iekc64_video.h

一个小的测试程序

*/
IEKC64_STATUS VIN_close( Handle videoInHandle );

/*--------------------------------------------------------------------------*/
/*! Get the next frame from the capture buffer
 
	\param videoInHandle 
				A handle to a VIN object returned by VIN_open().

	\param pPtrFrame 
				A pointer passed by reference to receive the pointer
				to the next frame

	\param nWaitTimeout 
				A timeout to specify how long the call must wait
				for a new captured frame. Value must be specified in
				milliseconds.
				If nWaitTimeout is IEKC64_VIDEO_NO_WAIT, then the call returns
				immediately with IEKC64_ERR_VIDEOIN_NO_FRAME_AVAILABLE
				if no frame is available.
				If nWaitTimeout is IEKC64_VIDEO_WAIT_INFINITE, then the call
				doesn't returns before a frame is available.

	\return	IEKC64_STATUS. If the call succeeds, the value will be IEKC64_OK.
				Otherwise it holds an error code. The status code can be tested by
				the IEKC64_SUCCESS(return code) macro that is true is the value
				represents a successful call.

	\b Example: 
	\verbatim
	Uint8 *pFrame;

	status = VIN_getFrame( vinHandle, &pFrame, IEKC64_VIDEO_WAIT_INFINITE );
	if ( !IEKC64_SUCCESS(status) )
	{
		printf( "VIN_getFrame() returned error %08X\n", status );
		exit( 1 );
	}
	\endverbatim

  You can find usage of this function in <a href="../../example/loopback_video">example/loopback_video</a>
  /<a href="../../example/loopback_video/loopback_video.c">loopback_video.c</a>.

*/
IEKC64_STATUS VIN_getFrame( Handle videoInHandle, void** pPtrFrame, Int32 nWaitTimeout );

/*--------------------------------------------------------------------------*/
/*! Opens and initializes the video generation module 

	\param pVideoOutConfig
				This must point to a IEKC64_VIDEOOUT parameters
				structure that the user must fill before the call.

	\param pVideoOutHandle
				This must point to a Handle that will be filled
				by the call. This handle must be used in every next calls to
				the VOUT module.

	\return	IEKC64_STATUS. If the call succeeds, the value will be IEKC64_OK.
				Otherwise it holds an error code. The status code can be tested by
				the IEKC64_SUCCESS(return code) macro that is true is the value
				represents a successful call.

	\b Example: 
	\verbatim
	IEKC64_STATUS		status;
	IEKC64_VIDEOOUT	voutParams = IEKC64_VIDEOOUT_DEFAULT;
	Handle				voutHandle;

	// ... initialize all fields
	voutParams.Standard = PAL;
	....

	status = VOUT_open( &voutParams, &voutHandle );
	if ( !IEKC64_SUCCESS(status) )
	{
		printf( "VOUT_open() returned error %08X\n", status );
		exit( 1 );
	}
	\endverbatim

  You can find usage of this function in <a href="../../example/loopback_video">example/loopback_video</a>
  /<a href="../../example/loopback_video/loopback_video.c">loopback_video.c</a>.

*/
IEKC64_STATUS VOUT_open( IEKC64_VIDEOOUT* pVideoOutConfig, Handle *pVideoOutHandle);

/*--------------------------------------------------------------------------*/
/*! Starts the generation process
 
	\param videoOutHandle
				A handle to a VOUT object returned by VOUT_open().

	\return	IEKC64_STATUS. If the call succeeds, the value will be IEKC64_OK.
				Otherwise it holds an error code. The status code can be tested by
				the IEKC64_SUCCESS(return code) macro that is true is the value
				represents a successful call.

	\b Example: 
	\verbatim
	status = VOUT_start( voutHandle );
	if ( !IEKC64_SUCCESS(status) )
	{
		printf( "VOUT_start() returned error %08X\n", status );
		exit( 1 );
	}
	\endverbatim

  You can find usage of this function in <a href="../../example/loopback_video">example/loopback_video</a>
  /<a href="../../example/loopback_video/loopback_video.c">loopback_video.c</a>.

*/
IEKC64_STATUS VOUT_start( Handle videoOutHandle);

/*--------------------------------------------------------------------------*/
/*! Pause the generation process
 
	\param videoOutHandle
				A handle to a VOUT object returned by VOUT_open().

	\return	IEKC64_STATUS. If the call succeeds, the value will be IEKC64_OK.
				Otherwise it holds an error code. The status code can be tested by
				the IEKC64_SUCCESS(return code) macro that is true is the value
				represents a successful call.

	\b Example: 
	\verbatim
	status = VOUT_stop( voutHandle );
	if ( !IEKC64_SUCCESS(status) )
	{
		printf( "VOUT_stop() returned error %08X\n", status );
		exit( 1 );
	}
	\endverbatim

  You can find usage of this function in <a href="../../example/loopback_video">example/loopback_video</a>
  /<a href="../../example/loopback_video/loopback_video.c">loopback_video.c</a>.

*/
IEKC64_STATUS VOUT_stop(Handle VOutHandle);

/*--------------------------------------------------------------------------*/
/*! Get the next frame from the capture buffer
 
	\param videoInHandle
				A handle to a VOUT object returned by VOUT_open().

	\param pFrame
				A pointer to the next frame to be displayed

	\param nWaitTimeout A timeout to specify how long the call must wait
				for the frame to be displayed. Value must be specified in
				milliseconds.
				If nWaitTimeout is IEKC64_VIDEO_NO_WAIT, then the call returns
				immediately without waiting.
				If nWaitTimeout is IEKC64_VIDEO_WAIT_INFINITE, then the call
				doesn't returns before a frame is available.

	\return A IEKC64_STATUS. If the call succeeds, the value will be IEKC64_OK.
				Otherwise it holds an error code. The status code can be tested by
				the IEKC64_SUCCESS(return code) macro that is true is the value
				represents a successful call.

	\b Example: 
	\verbatim
	Uint8 *pFrame = alloc( enough size );

	fillTheFrame( pFrame );

	status = VOUT_putFrame( voutHandle, pFrame, IEKC64_VIDEO_NO_WAIT );
	if ( !IEKC64_SUCCESS(status) )
	{
		printf( "VOUT_putFrame() returned error %08X\n", status );
		exit( 1 );
	}
	\endverbatim

  You can find usage of this function in <a href="../../example/loopback_video">example/loopback_video</a>
  /<a href="../../example/loopback_video/loopback_video.c">loopback_video.c</a>.

*/
IEKC64_STATUS VOUT_putFrame( Handle videoOutHandle, void* pFrame, Int32 nWaitTimeout );

/*--------------------------------------------------------------------------*/
/*! Wait for the last put frame to become the current displayed frame
     
	\param videoInHandle
				A handle to a VOUT object returned by VOUT_open().

	\param nWaitTimeout
				A timeout to specify how long the call must wait
				for the frame to be displayed. Value must be specified in
				milliseconds.
				If nWaitTimeout is IEKC64_VIDEO_NO_WAIT, then the call returns
				immediately without waiting.
				If nWaitTimeout is IEKC64_VIDEO_WAIT_INFINITE, then the call
				doesn't returns before a frame is available.

	\return	IEKC64_STATUS. If the call succeeds, the value will be IEKC64_OK.
				Otherwise it holds an error code. The status code can be tested by
				the IEKC64_SUCCESS(return code) macro that is true is the value
				represents a successful call.

	\b Example: 
	\verbatim
	status = VOUT_waitDisplayed( voutHandle, IEKC64_VIDEO_NO_WAIT );
	if ( !IEKC64_SUCCESS(status) )
	{
		printf( "VOUT_waitDisplayed() returned error %08X\n", status );
		exit( 1 );
	}
	\endverbatim

  You can find usage of this function in <a href="../../example/loopback_video">example/loopback_video</a>
  /<a href="../../example/loopback_video/loopback_video.c">loopback_video.c</a>.

*/
IEKC64_STATUS VOUT_waitDisplayed( Handle videoOutHandle, Int32 nWaitTimeout );


/*--------------------------------------------------------------------------*/
/*! Stop the VOUT module (No more video frame displayed.)
 
	\param videoInHandle 
				A handle to a VOUT object returned by VOUT_open().

	\return	A IEKC64_STATUS. If the call succeeds, the value will be IEKC64_OK.
				Otherwise it holds an error code. The status code can be tested by
				the IEKC64_SUCCESS(return code) macro that is true is the value
				represents a successful call.

	\b Example: 
	\verbatim
	status = VOUT_close( voutHandle );
	if ( !IEKC64_SUCCESS(status) )
	{
		printf( "VOUT_stop() returned error %08X\n", status );
		exit( 1 );
	}
	\endverbatim
  
  You can find usage of this function in <a href="../../example/loopback_video">example/loopback_video</a>
  /<a href="../../example/loopback_video/loopback_video.c">loopback_video.c</a>.

*/
IEKC64_STATUS VOUT_stop( Handle videoOutHandle );


/*--------------------------------------------------------------------------*/
/*! Closes the module and frees any allocated resource
 
	\param videoOutHandle 
				A handle to a VOUT object returned by VOUT_open().

	\return	IEKC64_STATUS. If the call succeeds, the value will be IEKC64_OK.
				Otherwise it holds an error code. The status code can be tested by
				the IEKC64_SUCCESS(return code) macro that is true is the value
				represents a successful call.

	\b Example: 
	\verbatim
	status = VOUT_close( voutHandle );
	if ( !IEKC64_SUCCESS(status) )
	{
		printf( "VOUT_close() returned error %08X\n", status );
		exit( 1 );
	}
	\endverbatim

  You can find usage of this function in <a href="../../example/loopback_video">example/loopback_video</a>
  /<a href="../../example/loopback_video/loopback_video.c">loopback_video.c</a>.

*/
IEKC64_STATUS VOUT_close( Handle videoOutHandle );

/*@}*//* end of group VIDEO */

#ifdef __cplusplus
}
#endif

#endif /*  __VIDEO_H__ */