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  modelName[0] = 0;
92  firmware[0] = 0;
93  uid[0] = 0;
94  url[0] = 0;
95  auxiliaryData[0] = 0;
96  defaultLogin[0] = 0;
97  defaultPassword[0] = 0;
98  }
99 
100  CameraInfo(const CameraInfo& value)
101  {
102  strncpy(modelName, value.modelName, sizeof(modelName));
103  strncpy(firmware, value.firmware, sizeof(firmware));
104  strncpy(uid, value.uid, sizeof(uid));
105  strncpy(url, value.url, sizeof(url));
106  strncpy(auxiliaryData, value.auxiliaryData, sizeof(auxiliaryData));
107  strncpy(defaultLogin, value.defaultLogin, sizeof(defaultLogin));
108  strncpy(defaultPassword, value.defaultPassword, sizeof(defaultPassword));
109  }
110  };
111 
112  struct CameraInfo2: public CameraInfo
113  {
115  {
116  groupId[0] = 0;
117  groupName[0] = 0;
118  }
119 
120  CameraInfo2(const CameraInfo& value):
121  CameraInfo(value)
122  {
123  groupId[0] = 0;
124  groupName[0] = 0;
125  }
126 
127  CameraInfo2(const CameraInfo2& value):
128  CameraInfo(value)
129  {
130  strncpy(groupId, value.groupId, sizeof(groupId) - 1);
131  strncpy(groupName, value.groupName, sizeof(groupName) - 1);
132  }
133 
134  char groupId[256];
135  char groupName[256];
136  };
137 
138  static const int CAMERA_INFO_ARRAY_SIZE = 256;
139  static const int MAX_MODEL_NAME_SIZE = 256;
140 
142 
156  {
157  public:
158  virtual ~CameraDiscoveryManager() {}
159 
161 
164  virtual void getVendorName( char* buf ) const = 0;
165 
167 
174  virtual int findCameras( CameraInfo* cameras, const char* serverURL ) = 0;
176 
186  virtual int checkHostAddress( CameraInfo* cameras, const char* address, const char* login, const char* password ) = 0;
188 
198  virtual int fromMDNSData(
199  const char* discoveryAddress,
200  const unsigned char* mdnsResponsePacket,
201  int mdnsResponsePacketSize,
202  CameraInfo* cameraInfo ) = 0;
204 
213  virtual int fromUpnpData( const char* upnpXMLData, int upnpXMLDataSize, CameraInfo* cameraInfo ) = 0;
214 
216 
219  virtual BaseCameraManager* createCameraManager( const CameraInfo& info ) = 0;
220 
222 
234  virtual int getReservedModelList( char** modelList, int* count ) = 0;
235  };
236 
238  {
239  public:
240  CameraDiscoveryManager2() = default;
241 
242  virtual int checkHostAddress2(nxcip::CameraInfo2* cameras, const char* address, const char* login, const char* password) = 0;
243  virtual int findCameras2(CameraInfo2* cameras, const char* serverURL) = 0;
244  };
245 
247  {
248  public:
249  enum Capability
250  {
251  noCapability = 0,
252  findLocalResources = 1 //< CameraDiscovery can find local resources without IP.
253  };
254 
255  CameraDiscoveryManager3() = default;
256  virtual int getCapabilities() const = 0;
257  };
258 
260  struct Resolution
261  {
263  int width;
265  int height;
266 
267  Resolution( int _width = 0, int _height = 0 )
268  :
269  width( _width ),
270  height( _height )
271  {
272  }
273  };
274 
277  {
281  float maxFps;
282 
284  :
285  maxFps( 0 )
286  {
287  }
288  };
289 
290  class StreamReader;
291 
292  // {528FD641-52BB-4f8b-B279-6C21FEF5A2BB}
293  static const nxpl::NX_GUID IID_CameraMediaEncoder = { { 0x52, 0x8f, 0xd6, 0x41, 0x52, 0xbb, 0x4f, 0x8b, 0xb2, 0x79, 0x6c, 0x21, 0xfe, 0xf5, 0xa2, 0xbb } };
294 
295  static const int MAX_RESOLUTION_LIST_SIZE = 64;
296 
299  :
300  public nxpl::PluginInterface
301  {
302  public:
303  virtual ~CameraMediaEncoder() {}
304 
306 
314  virtual int getMediaUrl( char* urlBuf ) const = 0;
315 
317 
323  virtual int getResolutionList( ResolutionInfo* infoList, int* infoListCount ) const = 0;
324 
326 
330  virtual int getMaxBitrate( int* maxBitrate ) const = 0;
331 
333 
337  virtual int setResolution( const Resolution& resolution ) = 0;
338 
345  virtual int setFps( const float& fps, float* selectedFps ) = 0;
346 
353  virtual int setBitrate( int bitrateKbps, int* selectedBitrateKbps ) = 0;
354  };
355 
356  struct AudioFormat
357  {
359  {
363  stFLT
364  };
365 
366  enum ByteOrderType
367  {
368  boLittleEndian,
369  boBigEndian
370  };
371 
372  CompressionType compressionType;
373  int sampleRate;
375  int bitrate;
376  ByteOrderType byteOrder;
377  int channels;
378  SampleType sampleFmt;
379  int channelLayout;
380  int blockAlign;
381  int bitsPerCodedSample;
382 
383  AudioFormat()
384  :
385  compressionType(AV_CODEC_ID_NONE),
386  sampleRate(0),
387  bitrate(0),
388  byteOrder(boLittleEndian),
389  channels(0),
390  sampleFmt(stU8),
391  channelLayout(0),
392  blockAlign(0),
393  bitsPerCodedSample(0)
394  {
395  }
396  };
397 
398  // {9A1BDA18-563C-42de-8E23-B9244FD00658}
399  static const nxpl::NX_GUID IID_CameraMediaEncoder2 = { { 0x9a, 0x1b, 0xda, 0x18, 0x56, 0x3c, 0x42, 0xde, 0x8e, 0x23, 0xb9, 0x24, 0x4f, 0xd0, 0x6, 0x58 } };
400 
403  {
404  public:
405  virtual ~CameraMediaEncoder2() override {}
406 
408 
413  virtual StreamReader* getLiveStreamReader() = 0;
415  virtual int getAudioFormat( AudioFormat* audioFormat ) const = 0;
416  };
417 
418 #ifndef __GNUC__
419 #pragma pack(push, 1)
420 #define PACKED
421 #else
422 #define PACKED __attribute__((__packed__))
423 #endif
424 
426  struct PACKED LiveStreamConfig
427  {
428  enum LiveStreamFlags
429  {
430  LIVE_STREAM_FLAG_AUDIO_ENABLED = 0x1
431  };
432 
433  int32_t reserved_head;
434  int32_t flags;
435  int32_t codec;
436  int32_t width;
437  int32_t height;
438  float framerate;
439  int32_t bitrateKbps;
440  int16_t quality;
441  int16_t gopLength;
442  uint8_t reserved_tail[96];
443  };
444 #ifndef __GNUC__
445 #pragma pack(pop)
446 #endif
447 #undef PACKED
448 
449  // {D1C7F082-B6F9-45F3-82D6-3CFE3EAE0260}
450  static const nxpl::NX_GUID IID_CameraMediaEncoder3 = { { 0xd1, 0xc7, 0xf0, 0x82, 0xb6, 0xf9, 0x45, 0xf3, 0x82, 0xd6, 0x3c, 0xfe, 0x3e, 0xae, 0x2, 0x60 } };
451 
453  {
454  public:
456 
466  virtual int getConfiguredLiveStreamReader(LiveStreamConfig * config, StreamReader ** reader) = 0;
467 
469 
477  virtual int getVideoFormat(CompressionType * codec, PixelFormat * pixelFormat) const = 0;
478  };
479 
480  // {9807EA20-FA37-4EA7-BF07-9AC61511E1DF}
481  static const nxpl::NX_GUID IID_CameraMediaEncoder4 = { { 0x98, 0x07, 0xEA ,0x20, 0xFA, 0x37, 0x4E, 0xA7, 0xBF, 0x07, 0x9A, 0xC6 ,0x15 ,0x11 ,0xE1, 0xDF } };
483  {
484  public:
486  virtual int setMediaUrl(const char url[nxcip::MAX_TEXT_LEN]) = 0;
487  };
488 
489  // {95d69238-7a07-462f-9364-971dd58b315e}
490  static const nxpl::NX_GUID IID_CameraMediaEncoder5 = { { 0x95, 0xd6, 0x92 ,0x38, 0x7a, 0x07, 0x46, 0x2f, 0x93, 0x64, 0x97, 0x1d ,0xd5 ,0x8b ,0x31, 0x5e } };
492  {
493  public:
495  virtual const char* audioExtradata() const = 0;
496 
498  virtual int audioExtradataSize() const = 0;
499  };
500 
501  class CameraPtzManager;
503  class CameraRelayIOManager;
504  class DtsArchiveReader;
505 
506  // {B7AA2FE8-7592-4459-A52F-B05E8E089AFE}
507  static const nxpl::NX_GUID IID_BaseCameraManager = { { 0xb7, 0xaa, 0x2f, 0xe8, 0x75, 0x92, 0x44, 0x59, 0xa5, 0x2f, 0xb0, 0x5e, 0x8e, 0x8, 0x9a, 0xfe } };
508 
510 
519  :
520  public nxpl::PluginInterface
521  {
522  public:
523  virtual ~BaseCameraManager() {}
524 
526 
535  virtual int getEncoderCount( int* encoderCount ) const = 0;
536 
538 
547  virtual int getEncoder( int encoderIndex, CameraMediaEncoder** encoderPtr ) = 0;
548 
550 
555  virtual int getCameraInfo( CameraInfo* info ) const = 0;
556 
559  {
563  ptzCapability = 0x0008,
564  audioCapability = 0x0010,
567  shareIpCapability = 0x0080,
581  dontAutoOpenCamera = 0x200000,
582  noAnalytics = 0x400000,
583  };
584 
586 
590  virtual int getCameraCapabilities( unsigned int* capabilitiesMask ) const = 0;
591 
593  virtual void setCredentials( const char* username, const char* password ) = 0;
594 
596 
600  virtual int setAudioEnabled( int audioEnabled ) = 0;
601 
603 
607  virtual CameraPtzManager* getPtzManager() const = 0;
609 
616 
620  virtual CameraRelayIOManager* getCameraRelayIOManager() const = 0;
621 
623 
626  virtual void getLastErrorString( char* errorString ) const = 0;
627  };
628 
629  // {A2017C29-CE9E-4829-87BE-9287598A1358}
630  static const nxpl::NX_GUID IID_Picture = { { 0xa2, 0x01, 0x7c, 0x29, 0xce, 0x9e, 0x48, 0x29, 0x87, 0xbe, 0x92, 0x87, 0x59, 0x8a, 0x13, 0x58 } };
631 
633  class Picture
634  :
635  public nxpl::PluginInterface
636  {
637  public:
638  virtual ~Picture() {}
639 
641  virtual PixelFormat pixelFormat() const = 0;
643  virtual int planeCount() const = 0;
645  virtual int width() const = 0;
647  virtual int height() const = 0;
649  virtual int xStride( int planeNumber ) const = 0;
651  virtual const void* scanLine( int planeNumber, int lineNumber ) const = 0;
653  virtual void* scanLine( int planeNumber, int lineNumber ) = 0;
658  virtual void* data() = 0;
659  virtual const void* data() const = 0;
660  };
661 
662  // {8006CC9F-7BDD-4a4c-8920-AC5546D4924A}
663  static const nxpl::NX_GUID IID_TimePeriods = { { 0x80, 0x06, 0xcc, 0x9f, 0x7b, 0xdd, 0x4a, 0x4c, 0x89, 0x20, 0xac, 0x55, 0x46, 0xd4, 0x92, 0x4a } };
664 
667  :
668  public nxpl::PluginInterface
669  {
670  public:
672  virtual void goToBeginning() = 0;
676  virtual bool next() = 0;
680  virtual bool atEnd() const = 0;
686  virtual bool get( UsecUTCTimestamp* start, UsecUTCTimestamp* end ) const = 0;
687  };
688 
691  {
692  public:
704  UsecUTCTimestamp startTime;
706  UsecUTCTimestamp endTime;
714  unsigned long long periodDetailLevel;
715 
721 
725  int limit;
726 
731 
733  :
734  motionMask( 0 ),
735  startTime( INVALID_TIMESTAMP_VALUE ),
736  endTime( INVALID_TIMESTAMP_VALUE ),
738  keepSmallChunks(0),
739  limit(0),
740  descSortOrder(false)
741  {
742  }
743  };
744 
745  // {1181F23B-071C-4608-89E3-648E1A735B54}
746  static const nxpl::NX_GUID IID_BaseCameraManager2 = { { 0x11, 0x81, 0xf2, 0x3b, 0x07, 0x1c, 0x46, 0x08, 0x89, 0xe3, 0x64, 0x8e, 0x1a, 0x73, 0x5b, 0x54 } };
747 
750  :
751  public BaseCameraManager
752  {
753  public:
756  {
759  };
760 
761  virtual ~BaseCameraManager2() {}
762 
764 
769  virtual int createDtsArchiveReader( DtsArchiveReader** dtsArchiveReader ) const = 0;
771 
778  virtual int find( ArchiveSearchOptions* searchOptions, TimePeriods** timePeriods ) const = 0;
780 
790  virtual int setMotionMask( Picture* motionMask ) = 0;
791  };
792 
793  // {840DEECD-2F9B-4859-9081-9592D17177F8}
794  static const nxpl::NX_GUID IID_BaseCameraManager3 = { { 0x84, 0x0d, 0xee, 0xcd, 0x2f, 0x9b, 0x48, 0x59, 0x90, 0x81, 0x95, 0x92, 0xd1, 0x71, 0x77, 0xf8 } };
795 
797 
802  :
803  public BaseCameraManager2
804  {
805  public:
807  {
809  };
810 
812 
816  virtual const char* getParametersDescriptionXML() const = 0;
818 
826  virtual int getParamValue( const char* paramName, char* valueBuf, int* valueBufSize ) const = 0;
828 
837  virtual int setParamValue( const char* paramName, const char* value ) = 0;
838  };
839 
840  // {8BAB5BC7-BEFC-4629-921F-8390A29D8A16}
841  static const nxpl::NX_GUID IID_CameraPTZManager = { { 0x8b, 0xab, 0x5b, 0xc7, 0xbe, 0xfc, 0x46, 0x29, 0x92, 0x1f, 0x83, 0x90, 0xa2, 0x9d, 0x8a, 0x16 } };
842 
844 
863  :
864  public nxpl::PluginInterface
865  {
866  public:
867  virtual ~CameraPtzManager() {}
868 
870  {
871  ContinuousPanCapability = 0x00000001,
874 
875  AbsolutePanCapability = 0x00000010,
876  AbsoluteTiltCapability = 0x00000020,
877  AbsoluteZoomCapability = 0x00000040,
878 
879  FlipPtzCapability = 0x00000100,
880  LimitsPtzCapability = 0x00000200,
881 
884 
888  };
889 
891  {
894  };
895 
896  enum Orientation
897  {
898  Horizontal = 0x1,
899  Vertical = 0x2
900  };
901 
902  struct Limits {
903  double minPan;
904  double maxPan;
905  double minTilt;
906  double maxTilt;
907  double minFov;
908  double maxFov;
909  };
910 
912  virtual int getCapabilities() const = 0;
913 
915 
930  virtual int continuousMove( double panSpeed, double tiltSpeed, double zoomSpeed ) = 0;
931 
933 
949  virtual int absoluteMove( CoordinateSpace space, double pan, double tilt, double zoom, double speed ) = 0;
950 
952 
963  virtual int getPosition( CoordinateSpace space, double *pan, double *tilt, double *zoom ) = 0;
964 
966 
974  virtual int getLimits( CoordinateSpace space, Limits *limits ) = 0;
975 
977 
985  virtual int getFlip( int *flip ) = 0;
986  };
987 
990  {
996 
1000  dptUnknown,
1001  dptData,
1002  };
1003 
1004  // {763C93DC-A77D-41ff-8071-B64C4D3AFCFF}
1005  static const nxpl::NX_GUID IID_MediaDataPacket = { { 0x76, 0x3c, 0x93, 0xdc, 0xa7, 0x7d, 0x41, 0xff, 0x80, 0x71, 0xb6, 0x4c, 0x4d, 0x3a, 0xfc, 0xff } };
1007  static const unsigned int MEDIA_DATA_BUFFER_ALIGNMENT = 64;
1009  static const unsigned int MEDIA_PACKET_BUFFER_PADDING_SIZE = 64;
1010 
1012 
1017  :
1018  public nxpl::PluginInterface
1019  {
1020  public:
1021  enum Flags
1022  {
1024  fKeyPacket = 0x01,
1029  DEPRECATED_fLowQuality = 0x08,
1035  };
1036 
1038  virtual UsecUTCTimestamp timestamp() const = 0;
1040  virtual DataPacketType type() const = 0;
1042 
1053  virtual const void* data() const = 0;
1055 
1059  virtual unsigned int dataSize() const = 0;
1064  virtual unsigned int channelNumber() const = 0;
1065 
1071  virtual CompressionType codecType() const = 0;
1072 
1074  virtual unsigned int flags() const = 0;
1076 
1080  virtual unsigned int cSeq() const = 0;
1081  };
1082 
1083  // {65E9548D-0BA6-48CB-A217-AE6AE270CE7D}
1084  static const nxpl::NX_GUID IID_MediaDataPacket2 = { { 0x65, 0xe9, 0x54, 0x8d, 0x0b, 0xa6, 0x48, 0xcb, 0xa2, 0x17, 0xae, 0x6a, 0xe2, 0x70, 0xce, 0x7d } };
1085 
1087  {
1088  public:
1090  virtual const char* extradata() const = 0;
1091 
1093  virtual int extradataSize() const = 0;
1094  };
1095 
1096  // {A3F5D1BA-5A74-42BD-8890-A1C6E0197C04}
1097  static const nxpl::NX_GUID IID_Encryptable = { { 0xa3, 0xf5, 0xd1, 0xba, 0x5a, 0x74, 0x42, 0xbd, 0x88, 0x90, 0xa1, 0xc6, 0xe0, 0x19, 0x7c, 0x4 } };
1098 
1105  {
1106  public:
1107  virtual const char* encryptionData() const = 0;
1108  virtual int encryptionDataSize() const = 0;
1109  };
1110 
1111  static const unsigned int DEFAULT_MOTION_DATA_PICTURE_WIDTH = 44;
1112  static const unsigned int DEFAULT_MOTION_DATA_PICTURE_HEIGHT = 32;
1113 
1114  // {A85D884B-F05E-4fff-8B5A-E36570E73067}
1115  static const nxpl::NX_GUID IID_VideoDataPacket = { { 0xa8, 0x5d, 0x88, 0x4b, 0xf0, 0x5e, 0x4f, 0xff, 0x8b, 0x5a, 0xe3, 0x65, 0x70, 0xe7, 0x30, 0x67 } };
1116 
1119  :
1120  public MediaDataPacket
1121  {
1122  public:
1124 
1134  virtual Picture* getMotionData() const = 0;
1135  };
1136 
1137  // {AFE4EEDA-3770-42c3-8381-EE3B55522551}
1138  static const nxpl::NX_GUID IID_StreamReader = { { 0xaf, 0xe4, 0xee, 0xda, 0x37, 0x70, 0x42, 0xc3, 0x83, 0x81, 0xee, 0x3b, 0x55, 0x52, 0x25, 0x51 } };
1139 
1141 
1148  :
1149  public nxpl::PluginInterface
1150  {
1151  public:
1153 
1162  virtual int getNextData( MediaDataPacket** packet ) = 0;
1163 
1165  virtual void interrupt() = 0;
1166  };
1167 
1169  {
1173 
1179  };
1180 
1181  // {CEB97832-E931-4965-9B18-A8A1557107D7}
1182  static const nxpl::NX_GUID IID_DtsArchiveReader = { { 0xce, 0xb9, 0x78, 0x32, 0xe9, 0x31, 0x49, 0x65, 0x9b, 0x18, 0xa8, 0xa1, 0x55, 0x71, 0x7, 0xd7 } };
1183 
1185 
1199  :
1200  public nxpl::PluginInterface
1201  {
1202  public:
1204  {
1206 
1248 
1254  };
1255 
1257  virtual unsigned int getCapabilities() const = 0;
1258 
1260 
1263  virtual int open() = 0;
1265 
1268  virtual StreamReader* getStreamReader() = 0;
1270 
1273  virtual UsecUTCTimestamp startTime() const = 0;
1275 
1278  virtual UsecUTCTimestamp endTime() const = 0;
1280 
1292  virtual int seek(
1293  unsigned int cSeq,
1294  UsecUTCTimestamp timestamp,
1295  bool findKeyFrame,
1296  UsecUTCTimestamp* selectedPosition ) = 0;
1298 
1309  virtual int setReverseMode(
1310  unsigned int cSeq,
1311  bool isReverse,
1312  UsecUTCTimestamp timestamp,
1313  UsecUTCTimestamp* selectedPosition ) = 0;
1315  virtual bool isReverseModeEnabled() const = 0;
1317 
1321  virtual int setMotionDataEnabled( bool motionPresent ) = 0;
1323 
1333  virtual int setQuality(
1334  MediaStreamQuality quality,
1335  bool waitForKeyFrame ) = 0;
1337 
1349  virtual int playRange(
1350  unsigned int cSeq,
1351  UsecUTCTimestamp start,
1352  UsecUTCTimestamp endTimeHint,
1353  unsigned int step ) = 0;
1354 
1356 
1359  virtual void getLastErrorString( char* errorString ) const = 0;
1360  };
1361 
1362  // {C6F06A48-8E3A-4690-8B21-CAC4A955D7ED}
1363  static const nxpl::NX_GUID IID_CameraMotionDataProvider = { { 0xc6, 0xf0, 0x6a, 0x48, 0x8e, 0x3a, 0x46, 0x90, 0x8b, 0x21, 0xca, 0xc4, 0xa9, 0x55, 0xd7, 0xed } };
1364 
1367  :
1368  public nxpl::PluginInterface
1369  {
1370  public:
1371  //TODO for future use
1372  };
1373 
1375 
1376  // {872F473F-72CF-4397-81E6-C06D42E97113}
1377  static const nxpl::NX_GUID IID_CameraRelayIOManager = { { 0x87, 0x2f, 0x47, 0x3f, 0x72, 0xcf, 0x43, 0x97, 0x81, 0xe6, 0xc0, 0x6d, 0x42, 0xe9, 0x71, 0x13 } };
1378 
1379  static const int MAX_ID_LEN = 64;
1380  static const int MAX_RELAY_PORT_COUNT = 32;
1381 
1383 
1387  :
1388  public nxpl::PluginInterface
1389  {
1390  public:
1392 
1397  virtual int getRelayOutputList( char** idList, int* idNum ) const = 0;
1398 
1400 
1405  virtual int getInputPortList( char** idList, int* idNum ) const = 0;
1406 
1408 
1414  virtual int setRelayOutputState(
1415  const char* outputID,
1416  int activate,
1417  unsigned int autoResetTimeoutMS ) = 0;
1418 
1420 
1425  virtual int startInputPortMonitoring() = 0;
1426 
1428 
1435  virtual void stopInputPortMonitoring() = 0;
1436 
1438 
1442  virtual void registerEventHandler( CameraInputEventHandler* handler ) = 0;
1443 
1445 
1454  virtual void unregisterEventHandler( CameraInputEventHandler* handler ) = 0;
1455 
1457 
1460  virtual void getLastErrorString( char* errorString ) const = 0;
1461  };
1462 
1463  // {CC1E749F-2EC6-4b73-BEC9-8F2AE9B7FCCE}
1464  static const nxpl::NX_GUID IID_CameraInputEventHandler = { { 0xcc, 0x1e, 0x74, 0x9f, 0x2e, 0xc6, 0x4b, 0x73, 0xbe, 0xc9, 0x8f, 0x2a, 0xe9, 0xb7, 0xfc, 0xce } };
1465 
1468  :
1469  public nxpl::PluginInterface
1470  {
1471  public:
1472  virtual ~CameraInputEventHandler() {}
1473 
1475 
1482  virtual void inputPortStateChanged(
1483  CameraRelayIOManager* source,
1484  const char* inputPortID,
1485  int newState,
1486  unsigned long int timestamp ) = 0;
1487  };
1488 }
1489 
1490 #endif //NX_CAMERA_PLUGIN_H
Definition: time_periods.h:12
Resolution resolution
Guess what.
Definition: camera_plugin.h:279
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:882
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:806
virtual bool next()=0
Camera sends absolute timestamps in media stream.
Definition: camera_plugin.h:577
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:375
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:690
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:263
virtual int width() const =0
Width (pixels)
Provides encoder parameter configuration and media stream access (by providing media stream url) ...
Definition: camera_plugin.h:298
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:801
virtual int getReservedModelList(char **modelList, int *count)=0
Get model names, reserved by the plugin.
Definition: camera_plugin.h:1104
CoordinateSpace
Definition: camera_plugin.h:890
if present, nxcip::BaseCameraManager2::find supports ArchiveSearchOptions::motionMask() ...
Definition: camera_plugin.h:757
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:989
Provides access to motion detection support, implemented on camera.
Definition: camera_plugin.h:1366
bool descSortOrder
Definition: camera_plugin.h:730
virtual unsigned int channelNumber() const =0
Definition: camera_plugin.h:902
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:569
allow multiple instances on a same IP address
Definition: camera_plugin.h:567
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:281
virtual const char * audioExtradata() const =0
Returns pointer to audio extra data.
CameraCapability
Enumeration of supported camera capabilities (bit flags)
Definition: camera_plugin.h:558
Definition: camera_plugin.h:246
Definition: camera_plugin.h:426
Camera supports absolute pan.
Definition: camera_plugin.h:875
if this flag is enabled, CameraRelayIOManager MUST be implemented
Definition: camera_plugin.h:562
Camera supports absolute zoom.
Definition: camera_plugin.h:877
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:276
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:580
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:1021
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:356
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:571
bool keepSmallChunks
Definition: camera_plugin.h:720
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:1147
e.g., h.264 IDR frame
Definition: camera_plugin.h:1024
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:755
signed 16 bits
Definition: camera_plugin.h:361
Receives events on input port state change.
Definition: camera_plugin.h:1467
Definition: camera_plugin.h:1086
Default quality SHOULD be high quality.
Definition: camera_plugin.h:1171
Definition: camera_plugin.h:491
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:1007
virtual int getFlip(int *flip)=0
Gets the camera streams&#39;s flipped state.
Picture * motionMask
Definition: camera_plugin.h:702
int32_t reserved_head
reserved, do not use
Definition: camera_plugin.h:433
Provides access to archive, stored on camera.
Definition: camera_plugin.h:1198
SampleType
Definition: camera_plugin.h:358
if set, camera supports audio
Definition: camera_plugin.h:564
if present, nxcip::BaseCameraManager3::setMotionMask is implemented
Definition: camera_plugin.h:758
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:1253
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:155
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:749
Logical coordinate space — degrees for pan, tilt and fov (zoom).
Definition: camera_plugin.h:893
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:992
Capabilities
Definition: camera_plugin.h:1203
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:435
Resolution of video stream picture.
Definition: camera_plugin.h:260
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:566
static const unsigned int MEDIA_PACKET_BUFFER_PADDING_SIZE
Required padding after media data (see MediaDataPacket::data() description)
Definition: camera_plugin.h:1009
virtual int startInputPortMonitoring()=0
Starts relay input monitoring or increments internal counter, if already started. ...
Pan-tilt-zoom management.
Definition: camera_plugin.h:862
Camera supports continuous tilt.
Definition: camera_plugin.h:872
camera&#39;s media streams are editable and can be provided directly via setProperty API call...
Definition: camera_plugin.h:576
virtual int getParamValue(const char *paramName, char *valueBuf, int *valueBufSize) const =0
Reads value of parameter paramName.
Definition: camera_plugin.h:237
Picture.
Definition: camera_plugin.h:633
Extends CameraMediaEncoder by adding functionality for plugin to directly provide live media stream...
Definition: camera_plugin.h:402
signed 32 bits
Definition: camera_plugin.h:362
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:573
unsigned 8 bits
Definition: camera_plugin.h:360
Relay input/output management.
Definition: camera_plugin.h:1386
char firmware[256]
Firmware version in any human readable format. Optional.
Definition: camera_plugin.h:76
Definition: camera_plugin.h:112
Low quality.
Definition: camera_plugin.h:1178
Signals that reverse playback by GOP (group of picture) reordering is supported.
Definition: camera_plugin.h:1246
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:879
set in first packet of gop block of reverse stream (see nxcip::DtsArchiveReader::setReverseMode) ...
Definition: camera_plugin.h:1028
camera supports hardware motion. Plugin, returning this flag, MUST implement BaseCameraManager::nativ...
Definition: camera_plugin.h:560
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:1026
if this flag is enabled, CameraRelayIOManager MUST be implemented
Definition: camera_plugin.h:561
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:994
virtual CameraPtzManager * getPtzManager() const =0
MUST return not-NULL if ptzCapability is present.
Array of time periods.
Definition: camera_plugin.h:666
if present, nxcip::BaseCameraManager2::find supports ArchiveSearchOptions::motionMask() ...
Definition: camera_plugin.h:572
Definition: camera_plugin.h:482
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:574
Camera supports continuous zoom.
Definition: camera_plugin.h:873
if this flag is enabled, CameraPTZManager MUST be implemented
Definition: camera_plugin.h:563
int limit
Definition: camera_plugin.h:725
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:876
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:575
virtual int setParamValue(const char *paramName, const char *value)=0
Set value of parameter paramName to value.
Capability
Definition: camera_plugin.h:869
Provides base camera operations: getting/settings fps, resolution, bitrate, media stream url(s)...
Definition: camera_plugin.h:518
UsecUTCTimestamp startTime
Min data timestamp that is of interest.
Definition: camera_plugin.h:704
camera has archive storage and provides access to its archive
Definition: camera_plugin.h:568
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:434
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:1016
Server should not open video from camera at its will.
Definition: camera_plugin.h:581
Camera supports coordinate space limits queries.
Definition: camera_plugin.h:880
Video packet. MUST contain complete frame (or field in case of interlaced video)
Definition: camera_plugin.h:1118
Camera supports continuous pan.
Definition: camera_plugin.h:871
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:265
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:706
Analytics Engine mustn&#39;t bind to the Device.
Definition: camera_plugin.h:582
Definition: camera_plugin.h:1034
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:714
MediaStreamQuality
Definition: camera_plugin.h:1168
Camera parameters can be read/set even if camera is not accessible at the moment. ...
Definition: camera_plugin.h:808
Camera supports multicast streaming.
Definition: camera_plugin.h:579
virtual BaseCameraManager * createCameraManager(const CameraInfo &info)=0
Instantiates camera manager instance based on info.
Definition: camera_plugin.h:452
Packet containing no data (e.g., signals end of stream)
Definition: camera_plugin.h:999
Device-specific coordinate space.
Definition: camera_plugin.h:892
High quality.
Definition: camera_plugin.h:1176
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:578
it is allowed to detect motion by primary stream (if no dual streaming on camera) ...
Definition: camera_plugin.h:570
frame skipping with DtsArchiveReader::setSkipFrames method is supported
Definition: camera_plugin.h:1251
if second stream is running whatever fps it has => first stream can get maximumFps - secondstreamFps ...
Definition: camera_plugin.h:565