nx_camera_sdk  1.0
Camera 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 
12 
14 
29 namespace nxcip
30 {
31  // TODO: Change to signed int64_t.
32  typedef unsigned long long int UsecUTCTimestamp;
33  static const UsecUTCTimestamp INVALID_TIMESTAMP_VALUE = (UsecUTCTimestamp)-1LL;
34 
35  static const int MAX_TEXT_LEN = 1024;
36 
37  //Error codes. Interface implementation MUST use these error codes when appropriate
38 
39  static const int NX_NO_ERROR = 0;
40  static const int NX_NOT_AUTHORIZED = -1;
41  static const int NX_INVALID_ENCODER_NUMBER = -2;
42  static const int NX_UNKNOWN_PORT_NAME = -3;
43  static const int NX_UNSUPPORTED_CODEC = -8;
44  static const int NX_UNSUPPORTED_RESOLUTION = -9;
45  static const int NX_UNDEFINED_BEHAVOUR = -20;
46  static const int NX_NOT_IMPLEMENTED = -21;
47  static const int NX_NETWORK_ERROR = -22;
48  static const int NX_MORE_DATA = -23;
49  static const int NX_NO_DATA = -24;
50  static const int NX_IO_ERROR = -25;
52  static const int NX_TRY_AGAIN = -26;
54  static const int NX_INTERRUPTED = -27;
55  static const int NX_PARAM_READ_ONLY = -40;
56  static const int NX_UNKNOWN_PARAMETER = -41;
57  static const int NX_INVALID_PARAM_VALUE = -42;
58  static const int NX_OTHER_ERROR = -100;
59 
60 
61  class BaseCameraManager;
62 
63  // {0D06134F-16D0-41c8-9752-A33E81FE9C75}
64  static const nxpl::NX_GUID IID_CameraDiscoveryManager = { { 0x0d, 0x06, 0x13, 0x4f, 0x16, 0xd0, 0x41, 0xc8, 0x97, 0x52, 0xa3, 0x3e, 0x81, 0xfe, 0x9c, 0x75 } };
65 
66  // {0D06134F-16D0-41c8-9752-A33E81FE9C74}
67  static const nxpl::NX_GUID IID_CameraDiscoveryManager2 = { { 0x0d, 0x06, 0x13, 0x4f, 0x16, 0xd0, 0x41, 0xc8, 0x97, 0x52, 0xa3, 0x3e, 0x81, 0xfe, 0x9c, 0x74 } };
68 
70  struct CameraInfo
71  {
73  char modelName[256];
75  char firmware[256];
77  char uid[256];
79  char url[MAX_TEXT_LEN];
81  char auxiliaryData[256];
83  char defaultLogin[256];
85  char defaultPassword[256];
86 
89  {
90  modelName[0] = 0;
91  firmware[0] = 0;
92  uid[0] = 0;
93  url[0] = 0;
94  auxiliaryData[0] = 0;
95  defaultLogin[0] = 0;
96  defaultPassword[0] = 0;
97  }
98 
99  CameraInfo(const CameraInfo& value)
100  {
101  strncpy(modelName, value.modelName, sizeof(modelName));
102  strncpy(firmware, value.firmware, sizeof(firmware));
103  strncpy(uid, value.uid, sizeof(uid));
104  strncpy(url, value.url, sizeof(url));
105  strncpy(auxiliaryData, value.auxiliaryData, sizeof(auxiliaryData));
106  strncpy(defaultLogin, value.defaultLogin, sizeof(defaultLogin));
107  strncpy(defaultPassword, value.defaultPassword, sizeof(defaultPassword));
108  }
109  };
110 
111  struct CameraInfo2: public CameraInfo
112  {
114  {
115  groupId[0] = 0;
116  groupName[0] = 0;
117  }
118 
119  CameraInfo2(const CameraInfo& value):
120  CameraInfo(value)
121  {
122  groupId[0] = 0;
123  groupName[0] = 0;
124  }
125 
126  CameraInfo2(const CameraInfo2& value):
127  CameraInfo(value)
128  {
129  strncpy(groupId, value.groupId, sizeof(groupId) - 1);
130  strncpy(groupName, value.groupName, sizeof(groupName) - 1);
131  }
132 
133  char groupId[256];
134  char groupName[256];
135  };
136 
137  static const int CAMERA_INFO_ARRAY_SIZE = 256;
138  static const int MAX_MODEL_NAME_SIZE = 256;
139 
141 
155  {
156  public:
157  virtual ~CameraDiscoveryManager() {}
158 
160 
163  virtual void getVendorName( char* buf ) const = 0;
164 
166 
173  virtual int findCameras( CameraInfo* cameras, const char* serverURL ) = 0;
175 
185  virtual int checkHostAddress( CameraInfo* cameras, const char* address, const char* login, const char* password ) = 0;
187 
197  virtual int fromMDNSData(
198  const char* discoveryAddress,
199  const unsigned char* mdnsResponsePacket,
200  int mdnsResponsePacketSize,
201  CameraInfo* cameraInfo ) = 0;
203 
212  virtual int fromUpnpData( const char* upnpXMLData, int upnpXMLDataSize, CameraInfo* cameraInfo ) = 0;
213 
215 
218  virtual BaseCameraManager* createCameraManager( const CameraInfo& info ) = 0;
219 
221 
233  virtual int getReservedModelList( char** modelList, int* count ) = 0;
234  };
235 
237  {
238  public:
239  CameraDiscoveryManager2() = default;
240 
241  virtual int checkHostAddress2(nxcip::CameraInfo2* cameras, const char* address, const char* login, const char* password) = 0;
242  virtual int findCameras2(CameraInfo2* cameras, const char* serverURL) = 0;
243  };
244 
245 
247  struct Resolution
248  {
250  int width;
252  int height;
253 
254  Resolution( int _width = 0, int _height = 0 )
255  :
256  width( _width ),
257  height( _height )
258  {
259  }
260  };
261 
264  {
268  float maxFps;
269 
271  :
272  maxFps( 0 )
273  {
274  }
275  };
276 
277 
278  class StreamReader;
279 
280  // {528FD641-52BB-4f8b-B279-6C21FEF5A2BB}
281  static const nxpl::NX_GUID IID_CameraMediaEncoder = { { 0x52, 0x8f, 0xd6, 0x41, 0x52, 0xbb, 0x4f, 0x8b, 0xb2, 0x79, 0x6c, 0x21, 0xfe, 0xf5, 0xa2, 0xbb } };
282 
283  static const int MAX_RESOLUTION_LIST_SIZE = 64;
284 
287  :
288  public nxpl::PluginInterface
289  {
290  public:
291  virtual ~CameraMediaEncoder() {}
292 
294 
302  virtual int getMediaUrl( char* urlBuf ) const = 0;
303 
305 
311  virtual int getResolutionList( ResolutionInfo* infoList, int* infoListCount ) const = 0;
312 
314 
318  virtual int getMaxBitrate( int* maxBitrate ) const = 0;
319 
321 
325  virtual int setResolution( const Resolution& resolution ) = 0;
326 
333  virtual int setFps( const float& fps, float* selectedFps ) = 0;
334 
341  virtual int setBitrate( int bitrateKbps, int* selectedBitrateKbps ) = 0;
342  };
343 
344 
345  struct AudioFormat
346  {
348  {
352  stFLT
353  };
354 
355  enum ByteOrderType
356  {
357  boLittleEndian,
358  boBigEndian
359  };
360 
361  CompressionType compressionType;
362  int sampleRate;
364  int bitrate;
365  ByteOrderType byteOrder;
366  int channels;
367  SampleType sampleFmt;
368  int channelLayout;
369  int blockAlign;
370  int bitsPerCodedSample;
371 
372  AudioFormat()
373  :
374  compressionType(AV_CODEC_ID_NONE),
375  sampleRate(0),
376  bitrate(0),
377  byteOrder(boLittleEndian),
378  channels(0),
379  sampleFmt(stU8),
380  channelLayout(0),
381  blockAlign(0),
382  bitsPerCodedSample(0)
383  {
384  }
385  };
386 
387  // {9A1BDA18-563C-42de-8E23-B9244FD00658}
388  static const nxpl::NX_GUID IID_CameraMediaEncoder2 = { { 0x9a, 0x1b, 0xda, 0x18, 0x56, 0x3c, 0x42, 0xde, 0x8e, 0x23, 0xb9, 0x24, 0x4f, 0xd0, 0x6, 0x58 } };
389 
392  {
393  public:
394  virtual ~CameraMediaEncoder2() override {}
395 
397 
402  virtual StreamReader* getLiveStreamReader() = 0;
404  virtual int getAudioFormat( AudioFormat* audioFormat ) const = 0;
405  };
406 
407 #ifndef __GNUC__
408 #pragma pack(push, 1)
409 #define PACKED
410 #else
411 #define PACKED __attribute__((__packed__))
412 #endif
413 
415  struct PACKED LiveStreamConfig
416  {
417  enum LiveStreamFlags
418  {
419  LIVE_STREAM_FLAG_AUDIO_ENABLED = 0x1
420  };
421 
422  int32_t reserved_head;
423  int32_t flags;
424  int32_t codec;
425  int32_t width;
426  int32_t height;
427  float framerate;
428  int32_t bitrateKbps;
429  int16_t quality;
430  int16_t gopLength;
431  uint8_t reserved_tail[96];
432  };
433 #ifndef __GNUC__
434 #pragma pack(pop)
435 #endif
436 #undef PACKED
437 
438  // {D1C7F082-B6F9-45F3-82D6-3CFE3EAE0260}
439  static const nxpl::NX_GUID IID_CameraMediaEncoder3 = { { 0xd1, 0xc7, 0xf0, 0x82, 0xb6, 0xf9, 0x45, 0xf3, 0x82, 0xd6, 0x3c, 0xfe, 0x3e, 0xae, 0x2, 0x60 } };
440 
442  {
443  public:
445 
455  virtual int getConfiguredLiveStreamReader(LiveStreamConfig * config, StreamReader ** reader) = 0;
456 
458 
464  virtual int getVideoFormat(CompressionType * codec, PixelFormat * pixelFormat) const = 0;
465  };
466 
467  // {9807EA20-FA37-4EA7-BF07-9AC61511E1DF}
468  static const nxpl::NX_GUID IID_CameraMediaEncoder4 = { { 0x98, 0x07, 0xEA ,0x20, 0xFA, 0x37, 0x4E, 0xA7, 0xBF, 0x07, 0x9A, 0xC6 ,0x15 ,0x11 ,0xE1, 0xDF } };
470  {
471  public:
473  virtual int setMediaUrl(const char url[nxcip::MAX_TEXT_LEN]) = 0;
474  };
475 
476  // {95d69238-7a07-462f-9364-971dd58b315e}
477  static const nxpl::NX_GUID IID_CameraMediaEncoder5 = { { 0x95, 0xd6, 0x92 ,0x38, 0x7a, 0x07, 0x46, 0x2f, 0x93, 0x64, 0x97, 0x1d ,0xd5 ,0x8b ,0x31, 0x5e } };
479  {
480  public:
482  virtual const char* audioExtradata() const = 0;
483 
485  virtual int audioExtradataSize() const = 0;
486  };
487 
488  class CameraPtzManager;
490  class CameraRelayIOManager;
491  class DtsArchiveReader;
492 
493  // {B7AA2FE8-7592-4459-A52F-B05E8E089AFE}
494  static const nxpl::NX_GUID IID_BaseCameraManager = { { 0xb7, 0xaa, 0x2f, 0xe8, 0x75, 0x92, 0x44, 0x59, 0xa5, 0x2f, 0xb0, 0x5e, 0x8e, 0x8, 0x9a, 0xfe } };
495 
497 
506  :
507  public nxpl::PluginInterface
508  {
509  public:
510  virtual ~BaseCameraManager() {}
511 
513 
522  virtual int getEncoderCount( int* encoderCount ) const = 0;
523 
525 
534  virtual int getEncoder( int encoderIndex, CameraMediaEncoder** encoderPtr ) = 0;
535 
537 
542  virtual int getCameraInfo( CameraInfo* info ) const = 0;
543 
546  {
550  ptzCapability = 0x0008,
551  audioCapability = 0x0010,
554  shareIpCapability = 0x0080,
566  };
567 
569 
573  virtual int getCameraCapabilities( unsigned int* capabilitiesMask ) const = 0;
574 
576  virtual void setCredentials( const char* username, const char* password ) = 0;
577 
579 
583  virtual int setAudioEnabled( int audioEnabled ) = 0;
584 
586 
590  virtual CameraPtzManager* getPtzManager() const = 0;
592 
599 
603  virtual CameraRelayIOManager* getCameraRelayIOManager() const = 0;
604 
606 
609  virtual void getLastErrorString( char* errorString ) const = 0;
610  };
611 
612 
613  // {A2017C29-CE9E-4829-87BE-9287598A1358}
614  static const nxpl::NX_GUID IID_Picture = { { 0xa2, 0x01, 0x7c, 0x29, 0xce, 0x9e, 0x48, 0x29, 0x87, 0xbe, 0x92, 0x87, 0x59, 0x8a, 0x13, 0x58 } };
615 
617  class Picture
618  :
619  public nxpl::PluginInterface
620  {
621  public:
622  virtual ~Picture() {}
623 
625  virtual PixelFormat pixelFormat() const = 0;
627  virtual int planeCount() const = 0;
629  virtual int width() const = 0;
631  virtual int height() const = 0;
633  virtual int xStride( int planeNumber ) const = 0;
635  virtual const void* scanLine( int planeNumber, int lineNumber ) const = 0;
637  virtual void* scanLine( int planeNumber, int lineNumber ) = 0;
642  virtual void* data() = 0;
643  virtual const void* data() const = 0;
644  };
645 
646 
647  // {8006CC9F-7BDD-4a4c-8920-AC5546D4924A}
648  static const nxpl::NX_GUID IID_TimePeriods = { { 0x80, 0x06, 0xcc, 0x9f, 0x7b, 0xdd, 0x4a, 0x4c, 0x89, 0x20, 0xac, 0x55, 0x46, 0xd4, 0x92, 0x4a } };
649 
652  :
653  public nxpl::PluginInterface
654  {
655  public:
657  virtual void goToBeginning() = 0;
661  virtual bool next() = 0;
665  virtual bool atEnd() const = 0;
671  virtual bool get( UsecUTCTimestamp* start, UsecUTCTimestamp* end ) const = 0;
672  };
673 
674 
677  {
678  public:
690  UsecUTCTimestamp startTime;
692  UsecUTCTimestamp endTime;
700  unsigned long long periodDetailLevel;
701 
707 
711  int limit;
712 
717 
719  :
720  motionMask( 0 ),
721  startTime( INVALID_TIMESTAMP_VALUE ),
722  endTime( INVALID_TIMESTAMP_VALUE ),
724  keepSmallChunks(0),
725  limit(0),
726  descSortOrder(false)
727  {
728  }
729  };
730 
731 
732  // {1181F23B-071C-4608-89E3-648E1A735B54}
733  static const nxpl::NX_GUID IID_BaseCameraManager2 = { { 0x11, 0x81, 0xf2, 0x3b, 0x07, 0x1c, 0x46, 0x08, 0x89, 0xe3, 0x64, 0x8e, 0x1a, 0x73, 0x5b, 0x54 } };
734 
737  :
738  public BaseCameraManager
739  {
740  public:
743  {
746  };
747 
748  virtual ~BaseCameraManager2() {}
749 
751 
756  virtual int createDtsArchiveReader( DtsArchiveReader** dtsArchiveReader ) const = 0;
758 
765  virtual int find( ArchiveSearchOptions* searchOptions, TimePeriods** timePeriods ) const = 0;
767 
777  virtual int setMotionMask( Picture* motionMask ) = 0;
778  };
779 
780 
781  // {840DEECD-2F9B-4859-9081-9592D17177F8}
782  static const nxpl::NX_GUID IID_BaseCameraManager3 = { { 0x84, 0x0d, 0xee, 0xcd, 0x2f, 0x9b, 0x48, 0x59, 0x90, 0x81, 0x95, 0x92, 0xd1, 0x71, 0x77, 0xf8 } };
783 
785 
790  :
791  public BaseCameraManager2
792  {
793  public:
795  {
797  };
798 
800 
804  virtual const char* getParametersDescriptionXML() const = 0;
806 
814  virtual int getParamValue( const char* paramName, char* valueBuf, int* valueBufSize ) const = 0;
816 
825  virtual int setParamValue( const char* paramName, const char* value ) = 0;
826  };
827 
828 
829  // {8BAB5BC7-BEFC-4629-921F-8390A29D8A16}
830  static const nxpl::NX_GUID IID_CameraPTZManager = { { 0x8b, 0xab, 0x5b, 0xc7, 0xbe, 0xfc, 0x46, 0x29, 0x92, 0x1f, 0x83, 0x90, 0xa2, 0x9d, 0x8a, 0x16 } };
831 
833 
852  :
853  public nxpl::PluginInterface
854  {
855  public:
856  virtual ~CameraPtzManager() {}
857 
859  {
860  ContinuousPanCapability = 0x00000001,
863 
864  AbsolutePanCapability = 0x00000010,
865  AbsoluteTiltCapability = 0x00000020,
866  AbsoluteZoomCapability = 0x00000040,
867 
868  FlipPtzCapability = 0x00000100,
869  LimitsPtzCapability = 0x00000200,
870 
873 
877  };
878 
880  {
883  };
884 
885  enum Orientation
886  {
887  Horizontal = 0x1,
888  Vertical = 0x2
889  };
890 
891  struct Limits {
892  double minPan;
893  double maxPan;
894  double minTilt;
895  double maxTilt;
896  double minFov;
897  double maxFov;
898  };
899 
901  virtual int getCapabilities() const = 0;
902 
904 
919  virtual int continuousMove( double panSpeed, double tiltSpeed, double zoomSpeed ) = 0;
920 
922 
938  virtual int absoluteMove( CoordinateSpace space, double pan, double tilt, double zoom, double speed ) = 0;
939 
941 
952  virtual int getPosition( CoordinateSpace space, double *pan, double *tilt, double *zoom ) = 0;
953 
955 
963  virtual int getLimits( CoordinateSpace space, Limits *limits ) = 0;
964 
966 
974  virtual int getFlip( int *flip ) = 0;
975  };
976 
977 
980  {
986 
990  };
991 
992 
993  // {763C93DC-A77D-41ff-8071-B64C4D3AFCFF}
994  static const nxpl::NX_GUID IID_MediaDataPacket = { { 0x76, 0x3c, 0x93, 0xdc, 0xa7, 0x7d, 0x41, 0xff, 0x80, 0x71, 0xb6, 0x4c, 0x4d, 0x3a, 0xfc, 0xff } };
996  static const unsigned int MEDIA_DATA_BUFFER_ALIGNMENT = 32;
998  static const unsigned int MEDIA_PACKET_BUFFER_PADDING_SIZE = 32;
999 
1001 
1006  :
1007  public nxpl::PluginInterface
1008  {
1009  public:
1010  enum Flags
1011  {
1013  fKeyPacket = 0x01,
1018  DEPRECATED_fLowQuality = 0x08,
1024  };
1025 
1027  virtual UsecUTCTimestamp timestamp() const = 0;
1029  virtual DataPacketType type() const = 0;
1031 
1042  virtual const void* data() const = 0;
1044 
1048  virtual unsigned int dataSize() const = 0;
1053  virtual unsigned int channelNumber() const = 0;
1055  virtual CompressionType codecType() const = 0;
1057  virtual unsigned int flags() const = 0;
1059 
1063  virtual unsigned int cSeq() const = 0;
1064  };
1065 
1066 
1067  // {65E9548D-0BA6-48CB-A217-AE6AE270CE7D}
1068  static const nxpl::NX_GUID IID_MediaDataPacket2 = { { 0x65, 0xe9, 0x54, 0x8d, 0x0b, 0xa6, 0x48, 0xcb, 0xa2, 0x17, 0xae, 0x6a, 0xe2, 0x70, 0xce, 0x7d } };
1069 
1071  {
1072  public:
1074  virtual const char* extradata() const = 0;
1075 
1077  virtual int extradataSize() const = 0;
1078  };
1079 
1080 
1081  static const unsigned int DEFAULT_MOTION_DATA_PICTURE_WIDTH = 44;
1082  static const unsigned int DEFAULT_MOTION_DATA_PICTURE_HEIGHT = 32;
1083 
1084 
1085  // {A85D884B-F05E-4fff-8B5A-E36570E73067}
1086  static const nxpl::NX_GUID IID_VideoDataPacket = { { 0xa8, 0x5d, 0x88, 0x4b, 0xf0, 0x5e, 0x4f, 0xff, 0x8b, 0x5a, 0xe3, 0x65, 0x70, 0xe7, 0x30, 0x67 } };
1087 
1090  :
1091  public MediaDataPacket
1092  {
1093  public:
1095 
1105  virtual Picture* getMotionData() const = 0;
1106  };
1107 
1108 
1109  // {AFE4EEDA-3770-42c3-8381-EE3B55522551}
1110  static const nxpl::NX_GUID IID_StreamReader = { { 0xaf, 0xe4, 0xee, 0xda, 0x37, 0x70, 0x42, 0xc3, 0x83, 0x81, 0xee, 0x3b, 0x55, 0x52, 0x25, 0x51 } };
1111 
1113 
1120  :
1121  public nxpl::PluginInterface
1122  {
1123  public:
1125 
1134  virtual int getNextData( MediaDataPacket** packet ) = 0;
1135 
1137  virtual void interrupt() = 0;
1138  };
1139 
1140 
1142  {
1146 
1152  };
1153 
1154 
1155  // {CEB97832-E931-4965-9B18-A8A1557107D7}
1156  static const nxpl::NX_GUID IID_DtsArchiveReader = { { 0xce, 0xb9, 0x78, 0x32, 0xe9, 0x31, 0x49, 0x65, 0x9b, 0x18, 0xa8, 0xa1, 0x55, 0x71, 0x7, 0xd7 } };
1157 
1159 
1173  :
1174  public nxpl::PluginInterface
1175  {
1176  public:
1178  {
1180 
1222 
1228  };
1229 
1231  virtual unsigned int getCapabilities() const = 0;
1232 
1234 
1237  virtual int open() = 0;
1239 
1242  virtual StreamReader* getStreamReader() = 0;
1244 
1247  virtual UsecUTCTimestamp startTime() const = 0;
1249 
1252  virtual UsecUTCTimestamp endTime() const = 0;
1254 
1266  virtual int seek(
1267  unsigned int cSeq,
1268  UsecUTCTimestamp timestamp,
1269  bool findKeyFrame,
1270  UsecUTCTimestamp* selectedPosition ) = 0;
1272 
1283  virtual int setReverseMode(
1284  unsigned int cSeq,
1285  bool isReverse,
1286  UsecUTCTimestamp timestamp,
1287  UsecUTCTimestamp* selectedPosition ) = 0;
1289  virtual bool isReverseModeEnabled() const = 0;
1291 
1295  virtual int setMotionDataEnabled( bool motionPresent ) = 0;
1297 
1307  virtual int setQuality(
1308  MediaStreamQuality quality,
1309  bool waitForKeyFrame ) = 0;
1311 
1323  virtual int playRange(
1324  unsigned int cSeq,
1325  UsecUTCTimestamp start,
1326  UsecUTCTimestamp endTimeHint,
1327  unsigned int step ) = 0;
1328 
1330 
1333  virtual void getLastErrorString( char* errorString ) const = 0;
1334  };
1335 
1336 
1337  // {C6F06A48-8E3A-4690-8B21-CAC4A955D7ED}
1338  static const nxpl::NX_GUID IID_CameraMotionDataProvider = { { 0xc6, 0xf0, 0x6a, 0x48, 0x8e, 0x3a, 0x46, 0x90, 0x8b, 0x21, 0xca, 0xc4, 0xa9, 0x55, 0xd7, 0xed } };
1339 
1342  :
1343  public nxpl::PluginInterface
1344  {
1345  public:
1346  //TODO for future use
1347  };
1348 
1349 
1351 
1352  // {872F473F-72CF-4397-81E6-C06D42E97113}
1353  static const nxpl::NX_GUID IID_CameraRelayIOManager = { { 0x87, 0x2f, 0x47, 0x3f, 0x72, 0xcf, 0x43, 0x97, 0x81, 0xe6, 0xc0, 0x6d, 0x42, 0xe9, 0x71, 0x13 } };
1354 
1355  static const int MAX_ID_LEN = 64;
1356  static const int MAX_RELAY_PORT_COUNT = 32;
1357 
1359 
1363  :
1364  public nxpl::PluginInterface
1365  {
1366  public:
1368 
1373  virtual int getRelayOutputList( char** idList, int* idNum ) const = 0;
1374 
1376 
1381  virtual int getInputPortList( char** idList, int* idNum ) const = 0;
1382 
1384 
1390  virtual int setRelayOutputState(
1391  const char* outputID,
1392  int activate,
1393  unsigned int autoResetTimeoutMS ) = 0;
1394 
1396 
1401  virtual int startInputPortMonitoring() = 0;
1402 
1404 
1411  virtual void stopInputPortMonitoring() = 0;
1412 
1414 
1418  virtual void registerEventHandler( CameraInputEventHandler* handler ) = 0;
1419 
1421 
1430  virtual void unregisterEventHandler( CameraInputEventHandler* handler ) = 0;
1431 
1433 
1436  virtual void getLastErrorString( char* errorString ) const = 0;
1437  };
1438 
1439 
1440  // {CC1E749F-2EC6-4b73-BEC9-8F2AE9B7FCCE}
1441  static const nxpl::NX_GUID IID_CameraInputEventHandler = { { 0xcc, 0x1e, 0x74, 0x9f, 0x2e, 0xc6, 0x4b, 0x73, 0xbe, 0xc9, 0x8f, 0x2a, 0xe9, 0xb7, 0xfc, 0xce } };
1442 
1445  :
1446  public nxpl::PluginInterface
1447  {
1448  public:
1449  virtual ~CameraInputEventHandler() {}
1450 
1452 
1459  virtual void inputPortStateChanged(
1460  CameraRelayIOManager* source,
1461  const char* inputPortID,
1462  int newState,
1463  unsigned long int timestamp ) = 0;
1464  };
1465 }
1466 
1467 #endif //NX_CAMERA_PLUGIN_H
Definition: time_periods.h:12
Resolution resolution
Guess what.
Definition: camera_plugin.h:266
VMS Camera Integration Plugin API (c++)
Definition: camera_plugin.h:29
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:871
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:794
virtual bool next()=0
Camera sends absolute timestamps in media stream.
Definition: camera_plugin.h:564
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:364
char modelName[256]
Camera model name in any human readable format. MUST NOT be empty.
Definition: camera_plugin.h:73
Set of options, used to search archive.
Definition: camera_plugin.h:676
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:250
virtual int width() const =0
Width (pixels)
Provides encoder parameter configuration and media stream access (by providing media stream url) ...
Definition: camera_plugin.h:286
virtual int getMaxBitrate(int *maxBitrate) const =0
Returns maximem 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:81
Extends BaseCameraManager2 by adding editable parameters.
Definition: camera_plugin.h:789
virtual int getReservedModelList(char **modelList, int *count)=0
Get model names, reserved by the plugin.
CoordinateSpace
Definition: camera_plugin.h:879
if present, nxcip::BaseCameraManager2::find supports ArchiveSearchOptions::motionMask() ...
Definition: camera_plugin.h:744
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:979
Provides access to motion detection support, implemented on camera.
Definition: camera_plugin.h:1341
bool descSortOrder
Definition: camera_plugin.h:716
virtual unsigned int channelNumber() const =0
Definition: camera_plugin.h:891
static const int NX_INTERRUPTED
Blocking call has been interrupted (e.g., by StreamReader::interrupt)
Definition: camera_plugin.h:54
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:556
allow multiple instances on a same IP address
Definition: camera_plugin.h:554
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:268
virtual const char * audioExtradata() const =0
Returns pointer to audio extra data.
CameraCapability
Enumeration of supported camera capabilities (bit flags)
Definition: camera_plugin.h:545
Definition: camera_plugin.h:415
Camera supports absolute pan.
Definition: camera_plugin.h:864
if this flag is enabled, CameraRelayIOManager MUST be implemented
Definition: camera_plugin.h:549
Camera supports absolute zoom.
Definition: camera_plugin.h:866
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:263
virtual int continuousMove(double panSpeed, double tiltSpeed, double zoomSpeed)=0
Starts or stops continuous PTZ movement.
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:1010
virtual int setFps(const float &fps, float *selectedFps)=0
virtual CompressionType codecType() const =0
Constant from nxcip::CompressionType enumeration.
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:345
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:558
bool keepSmallChunks
Definition: camera_plugin.h:706
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 posiition in stream.
Used for reading media stream from camera.
Definition: camera_plugin.h:1119
e.g., h.264 IDR frame
Definition: camera_plugin.h:1013
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:742
signed 16 bits
Definition: camera_plugin.h:350
Receives events on input port state change.
Definition: camera_plugin.h:1444
Definition: camera_plugin.h:1070
Default quality SHOULD be high quality.
Definition: camera_plugin.h:1144
Definition: camera_plugin.h:478
char url[MAX_TEXT_LEN]
Camera management url. Can contain just address. MUST NOT be empty.
Definition: camera_plugin.h:79
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:996
virtual int getFlip(int *flip)=0
Gets the camera streams&#39;s flipped state.
Picture * motionMask
Definition: camera_plugin.h:688
int32_t reserved_head
reserved, do not use
Definition: camera_plugin.h:422
Provides access to archive, stored on camera.
Definition: camera_plugin.h:1172
SampleType
Definition: camera_plugin.h:347
if set, camera supports audio
Definition: camera_plugin.h:551
if present, nxcip::BaseCameraManager3::setMotionMask is implemented
Definition: camera_plugin.h:745
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:1227
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:154
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:736
Logical coordinate space — degrees for pan, tilt and fov (zoom).
Definition: camera_plugin.h:882
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:70
Audio packet. Can contain mutiple audio frames.
Definition: camera_plugin.h:982
Capabilities
Definition: camera_plugin.h:1177
CameraInfo()
Initializes all values with zeros/empty strings.
Definition: camera_plugin.h:88
virtual int setBitrate(int bitrateKbps, int *selectedBitrateKbps)=0
int32_t codec
Definition: camera_plugin.h:424
Resolution of video stream picture.
Definition: camera_plugin.h:247
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:553
static const unsigned int MEDIA_PACKET_BUFFER_PADDING_SIZE
Required padding after media data (see MediaDataPacket::data() description)
Definition: camera_plugin.h:998
virtual int startInputPortMonitoring()=0
Starts relay input monitoring or increments internal counter, if already started. ...
Pan-tilt-zoom management.
Definition: camera_plugin.h:851
Camera supports continuous tilt.
Definition: camera_plugin.h:861
camera&#39;s media streams are editable and can be provided directly via setProperty API call...
Definition: camera_plugin.h:563
virtual int getParamValue(const char *paramName, char *valueBuf, int *valueBufSize) const =0
Reads value of parameter paramName.
Definition: camera_plugin.h:236
Picture.
Definition: camera_plugin.h:617
Extends CameraMediaEncoder by adding functionality for plugin to directly provide live media stream...
Definition: camera_plugin.h:391
signed 32 bits
Definition: camera_plugin.h:351
char defaultPassword[256]
Plugin can specify default credentials to use with camera.
Definition: camera_plugin.h:85
if present, nxcip::BaseCameraManager3::setMotionMask is implemented
Definition: camera_plugin.h:560
unsigned 8 bits
Definition: camera_plugin.h:349
Relay input/output management.
Definition: camera_plugin.h:1362
char firmware[256]
Firmware version in any human readable format. Optional.
Definition: camera_plugin.h:75
Definition: camera_plugin.h:111
Low quality.
Definition: camera_plugin.h:1151
Signals that reverse playback by GOP (group of picture) reordering is supported.
Definition: camera_plugin.h:1220
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:868
set in first packet of gop block of reverse stream (see nxcip::DtsArchiveReader::setReverseMode) ...
Definition: camera_plugin.h:1017
camera supports hardware motion. Plugin, returning this flag, MUST implement BaseCameraManager::nativ...
Definition: camera_plugin.h:547
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:1015
if this flag is enabled, CameraRelayIOManager MUST be implemented
Definition: camera_plugin.h:548
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:984
virtual CameraPtzManager * getPtzManager() const =0
MUST return not-NULL if ptzCapability is present.
Array of time periods.
Definition: camera_plugin.h:651
if present, nxcip::BaseCameraManager2::find supports ArchiveSearchOptions::motionMask() ...
Definition: camera_plugin.h:559
Definition: camera_plugin.h:469
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:561
Camera supports continuous zoom.
Definition: camera_plugin.h:862
if this flag is enabled, CameraPTZManager MUST be implemented
Definition: camera_plugin.h:550
int limit
Definition: camera_plugin.h:711
char uid[256]
Camera&#39;s unique identifier. MAC address can be used. MUST NOT be empty.
Definition: camera_plugin.h:77
virtual int setAudioEnabled(int audioEnabled)=0
Turn on/off audio on ALL encoders.
Camera supports absolute tilt.
Definition: camera_plugin.h:865
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:562
virtual int setParamValue(const char *paramName, const char *value)=0
Set value of parameter paramName to value.
Capability
Definition: camera_plugin.h:858
Provides base camera operations: getting/settings fps, resolution, bitrate, media stream url(s)...
Definition: camera_plugin.h:505
UsecUTCTimestamp startTime
Min data timestamp that is of interest.
Definition: camera_plugin.h:690
camera has archive storage and provides access to its archive
Definition: camera_plugin.h:555
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:423
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:83
Portion of media data.
Definition: camera_plugin.h:1005
Camera supports coordinate space limits queries.
Definition: camera_plugin.h:869
Video packet. MUST contain complete frame (or field in case of interlaced video)
Definition: camera_plugin.h:1089
Camera supports continuous pan.
Definition: camera_plugin.h:860
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:33
int height
Height in pixels.
Definition: camera_plugin.h:252
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:692
Definition: camera_plugin.h:1023
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:700
MediaStreamQuality
Definition: camera_plugin.h:1141
Camera parameters can be read/set even if camera is not accessible at the moment. ...
Definition: camera_plugin.h:796
virtual BaseCameraManager * createCameraManager(const CameraInfo &info)=0
Instantiates camera manager instance based on info.
Definition: camera_plugin.h:441
Packet containing no data (e.g., signals end of stream)
Definition: camera_plugin.h:989
Device-specific coordinate space.
Definition: camera_plugin.h:881
High quality.
Definition: camera_plugin.h:1149
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:52
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:565
it is allowed to detect motion by primary stream (if no dual streaming on camera) ...
Definition: camera_plugin.h:557
frame skipping with DtsArchiveReader::setSkipFrames method is supported
Definition: camera_plugin.h:1225
if second stream is running whatever fps it has => first stream can get maximumFps - secondstreamFps ...
Definition: camera_plugin.h:552