AJA NTV2 SDK  17.5.0.1242
NTV2 SDK 17.5.0.1242
main.cpp
Go to the documentation of this file.
1 /* SPDX-License-Identifier: MIT */
9 // Includes
10 #include "ntv2player.h"
11 #include <signal.h>
12 
13 
14 using namespace std;
15 
16 
17 // Globals
18 static bool gGlobalQuit (false); // Set this "true" to exit gracefully
19 
20 
21 static void SignalHandler (int inSignal)
22 {
23  (void) inSignal;
24  gGlobalQuit = true;
25 }
26 
27 
28 int main (int argc, const char ** argv)
29 {
30  char * pDeviceSpec (AJA_NULL); // Device specifier string, if any
31  char * pPixelFormat (AJA_NULL); // Pixel format argument
32  char * pFramesSpec (AJA_NULL); // AutoCirculate frames spec
33  char * pAncFilePath (AJA_NULL); // Anc data filepath to play
34  char * pVideoFormat (AJA_NULL); // Video format to use
35  int channelNumber (1); // Channel/FrameStore to use
36  int doMultiFormat (0); // MultiFormat mode?
37  int showVersion (0); // Show version?
38  int noAudio (0); // Disable audio tone?
39  int noVideo (0); // Disable video?
40  int xmitLTC (0); // Use LTC? (Defaults to VITC)
42 
43  // Command line option descriptions:
44  const CNTV2DemoCommon::PoptOpts optionsTable [] =
45  {
46  {"version", 0, POPT_ARG_NONE, &showVersion, 0, "show version & exit", AJA_NULL },
47  {"device", 'd', POPT_ARG_STRING, &pDeviceSpec, 0, "device to use", "index#, serial#, or model" },
48  {"channel", 'c', POPT_ARG_INT, &channelNumber, 0, "channel to use", "1-8" },
49  {"multiFormat", 'm', POPT_ARG_NONE, &doMultiFormat, 0, "use multi-format/channel", AJA_NULL },
50  {"pixelFormat", 'p', POPT_ARG_STRING, &pPixelFormat, 0, "pixel format to use", "'?' or 'list' to list" },
51  {"frames", 0, POPT_ARG_STRING, &pFramesSpec, 0, "frames to AutoCirculate", "num[@min] or min-max" },
52  {"videoFormat", 'v', POPT_ARG_STRING, &pVideoFormat, 0, "video format to produce", "'?' or 'list' to list" },
53  {"anc", 'a', POPT_ARG_STRING, &pAncFilePath, 0, "play prerecorded anc", "path/to/binary/data/file" },
54  {"noaudio", 0, POPT_ARG_NONE, &noAudio, 0, "disable audio tone", AJA_NULL },
55  {"novideo", 0, POPT_ARG_NONE, &noVideo, 0, "disable video", AJA_NULL },
56  {"ltc", 'l', POPT_ARG_NONE, &xmitLTC, 0, "xmit LTC instead of VITC", AJA_NULL },
59  };
60  CNTV2DemoCommon::Popt popt(argc, argv, optionsTable);
61  if (!popt)
62  {cerr << "## ERROR: " << popt.errorStr() << endl; return 2;}
63  if (showVersion)
64  {cout << argv[0] << ", NTV2 SDK " << ::NTV2Version() << endl; return 0;}
65 
66  // Device
67  const string deviceSpec (pDeviceSpec ? pDeviceSpec : "0");
68  if (!CNTV2DemoCommon::IsValidDevice(deviceSpec))
69  return 1;
70 
71  PlayerConfig config(deviceSpec);
72 
73  // Channel
74  if ((channelNumber < 1) || (channelNumber > 8))
75  {cerr << "## ERROR: Invalid channel number " << channelNumber << " -- expected 1 thru 8" << endl; return 1;}
76  config.fOutputChannel = NTV2Channel(channelNumber - 1);
77 
78  // VideoFormat
79  const string videoFormatStr (pVideoFormat ? pVideoFormat : "");
80  config.fVideoFormat = videoFormatStr.empty() ? NTV2_FORMAT_1080i_5994
81  : CNTV2DemoCommon::GetVideoFormatFromString(videoFormatStr, VIDEO_FORMATS_ALL, deviceSpec);
82  if (videoFormatStr == "?" || videoFormatStr == "list")
83  {cout << CNTV2DemoCommon::GetVideoFormatStrings(VIDEO_FORMATS_ALL, pDeviceSpec ? deviceSpec : "") << endl; return 0;}
84  else if (!videoFormatStr.empty() && config.fVideoFormat == NTV2_FORMAT_UNKNOWN)
85  { cerr << "## ERROR: Invalid '--videoFormat' value '" << videoFormatStr << "' -- expected values:" << endl
87  return 2;
88  }
89 
90  // Pixel Format
91  const string pixelFormatStr (pPixelFormat ? pPixelFormat : "");
92  config.fPixelFormat = pixelFormatStr.empty() ? NTV2_FBF_8BIT_YCBCR : CNTV2DemoCommon::GetPixelFormatFromString(pixelFormatStr);
93  if (pixelFormatStr == "?" || pixelFormatStr == "list")
94  {cout << CNTV2DemoCommon::GetPixelFormatStrings(PIXEL_FORMATS_ALL, pDeviceSpec ? deviceSpec : "") << endl; return 0;}
95  else if (!pixelFormatStr.empty() && !NTV2_IS_VALID_FRAME_BUFFER_FORMAT(config.fPixelFormat))
96  {
97  cerr << "## ERROR: Invalid '--pixelFormat' value '" << pixelFormatStr << "' -- expected values:" << endl
99  return 2;
100  }
101 
102  // AutoCirculate Frames
103  static const string legalFramesSpec ("{frameCount}[@{firstFrameNum}] or {firstFrameNum}-{lastFrameNum}");
104  const string framesSpec (pFramesSpec ? pFramesSpec : "");
105  if (!framesSpec.empty())
106  {
107  const string parseResult(config.fFrames.setFromString(framesSpec));
108  if (!parseResult.empty())
109  {cerr << "## ERROR: Bad 'frames' spec '" << framesSpec << "'\n## " << parseResult << endl; return 1;}
110  }
111  if (!config.fFrames.valid())
112  {cerr << "## ERROR: Bad 'frames' spec '" << framesSpec << "'\n## Expected " << legalFramesSpec << endl; return 1;}
113 
114  if (noVideo && noAudio)
115  {cerr << "## ERROR: conflicting options '--novideo' and '--noaudio'" << endl; return 1;}
116 
117  // Anc Playback
118  string ancFilePath (pAncFilePath ? pAncFilePath : "");
119  config.fAncDataFilePath = aja::strip(ancFilePath);
121  config.fSuppressAudio = noAudio ? true : false;
122  config.fSuppressVideo = noVideo ? true : false;
123  config.fDoMultiFormat = doMultiFormat ? true : false; // Multiformat mode?
124  config.fTransmitLTC = xmitLTC ? true : false;
125 
126  // Instantiate and initialize the NTV2Player object...
127  NTV2Player player(config);
128  AJAStatus status = player.Init();
129  if (AJA_FAILURE(status))
130  {cout << "## ERROR: Initialization failed: " << ::AJAStatusToString(status) << endl; return 1;}
131 
132  ::signal (SIGINT, SignalHandler);
133  #if defined(AJAMac)
134  ::signal (SIGHUP, SignalHandler);
135  ::signal (SIGQUIT, SignalHandler);
136  #endif
137 
138  // Run it...
139  player.Run();
140 
141  cout << " Frames Frames Buffer" << endl
142  << " Played Dropped Level" << endl;
143  do
144  { // Poll its status until stopped...
145  AUTOCIRCULATE_STATUS outputStatus;
146  player.GetACStatus(outputStatus);
147  cout << setw(9) << outputStatus.GetProcessedFrameCount()
148  << setw(9) << outputStatus.GetDroppedFrameCount()
149  << setw(9) << outputStatus.GetBufferLevel() << "\r" << flush;
150  AJATime::Sleep(2000);
151  } while (player.IsRunning() && !gGlobalQuit); // loop til done
152 
153  cout << endl;
154  return 0;
155 
156 } // main
CNTV2DemoCommon::GetVideoFormatFromString
static NTV2VideoFormat GetVideoFormatFromString(const std::string &inStr, const NTV2VideoFormatKinds inKinds=VIDEO_FORMATS_SDHD, const std::string &inDevSpec=std::string())
Returns the NTV2VideoFormat that matches the given string.
Definition: ntv2democommon.cpp:553
poptOption
Definition: options_popt.h:148
CNTV2DemoCommon::GetPixelFormatFromString
static NTV2PixelFormat GetPixelFormatFromString(const std::string &inStr, const NTV2PixelFormatKinds inKinds=PIXEL_FORMATS_ALL, const std::string inDevSpec=std::string())
Returns the NTV2PixelFormat that matches the given string.
Definition: ntv2democommon.cpp:637
aja::strip
std::string & strip(std::string &str, const std::string &ws)
Definition: common.cpp:461
NTV2Channel
NTV2Channel
These enum values are mostly used to identify a specific widget_framestore. They're also commonly use...
Definition: ntv2enums.h:1334
VIDEO_FORMATS_ALL
@ VIDEO_FORMATS_ALL
Definition: ntv2democommon.h:229
NTV2Player
I play out SD or HD test pattern (with timecode) to an output of an AJA device with or without audio ...
Definition: ntv2player.h:24
SignalHandler
void SignalHandler(int inSignal)
Definition: main.cpp:26
NTV2_FORMAT_1080i_5994
@ NTV2_FORMAT_1080i_5994
Definition: ntv2enums.h:535
AUTOCIRCULATE_STATUS::GetProcessedFrameCount
ULWord GetProcessedFrameCount(void) const
Definition: ntv2publicinterface.h:7249
AUTOCIRCULATE_STATUS::GetBufferLevel
ULWord GetBufferLevel(void) const
Definition: ntv2publicinterface.h:7254
main
int main(int argc, const char **argv)
Definition: main.cpp:30
PlayerConfig::fDoMultiFormat
bool fDoMultiFormat
If true, enable device-sharing; otherwise take exclusive control of device.
Definition: ntv2democommon.h:332
NTV2Player::Init
virtual AJAStatus Init(void)
Initializes me and prepares me to Run.
Definition: ntv2player.cpp:111
NTV2ACFrameRange::setFromString
std::string setFromString(const std::string &inStr)
Definition: ntv2utils.cpp:4155
NTV2ChannelToOutputDestination
NTV2OutputDestination NTV2ChannelToOutputDestination(const NTV2Channel inChannel, const NTV2IOKinds inKinds=NTV2_IOKINDS_SDI)
Converts the given NTV2Channel value into its ordinary equivalent NTV2OutputDestination.
Definition: ntv2utils.cpp:5227
nlohmann::json_abiNLOHMANN_JSON_ABI_TAG_LEGACY_DISCARDED_VALUE_COMPARISON_v3_11_NLOHMANN_JSON_VERSION_PATCH::detail::void
j template void())
Definition: json.hpp:4893
POPT_ARG_INT
#define POPT_ARG_INT
Definition: options_popt.h:58
POPT_AUTOHELP
#define POPT_AUTOHELP
Definition: options_popt.h:220
CNTV2DemoCommon::IsValidDevice
static bool IsValidDevice(const std::string &inDeviceSpec)
Definition: ntv2democommon.cpp:455
AJAStatus
AJAStatus
Definition: types.h:378
PlayerConfig::fFrames
NTV2ACFrameRange fFrames
AutoCirculate frame count or range.
Definition: ntv2democommon.h:326
AJATime::Sleep
static void Sleep(const int32_t inMilliseconds)
Suspends execution of the current thread for a given number of milliseconds.
Definition: systemtime.cpp:284
AUTOCIRCULATE_STATUS
This is returned from the CNTV2Card::AutoCirculateGetStatus function.
Definition: ntv2publicinterface.h:7193
PlayerConfig::fSuppressAudio
bool fSuppressAudio
If true, suppress audio; otherwise generate & xfer audio tone.
Definition: ntv2democommon.h:333
PlayerConfig::fSuppressVideo
bool fSuppressVideo
If true, suppress video; otherwise generate & xfer test patterns.
Definition: ntv2democommon.h:334
CNTV2DemoCommon::GetPixelFormatStrings
static std::string GetPixelFormatStrings(const NTV2PixelFormatKinds inKinds=PIXEL_FORMATS_ALL, const std::string inDevSpec=std::string())
Definition: ntv2democommon.cpp:605
PlayerConfig::fVideoFormat
NTV2VideoFormat fVideoFormat
The video format to use.
Definition: ntv2democommon.h:328
NTV2_FBF_8BIT_YCBCR
@ NTV2_FBF_8BIT_YCBCR
See 8-Bit YCbCr Format.
Definition: ntv2enums.h:214
CNTV2DemoCommon::Popt
Definition: ntv2democommon.h:848
PlayerConfig::fOutputChannel
NTV2Channel fOutputChannel
The device channel to use.
Definition: ntv2democommon.h:324
CNTV2DemoCommon::Popt::errorStr
virtual const std::string & errorStr(void) const
Definition: ntv2democommon.h:856
NTV2Version
std::string NTV2Version(const bool inDetailed=false)
Definition: ntv2version.cpp:41
PlayerConfig::fAncDataFilePath
std::string fAncDataFilePath
Optional path to Anc binary data file to playout.
Definition: ntv2democommon.h:323
CNTV2DemoCommon::GetVideoFormatStrings
static std::string GetVideoFormatStrings(const NTV2VideoFormatKinds inKinds=VIDEO_FORMATS_SDHD, const std::string inDevSpec=std::string())
Definition: ntv2democommon.cpp:523
gGlobalQuit
static bool gGlobalQuit((0))
AJADebug::Open
static AJAStatus Open(bool incrementRefCount=false)
Definition: debug.cpp:44
AJA_NULL
#define AJA_NULL
Definition: ajatypes.h:199
NTV2_FORMAT_UNKNOWN
@ NTV2_FORMAT_UNKNOWN
Definition: ntv2enums.h:521
PlayerConfig::fTransmitLTC
bool fTransmitLTC
If true, embed LTC; otherwise embed VITC.
Definition: ntv2democommon.h:335
PlayerConfig::fOutputDest
NTV2OutputDest fOutputDest
The desired output connector to use.
Definition: ntv2democommon.h:325
std
Definition: json.hpp:5362
AJAStatusToString
std::string AJAStatusToString(const AJAStatus inStatus, const bool inDetailed)
Definition: debug.cpp:981
AUTOCIRCULATE_STATUS::GetDroppedFrameCount
ULWord GetDroppedFrameCount(void) const
Definition: ntv2publicinterface.h:7244
POPT_TABLEEND
#define POPT_TABLEEND
Definition: options_popt.h:215
ntv2player.h
true
#define true
Definition: ntv2devicefeatures.h:26
NTV2ACFrameRange::valid
bool valid(void) const
Definition: ntv2utils.h:985
PlayerConfig
Configures an NTV2Player instance.
Definition: ntv2democommon.h:319
PlayerConfig::fPixelFormat
NTV2PixelFormat fPixelFormat
The pixel format to use.
Definition: ntv2democommon.h:327
NTV2Player::Run
virtual AJAStatus Run(void)
Runs me.
Definition: ntv2player.cpp:481
NTV2_IS_VALID_FRAME_BUFFER_FORMAT
#define NTV2_IS_VALID_FRAME_BUFFER_FORMAT(__s__)
Definition: ntv2enums.h:254
AJA_FAILURE
#define AJA_FAILURE(_status_)
Definition: types.h:371
POPT_ARG_STRING
#define POPT_ARG_STRING
Definition: options_popt.h:57
POPT_ARG_NONE
#define POPT_ARG_NONE
Definition: options_popt.h:56
NTV2Player::GetACStatus
virtual void GetACStatus(AUTOCIRCULATE_STATUS &outStatus)
Provides status information about my output (playout) process.
Definition: ntv2player.cpp:830
PIXEL_FORMATS_ALL
@ PIXEL_FORMATS_ALL
Definition: ntv2democommon.h:252