<!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.11"/>
<title>ZVBI Library: Teletext IDL packet demultiplexer</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">ZVBI Library
 <span id="projectnumber">0.2.35</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</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">Teletext IDL packet demultiplexer<div class="ingroups"><a class="el" href="group__LowDec.html">Low Level Decoding</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Functions to decode data transmissions in Teletext Independent Data Line packets (EN 300 708 section 6).
<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:gaafdaf9e811243a766ca641ef20ed913e"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__vbi__idl__demux.html">_vbi_idl_demux</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__IDLDemux.html#gaafdaf9e811243a766ca641ef20ed913e">vbi_idl_demux</a></td></tr>
<tr class="memdesc:gaafdaf9e811243a766ca641ef20ed913e"><td class="mdescLeft"> </td><td class="mdescRight">IDL demultiplexer context. <a href="#gaafdaf9e811243a766ca641ef20ed913e">More...</a><br /></td></tr>
<tr class="separator:gaafdaf9e811243a766ca641ef20ed913e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab9e661e9d49aef0d8b20d465e5915032"><td class="memItemLeft" align="right" valign="top">typedef vbi_bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__IDLDemux.html#gab9e661e9d49aef0d8b20d465e5915032">vbi_idl_demux_cb</a>(<a class="el" href="group__IDLDemux.html#gaafdaf9e811243a766ca641ef20ed913e">vbi_idl_demux</a> *dx, const uint8_t *buffer, unsigned int n_bytes, unsigned int flags, void *user_data)</td></tr>
<tr class="separator:gab9e661e9d49aef0d8b20d465e5915032"><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:ga80beb5dd0ffe1c6836c4daac6f464e3c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__IDLDemux.html#ga80beb5dd0ffe1c6836c4daac6f464e3c">vbi_idl_demux_reset</a> (<a class="el" href="group__IDLDemux.html#gaafdaf9e811243a766ca641ef20ed913e">vbi_idl_demux</a> *dx) _vbi_nonnull((1))</td></tr>
<tr class="separator:ga80beb5dd0ffe1c6836c4daac6f464e3c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga490f1961add5aa7d0f27b3fd913f2f59"><td class="memItemLeft" align="right" valign="top">vbi_bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__IDLDemux.html#ga490f1961add5aa7d0f27b3fd913f2f59">vbi_idl_demux_feed</a> (<a class="el" href="group__IDLDemux.html#gaafdaf9e811243a766ca641ef20ed913e">vbi_idl_demux</a> *dx, const uint8_t buffer[42])</td></tr>
<tr class="separator:ga490f1961add5aa7d0f27b3fd913f2f59"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacc00454d5f855751aa360470cefc0e7e"><td class="memItemLeft" align="right" valign="top">vbi_bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__IDLDemux.html#gacc00454d5f855751aa360470cefc0e7e">vbi_idl_demux_feed_frame</a> (<a class="el" href="group__IDLDemux.html#gaafdaf9e811243a766ca641ef20ed913e">vbi_idl_demux</a> *dx, const <a class="el" href="structvbi__sliced.html">vbi_sliced</a> *sliced, unsigned int n_lines)</td></tr>
<tr class="separator:gacc00454d5f855751aa360470cefc0e7e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad92399bea4dd2303046d3df978243db8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__IDLDemux.html#gad92399bea4dd2303046d3df978243db8">vbi_idl_demux_delete</a> (<a class="el" href="group__IDLDemux.html#gaafdaf9e811243a766ca641ef20ed913e">vbi_idl_demux</a> *dx)</td></tr>
<tr class="separator:gad92399bea4dd2303046d3df978243db8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga350eeab053043ecdb7219a902e7e1475"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__IDLDemux.html#gaafdaf9e811243a766ca641ef20ed913e">vbi_idl_demux</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__IDLDemux.html#ga350eeab053043ecdb7219a902e7e1475">vbi_idl_a_demux_new</a> (unsigned int channel, unsigned int address, <a class="el" href="group__IDLDemux.html#gab9e661e9d49aef0d8b20d465e5915032">vbi_idl_demux_cb</a> *callback, void *user_data)</td></tr>
<tr class="separator:ga350eeab053043ecdb7219a902e7e1475"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Functions to decode data transmissions in Teletext Independent Data Line packets (EN 300 708 section 6). </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gaafdaf9e811243a766ca641ef20ed913e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="struct__vbi__idl__demux.html">_vbi_idl_demux</a> <a class="el" href="group__IDLDemux.html#gaafdaf9e811243a766ca641ef20ed913e">vbi_idl_demux</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>IDL demultiplexer context. </p>
<p>The contents of this structure are private.</p>
<p>Call vbi_idl_demux_new() to allocate an IDL demultiplexer context. </p>
</div>
</div>
<a class="anchor" id="gab9e661e9d49aef0d8b20d465e5915032"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef vbi_bool vbi_idl_demux_cb(<a class="el" href="group__IDLDemux.html#gaafdaf9e811243a766ca641ef20ed913e">vbi_idl_demux</a> *dx, const uint8_t *buffer, unsigned int n_bytes, unsigned int flags, void *user_data)</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dx</td><td>IDL demultiplexer returned by <a class="el" href="group__IDLDemux.html#ga350eeab053043ecdb7219a902e7e1475">vbi_idl_a_demux_new()</a> and given to <a class="el" href="group__IDLDemux.html#ga490f1961add5aa7d0f27b3fd913f2f59">vbi_idl_demux_feed()</a>. </td></tr>
<tr><td class="paramname">buffer</td><td>Pointer to received user data. </td></tr>
<tr><td class="paramname">n_bytes</td><td>Number of bytes in the buffer. Can be <code>0</code> if the decoded packet did not contain user data. </td></tr>
<tr><td class="paramname">flags</td><td><code>VBI_IDL_DATA_LOST</code>, <code>VBI_IDL_DEPENDENT</code>. </td></tr>
<tr><td class="paramname">user_data</td><td>User pointer passed to vbi_idl_demux_new().</td></tr>
</table>
</dd>
</dl>
<p>The <a class="el" href="group__IDLDemux.html#ga490f1961add5aa7d0f27b3fd913f2f59">vbi_idl_demux_feed()</a> function calls a function of this type after successfully decoding an IDL packet.</p>
<dl class="section return"><dt>Returns</dt><dd>FALSE to abort <a class="el" href="group__IDLDemux.html#ga490f1961add5aa7d0f27b3fd913f2f59">vbi_idl_demux_feed()</a> and return FALSE. </dd></dl>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga80beb5dd0ffe1c6836c4daac6f464e3c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vbi_idl_demux_reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__IDLDemux.html#gaafdaf9e811243a766ca641ef20ed913e">vbi_idl_demux</a> * </td>
<td class="paramname"><em>dx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dx</td><td>IDL demultiplexer allocated with <a class="el" href="group__IDLDemux.html#ga350eeab053043ecdb7219a902e7e1475">vbi_idl_a_demux_new()</a>.</td></tr>
</table>
</dd>
</dl>
<p>Resets the IDL demux context, useful for example after a channel change.</p>
<dl class="section since"><dt>Since</dt><dd>0.2.14 </dd></dl>
<p>References <a class="el" href="struct__vbi__idl__demux.html#a0b38fe32bc5abffcf3c9d64e1cf5e6a8">_vbi_idl_demux::ci</a>, and <a class="el" href="struct__vbi__idl__demux.html#a5f0a40f4fff518016769df84637d6841">_vbi_idl_demux::ri</a>.</p>
<p>Referenced by <a class="el" href="group__IDLDemux.html#gacc00454d5f855751aa360470cefc0e7e">vbi_idl_demux_feed_frame()</a>.</p>
</div>
</div>
<a class="anchor" id="ga490f1961add5aa7d0f27b3fd913f2f59"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vbi_bool vbi_idl_demux_feed </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__IDLDemux.html#gaafdaf9e811243a766ca641ef20ed913e">vbi_idl_demux</a> * </td>
<td class="paramname"><em>dx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t </td>
<td class="paramname"><em>buffer</em>[42] </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dx</td><td>IDL demultiplexer allocated with <a class="el" href="group__IDLDemux.html#ga350eeab053043ecdb7219a902e7e1475">vbi_idl_a_demux_new()</a>. </td></tr>
<tr><td class="paramname">buffer</td><td>Teletext packet (last 42 bytes, i. e. without clock run-in and framing code), as in struct <a class="el" href="structvbi__sliced.html" title="This structure holds one scan line of sliced vbi data. ">vbi_sliced</a>.</td></tr>
</table>
</dd>
</dl>
<p>This function takes a stream of Teletext packets, filters out packets of the desired data channel and address and calls the output function given to <a class="el" href="group__IDLDemux.html#ga350eeab053043ecdb7219a902e7e1475">vbi_idl_a_demux_new()</a> when new user data is available.</p>
<dl class="section return"><dt>Returns</dt><dd>FALSE if the packet contained uncorrectable errors.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.14 </dd></dl>
<p>References <a class="el" href="struct__vbi__idl__demux.html#a3e9a7295f8f488ec2f235deee52752ee">_vbi_idl_demux::channel</a>, and <a class="el" href="group__Error.html#ga91fcc67515be04557c53c3e076159507">vbi_unham8()</a>.</p>
<p>Referenced by <a class="el" href="group__IDLDemux.html#gacc00454d5f855751aa360470cefc0e7e">vbi_idl_demux_feed_frame()</a>.</p>
</div>
</div>
<a class="anchor" id="gacc00454d5f855751aa360470cefc0e7e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vbi_bool vbi_idl_demux_feed_frame </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__IDLDemux.html#gaafdaf9e811243a766ca641ef20ed913e">vbi_idl_demux</a> * </td>
<td class="paramname"><em>dx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structvbi__sliced.html">vbi_sliced</a> * </td>
<td class="paramname"><em>sliced</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>n_lines</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dx</td><td>IDL demultiplexer allocated with <a class="el" href="group__IDLDemux.html#ga350eeab053043ecdb7219a902e7e1475">vbi_idl_a_demux_new()</a>. </td></tr>
<tr><td class="paramname">sliced</td><td>Sliced VBI data. </td></tr>
<tr><td class="paramname">n_lines</td><td>Number of lines in the <em>sliced</em> array.</td></tr>
</table>
</dd>
</dl>
<p>This function works like <a class="el" href="group__IDLDemux.html#ga490f1961add5aa7d0f27b3fd913f2f59">vbi_idl_demux_feed()</a> but operates on sliced VBI data and filters out <code>VBI_SLICED_TELETEXT_B_625</code>.</p>
<dl class="section return"><dt>Returns</dt><dd>FALSE if any Teletext lines contained uncorrectable errors.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.26 </dd></dl>
<p>References <a class="el" href="struct__vbi__idl__demux.html#a3e9a7295f8f488ec2f235deee52752ee">_vbi_idl_demux::channel</a>, <a class="el" href="structvbi__sliced.html#aaec2527f9c9aada8be8519401ccafb48">vbi_sliced::data</a>, <a class="el" href="structvbi__sliced.html#add8a7578942158880b5e3472adcd5eed">vbi_sliced::id</a>, <a class="el" href="group__IDLDemux.html#ga490f1961add5aa7d0f27b3fd913f2f59">vbi_idl_demux_feed()</a>, and <a class="el" href="group__IDLDemux.html#ga80beb5dd0ffe1c6836c4daac6f464e3c">vbi_idl_demux_reset()</a>.</p>
</div>
</div>
<a class="anchor" id="gad92399bea4dd2303046d3df978243db8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vbi_idl_demux_delete </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__IDLDemux.html#gaafdaf9e811243a766ca641ef20ed913e">vbi_idl_demux</a> * </td>
<td class="paramname"><em>dx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dx</td><td>IDL demultiplexer allocated with <a class="el" href="group__IDLDemux.html#ga350eeab053043ecdb7219a902e7e1475">vbi_idl_a_demux_new()</a>, can be <code>NULL</code>.</td></tr>
</table>
</dd>
</dl>
<p>Frees all resources associated with <em>dx</em>.</p>
<dl class="section since"><dt>Since</dt><dd>0.2.14 </dd></dl>
</div>
</div>
<a class="anchor" id="ga350eeab053043ecdb7219a902e7e1475"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__IDLDemux.html#gaafdaf9e811243a766ca641ef20ed913e">vbi_idl_demux</a>* vbi_idl_a_demux_new </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>channel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__IDLDemux.html#gab9e661e9d49aef0d8b20d465e5915032">vbi_idl_demux_cb</a> * </td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>user_data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">channel</td><td>Filter out packets of this channel. </td></tr>
<tr><td class="paramname">address</td><td>Filter out packets with this service data address. </td></tr>
<tr><td class="paramname">callback</td><td>Function to be called by <a class="el" href="group__IDLDemux.html#ga490f1961add5aa7d0f27b3fd913f2f59">vbi_idl_demux_feed()</a> when new data is available. </td></tr>
<tr><td class="paramname">user_data</td><td>User pointer passed through to <em>callback</em> function.</td></tr>
</table>
</dd>
</dl>
<p>Allocates a new Independent Data Line format A (EN 300 708 section 6.5) demultiplexer.</p>
<dl class="section return"><dt>Returns</dt><dd>Pointer to newly allocated IDL demultiplexer which must be freed with <a class="el" href="group__IDLDemux.html#gad92399bea4dd2303046d3df978243db8">vbi_idl_demux_delete()</a> when done. <code>NULL</code> on failure (out of memory).</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.14 </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.11
</small></address>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-release
>
by-pkgid
>
2a781e5f78e233aedaa1e51ed196dcc3
>
files
>
47
