<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>gavl: Video converter</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">gavl
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Video converter<div class="ingroups"><a class="el" href="group__video.html">Video</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Video format converter.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga8608b4a917f962a192fbb4e7d1a180f5"><td class="memItemLeft" align="right" valign="top">typedef struct gavl_video_converter_s </td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__converter.html#ga8608b4a917f962a192fbb4e7d1a180f5">gavl_video_converter_t</a></td></tr>
<tr class="memdesc:ga8608b4a917f962a192fbb4e7d1a180f5"><td class="mdescLeft"> </td><td class="mdescRight">Opaque video converter structure. <a href="#ga8608b4a917f962a192fbb4e7d1a180f5">More...</a><br /></td></tr>
<tr class="separator:ga8608b4a917f962a192fbb4e7d1a180f5"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gac65bbe195bf92930e68d7d889ef4be87"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC <a class="el" href="group__video__converter.html#ga8608b4a917f962a192fbb4e7d1a180f5">gavl_video_converter_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__converter.html#gac65bbe195bf92930e68d7d889ef4be87">gavl_video_converter_create</a> ()</td></tr>
<tr class="memdesc:gac65bbe195bf92930e68d7d889ef4be87"><td class="mdescLeft"> </td><td class="mdescRight">Creates a video converter. <a href="#gac65bbe195bf92930e68d7d889ef4be87">More...</a><br /></td></tr>
<tr class="separator:gac65bbe195bf92930e68d7d889ef4be87"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacd1f728055a582c57f8a45484da9366d"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__converter.html#gacd1f728055a582c57f8a45484da9366d">gavl_video_converter_destroy</a> (<a class="el" href="group__video__converter.html#ga8608b4a917f962a192fbb4e7d1a180f5">gavl_video_converter_t</a> *cnv)</td></tr>
<tr class="memdesc:gacd1f728055a582c57f8a45484da9366d"><td class="mdescLeft"> </td><td class="mdescRight">Destroys a video converter and frees all associated memory. <a href="#gacd1f728055a582c57f8a45484da9366d">More...</a><br /></td></tr>
<tr class="separator:gacd1f728055a582c57f8a45484da9366d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae07e2d1a722b74152545176d24b3cbe7"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC <a class="el" href="group__video__options.html#ga661526ac8e31c3a162f8607c2bcda6ee">gavl_video_options_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__converter.html#gae07e2d1a722b74152545176d24b3cbe7">gavl_video_converter_get_options</a> (<a class="el" href="group__video__converter.html#ga8608b4a917f962a192fbb4e7d1a180f5">gavl_video_converter_t</a> *cnv)</td></tr>
<tr class="memdesc:gae07e2d1a722b74152545176d24b3cbe7"><td class="mdescLeft"> </td><td class="mdescRight">gets options of a video converter <a href="#gae07e2d1a722b74152545176d24b3cbe7">More...</a><br /></td></tr>
<tr class="separator:gae07e2d1a722b74152545176d24b3cbe7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3fc45b6f66687029f4ad6b145d5c3326"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__converter.html#ga3fc45b6f66687029f4ad6b145d5c3326">gavl_video_converter_init</a> (<a class="el" href="group__video__converter.html#ga8608b4a917f962a192fbb4e7d1a180f5">gavl_video_converter_t</a> *cnv, const <a class="el" href="group__video__format.html#ga0ffc9c60fb71a5fb835e453531fd442c">gavl_video_format_t</a> *input_format, const <a class="el" href="group__video__format.html#ga0ffc9c60fb71a5fb835e453531fd442c">gavl_video_format_t</a> *output_format)</td></tr>
<tr class="memdesc:ga3fc45b6f66687029f4ad6b145d5c3326"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a video converter. <a href="#ga3fc45b6f66687029f4ad6b145d5c3326">More...</a><br /></td></tr>
<tr class="separator:ga3fc45b6f66687029f4ad6b145d5c3326"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabf283face818d6425b72cbfc888f1661"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__converter.html#gabf283face818d6425b72cbfc888f1661">gavl_video_converter_reinit</a> (<a class="el" href="group__video__converter.html#ga8608b4a917f962a192fbb4e7d1a180f5">gavl_video_converter_t</a> *cnv)</td></tr>
<tr class="memdesc:gabf283face818d6425b72cbfc888f1661"><td class="mdescLeft"> </td><td class="mdescRight">Reinitialize a video converter. <a href="#gabf283face818d6425b72cbfc888f1661">More...</a><br /></td></tr>
<tr class="separator:gabf283face818d6425b72cbfc888f1661"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab4d87d96d232ff18f667968edec146e6"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__converter.html#gab4d87d96d232ff18f667968edec146e6">gavl_video_convert</a> (<a class="el" href="group__video__converter.html#ga8608b4a917f962a192fbb4e7d1a180f5">gavl_video_converter_t</a> *cnv, const <a class="el" href="structgavl__video__frame__t.html">gavl_video_frame_t</a> *input_frame, <a class="el" href="structgavl__video__frame__t.html">gavl_video_frame_t</a> *output_frame)</td></tr>
<tr class="memdesc:gab4d87d96d232ff18f667968edec146e6"><td class="mdescLeft"> </td><td class="mdescRight">Convert video. <a href="#gab4d87d96d232ff18f667968edec146e6">More...</a><br /></td></tr>
<tr class="separator:gab4d87d96d232ff18f667968edec146e6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Video format converter. </p>
<p>This is a generic converter, which converts video frames from one arbitrary format to another. It can convert pixelformats, scale images and deinterlace.</p>
<p>For quality levels of 3 and below, pixelformats are converted in one single step, without the need for intermediate frames. Quality levels of 4 and 5 will take care of chroma placement. For this, a <a class="el" href="group__video__scaler.html#ga8b4210889926401c0af62a9c423e14ab">gavl_video_scaler_t</a> will be used.</p>
<p>Deinterlacing is enabled if the input format is interlaced and the output format is progressive and the deinterlace mode is something else than <a class="el" href="group__video__options.html#gga498099f87328c97f303f538eb79eded9a3f9fa297598a227e7011325f0063409c">GAVL_DEINTERLACE_NONE</a>. You can also force deinterlacing (<a class="el" href="group__video__conversion__flags.html#ga2337d9ab35e09d07f98a89e8d39c3162">GAVL_FORCE_DEINTERLACE</a>).</p>
<p>Create a video converter with <a class="el" href="group__video__converter.html#gac65bbe195bf92930e68d7d889ef4be87">gavl_video_converter_create</a>. If you want to configure it, get the options pointer with <a class="el" href="group__video__converter.html#gae07e2d1a722b74152545176d24b3cbe7">gavl_video_converter_get_options</a> and change the options (See <a class="el" href="group__video__options.html">Video conversion options</a>). Call <a class="el" href="group__video__converter.html#ga3fc45b6f66687029f4ad6b145d5c3326">gavl_video_converter_init</a> to initialize the converter for the input and output formats. Video frames are then converted with <a class="el" href="group__video__converter.html#gab4d87d96d232ff18f667968edec146e6">gavl_video_convert</a>.</p>
<p>When you are done, you can either reinitialize the converter or destroy it with <a class="el" href="group__video__converter.html#gacd1f728055a582c57f8a45484da9366d">gavl_video_converter_destroy</a>. </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga8608b4a917f962a192fbb4e7d1a180f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8608b4a917f962a192fbb4e7d1a180f5">§ </a></span>gavl_video_converter_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct gavl_video_converter_s <a class="el" href="group__video__converter.html#ga8608b4a917f962a192fbb4e7d1a180f5">gavl_video_converter_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Opaque video converter structure. </p>
<p>You don't want to know what's inside. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gac65bbe195bf92930e68d7d889ef4be87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac65bbe195bf92930e68d7d889ef4be87">§ </a></span>gavl_video_converter_create()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC <a class="el" href="group__video__converter.html#ga8608b4a917f962a192fbb4e7d1a180f5">gavl_video_converter_t</a>* gavl_video_converter_create </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a video converter. </p>
<dl class="section return"><dt>Returns</dt><dd>A newly allocated video converter </dd></dl>
</div>
</div>
<a id="gacd1f728055a582c57f8a45484da9366d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacd1f728055a582c57f8a45484da9366d">§ </a></span>gavl_video_converter_destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC void gavl_video_converter_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__video__converter.html#ga8608b4a917f962a192fbb4e7d1a180f5">gavl_video_converter_t</a> * </td>
<td class="paramname"><em>cnv</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroys a video converter and frees all associated memory. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cnv</td><td>A video converter </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gae07e2d1a722b74152545176d24b3cbe7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae07e2d1a722b74152545176d24b3cbe7">§ </a></span>gavl_video_converter_get_options()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC <a class="el" href="group__video__options.html#ga661526ac8e31c3a162f8607c2bcda6ee">gavl_video_options_t</a>* gavl_video_converter_get_options </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__video__converter.html#ga8608b4a917f962a192fbb4e7d1a180f5">gavl_video_converter_t</a> * </td>
<td class="paramname"><em>cnv</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>gets options of a video converter </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cnv</td><td>A video converter</td></tr>
</table>
</dd>
</dl>
<p>After you called this, you can use the gavl_video_options_set_*() functions to change the options. Options will become valid with the next call to <a class="el" href="group__video__converter.html#ga3fc45b6f66687029f4ad6b145d5c3326">gavl_video_converter_init</a> or <a class="el" href="group__video__converter.html#gabf283face818d6425b72cbfc888f1661">gavl_video_converter_reinit</a>. </p>
</div>
</div>
<a id="ga3fc45b6f66687029f4ad6b145d5c3326"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3fc45b6f66687029f4ad6b145d5c3326">§ </a></span>gavl_video_converter_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC int gavl_video_converter_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__video__converter.html#ga8608b4a917f962a192fbb4e7d1a180f5">gavl_video_converter_t</a> * </td>
<td class="paramname"><em>cnv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__video__format.html#ga0ffc9c60fb71a5fb835e453531fd442c">gavl_video_format_t</a> * </td>
<td class="paramname"><em>input_format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__video__format.html#ga0ffc9c60fb71a5fb835e453531fd442c">gavl_video_format_t</a> * </td>
<td class="paramname"><em>output_format</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize a video converter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cnv</td><td>A video converter </td></tr>
<tr><td class="paramname">input_format</td><td>Input format </td></tr>
<tr><td class="paramname">output_format</td><td>Output format </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of single conversion steps necessary to perform the conversion. It may be 0, in this case you must not use the converter and have to pass the video frames directly. If something goes wrong (should never happen), -1 is returned.</dd></dl>
<p>This function can be called multiple times with one instance </p>
</div>
</div>
<a id="gabf283face818d6425b72cbfc888f1661"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabf283face818d6425b72cbfc888f1661">§ </a></span>gavl_video_converter_reinit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC int gavl_video_converter_reinit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__video__converter.html#ga8608b4a917f962a192fbb4e7d1a180f5">gavl_video_converter_t</a> * </td>
<td class="paramname"><em>cnv</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reinitialize a video converter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cnv</td><td>A video converter </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of single conversion steps necessary to perform the conversion. It may be 0, in this case you must not use the converter and have to pass the video frames directly. If something goes wrong (should never happen), -1 is returned.</dd></dl>
<p>This function can be called if the input and output formats didn't change but the options did. </p>
</div>
</div>
<a id="gab4d87d96d232ff18f667968edec146e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab4d87d96d232ff18f667968edec146e6">§ </a></span>gavl_video_convert()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC void gavl_video_convert </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__video__converter.html#ga8608b4a917f962a192fbb4e7d1a180f5">gavl_video_converter_t</a> * </td>
<td class="paramname"><em>cnv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structgavl__video__frame__t.html">gavl_video_frame_t</a> * </td>
<td class="paramname"><em>input_frame</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structgavl__video__frame__t.html">gavl_video_frame_t</a> * </td>
<td class="paramname"><em>output_frame</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert video. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cnv</td><td>A video converter </td></tr>
<tr><td class="paramname">input_frame</td><td>Input frame </td></tr>
<tr><td class="paramname">output_frame</td><td>Output frame </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>
