<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>gmerlin: bg_encoder_pp_plugin_s Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>bg_encoder_pp_plugin_s Struct Reference<br>
<small>
[<a class="el" href="group__plugin__e__pp.html">Encoding postprocessor</a>]</small>
</h1><!-- doxytag: class="bg_encoder_pp_plugin_s" -->Encoding postprocessor.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="plugin_8h_source.html">plugin.h</a>></code>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structbg__plugin__common__s.html">bg_plugin_common_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structbg__encoder__pp__plugin__s.html#b5eeaf82f1122aaa45b9c6c7a5f36f90">common</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Infos and functions common to all plugin types. <a href="#b5eeaf82f1122aaa45b9c6c7a5f36f90"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structbg__encoder__pp__plugin__s.html#5f41c8dc70d6f396c0fe7229f4e150d8">max_audio_streams</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum number of audio streams. -1 means infinite. <a href="#5f41c8dc70d6f396c0fe7229f4e150d8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structbg__encoder__pp__plugin__s.html#0b978d2ce49fe08e153b12cadf3528c5">max_video_streams</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum number of video streams. -1 means infinite. <a href="#0b978d2ce49fe08e153b12cadf3528c5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structbg__encoder__pp__plugin__s.html#5027cd800fa34b17121f92da980c11bf">supported_extensions</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Supported file extensions (space separated). <a href="#5027cd800fa34b17121f92da980c11bf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structbg__encoder__pp__plugin__s.html#d779568bf70300040f501791457bd35a">set_callbacks</a> )(void *priv, <a class="el" href="structbg__e__pp__callbacks__t.html">bg_e_pp_callbacks_t</a> *callbacks)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set callbacks. <a href="#d779568bf70300040f501791457bd35a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structbg__encoder__pp__plugin__s.html#6c2e790e7f4844ade013de7412f98584">init</a> )(void *priv)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize. <a href="#6c2e790e7f4844ade013de7412f98584"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structbg__encoder__pp__plugin__s.html#f73a431a201010f97a95623d8622f7b9">add_track</a> )(void *priv, const char *filename, <a class="el" href="structbg__metadata__t.html">bg_metadata_t</a> *metadata, int pp_only)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a transcoded track. <a href="#f73a431a201010f97a95623d8622f7b9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structbg__encoder__pp__plugin__s.html#5a3f4dacd8f958f511cf727503cad88b">run</a> )(void *priv, const char *directory, int cleanup)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start postprocessing. <a href="#5a3f4dacd8f958f511cf727503cad88b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structbg__encoder__pp__plugin__s.html#8c745ea886387b565ec6316dc3ccd26c">stop</a> )(void *priv)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop postprocessing. <a href="#8c745ea886387b565ec6316dc3ccd26c"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Encoding postprocessor. <hr><h2>Field Documentation</h2>
<a class="anchor" name="b5eeaf82f1122aaa45b9c6c7a5f36f90"></a><!-- doxytag: member="bg_encoder_pp_plugin_s::common" ref="b5eeaf82f1122aaa45b9c6c7a5f36f90" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structbg__plugin__common__s.html">bg_plugin_common_t</a> <a class="el" href="structbg__encoder__pp__plugin__s.html#b5eeaf82f1122aaa45b9c6c7a5f36f90">bg_encoder_pp_plugin_s::common</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Infos and functions common to all plugin types.
<p>
</div>
</div><p>
<a class="anchor" name="5f41c8dc70d6f396c0fe7229f4e150d8"></a><!-- doxytag: member="bg_encoder_pp_plugin_s::max_audio_streams" ref="5f41c8dc70d6f396c0fe7229f4e150d8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structbg__encoder__pp__plugin__s.html#5f41c8dc70d6f396c0fe7229f4e150d8">bg_encoder_pp_plugin_s::max_audio_streams</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Maximum number of audio streams. -1 means infinite.
<p>
</div>
</div><p>
<a class="anchor" name="0b978d2ce49fe08e153b12cadf3528c5"></a><!-- doxytag: member="bg_encoder_pp_plugin_s::max_video_streams" ref="0b978d2ce49fe08e153b12cadf3528c5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structbg__encoder__pp__plugin__s.html#0b978d2ce49fe08e153b12cadf3528c5">bg_encoder_pp_plugin_s::max_video_streams</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Maximum number of video streams. -1 means infinite.
<p>
</div>
</div><p>
<a class="anchor" name="5027cd800fa34b17121f92da980c11bf"></a><!-- doxytag: member="bg_encoder_pp_plugin_s::supported_extensions" ref="5027cd800fa34b17121f92da980c11bf" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="structbg__encoder__pp__plugin__s.html#5027cd800fa34b17121f92da980c11bf">bg_encoder_pp_plugin_s::supported_extensions</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Supported file extensions (space separated).
<p>
</div>
</div><p>
<a class="anchor" name="d779568bf70300040f501791457bd35a"></a><!-- doxytag: member="bg_encoder_pp_plugin_s::set_callbacks" ref="d779568bf70300040f501791457bd35a" args=")(void *priv, bg_e_pp_callbacks_t *callbacks)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* <a class="el" href="structbg__encoder__pp__plugin__s.html#d779568bf70300040f501791457bd35a">bg_encoder_pp_plugin_s::set_callbacks</a>)(void *priv, <a class="el" href="structbg__e__pp__callbacks__t.html">bg_e_pp_callbacks_t</a> *callbacks) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set callbacks.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>priv</em> </td><td>The handle returned by the create() method </td></tr>
<tr><td valign="top"></td><td valign="top"><em>callbacks</em> </td><td>Callback structure initialized by the caller before </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="6c2e790e7f4844ade013de7412f98584"></a><!-- doxytag: member="bg_encoder_pp_plugin_s::init" ref="6c2e790e7f4844ade013de7412f98584" args=")(void *priv)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* <a class="el" href="structbg__encoder__pp__plugin__s.html#6c2e790e7f4844ade013de7412f98584">bg_encoder_pp_plugin_s::init</a>)(void *priv) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initialize.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>priv</em> </td><td>The handle returned by the create() method</td></tr>
</table>
</dl>
This functions clears all tracks and makes the plugin ready to add new tracks.
</div>
</div><p>
<a class="anchor" name="f73a431a201010f97a95623d8622f7b9"></a><!-- doxytag: member="bg_encoder_pp_plugin_s::add_track" ref="f73a431a201010f97a95623d8622f7b9" args=")(void *priv, const char *filename, bg_metadata_t *metadata, int pp_only)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* <a class="el" href="structbg__encoder__pp__plugin__s.html#f73a431a201010f97a95623d8622f7b9">bg_encoder_pp_plugin_s::add_track</a>)(void *priv, const char *filename, <a class="el" href="structbg__metadata__t.html">bg_metadata_t</a> *metadata, int pp_only) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a transcoded track.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>priv</em> </td><td>The handle returned by the create() method </td></tr>
<tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>Name of the media file </td></tr>
<tr><td valign="top"></td><td valign="top"><em>metadata</em> </td><td>Metadata for the track </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pp_only</em> </td><td>Set this to 1 if this file was not encoded and is only postprocessed</td></tr>
</table>
</dl>
Send a track to the postprocessor. This plugin will store all necessary data until the <a class="el" href="structbg__encoder__pp__plugin__s.html#5a3f4dacd8f958f511cf727503cad88b">run()</a> method is called. Some postprocessors might do some sanity tests on the file e.g. the audio CD burner will reject anything except WAV-files.<p>
Usually, it is assumed, that files were encoded for the only purpose of postprocessing them. This means, they will be deleted if the cleanup flag is passed to the <a class="el" href="structbg__encoder__pp__plugin__s.html#5a3f4dacd8f958f511cf727503cad88b">run()</a> function. If you set the pp_only argument to 1, you tell, that this file should be kept after postprocessing.
</div>
</div><p>
<a class="anchor" name="5a3f4dacd8f958f511cf727503cad88b"></a><!-- doxytag: member="bg_encoder_pp_plugin_s::run" ref="5a3f4dacd8f958f511cf727503cad88b" args=")(void *priv, const char *directory, int cleanup)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* <a class="el" href="structbg__encoder__pp__plugin__s.html#5a3f4dacd8f958f511cf727503cad88b">bg_encoder_pp_plugin_s::run</a>)(void *priv, const char *directory, int cleanup) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Start postprocessing.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>priv</em> </td><td>The handle returned by the create() method </td></tr>
<tr><td valign="top"></td><td valign="top"><em>directory</em> </td><td>The directory, where output files can be written </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cleanup</em> </td><td>Set this to 1 to erase all source files and temporary files after finishing Run can be a long operation, it should be called from a separate thread launched by the application and the callbacks should be used for progress reporting </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="8c745ea886387b565ec6316dc3ccd26c"></a><!-- doxytag: member="bg_encoder_pp_plugin_s::stop" ref="8c745ea886387b565ec6316dc3ccd26c" args=")(void *priv)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* <a class="el" href="structbg__encoder__pp__plugin__s.html#8c745ea886387b565ec6316dc3ccd26c">bg_encoder_pp_plugin_s::stop</a>)(void *priv) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Stop postprocessing.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>priv</em> </td><td>The handle returned by the create() method</td></tr>
</table>
</dl>
Call this function to cancel a previously called <a class="el" href="structbg__encoder__pp__plugin__s.html#5a3f4dacd8f958f511cf727503cad88b">run()</a> function. The plugin must implement the stop mechanism in a thread save manner, i.e. the stop method must savely be callable from another thread than the one, which called <a class="el" href="structbg__encoder__pp__plugin__s.html#5a3f4dacd8f958f511cf727503cad88b">run()</a>.
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>/home/mandrake/rpm/BUILD/gmerlin-0.4.1/include/gmerlin/<a class="el" href="plugin_8h_source.html">plugin.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sat Aug 22 01:28:05 2009 for gmerlin by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
874255f3b26b44feb57fbe38a7384518
>
files
>
255
