Instances of me capture frames in real time from a video signal provided to an input of an AJA device. More...

#include <ntv2capture.h>

Public Member Functions
	NTV2Capture (const CaptureConfig &inConfig)
	Constructs me using the given settings. More...

virtual	~NTV2Capture ()

virtual AJAStatus	Init (void)
	Initializes me and prepares me to Run. More...

virtual AJAStatus	Run (void)
	Runs me. More...

virtual void	Quit (void)
	Gracefully stops me from running. More...

virtual void	GetACStatus (ULWord &outGoodFrames, ULWord &outDroppedFrames, ULWord &outBufferLevel)
	Provides status information about my input (capture) process. More...

Protected Member Functions
virtual AJAStatus	SetupVideo (void)
	Sets up everything I need for capturing video. More...

virtual AJAStatus	SetupAudio (void)
	Sets up everything I need for capturing audio. More...

virtual bool	RouteInputSignal (void)
	Sets up device routing for capture. More...

virtual void	SetupHostBuffers (void)
	Sets up my circular buffers. More...

virtual void	StartProducerThread (void)
	Starts my capture thread. More...

virtual void	CaptureFrames (void)
	Repeatedly captures frames using AutoCirculate (until global quit flag set). More...

virtual void	StartConsumerThread (void)
	Starts my frame consumer thread. More...

virtual void	ConsumeFrames (void)
	Repeatedly consumes frames from the circular buffer (until global quit flag set). More...

Static Protected Member Functions
static void	ConsumerThreadStatic (AJAThread pThread, void pContext)
	This is the consumer thread's static callback function that gets called when the consumer thread runs. This function gets "Attached" to the consumer thread's AJAThread instance. More...

static void	ProducerThreadStatic (AJAThread pThread, void pContext)
	This is the capture thread's static callback function that gets called when the capture thread runs. This function gets "Attached" to the AJAThread instance. More...

Detailed Description

Instances of me capture frames in real time from a video signal provided to an input of an AJA device.

Definition at line 19 of file ntv2capture.h.

Constructor & Destructor Documentation

◆ NTV2Capture()

NTV2Capture::NTV2Capture ( const CaptureConfig & inConfig )

Constructs me using the given settings.

Parameters

[in] inConfig Specifies how to configure capture.

Note: I'm not completely initialized and ready to use until after my Init method has been called.

Definition at line 25 of file ntv2capture.cpp.

◆ ~NTV2Capture()

NTV2Capture::~NTV2Capture ( )

virtual

Definition at line 40 of file ntv2capture.cpp.

Member Function Documentation

◆ CaptureFrames()

void NTV2Capture::CaptureFrames ( void )

protectedvirtual

Repeatedly captures frames using AutoCirculate (until global quit flag set).

Definition at line 384 of file ntv2capture.cpp.

◆ ConsumeFrames()

void NTV2Capture::ConsumeFrames ( void )

protectedvirtual

Repeatedly consumes frames from the circular buffer (until global quit flag set).

Definition at line 320 of file ntv2capture.cpp.

◆ ConsumerThreadStatic()

void NTV2Capture::ConsumerThreadStatic	(	AJAThread *	pThread,
		void *	pContext
	)

staticprotected

This is the consumer thread's static callback function that gets called when the consumer thread runs. This function gets "Attached" to the consumer thread's AJAThread instance.

Parameters

[in]	pThread	A valid pointer to the consumer thread's AJAThread instance.
[in]	pContext	Context information to pass to the thread. (For this application, this will point to the NTV2Capture instance.)

Definition at line 308 of file ntv2capture.cpp.

◆ GetACStatus()

void NTV2Capture::GetACStatus	(	ULWord &	outGoodFrames,
		ULWord &	outDroppedFrames,
		ULWord &	outBufferLevel
	)

virtual

Provides status information about my input (capture) process.

Parameters

[out]	outGoodFrames	Receives the number of successfully captured frames.
[out]	outDroppedFrames	Receives the number of dropped frames.
[out]	outBufferLevel	Receives the buffer level (number of captured frames ready to be transferred to the host).

Definition at line 504 of file ntv2capture.cpp.

◆ Init()

AJAStatus NTV2Capture::Init ( void )

virtual

Initializes me and prepares me to Run.

Definition at line 73 of file ntv2capture.cpp.

◆ ProducerThreadStatic()

void NTV2Capture::ProducerThreadStatic	(	AJAThread *	pThread,
		void *	pContext
	)

staticprotected

This is the capture thread's static callback function that gets called when the capture thread runs. This function gets "Attached" to the AJAThread instance.

Parameters

[in]	pThread	Points to the AJAThread instance.
[in]	pContext	Context information to pass to the thread. (For this application, this will point to the NTV2Capture instance.)

Definition at line 372 of file ntv2capture.cpp.

◆ Quit()

void NTV2Capture::Quit ( void )

virtual

Gracefully stops me from running.

Definition at line 52 of file ntv2capture.cpp.

◆ RouteInputSignal()

bool NTV2Capture::RouteInputSignal ( void )

protectedvirtual

Sets up device routing for capture.

Definition at line 269 of file ntv2capture.cpp.

◆ Run()

AJAStatus NTV2Capture::Run ( void )

virtual

Runs me.

Note: Call this method only after calling Init and it returned AJA_STATUS_SUCCESS.

Definition at line 284 of file ntv2capture.cpp.

◆ SetupAudio()

AJAStatus NTV2Capture::SetupAudio ( void )

protectedvirtual

Sets up everything I need for capturing audio.

Definition at line 211 of file ntv2capture.cpp.

◆ SetupHostBuffers()

void NTV2Capture::SetupHostBuffers ( void )

protectedvirtual

Sets up my circular buffers.

Definition at line 226 of file ntv2capture.cpp.

◆ SetupVideo()

AJAStatus NTV2Capture::SetupVideo ( void )

protectedvirtual

Sets up everything I need for capturing video.

Definition at line 160 of file ntv2capture.cpp.

◆ StartConsumerThread()

void NTV2Capture::StartConsumerThread ( void )

protectedvirtual

Starts my frame consumer thread.

Definition at line 297 of file ntv2capture.cpp.

◆ StartProducerThread()

void NTV2Capture::StartProducerThread ( void )

protectedvirtual

Starts my capture thread.

Definition at line 361 of file ntv2capture.cpp.

The documentation for this class was generated from the following files:

/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/demos/ntv2capture/ntv2capture.h
/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/demos/ntv2capture/ntv2capture.cpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ NTV2Capture()

◆ ~NTV2Capture()

Member Function Documentation

◆ CaptureFrames()

◆ ConsumeFrames()

◆ ConsumerThreadStatic()

◆ GetACStatus()

◆ Init()

◆ ProducerThreadStatic()

◆ Quit()

◆ RouteInputSignal()

◆ Run()

◆ SetupAudio()

◆ SetupHostBuffers()

◆ SetupVideo()

◆ StartConsumerThread()

◆ StartProducerThread()