video.c File Reference

#include <pthread.h>
#include <string.h>
#include <AR/config.h>
#include <AR/ar.h>
#include <AR/video.h>

Include dependency graph for VideoMacOSX/video.c:

Classes
struct	_AR2VideoParamT
struct	_VdigGrab
Defines
#define	AR_PTHREAD_CANCELLED ((void *) 1);
#define	AR_VIDEO_IDLE_INTERVAL_MILLISECONDS_MAX 100L
#define	AR_VIDEO_IDLE_INTERVAL_MILLISECONDS_MIN 20L
#define	AR_VIDEO_STATUS_BIT_BUFFER 0x02
#define	AR_VIDEO_STATUS_BIT_READY 0x01
#define	ARVIDEO_APIENTRY
Typedefs
typedef struct _AR2VideoParamT *	AR2VideoParamTRef
typedef struct _VdigGrab	VdigGrab
typedef struct _VdigGrab *	VdigGrabRef
Functions
int	ar2VideoCapNext (AR2VideoParamT *vid)
	call for the next grabbed video frame of a video source (multiple video inputs)
int	ar2VideoCapStart (AR2VideoParamT *vid)
	start the capture of a video source (multiple video inputs)
int	ar2VideoCapStop (AR2VideoParamT *vid)
	stop the capture of a video source (multiple video inputs)
int	ar2VideoClose (AR2VideoParamT *vid)
	close a video source (multiple video inputs)
int	ar2VideoDispOption (void)
	display the video option (multiple video inputs)
ARUint8 *	ar2VideoGetImage (AR2VideoParamT *vid)
	get a video image from a video source (multiple video inputs)
int	ar2VideoInqSize (AR2VideoParamT vid, int x, int *y)
	get the video image size of a video source (multiple video inputs)
static int	ar2VideoInternalLock (pthread_mutex_t *mutex)
static void *	ar2VideoInternalThread (void *arg)
static void ARVIDEO_APIENTRY	ar2VideoInternalThreadCleanup (void *arg)
static int	ar2VideoInternalUnlock (pthread_mutex_t *mutex)
AR2VideoParamT *	ar2VideoOpen (char *config_in)
	open a video source (multiple video inputs)
int	arVideoCapNext (void)
	call for the next grabbed video frame.
int	arVideoCapStart (void)
	start the capture of video.
int	arVideoCapStop (void)
	stop the capture of video.
int	arVideoClose (void)
	close the video source. After your application has finished using a video stream, this function must be called to close the link to the input source, and free resources associated with the capture operation.
int	arVideoDispOption (void)
	display the video option.
ARUint8 *	arVideoGetImage (void)
	get the video image.
int	arVideoInqSize (int x, int y)
	get the video image size, in pixels.
int	arVideoOpen (char *config)
	open a video source.
static SeqGrabComponent	MakeSequenceGrabber (WindowRef pWindow, const int grabber)
static ComponentResult	MakeSequenceGrabChannel (SeqGrabComponent seqGrab, SGChannel *psgchanVideo)
VdigGrabRef	vdgAllocAndInit (const int grabber)
static OSErr	vdgDecompressionSequenceBegin (VdigGrab pVdg, CGrafPtr dstPort, Rect pDstRect, MatrixRecord *pDstScaleMatrix)
static OSErr	vdgDecompressionSequenceEnd (VdigGrab *pVdg)
static OSErr	vdgDecompressionSequenceWhen (VdigGrab *pVdg, Ptr theData, long dataSize)
static VideoDigitizerError	vdgGetDataRate (VdigGrab pVdg, long pMilliSecPerFrame, Fixed pFramesPerSecond, long pBytesPerSecond)
static VideoDigitizerError	vdgGetDeviceNameAndFlags (VdigGrab pVdg, char szName, long pBuffSize, UInt32 pVdFlags)
static VideoDigitizerError	vdgGetImageDescription (VdigGrab *pVdg, ImageDescriptionHandle vdImageDesc)
static ComponentResult	vdgGetSettings (VdigGrab *pVdg)
static VideoDigitizerError	vdgIdle (VdigGrab pVdg, int pIsUpdated)
static bool	vdgIsGrabbing (VdigGrab *pVdg)
static VideoDigitizerError	vdgPoll (VdigGrab pVdg, UInt8 pQueuedFrameCount, Ptr pTheData, long pDataSize, UInt8 pSimilarity, TimeRecord pTime)
static VideoDigitizerError	vdgPreflightGrabbing (VdigGrab *pVdg)
static ComponentResult	vdgReleaseAndDealloc (VdigGrab *pVdg)
static VideoDigitizerError	vdgReleaseBuffer (VdigGrab *pVdg, Ptr theData)
static ComponentResult	vdgRequestSettings (VdigGrab *pVdg, const int showDialog, const int standardDialog, const int inputIndex)
static OSErr	vdgSetDestination (VdigGrab *pVdg, CGrafPtr dstPort)
static VideoDigitizerError	vdgStartGrabbing (VdigGrab pVdg, MatrixRecord pDstScaleMatrix)
static VideoDigitizerError	vdgStopGrabbing (VdigGrab *pVdg)
Variables
static AR2VideoParamT *	gVid = NULL
static unsigned int	gVidCount = 0

Define Documentation

#define AR_PTHREAD_CANCELLED ((void *) 1);

Definition at line 129 of file VideoMacOSX/video.c.

#define AR_VIDEO_IDLE_INTERVAL_MILLISECONDS_MAX 100L

Definition at line 120 of file VideoMacOSX/video.c.

#define AR_VIDEO_IDLE_INTERVAL_MILLISECONDS_MIN 20L

Definition at line 119 of file VideoMacOSX/video.c.

#define AR_VIDEO_STATUS_BIT_BUFFER 0x02

Definition at line 123 of file VideoMacOSX/video.c.

#define AR_VIDEO_STATUS_BIT_READY 0x01

Definition at line 122 of file VideoMacOSX/video.c.

#define ARVIDEO_APIENTRY

Definition at line 143 of file VideoMacOSX/video.c.

Typedef Documentation

typedef struct _AR2VideoParamT* AR2VideoParamTRef

Definition at line 211 of file VideoMacOSX/video.c.

typedef struct _VdigGrab VdigGrab

Definition at line 179 of file VideoMacOSX/video.c.

typedef struct _VdigGrab* VdigGrabRef

Definition at line 180 of file VideoMacOSX/video.c.

Function Documentation

int ar2VideoCapNext ( AR2VideoParamT * vid )

call for the next grabbed video frame of a video source (multiple video inputs)

Companion function to arVideoCapNext for multiple video sources.

Parameters:

vid

a video handle structure for multi-camera grabbing

Definition at line 1860 of file VideoMacOSX/video.c.

int ar2VideoCapStart ( AR2VideoParamT * vid )

start the capture of a video source (multiple video inputs)

Companion function to arVideoCapStart for multiple video sources.

Parameters:

vid

a video handle structure for multi-camera grabbing

Definition at line 1802 of file VideoMacOSX/video.c.

int ar2VideoCapStop ( AR2VideoParamT * vid )

stop the capture of a video source (multiple video inputs)

Companion function to arVideoCapStop for multiple video sources.

Parameters:

vid

a video handle structure for multi-camera grabbing

Definition at line 1865 of file VideoMacOSX/video.c.

int ar2VideoClose ( AR2VideoParamT * vid )

close a video source (multiple video inputs)

Companion function to arVideoClose for multiple video sources.

Parameters:

vid

a video handle structure for multi-camera grabbing.

Definition at line 1709 of file VideoMacOSX/video.c.

int ar2VideoDispOption ( void )

display the video option (multiple video inputs)

Companion function to arVideoDispOption, for multiple video sources.

Definition at line 1228 of file VideoMacOSX/video.c.

ARUint8* ar2VideoGetImage ( AR2VideoParamT * vid )

get a video image from a video source (multiple video inputs)

Companion function to arVideoGetImage for multiple video sources.

Parameters:

vid

a video handle structure for multi-camera grabbing

Definition at line 1949 of file VideoMacOSX/video.c.

int ar2VideoInqSize	(	AR2VideoParamT *	vid,
		int *	x,
		int *	y
	)

get the video image size of a video source (multiple video inputs)

Companion function to arVideoInqSize for multiple video sources.

Parameters:

vid

a video handle structure for multi-camera grabbing

Definition at line 1929 of file VideoMacOSX/video.c.

static int ar2VideoInternalLock ( pthread_mutex_t * mutex ) [static]

Definition at line 972 of file VideoMacOSX/video.c.

static void* ar2VideoInternalThread ( void * arg ) [static]

Definition at line 1029 of file VideoMacOSX/video.c.

static void ARVIDEO_APIENTRY ar2VideoInternalThreadCleanup ( void * arg ) [static]

Definition at line 1011 of file VideoMacOSX/video.c.

static int ar2VideoInternalUnlock ( pthread_mutex_t * mutex ) [static]

Definition at line 999 of file VideoMacOSX/video.c.

AR2VideoParamT* ar2VideoOpen ( char * config )

open a video source (multiple video inputs)

Companion function to arVideoOpen for multiple video sources. This function can be called multiple times to open multiple video streams. The maximum number of streams is dependent on the operating system and the performance characteristics of the host CPU and video capture infrastructure.

Parameters:

config

string of the selected video configuration.

Returns:: If the video path was successfully opened, this function returns a pointer to an AR2VideoParamT structure, an opaque structure which holds information and configuration for the video stream. This paramater should then be passed to other ar2Video* functions to specify which video stream is being operated upon. If the video path was not successfully opened, NULL will be returned. s

Definition at line 1269 of file VideoMacOSX/video.c.

int arVideoCapNext ( void )

call for the next grabbed video frame.

This function should be called at least once per frame. It has several purposes, depending on the operating system. It allows the video driver to perform housekeeping tasks and also signals to the video grabber that your code has finished using the most recent video frame returned by arVideoGetImage(), and that the video driver may re-use the memory occupied by the frame. The effect of this call is operating-system dependent. The best place to call this function is immediately after you have finished displaying the current video frame, i.e. after calling arglDispImage() or argDispImage().

Remarks:: On some operating systems, this function is a no-op.

Returns:: 0 if successful, -1 if the video driver encountered an error.

Definition at line 964 of file VideoMacOSX/video.c.

int arVideoCapStart ( void )

start the capture of video.

This function starts the video capture routine.

Remarks:: On some operating systems, capture operations may run in a separate execution thread. This call starts that thread.; this function coupled with arVideoCapStop, can be call many times in your program (this may reduce the CPU load when video processing is stopped or for long and critical operations).

Returns:: 0 if successful, -1 if the capture couldn't be started.

Definition at line 950 of file VideoMacOSX/video.c.

int arVideoCapStop ( void )

stop the capture of video.

This function stops the video capture routine.

Remarks:: On some operating systems, capture operations may run in a separate execution thread. This call stops that thread.; this function coupled with arVideoCapStart, can be call many times in your program (this may reduce the CPU load when video processing is stopped or for long and critical operations).

Returns:: 0 if successful, -1 if the capture couldn't be stopped.

Definition at line 957 of file VideoMacOSX/video.c.

int arVideoClose ( void )

close the video source. After your application has finished using a video stream, this function must be called to close the link to the input source, and free resources associated with the capture operation.

Returns:: 0 if shut down successfully, otherwise -1.

Definition at line 925 of file VideoMacOSX/video.c.

int arVideoDispOption ( void )

display the video option.

The video configuration options vary by operating system and platform. This function outputs to the standard output the options available on the current OS and platform.

Returns:: 0

Definition at line 908 of file VideoMacOSX/video.c.

ARUint8* arVideoGetImage ( void )

get the video image.

This function returns a buffer with a captured video image. The returned data consists of a tightly-packed array of pixels, beginning with the first component of the leftmost pixel of the topmost row, and continuing with the remaining components of that pixel, followed by the remaining pixels in the topmost row, followed by the leftmost pixel of the second row, and so on. The arrangement of components of the pixels in the buffer is determined by the configuration string passed in to the driver at the time the video stream was opened. If no pixel format was specified in the configuration string, then an operating- system dependent default, defined in <AR/config.h> is used. The memory occupied by the pixel data is owned by the video driver and should not be freed by your program. The pixels in the buffer remain valid until the next call to arVideoCapNext, or the next call to arVideoGetImage which returns a non-NULL pointer, or any call to arVideoCapStop or arVideoClose.

Returns:: A pointer to the pixel data of the captured video frame, or NULL if no new pixel data was available at the time of calling.

Definition at line 943 of file VideoMacOSX/video.c.

int arVideoInqSize	(	int *	x,
		int *	y
	)

get the video image size, in pixels.

This function returns the size of the captured video frame, in pixels.

Parameters:

	x	a pointer to the length of the captured image
	y	a pointer to the width of the captured image

Returns:: 0 if the dimensions are found successfully, otherwise -1

Definition at line 936 of file VideoMacOSX/video.c.

int arVideoOpen ( char * config )

open a video source.

This function opens a video input path with the driver (and device) present on your platform. According to your operating system and the hardware the initialization will be different : a generic string structure is used for this issue. This function prepares the video stream for capture, but capture will not actually begin until arVideoCapStart is called.

Parameters:

config

string of the selected video configuration. See the video configuration documentation for more information on this parameter.

Returns:: 0 if successful, -1 if a video path couldn't be opened

Definition at line 913 of file VideoMacOSX/video.c.

static SeqGrabComponent MakeSequenceGrabber	(	WindowRef	pWindow,
		const int	grabber
	)			`[static]`

Definition at line 232 of file VideoMacOSX/video.c.

static ComponentResult MakeSequenceGrabChannel	(	SeqGrabComponent	seqGrab,
		SGChannel *	psgchanVideo
	)			`[static]`

Definition at line 295 of file VideoMacOSX/video.c.

VdigGrabRef vdgAllocAndInit ( const int grabber )

Definition at line 359 of file VideoMacOSX/video.c.

static OSErr vdgDecompressionSequenceBegin	(	VdigGrab *	pVdg,
		CGrafPtr	dstPort,
		Rect *	pDstRect,
		MatrixRecord *	pDstScaleMatrix
	)			`[static]`

Definition at line 615 of file VideoMacOSX/video.c.

static OSErr vdgDecompressionSequenceEnd ( VdigGrab * pVdg ) [static]

Definition at line 686 of file VideoMacOSX/video.c.

static OSErr vdgDecompressionSequenceWhen	(	VdigGrab *	pVdg,
		Ptr	theData,
		long	dataSize
	)			`[static]`

Definition at line 663 of file VideoMacOSX/video.c.

static VideoDigitizerError vdgGetDataRate	(	VdigGrab *	pVdg,
		long *	pMilliSecPerFrame,
		Fixed *	pFramesPerSecond,
		long *	pBytesPerSecond
	)			`[static]`

Definition at line 581 of file VideoMacOSX/video.c.

static VideoDigitizerError vdgGetDeviceNameAndFlags	(	VdigGrab *	pVdg,
		char *	szName,
		long *	pBuffSize,
		UInt32 *	pVdFlags
	)			`[static]`

Definition at line 411 of file VideoMacOSX/video.c.

static VideoDigitizerError vdgGetImageDescription	(	VdigGrab *	pVdg,
		ImageDescriptionHandle	vdImageDesc
	)			`[static]`

Definition at line 600 of file VideoMacOSX/video.c.

static ComponentResult vdgGetSettings ( VdigGrab * pVdg ) [static]

Definition at line 327 of file VideoMacOSX/video.c.

static VideoDigitizerError vdgIdle	(	VdigGrab *	pVdg,
		int *	pIsUpdated
	)			`[static]`

Definition at line 820 of file VideoMacOSX/video.c.

static bool vdgIsGrabbing ( VdigGrab * pVdg ) [static]

Definition at line 760 of file VideoMacOSX/video.c.

static VideoDigitizerError vdgPoll	(	VdigGrab *	pVdg,
		UInt8 *	pQueuedFrameCount,
		Ptr *	pTheData,
		long *	pDataSize,
		UInt8 *	pSimilarity,
		TimeRecord *	pTime
	)			`[static]`

Definition at line 765 of file VideoMacOSX/video.c.

static VideoDigitizerError vdgPreflightGrabbing ( VdigGrab * pVdg ) [static]

Definition at line 456 of file VideoMacOSX/video.c.

static ComponentResult vdgReleaseAndDealloc ( VdigGrab * pVdg ) [static]

Definition at line 870 of file VideoMacOSX/video.c.

static VideoDigitizerError vdgReleaseBuffer	(	VdigGrab *	pVdg,
		Ptr	theData
	)			`[static]`

Definition at line 806 of file VideoMacOSX/video.c.

static ComponentResult vdgRequestSettings	(	VdigGrab *	pVdg,
		const int	showDialog,
		const int	standardDialog,
		const int	inputIndex
	)			`[static]`

Definition at line 383 of file VideoMacOSX/video.c.

static OSErr vdgSetDestination	(	VdigGrab *	pVdg,
		CGrafPtr	dstPort
	)			`[static]`

Definition at line 449 of file VideoMacOSX/video.c.

static VideoDigitizerError vdgStartGrabbing	(	VdigGrab *	pVdg,
		MatrixRecord *	pDstScaleMatrix
	)			`[static]`

Definition at line 709 of file VideoMacOSX/video.c.

static VideoDigitizerError vdgStopGrabbing ( VdigGrab * pVdg ) [static]

Definition at line 738 of file VideoMacOSX/video.c.

Variable Documentation

AR2VideoParamT* gVid = NULL [static]

Definition at line 217 of file VideoMacOSX/video.c.

unsigned int gVidCount = 0 [static]

Definition at line 218 of file VideoMacOSX/video.c.

video.c File Reference

Classes

Defines

Typedefs

Functions

Variables

Define Documentation

Typedef Documentation

Function Documentation

Variable Documentation