4a5082f Release note for v1.4.0

* Fix for crash caused by latest Mac tool chain issue
* Fix for callbacks returning incorrect custom data in gstreamer sample app
* Support for custom logger
* Fix for multiple callbacks when triggering connection staleness

Author: chehefen

README.md

@@ -341,7 +341,11 @@ make install
 
 
 ## Release Notes
-
+#### Release 1.4.0 (25th April 2018)
+* Fix for crash caused by latest Mac tool chain issue
+* Fix for callbacks returning incorrect custom data in gstreamer sample app
+* Support for custom logger
+* Fix for multiple callbacks when triggering connection staleness
 #### Release 1.3.1 (5th April 2018)
 * Fixed video source negotiation error caused by camera with fractional fps 
 * Docker suport for RTSP streaming

kinesis-video-gst-demo/kinesis_video_gstreamer_sample_app.cpp

@@ -33,6 +33,10 @@ namespace com { namespace amazonaws { namespace kinesis { namespace video {
 class SampleClientCallbackProvider : public ClientCallbackProvider {
 public:
 
+    UINT64 getCallbackCustomData() override {
+        return reinterpret_cast<UINT64> (this);
+    }
+
     StorageOverflowPressureFunc getStorageOverflowPressureCallback() override {
         return storageOverflowPressure;
     }
@@ -43,6 +47,10 @@ class SampleClientCallbackProvider : public ClientCallbackProvider {
 class SampleStreamCallbackProvider : public StreamCallbackProvider {
 public:
 
+    UINT64 getCallbackCustomData() override {
+        return reinterpret_cast<UINT64> (this);
+    }
+
     StreamConnectionStaleFunc getStreamConnectionStaleCallback() override {
         return streamConnectionStaleHandler;
     };

kinesis-video-gst-demo/kinesis_video_gstreamer_sample_rtsp_app.cpp

@@ -35,6 +35,10 @@ namespace com {
                 class SampleClientCallbackProvider : public ClientCallbackProvider {
                 public:
 
+                    UINT64 getCallbackCustomData() override {
+                        return reinterpret_cast<UINT64> (this);
+                    }
+
                     StorageOverflowPressureFunc getStorageOverflowPressureCallback() override {
                         return storageOverflowPressure;
                     }
@@ -45,6 +49,10 @@ namespace com {
                 class SampleStreamCallbackProvider : public StreamCallbackProvider {
                 public:
 
+                    UINT64 getCallbackCustomData() override {
+                        return reinterpret_cast<UINT64> (this);
+                    }
+
                     StreamConnectionStaleFunc getStreamConnectionStaleCallback() override {
                         return streamConnectionStaleHandler;
                     };

kinesis-video-native-build/CMakeLists.txt

@@ -125,6 +125,7 @@ set(PIC_SOURCE_FILES
         ${KINESIS_VIDEO_PIC_SRC}/src/utils/src/String.cpp
         ${KINESIS_VIDEO_PIC_SRC}/src/utils/src/Threads.cpp
         ${KINESIS_VIDEO_PIC_SRC}/src/utils/src/Time.cpp
+        ${KINESIS_VIDEO_PIC_SRC}/src/utils/src/Logger.cpp
 
         ${KINESIS_VIDEO_PIC_SRC}/src/view/include/com/amazonaws/kinesis/video/view/Include.h
         ${KINESIS_VIDEO_PIC_SRC}/src/view/src/ContentView.cpp
@@ -301,11 +302,11 @@ target_link_libraries(kinesis_video_gstreamer_sample_app
         glib-2.0)
 
 target_link_libraries(kinesis_video_gstreamer_sample_rtsp_app
-        producer 
-        pthread 
-        dl 
-        gstreamer-1.0 
-        gstapp-1.0 
-        gobject-2.0 
+        producer
+        pthread
+        dl
+        gstreamer-1.0
+        gstapp-1.0
+        gobject-2.0
         glib-2.0)
 

kinesis-video-pic/src/client/include/com/amazonaws/kinesis/video/client/Include.h

@@ -1352,6 +1352,15 @@ typedef VOID (*FreeMutexFunc)(UINT64,
  */
 typedef UINT32 (*GetRandomNumberFunc)(UINT64);
 
+///////////////////////////////////////////////////////////////
+// Logging callbacks
+///////////////////////////////////////////////////////////////
+
+/**
+ * Logs a line of text with the tag and the log level - see PlatformUtils.h for more info
+ */
+typedef logPrintFunc LogPrintFunc;
+
 ///////////////////////////////////////////////////////////////
 // Service call callbacks
 ///////////////////////////////////////////////////////////////
@@ -1528,6 +1537,7 @@ struct __ClientCallbacks {
     CreateDeviceFunc createDeviceFn;
     DeviceCertToTokenFunc deviceCertToTokenFn;
     ClientReadyFunc clientReadyFn;
+    LogPrintFunc logPrintFn;
 };
 typedef __ClientCallbacks* PClientCallbacks;
 

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

@@ -29,8 +29,6 @@ STATUS createKinesisVideoClient(PDeviceInfo pDeviceInfo, PClientCallbacks pClien
     PCHAR pCurPnt;
     CLIENT_HANDLE clientHandle;
 
-    DLOGI("Creating Kinesis Video Client");
-
     // Check the input params
     CHK(pDeviceInfo != NULL && pClientHandle != NULL, STATUS_NULL_ARG);
 
@@ -39,8 +37,13 @@ STATUS createKinesisVideoClient(PDeviceInfo pDeviceInfo, PClientCallbacks pClien
 
     // Validate the input structs
     CHK_STATUS(validateDeviceInfo(pDeviceInfo));
+
+    // Validate the callbacks. Set default callbacks.
     CHK_STATUS(validateClientCallbacks(pDeviceInfo, pClientCallbacks));
 
+    // Report the creation after the validation as we might have the overwritten logger.
+    DLOGI("Creating Kinesis Video Client");
+
     // Allocate the main struct with an array of stream pointers following the structure and the array of tags following it
     // NOTE: The calloc will Zero the fields
     allocationSize = SIZEOF(KinesisVideoClient) + pDeviceInfo->streamCount * SIZEOF(PKinesisVideoStream) + pDeviceInfo->tagCount * TAG_FULL_LENGTH;
@@ -720,7 +723,7 @@ VOID viewItemRemoved(PContentView pContentView, UINT64 customData, PViewItem pVi
         DLOGW("Reporting a dropped frame/fragment.");
 
         // Invalidate the streams current view item
-        MEMSET(&pKinesisVideoStream->curViewItem, 0x00, SIZEOF(ViewItem));
+        MEMSET(&pKinesisVideoStream->curViewItem, 0x00, SIZEOF(CurrentViewItem));
         pKinesisVideoStream->curViewItem.viewItem.handle = INVALID_ALLOCATION_HANDLE_VALUE;
 
         switch (pKinesisVideoStream->streamInfo.streamCaps.streamingType) {

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

@@ -79,6 +79,10 @@ STATUS validateClientCallbacks(PDeviceInfo pDeviceInfo, PClientCallbacks pClient
         pClientCallbacks->getRandomNumberFn = defaultGetRandomNumber;
     }
 
+    if (pClientCallbacks->logPrintFn != NULL) {
+        globalCustomLogPrintFn = pClientCallbacks->logPrintFn;
+    }
+
 CleanUp:
     return retStatus;
 }

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

@@ -1647,7 +1647,7 @@ STATUS checkForConnectionStaleness(PKinesisVideoStream pKinesisVideoStream, PVie
 
     // Check if we need to do anything
     CHK(pKinesisVideoStream->streamInfo.streamCaps.connectionStalenessDuration != CONNECTION_STALENESS_DETECTION_SENTINEL &&
-        !pKinesisVideoStream->streamInfo.streamCaps.fragmentAcks &&
+        pKinesisVideoStream->streamInfo.streamCaps.fragmentAcks &&
         pKinesisVideoStream->pKinesisVideoClient->clientCallbacks.streamConnectionStaleFn != NULL,
         retStatus);
 
@@ -1668,6 +1668,7 @@ STATUS checkForConnectionStaleness(PKinesisVideoStream pKinesisVideoStream, PVie
                     pKinesisVideoStream->pKinesisVideoClient->clientCallbacks.customData,
                     TO_STREAM_HANDLE(pKinesisVideoStream),
                     lastAckDuration));
+            break;
         }
 
         curIndex--;

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

@@ -29,6 +29,17 @@ UINT32 ClientTestBase::getRandomNumberFunc(UINT64 customData)
     return RAND();
 }
 
+VOID ClientTestBase::logPrintFunc(UINT32 level, PCHAR tag, PCHAR fmt, ...)
+{
+    // Temp scratch buffer = 10KB
+    CHAR tempBuf[10 * 1024];
+    snprintf(tempBuf, SIZEOF(tempBuf), "\n[0x%016llx] [level %u] %s %s", GETTID(), level, tag, fmt);
+    va_list valist;
+    va_start(valist, fmt);
+    vprintf(tempBuf, valist);
+    va_end(valist);
+}
+
 STATUS ClientTestBase::getDeviceCertificateFunc(UINT64 customData, PBYTE* ppCert, PUINT32 pSize, PUINT64 pExpiration)
 {
     DLOGV("TID 0x%016llx getDeviceCertificateFunc called.", GETTID());

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

@@ -211,6 +211,7 @@ class ClientTestBase : public ::testing::Test {
         mClientCallbacks.tagResourceFn = tagResourceFunc;
         mClientCallbacks.getCurrentTimeFn = getCurrentTimeFunc;
         mClientCallbacks.getRandomNumberFn = getRandomNumberFunc;
+        mClientCallbacks.logPrintFn = logPrintFunc;
         mClientCallbacks.clientReadyFn = clientReadyFunc;
         mClientCallbacks.streamDataAvailableFn = streamDataAvailableFunc;
         mClientCallbacks.streamErrorReportFn = streamErrorReportFunc;
@@ -509,6 +510,7 @@ class ClientTestBase : public ::testing::Test {
     //////////////////////////////////////////////////////////////////////////////////////
     static UINT64 getCurrentTimeFunc(UINT64);
     static UINT32 getRandomNumberFunc(UINT64);
+    static VOID logPrintFunc(UINT32, PCHAR, PCHAR, ...);
     static STATUS getDeviceCertificateFunc(UINT64, PBYTE*, PUINT32, PUINT64);
     static STATUS getSecurityTokenFunc(UINT64, PBYTE*, PUINT32, PUINT64);
     static STATUS getDeviceFingerprintFunc(UINT64, PCHAR*);