nx_video_source_sdk  1.0
Video Source SDK
camera_plugin.h
1 // Copyright 2018-present Network Optix, Inc. Licensed under MPL 2.0: www.mozilla.org/MPL/2.0/
2 
3 #ifndef NX_CAMERA_PLUGIN_H
4 #define NX_CAMERA_PLUGIN_H
5 
6 #include <cstring>
7 #include <stdint.h>
8 
9 #include "camera_plugin_types.h"
10 #include <plugins/plugin_api.h>
11 
13 
28 namespace nxcip
29 {
30  // TODO: Change to signed int64_t.
31  typedef unsigned long long int UsecUTCTimestamp;
32  static const UsecUTCTimestamp INVALID_TIMESTAMP_VALUE = (UsecUTCTimestamp)-1LL;
33 
34  static const int MAX_TEXT_LEN = 1024;
35 
36  //Error codes. Interface implementation MUST use these error codes when appropriate
37 
38  static const int NX_NO_ERROR = 0;
39  static const int NX_NOT_AUTHORIZED = -1;
40  static const int NX_INVALID_ENCODER_NUMBER = -2;
41  static const int NX_UNKNOWN_PORT_NAME = -3;
42  static const int NX_UNSUPPORTED_CODEC = -8;
43  static const int NX_UNSUPPORTED_RESOLUTION = -9;
44  static const int NX_UNDEFINED_BEHAVOUR = -20;
45  static const int NX_NOT_IMPLEMENTED = -21;
46  static const int NX_NETWORK_ERROR = -22;
47  static const int NX_MORE_DATA = -23;
48  static const int NX_NO_DATA = -24;
49  static const int NX_IO_ERROR = -25;
51  static const int NX_TRY_AGAIN = -26;
53  static const int NX_INTERRUPTED = -27;
54  static const int NX_PARAM_READ_ONLY = -40;
55  static const int NX_UNKNOWN_PARAMETER = -41;
56  static const int NX_INVALID_PARAM_VALUE = -42;
57  static const int NX_OTHER_ERROR = -100;
58 
59  class BaseCameraManager;
60 
61  // {0D06134F-16D0-41c8-9752-A33E81FE9C75}
62  static const nxpl::NX_GUID IID_CameraDiscoveryManager = { { 0x0d, 0x06, 0x13, 0x4f, 0x16, 0xd0, 0x41, 0xc8, 0x97, 0x52, 0xa3, 0x3e, 0x81, 0xfe, 0x9c, 0x75 } };
63 
64  // {0D06134F-16D0-41c8-9752-A33E81FE9C74}
65  static const nxpl::NX_GUID IID_CameraDiscoveryManager2 = { { 0x0d, 0x06, 0x13, 0x4f, 0x16, 0xd0, 0x41, 0xc8, 0x97, 0x52, 0xa3, 0x3e, 0x81, 0xfe, 0x9c, 0x74 } };
66 
67  // {FEA0452D-8493-4FF3-83E9-72D5BF75A9DE}
68  static const nxpl::NX_GUID IID_CameraDiscoveryManager3 = { { 0xFE, 0xA0, 0x45, 0x2D, 0x84, 0x93, 0x4F, 0xF3, 0x83, 0xE9, 0x72, 0xD5, 0xBF, 0x75, 0xA9, 0xDE } };
69 
71  struct CameraInfo
72  {
74  char modelName[256];
76  char firmware[256];
78  char uid[256];
80  char url[MAX_TEXT_LEN];
82  char auxiliaryData[256];
84  char defaultLogin[256];
86  char defaultPassword[256];
87 
90  {
91  memset(this, 0, sizeof(CameraInfo));
92  }
93 
94  CameraInfo(const CameraInfo& value)
95  {
96  strncpy(modelName, value.modelName, sizeof(modelName) - 1);
97  modelName[sizeof(modelName) - 1] = '\0';
98 
99  strncpy(firmware, value.firmware, sizeof(firmware) - 1);
100  firmware[sizeof(firmware) - 1] = '\0';
101 
102  strncpy(uid, value.uid, sizeof(uid) - 1);
103  uid[sizeof(uid) - 1] = '\0';
104 
105  strncpy(url, value.url, sizeof(url) - 1);
106  url[sizeof(url) - 1] = '\0';
107 
108  strncpy(auxiliaryData, value.auxiliaryData, sizeof(auxiliaryData) - 1);
109  auxiliaryData[sizeof(auxiliaryData) - 1] = '\0';
110 
111  strncpy(defaultLogin, value.defaultLogin, sizeof(defaultLogin) - 1);
112  defaultLogin[sizeof(defaultLogin) - 1] = '\0';
113 
114  strncpy(defaultPassword, value.defaultPassword, sizeof(defaultPassword) - 1);
115  defaultPassword[sizeof(defaultPassword) - 1] = '\0';
116  }
117  };
118 
119  struct CameraInfo2: public CameraInfo
120  {
122  {
123  groupId[0] = 0;
124  groupName[0] = 0;
125  }
126 
127  CameraInfo2(const CameraInfo& value):
128  CameraInfo(value)
129  {
130  groupId[0] = 0;
131  groupName[0] = 0;
132  }
133 
134  CameraInfo2(const CameraInfo2& value):
135  CameraInfo(value)
136  {
137  strncpy(groupId, value.groupId, sizeof(groupId) - 1);
138  strncpy(groupName, value.groupName, sizeof(groupName) - 1);
139  }
140 
141  char groupId[256];
142  char groupName[256];
143  };
144 
145  static const int CAMERA_INFO_ARRAY_SIZE = 256;
146  static const int MAX_MODEL_NAME_SIZE = 256;
147 
149 
163  {
164  public:
165  virtual ~CameraDiscoveryManager() {}
166 
168 
171  virtual void getVendorName( char* buf ) const = 0;
172 
174 
181  virtual int findCameras( CameraInfo* cameras, const char* serverURL ) = 0;
183 
193  virtual int checkHostAddress( CameraInfo* cameras, const char* address, const char* login, const char* password ) = 0;
195 
205  virtual int fromMDNSData(
206  const char* discoveryAddress,
207  const unsigned char* mdnsResponsePacket,
208  int mdnsResponsePacketSize,
209  CameraInfo* cameraInfo ) = 0;
211 
220  virtual int fromUpnpData( const char* upnpXMLData, int upnpXMLDataSize, CameraInfo* cameraInfo ) = 0;
221 
223 
226  virtual BaseCameraManager* createCameraManager( const CameraInfo& info ) = 0;
227 
229 
241  virtual int getReservedModelList( char** modelList, int* count ) = 0;
242  };
243 
245  {
246  public:
247  CameraDiscoveryManager2() = default;
248 
249  virtual int checkHostAddress2(nxcip::CameraInfo2* cameras, const char* address, const char* login, const char* password) = 0;
250  virtual int findCameras2(CameraInfo2* cameras, const char* serverURL) = 0;
251  };
252 
254  {
255  public:
256  enum Capability
257  {
258  noCapability = 0,
259  findLocalResources = 1 //< CameraDiscovery can find local resources without IP.
260  };
261 
262  CameraDiscoveryManager3() = default;
263  virtual int getCapabilities() const = 0;
264  };
265 
267  struct Resolution
268  {
270  int width;
272  int height;
273 
274  Resolution( int _width = 0, int _height = 0 )
275  :
276  width( _width ),
277  height( _height )
278  {
279  }
280  };
281 
284  {
288  float maxFps;
289 
291  :
292  maxFps( 0 )
293  {
294  }
295  };
296 
297  class StreamReader;
298 
299  // {528FD641-52BB-4f8b-B279-6C21FEF5A2BB}
300  static const nxpl::NX_GUID IID_CameraMediaEncoder = { { 0x52, 0x8f, 0xd6, 0x41, 0x52, 0xbb, 0x4f, 0x8b, 0xb2, 0x79, 0x6c, 0x21, 0xfe, 0xf5, 0xa2, 0xbb } };
301 
302  static const int MAX_RESOLUTION_LIST_SIZE = 64;
303 
306  :
307  public nxpl::PluginInterface
308  {
309  public:
310  virtual ~CameraMediaEncoder() {}
311 
313 
321  virtual int getMediaUrl( char* urlBuf ) const = 0;
322 
324 
330  virtual int getResolutionList( ResolutionInfo* infoList, int* infoListCount ) const = 0;
331 
333 
337  virtual int getMaxBitrate( int* maxBitrate ) const = 0;
338 
340 
344  virtual int setResolution( const Resolution& resolution ) = 0;
345 
352  virtual int setFps( const float& fps, float* selectedFps ) = 0;
353 
360  virtual int setBitrate( int bitrateKbps, int* selectedBitrateKbps ) = 0;
361  };
362 
363  struct AudioFormat
364  {
366  {
370  stFLT
371  };
372 
373  enum ByteOrderType
374  {
375  boLittleEndian,
376  boBigEndian
377  };
378 
379  CompressionType compressionType;
380  int sampleRate;
382  int bitrate;
383  ByteOrderType byteOrder;
384  int channels;
385  SampleType sampleFmt;
386  int channelLayout;
387  int blockAlign;
388  int bitsPerCodedSample;
389 
390  AudioFormat()
391  :
392  compressionType(AV_CODEC_ID_NONE),
393  sampleRate(0),
394  bitrate(0),
395  byteOrder(boLittleEndian),
396  channels(0),
397  sampleFmt(stU8),
398  channelLayout(0),
399  blockAlign(0),
400  bitsPerCodedSample(0)
401  {
402  }
403  };
404 
405  // {9A1BDA18-563C-42de-8E23-B9244FD00658}
406  static const nxpl::NX_GUID IID_CameraMediaEncoder2 = { { 0x9a, 0x1b, 0xda, 0x18, 0x56, 0x3c, 0x42, 0xde, 0x8e, 0x23, 0xb9, 0x24, 0x4f, 0xd0, 0x6, 0x58 } };
407 
410  {
411  public:
412  virtual ~CameraMediaEncoder2() override {}
413 
415 
420  virtual StreamReader* getLiveStreamReader() = 0;
422  virtual int getAudioFormat( AudioFormat* audioFormat ) const = 0;
423  };
424 
425 #ifndef __GNUC__
426 #pragma pack(push, 1)
427 #define PACKED
428 #else
429 #define PACKED __attribute__((__packed__))
430 #endif
431 
433  struct PACKED LiveStreamConfig
434  {
435  enum LiveStreamFlags
436  {
437  LIVE_STREAM_FLAG_AUDIO_ENABLED = 0x1
438  };
439 
440  int32_t reserved_head;
441  int32_t flags;
442  int32_t codec;
443  int32_t width;
444  int32_t height;
445  float framerate;
446  int32_t bitrateKbps;
447  int16_t quality;
448  int16_t gopLength;
449  uint8_t reserved_tail[96];
450  };
451 #ifndef __GNUC__
452 #pragma pack(pop)
453 #endif
454 #undef PACKED
455 
456  // {D1C7F082-B6F9-45F3-82D6-3CFE3EAE0260}
457  static const nxpl::NX_GUID IID_CameraMediaEncoder3 = { { 0xd1, 0xc7, 0xf0, 0x82, 0xb6, 0xf9, 0x45, 0xf3, 0x82, 0xd6, 0x3c, 0xfe, 0x3e, 0xae, 0x2, 0x60 } };
458 
460  {
461  public:
463 
473  virtual int getConfiguredLiveStreamReader(LiveStreamConfig * config, StreamReader ** reader) = 0;
474 
476 
484  virtual int getVideoFormat(CompressionType * codec, PixelFormat * pixelFormat) const = 0;
485  };
486 
487  // {9807EA20-FA37-4EA7-BF07-9AC61511E1DF}
488  static const nxpl::NX_GUID IID_CameraMediaEncoder4 = { { 0x98, 0x07, 0xEA ,0x20, 0xFA, 0x37, 0x4E, 0xA7, 0xBF, 0x07, 0x9A, 0xC6 ,0x15 ,0x11 ,0xE1, 0xDF } };
490  {
491  public:
493  virtual int setMediaUrl(const char url[nxcip::MAX_TEXT_LEN]) = 0;
494  };
495 
496  // {95d69238-7a07-462f-9364-971dd58b315e}
497  static const nxpl::NX_GUID IID_CameraMediaEncoder5 = { { 0x95, 0xd6, 0x92 ,0x38, 0x7a, 0x07, 0x46, 0x2f, 0x93, 0x64, 0x97, 0x1d ,0xd5 ,0x8b ,0x31, 0x5e } };
499  {
500  public:
502  virtual const char* audioExtradata() const = 0;
503 
505  virtual int audioExtradataSize() const = 0;
506  };
507 
508  class CameraPtzManager;
510  class CameraRelayIOManager;
511  class DtsArchiveReader;
512 
513  // {B7AA2FE8-7592-4459-A52F-B05E8E089AFE}
514  static const nxpl::NX_GUID IID_BaseCameraManager = { { 0xb7, 0xaa, 0x2f, 0xe8, 0x75, 0x92, 0x44, 0x59, 0xa5, 0x2f, 0xb0, 0x5e, 0x8e, 0x8, 0x9a, 0xfe } };
515 
517 
526  :
527  public nxpl::PluginInterface
528  {
529  public:
530  virtual ~BaseCameraManager() {}
531 
533 
542  virtual int getEncoderCount( int* encoderCount ) const = 0;
543 
545 
554  virtual int getEncoder( int encoderIndex, CameraMediaEncoder** encoderPtr ) = 0;
555 
557 
562  virtual int getCameraInfo( CameraInfo* info ) const = 0;
563 
566  {
570  ptzCapability = 0x0008,
571  audioCapability = 0x0010,
574  shareIpCapability = 0x0080,
588  dontAutoOpenCamera = 0x200000,
589  noAnalytics = 0x400000,
590  };
591 
593 
597  virtual int getCameraCapabilities( unsigned int* capabilitiesMask ) const = 0;
598 
600  virtual void setCredentials( const char* username, const char* password ) = 0;
601 
603 
607  virtual int setAudioEnabled( int audioEnabled ) = 0;
608 
610 
614  virtual CameraPtzManager* getPtzManager() const = 0;
616 
623 
627  virtual CameraRelayIOManager* getCameraRelayIOManager() const = 0;
628 
630 
633  virtual void getLastErrorString( char* errorString ) const = 0;
634  };
635 
636  // {A2017C29-CE9E-4829-87BE-9287598A1358}
637  static const nxpl::NX_GUID IID_Picture = { { 0xa2, 0x01, 0x7c, 0x29, 0xce, 0x9e, 0x48, 0x29, 0x87, 0xbe, 0x92, 0x87, 0x59, 0x8a, 0x13, 0x58 } };
638 
640  class Picture
641  :
642  public nxpl::PluginInterface
643  {
644  public:
645  virtual ~Picture() {}
646 
648  virtual PixelFormat pixelFormat() const = 0;
650  virtual int planeCount() const = 0;
652  virtual int width() const = 0;
654  virtual int height() const = 0;
656  virtual int xStride( int planeNumber ) const = 0;
658  virtual const void* scanLine( int planeNumber, int lineNumber ) const = 0;
660  virtual void* scanLine( int planeNumber, int lineNumber ) = 0;
665  virtual void* data() = 0;
666  virtual const void* data() const = 0;
667  };
668 
669  // {8006CC9F-7BDD-4a4c-8920-AC5546D4924A}
670  static const nxpl::NX_GUID IID_TimePeriods = { { 0x80, 0x06, 0xcc, 0x9f, 0x7b, 0xdd, 0x4a, 0x4c, 0x89, 0x20, 0xac, 0x55, 0x46, 0xd4, 0x92, 0x4a } };
671 
674  :
675  public nxpl::PluginInterface
676  {
677  public:
679  virtual void goToBeginning() = 0;
683  virtual bool next() = 0;
687  virtual bool atEnd() const = 0;
693  virtual bool get( UsecUTCTimestamp* start, UsecUTCTimestamp* end ) const = 0;
694  };
695 
698  {
699  public:
711  UsecUTCTimestamp startTime;
713  UsecUTCTimestamp endTime;
721  unsigned long long periodDetailLevel;
722 
728 
732  int limit;
733 
738 
740  :
741  motionMask( 0 ),
742  startTime( INVALID_TIMESTAMP_VALUE ),
743  endTime( INVALID_TIMESTAMP_VALUE ),
745  keepSmallChunks(0),
746  limit(0),
747  descSortOrder(false)
748  {
749  }
750  };
751 
752  // {1181F23B-071C-4608-89E3-648E1A735B54}
753  static const nxpl::NX_GUID IID_BaseCameraManager2 = { { 0x11, 0x81, 0xf2, 0x3b, 0x07, 0x1c, 0x46, 0x08, 0x89, 0xe3, 0x64, 0x8e, 0x1a, 0x73, 0x5b, 0x54 } };
754 
757  :
758  public BaseCameraManager
759  {
760  public:
763  {
766  };
767 
768  virtual ~BaseCameraManager2() {}
769 
771 
776  virtual int createDtsArchiveReader( DtsArchiveReader** dtsArchiveReader ) const = 0;
778 
785  virtual int find( ArchiveSearchOptions* searchOptions, TimePeriods** timePeriods ) const = 0;
787 
797  virtual int setMotionMask( Picture* motionMask ) = 0;
798  };
799 
800  // {840DEECD-2F9B-4859-9081-9592D17177F8}
801  static const nxpl::NX_GUID IID_BaseCameraManager3 = { { 0x84, 0x0d, 0xee, 0xcd, 0x2f, 0x9b, 0x48, 0x59, 0x90, 0x81, 0x95, 0x92, 0xd1, 0x71, 0x77, 0xf8 } };
802 
804 
809  :
810  public BaseCameraManager2
811  {
812  public:
814  {
816  };
817 
819 
823  virtual const char* getParametersDescriptionXML() const = 0;
825 
833  virtual int getParamValue( const char* paramName, char* valueBuf, int* valueBufSize ) const = 0;
835 
844  virtual int setParamValue( const char* paramName, const char* value ) = 0;
845  };
846 
847  // {8BAB5BC7-BEFC-4629-921F-8390A29D8A16}
848  static const nxpl::NX_GUID IID_CameraPTZManager = { { 0x8b, 0xab, 0x5b, 0xc7, 0xbe, 0xfc, 0x46, 0x29, 0x92, 0x1f, 0x83, 0x90, 0xa2, 0x9d, 0x8a, 0x16 } };
849 
851 
870  :
871  public nxpl::PluginInterface
872  {
873  public:
874  virtual ~CameraPtzManager() {}
875 
877  {
878  ContinuousPanCapability = 0x00000001,
881 
882  AbsolutePanCapability = 0x00000010,
883  AbsoluteTiltCapability = 0x00000020,
884  AbsoluteZoomCapability = 0x00000040,
885 
886  FlipPtzCapability = 0x00000100,
887  LimitsPtzCapability = 0x00000200,
888 
891 
895  };
896 
898  {
901  };
902 
903  enum Orientation
904  {
905  Horizontal = 0x1,
906  Vertical = 0x2
907  };
908 
909  struct Limits {
910  double minPan;
911  double maxPan;
912  double minTilt;
913  double maxTilt;
914  double minFov;
915  double maxFov;
916  };
917 
919  virtual int getCapabilities() const = 0;
920 
922 
937  virtual int continuousMove( double panSpeed, double tiltSpeed, double zoomSpeed ) = 0;
938 
940 
956  virtual int absoluteMove( CoordinateSpace space, double pan, double tilt, double zoom, double speed ) = 0;
957 
959 
970  virtual int getPosition( CoordinateSpace space, double *pan, double *tilt, double *zoom ) = 0;
971 
973 
981  virtual int getLimits( CoordinateSpace space, Limits *limits ) = 0;
982 
984 
992  virtual int getFlip( int *flip ) = 0;
993  };
994 
997  {
1003 
1007  dptUnknown,
1008  dptData,
1009  };
1010 
1011  // {763C93DC-A77D-41ff-8071-B64C4D3AFCFF}
1012  static const nxpl::NX_GUID IID_MediaDataPacket = { { 0x76, 0x3c, 0x93, 0xdc, 0xa7, 0x7d, 0x41, 0xff, 0x80, 0x71, 0xb6, 0x4c, 0x4d, 0x3a, 0xfc, 0xff } };
1014  static const unsigned int MEDIA_DATA_BUFFER_ALIGNMENT = 64;
1016  static const unsigned int MEDIA_PACKET_BUFFER_PADDING_SIZE = 64;
1017 
1019 
1024  :
1025  public nxpl::PluginInterface
1026  {
1027  public:
1028  enum Flags
1029  {
1031  fKeyPacket = 0x01,
1036  DEPRECATED_fLowQuality = 0x08,
1042  };
1043 
1045  virtual UsecUTCTimestamp timestamp() const = 0;
1047  virtual DataPacketType type() const = 0;
1049 
1060  virtual const void* data() const = 0;
1062 
1066  virtual unsigned int dataSize() const = 0;
1071  virtual unsigned int channelNumber() const = 0;
1072 
1078  virtual CompressionType codecType() const = 0;
1079 
1081  virtual unsigned int flags() const = 0;
1083 
1087  virtual unsigned int cSeq() const = 0;
1088  };
1089 
1090  // {65E9548D-0BA6-48CB-A217-AE6AE270CE7D}
1091  static const nxpl::NX_GUID IID_MediaDataPacket2 = { { 0x65, 0xe9, 0x54, 0x8d, 0x0b, 0xa6, 0x48, 0xcb, 0xa2, 0x17, 0xae, 0x6a, 0xe2, 0x70, 0xce, 0x7d } };
1092 
1094  {
1095  public:
1097  virtual const char* extradata() const = 0;
1098 
1100  virtual int extradataSize() const = 0;
1101  };
1102 
1103  // {A3F5D1BA-5A74-42BD-8890-A1C6E0197C04}
1104  static const nxpl::NX_GUID IID_Encryptable = { { 0xa3, 0xf5, 0xd1, 0xba, 0x5a, 0x74, 0x42, 0xbd, 0x88, 0x90, 0xa1, 0xc6, 0xe0, 0x19, 0x7c, 0x4 } };
1105 
1112  {
1113  public:
1114  virtual const char* encryptionData() const = 0;
1115  virtual int encryptionDataSize() const = 0;
1116  };
1117 
1118  static const unsigned int DEFAULT_MOTION_DATA_PICTURE_WIDTH = 44;
1119  static const unsigned int DEFAULT_MOTION_DATA_PICTURE_HEIGHT = 32;
1120 
1121  // {A85D884B-F05E-4fff-8B5A-E36570E73067}
1122  static const nxpl::NX_GUID IID_VideoDataPacket = { { 0xa8, 0x5d, 0x88, 0x4b, 0xf0, 0x5e, 0x4f, 0xff, 0x8b, 0x5a, 0xe3, 0x65, 0x70, 0xe7, 0x30, 0x67 } };
1123 
1126  :
1127  public MediaDataPacket
1128  {
1129  public:
1131 
1141  virtual Picture* getMotionData() const = 0;
1142  };
1143 
1144  // {AFE4EEDA-3770-42c3-8381-EE3B55522551}
1145  static const nxpl::NX_GUID IID_StreamReader = { { 0xaf, 0xe4, 0xee, 0xda, 0x37, 0x70, 0x42, 0xc3, 0x83, 0x81, 0xee, 0x3b, 0x55, 0x52, 0x25, 0x51 } };
1146 
1148 
1155  :
1156  public nxpl::PluginInterface
1157  {
1158  public:
1160 
1169  virtual int getNextData( MediaDataPacket** packet ) = 0;
1170 
1172  virtual void interrupt() = 0;
1173  };
1174 
1176  {
1180 
1186  };
1187 
1188  // {CEB97832-E931-4965-9B18-A8A1557107D7}
1189  static const nxpl::NX_GUID IID_DtsArchiveReader = { { 0xce, 0xb9, 0x78, 0x32, 0xe9, 0x31, 0x49, 0x65, 0x9b, 0x18, 0xa8, 0xa1, 0x55, 0x71, 0x7, 0xd7 } };
1190 
1192 
1206  :
1207  public nxpl::PluginInterface
1208  {
1209  public:
1211  {
1213 
1255 
1261  };
1262 
1264  virtual unsigned int getCapabilities() const = 0;
1265 
1267 
1270  virtual int open() = 0;
1272 
1275  virtual StreamReader* getStreamReader() = 0;
1277 
1280  virtual UsecUTCTimestamp startTime() const = 0;
1282 
1285  virtual UsecUTCTimestamp endTime() const = 0;
1287 
1299  virtual int seek(
1300  unsigned int cSeq,
1301  UsecUTCTimestamp timestamp,
1302  bool findKeyFrame,
1303  UsecUTCTimestamp* selectedPosition ) = 0;
1305 
1316  virtual int setReverseMode(
1317  unsigned int cSeq,
1318  bool isReverse,
1319  UsecUTCTimestamp timestamp,
1320  UsecUTCTimestamp* selectedPosition ) = 0;
1322  virtual bool isReverseModeEnabled() const = 0;
1324 
1328  virtual int setMotionDataEnabled( bool motionPresent ) = 0;
1330 
1340  virtual int setQuality(
1341  MediaStreamQuality quality,
1342  bool waitForKeyFrame ) = 0;
1344 
1356  virtual int playRange(
1357  unsigned int cSeq,
1358  UsecUTCTimestamp start,
1359  UsecUTCTimestamp endTimeHint,
1360  unsigned int step ) = 0;
1361 
1363 
1366  virtual void getLastErrorString( char* errorString ) const = 0;
1367  };
1368 
1369  // {C6F06A48-8E3A-4690-8B21-CAC4A955D7ED}
1370  static const nxpl::NX_GUID IID_CameraMotionDataProvider = { { 0xc6, 0xf0, 0x6a, 0x48, 0x8e, 0x3a, 0x46, 0x90, 0x8b, 0x21, 0xca, 0xc4, 0xa9, 0x55, 0xd7, 0xed } };
1371 
1374  :
1375  public nxpl::PluginInterface
1376  {
1377  public:
1378  //TODO for future use
1379  };
1380 
1382 
1383  // {872F473F-72CF-4397-81E6-C06D42E97113}
1384  static const nxpl::NX_GUID IID_CameraRelayIOManager = { { 0x87, 0x2f, 0x47, 0x3f, 0x72, 0xcf, 0x43, 0x97, 0x81, 0xe6, 0xc0, 0x6d, 0x42, 0xe9, 0x71, 0x13 } };
1385 
1386  static const int MAX_ID_LEN = 64;
1387  static const int MAX_RELAY_PORT_COUNT = 32;
1388 
1390 
1394  :
1395  public nxpl::PluginInterface
1396  {
1397  public:
1399 
1404  virtual int getRelayOutputList( char** idList, int* idNum ) const = 0;
1405 
1407 
1412  virtual int getInputPortList( char** idList, int* idNum ) const = 0;
1413 
1415 
1421  virtual int setRelayOutputState(
1422  const char* outputID,
1423  int activate,
1424  unsigned int autoResetTimeoutMS ) = 0;
1425 
1427 
1432  virtual int startInputPortMonitoring() = 0;
1433 
1435 
1442  virtual void stopInputPortMonitoring() = 0;
1443 
1445 
1449  virtual void registerEventHandler( CameraInputEventHandler* handler ) = 0;
1450 
1452 
1461  virtual void unregisterEventHandler( CameraInputEventHandler* handler ) = 0;
1462 
1464 
1467  virtual void getLastErrorString( char* errorString ) const = 0;
1468  };
1469 
1470  // {CC1E749F-2EC6-4b73-BEC9-8F2AE9B7FCCE}
1471  static const nxpl::NX_GUID IID_CameraInputEventHandler = { { 0xcc, 0x1e, 0x74, 0x9f, 0x2e, 0xc6, 0x4b, 0x73, 0xbe, 0xc9, 0x8f, 0x2a, 0xe9, 0xb7, 0xfc, 0xce } };
1472 
1475  :
1476  public nxpl::PluginInterface
1477  {
1478  public:
1479  virtual ~CameraInputEventHandler() {}
1480 
1482 
1489  virtual void inputPortStateChanged(
1490  CameraRelayIOManager* source,
1491  const char* inputPortID,
1492  int newState,
1493  unsigned long int timestamp ) = 0;
1494  };
1495 }
1496 
1497 #endif //NX_CAMERA_PLUGIN_H
Definition: time_periods.h:12
Resolution resolution
Guess what.
Definition: camera_plugin.h:286
VMS Camera Integration Plugin API (c++)
Definition: camera_plugin.h:28
virtual int getEncoderCount(int *encoderCount) const =0
Provides maximum number of available encoders.
Camera supports absolute positioning in device-specific coordinate space.
Definition: camera_plugin.h:889
virtual const void * scanLine(int planeNumber, int lineNumber) const =0
Returns pointer to horizontal line lineNumber (starting with 0) of plane planeNumber.
CameraCapability3
Definition: camera_plugin.h:813
virtual bool next()=0
Camera sends absolute timestamps in media stream.
Definition: camera_plugin.h:584
virtual int extradataSize() const =0
Returns size of extradata blob in bytes.
virtual unsigned int dataSize() const =0
Returns size (in bytes) of packet&#39;s data.
int bitrate
in bps
Definition: camera_plugin.h:382
char modelName[256]
Camera model name in any human readable format. MUST NOT be empty.
Definition: camera_plugin.h:74
Set of options, used to search archive.
Definition: camera_plugin.h:697
virtual unsigned int cSeq() const =0
Returns sequence number of command this packet belongs to.
virtual StreamReader * getStreamReader()=0
Returns stream reader.
int width
Width in pixels.
Definition: camera_plugin.h:270
virtual int width() const =0
Width (pixels)
Provides encoder parameter configuration and media stream access (by providing media stream url) ...
Definition: camera_plugin.h:305
virtual int getMaxBitrate(int *maxBitrate) const =0
Returns maximum bitrate in Kbps. 0 is interpreted as unlimited bitrate value.
virtual void setCredentials(const char *username, const char *password)=0
Set credentials for camera access.
char auxiliaryData[256]
Any data in implementation defined format (for internal plugin usage)
Definition: camera_plugin.h:82
Extends BaseCameraManager2 by adding editable parameters.
Definition: camera_plugin.h:808
virtual int getReservedModelList(char **modelList, int *count)=0
Get model names, reserved by the plugin.
Definition: camera_plugin.h:1111
CoordinateSpace
Definition: camera_plugin.h:897
if present, nxcip::BaseCameraManager2::find supports ArchiveSearchOptions::motionMask() ...
Definition: camera_plugin.h:764
virtual void getLastErrorString(char *errorString) const =0
Returns text description of the last error.
DataPacketType
Type of packets provided by StreamReader.
Definition: camera_plugin.h:996
Provides access to motion detection support, implemented on camera.
Definition: camera_plugin.h:1373
bool descSortOrder
Definition: camera_plugin.h:737
virtual unsigned int channelNumber() const =0
Definition: camera_plugin.h:909
static const int NX_INTERRUPTED
Blocking call has been interrupted (e.g., by StreamReader::interrupt)
Definition: camera_plugin.h:53
virtual int audioExtradataSize() const =0
Returns size of audio extra data in bytes.
virtual int getResolutionList(ResolutionInfo *infoList, int *infoListCount) const =0
Returns supported resolution list.
provides media stream through StreamReader interface, otherwise - CameraMediaEncoder::getMediaUrl is ...
Definition: camera_plugin.h:576
allow multiple instances on a same IP address
Definition: camera_plugin.h:574
virtual int height() const =0
Height (pixels)
virtual int getConfiguredLiveStreamReader(LiveStreamConfig *config, StreamReader **reader)=0
Returns configured stream reader, providing live data stream. Required method!
virtual bool atEnd() const =0
virtual void getVendorName(char *buf) const =0
Returns utf-8 camera vendor name.
virtual CameraMotionDataProvider * getCameraMotionDataProvider() const =0
MUST return not-NULL if hardwareMotionCapability is present.
virtual int setQuality(MediaStreamQuality quality, bool waitForKeyFrame)=0
Select media stream quality (used for dynamic media stream adaptation)
float maxFps
Maximum fps, allowed for resolution.
Definition: camera_plugin.h:288
virtual const char * audioExtradata() const =0
Returns pointer to audio extra data.
CameraCapability
Enumeration of supported camera capabilities (bit flags)
Definition: camera_plugin.h:565
Definition: camera_plugin.h:253
Definition: camera_plugin.h:433
Camera supports absolute pan.
Definition: camera_plugin.h:882
if this flag is enabled, CameraRelayIOManager MUST be implemented
Definition: camera_plugin.h:569
Camera supports absolute zoom.
Definition: camera_plugin.h:884
virtual void inputPortStateChanged(CameraRelayIOManager *source, const char *inputPortID, int newState, unsigned long int timestamp)=0
Called by CameraRelayIOManager on input port event.
virtual void unregisterEventHandler(CameraInputEventHandler *handler)=0
Removes handler from event receiver list.
virtual void stopInputPortMonitoring()=0
Stops input port monitoring if internal monitoring counter has reached zero.
Contains resolution and maximum fps, supported by camera for this resolution.
Definition: camera_plugin.h:283
virtual int continuousMove(double panSpeed, double tiltSpeed, double zoomSpeed)=0
Starts or stops continuous PTZ movement.
Camera is bound to a particular server.
Definition: camera_plugin.h:587
virtual bool isReverseModeEnabled() const =0
Returns true if reverse mode is currently on.
Base class for every interface, provided by plugin.
Definition: plugin_api.h:44
virtual const char * getParametersDescriptionXML() const =0
Returns XML describing camera parameters.
virtual unsigned int flags() const =0
Returns combination of values from MediaDataPacket::Flags enumeration.
Flags
Definition: camera_plugin.h:1028
virtual int setFps(const float &fps, float *selectedFps)=0
virtual CompressionType codecType() const =0
virtual int planeCount() const =0
Returns number of planes in picture (this depends on format)
virtual UsecUTCTimestamp startTime() const =0
Returns timestamp (usec (microseconds) since 1970-01-01, UTC) of oldest data, present in the archive...
Definition: camera_plugin.h:363
virtual void interrupt()=0
Interrupt StreamReader::getNextData blocked in other thread.
camera parameters can be read/set even if camera is not accessible at the moment
Definition: camera_plugin.h:578
bool keepSmallChunks
Definition: camera_plugin.h:727
virtual int getRelayOutputList(char **idList, int *idNum) const =0
Returns list of IDs of available relay output ports.
virtual int seek(unsigned int cSeq, UsecUTCTimestamp timestamp, bool findKeyFrame, UsecUTCTimestamp *selectedPosition)=0
Seek to specified position in stream.
Used for reading media stream from camera.
Definition: camera_plugin.h:1154
e.g., h.264 IDR frame
Definition: camera_plugin.h:1031
virtual int absoluteMove(CoordinateSpace space, double pan, double tilt, double zoom, double speed)=0
Sets camera PTZ position in the given coordinate space.
virtual StreamReader * getLiveStreamReader()=0
Returns stream reader, providing live data stream.
virtual void goToBeginning()=0
Move cursor to the first position.
virtual void * data()=0
CameraCapability2
Enumeration of supported camera capabilities (bit flags)
Definition: camera_plugin.h:762
signed 16 bits
Definition: camera_plugin.h:368
Receives events on input port state change.
Definition: camera_plugin.h:1474
Definition: camera_plugin.h:1093
Default quality SHOULD be high quality.
Definition: camera_plugin.h:1178
Definition: camera_plugin.h:498
char url[MAX_TEXT_LEN]
Camera management url. Can contain just address. MUST NOT be empty.
Definition: camera_plugin.h:80
virtual const char * extradata() const =0
Returns pointer to extradata blob.
static const unsigned int MEDIA_DATA_BUFFER_ALIGNMENT
Required alignment of MediaDataPacket::data() buffer.
Definition: camera_plugin.h:1014
virtual int getFlip(int *flip)=0
Gets the camera streams&#39;s flipped state.
Picture * motionMask
Definition: camera_plugin.h:709
int32_t reserved_head
reserved, do not use
Definition: camera_plugin.h:440
Provides access to archive, stored on camera.
Definition: camera_plugin.h:1205
SampleType
Definition: camera_plugin.h:365
if set, camera supports audio
Definition: camera_plugin.h:571
if present, nxcip::BaseCameraManager3::setMotionMask is implemented
Definition: camera_plugin.h:765
virtual int setRelayOutputState(const char *outputID, int activate, unsigned int autoResetTimeoutMS)=0
Change state of relay output port.
virtual unsigned int getCapabilities() const =0
Returns bit mask with supported capabilities.
motion data can be provided in media stream
Definition: camera_plugin.h:1260
GUID of plugin interface.
Definition: plugin_api.h:26
virtual int getMediaUrl(char *urlBuf) const =0
Returns url of media stream as NULL-terminated utf-8 string.
virtual int setMotionDataEnabled(bool motionPresent)=0
Toggle motion data in media stream on/off.
This interface is used to find cameras and create BaseCameraManager instance.
Definition: camera_plugin.h:162
virtual int findCameras(CameraInfo *cameras, const char *serverURL)=0
Vendor-specific camera search method. Returns list of found cameras.
virtual UsecUTCTimestamp timestamp() const =0
Packet&#39;s timestamp (usec (microseconds) since 1970-01-01, UTC)
Extends BaseCameraManager by adding remote archive storage support (e.g., storage is mounted directly...
Definition: camera_plugin.h:756
Logical coordinate space — degrees for pan, tilt and fov (zoom).
Definition: camera_plugin.h:900
virtual int open()=0
Initialize connection to archive.
virtual int checkHostAddress(CameraInfo *cameras, const char *address, const char *login, const char *password)=0
Check host for camera presence.
Contains base camera information.
Definition: camera_plugin.h:71
Audio packet. Can contain multiple audio frames.
Definition: camera_plugin.h:999
Capabilities
Definition: camera_plugin.h:1210
CameraInfo()
Initializes all values with zeros/empty strings.
Definition: camera_plugin.h:89
virtual int setBitrate(int bitrateKbps, int *selectedBitrateKbps)=0
int32_t codec
Definition: camera_plugin.h:442
Resolution of video stream picture.
Definition: camera_plugin.h:267
virtual void getLastErrorString(char *errorString) const =0
Returns text description of the last error.
if second stream is running whatever megapixel it has => first stream can get maxMegapixels - seconds...
Definition: camera_plugin.h:573
static const unsigned int MEDIA_PACKET_BUFFER_PADDING_SIZE
Required padding after media data (see MediaDataPacket::data() description)
Definition: camera_plugin.h:1016
virtual int startInputPortMonitoring()=0
Starts relay input monitoring or increments internal counter, if already started. ...
Pan-tilt-zoom management.
Definition: camera_plugin.h:869
Camera supports continuous tilt.
Definition: camera_plugin.h:879
camera&#39;s media streams are editable and can be provided directly via setProperty API call...
Definition: camera_plugin.h:583
virtual int getParamValue(const char *paramName, char *valueBuf, int *valueBufSize) const =0
Reads value of parameter paramName.
Definition: camera_plugin.h:244
Picture.
Definition: camera_plugin.h:640
Extends CameraMediaEncoder by adding functionality for plugin to directly provide live media stream...
Definition: camera_plugin.h:409
signed 32 bits
Definition: camera_plugin.h:369
char defaultPassword[256]
Plugin can specify default credentials to use with camera.
Definition: camera_plugin.h:86
if present, nxcip::BaseCameraManager3::setMotionMask is implemented
Definition: camera_plugin.h:580
unsigned 8 bits
Definition: camera_plugin.h:367
Relay input/output management.
Definition: camera_plugin.h:1393
char firmware[256]
Firmware version in any human readable format. Optional.
Definition: camera_plugin.h:76
Definition: camera_plugin.h:119
Low quality.
Definition: camera_plugin.h:1185
Signals that reverse playback by GOP (group of picture) reordering is supported.
Definition: camera_plugin.h:1253
virtual void getLastErrorString(char *errorString) const =0
Returns text description of last error.
virtual int getCameraCapabilities(unsigned int *capabilitiesMask) const =0
Return bit set of camera capabilities (CameraCapability enumeration)
virtual int getCapabilities() const =0
Returns bitset of Capability enumeration members.
Camera supports flip state queries.
Definition: camera_plugin.h:886
set in first packet of gop block of reverse stream (see nxcip::DtsArchiveReader::setReverseMode) ...
Definition: camera_plugin.h:1035
camera supports hardware motion. Plugin, returning this flag, MUST implement BaseCameraManager::nativ...
Definition: camera_plugin.h:567
virtual int getCameraInfo(CameraInfo *info) const =0
Fills info struct with camera data.
virtual UsecUTCTimestamp endTime() const =0
Returns timestamp (usec (microseconds) since 1970-01-01, UTC) of newest data, present in the archive...
packet has been generated during playback of reverse stream. Packets of type dptEmpty MUST have this ...
Definition: camera_plugin.h:1033
if this flag is enabled, CameraRelayIOManager MUST be implemented
Definition: camera_plugin.h:568
virtual int fromUpnpData(const char *upnpXMLData, int upnpXMLDataSize, CameraInfo *cameraInfo)=0
UPNP camera search method.
virtual int getPosition(CoordinateSpace space, double *pan, double *tilt, double *zoom)=0
Gets PTZ position from camera in the given coordinate space.
virtual Picture * getMotionData() const =0
Returns motion data. Can be NULL, if no motion.
Video packet. Usually contains one frame. Video packet class MUST inherit nxcip::VideoDataPacket.
Definition: camera_plugin.h:1001
virtual CameraPtzManager * getPtzManager() const =0
MUST return not-NULL if ptzCapability is present.
Array of time periods.
Definition: camera_plugin.h:673
if present, nxcip::BaseCameraManager2::find supports ArchiveSearchOptions::motionMask() ...
Definition: camera_plugin.h:579
Definition: camera_plugin.h:489
virtual int find(ArchiveSearchOptions *searchOptions, TimePeriods **timePeriods) const =0
Find regions of archive, satisfying given conditions.
virtual int getInputPortList(char **idList, int *idNum) const =0
Returns list of IDs of available relay input ports.
virtual DataPacketType type() const =0
Packet type.
virtual void registerEventHandler(CameraInputEventHandler *handler)=0
Registers handler as event receiver.
virtual CameraRelayIOManager * getCameraRelayIOManager() const =0
MUST return not-NULL if BaseCameraManager::relayInputCapability is present.
virtual int getAudioFormat(AudioFormat *audioFormat) const =0
Returns audio format, if audio is supported.
packet will be tested if it&#39;s a I-Frame. Use it if plugin can&#39;t set fKeyPacket
Definition: camera_plugin.h:581
Camera supports continuous zoom.
Definition: camera_plugin.h:880
if this flag is enabled, CameraPTZManager MUST be implemented
Definition: camera_plugin.h:570
int limit
Definition: camera_plugin.h:732
char uid[256]
Camera&#39;s unique identifier. MAC address can be used. MUST NOT be empty.
Definition: camera_plugin.h:78
virtual int setAudioEnabled(int audioEnabled)=0
Turn on/off audio on ALL encoders.
Camera supports absolute tilt.
Definition: camera_plugin.h:883
virtual int getLimits(CoordinateSpace space, Limits *limits)=0
Gets PTZ limits of the camera.
#define LL
Definition: debug.h:145
camera provides relative timestamps. It need to align them to the current time.
Definition: camera_plugin.h:582
virtual int setParamValue(const char *paramName, const char *value)=0
Set value of parameter paramName to value.
Capability
Definition: camera_plugin.h:876
Provides base camera operations: getting/settings fps, resolution, bitrate, media stream url(s)...
Definition: camera_plugin.h:525
UsecUTCTimestamp startTime
Min data timestamp that is of interest.
Definition: camera_plugin.h:711
camera has archive storage and provides access to its archive
Definition: camera_plugin.h:575
virtual int getVideoFormat(CompressionType *codec, PixelFormat *pixelFormat) const =0
Returns video format. Optional method.
virtual const void * data() const =0
Coded media stream data.
int32_t flags
Definition: camera_plugin.h:441
virtual int fromMDNSData(const char *discoveryAddress, const unsigned char *mdnsResponsePacket, int mdnsResponsePacketSize, CameraInfo *cameraInfo)=0
MDNS camera search method.
virtual int getNextData(MediaDataPacket **packet)=0
Returns media packet or NULL in case of error.
char defaultLogin[256]
Plugin can specify default credentials to use with camera.
Definition: camera_plugin.h:84
Portion of media data.
Definition: camera_plugin.h:1023
Server should not open video from camera at its will.
Definition: camera_plugin.h:588
Camera supports coordinate space limits queries.
Definition: camera_plugin.h:887
Video packet. MUST contain complete frame (or field in case of interlaced video)
Definition: camera_plugin.h:1125
Camera supports continuous pan.
Definition: camera_plugin.h:878
virtual int xStride(int planeNumber) const =0
Length of horizontal line (in bytes) of plane planeNumber.
virtual PixelFormat pixelFormat() const =0
Returns pixel format.
virtual int setMediaUrl(const char url[nxcip::MAX_TEXT_LEN])=0
virtual int setResolution(const Resolution &resolution)=0
Change resolution on specified encoder.
PixelFormat
Definition: camera_plugin_types.h:39
int height
Height in pixels.
Definition: camera_plugin.h:272
virtual int playRange(unsigned int cSeq, UsecUTCTimestamp start, UsecUTCTimestamp endTimeHint, unsigned int step)=0
Play time range [start; end) skipping frames.
UsecUTCTimestamp endTime
Max data timestamp that is of interest.
Definition: camera_plugin.h:713
Analytics Engine mustn&#39;t bind to the Device.
Definition: camera_plugin.h:589
Definition: camera_plugin.h:1041
virtual int setMotionMask(Picture *motionMask)=0
If camera plugin implements this method, it MUST report motion only on for region specified (motionMa...
virtual int setReverseMode(unsigned int cSeq, bool isReverse, UsecUTCTimestamp timestamp, UsecUTCTimestamp *selectedPosition)=0
Set playback direction (forward/reverse)
unsigned long long periodDetailLevel
Definition: camera_plugin.h:721
MediaStreamQuality
Definition: camera_plugin.h:1175
Camera parameters can be read/set even if camera is not accessible at the moment. ...
Definition: camera_plugin.h:815
Camera supports multicast streaming.
Definition: camera_plugin.h:586
virtual BaseCameraManager * createCameraManager(const CameraInfo &info)=0
Instantiates camera manager instance based on info.
Definition: camera_plugin.h:459
Packet containing no data (e.g., signals end of stream)
Definition: camera_plugin.h:1006
Device-specific coordinate space.
Definition: camera_plugin.h:899
High quality.
Definition: camera_plugin.h:1183
virtual int getEncoder(int encoderIndex, CameraMediaEncoder **encoderPtr)=0
Returns encoder by index.
Reads picture files from specified directory as video-stream.
Definition: stream_reader.h:18
static const int NX_TRY_AGAIN
Operation could not be completed now, but it may still be available later.
Definition: camera_plugin.h:51
virtual int createDtsArchiveReader(DtsArchiveReader **dtsArchiveReader) const =0
Returns not NULL if BaseCameraManager::dtsArchiveCapability is supported.
Camera does not allow to change stream quality/fps.
Definition: camera_plugin.h:585
it is allowed to detect motion by primary stream (if no dual streaming on camera) ...
Definition: camera_plugin.h:577
frame skipping with DtsArchiveReader::setSkipFrames method is supported
Definition: camera_plugin.h:1258
if second stream is running whatever fps it has => first stream can get maximumFps - secondstreamFps ...
Definition: camera_plugin.h:572