<!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.8"/>
<title>ZVBI Library: Teletext PFC 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 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.8 -->
<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><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="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Teletext PFC 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 Page Function Clear packets (EN 300 708 section 4).
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__pfc__block.html">vbi_pfc_block</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">One block of data returned by <a class="el" href="group__PFCDemux.html#ga92c46d220a81ab6a01a81a864406e690">vbi_pfc_demux_cb()</a>. <a href="structvbi__pfc__block.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gadaab0edb3e8a3a858cc2bf6fdaeac498"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__vbi__pfc__demux.html">_vbi_pfc_demux</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PFCDemux.html#gadaab0edb3e8a3a858cc2bf6fdaeac498">vbi_pfc_demux</a></td></tr>
<tr class="memdesc:gadaab0edb3e8a3a858cc2bf6fdaeac498"><td class="mdescLeft"> </td><td class="mdescRight">PFC demultiplexer context. <a href="#gadaab0edb3e8a3a858cc2bf6fdaeac498">More...</a><br /></td></tr>
<tr class="separator:gadaab0edb3e8a3a858cc2bf6fdaeac498"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga92c46d220a81ab6a01a81a864406e690"><td class="memItemLeft" align="right" valign="top">typedef vbi_bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PFCDemux.html#ga92c46d220a81ab6a01a81a864406e690">vbi_pfc_demux_cb</a> (<a class="el" href="group__PFCDemux.html#gadaab0edb3e8a3a858cc2bf6fdaeac498">vbi_pfc_demux</a> *dx, void *user_data, const <a class="el" href="structvbi__pfc__block.html">vbi_pfc_block</a> *block)</td></tr>
<tr class="separator:ga92c46d220a81ab6a01a81a864406e690"><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:gae334afca20ce542494b2cf783b8fae39"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PFCDemux.html#gae334afca20ce542494b2cf783b8fae39">vbi_pfc_demux_reset</a> (<a class="el" href="group__PFCDemux.html#gadaab0edb3e8a3a858cc2bf6fdaeac498">vbi_pfc_demux</a> *dx) _vbi_nonnull((1))</td></tr>
<tr class="separator:gae334afca20ce542494b2cf783b8fae39"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa4b895cf6895630a82608b3225c6412c"><td class="memItemLeft" align="right" valign="top">vbi_bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PFCDemux.html#gaa4b895cf6895630a82608b3225c6412c">vbi_pfc_demux_feed</a> (<a class="el" href="group__PFCDemux.html#gadaab0edb3e8a3a858cc2bf6fdaeac498">vbi_pfc_demux</a> *dx, const uint8_t buffer[42])</td></tr>
<tr class="separator:gaa4b895cf6895630a82608b3225c6412c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1389d3cf33437d596faf835ebde346f6"><td class="memItemLeft" align="right" valign="top">vbi_bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PFCDemux.html#ga1389d3cf33437d596faf835ebde346f6">vbi_pfc_demux_feed_frame</a> (<a class="el" href="group__PFCDemux.html#gadaab0edb3e8a3a858cc2bf6fdaeac498">vbi_pfc_demux</a> *dx, const <a class="el" href="structvbi__sliced.html">vbi_sliced</a> *sliced, unsigned int n_lines)</td></tr>
<tr class="separator:ga1389d3cf33437d596faf835ebde346f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga75e8bc1bb2a51e972932993ad2a9e309"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PFCDemux.html#ga75e8bc1bb2a51e972932993ad2a9e309">vbi_pfc_demux_delete</a> (<a class="el" href="group__PFCDemux.html#gadaab0edb3e8a3a858cc2bf6fdaeac498">vbi_pfc_demux</a> *dx)</td></tr>
<tr class="separator:ga75e8bc1bb2a51e972932993ad2a9e309"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabb8a4610aa41282267b5e09d98394153"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__PFCDemux.html#gadaab0edb3e8a3a858cc2bf6fdaeac498">vbi_pfc_demux</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PFCDemux.html#gabb8a4610aa41282267b5e09d98394153">vbi_pfc_demux_new</a> (<a class="el" href="group__HiDec.html#ga8711c9b42b61d518b7f79e941fe94eb1">vbi_pgno</a> pgno, unsigned int stream, <a class="el" href="group__PFCDemux.html#ga92c46d220a81ab6a01a81a864406e690">vbi_pfc_demux_cb</a> *callback, void *user_data)</td></tr>
<tr class="separator:gabb8a4610aa41282267b5e09d98394153"><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 Page Function Clear packets (EN 300 708 section 4). </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gadaab0edb3e8a3a858cc2bf6fdaeac498"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="struct__vbi__pfc__demux.html">_vbi_pfc_demux</a> <a class="el" href="group__PFCDemux.html#gadaab0edb3e8a3a858cc2bf6fdaeac498">vbi_pfc_demux</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>PFC demultiplexer context. </p>
<p>The contents of this structure are private.</p>
<p>Call <a class="el" href="group__PFCDemux.html#gabb8a4610aa41282267b5e09d98394153">vbi_pfc_demux_new()</a> to allocate a PFC demultiplexer context. </p>
</div>
</div>
<a class="anchor" id="ga92c46d220a81ab6a01a81a864406e690"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef vbi_bool vbi_pfc_demux_cb(<a class="el" href="group__PFCDemux.html#gadaab0edb3e8a3a858cc2bf6fdaeac498">vbi_pfc_demux</a> *dx, void *user_data, const <a class="el" href="structvbi__pfc__block.html">vbi_pfc_block</a> *block)</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dx</td><td>PFC demultiplexer context returned by vbi_pfx_demux_new() and given to <a class="el" href="group__PFCDemux.html#gaa4b895cf6895630a82608b3225c6412c">vbi_pfc_demux_feed()</a>. </td></tr>
<tr><td class="paramname">user_data</td><td>User pointer given to <a class="el" href="group__PFCDemux.html#gabb8a4610aa41282267b5e09d98394153">vbi_pfc_demux_new()</a>. </td></tr>
<tr><td class="paramname">block</td><td>Structure describing the received data block.</td></tr>
</table>
</dd>
</dl>
<p>Function called by <a class="el" href="group__PFCDemux.html#gaa4b895cf6895630a82608b3225c6412c">vbi_pfc_demux_feed()</a> when a new data block is available.</p>
<dl class="section return"><dt>Returns</dt><dd>FALSE on error, will be returned by <a class="el" href="group__PFCDemux.html#gaa4b895cf6895630a82608b3225c6412c">vbi_pfc_demux_feed()</a>.</dd></dl>
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000013">Bug:</a></b></dt><dd><a class="el" href="group__PFCDemux.html#gaa4b895cf6895630a82608b3225c6412c">vbi_pfc_demux_feed()</a> returns the <em>user_data</em> pointer as second parameter the <em>block</em> pointer as third parameter, but prior to version 0.2.26 this function incorrectly defined <em>block</em> as second and <em>user_data</em> as third parameter. </dd></dl>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gae334afca20ce542494b2cf783b8fae39"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vbi_pfc_demux_reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__PFCDemux.html#gadaab0edb3e8a3a858cc2bf6fdaeac498">vbi_pfc_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>PFC demultiplexer context allocated with <a class="el" href="group__PFCDemux.html#gabb8a4610aa41282267b5e09d98394153">vbi_pfc_demux_new()</a>.</td></tr>
</table>
</dd>
</dl>
<p>Resets the PFC demux context, useful for example after a channel change. </p>
<p>References <a class="el" href="structvbi__pfc__block.html#ac9b7475a5b0adea5b5c82b3776736516">vbi_pfc_block::application_id</a>, <a class="el" href="struct__vbi__pfc__demux.html#af4a4ff320693b80014e91f467a804279">_vbi_pfc_demux::bi</a>, <a class="el" href="struct__vbi__pfc__demux.html#a598551d27a956cbf4b382fc96a883aca">_vbi_pfc_demux::ci</a>, <a class="el" href="struct__vbi__pfc__demux.html#a2b37a8686b8c5c42610827b62605db10">_vbi_pfc_demux::left</a>, <a class="el" href="struct__vbi__pfc__demux.html#a369c110c67d20c3ba9365701a66ead2b">_vbi_pfc_demux::n_packets</a>, and <a class="el" href="struct__vbi__pfc__demux.html#a7d91bebbfcda9e8ef179462b1eea14a9">_vbi_pfc_demux::packet</a>.</p>
<p>Referenced by <a class="el" href="group__PFCDemux.html#gaa4b895cf6895630a82608b3225c6412c">vbi_pfc_demux_feed()</a>.</p>
</div>
</div>
<a class="anchor" id="gaa4b895cf6895630a82608b3225c6412c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vbi_bool vbi_pfc_demux_feed </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__PFCDemux.html#gadaab0edb3e8a3a858cc2bf6fdaeac498">vbi_pfc_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>PFC demultiplexer context allocated with <a class="el" href="group__PFCDemux.html#gabb8a4610aa41282267b5e09d98394153">vbi_pfc_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 raw stream of Teletext packets, filters out the page and stream requested with <a class="el" href="group__PFCDemux.html#gabb8a4610aa41282267b5e09d98394153">vbi_pfc_demux_new()</a> and assembles the data transmitted in this page in a buffer. When a data block is complete it calls the output function given to <a class="el" href="group__PFCDemux.html#gabb8a4610aa41282267b5e09d98394153">vbi_pfc_demux_new()</a>.</p>
<dl class="section return"><dt>Returns</dt><dd>FALSE if the packet contained uncorrectable errors. </dd></dl>
<p>References <a class="el" href="struct__vbi__pfc__demux.html#a598551d27a956cbf4b382fc96a883aca">_vbi_pfc_demux::ci</a>, <a class="el" href="struct__vbi__pfc__demux.html#a369c110c67d20c3ba9365701a66ead2b">_vbi_pfc_demux::n_packets</a>, <a class="el" href="struct__vbi__pfc__demux.html#a7d91bebbfcda9e8ef179462b1eea14a9">_vbi_pfc_demux::packet</a>, <a class="el" href="structvbi__pfc__block.html#aa0bae83320be6936ec6edf049914ad74">vbi_pfc_block::pgno</a>, <a class="el" href="structvbi__pfc__block.html#a95bf86f1fcb4a60fa17f10c5d83c088a">vbi_pfc_block::stream</a>, <a class="el" href="group__PFCDemux.html#gae334afca20ce542494b2cf783b8fae39">vbi_pfc_demux_reset()</a>, and <a class="el" href="group__Error.html#gab62090ec932d135dea3dde39e4e4cc55">vbi_unham16p()</a>.</p>
<p>Referenced by <a class="el" href="group__PFCDemux.html#ga1389d3cf33437d596faf835ebde346f6">vbi_pfc_demux_feed_frame()</a>.</p>
</div>
</div>
<a class="anchor" id="ga1389d3cf33437d596faf835ebde346f6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vbi_bool vbi_pfc_demux_feed_frame </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__PFCDemux.html#gadaab0edb3e8a3a858cc2bf6fdaeac498">vbi_pfc_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>PFC demultiplexer context allocated with <a class="el" href="group__PFCDemux.html#gabb8a4610aa41282267b5e09d98394153">vbi_pfc_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__PFCDemux.html#gaa4b895cf6895630a82608b3225c6412c">vbi_pfc_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="structvbi__sliced.html#aaec2527f9c9aada8be8519401ccafb48">vbi_sliced::data</a>, <a class="el" href="structvbi__sliced.html#add8a7578942158880b5e3472adcd5eed">vbi_sliced::id</a>, and <a class="el" href="group__PFCDemux.html#gaa4b895cf6895630a82608b3225c6412c">vbi_pfc_demux_feed()</a>.</p>
</div>
</div>
<a class="anchor" id="ga75e8bc1bb2a51e972932993ad2a9e309"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vbi_pfc_demux_delete </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__PFCDemux.html#gadaab0edb3e8a3a858cc2bf6fdaeac498">vbi_pfc_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>PFC demultiplexer context allocated with <a class="el" href="group__PFCDemux.html#gabb8a4610aa41282267b5e09d98394153">vbi_pfc_demux_new()</a>, can be <code>NULL</code>.</td></tr>
</table>
</dd>
</dl>
<p>Frees all resources associated with <em>dx</em>. </p>
</div>
</div>
<a class="anchor" id="gabb8a4610aa41282267b5e09d98394153"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__PFCDemux.html#gadaab0edb3e8a3a858cc2bf6fdaeac498">vbi_pfc_demux</a>* vbi_pfc_demux_new </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__HiDec.html#ga8711c9b42b61d518b7f79e941fe94eb1">vbi_pgno</a> </td>
<td class="paramname"><em>pgno</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>stream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__PFCDemux.html#ga92c46d220a81ab6a01a81a864406e690">vbi_pfc_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">pgno</td><td>Page to take PFC data from. </td></tr>
<tr><td class="paramname">stream</td><td>PFC stream to be demultiplexed. </td></tr>
<tr><td class="paramname">callback</td><td>Function to be called by <a class="el" href="group__PFCDemux.html#gaa4b895cf6895630a82608b3225c6412c">vbi_pfc_demux_feed()</a> when a new data block is available. </td></tr>
<tr><td class="paramname">user_data</td><td>User pointer passed through to <em>cb</em> function.</td></tr>
</table>
</dd>
</dl>
<p>Allocates a new Page Function Clear (ETS 300 708 section 4) demultiplexer.</p>
<dl class="section return"><dt>Returns</dt><dd>Pointer to newly allocated PFC demux context which must be freed with <a class="el" href="group__PFCDemux.html#ga75e8bc1bb2a51e972932993ad2a9e309">vbi_pfc_demux_delete()</a> when done. <code>NULL</code> on failure (out of memory). </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 16 2014 08:52:24 for ZVBI Library by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
b87535c165133127a8d07aeb2413ddb2
>
files
>
57
