<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>ZVBI Library: Teletext IDL packet demultiplexer</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><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> </ul> </div> </div> <div class="contents"> <h1>Teletext IDL packet demultiplexer<br> <small> [<a class="el" href="group__LowDec.html">Low Level Decoding</a>]</small> </h1>Functions to decode data transmissions in Teletext Independent Data Line packets (EN 300 708 section 6). <a href="#_details">More...</a> <p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef struct _vbi_idl_demux </td><td class="memItemRight" valign="bottom"><a class="el" href="group__IDLDemux.html#gafdaf9e811243a766ca641ef20ed913e">vbi_idl_demux</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">IDL demultiplexer context. <a href="#gafdaf9e811243a766ca641ef20ed913e"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef vbi_bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__IDLDemux.html#gb9e661e9d49aef0d8b20d465e5915032">vbi_idl_demux_cb</a> (<a class="el" href="group__IDLDemux.html#gafdaf9e811243a766ca641ef20ed913e">vbi_idl_demux</a> *dx, const uint8_t *buffer, unsigned int n_bytes, unsigned int flags, void *user_data)</td></tr> <tr><td colspan="2"><br><h2>Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__IDLDemux.html#g80beb5dd0ffe1c6836c4daac6f464e3c">vbi_idl_demux_reset</a> (<a class="el" href="group__IDLDemux.html#gafdaf9e811243a766ca641ef20ed913e">vbi_idl_demux</a> *dx) _vbi_nonnull((1))</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">vbi_bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__IDLDemux.html#g490f1961add5aa7d0f27b3fd913f2f59">vbi_idl_demux_feed</a> (<a class="el" href="group__IDLDemux.html#gafdaf9e811243a766ca641ef20ed913e">vbi_idl_demux</a> *dx, const uint8_t buffer[42])</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">vbi_bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__IDLDemux.html#gcc00454d5f855751aa360470cefc0e7e">vbi_idl_demux_feed_frame</a> (<a class="el" href="group__IDLDemux.html#gafdaf9e811243a766ca641ef20ed913e">vbi_idl_demux</a> *dx, const <a class="el" href="structvbi__sliced.html">vbi_sliced</a> *sliced, unsigned int n_lines)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__IDLDemux.html#gd92399bea4dd2303046d3df978243db8">vbi_idl_demux_delete</a> (<a class="el" href="group__IDLDemux.html#gafdaf9e811243a766ca641ef20ed913e">vbi_idl_demux</a> *dx)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__IDLDemux.html#gafdaf9e811243a766ca641ef20ed913e">vbi_idl_demux</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__IDLDemux.html#g350eeab053043ecdb7219a902e7e1475">vbi_idl_a_demux_new</a> (unsigned int channel, unsigned int address, <a class="el" href="group__IDLDemux.html#gb9e661e9d49aef0d8b20d465e5915032">vbi_idl_demux_cb</a> *callback, void *user_data)</td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Functions to decode data transmissions in Teletext Independent Data Line packets (EN 300 708 section 6). <hr><h2>Typedef Documentation</h2> <a class="anchor" name="gafdaf9e811243a766ca641ef20ed913e"></a><!-- doxytag: member="idl_demux.h::vbi_idl_demux" ref="gafdaf9e811243a766ca641ef20ed913e" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct _vbi_idl_demux <a class="el" href="group__IDLDemux.html#gafdaf9e811243a766ca641ef20ed913e">vbi_idl_demux</a> </td> </tr> </table> </div> <div class="memdoc"> <p> IDL demultiplexer context. <p> The contents of this structure are private.<p> Call vbi_idl_demux_new() to allocate an IDL demultiplexer context. </div> </div><p> <a class="anchor" name="gb9e661e9d49aef0d8b20d465e5915032"></a><!-- doxytag: member="idl_demux.h::vbi_idl_demux_cb" ref="gb9e661e9d49aef0d8b20d465e5915032" args="(vbi_idl_demux *dx, const uint8_t *buffer, unsigned int n_bytes, unsigned int flags, void *user_data)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef vbi_bool <a class="el" href="group__IDLDemux.html#gb9e661e9d49aef0d8b20d465e5915032">vbi_idl_demux_cb</a>(<a class="el" href="group__IDLDemux.html#gafdaf9e811243a766ca641ef20ed913e">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"> <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>dx</em> </td><td>IDL demultiplexer returned by <a class="el" href="group__IDLDemux.html#g350eeab053043ecdb7219a902e7e1475">vbi_idl_a_demux_new()</a> and given to <a class="el" href="group__IDLDemux.html#g490f1961add5aa7d0f27b3fd913f2f59">vbi_idl_demux_feed()</a>. </td></tr> <tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>Pointer to received user data. </td></tr> <tr><td valign="top"></td><td valign="top"><em>n_bytes</em> </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 valign="top"></td><td valign="top"><em>flags</em> </td><td><code>VBI_IDL_DATA_LOST</code>, <code>VBI_IDL_DEPENDENT</code>. </td></tr> <tr><td valign="top"></td><td valign="top"><em>user_data</em> </td><td>User pointer passed to vbi_idl_demux_new().</td></tr> </table> </dl> The <a class="el" href="group__IDLDemux.html#g490f1961add5aa7d0f27b3fd913f2f59">vbi_idl_demux_feed()</a> function calls a function of this type after successfully decoding an IDL packet.<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>FALSE to abort <a class="el" href="group__IDLDemux.html#g490f1961add5aa7d0f27b3fd913f2f59">vbi_idl_demux_feed()</a> and return FALSE. </dd></dl> </div> </div><p> <hr><h2>Function Documentation</h2> <a class="anchor" name="g80beb5dd0ffe1c6836c4daac6f464e3c"></a><!-- doxytag: member="idl_demux.h::vbi_idl_demux_reset" ref="g80beb5dd0ffe1c6836c4daac6f464e3c" args="(vbi_idl_demux *dx) _vbi_nonnull((1))" --> <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#gafdaf9e811243a766ca641ef20ed913e">vbi_idl_demux</a> * </td> <td class="paramname"> <em>dx</em> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <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>dx</em> </td><td>IDL demultiplexer allocated with <a class="el" href="group__IDLDemux.html#g350eeab053043ecdb7219a902e7e1475">vbi_idl_a_demux_new()</a>.</td></tr> </table> </dl> Resets the IDL demux context, useful for example after a channel change.<p> <dl class="since" compact><dt><b>Since:</b></dt><dd>0.2.14 </dd></dl> </div> </div><p> <a class="anchor" name="g490f1961add5aa7d0f27b3fd913f2f59"></a><!-- doxytag: member="idl_demux.h::vbi_idl_demux_feed" ref="g490f1961add5aa7d0f27b3fd913f2f59" args="(vbi_idl_demux *dx, const uint8_t buffer[42])" --> <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#gafdaf9e811243a766ca641ef20ed913e">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><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <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>dx</em> </td><td>IDL demultiplexer allocated with <a class="el" href="group__IDLDemux.html#g350eeab053043ecdb7219a902e7e1475">vbi_idl_a_demux_new()</a>. </td></tr> <tr><td valign="top"></td><td valign="top"><em>buffer</em> </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> </dl> 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#g350eeab053043ecdb7219a902e7e1475">vbi_idl_a_demux_new()</a> when new user data is available.<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>FALSE if the packet contained incorrectable errors.</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd>0.2.14 </dd></dl> </div> </div><p> <a class="anchor" name="gcc00454d5f855751aa360470cefc0e7e"></a><!-- doxytag: member="idl_demux.h::vbi_idl_demux_feed_frame" ref="gcc00454d5f855751aa360470cefc0e7e" args="(vbi_idl_demux *dx, const vbi_sliced *sliced, unsigned int n_lines)" --> <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#gafdaf9e811243a766ca641ef20ed913e">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><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <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>dx</em> </td><td>IDL demultiplexer allocated with <a class="el" href="group__IDLDemux.html#g350eeab053043ecdb7219a902e7e1475">vbi_idl_a_demux_new()</a>. </td></tr> <tr><td valign="top"></td><td valign="top"><em>sliced</em> </td><td>Sliced VBI data. </td></tr> <tr><td valign="top"></td><td valign="top"><em>n_lines</em> </td><td>Number of lines in the <em>sliced</em> array.</td></tr> </table> </dl> This function works like <a class="el" href="group__IDLDemux.html#g490f1961add5aa7d0f27b3fd913f2f59">vbi_idl_demux_feed()</a> but operates on sliced VBI data and filters out <code>VBI_SLICED_TELETEXT_B_625</code>.<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>FALSE if any Teletext lines contained incorrectable errors.</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd>0.2.26 </dd></dl> </div> </div><p> <a class="anchor" name="gd92399bea4dd2303046d3df978243db8"></a><!-- doxytag: member="idl_demux.h::vbi_idl_demux_delete" ref="gd92399bea4dd2303046d3df978243db8" args="(vbi_idl_demux *dx)" --> <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#gafdaf9e811243a766ca641ef20ed913e">vbi_idl_demux</a> * </td> <td class="paramname"> <em>dx</em> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <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>dx</em> </td><td>IDL demultiplexer allocated with <a class="el" href="group__IDLDemux.html#g350eeab053043ecdb7219a902e7e1475">vbi_idl_a_demux_new()</a>, can be <code>NULL</code>.</td></tr> </table> </dl> Frees all resources associated with <em>dx</em>.<p> <dl class="since" compact><dt><b>Since:</b></dt><dd>0.2.14 </dd></dl> </div> </div><p> <a class="anchor" name="g350eeab053043ecdb7219a902e7e1475"></a><!-- doxytag: member="idl_demux.h::vbi_idl_a_demux_new" ref="g350eeab053043ecdb7219a902e7e1475" args="(unsigned int channel, unsigned int address, vbi_idl_demux_cb *callback, void *user_data)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__IDLDemux.html#gafdaf9e811243a766ca641ef20ed913e">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#gb9e661e9d49aef0d8b20d465e5915032">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><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <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>channel</em> </td><td>Filter out packets of this channel. </td></tr> <tr><td valign="top"></td><td valign="top"><em>address</em> </td><td>Filter out packets with this service data address. </td></tr> <tr><td valign="top"></td><td valign="top"><em>callback</em> </td><td>Function to be called by <a class="el" href="group__IDLDemux.html#g490f1961add5aa7d0f27b3fd913f2f59">vbi_idl_demux_feed()</a> when new data is available. </td></tr> <tr><td valign="top"></td><td valign="top"><em>user_data</em> </td><td>User pointer passed through to <em>callback</em> function.</td></tr> </table> </dl> Allocates a new Independent Data Line format A (EN 300 708 section 6.5) demultiplexer.<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to newly allocated IDL demultiplexer which must be freed with <a class="el" href="group__IDLDemux.html#gd92399bea4dd2303046d3df978243db8">vbi_idl_demux_delete()</a> when done. <code>NULL</code> on failure (out of memory).</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd>0.2.14 </dd></dl> </div> </div><p> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Wed May 27 04:47:58 2009 for ZVBI Library 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>