Merge 27d593b into 4f1e798

Author: sirknightj

README.md

@@ -133,6 +133,17 @@ For audio only, run `./kvsAudioOnlyStreamingSample <stream-name> <streaming_dura
 
 This will stream the audio files from the `samples/aacSampleFrames` or `samples/alawSampleFrames` (as per the choice of audio codec in the last argument) respectively. 
 
+### Fragment metadata
+
+`./kvsVideoOnlyRealtimeStreamingSample` is the only sample that has the [fragment metadata](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/how-meta.html) implemented out of the box.
+
+In addition to the required arguments above, this sample has an additional argument:
+```shell
+./kvsVideoOnlyRealtimeStreamingSample <stream-name> <video-codec> <streaming-duration-in-seconds> <sample-location> <num-metadata>
+```
+
+`num-metadata` -- the number of sample fragment metadata key-value pairs that are added to each fragment. Min: 0, Max: 10. Default: 10.
+
 ### Setting log levels
 
 

samples/KvsVideoOnlyRealtimeStreamingSample.c

@@ -11,6 +11,9 @@
 #define VIDEO_CODEC_NAME_H264             "h264"
 #define VIDEO_CODEC_NAME_H265             "h265"
 #define VIDEO_CODEC_NAME_MAX_LENGTH       5
+#define METADATA_MAX_KEY_LENGTH           128
+#define METADATA_MAX_VALUE_LENGTH         256
+#define MAX_METADATA_PER_FRAGMENT         10
 
 #define NUMBER_OF_FRAME_FILES 403
 
@@ -57,10 +60,10 @@ INT32 main(INT32 argc, CHAR* argv[])
     STREAM_HANDLE streamHandle = INVALID_STREAM_HANDLE_VALUE;
     STATUS retStatus = STATUS_SUCCESS;
     PCHAR accessKey = NULL, secretKey = NULL, sessionToken = NULL, streamName = NULL, region = NULL, cacertPath = NULL;
-    CHAR frameFilePath[MAX_PATH_LEN + 1];
+    CHAR frameFilePath[MAX_PATH_LEN + 1], metadataKey[METADATA_MAX_KEY_LENGTH + 1], metadataValue[METADATA_MAX_VALUE_LENGTH + 1];
     Frame frame;
     BYTE frameBuffer[200000]; // Assuming this is enough
-    UINT32 frameSize = SIZEOF(frameBuffer), frameIndex = 0, fileIndex = 0;
+    UINT32 frameSize = SIZEOF(frameBuffer), frameIndex = 0, fileIndex = 0, n = 0, numMetadata = 10;
     UINT64 streamStopTime, streamingDuration = DEFAULT_STREAM_DURATION;
     DOUBLE startUpLatency;
     BOOL firstFrame = TRUE;
@@ -70,8 +73,8 @@ INT32 main(INT32 argc, CHAR* argv[])
     VIDEO_CODEC_ID videoCodecID = VIDEO_CODEC_ID_H264;
 
     if (argc < 2) {
-        DLOGE("Usage: AWS_ACCESS_KEY_ID=SAMPLEKEY AWS_SECRET_ACCESS_KEY=SAMPLESECRET %s <stream_name> <codec> <duration_in_seconds> "
-              "<frame_files_path>\n",
+        DLOGE("Usage: AWS_ACCESS_KEY_ID=SAMPLEKEY AWS_SECRET_ACCESS_KEY=SAMPLESECRET %s <stream_name>"
+              "<codec> <duration_in_seconds> <frame_files_path> [num_metadata = 10]\n",
               argv[0]);
         CHK(FALSE, STATUS_INVALID_ARG);
     }
@@ -81,33 +84,39 @@ INT32 main(INT32 argc, CHAR* argv[])
         CHK(FALSE, STATUS_INVALID_ARG);
     }
 
-    MEMSET(frameFilePath, 0x00, MAX_PATH_LEN + 1);
-    if (argc < 5) {
-        STRCPY(frameFilePath, (PCHAR) "../samples/");
-    } else {
-        STRNCPY(frameFilePath, argv[4], MAX_PATH_LEN);
-    }
-
     cacertPath = getenv(CACERT_PATH_ENV_VAR);
     sessionToken = getenv(SESSION_TOKEN_ENV_VAR);
     streamName = argv[1];
     if ((region = getenv(DEFAULT_REGION_ENV_VAR)) == NULL) {
         region = (PCHAR) DEFAULT_AWS_REGION;
     }
 
-    if (argc >= 3) {
+    if (argc >= 3 && !IS_EMPTY_STRING(argv[2])) {
         if (!STRCMP(argv[2], VIDEO_CODEC_NAME_H265)) {
             STRNCPY(videoCodec, VIDEO_CODEC_NAME_H265, STRLEN(VIDEO_CODEC_NAME_H265));
             videoCodecID = VIDEO_CODEC_ID_H265;
         }
     }
 
-    if (argc >= 4) {
+    if (argc >= 4 && !IS_EMPTY_STRING(argv[3])) {
         // Get the duration and convert to an integer
         CHK_STATUS(STRTOUI64(argv[3], NULL, 10, &streamingDuration));
         streamingDuration *= HUNDREDS_OF_NANOS_IN_A_SECOND;
     }
 
+    MEMSET(frameFilePath, 0x00, MAX_PATH_LEN + 1);
+    if (argc >= 5 && !IS_EMPTY_STRING(argv[4])) {
+        STRNCPY(frameFilePath, argv[4], MAX_PATH_LEN);
+    } else {
+        STRCPY(frameFilePath, (PCHAR) "../samples/");
+    }
+
+    if (argc >= 6 && !IS_EMPTY_STRING(argv[5])) {
+        numMetadata = STRTOUL(argv[5], NULL, 10);
+        DLOGD("numMetadata: %d\n", numMetadata);
+        CHK(numMetadata <= MAX_METADATA_PER_FRAGMENT, STATUS_INVALID_ARG);
+    }
+
     streamStopTime = GETTIME() + streamingDuration;
 
     // default storage size is 128MB. Use setDeviceInfoStorageSize after create to change storage size.
@@ -154,6 +163,17 @@ INT32 main(INT32 argc, CHAR* argv[])
 
         CHK_STATUS(readFrameData(&frame, frameFilePath, videoCodec));
 
+        // Add the fragment metadata key-value pairs
+        // For limits, refer to https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html#limits-streaming-metadata
+        if (numMetadata > 0 && frame.flags == FRAME_FLAG_KEY_FRAME) {
+            DLOGD("Adding metadata! frameIndex: %d", frame.index);
+            for (n = 1; n <= numMetadata; n++) {
+                SNPRINTF(metadataKey, METADATA_MAX_KEY_LENGTH, "TEST_KEY_%d", n);
+                SNPRINTF(metadataValue, METADATA_MAX_VALUE_LENGTH, "TEST_VALUE_%d", frame.index + n);
+                CHK_STATUS(putKinesisVideoFragmentMetadata(streamHandle, metadataKey, metadataValue, TRUE));
+            }
+        }
+
         CHK_STATUS(putKinesisVideoFrame(streamHandle, &frame));
         if (firstFrame) {
             startUpLatency = (DOUBLE) (GETTIME() - startTime) / (DOUBLE) HUNDREDS_OF_NANOS_IN_A_MILLISECOND;