Public Member Functions | Protected Attributes

ffmpegFile Class Reference

#include <ffmpegFile.h>

List of all members.

Public Member Functions

 ffmpegFile (const char *portName, int queueSize, int blockingCallbacks, const char *NDArrayPort, int NDArrayAddr, int priority, int stackSize)
virtual asynStatus openFile (const char *fileName, NDFileOpenMode_t openMode, NDArray *pArray)
virtual asynStatus readFile (NDArray **pArray)
virtual asynStatus writeFile (NDArray *pArray)
virtual asynStatus closeFile ()

Protected Attributes

int ffmpegFileBitrate
int ffmpegFileFPS
int ffmpegFileHeight
int ffmpegFileWidth

Detailed Description

Writes NDArrays to a ffmpeg file. This can be one of many video formats

Definition at line 17 of file ffmpegFile.h.


Constructor & Destructor Documentation

ffmpegFile::ffmpegFile ( const char *  portName,
int  queueSize,
int  blockingCallbacks,
const char *  NDArrayPort,
int  NDArrayAddr,
int  priority,
int  stackSize 
)

Constructor for ffmpegFile; all parameters are simply passed to NDPluginFile::NDPluginFile. ffmpegFileConfigure() should be used to create an instance in the iocsh. See ffmpegStream.template for more details of usage.

Parameters:
[in] portName The name of the asyn port driver to be created.
[in] queueSize The number of NDArrays that the input queue for this plugin can hold when NDPluginDriverBlockingCallbacks=0. Larger queues can decrease the number of dropped arrays, at the expense of more NDArray buffers being allocated from the underlying driver's NDArrayPool.
[in] blockingCallbacks Initial setting for the NDPluginDriverBlockingCallbacks flag. 0=callbacks are queued and executed by the callback thread; 1 callbacks execute in the thread of the driver doing the callbacks.
[in] NDArrayPort Name of asyn port driver for initial source of NDArray callbacks.
[in] NDArrayAddr asyn port driver address for initial source of NDArray callbacks.
[in] priority The thread priority for the asyn port driver thread if ASYN_CANBLOCK is set in asynFlags.
[in] stackSize The stack size for the asyn port driver thread if ASYN_CANBLOCK is set in asynFlags.

Definition at line 355 of file ffmpegFile.cpp.


Member Function Documentation

asynStatus ffmpegFile::closeFile (  )  [virtual]

Closes the ffmpeg file.

Definition at line 294 of file ffmpegFile.cpp.

asynStatus ffmpegFile::openFile ( const char *  fileName,
NDFileOpenMode_t  openMode,
NDArray *  pArray 
) [virtual]

Opens an FFMPEG file.

Parameters:
[in] fileName The name of the file to open.
[in] openMode Mask defining how the file should be opened; bits are NDFileModeRead, NDFileModeWrite, NDFileModeAppend, NDFileModeMultiple
[in] pArray A pointer to an NDArray; this is used to determine the array and attribute properties.

Definition at line 20 of file ffmpegFile.cpp.

asynStatus ffmpegFile::readFile ( NDArray **  pArray  )  [virtual]

Reads single NDArray from a ffmpeg file; NOT CURRENTLY IMPLEMENTED.

Parameters:
[in] pArray Pointer to the NDArray to be read

Definition at line 285 of file ffmpegFile.cpp.

asynStatus ffmpegFile::writeFile ( NDArray *  pArray  )  [virtual]

Writes single NDArray to the ffmpeg file.

Parameters:
[in] pArray Pointer to the NDArray to be written

Definition at line 218 of file ffmpegFile.cpp.


Member Data Documentation

Definition at line 29 of file ffmpegFile.h.

int ffmpegFile::ffmpegFileFPS [protected]

Definition at line 31 of file ffmpegFile.h.

Definition at line 32 of file ffmpegFile.h.

int ffmpegFile::ffmpegFileWidth [protected]

Definition at line 33 of file ffmpegFile.h.


The documentation for this class was generated from the following files:
 All Classes Files Functions Variables Defines