AJA NTV2 SDK  17.1.3.1410
NTV2 SDK 17.1.3.1410
ntv2nubaccess.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: MIT */
8 #ifndef NTV2NUBACCESS_H
9 #define NTV2NUBACCESS_H
10 
11 #include "ntv2utils.h" // NTV2StringList
12 #include "ajabase/system/lock.h" // AJALock
13 #include "ajabase/common/ajarefptr.h" // AJARefPtr
14 #include <string>
15 #include <vector>
16 #include <map>
17 
18 // TYPEDEFs
19 typedef std::pair<NTV2DeviceID, ULWord64> NTV2DeviceIDSerialPair;
20 typedef std::vector<NTV2DeviceIDSerialPair> NTV2DeviceIDSerialPairs;
21 typedef NTV2DeviceIDSerialPairs::iterator NTV2DeviceIDSerialPairsIter;
22 typedef NTV2DeviceIDSerialPairs::const_iterator NTV2DeviceIDSerialPairsConstIter;
23 
24 // Supported NTV2ConnectParams:
25 #define kConnectParamScheme "Scheme"
26 #define kConnectParamHost "Host"
27 #define kConnectParamPort "Port"
28 #define kConnectParamDevIndex "DeviceIndex"
29 #define kConnectParamDevSerial "DeviceSerial"
30 #define kConnectParamDevModel "DeviceModel"
31 #define kConnectParamDevID "DeviceID"
32 #define kConnectParamResource "ResourcePath"
33 #define kConnectParamQuery "Query"
34 
35 // AJA query params:
36 #define kQParamVerboseLogging "verbose"
37 #define kQParamLogToStdout "stdout"
38 #define kQParamShowX509Cert "showcert"
39 #define kQParamShowParams "showparams"
40 #define kQParamDebugRegistry "debugregistry"
41 
42 // Local URL schemes:
43 #define kLegalSchemeNTV2 "ntv2"
44 #define kLegalSchemeNTV2Local "ntv2local"
45 
46 // Exported Function Names:
47 #define kFuncNameCreateClient "CreateClient"
48 #define kFuncNameCreateServer "CreateServer"
49 #define kFuncNameGetRegInfo "GetRegistrationInfo"
50 
51 // Other Info Keys:
52 #define kNTV2PluginInfoKey_PluginsPath "PluginsPath"
53 #define kNTV2PluginInfoKey_PluginPath "PluginPath"
54 #define kNTV2PluginInfoKey_PluginSigPath "PluginSigPath"
55 #define kNTV2PluginInfoKey_PluginBaseName "PluginBaseName"
56 #define kNTV2PluginInfoKey_Fingerprint "serial number"
57 
58 // Plugin Registration Info Keys:
59 #define kNTV2PluginRegInfoKey_Vendor "Vendor"
60 #define kNTV2PluginRegInfoKey_CommonName "CommonName"
61 #define kNTV2PluginRegInfoKey_OrgUnit "OrgUnit"
62 #define kNTV2PluginRegInfoKey_ShortName "ShortName"
63 #define kNTV2PluginRegInfoKey_LongName "LongName"
64 #define kNTV2PluginRegInfoKey_Description "Description"
65 #define kNTV2PluginRegInfoKey_Copyright "Copyright"
66 #define kNTV2PluginRegInfoKey_NTV2SDKVersion "NTV2SDKVersion"
67 #define kNTV2PluginRegInfoKey_Version "Version"
68 #define kNTV2PluginRegInfoKey_CommitSHA "CommitSHA"
69 
70 // Plugin Signature File Keys:
71 #define kNTV2PluginSigFileKey_X509Certificate "X509Certificate"
72 #define kNTV2PluginSigFileKey_Signature "Signature"
73 
74 // X509 Certificate Attribute Keys:
75 #define kNTV2PluginX500AttrKey_CommonName "CN"
76 #define kNTV2PluginX500AttrKey_LocalityName "L"
77 #define kNTV2PluginX500AttrKey_StateOrProvinceName "ST"
78 #define kNTV2PluginX500AttrKey_OrganizationName "O"
79 #define kNTV2PluginX500AttrKey_OrganizationalUnitName "OU"
80 #define kNTV2PluginX500AttrKey_CountryName "C"
81 
82 
86 class AJAExport NTV2Dictionary
87 {
88  public:
92  inline size_t size (void) const {return mDict.size();}
94  inline bool empty (void) const {return mDict.empty();}
95  inline bool hasKey (const std::string & inKey) const {return mDict.find(inKey) != mDict.end();}
96  std::string valueForKey (const std::string & inKey) const;
97  uint16_t u16ValueForKey (const std::string & inKey, const uint16_t inDefault = 0) const;
98  NTV2StringSet keys (void) const;
99  size_t largestKeySize (void) const;
100  size_t largestValueSize (void) const;
101  std::ostream & Print (std::ostream & oss, const bool inCompact = true) const;
102  bool serialize (std::string & outStr) const;
103 
108  inline void clear (void) {mDict.clear();}
110  bool insert (const std::string & inKey, const std::string & inValue);
111  inline size_t erase (const std::string & inKey) {return hasKey(inKey) ? mDict.erase(inKey) : 0;}
112  size_t updateFrom (const NTV2Dictionary & inDict);
113  size_t addFrom (const NTV2Dictionary & inDict);
114  bool deserialize (const std::string & inStr);
115  #if !defined(NTV2_DEPRECATE_17_1)
116  inline NTV2_DEPRECATED_f(size_t UpdateFrom (const NTV2Dictionary & inDict)) {return updateFrom(inDict);}
117  inline NTV2_DEPRECATED_f(size_t AddFrom (const NTV2Dictionary & inDict)) {return addFrom(inDict);}
118  #endif // !defined(NTV2_DEPRECATE_17_1)
119 
121  protected:
122  typedef std::map<std::string, std::string> Dict;
123  typedef Dict::const_iterator DictConstIter;
124 
125  private:
126  Dict mDict;
127 }; // NTV2Dictionary
128 
129 typedef NTV2Dictionary NTV2Dict;
130 typedef NTV2Dictionary NTV2ConnectParams;
131 typedef NTV2Dictionary NTV2ConfigParams;
132 typedef std::pair<std::string, std::string> NTV2DictionaryEntry, NTV2DictEntry, NTV2ConnectParam;
133 
134 inline std::ostream & operator << (std::ostream & oss, const NTV2Dictionary & inDict) {return inDict.Print(oss);}
135 
142 class AJAExport NTV2DeviceSpecParser
143 {
144  public:
145  static bool IsSupportedScheme (const std::string & inScheme);
146 
147  public:
148  NTV2DeviceSpecParser (const std::string inSpec = "");
149  void Reset (const std::string inSpec = "");
150  inline const std::string & DeviceSpec (void) const {return mSpec;}
151  inline bool HasDeviceSpec (void) const {return !DeviceSpec().empty();}
152  inline bool Successful (void) const {return !Failed();}
153  inline bool Failed (void) const {return DeviceSpec().empty() ? true : HasErrors();}
154  inline bool HasScheme (void) const {return HasResult(kConnectParamScheme);}
155  inline std::string Scheme (void) const {return Result(kConnectParamScheme);}
156  inline bool IsLocalDevice (void) const {return Scheme() == kLegalSchemeNTV2Local || Scheme() == kLegalSchemeNTV2;}
157  inline size_t ErrorCount (void) const {return mErrors.size();}
158  inline bool HasErrors (void) const {return ErrorCount() > 0;}
159  inline std::string Error (const size_t inIndex = 0) const {if (inIndex < mErrors.size()) return mErrors.at(inIndex); return "";}
160  inline NTV2StringList Errors (void) const {return mErrors;}
161  inline NTV2ConnectParams Results (void) const {return mResult;}
162  inline bool HasResult (const std::string & inKey) const {return mResult.hasKey(inKey);}
163  std::string Result (const std::string & inKey) const {return mResult.valueForKey(inKey);}
164  std::string Resource (const bool inStripLeadSlash = true) const;
165  std::ostream & PrintErrors (std::ostream & oss) const;
166  std::ostream & Print (std::ostream & oss, const bool inDumpResults = false) const;
167  std::string InfoString (void) const;
168  uint64_t DeviceSerial (void) const;
169  inline std::string DeviceModel (void) const {return Result(kConnectParamDevModel);}
170  NTV2DeviceID DeviceID (void) const;
171  UWord DeviceIndex (void) const;
172  inline const NTV2Dictionary & QueryParams (void) const {return mQueryParams;}
173  inline std::string QueryParam (const std::string & inKey) const {return mQueryParams.valueForKey(inKey);}
174  #if defined(_DEBUG)
175  static void test (void);
176  #endif // defined(_DEBUG)
177 
178  private:
179  void Parse (void);
180  bool ParseHexNumber (size_t & pos, std::string & outToken);
181  bool ParseDecNumber (size_t & pos, std::string & outToken);
182  bool ParseAlphaNumeric (size_t & pos, std::string & outToken, const std::string & inOtherChars = ""); // A run of letters and/or decimal digits and/or other chars
183  bool ParseScheme (size_t & pos, std::string & outToken); // An alphanumeric name followed by "://"
184  bool ParseSerialNum (size_t & pos, std::string & outToken); // An 8 or 9 character alphanumeric name or a 64-bit hex number
185  bool ParseDeviceID (size_t & pos, std::string & outToken); // An 32-bit hex number that matches a known NTV2DeviceID
186  bool ParseModelName (size_t & pos, std::string & outToken); // An alphanumeric name that matches a known device model name
187  bool ParseDNSName (size_t & pos, std::string & outDNSName); // A domain name: one or more alphanumeric names separated with '.'
188  bool ParseIPv4Address (size_t & pos, std::string & outIPv4); // Exactly four decimal numbers, each no greater than 255, separated with '.'
189  bool ParseHostAddressAndPortNumber (size_t & pos, std::string & outAddr, std::string & outPort); // A host name or IPv4 address with an optional port number
190  bool ParseResourcePath (size_t & pos, std::string & outRsrc); // One or more '/'-separated alphanumeric names
191  bool ParseParamAssignment (size_t & pos, std::string & outKey, std::string & outValue); // An alphanumeric key optionally followed by '=' optionally followed by URL-encoded value string
192  bool ParseQuery (size_t & pos, NTV2Dictionary & outParams); // Starts with '?' one or more '&'-separated param assignments
193  inline int LargestResultKey (void) const {return int(mResult.largestKeySize());}
194  inline int LargestResultValue (void) const {return int(mResult.largestValueSize());}
195  inline char CharAt (const size_t inPos) {return inPos < mSpec.length() ? mSpec.at(inPos) : 0;}
196  inline size_t SpecLength (void) const {return mSpec.length();}
197  inline size_t CurrentPosition (void) const {return mPos;}
198  inline void AddError (const std::string & inError) {mErrors.push_back(inError);}
199  static bool IsUpperLetter (const char inChar);
200  static bool IsLowerLetter (const char inChar);
201  static bool IsLetter (const char inChar, const bool inIncludeUnderscore = false);
202  static bool IsDecimalDigit (const char inChar);
203  static bool IsHexDigit (const char inChar);
204  static bool IsLegalSerialNumChar (const char inChar);
205 
206  private:
207  std::string mSpec;
208  NTV2StringList mErrors;
209  NTV2ConnectParams mResult;
210  NTV2Dictionary mQueryParams;
211  size_t mPos;
212 }; // NTV2DeviceSpecParser
213 
214 #if defined(NTV2_PREVENT_PLUGIN_LOAD)
215 
216 #else // !defined(NTV2_PREVENT_PLUGIN_LOAD)
217 
218 #endif // !defined(NTV2_PREVENT_PLUGIN_LOAD)
219 
220 
224 class AJAExport NTV2RPCBase
225 {
226  public:
227  static std::string ShortSDKVersion (void);
228 
229  protected:
230  NTV2RPCBase (NTV2Dictionary params, uint32_t * pRefCon);
231  virtual ~NTV2RPCBase ();
232  bool SetParams (const NTV2ConfigParams & inNewParams, const bool inAugment = false);
233 
234  protected:
235  NTV2Dictionary mParams;
236  mutable AJALock mParamLock;
237  uint32_t * mpRefCon;
238 }; // NTV2RPCBase
239 
240 
253 class AJAExport NTV2RPCClientAPI : public NTV2RPCBase
254 {
255  public:
261  static NTV2RPCClientAPI * CreateClient (NTV2ConnectParams & inParams);
262 
263  public:
267  virtual std::string HostName (void) const {return ConnectParam(kConnectParamHost);}
269  virtual std::string Name (void) const {return "";}
270  virtual std::string Description (void) const;
271  virtual std::ostream & Print (std::ostream & oss) const;
273 
277  virtual bool NTV2Connect (void);
279  virtual bool NTV2Disconnect (void);
280  virtual bool IsConnected (void) const {return false;}
281 
286  virtual NTV2ConnectParams ConnectParams (void) const;
288  virtual bool HasConnectParam (const std::string & inParam) const;
289  virtual std::string ConnectParam (const std::string & inParam) const;
290  virtual bool ConnectHasScheme (void) const;
291  virtual inline bool SetConnectParams (const NTV2ConnectParams & inNewParams, const bool inAugment = false) {return !IsConnected() && SetParams(inNewParams, inAugment);}
292 
297  virtual bool NTV2ReadRegisterRemote (const ULWord regNum, ULWord & outRegValue, const ULWord regMask, const ULWord regShift);
299  virtual bool NTV2WriteRegisterRemote (const ULWord regNum, const ULWord regValue, const ULWord regMask, const ULWord regShift);
300  virtual bool NTV2AutoCirculateRemote (AUTOCIRCULATE_DATA & autoCircData);
301  virtual bool NTV2WaitForInterruptRemote (const INTERRUPT_ENUMS eInterrupt, const ULWord timeOutMs);
302  virtual bool NTV2DMATransferRemote (const NTV2DMAEngine inDMAEngine, const bool inIsRead,
303  const ULWord inFrameNumber, NTV2Buffer & inOutBuffer,
304  const ULWord inCardOffsetBytes, const ULWord inNumSegments,
305  const ULWord inSegmentHostPitch, const ULWord inSegmentCardPitch,
306  const bool inSynchronous);
307  virtual bool NTV2MessageRemote (NTV2_HEADER * pInMessage);
309 
313  virtual bool NTV2GetBoolParamRemote (const ULWord inParamID, ULWord & outValue); // New in SDK 17.0
315  virtual bool NTV2GetNumericParamRemote (const ULWord inParamID, ULWord & outValue); // New in SDK 17.0
316  virtual bool NTV2GetSupportedRemote (const ULWord inEnumsID, ULWordSet & outSupported); // New in SDK 17.0
318 
332  virtual bool NTV2QueryDevices (NTV2StringList & outDeviceInfos) {outDeviceInfos.clear(); return true;}
333 
334  #if !defined(NTV2_DEPRECATE_16_3) // These functions are going away
335  virtual bool NTV2DriverGetBitFileInformationRemote (BITFILE_INFO_STRUCT & bitFileInfo, const NTV2BitFileType bitFileType);
336  virtual bool NTV2DriverGetBuildInformationRemote (BUILD_INFO_STRUCT & buildInfo);
337  virtual bool NTV2DownloadTestPatternRemote (const NTV2Channel channel, const NTV2PixelFormat testPatternFBF,
338  const UWord signalMask, const bool testPatDMAEnb, const ULWord testPatNum);
339  virtual bool NTV2ReadRegisterMultiRemote (const ULWord numRegs, ULWord & outFailedRegNum, NTV2RegInfo outRegs[]);
340  virtual bool NTV2GetDriverVersionRemote (ULWord & outDriverVersion);
341  #endif // !defined(NTV2_DEPRECATE_16_3)
342 
343  virtual ~NTV2RPCClientAPI();
344 
345  protected:
346  NTV2RPCClientAPI (NTV2ConnectParams inParams, void * pRefCon);
347 
348  virtual bool NTV2OpenRemote (void);
349  virtual bool NTV2CloseRemote (void);
350 
351  protected:
352  uint32_t mSpare[1024];
353 }; // NTV2RPCClientAPI
354 
355 typedef NTV2RPCClientAPI NTV2RPCAPI;
356 
357 inline std::ostream & operator << (std::ostream & oss, const NTV2RPCClientAPI & inObj) {return inObj.Print(oss);}
358 
363 class AJAExport NTV2RPCServerAPI : public NTV2RPCBase
364 {
365  public:
373  static NTV2RPCServerAPI * CreateServer (NTV2ConfigParams & inParams);
374 
383  static NTV2RPCServerAPI * CreateServer (const std::string & inURL);
384 
385  public:
389  virtual std::ostream & Print (std::ostream & oss) const;
391  virtual inline bool IsRunning (void) const {return mRunning;}
392 
397  virtual NTV2ConfigParams ConfigParams (void) const;
399  virtual bool HasConfigParam (const std::string & inParam) const;
400  virtual std::string ConfigParam (const std::string & inParam) const;
401  virtual inline bool SetConfigParams (const NTV2ConfigParams & inNewParams, const bool inAugment = false) {return SetParams(inNewParams, inAugment);}
402 
407  virtual void RunServer (void);
409  virtual inline void Stop (void) {mTerminate = true;}
410 
412  protected:
413  NTV2RPCServerAPI (NTV2ConnectParams inParams, void * pRefCon);
414  virtual ~NTV2RPCServerAPI();
415 
416  protected:
417  bool mRunning;
418  bool mTerminate;
419  uint32_t mSpare[1024];
420 }; // NTV2RPCServerAPI
421 
422 inline std::ostream & operator << (std::ostream & oss, const NTV2RPCServerAPI & inObj) {return inObj.Print(oss);}
423 
429 extern "C"
430 {
444  typedef bool (*fpGetRegistrationInfo) (const uint32_t /*inHostSDKVers*/, NTV2Dictionary & /*outInfo*/);
445 
453  typedef NTV2RPCClientAPI* (*fpCreateClient) (void * /*pRefCon*/, const NTV2ConnectParams & /*inParams*/, const uint32_t /*inHostSDKVersion*/);
454 
463  typedef NTV2RPCServerAPI* (*fpCreateServer) (void * /*pRefCon*/, const NTV2ConfigParams & /*inParams*/, const uint32_t /*inHostSDKVersion*/);
464 
465  #if !defined(NTV2_DEPRECATE_16_3) // Don't use these functions going forward
466  typedef NTV2RPCAPI* (*fpCreateNTV2SoftwareDevice) (void * /*pInDLLHandle*/, const std::string & /*inQueryStr*/, const uint32_t /*inHostSDKVersion*/);
467  #endif // !defined(NTV2_DEPRECATE_16_3)
468 }
469 
470 #endif // NTV2NUBACCESS_H
NTV2ConfigParams
NTV2Dictionary NTV2ConfigParams
A dictionary of parameters used to configure an RPC server.
Definition: ntv2nubaccess.h:131
kLegalSchemeNTV2Local
#define kLegalSchemeNTV2Local
Definition: ntv2nubaccess.h:44
INTERRUPT_ENUMS
enum _INTERRUPT_ENUMS_ INTERRUPT_ENUMS
BUILD_INFO_STRUCT
Definition: ntv2publicinterface.h:4918
NTV2DeviceIDSerialPair
std::pair< NTV2DeviceID, ULWord64 > NTV2DeviceIDSerialPair
Identifies a device by its NTV2DeviceID and serial number.
Definition: ntv2nubaccess.h:19
NTV2StringSet
std::set< std::string > NTV2StringSet
Definition: ntv2utils.h:1137
NTV2Channel
NTV2Channel
These enum values are mostly used to identify a specific widget_framestore. They're also commonly use...
Definition: ntv2enums.h:1305
NTV2Buffer
A generic user-space buffer object that has an address and a length. Used most often to share an arbi...
Definition: ntv2publicinterface.h:5993
NTV2RPCServerAPI
Base class of objects that can serve device operation RPCs with NTV2RPCClientAPI instances.
Definition: ntv2nubaccess.h:363
NTV2RPCBase
Common base class for NTV2RPCClientAPI and NTV2RPCServerAPI.
Definition: ntv2nubaccess.h:224
NTV2DeviceIDSerialPairsConstIter
NTV2DeviceIDSerialPairs::const_iterator NTV2DeviceIDSerialPairsConstIter
Definition: ntv2nubaccess.h:22
NTV2Dict
NTV2Dictionary NTV2Dict
Definition: ntv2nubaccess.h:129
NTV2RPCBase::SetParams
bool SetParams(const NTV2ConfigParams &inNewParams, const bool inAugment=false)
Definition: ntv2nubaccess.cpp:1854
NTV2DeviceID
NTV2DeviceID
Identifies a specific AJA NTV2 device model number. The NTV2DeviceID is actually the PROM part number...
Definition: ntv2enums.h:20
NTV2FrameBufferFormat
NTV2FrameBufferFormat
Identifies a particular video frame buffer format. See Device Frame Buffer Formats for details.
Definition: ntv2enums.h:207
NTV2Dictionary::Print
std::ostream & Print(std::ostream &oss, const bool inCompact=true) const
Prints human-readable representation to ostream.
Definition: ntv2nubaccess.cpp:147
NTV2DeviceSpecParser::DeviceModel
std::string DeviceModel(void) const
Definition: ntv2nubaccess.h:169
NTV2RPCAPI
NTV2RPCClientAPI NTV2RPCAPI
Definition: ntv2nubaccess.h:355
kConnectParamDevModel
#define kConnectParamDevModel
First device of this model (e.g. 'kona4')
Definition: ntv2nubaccess.h:30
NTV2RPCBase::mParams
NTV2Dictionary mParams
Copy of config params passed to my constructor.
Definition: ntv2nubaccess.h:235
NTV2DMAEngine
NTV2DMAEngine
Definition: ntv2enums.h:1801
NTV2RPCClientAPI::NTV2QueryDevices
virtual bool NTV2QueryDevices(NTV2StringList &outDeviceInfos)
Queries the devices that are accessible on the remote host.
Definition: ntv2nubaccess.h:332
ULWordSet
std::set< ULWord > ULWordSet
A collection of unique ULWord (uint32_t) values.
Definition: ntv2publicinterface.h:54
kLegalSchemeNTV2
#define kLegalSchemeNTV2
Definition: ntv2nubaccess.h:43
lock.h
Declares the AJALock class.
ULWord
uint32_t ULWord
Definition: ajatypes.h:253
NTV2ConnectParams
NTV2Dictionary NTV2ConnectParams
A dictionary of parameters used to connect to remote/fake devices.
Definition: ntv2nubaccess.h:130
NTV2BitFileType
NTV2BitFileType
Definition: ntv2enums.h:3274
NTV2DeviceIDSerialPairs
std::vector< NTV2DeviceIDSerialPair > NTV2DeviceIDSerialPairs
An ordered sequence of NTV2DeviceIDSerialPairs.
Definition: ntv2nubaccess.h:20
kConnectParamHost
#define kConnectParamHost
DNS name, IPv4 or sw device DLL name.
Definition: ntv2nubaccess.h:26
NTV2RPCServerAPI::Print
virtual std::ostream & Print(std::ostream &oss) const
Definition: ntv2nubaccess.cpp:2138
NTV2RPCServerAPI::mTerminate
bool mTerminate
Set true to stop server.
Definition: ntv2nubaccess.h:418
NTV2RPCServerAPI::mRunning
bool mRunning
Running?
Definition: ntv2nubaccess.h:417
NTV2_HEADER
All new NTV2 structs start with this common header.
Definition: ntv2publicinterface.h:6954
UWord
uint16_t UWord
Definition: ajatypes.h:251
ntv2utils.h
Declares numerous NTV2 utility functions.
NTV2RPCBase::mParamLock
AJALock mParamLock
Mutex to protect mParams.
Definition: ntv2nubaccess.h:236
NTV2Dictionary::DictConstIter
Dict::const_iterator DictConstIter
Definition: ntv2nubaccess.h:123
NTV2StringList
std::vector< std::string > NTV2StringList
Definition: ntv2utils.h:1134
AJALock
Definition: lock.h:30
kConnectParamScheme
#define kConnectParamScheme
URL scheme.
Definition: ntv2nubaccess.h:25
NTV2DeviceSpecParser
One-stop shop for parsing device specifications. (New in SDK 16.3) I do very little in the way of val...
Definition: ntv2nubaccess.h:142
NTV2DictEntry
std::pair< std::string, std::string > NTV2DictEntry
Definition: ntv2nubaccess.h:132
NTV2DictionaryEntry
std::pair< std::string, std::string > NTV2DictionaryEntry
Definition: ntv2nubaccess.h:132
NTV2_DEPRECATED_f
#define NTV2_DEPRECATED_f(__f__)
Definition: ajatypes.h:553
NTV2ConnectParam
std::pair< std::string, std::string > NTV2ConnectParam
A parameter used to connect to remote/fake devices.
Definition: ntv2nubaccess.h:132
AJAExport
#define AJAExport
Definition: export.h:33
true
#define true
Definition: ntv2devicefeatures.h:26
NTV2DeviceIDSerialPairsIter
NTV2DeviceIDSerialPairs::iterator NTV2DeviceIDSerialPairsIter
Definition: ntv2nubaccess.h:21
NTV2RPCClientAPI::Print
virtual std::ostream & Print(std::ostream &oss) const
Definition: ntv2nubaccess.cpp:1930
fpGetRegistrationInfo
bool(* fpGetRegistrationInfo)(const uint32_t, NTV2Dictionary &)
Obtains a plugin's registration information. Starting in SDK 17.1, all plugins must implement this fu...
Definition: ntv2nubaccess.h:444
NTV2RPCClientAPI
An object that can connect to, and operate remote or fake devices. I have three general API groups:
Definition: ntv2nubaccess.h:253
NTV2Dictionary::valueForKey
std::string valueForKey(const std::string &inKey) const
Definition: ntv2nubaccess.cpp:103
NTV2RPCBase::mpRefCon
uint32_t * mpRefCon
Reserved for internal use.
Definition: ntv2nubaccess.h:237
NTV2Dictionary
A simple (not thread-safe) set of key/value pairs. (New in SDK 16.3)
Definition: ntv2nubaccess.h:86
ajarefptr.h
Defines the AJARefPtr template class.
NTV2Dictionary::Dict
std::map< std::string, std::string > Dict
Definition: ntv2nubaccess.h:122
BITFILE_INFO_STRUCT
Definition: ntv2publicinterface.h:4803
NTV2RegInfo
Everything needed to call CNTV2Card::ReadRegister or CNTV2Card::WriteRegister functions.
Definition: ntv2publicinterface.h:3931
AUTOCIRCULATE_DATA
Definition: ntv2publicinterface.h:4369
operator<<
std::ostream & operator<<(std::ostream &oss, const NTV2Dictionary &inDict)
Definition: ntv2nubaccess.h:134