<!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: Error correction functions</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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Error correction functions<div class="ingroups"><a class="el" href="group__Raw.html">Raw VBI</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Helper functions to decode sliced VBI data.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaac266ab17d0044d1adbcf7f113329290"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Error.html#gaac266ab17d0044d1adbcf7f113329290">vbi_par</a> (uint8_t *p, unsigned int n)</td></tr>
<tr class="separator:gaac266ab17d0044d1adbcf7f113329290"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafa73f04f095b154f3237f7d4e98f18b7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Error.html#gafa73f04f095b154f3237f7d4e98f18b7">vbi_unpar</a> (uint8_t *p, unsigned int n)</td></tr>
<tr class="separator:gafa73f04f095b154f3237f7d4e98f18b7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga997d16edd4deed54dfca6943f5b7b885"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Error.html#ga997d16edd4deed54dfca6943f5b7b885">vbi_ham24p</a> (uint8_t *p, unsigned int c)</td></tr>
<tr class="separator:ga997d16edd4deed54dfca6943f5b7b885"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5d764f42094e48760cf3e754776ac3fd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Error.html#ga5d764f42094e48760cf3e754776ac3fd">vbi_unham24p</a> (const uint8_t *p)</td></tr>
<tr class="separator:ga5d764f42094e48760cf3e754776ac3fd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab59fd75a6908d9b03166c9be36d2f4ce"><td class="memItemLeft" align="right" valign="top">_vbi_inline unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Error.html#gab59fd75a6908d9b03166c9be36d2f4ce">vbi_rev8</a> (unsigned int c)</td></tr>
<tr class="separator:gab59fd75a6908d9b03166c9be36d2f4ce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0b14a7e987786a8746987b7dcb0c955f"><td class="memItemLeft" align="right" valign="top">_vbi_inline unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Error.html#ga0b14a7e987786a8746987b7dcb0c955f">vbi_rev16</a> (unsigned int c)</td></tr>
<tr class="separator:ga0b14a7e987786a8746987b7dcb0c955f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf0a2792d50100576982c44cd64fa7fd4"><td class="memItemLeft" align="right" valign="top">_vbi_inline unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Error.html#gaf0a2792d50100576982c44cd64fa7fd4">vbi_rev16p</a> (const uint8_t *p)</td></tr>
<tr class="separator:gaf0a2792d50100576982c44cd64fa7fd4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf85ae2c13320d8dd664863ebff8165ff"><td class="memItemLeft" align="right" valign="top">_vbi_inline unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Error.html#gaf85ae2c13320d8dd664863ebff8165ff">vbi_par8</a> (unsigned int c)</td></tr>
<tr class="separator:gaf85ae2c13320d8dd664863ebff8165ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga49d1cf6af476a4fa10c0312f373ac1a0"><td class="memItemLeft" align="right" valign="top">_vbi_inline int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Error.html#ga49d1cf6af476a4fa10c0312f373ac1a0">vbi_unpar8</a> (unsigned int c)</td></tr>
<tr class="separator:ga49d1cf6af476a4fa10c0312f373ac1a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga34d1be5fbcad2db35b7003f8d5e2b905"><td class="memItemLeft" align="right" valign="top">_vbi_inline unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Error.html#ga34d1be5fbcad2db35b7003f8d5e2b905">vbi_ham8</a> (unsigned int c)</td></tr>
<tr class="separator:ga34d1be5fbcad2db35b7003f8d5e2b905"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga91fcc67515be04557c53c3e076159507"><td class="memItemLeft" align="right" valign="top">_vbi_inline int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Error.html#ga91fcc67515be04557c53c3e076159507">vbi_unham8</a> (unsigned int c)</td></tr>
<tr class="separator:ga91fcc67515be04557c53c3e076159507"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab62090ec932d135dea3dde39e4e4cc55"><td class="memItemLeft" align="right" valign="top">_vbi_inline int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Error.html#gab62090ec932d135dea3dde39e4e4cc55">vbi_unham16p</a> (const uint8_t *p)</td></tr>
<tr class="separator:gab62090ec932d135dea3dde39e4e4cc55"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Helper functions to decode sliced VBI data. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaac266ab17d0044d1adbcf7f113329290"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vbi_par </td>
<td>(</td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>n</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">p</td><td>Array of unsigned bytes. </td></tr>
<tr><td class="paramname">n</td><td>Size of array.</td></tr>
</table>
</dd>
</dl>
<p>Of each byte of the array, changes the most significant bit to make the number of set bits odd.</p>
<dl class="section since"><dt>Since</dt><dd>0.2.12 </dd></dl>
<p>Referenced by <a class="el" href="group__Error.html#ga49d1cf6af476a4fa10c0312f373ac1a0">vbi_unpar8()</a>.</p>
</div>
</div>
<a class="anchor" id="gafa73f04f095b154f3237f7d4e98f18b7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int vbi_unpar </td>
<td>(</td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>n</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">p</td><td>Array of unsigned bytes. </td></tr>
<tr><td class="paramname">n</td><td>Size of array.</td></tr>
</table>
</dd>
</dl>
<p>Tests the parity and clears the most significant bit of each byte of the array.</p>
<dl class="section return"><dt>Returns</dt><dd>A negative value if any byte of the array had even parity (sum of bits modulo 2 is 0).</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.12 </dd></dl>
<p>Referenced by <a class="el" href="group__Error.html#ga49d1cf6af476a4fa10c0312f373ac1a0">vbi_unpar8()</a>.</p>
</div>
</div>
<a class="anchor" id="ga997d16edd4deed54dfca6943f5b7b885"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vbi_ham24p </td>
<td>(</td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>c</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">p</td><td>A Hamming 24/18 protected 24 bit word will be stored here, last significant byte first, lsb first transmitted. </td></tr>
<tr><td class="paramname">c</td><td>Integer between 0 ... 1 << 18 - 1.</td></tr>
</table>
</dd>
</dl>
<p>Encodes an 18 bit word with Hamming 24/18 protection as specified in ETS 300 706, Section 8.3.</p>
<dl class="section since"><dt>Since</dt><dd>0.2.27 </dd></dl>
<p>Referenced by <a class="el" href="group__Error.html#gab62090ec932d135dea3dde39e4e4cc55">vbi_unham16p()</a>.</p>
</div>
</div>
<a class="anchor" id="ga5d764f42094e48760cf3e754776ac3fd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int vbi_unham24p </td>
<td>(</td>
<td class="paramtype">const uint8_t * </td>
<td class="paramname"><em>p</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">p</td><td>Pointer to a Hamming 24/18 protected 24 bit word, last significant byte first, lsb first transmitted.</td></tr>
</table>
</dd>
</dl>
<p>Decodes a Hamming 24/18 protected byte triplet as specified in ETS 300 706, Section 8.3.</p>
<dl class="section return"><dt>Returns</dt><dd>Triplet data bits D18 [msb] ... D1 [lsb] or a negative value if the triplet contained uncorrectable errors.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.12 </dd></dl>
<p>Referenced by <a class="el" href="group__Error.html#gab62090ec932d135dea3dde39e4e4cc55">vbi_unham16p()</a>.</p>
</div>
</div>
<a class="anchor" id="gab59fd75a6908d9b03166c9be36d2f4ce"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_vbi_inline unsigned int vbi_rev8 </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>c</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">c</td><td>Unsigned byte.</td></tr>
</table>
</dd>
</dl>
<p>Reverses the bits of the argument.</p>
<dl class="section return"><dt>Returns</dt><dd>Data bits 0 [msb] ... 7 [lsb].</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.12 </dd></dl>
<p>Referenced by <a class="el" href="group__Packet830.html#ga67d3820f3f859189fea8143293b9a9e1">vbi_decode_teletext_8302_cni()</a>, and <a class="el" href="group__Packet830.html#gad0461de5ceb8ef217d2ad62cb4438809">vbi_decode_teletext_8302_pdc()</a>.</p>
</div>
</div>
<a class="anchor" id="ga0b14a7e987786a8746987b7dcb0c955f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_vbi_inline unsigned int vbi_rev16 </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>c</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">c</td><td>Unsigned 16 bit word.</td></tr>
</table>
</dd>
</dl>
<p>Reverses (or "reflects") the bits of the argument.</p>
<dl class="section return"><dt>Returns</dt><dd>Data bits 0 [msb] ... 15 [lsb].</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.12 </dd></dl>
</div>
</div>
<a class="anchor" id="gaf0a2792d50100576982c44cd64fa7fd4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_vbi_inline unsigned int vbi_rev16p </td>
<td>(</td>
<td class="paramtype">const uint8_t * </td>
<td class="paramname"><em>p</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">p</td><td>Pointer to a 16 bit word, last significant byte first.</td></tr>
</table>
</dd>
</dl>
<p>Reverses (or "reflects") the bits of the argument.</p>
<dl class="section return"><dt>Returns</dt><dd>Data bits 0 [msb] ... 15 [lsb].</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.12 </dd></dl>
<p>Referenced by <a class="el" href="group__Packet830.html#gad73eef286a3222ceab3be07436e0a45d">vbi_decode_teletext_8301_cni()</a>.</p>
</div>
</div>
<a class="anchor" id="gaf85ae2c13320d8dd664863ebff8165ff"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_vbi_inline unsigned int vbi_par8 </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>c</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">c</td><td>Unsigned byte.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Changes the most significant bit of the byte to make the number of set bits odd.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.12 </dd></dl>
<p>Referenced by <a class="el" href="group__Device.html#gaa0b81b4226106cf38b541597eff40f2d">vbi_capture_sim_add_noise()</a>.</p>
</div>
</div>
<a class="anchor" id="ga49d1cf6af476a4fa10c0312f373ac1a0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_vbi_inline int vbi_unpar8 </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>c</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">c</td><td>Unsigned byte.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>If the byte has odd parity (sum of bits modulo 2 is 1) the byte AND 127, otherwise a negative value.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.12 </dd></dl>
<p>References <a class="el" href="group__Error.html#gaac266ab17d0044d1adbcf7f113329290">vbi_par()</a>, and <a class="el" href="group__Error.html#gafa73f04f095b154f3237f7d4e98f18b7">vbi_unpar()</a>.</p>
<p>Referenced by <a class="el" href="group__XDSDemux.html#gab46df46f3dfcc51c605a618ecbdac01f">vbi_xds_demux_feed()</a>.</p>
</div>
</div>
<a class="anchor" id="ga34d1be5fbcad2db35b7003f8d5e2b905"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_vbi_inline unsigned int vbi_ham8 </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>c</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">c</td><td>Integer between 0 ... 15.</td></tr>
</table>
</dd>
</dl>
<p>Encodes a nibble with Hamming 8/4 protection as specified in EN 300 706, Section 8.2.</p>
<dl class="section return"><dt>Returns</dt><dd>Hamming encoded unsigned byte, lsb first transmitted.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.12 </dd></dl>
</div>
</div>
<a class="anchor" id="ga91fcc67515be04557c53c3e076159507"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_vbi_inline int vbi_unham8 </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>c</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">c</td><td>Hamming 8/4 protected byte, lsb first transmitted.</td></tr>
</table>
</dd>
</dl>
<p>Decodes a Hamming 8/4 protected byte as specified in EN 300 706, Section 8.2.</p>
<dl class="section return"><dt>Returns</dt><dd>Data bits (D4 [msb] ... D1 [lsb]) or a negative value if the byte contained uncorrectable errors.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.12 </dd></dl>
<p>Referenced by <a class="el" href="group__Packet830.html#gad0461de5ceb8ef217d2ad62cb4438809">vbi_decode_teletext_8302_pdc()</a>, <a class="el" href="group__IDLDemux.html#ga490f1961add5aa7d0f27b3fd913f2f59">vbi_idl_demux_feed()</a>, and <a class="el" href="group__PFCDemux.html#gae334afca20ce542494b2cf783b8fae39">vbi_pfc_demux_reset()</a>.</p>
</div>
</div>
<a class="anchor" id="gab62090ec932d135dea3dde39e4e4cc55"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_vbi_inline int vbi_unham16p </td>
<td>(</td>
<td class="paramtype">const uint8_t * </td>
<td class="paramname"><em>p</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">p</td><td>Pointer to a Hamming 8/4 protected 16 bit word, last significant byte first, lsb first transmitted.</td></tr>
</table>
</dd>
</dl>
<p>Decodes a Hamming 8/4 protected byte pair as specified in EN 300 706, Section 8.2.</p>
<dl class="section return"><dt>Returns</dt><dd>Data bits D4 [msb] ... D1 of first byte and D4 ... D1 [lsb] of second byte, or a negative value if any of the bytes contained uncorrectable errors.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.12 </dd></dl>
<p>References <a class="el" href="group__Error.html#ga997d16edd4deed54dfca6943f5b7b885">vbi_ham24p()</a>, and <a class="el" href="group__Error.html#ga5d764f42094e48760cf3e754776ac3fd">vbi_unham24p()</a>.</p>
<p>Referenced by <a class="el" href="group__Packet830.html#ga67d3820f3f859189fea8143293b9a9e1">vbi_decode_teletext_8302_cni()</a>, <a class="el" href="group__Packet830.html#gad0461de5ceb8ef217d2ad62cb4438809">vbi_decode_teletext_8302_pdc()</a>, <a class="el" href="group__PFCDemux.html#gaa4b895cf6895630a82608b3225c6412c">vbi_pfc_demux_feed()</a>, and <a class="el" href="group__PFCDemux.html#gae334afca20ce542494b2cf783b8fae39">vbi_pfc_demux_reset()</a>.</p>
</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
>
42
