bg_rv_plugin_t Struct Reference
[Video recorder]

Video recorder plugin. More...

#include <plugin.h>


Data Fields

bg_plugin_common_t common
 Infos and functions common to all plugin types.
int(* open )(void *priv, gavl_video_format_t *format)
 Open plugin.
gavl_video_frame_t *(* alloc_frame )(void *priv)
 Allocate a video frame.
int(* read_frame )(void *priv, gavl_video_frame_t *frame)
 Read a video frame.
void(* free_frame )(void *priv, gavl_video_frame_t *frame)
 Free a frame created with the alloc_frame() method.
void(* close )(void *priv)
 Close the plugin.


Detailed Description

Video recorder plugin.

Field Documentation

bg_plugin_common_t bg_rv_plugin_t::common

Infos and functions common to all plugin types.

int(* bg_rv_plugin_t::open)(void *priv, gavl_video_format_t *format)

Open plugin.

Parameters:
priv The handle returned by the create() method
format Video format
The format will be changed to the nearest format, which is supported by the plugin. To convert the source format to the output format, use a gavl_video_converter_t

gavl_video_frame_t*(* bg_rv_plugin_t::alloc_frame)(void *priv)

Allocate a video frame.

Parameters:
priv The handle returned by the create() method
Returns:
a newly allocated video frame
This optional method allocates a video frame in a plugin specific manner (e.g. in a shared memory segment). If this funtion is defined, all frames which are passed to the plugin, must be allocated by this function. Before the plugin is closed, all created frames must be freed with the free_frame() method.

int(* bg_rv_plugin_t::read_frame)(void *priv, gavl_video_frame_t *frame)

Read a video frame.

Parameters:
priv The handle returned by the create() method
frame Where the frame will be copied
Returns:
1 if a frame was read, 0 on error

void(* bg_rv_plugin_t::free_frame)(void *priv, gavl_video_frame_t *frame)

Free a frame created with the alloc_frame() method.

Parameters:
priv The handle returned by the create() method
frame The frame to be freed

void(* bg_rv_plugin_t::close)(void *priv)

Close the plugin.

Parameters:
priv The handle returned by the create() method
Close everything so the plugin can be opened with a differtent format after.


The documentation for this struct was generated from the following file:
Generated on Wed Jan 9 19:32:52 2008 for gmerlin by  doxygen 1.5.3