Version 1.3.0

Author: marat-iskhakov

Diff for: README.md

@@ -12,10 +12,6 @@ This SDK is designed to integrate IP cameras with the Faceter cloud video survei
 
 **Faceter CloudCam SDK** – modules that implement interaction with the cloud and Faceter applications. The SDK requires a local RTSP stream, which is transmitted to the Faceter cloud using RTSP-push technology
 
-## Faceter CloudCam SDK prebuilt libraries
-
-Prebuilt libraries for different platforms are located in the [latest release](https://github.com/faceterteam/Faceter-CloudCam-SDK/releases/latest)
-
 ## Intergration sample
 
 An example of code with stubs describing intergation process is shown in [integration_sample.c](integration_sample.c) 
@@ -43,11 +39,10 @@ const char* serialNumber = GetSerialNumber();
 
 ClientSettings settings = {
     .cameraModel = "MyModel",
-    .cameraVendor = "Faceter",
+    .cameraVendor = "Vision",
     .appVersion = "1.0.0",
     .firmwareVersion = "Camera_1.0.3",
     .hardwareId = "t31_gc2053",
-    .discoveryPort = 3702,
     .certFilePath = "/etc/ssl/certs/ca-certificates.crt",
     .confFilePath = "/etc/faceter-camera.conf",
     .rtspMainUrl = "rtsp://127.0.0.1/stream=0",
@@ -75,7 +70,6 @@ Returns 0 on success and -1 if some error value occurs
 * appVersion - version of the applcation using library ("1.0.0")
 * firmwareVersion - camera firmware version ("Camera_1.0.3")
 * hardwareId - information about hardware, such as processor and sensor ("t31_gc2053")
-* discoveryPort - port used for camera discovery from Faceter application (3702)
 * certFilePath - path to the SSL certificate file, used in HTTPS connections ("/etc/ssl/certs/ca-certificates.crt")
 * confFilePath - path to the file in the writable location where library will store it's state ("/etc/faceter-camera.conf")
 * rtspMainUrl - main stream RTSP url without credentials ("rtsp://127.0.0.1/stream=0")
@@ -201,25 +195,39 @@ typedef enum ObjectType
     ObjectAnimal,
     ObjectFire,
     ObjectSmoke,
-    ObjectOther
+    ObjectOther,
+    ObjectUnknown
 } ObjectType;
 
-void FaceterClientOnVideoEvent(VideoEventType eventType, ObjectType objectType, 
-    DetectionAttribute *attributesList, DetectionRect *relativeBoundingRectList, 
-    char* snapshotImage, long int snapshotBytesCount)
+typedef struct DetectionGrid 
+{
+    int rowsCount;
+    int colsCount;
+    int cellsCount;
+    uint32_t *cells;
+} DetectionGrid;
+
+void FaceterClientOnVideoEventStart(int64_t eventTimestampSec, VideoEventType eventType, ObjectType objectType, 
+    DetectionAttribute *attributesList, DetectionGrid detectionGrid, 
+    char* snapshotImage, long int snapshotBytesCount);
+
+void FaceterClientOnVideoEventUpdate(int64_t eventTimestampSec, VideoEventType eventType, ObjectType objectType, 
+    DetectionGrid detectionGrid);    
+
+void FaceterClientOnVideoEventEnd(int64_t eventTimestampSec, VideoEventType eventType, ObjectType objectType, 
+    DetectionGrid detectionGrid);
 ```
-Each video event has VideoEventType if can be recognized, otherwise use **VideoEventMotion**. 
-If object can be detected it's type passed as second parameters, otherwise use **ObjectOther**.
+Long time detection events have start point, end point and can be updated between start and end.
+Use **FaceterClientOnVideoEventStart**, **FaceterClientOnVideoEventEnd** and **FaceterClientOnVideoEventUpdate** respectively.
+Pass event timestamp in seconds since 01.01.1970. Each video event has VideoEventType if can be recognized, otherwise use **VideoEventMotion**. If object can be detected it's type passed as second parameters, otherwise use **ObjectUnknown**.
 
 Also detector may provide object's attributes, that can be passed linked list of **DetectionAttribute**.
 Parameter can be NULL if no information about object attributes provided.
 DetectionAttribute is key-value structure of string type. Use PushDetectionAttribute to add object attribute.
 Helper function PushHumanAttibutes creates DetectionAttribute list for human with gender and age fields.
 Helper function PushVehicleAttributes creates DetectionAttribute list for vehicle with type and license plate fields
 
-For describing objects bounding rects use **DetectionRect** list. Parameter can be NULL if no information about rect provided. 
-Rect coordinates (top left corner, width and height) are relative to image size and must be set as integers in the range [0..99]. 
-For adding next DetectionRect to list PushDetectionRect use PushDetectionRect
+For describing cells in grid where object was detected pass DetectionGrid object. It has number of columns, rows and array cells with uint32 numbers. Each bit in this number describe cell. If object detected in cell bit will be 1, otherwise 0.
 
 Last two parameters - camera snapshot of detected event in jpeg format and snapshot bytes count. Can be NULL.
 
@@ -228,16 +236,37 @@ Last two parameters - camera snapshot of detected event in jpeg format and snaps
 long int snapshotJpegBytesCount = 100;
 char snapshotJpegImage[snapshotJpegBytesCount];
 
-//simple motion event
-FaceterClientOnVideoEvent(VideoEventMotion, ObjectOther, NULL, NULL, NULL, 0);
+int64_t nowTime = (int64_t)time(NULL);
+DetectionGrid grid = {
+    .rowsCount = 10,
+    .colsCount = 16,
+    .cellsCount = 5
+};
+grid.cells = malloc(grid.cellsCount * sizeof(int32_t));
+grid.cells[2] = 1;
+//simple motion event started
+FaceterClientOnVideoEventStart(nowTime, VideoEventMotion, ObjectUnknown, NULL, grid, snapshotJpegImage, snapshotJpegBytesCount);
+
+//simple motion event updated periodically
+FaceterClientOnVideoEventUpdate(nowTime1, VideoEventMotion, ObjectUnknown, grid1);
+FaceterClientOnVideoEventUpdate(nowTime2, VideoEventMotion, ObjectUnknown, grid2);
+
+//simple motion event ended
+FaceterClientOnVideoEventEnd(nowTime3, VideoEventMotion, ObjectUnknown, grid3);
 
 //human motion event
 DetectionAttribute* humanAttrList = NULL;
 PushHumanAttibutes(&humanAttrList, GenderMale, 30);
 DetectionRect* humanRect = NULL;
 PushDetectionRect(&humanRect, 10, 15, 25, 49);
-FaceterClientOnVideoEvent(VideoEventMotion, ObjectHuman, humanAttrList, humanRect, snapshotJpegImage, snapshotJpegBytesCount);
+FaceterClientOnVideoEventStart(nowTime, VideoEventMotion, ObjectHuman, humanAttrList, grid, snapshotJpegImage, snapshotJpegBytesCount);
+FaceterClientOnVideoEventUpdate(nowTime, VideoEventMotion, ObjectHuman, grid);
+FaceterClientOnVideoEventEnd(nowTime, VideoEventMotion, ObjectHuman, grid);
+```
+
+One-time events can be passed to SDK with **FaceterClientOnVideoEvent** method
 
+```
 //animal motion event
 DetectionAttribute* animalAttrList = NULL;
 PushDetectionAttribute(&animalAttrList, "kind", "cat");

Diff for: include/CameraConfig.h

@@ -41,6 +41,9 @@ typedef struct DetectorConfig {
 
 typedef struct OsdConfig {
     int isEnabled;
+    int offsetX;
+    int offsetY;
+    char template[50];
 } OsdConfig;
 
 typedef struct NightModeConfig {

Diff for: include/ControlFunction.h

@@ -18,7 +18,8 @@ typedef enum ClientControlCode {
     ControlCodeStreamStatus,        /**< update stream status */
     ControlCodeSetupWifi,           /**< set wifi configuration from param */
     ControlCodeStartScanQr,         /**< start qr code scanner */
-    ControlCodeStopScanQr           /**< stop qr code scanner */
+    ControlCodeStopScanQr,          /**< stop qr code scanner */
+    ControlCodeUpdateVideoEvent     /**< get detection grid for video event and call FaceterClientOnVideoEventUpdate */
 } ClientControlCode;
 
 /*

Diff for: include/DetectionEvents.h

@@ -1,6 +1,8 @@
 #ifndef DETECTIONEVENTS_H
 #define DETECTIONEVENTS_H
 
+#include <stdint.h>
+
 typedef enum AudioEventType 
 {
     AudioEventCry,
@@ -27,7 +29,8 @@ typedef enum ObjectType
     ObjectAnimal,
     ObjectFire,
     ObjectSmoke,
-    ObjectOther
+    ObjectOther,
+    ObjectUnknown
 } ObjectType;
 
 typedef enum HumanGender
@@ -55,6 +58,14 @@ typedef struct DetectionRect
     struct DetectionRect* next;
 } DetectionRect;
 
+typedef struct DetectionGrid 
+{
+    int rowsCount;
+    int colsCount;
+    int cellsCount;
+    uint32_t *cells;
+} DetectionGrid;
+
 typedef struct DetectionAttribute 
 {
     char* key;
@@ -71,5 +82,9 @@ void PushHumanAttibutes(DetectionAttribute** top, HumanGender gender, int age);
 void PushVehicleAttributes(DetectionAttribute** top, VehicleType vehicleType, const char* licensePlate);
 DetectionAttribute* PopDetectionAttribute(DetectionAttribute** top);
 
+const char* VideoEventTypeToStr(VideoEventType eventType);
+const char* ObjectTypeToStr(ObjectType objectType);
+const char* AudioEventTypeToStr(AudioEventType eventType);
+
 
 #endif //DETECTIONEVENTS_H

Diff for: include/FaceterClient.h

@@ -42,6 +42,8 @@ void FaceterClientSetControlStatus(ClientControlCode controlCode, ClientStatusCo
 /*
  * Send detected video event to the library
  *
+ * @param eventTimestampSec UTC linux timestamp when event occured
+ * 
  * @param eventType type of detected video event.
  * If does not matched anything else in the VideoEventType use VideoEventMotion
  * 
@@ -53,19 +55,42 @@ void FaceterClientSetControlStatus(ClientControlCode controlCode, ClientStatusCo
  * PushHumanAttibutes for human attributes,  
  * PushVehicleAttributes for vehicle attributes
  * 
- * @param relativeBoundingRectList list of detected objects bounding rects in relative coordinates.
- * Could be NULL. Use PushDetectionRect for adding next DetectionRect. 
- * 0 <= x, y, width, height < 100
+ * @param detectionGrid desribes grid - number of rows, cols and cells, where
+ * event was detected
  * 
  * @param snapshotImage image of the detected event. Could be NULL
  * @param snapshotBytesCount size of snaphot, 0 if snapshotImage is NULL
  * 
  */
-void FaceterClientOnVideoEvent(VideoEventType eventType, ObjectType objectType, 
-    DetectionAttribute *attributesList, DetectionRect *relativeBoundingRectList, 
+void FaceterClientOnVideoEvent(int64_t eventTimestampSec, VideoEventType eventType, ObjectType objectType, 
+    DetectionAttribute *attributesList, DetectionGrid detectionGrid, 
     char* snapshotImage, long int snapshotBytesCount);
 
 
+/*
+ * Method for start sending long detections
+ *
+ * params descripion in FaceterClientOnVideoEvent
+ */
+void FaceterClientOnVideoEventStart(int64_t eventTimestampSec, VideoEventType eventType, ObjectType objectType, 
+    DetectionAttribute *attributesList, DetectionGrid detectionGrid, 
+    char* snapshotImage, long int snapshotBytesCount);
+/*
+ * Method for update deetction grid for long detection
+ *
+ * params descripion in FaceterClientOnVideoEvent
+ */
+void FaceterClientOnVideoEventUpdate(int64_t eventTimestampSec, VideoEventType eventType, ObjectType objectType, 
+    DetectionGrid detectionGrid);    
+
+/*
+ * Method for end sending long detections
+ *
+ * params descripion in FaceterClientOnVideoEvent
+ */
+void FaceterClientOnVideoEventEnd(int64_t eventTimestampSec, VideoEventType eventType, ObjectType objectType, 
+    DetectionGrid detectionGrid);
+
 /*
  * Send detected audio event to the library
  *

Diff for: integration_sample.c

@@ -1,5 +1,6 @@
 #include <stdlib.h>
 #include <string.h>
+#include <time.h>
 #include "FaceterClient.h"
 
 /*
@@ -34,34 +35,49 @@ void OnMotionDetected()
     long int snapshotJpegBytesCount = 100;
     char snapshotJpegImage[snapshotJpegBytesCount];
 
-    //simple motion event
-    FaceterClientOnVideoEvent(VideoEventMotion, ObjectOther, NULL, NULL, NULL, 0);
+    int64_t nowTime = (int64_t)time(NULL);
+    DetectionGrid grid = {
+        .rowsCount = 10,
+        .colsCount = 16,
+        .cellsCount = 5
+    };
+    grid.cells = malloc(grid.cellsCount * sizeof(int32_t));
+    grid.cells[2] = 1;
+    //simple motion event started
+    FaceterClientOnVideoEventStart(nowTime, VideoEventMotion, ObjectUnknown, NULL, grid, snapshotJpegImage, snapshotJpegBytesCount);
+
+    //simple motion event updated periodically
+    FaceterClientOnVideoEventUpdate(nowTime, VideoEventMotion, ObjectUnknown, grid);
+    FaceterClientOnVideoEventUpdate(nowTime, VideoEventMotion, ObjectUnknown, grid);
+
+    //simple motion event ended
+    FaceterClientOnVideoEventEnd(nowTime, VideoEventMotion, ObjectUnknown, grid);
 
     //human motion event
     DetectionAttribute* humanAttrList = NULL;
     PushHumanAttibutes(&humanAttrList, GenderMale, 30);
     DetectionRect* humanRect = NULL;
     PushDetectionRect(&humanRect, 10, 15, 25, 49);
-    FaceterClientOnVideoEvent(VideoEventMotion, ObjectHuman, humanAttrList, humanRect, snapshotJpegImage, snapshotJpegBytesCount);
+    FaceterClientOnVideoEventStart(nowTime, VideoEventMotion, ObjectHuman, humanAttrList, grid, snapshotJpegImage, snapshotJpegBytesCount);
+    FaceterClientOnVideoEventUpdate(nowTime, VideoEventMotion, ObjectHuman, grid);
+    FaceterClientOnVideoEventEnd(nowTime, VideoEventMotion, ObjectHuman, grid);
 
     //animal motion event
     DetectionAttribute* animalAttrList = NULL;
     PushDetectionAttribute(&animalAttrList, "kind", "cat");
-    FaceterClientOnVideoEvent(VideoEventMotion, ObjectAnimal, animalAttrList, NULL, snapshotJpegImage, snapshotJpegBytesCount);
+    FaceterClientOnVideoEvent(nowTime, VideoEventMotion, ObjectAnimal, animalAttrList, grid, snapshotJpegImage, snapshotJpegBytesCount);
 
     //line crossing event
-    DetectionRect* crossRects = NULL;
-    PushDetectionRect(&crossRects, 1, 5, 25, 49);
-    PushDetectionRect(&crossRects, 30, 45, 5, 17);
-    FaceterClientOnVideoEvent(VideoEventLineCrossing, ObjectOther, NULL, crossRects, snapshotJpegImage, snapshotJpegBytesCount);
+    grid.cells[1] = 12345;
+    FaceterClientOnVideoEvent(nowTime, VideoEventLineCrossing, ObjectOther, NULL, grid, snapshotJpegImage, snapshotJpegBytesCount);
 
     //vehicle line crossing event
     DetectionAttribute* vehicleAttrList = NULL;
     PushVehicleAttributes(&vehicleAttrList, VehicleCar, "AB123");
-    FaceterClientOnVideoEvent(VideoEventLineCrossing, ObjectVehicle, vehicleAttrList, NULL, snapshotJpegImage, snapshotJpegBytesCount);
+    FaceterClientOnVideoEvent(nowTime, VideoEventLineCrossing, ObjectVehicle, vehicleAttrList, grid, snapshotJpegImage, snapshotJpegBytesCount);
 
     //loitering event
-    FaceterClientOnVideoEvent(VideoEventLoitering, ObjectHuman, NULL, NULL, NULL, 0);
+    FaceterClientOnVideoEvent(nowTime, VideoEventLoitering, ObjectHuman, NULL, grid, NULL, 0);
 
     //baby cry audio event
     FaceterClientOnAudioEvent(AudioEventCry);