Enforce non-zero TrackUid and SegmentUUID

Author: chehefen

README.md

@@ -45,6 +45,9 @@ This library is licensed under the Amazon Software License.
 ----
 ### Release notes
 
+#### Release 1.7.3 (12th Feb 2019)
+* Enforce non-zero TrackUid and SegmentUUID.
+
 #### Release 1.7.2 (8th Feb 2019)
 * JNI free object logic fix used by Java KVS SDK.
 

kinesis-video-gst-demo/kinesis_video_gstreamer_audio_video_sample_app.cpp

@@ -64,10 +64,10 @@ LOGGER_TAG("com.amazonaws.kinesis.video.gstreamer");
 #define DEFAULT_CREDENTIAL_EXPIRATION_SECONDS 180
 #define DEFAULT_AUDIO_VIDEO_DRIFT_TIMEOUT_SECOND 5
 
-#define DEFAULT_VIDEO_TRACKID 0
+#define DEFAULT_VIDEO_TRACKID 1
 #define DEFAULT_AUDIO_TRACK_NAME "audio"
 #define DEFAULT_AUDIO_CODEC_ID "A_AAC"
-#define DEFAULT_AUDIO_TRACKID 1
+#define DEFAULT_AUDIO_TRACKID 2
 
 
 typedef struct _FileInfo {
@@ -703,7 +703,10 @@ void kinesis_video_stream_init(CustomData *data) {
                                                            DEFAULT_CODEC_ID,
                                                            DEFAULT_TRACKNAME,
                                                            nullptr,
-                                                           0);
+                                                           0,
+                                                           MKV_TRACK_INFO_TYPE_VIDEO,
+                                                           vector<uint8_t>(),
+                                                           DEFAULT_VIDEO_TRACKID);
 
     stream_definition->addTrack(DEFAULT_AUDIO_TRACKID, DEFAULT_AUDIO_TRACK_NAME, DEFAULT_AUDIO_CODEC_ID, MKV_TRACK_INFO_TYPE_AUDIO);
     data->kinesis_video_stream = data->kinesis_video_producer->createStreamSync(move(stream_definition));
@@ -751,8 +754,8 @@ int gstreamer_init(int argc, char *argv[], CustomData &data) {
     gst_caps_unref(caps);
 
     // hardcoding appsink name and track id
-    const string video_appsink_name = "appsink_0";
-    const string audio_appsink_name = "appsink_1";
+    const string video_appsink_name = "appsink_" + to_string(DEFAULT_VIDEO_TRACKID);
+    const string audio_appsink_name = "appsink_" + to_string(DEFAULT_AUDIO_TRACKID);
 
     appsink_video = gst_element_factory_make("appsink", (gchar *) video_appsink_name.c_str());
     appsink_audio = gst_element_factory_make("appsink", (gchar *) audio_appsink_name.c_str());

kinesis-video-gstreamer-plugin/plugin-src/gstkvssink.cpp

@@ -130,8 +130,8 @@ GST_DEBUG_CATEGORY_STATIC (gst_kvs_sink_debug);
 
 #define DEFAULT_AUDIO_TRACK_NAME "audio"
 #define DEFAULT_AUDIO_CODEC_ID "A_AAC"
-#define DEFAULT_VIDEO_TRACKID 0
-#define DEFAULT_AUDIO_TRACKID 1
+#define KVS_SINK_DEFAULT_TRACKID 1
+#define KVS_SINK_DEFAULT_AUDIO_TRACKID 2
 
 enum {
     PROP_0,
@@ -388,10 +388,12 @@ void create_kinesis_video_stream(GstKvsSink *kvssink) {
                                                            kvssink->track_name,
                                                            nullptr,
                                                            0,
-                                                           kvssink->track_info_type);
+                                                           kvssink->track_info_type,
+                                                           vector<uint8_t>(),
+                                                           KVS_SINK_DEFAULT_TRACKID);
 
     if (data->media_type == AUDIO_VIDEO) {
-        stream_definition->addTrack(DEFAULT_AUDIO_TRACKID, DEFAULT_AUDIO_TRACK_NAME, DEFAULT_AUDIO_CODEC_ID, MKV_TRACK_INFO_TYPE_AUDIO);
+        stream_definition->addTrack(KVS_SINK_DEFAULT_AUDIO_TRACKID, DEFAULT_AUDIO_TRACK_NAME, DEFAULT_AUDIO_CODEC_ID, MKV_TRACK_INFO_TYPE_AUDIO);
     }
 
     data->kinesis_video_stream = data->kinesis_video_producer->createStreamSync(move(stream_definition));
@@ -1095,6 +1097,7 @@ gst_kvs_sink_handle_buffer (GstCollectPads * pads,
         goto CleanUp;
     }
 
+    //LOG_DEBUG("flags" << GST_BUFFER_FLAGS(buf));
     isDroppable =   GST_BUFFER_FLAG_IS_SET(buf, GST_BUFFER_FLAG_CORRUPTED) ||
                     GST_BUFFER_FLAG_IS_SET(buf, GST_BUFFER_FLAG_DECODE_ONLY) ||
                     (!GST_BUFFER_PTS_IS_VALID(buf)); //frame with invalid pts cannot be processed.
@@ -1134,13 +1137,10 @@ gst_kvs_sink_handle_buffer (GstCollectPads * pads,
             }
             break;
         case AUDIO_VIDEO:
-            if(!delta) {
-                // Set key frame flag on first key frame. No matter audio or video.
-                // After that set key frame flag on video key frame only.
-                if (data->first_key_frame) {
-                    data->first_key_frame = false;
-                    kinesis_video_flags = FRAME_FLAG_KEY_FRAME;
-                } else if (kvs_sink_track_data->track_type == MKV_TRACK_INFO_TYPE_VIDEO) {
+            if(!delta && kvs_sink_track_data->track_type == MKV_TRACK_INFO_TYPE_VIDEO) {
+                if (data->first_video_frame) {
+                    data->first_video_frame = false;
+                } else {
                     kinesis_video_flags = FRAME_FLAG_KEY_FRAME;
                 }
             }
@@ -1267,7 +1267,7 @@ gst_kvs_sink_request_new_pad (GstElement * element, GstPadTemplate * templ,
                                       NULL, locked);
     kvs_sink_track_data->kvssink = kvssink;
     kvs_sink_track_data->track_type = track_type;
-    kvs_sink_track_data->track_id = DEFAULT_TRACK_ID;
+    kvs_sink_track_data->track_id = KVS_SINK_DEFAULT_TRACKID;
 
     if (!gst_element_add_pad (element, GST_PAD (newpad))) {
         gst_object_unref (newpad);
@@ -1323,8 +1323,8 @@ assign_track_id(GstKvsSink *kvssink) {
 
             // set up track id in kvs_sink_track_data
             kvs_sink_track_data->track_id = kvs_sink_track_data->track_type == MKV_TRACK_INFO_TYPE_AUDIO ?
-                                            DEFAULT_AUDIO_TRACKID :
-                                            DEFAULT_VIDEO_TRACKID;
+                                            KVS_SINK_DEFAULT_AUDIO_TRACKID :
+                                            KVS_SINK_DEFAULT_TRACKID;
         }
     }
 }

kinesis-video-gstreamer-plugin/plugin-src/gstkvssink.h

@@ -168,15 +168,15 @@ typedef struct _CustomData {
             last_dts(0),
             pts_base(0),
             media_type(VIDEO_ONLY),
-            first_key_frame(true) {}
+            first_video_frame(true) {}
     unique_ptr<KinesisVideoProducer> kinesis_video_producer;
     shared_ptr<KinesisVideoStream> kinesis_video_stream;
     shared_ptr<CallbackStateMachine> callback_state_machine;
     map<uint64_t, string> track_cpd;
     GstKvsSink *kvsSink;
     bool stream_created = false;
     MediaType media_type;
-    bool first_key_frame;
+    bool first_video_frame;
 
     atomic_bool stream_ready;
     atomic_uint stream_status;

kinesis-video-pic/src/client/src/AuthIntegration.cpp

@@ -106,6 +106,32 @@ UINT64 getCurrentAuthExpiration(PKinesisVideoClient pKinesisVideoClient)
     return expiration;
 }
 
+/**
+ * Randomizing or adding a jitter to the auth info expiration.
+ *
+ * NOTE: The parameters are assumed to have been validated
+ */
+UINT64 randomizeAuthInfoExpiration(PKinesisVideoClient pKinesisVideoClient, UINT64 expiration, UINT64 currentTime)
+{
+    UINT64 jitterInSec = (UINT64) ((expiration - currentTime) * AUTH_INFO_EXPIRATION_JITTER_RATIO / HUNDREDS_OF_NANOS_IN_A_SECOND);
+
+    // Quick check whether we need to do anything
+    if (!ENABLE_AUTH_INFO_EXPIRATION_RANDOMIZATION ||
+        jitterInSec == 0 ||
+        currentTime + AUTH_INFO_EXPIRATION_RANDOMIZATION_DURATION_THRESHOLD > expiration) {
+        return expiration;
+    }
+
+    // Calculate the jitter and take random part.
+    UINT64 randomizedJitter = pKinesisVideoClient->clientCallbacks.getRandomNumberFn(
+            pKinesisVideoClient->clientCallbacks.customData) % jitterInSec;
+
+    // Ensure no more than max jitter is applied
+    UINT64 jitter = MIN(randomizedJitter * HUNDREDS_OF_NANOS_IN_A_SECOND, MAX_AUTH_INFO_EXPIRATION_RANDOMIZATION);
+
+    return expiration - jitter;
+}
+
 /**
  * Performs the producer client provisioning
  * NOTE: This is a long running operation

kinesis-video-pic/src/client/src/Include_i.h

@@ -199,6 +199,26 @@ typedef __KinesisVideoBase* PKinesisVideoBase;
                                                     (x)->streamInfo.streamCaps.fragmentAcks && \
                                                     (x)->streamInfo.retention != RETENTION_PERIOD_SENTINEL)
 
+/**
+ * Controls whether we enable auth info expiration randomization
+ */
+#define ENABLE_AUTH_INFO_EXPIRATION_RANDOMIZATION       TRUE
+
+/**
+ * The threshold beyond which we won't do any auth info expiration randomization
+ */
+#define AUTH_INFO_EXPIRATION_RANDOMIZATION_DURATION_THRESHOLD       5 * HUNDREDS_OF_NANOS_IN_A_MINUTE
+
+/**
+ * Max randomization value to be added
+ */
+#define MAX_AUTH_INFO_EXPIRATION_RANDOMIZATION                      3 * HUNDREDS_OF_NANOS_IN_A_MINUTE
+
+/**
+ * Ratio of the expiration to use for jitter
+ */
+#define AUTH_INFO_EXPIRATION_JITTER_RATIO                           0.1L
+
 /**
  * Kinesis Video client internal structure
  */
@@ -278,6 +298,11 @@ STATUS provisionKinesisVideoProducer(PKinesisVideoClient);
  */
 AUTH_INFO_TYPE getCurrentAuthType(PKinesisVideoClient);
 
+/**
+ * Randomizing or adding a jitter to the auth info expiration
+ */
+UINT64 randomizeAuthInfoExpiration(PKinesisVideoClient, UINT64, UINT64);
+
 /**
  * Default implementations of some of the callbacks if the caller hasn't specified them
  */

kinesis-video-pic/src/client/src/StreamEvent.cpp

@@ -311,6 +311,11 @@ STATUS getStreamingTokenResult(PKinesisVideoStream pKinesisVideoStream, SERVICE_
         // Ensure that we rotate before the max period is enforced
         pKinesisVideoStream->streamingAuthInfo.expiration = MIN(expiration, currentTime + MAX_ENFORCED_TOKEN_EXPIRATION_DURATION);
 
+        // Introduce jitter to the expiration time
+        pKinesisVideoStream->streamingAuthInfo.expiration = randomizeAuthInfoExpiration(pKinesisVideoClient,
+                                                                                        pKinesisVideoStream->streamingAuthInfo.expiration,
+                                                                                        currentTime);
+
         // If we don't have a token we assume there is no auth.
         if (pToken == NULL || tokenSize == 0) {
             pKinesisVideoStream->streamingAuthInfo.type = AUTH_INFO_NONE;

kinesis-video-pic/src/client/tst/ClientTestFixture.cpp

@@ -17,6 +17,24 @@ UINT64 ClientTestBase::getCurrentTimeFunc(UINT64 customData)
     return pClient->mTime;
 }
 
+// Global variable which is used as a preset time
+UINT64 gPresetCurrentTime = 0;
+UINT64 ClientTestBase::getCurrentPresetTimeFunc(UINT64 customData)
+{
+    DLOGV("TID 0x%016llx getCurrentPresetTimeFunc called.", GETTID());
+
+    ClientTestBase *pClient = (ClientTestBase*) customData;
+    EXPECT_TRUE(pClient != NULL && pClient->mMagic == TEST_CLIENT_MAGIC_NUMBER);
+
+    pClient->mGetCurrentTimeFuncCount++;
+    pClient->mTime = gPresetCurrentTime;
+
+    // Increment the preset time
+    gPresetCurrentTime++;
+
+    return pClient->mTime;
+}
+
 UINT32 ClientTestBase::getRandomNumberFunc(UINT64 customData)
 {
     DLOGV("TID 0x%016llx getRandomNumberFunc called.", GETTID());
@@ -29,6 +47,9 @@ UINT32 ClientTestBase::getRandomNumberFunc(UINT64 customData)
     return RAND();
 }
 
+// Global variable which is used for the random function that returns constant value for testing
+UINT32 gConstReturnFromRandomFunction = TEST_CONST_RAND_FUNC_BYTE;
+
 UINT32 ClientTestBase::getRandomNumberConstFunc(UINT64 customData)
 {
     DLOGV("TID 0x%016llx getRandomNumberConstFunc called.", GETTID());
@@ -38,7 +59,7 @@ UINT32 ClientTestBase::getRandomNumberConstFunc(UINT64 customData)
 
     pClient->mGetRandomNumberFuncCount++;
 
-    return TEST_CONST_RAND_FUNC_BYTE;
+    return gConstReturnFromRandomFunction;
 }
 
 VOID ClientTestBase::logPrintFunc(UINT32 level, PCHAR tag, PCHAR fmt, ...)

kinesis-video-pic/src/client/tst/ClientTestFixture.h

@@ -23,7 +23,9 @@
 #define TEST_CONTENT_TYPE               ((PCHAR) "TestContentType")
 #define TEST_CODEC_ID                   ((PCHAR) "TestCodec")
 #define TEST_TRACK_NAME                 ((PCHAR) "TestTrack")
-#define TEST_TRACKID                    0
+#define TEST_TRACKID                    1
+#define TEST_TRACK_INDEX                0
+#define TEST_INVALID_TRACK_ID           100
 
 #define TEST_DEVICE_ARN                 ((PCHAR) "TestDeviceARN")
 
@@ -578,6 +580,7 @@ class ClientTestBase : public ::testing::Test {
     // Static callbacks definitions
     //////////////////////////////////////////////////////////////////////////////////////
     static UINT64 getCurrentTimeFunc(UINT64);
+    static UINT64 getCurrentPresetTimeFunc(UINT64);
     static UINT32 getRandomNumberFunc(UINT64);
     static UINT32 getRandomNumberConstFunc(UINT64);
     static VOID logPrintFunc(UINT32, PCHAR, PCHAR, ...);