AJA NTV2 SDK  17.5.0.1242
NTV2 SDK 17.5.0.1242
ntv2player8k.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: MIT */
9 #ifndef _NTV2PLAYER8K_H
10 #define _NTV2PLAYER8K_H
11 
12 #include "ntv2democommon.h"
13 #include "ajabase/system/thread.h"
15 
16 
25 {
26  // Public Instance Methods
27  public:
33  NTV2Player8K (const PlayerConfig & inConfig);
34 
35  virtual ~NTV2Player8K (void);
36 
37  virtual AJAStatus Init (void);
38 
43  virtual AJAStatus Run (void);
44 
45  virtual void Quit (void);
46 
47  virtual bool IsRunning (void) const {return !mGlobalQuit;}
48 
53  virtual void GetACStatus (AUTOCIRCULATE_STATUS & outStatus);
54 
55 
56  // Protected Instance Methods
57  protected:
58  virtual AJAStatus SetUpVideo (void);
59  virtual AJAStatus SetUpAudio (void);
60  virtual bool RouteOutputSignal (void);
61  virtual AJAStatus SetUpHostBuffers (void);
62  virtual AJAStatus SetUpTestPatternBuffers (void);
63  virtual void StartConsumerThread (void);
64  virtual void ConsumeFrames (void);
65  virtual void StartProducerThread (void);
66  virtual void ProduceFrames (void);
67 
74  virtual uint32_t AddTone (ULWord * audioBuffer);
75 
76 
77  // Protected Class Methods
78  protected:
85  static void ConsumerThreadStatic (AJAThread * pThread, void * pContext);
86 
93  static void ProducerThreadStatic (AJAThread * pThread, void * pContext);
94 
95 
96  // Private Member Data
97  private:
98  typedef std::vector<NTV2Buffer> NTV2Buffers;
99 
100  PlayerConfig mConfig;
101  AJAThread mConsumerThread;
102  AJAThread mProducerThread;
103  CNTV2Card mDevice;
104  NTV2DeviceID mDeviceID;
105  NTV2TaskMode mSavedTaskMode;
106  ULWord mCurrentFrame;
107  ULWord mCurrentSample;
108  double mToneFrequency;
109  NTV2AudioSystem mAudioSystem;
110  NTV2FormatDesc mFormatDesc;
111 
112  bool mGlobalQuit;
113  AJATimeCodeBurn mTCBurner;
114  NTV2FrameDataArray mHostBuffers;
115  FrameDataRingBuffer mFrameDataRing;
116  NTV2Buffers mTestPatRasters;
117 
118 }; // NTV2Player8K
119 
120 #endif // _NTV2PLAYER8K_H
NTV2Player8K::StartConsumerThread
virtual void StartConsumerThread(void)
Starts my consumer thread.
Definition: ntv2player8k.cpp:614
NTV2TaskMode
enum NTV2EveryFrameTaskMode NTV2TaskMode
NTV2Player8K::SetUpHostBuffers
virtual AJAStatus SetUpHostBuffers(void)
Sets up my host video & audio buffers.
Definition: ntv2player8k.cpp:311
NTV2Player8K::AddTone
virtual uint32_t AddTone(ULWord *audioBuffer)
Inserts audio tone (based on my current tone frequency) into the given audio buffer.
Definition: ntv2player8k.cpp:832
NTV2Player8K::SetUpAudio
virtual AJAStatus SetUpAudio(void)
Performs all audio setup.
Definition: ntv2player8k.cpp:260
NTV2FormatDescriptor
Describes a video frame for a given video standard or format and pixel format, including the total nu...
Definition: ntv2formatdescriptor.h:41
NTV2Player8K::Quit
virtual void Quit(void)
Gracefully stops me from running.
Definition: ntv2player8k.cpp:84
NTV2Player8K::StartProducerThread
virtual void StartProducerThread(void)
Starts my producer thread.
Definition: ntv2player8k.cpp:763
NTV2Player8K::SetUpTestPatternBuffers
virtual AJAStatus SetUpTestPatternBuffers(void)
Creates my test pattern buffers.
Definition: ntv2player8k.cpp:358
NTV2DeviceID
NTV2DeviceID
Identifies a specific AJA NTV2 device model number. The NTV2DeviceID is actually the PROM part number...
Definition: ntv2enums.h:20
AJAThread
Definition: thread.h:69
timecodeburn.h
Declares the AJATimeCodeBurn class.
NTV2Player8K
I am an object that can play out an 8K or UHD2 test pattern (with timecode) to 4 x 12G SDI outputs of...
Definition: ntv2player8k.h:24
AJAStatus
AJAStatus
Definition: types.h:378
NTV2Player8K::ConsumeFrames
virtual void ConsumeFrames(void)
My consumer thread that repeatedly plays frames using AutoCirculate (until quit).
Definition: ntv2player8k.cpp:636
NTV2Player8K::SetUpVideo
virtual AJAStatus SetUpVideo(void)
Performs all video setup.
Definition: ntv2player8k.cpp:188
ULWord
uint32_t ULWord
Definition: ajatypes.h:255
AUTOCIRCULATE_STATUS
This is returned from the CNTV2Card::AutoCirculateGetStatus function.
Definition: ntv2publicinterface.h:7193
NTV2Player8K::ProducerThreadStatic
static void ProducerThreadStatic(AJAThread *pThread, void *pContext)
This is the producer thread's static callback function that gets called when the producer thread star...
Definition: ntv2player8k.cpp:773
CNTV2Card
I interrogate and control an AJA video/audio capture/playout device.
Definition: ntv2card.h:28
NTV2Player8K::ProduceFrames
virtual void ProduceFrames(void)
My producer thread that repeatedly produces video frames.
Definition: ntv2player8k.cpp:783
NTV2FrameDataArray
std::vector< NTV2FrameData > NTV2FrameDataArray
A vector of NTV2FrameData elements.
Definition: ntv2democommon.h:152
NTV2Player8K::RouteOutputSignal
virtual bool RouteOutputSignal(void)
Performs all widget/signal routing for playout.
Definition: ntv2player8k.cpp:417
NTV2Player8K::Run
virtual AJAStatus Run(void)
Runs me.
Definition: ntv2player8k.cpp:600
NTV2Player8K::~NTV2Player8K
virtual ~NTV2Player8K(void)
Definition: ntv2player8k.cpp:75
ntv2democommon.h
This file contains some structures, constants, classes and functions that are used in some of the dem...
NTV2Player8K::ConsumerThreadStatic
static void ConsumerThreadStatic(AJAThread *pThread, void *pContext)
This is the consumer thread's static callback function that gets called when the consumer thread star...
Definition: ntv2player8k.cpp:625
NTV2Player8K::NTV2Player8K
NTV2Player8K(const PlayerConfig &inConfig)
Constructs me using the given configuration settings.
Definition: ntv2player8k.cpp:54
NTV2Player8K::Init
virtual AJAStatus Init(void)
Initializes me and prepares me to Run.
Definition: ntv2player8k.cpp:107
NTV2Player8K::GetACStatus
virtual void GetACStatus(AUTOCIRCULATE_STATUS &outStatus)
Provides status information about my output (playout) process.
Definition: ntv2player8k.cpp:868
PlayerConfig
Configures an NTV2Player instance.
Definition: ntv2democommon.h:319
AJATimeCodeBurn
Definition: timecodeburn.h:19
NTV2AudioSystem
NTV2AudioSystem
Used to identify an Audio System on an NTV2 device. See Audio System Operation for more information.
Definition: ntv2enums.h:3848
thread.h
Declares the AJAThread class.
AJACircularBuffer< NTV2FrameData * >