<!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: vbi_page Struct Reference</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 class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>vbi_page Struct Reference<br>
<small>
[<a class="el" href="group__Page.html">Formatted text page</a>]</small>
</h1><!-- doxytag: class="vbi_page" -->Formatted Teletext or Closed Caption page.
<a href="#_details">More...</a>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">vbi_decoder * </td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__page.html#5a7c9dabfb7b84608416f38125cc18e5">vbi</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__Event.html#gf7674e0718ecde1f3340325e34296b6a">vbi_nuid</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__page.html#5d466eadf603e620c1e7662c3d37cf82">nuid</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__page.html#7633883c5732103d8048c9db0e250358">pgno</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__page.html#741ccb9357e542ff47b12baa4ee0de8c">subno</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__page.html#794471cd941ff108c639f4fe36457a9b">rows</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__page.html#117201ffef54e2cd66454dfe85650931">columns</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structvbi__char.html">vbi_char</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__page.html#b60a5037fac8d628cbfcda0bc8da91ae">text</a> [1056]</td></tr>
<tr><td class="memItemLeft" nowrap>struct {</td></tr>
<tr><td class="memItemLeft" nowrap> int <b>y0</b></td></tr>
<tr><td class="memItemLeft" nowrap> int <b>y1</b></td></tr>
<tr><td class="memItemLeft" nowrap> int <b>roll</b></td></tr>
<tr><td class="memItemLeft" nowrap valign="top">} </td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__page.html#7cde8e0896e606e806ca6622c5f53d01">dirty</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__Page.html#g5cc7aca92393625043f2e531f238ee32">vbi_color</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__page.html#93a5df00d0686b7bebf31ce68fa3076e">screen_color</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__Page.html#gb3f248dc4cf23026c2da167b428a5162">vbi_opacity</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__page.html#bd04a9a8e20c21eb9e1a1fee26b9395f">screen_opacity</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__Page.html#gba178f9da35c6ecb95c20e9fd9ef8a42">vbi_rgba</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__page.html#147616645aa850cc6655a045077e9a6d">color_map</a> [40]</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__page.html#1312e2c271536ac6c64b641968cbfab3">drcs_clut</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__page.html#9e88ff7c2b551ec99a7b856718d0c738">drcs</a> [32]</td></tr>
<tr><td class="memItemLeft" nowrap><a class="anchor" name="a9b98dbe3ae1789c1ef1faee7babf388"></a><!-- doxytag: member="vbi_page::nav_link" ref="a9b98dbe3ae1789c1ef1faee7babf388" args="[6]" -->
struct {</td></tr>
<tr><td class="memItemLeft" nowrap> int <b>pgno</b></td></tr>
<tr><td class="memItemLeft" nowrap> int <b>subno</b></td></tr>
<tr><td class="memItemLeft" nowrap valign="top">} </td><td class="memItemRight" valign="bottom"><b>nav_link</b> [6]</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4cd68b64b12c50691fe998ae6feb4a70"></a><!-- doxytag: member="vbi_page::nav_index" ref="4cd68b64b12c50691fe998ae6feb4a70" args="[64]" -->
char </td><td class="memItemRight" valign="bottom"><b>nav_index</b> [64]</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f11cb160b52558c441f710171711b74c"></a><!-- doxytag: member="vbi_page::font" ref="f11cb160b52558c441f710171711b74c" args="[2]" -->
struct <a class="el" href="group__Page.html#gd84ac3c6f0e0020131369c2afa8bd8f8">vbi_font_descr</a> * </td><td class="memItemRight" valign="bottom"><b>font</b> [2]</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ad8d849fc6683bddacd852de7f3f7327"></a><!-- doxytag: member="vbi_page::double_height_lower" ref="ad8d849fc6683bddacd852de7f3f7327" args="" -->
unsigned int </td><td class="memItemRight" valign="bottom"><b>double_height_lower</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="162cab11e972554e4bef9e3d1fa67975"></a><!-- doxytag: member="vbi_page::page_opacity" ref="162cab11e972554e4bef9e3d1fa67975" args="[2]" -->
<a class="el" href="group__Page.html#gb3f248dc4cf23026c2da167b428a5162">vbi_opacity</a> </td><td class="memItemRight" valign="bottom"><b>page_opacity</b> [2]</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="87448683f28cb7c1ae6842119f3783c6"></a><!-- doxytag: member="vbi_page::boxed_opacity" ref="87448683f28cb7c1ae6842119f3783c6" args="[2]" -->
<a class="el" href="group__Page.html#gb3f248dc4cf23026c2da167b428a5162">vbi_opacity</a> </td><td class="memItemRight" valign="bottom"><b>boxed_opacity</b> [2]</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Formatted Teletext or Closed Caption page.
<p>
Clients can fetch pages from the respective cache using vbi_fetch_vt_page() or <a class="el" href="group__Cache.html#g7569e113defe7ccfdebd396691a696f6">vbi_fetch_cc_page()</a> for evaluation, display or output. Since the page may reference other objects in cache which are locked by the fetch functions, <a class="el" href="group__Cache.html#gf22bf32b5027d5c5d34d615bc22896a3">vbi_unref_page()</a> must be called when done. Note this structure is large, some 10 KB. <dl compact><dt><b>Examples: </b></dt><dd>
<p>
<a class="el" href="src_2exp-templ_8c-example.html#_a15">src/exp-templ.c</a>.</dl><hr><h2>Field Documentation</h2>
<a class="anchor" name="5a7c9dabfb7b84608416f38125cc18e5"></a><!-- doxytag: member="vbi_page::vbi" ref="5a7c9dabfb7b84608416f38125cc18e5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vbi_decoder* <a class="el" href="structvbi__page.html#5a7c9dabfb7b84608416f38125cc18e5">vbi_page::vbi</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Points back to the source context.
</div>
</div><p>
<a class="anchor" name="5d466eadf603e620c1e7662c3d37cf82"></a><!-- doxytag: member="vbi_page::nuid" ref="5d466eadf603e620c1e7662c3d37cf82" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__Event.html#gf7674e0718ecde1f3340325e34296b6a">vbi_nuid</a> <a class="el" href="structvbi__page.html#5d466eadf603e620c1e7662c3d37cf82">vbi_page::nuid</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Identifies the network broadcasting this page.
</div>
</div><p>
<a class="anchor" name="7633883c5732103d8048c9db0e250358"></a><!-- doxytag: member="vbi_page::pgno" ref="7633883c5732103d8048c9db0e250358" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structvbi__page.html#7633883c5732103d8048c9db0e250358">vbi_page::pgno</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Page number, see vbi_pgno. <dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="src_2exp-templ_8c-example.html#a16">src/exp-templ.c</a>.</dl>
</div>
</div><p>
<a class="anchor" name="741ccb9357e542ff47b12baa4ee0de8c"></a><!-- doxytag: member="vbi_page::subno" ref="741ccb9357e542ff47b12baa4ee0de8c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structvbi__page.html#741ccb9357e542ff47b12baa4ee0de8c">vbi_page::subno</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Subpage number, see vbi_subno. <dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="src_2exp-templ_8c-example.html#a17">src/exp-templ.c</a>.</dl>
</div>
</div><p>
<a class="anchor" name="794471cd941ff108c639f4fe36457a9b"></a><!-- doxytag: member="vbi_page::rows" ref="794471cd941ff108c639f4fe36457a9b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structvbi__page.html#794471cd941ff108c639f4fe36457a9b">vbi_page::rows</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Number of character rows in the page.
</div>
</div><p>
<a class="anchor" name="117201ffef54e2cd66454dfe85650931"></a><!-- doxytag: member="vbi_page::columns" ref="117201ffef54e2cd66454dfe85650931" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structvbi__page.html#117201ffef54e2cd66454dfe85650931">vbi_page::columns</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Number of character columns in the page.
</div>
</div><p>
<a class="anchor" name="b60a5037fac8d628cbfcda0bc8da91ae"></a><!-- doxytag: member="vbi_page::text" ref="b60a5037fac8d628cbfcda0bc8da91ae" args="[1056]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structvbi__char.html">vbi_char</a> <a class="el" href="structvbi__page.html#b60a5037fac8d628cbfcda0bc8da91ae">vbi_page::text</a>[1056] </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The page contents, these are <em>rows</em> x <em>columns</em> without padding between the rows. See <a class="el" href="structvbi__char.html" title="Attributed character.">vbi_char</a> for details.
</div>
</div><p>
<a class="anchor" name="7cde8e0896e606e806ca6622c5f53d01"></a><!-- doxytag: member="vbi_page::dirty" ref="7cde8e0896e606e806ca6622c5f53d01" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct { ... } <a class="el" href="structvbi__page.html#7cde8e0896e606e806ca6622c5f53d01">vbi_page::dirty</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
To speed up rendering these variables mark the rows which actually changed since the page has been last fetched from cache. <em>y0</em> ... <em>y1</em> are the first to last row changed, inclusive, in range 0 ... <em>rows</em> - 1. <em>roll</em> indicates the page has been vertically scrolled this number of rows, negative numbers up (towards lower row numbers), positive numbers down. For example -1 means row <em>y0</em> + 1 ... <em>y1</em> moved to <em>y0</em> ... <em>y1</em> - 1, erasing row <em>y1</em> to all spaces.<p>
Practically this is only used in Closed Caption roll-up mode, otherwise all rows are always marked dirty. Clients are free to ignore this information.
</div>
</div><p>
<a class="anchor" name="93a5df00d0686b7bebf31ce68fa3076e"></a><!-- doxytag: member="vbi_page::screen_color" ref="93a5df00d0686b7bebf31ce68fa3076e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__Page.html#g5cc7aca92393625043f2e531f238ee32">vbi_color</a> <a class="el" href="structvbi__page.html#93a5df00d0686b7bebf31ce68fa3076e">vbi_page::screen_color</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
When a TV displays Teletext or Closed Caption pages, only a section in the center of the screen is actually covered by characters. The remaining space is referred to here as 'border', which can have a color different from the typical black. (In the Teletext specs this is referred to as the screen color, hence the field name.) This is a vbi_color index into the <em>color_map</em>.
</div>
</div><p>
<a class="anchor" name="bd04a9a8e20c21eb9e1a1fee26b9395f"></a><!-- doxytag: member="vbi_page::screen_opacity" ref="bd04a9a8e20c21eb9e1a1fee26b9395f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__Page.html#gb3f248dc4cf23026c2da167b428a5162">vbi_opacity</a> <a class="el" href="structvbi__page.html#bd04a9a8e20c21eb9e1a1fee26b9395f">vbi_page::screen_opacity</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The 'border' can also have a distinguished opacity. Typically this will be VBI_OPAQUE, but pages intended for overlay onto video (Teletext subtitles, newsflash, Caption pages) will have a <em>screen_opacity</em> of VBI_TRANSPARENT_SPACE. See vbi_opacity for details.
</div>
</div><p>
<a class="anchor" name="147616645aa850cc6655a045077e9a6d"></a><!-- doxytag: member="vbi_page::color_map" ref="147616645aa850cc6655a045077e9a6d" args="[40]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__Page.html#gba178f9da35c6ecb95c20e9fd9ef8a42">vbi_rgba</a> <a class="el" href="structvbi__page.html#147616645aa850cc6655a045077e9a6d">vbi_page::color_map</a>[40] </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This is the color palette indexed by vbi_color in <a class="el" href="structvbi__char.html" title="Attributed character.">vbi_char</a> and elsewhere, colors defined as vbi_rgba. Note this palette may not correspond to the vbi_color enumeration since Teletext allows editors to redefine the entire palette. Closed Caption and Teletext Level 1.0/1.5 pages use entries 0 ... 7. Teletext Level 2.5/3.5 pages use entries 0 ... 31. Navigation related text (TOP, FLOF) added by libzvbi uses entries 32 ... 39 which are not subject to redefinition.
</div>
</div><p>
<a class="anchor" name="1312e2c271536ac6c64b641968cbfab3"></a><!-- doxytag: member="vbi_page::drcs_clut" ref="1312e2c271536ac6c64b641968cbfab3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t* <a class="el" href="structvbi__page.html#1312e2c271536ac6c64b641968cbfab3">vbi_page::drcs_clut</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
DRCS (dynamically redefinable characters) can have two, four or sixteen different colors. Without further details, the effective color of each pixel is given by <div class="fragment"><pre class="fragment"> <a class="code" href="structvbi__page.html" title="Formatted Teletext or Closed Caption page.">vbi_page</a>->color_map[<a class="code" href="structvbi__page.html#1312e2c271536ac6c64b641968cbfab3">drcs_clut</a>[<a class="code" href="structvbi__page.html#9e88ff7c2b551ec99a7b856718d0c738">drcs</a> pixel color + <a class="code" href="structvbi__char.html" title="Attributed character.">vbi_char</a>->drcs_clut_offs]],
</pre></div> whereby drcs_clut[0] shall be replaced by vbi_char->foreground, drcs_clut[1] by vbi_char->background. (Renderers are supposed to convert the drcs_clut into a private color map of the desired pixel format.)<p>
Practically vbi_char->drcs_clut_offs encodes the DRCS color depth and selects between the <a class="el" href="structvbi__char.html" title="Attributed character.">vbi_char</a> colors and one of two 4- or 16-entry Color Look-Up Tables. Also the different resolution of DRCS and the bitplane color coding is hidden to speed up rendering.
</div>
</div><p>
<a class="anchor" name="9e88ff7c2b551ec99a7b856718d0c738"></a><!-- doxytag: member="vbi_page::drcs" ref="9e88ff7c2b551ec99a7b856718d0c738" args="[32]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t* <a class="el" href="structvbi__page.html#9e88ff7c2b551ec99a7b856718d0c738">vbi_page::drcs</a>[32] </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Pointer to DRCS data. Per definition the maximum number of DRCS usable at the same time, i. e. on one page, is limited to 96. However the number of DRCS defined in a Teletext data stream can be much larger. The 32 pointers here correspond to the 32 DRCS character planes mentioned in the <a class="el" href="structvbi__char.html" title="Attributed character.">vbi_char</a> description. Each of them points to an array of character definitions, a DRCS font. One character occupies 60 bytes or 12 x 10 pixels, stored left to right and top to bottom. The color of each pixel (index into <em>drcs_clut</em>) is coded in four bits stored in little endian order, first pixel 0x0F, second pixel 0xF0 and so on. For example the first, top/leftmost pixel can be found at <div class="fragment"><pre class="fragment"> <a class="code" href="structvbi__page.html" title="Formatted Teletext or Closed Caption page.">vbi_page</a>->drcs[(unicode >> 6) & 0x1F][(unicode & 0x3F) * 60]
</pre></div><p>
Do not access DRCS data unless referenced by a <a class="el" href="structvbi__char.html" title="Attributed character.">vbi_char</a> in <em>text</em>, a segfault may result. Do not access DRCS data after calling <a class="el" href="group__Cache.html#gf22bf32b5027d5c5d34d615bc22896a3">vbi_unref_page()</a>, it may not be cached anymore.
</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>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
1af184c486f5d5f476d50602700ee0a0
>
files
>
69
