wcwebcamclient.h

Go to the documentation of this file.

 
#ifndef WCWEBCAMCLIENT_H
#define WCWEBCAMCLIENT_H
 
#define COMMON_FUNC_ONLY
#ifdef COMMON_FUNC_ONLY
#include "wcCommonCallbacks.h"
#else
#include "wcCallbacks.h"
#endif
 
#if !defined(__WINDOWS__) && (defined(WIN32) || defined(WIN64) || defined(_MSC_VER) || defined(_WIN32))
#define __WINDOWS__
#endif
 
#ifdef _ANDROID_COMPILER_
#define DLLEXPORT
#else
#ifdef DLL_BUILD
#if defined(_MSC_VER)
    //  Microsoft
    #define DLLEXPORT __declspec(dllexport)
#elif defined(__GNUC__)
    //  GCC
    #ifdef __WINDOWS__
    #define DLLEXPORT __attribute__ ((dllexport))
    #else
    #define DLLEXPORT __attribute__ ((visibility ("default")))
    #endif
#endif
#else
#ifdef __cplusplus
#include <cstddef>
#endif
#if defined(_MSC_VER)
    //  Microsoft
    #define DLLEXPORT __declspec(dllimport)
#elif defined(__GNUC__)
    //  GCC
    #define DLLEXPORT
#endif
#endif
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
typedef int wcStateVal;
 
 
typedef int wcRCode;
 
const wcRCode WC_TRUE = 1;
 
const wcRCode WC_FALSE = 0;
 
const wcRCode WC_OK = 0;
 
const wcRCode WC_BAD_TARGET = -1;
 
const wcRCode WC_BAD_PARAM = -2;
 
const wcRCode WC_BAD_VALUE = -3;
 
const wcRCode WC_CLIENT_NOT_STREAMING = -4;
 
const wcRCode WC_NOT_A_TASK = -5;
 
const wcRCode WC_TASK_MISMATCH = -6;
 
const wcRCode WC_NOT_ENOUGH_MEM  = -7;
typedef int wcHandle;
 
typedef wcCallbackTask wcTask;
 
typedef uint32_t wcTaskClass;
 
const wcTaskClass WC_BASE_TASK = 0;
const wcTaskClass WC_TASK = 1;
const wcTaskClass WC_IN_STREAM_TASK = 2;
const wcTaskClass WC_OUT_STREAM_TASK = 4;
const wcTaskClass WC_ALL_TASKS = 0xffffffff;
 
const uint16_t WC_STREAM_FRAME_HEADER_SIZE = sizeof(uint16_t) + sizeof(uint32_t);
const uint16_t WC_FRAME_START_SEQ = 0xaaaa;
 
#ifdef _MSC_VER
__pragma( pack(push, 1) )
#endif
 
typedef enum wcCallback {
    /* maintaining block */
    wccbkInitCURL=0,               
    wccbkSuccessAuth,              
    wccbkConnected,                
    wccbkDisconnect,               
    wccbkSIDSetted,                
    wccbkAddLog,                   
    wccbkSynchroUpdateTask,        
    /* streams block */
    wccbkAfterLaunchInStream,      
    wccbkAfterLaunchOutStream,     
    wccbkSuccessIOStream,          
    /* data blobs block */
    wccbkSuccessSaveRecord,        
    wccbkSuccessRequestRecord,     
    /* JSON block */
    wccbkSuccessUpdateRecords,     
    wccbkSuccessUpdateDevices,     
    wccbkSuccessUpdateStreams,     
    wccbkSuccessUpdateMsgs,        
    wccbkSuccessSendMsg,           
    wccbkSuccessRequestRecordMeta, 
    wccbkSuccessGetConfig,         
    wccbkSuccessDeleteRecords,     
    wccbkLast}
#ifdef __GNUC__
__attribute__((__packed__))
#endif
wcCallback;
typedef enum wcStateId {
    wcstConnection      = 0,   
    wcstVerifyTLS       = 1,   
    wcstError           = 2,   
    wcstLog             = 3,   
    wcstStreaming       = 4,   
    wcstStreams         = 5,   
    wcstDevices         = 6,   
    wcstRecords         = 7,   
    wcstRecordsStamp    = 8,   
    wcstMsgs            = 9,   
    wcstSendWithSync    = 22,  
    wcstMsgsStamp       = 10,  
    wcstMetaData        = 11,  
    wcstDeviceName      = 12,  
    wcstSID             = 13,  
    wcstHostName        = 14,  
    wcstProxy           = 15,  
    wcstProxyAuth       = 16,  
    wcstProxyProtocol   = 17,  
    wcstProxyHost       = 18,  
    wcstProxyPort       = 19,  
    wcstProxyUser       = 20,  
    wcstProxyPwrd       = 21   
}
#ifdef __GNUC__
__attribute__((__packed__))
#endif
wcStateId;
 
typedef enum wcTaskStateId {
    wctstError = 0,           
    wctstPath,                
    wctstSubProto,            
    wctstDeviceName           
}
#ifdef __GNUC__
__attribute__((__packed__))
#endif
wcTaskStateId;
#ifdef _MSC_VER
__pragma( pack(pop))
#endif
 
typedef void (*EmptyNotifyLibFunc) (wcHandle client);
typedef void (*NotifyEventLibFunc) (wcHandle client, void * data);
typedef void (*TaskNotifyLibFunc) (wcHandle client, wcTask tsk);
typedef void (*ConnNotifyEventLibFunc) (wcHandle client, int state);
typedef void (*CStringNotifyLibFunc) (wcHandle client, const char * value);
typedef void (*DataNotifyEventLibFunc) (wcHandle client, wcTask tsk, void * strm);
typedef void (*DataAltNotifyEventLibFunc) (wcHandle client, wcTask tsk, void* data, size_t sz);
typedef void (*JSONStrNotifyEventLibFunc) (wcHandle client, wcTask tsk, const char * jsonStr);
 
#ifndef COMMON_FUNC_ONLY
typedef void (*cJSONNotifyEventLibFunc) (wcHandle client, wcTask tsk, const cJSON * jsonObj);;
typedef void (*StringNotifyLibFunc) (wcHandle client, const std::string& value);
typedef void (*JSONNotifyEventLibFunc) (wcHandle client, wcTask tsk, wcJSON& jsonObj);
#endif
 
void DLLEXPORT wcGetLibVersion(uint8_t * vmajor, uint8_t * vminor, uint16_t * vrev);
 
wcHandle DLLEXPORT wcClientCreate();
 
wcRCode DLLEXPORT wcClientStart(wcHandle client);
 
wcRCode DLLEXPORT wcClientAuth(wcHandle client, const char * aLogin, const char * aPwrd);
 
wcRCode DLLEXPORT wcClientProceed(wcHandle client);
 
wcRCode DLLEXPORT wcClientTasksProceed(wcHandle client);
 
wcRCode DLLEXPORT wcClientDisconnect(wcHandle client);
 
wcRCode DLLEXPORT wcClientDestroy(wcHandle client);
 
wcRCode DLLEXPORT wcClientInvalidateState(wcHandle client, wcStateId aStateId);
 
wcRCode DLLEXPORT wcClientGetIntState(wcHandle client, wcStateId aStateId, int * aStateVal);
 
wcRCode DLLEXPORT wcClientGetBoolState(wcHandle client, wcStateId aStateId);
 
wcRCode DLLEXPORT wcClientSetBoolState(wcHandle client, wcStateId aStateId, wcStateVal aStateVal);
 
wcRCode DLLEXPORT wcClientGetStrValue(wcHandle client, wcStateId aStateId, char ** aStateVal);
 
wcRCode DLLEXPORT wcClientGetStrNValue(wcHandle client, wcStateId aStateId, uint32_t sz, char * aStateVal);
 
wcRCode DLLEXPORT wcClientSetStrValue(wcHandle client, wcStateId aStateId, const char * aStateVal);
 
wcRCode DLLEXPORT wcSetNotifyCallback(wcHandle client, wcCallback callbackId, NotifyEventLibFunc func);
 
wcRCode DLLEXPORT wcSetTaskCallback(wcHandle client, wcCallback callbackId, TaskNotifyLibFunc func);
 
wcRCode DLLEXPORT wcSetConnCallback(wcHandle client, ConnNotifyEventLibFunc func);
 
wcRCode DLLEXPORT wcSetCStringCallback(wcHandle client, wcCallback callbackId, CStringNotifyLibFunc func);
#ifndef COMMON_FUNC_ONLY
 
wcRCode DLLEXPORT wcSetStringCallback(wcHandle client, wcCallback callbackId, StringNotifyLibFunc func);
#endif
 
wcRCode DLLEXPORT wcSetAltDataCallback(wcHandle client, wcCallback callbackId, DataAltNotifyEventLibFunc func);
#ifndef COMMON_FUNC_ONLY
 
wcRCode DLLEXPORT wcSetDataCallback(wcHandle client, wcCallback callbackId, DataNotifyEventLibFunc func);
#endif
 
wcRCode DLLEXPORT wcSetJSONStrCallback(wcHandle client, wcCallback callbackId, JSONStrNotifyEventLibFunc func);
#ifndef COMMON_FUNC_ONLY
 
wcRCode DLLEXPORT wcSetcJSONCallback(wcHandle client,   wcCallback callbackId, cJSONNotifyEventLibFunc func);
 
wcRCode DLLEXPORT wcSetJSONCallback(wcHandle client,    wcCallback callbackId, JSONNotifyEventLibFunc func);
#endif
 
wcRCode DLLEXPORT wcGetConfig(wcHandle client, void * data);
 
wcRCode DLLEXPORT wcSetConfig(wcHandle client, const char * cfg);
 
wcRCode DLLEXPORT wcDeleteRecords(wcHandle client, const char * indices, void * data);
 
wcRCode DLLEXPORT wcSendMsg(wcHandle client, const char * msg, void * data);
#ifndef COMMON_FUNC_ONLY
 
wcRCode DLLEXPORT wcSendMsg_cJson(wcHandle client, cJSON * msg, void * data);
#endif
 
wcRCode DLLEXPORT wcRequestRecord(wcHandle client, int rid, void * data);
 
wcRCode DLLEXPORT wcRequestRecordMeta(wcHandle client, int rid, void * data);
 
wcRCode DLLEXPORT wcSaveRecord(wcHandle client, const void * aBuf, size_t  sz, const char * meta, void * data);
 
wcRCode DLLEXPORT wcLaunchOutStream(wcHandle client, const char * subProtocol, int delta, void * data);
 
wcRCode DLLEXPORT wcLaunchInStream(wcHandle client, const char * deviceName, void * data);
 
wcRCode DLLEXPORT wcClientGetFrameID(wcHandle client, long * id);
 
wcRCode DLLEXPORT wcClientFrameLock(wcHandle client);
 
wcRCode DLLEXPORT wcClientFrameUnLock(wcHandle client);
 
wcRCode DLLEXPORT wcClientFramePushData(wcHandle client, const void * data, size_t len);
 
wcRCode DLLEXPORT wcClientFrameGetData(wcHandle client, void ** data, size_t * len);
 
wcRCode DLLEXPORT wcTaskGetClass(wcTask task, wcTaskClass * id);
 
wcRCode DLLEXPORT wcTaskGetUserData(wcTask task, void ** data);
 
wcRCode DLLEXPORT wcTaskSetUserData(wcTask task, void * data);
 
wcRCode DLLEXPORT wcTaskLock(wcTask task);
 
wcRCode DLLEXPORT wcTaskUnLock(wcTask task);
 
wcRCode DLLEXPORT wcTaskGetStrValue(wcTask task, wcTaskStateId aStateId, char ** aStateVal);
 
wcRCode DLLEXPORT wcTaskGetStrNValue(wcTask task, wcTaskStateId aStateId, uint32_t sz, char * aStateVal);
 
wcRCode DLLEXPORT wcInTaskPopFrame(wcTask task, void ** data, size_t * len);
#ifdef __cplusplus
}
#endif
 
#endif // WCWEBCAMCLIENT_H