libzvbi-doc 0.2.35-13 / usr / share / doc / libzvbi-doc / html / group__Packet830.html

This file is indexed.

/usr/share/doc/libzvbi-doc/html/group__Packet830.html is in libzvbi-doc 0.2.35-13.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
<!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>ZVBI Library: Teletext Packet 8/30 Decoder</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
   &#160;<span id="projectnumber">0.2.35</span>
   </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="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Teletext Packet 8/30 Decoder<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 Teletext packet 8/30 (ETS 300 706).  
<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:gad73eef286a3222ceab3be07436e0a45d"><td class="memItemLeft" align="right" valign="top">vbi_bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Packet830.html#gad73eef286a3222ceab3be07436e0a45d">vbi_decode_teletext_8301_cni</a> (unsigned int *cni, const uint8_t buffer[42])</td></tr>
<tr class="separator:gad73eef286a3222ceab3be07436e0a45d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga26a2b9d099bc2e7b83374b3318a5200c"><td class="memItemLeft" align="right" valign="top">vbi_bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Packet830.html#ga26a2b9d099bc2e7b83374b3318a5200c">vbi_decode_teletext_8301_local_time</a> (time_t *utc_time, int *seconds_east, const uint8_t buffer[42])</td></tr>
<tr class="separator:ga26a2b9d099bc2e7b83374b3318a5200c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga67d3820f3f859189fea8143293b9a9e1"><td class="memItemLeft" align="right" valign="top">vbi_bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Packet830.html#ga67d3820f3f859189fea8143293b9a9e1">vbi_decode_teletext_8302_cni</a> (unsigned int *cni, const uint8_t buffer[42])</td></tr>
<tr class="separator:ga67d3820f3f859189fea8143293b9a9e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad0461de5ceb8ef217d2ad62cb4438809"><td class="memItemLeft" align="right" valign="top">vbi_bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Packet830.html#gad0461de5ceb8ef217d2ad62cb4438809">vbi_decode_teletext_8302_pdc</a> (<a class="el" href="structvbi__program__id.html">vbi_program_id</a> *pid, const uint8_t buffer[42])</td></tr>
<tr class="separator:gad0461de5ceb8ef217d2ad62cb4438809"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Functions to decode Teletext packet 8/30 (ETS 300 706). </p>
<p>Teletext pages are transmitted in packets numbered 0 to 31. Packet 0 to 25 contain the text of the page, packet 26 to 29 additional information like Fastext links. Packet 30 and 31 are reserved for data transmissions unrelated to any page. Since each packet contains a magazine number 1 to 8 (the first digit of the Teletext page number) 16 logical channels can be distinguished. Packet 30 with magazine number 8 carries a Country and Network Identifier, and either a local time (format 1) or PDC label (format 2).</p>
<p>These are low level functions. See test/decode.c for a usage example.</p>
<p>The <em><a class="el" href="structvbi__decoder.html">vbi_decoder</a></em> module can decode a full Teletext signal and provide the information transmitted in packet 8/30 as <code>VBI_EVENT_NETWORK</code>, <code>VBI_EVENT_NETWORK_ID</code>, <code>VBI_EVENT_LOCAL_TIME</code> and <code>VBI_EVENT_PROG_ID</code>. See examples/network.c and examples/pdc1.c. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="gad73eef286a3222ceab3be07436e0a45d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad73eef286a3222ceab3be07436e0a45d">&sect;&nbsp;</a></span>vbi_decode_teletext_8301_cni()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vbi_bool vbi_decode_teletext_8301_cni </td>
          <td>(</td>
          <td class="paramtype">unsigned int *&#160;</td>
          <td class="paramname"><em>cni</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint8_t&#160;</td>
          <td class="paramname"><em>buffer</em>[42]&#160;</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">cni</td><td>CNI of type VBI_CNI_TYPE_8301 will be stored here. </td></tr>
    <tr><td class="paramname">buffer</td><td>Teletext packet as defined for <code>VBI_SLICED_TELETEXT_B</code>, i.e. 42 bytes without clock run-in and framing code.</td></tr>
  </table>
  </dd>
</dl>
<p>Decodes a Teletext packet 8/30 format 1 according to ETS 300 706 section 9.8.1, returning the contained 16 bit Country and Network Identifier in <em>*cni</em>.</p>
<dl class="section return"><dt>Returns</dt><dd>Always <code>TRUE</code>, no error checking possible. It may be prudent to wait for a second transmission of the received CNI to ensure correct reception.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.34 </dd></dl>

<p>References <a class="el" href="group__Packet830.html#ga26a2b9d099bc2e7b83374b3318a5200c">vbi_decode_teletext_8301_local_time()</a>, and <a class="el" href="group__Error.html#gaf0a2792d50100576982c44cd64fa7fd4">vbi_rev16p()</a>.</p>

</div>
</div>
<a id="ga26a2b9d099bc2e7b83374b3318a5200c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga26a2b9d099bc2e7b83374b3318a5200c">&sect;&nbsp;</a></span>vbi_decode_teletext_8301_local_time()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vbi_bool vbi_decode_teletext_8301_local_time </td>
          <td>(</td>
          <td class="paramtype">time_t *&#160;</td>
          <td class="paramname"><em>time</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int *&#160;</td>
          <td class="paramname"><em>seconds_east</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint8_t&#160;</td>
          <td class="paramname"><em>buffer</em>[42]&#160;</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">time</td><td>The current time in seconds since 1970-01-01 00:00 UTC will be stored here. </td></tr>
    <tr><td class="paramname">seconds_east</td><td>The offset of the local time of the intended audience of the program in seconds east of UTC will be stored here, including a daylight-saving time offset if daylight-saving is currently in effect in that time zone. To get the local time of the intended audience add <em>seconds_east</em> to <em>time</em>. </td></tr>
    <tr><td class="paramname">buffer</td><td>Teletext packet as defined for <code>VBI_SLICED_TELETEXT_B</code>, i.e. 42 bytes without clock run-in and framing code.</td></tr>
  </table>
  </dd>
</dl>
<p>Decodes a Teletext packet 8/30 format 1 according to ETS 300 706 section 9.8.1, returning the current time in the UTC time zone and the time zone of the intended audience of the program.</p>
<dl class="section return"><dt>Returns</dt><dd>On error the function returns <code>FALSE:</code> <ul>
<li>The buffer contains uncorrectable errors or</li>
<li>The time is not representable as a time_t. In these cases <em>*time</em> and <em>*seconds_east</em> remain unchanged.</li>
</ul>
</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.34 </dd></dl>

<p>References <a class="el" href="group__BCD.html#ga557e0e23dd907e1aa77e8b2112b43d5c">vbi_is_bcd()</a>.</p>

<p>Referenced by <a class="el" href="group__Packet830.html#gad73eef286a3222ceab3be07436e0a45d">vbi_decode_teletext_8301_cni()</a>.</p>

</div>
</div>
<a id="ga67d3820f3f859189fea8143293b9a9e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga67d3820f3f859189fea8143293b9a9e1">&sect;&nbsp;</a></span>vbi_decode_teletext_8302_cni()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vbi_bool vbi_decode_teletext_8302_cni </td>
          <td>(</td>
          <td class="paramtype">unsigned int *&#160;</td>
          <td class="paramname"><em>cni</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint8_t&#160;</td>
          <td class="paramname"><em>buffer</em>[42]&#160;</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">cni</td><td>CNI of type VBI_CNI_TYPE_8302 will be stored here. </td></tr>
    <tr><td class="paramname">buffer</td><td>Teletext packet as defined for <code>VBI_SLICED_TELETEXT_B</code>, i.e. 42 bytes without clock run-in and framing code.</td></tr>
  </table>
  </dd>
</dl>
<p>Decodes a Teletext packet 8/30 format 2 according to ETS 300 706 section 9.8.2, returning the contained 16 bit Country and Network Identifier in <em>*cni</em>.</p>
<dl class="section return"><dt>Returns</dt><dd><code>FALSE</code> if the buffer contains uncorrectable errors. In this case <em>*cni</em> remains unchanged.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.34 </dd></dl>

<p>References <a class="el" href="group__Error.html#gab59fd75a6908d9b03166c9be36d2f4ce">vbi_rev8()</a>, and <a class="el" href="group__Error.html#gab62090ec932d135dea3dde39e4e4cc55">vbi_unham16p()</a>.</p>

</div>
</div>
<a id="gad0461de5ceb8ef217d2ad62cb4438809"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad0461de5ceb8ef217d2ad62cb4438809">&sect;&nbsp;</a></span>vbi_decode_teletext_8302_pdc()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vbi_bool vbi_decode_teletext_8302_pdc </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structvbi__program__id.html">vbi_program_id</a> *&#160;</td>
          <td class="paramname"><em>pid</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint8_t&#160;</td>
          <td class="paramname"><em>buffer</em>[42]&#160;</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">pid</td><td>PDC program ID will be stored here. </td></tr>
    <tr><td class="paramname">buffer</td><td>Teletext packet as defined for <code>VBI_SLICED_TELETEXT_B</code>, i.e. 42 bytes without clock run-in and framing code.</td></tr>
  </table>
  </dd>
</dl>
<p>Decodes a Teletext packet 8/30 format 2 according to ETS 300 231, and stores the contained PDC recording-control data in <em>*pid</em>.</p>
<dl class="section return"><dt>Returns</dt><dd><code>FALSE</code> if the buffer contains uncorrectable errors or invalid data. In this case <em>*pid</em> remains unchanged.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.2.34 </dd></dl>

<p>References <a class="el" href="structvbi__program__id.html#a90794327986da193ddb76d518331589d">vbi_program_id::channel</a>, <a class="el" href="structvbi__program__id.html#ab02c877d547812c4cc22df34e6b8794c">vbi_program_id::cni</a>, <a class="el" href="structvbi__program__id.html#a5ac7312ef52b908f7b55996d6d12b3bb">vbi_program_id::cni_type</a>, <a class="el" href="structvbi__program__id.html#abdd578b10dfa50e422cf90f200899d84">vbi_program_id::luf</a>, <a class="el" href="structvbi__program__id.html#a9cccb9d3856e8b459d09e67cd12908d4">vbi_program_id::mi</a>, <a class="el" href="structvbi__program__id.html#a0c3e81ecb789d309061ce5cf8bb16bce">vbi_program_id::pcs_audio</a>, <a class="el" href="structvbi__program__id.html#a30c0862c008de112f4222e1208038d58">vbi_program_id::pil</a>, <a class="el" href="structvbi__program__id.html#a35a130af99faf5714b96da7f3d08c48e">vbi_program_id::prf</a>, <a class="el" href="structvbi__program__id.html#a069f84e950d47f19a589cbe4a3603068">vbi_program_id::pty</a>, <a class="el" href="group__ProgramID.html#gga289ec10e87cef7655799144bc898f262a51a53db4366781f100d5d02836d6452e">VBI_PID_CHANNEL_LCI_0</a>, <a class="el" href="group__Error.html#gab59fd75a6908d9b03166c9be36d2f4ce">vbi_rev8()</a>, <a class="el" href="group__Error.html#gab62090ec932d135dea3dde39e4e4cc55">vbi_unham16p()</a>, and <a class="el" href="group__Error.html#ga91fcc67515be04557c53c3e076159507">vbi_unham8()</a>.</p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>

APT Browse - Built by Thomas Orozco.