<!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: Formatted text page</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>Formatted text page<br>
<small>
[<a class="el" href="group__HiDec.html">High Level Decoding</a>]</small>
</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__char.html">vbi_char</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Attributed character. <a href="structvbi__char.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__page.html">vbi_page</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Formatted Teletext or Closed Caption page. <a href="structvbi__page.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gba178f9da35c6ecb95c20e9fd9ef8a42"></a><!-- doxytag: member="Page::vbi_rgba" ref="gba178f9da35c6ecb95c20e9fd9ef8a42" args="" -->
typedef uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Page.html#gba178f9da35c6ecb95c20e9fd9ef8a42">vbi_rgba</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Colormap entry: 0xAABBGGRR. libzvbi sets the alpha channel always to 0xFF. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd84ac3c6f0e0020131369c2afa8bd8f8"></a><!-- doxytag: member="Page::vbi_font_descr" ref="gd84ac3c6f0e0020131369c2afa8bd8f8" args="" -->
typedef struct <a class="el" href="group__Page.html#gd84ac3c6f0e0020131369c2afa8bd8f8">vbi_font_descr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Page.html#gd84ac3c6f0e0020131369c2afa8bd8f8">vbi_font_descr</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Opaque font descriptor. <br></td></tr>
<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Page.html#g5cc7aca92393625043f2e531f238ee32">vbi_color</a> { <br>
<b>VBI_BLACK</b>,
<br>
<b>VBI_RED</b>,
<br>
<b>VBI_GREEN</b>,
<br>
<b>VBI_YELLOW</b>,
<br>
<b>VBI_BLUE</b>,
<br>
<b>VBI_MAGENTA</b>,
<br>
<b>VBI_CYAN</b>,
<br>
<b>VBI_WHITE</b>
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Index into the vbi_page->color_map. <a href="group__Page.html#g5cc7aca92393625043f2e531f238ee32">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Page.html#gb3f248dc4cf23026c2da167b428a5162">vbi_opacity</a> { <br>
<a class="el" href="group__Page.html#ggb3f248dc4cf23026c2da167b428a51620f8eacb19833c4505d76d57f0d28fd74">VBI_TRANSPARENT_SPACE</a>,
<br>
<a class="el" href="group__Page.html#ggb3f248dc4cf23026c2da167b428a516272062319b73325984c2b870f99edd4b7">VBI_TRANSPARENT_FULL</a>,
<br>
<a class="el" href="group__Page.html#ggb3f248dc4cf23026c2da167b428a51622511d5030ed1055b9f8a4413fb7826da">VBI_SEMI_TRANSPARENT</a>,
<br>
<a class="el" href="group__Page.html#ggb3f248dc4cf23026c2da167b428a51620e7504f00aebfac0f1542ffd54d2e74d">VBI_OPAQUE</a>
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Defines the opacity of a <a class="el" href="structvbi__char.html" title="Attributed character.">vbi_char</a> and <a class="el" href="structvbi__page.html" title="Formatted Teletext or Closed Caption page.">vbi_page</a> border. <a href="group__Page.html#gb3f248dc4cf23026c2da167b428a5162">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Page.html#g75a5fe9d9e5f1b6981030c99aa488270">vbi_size</a> { <br>
<b>VBI_NORMAL_SIZE</b>,
<br>
<b>VBI_DOUBLE_WIDTH</b>,
<br>
<b>VBI_DOUBLE_HEIGHT</b>,
<br>
<b>VBI_DOUBLE_SIZE</b>,
<br>
<b>VBI_OVER_TOP</b>,
<br>
<b>VBI_OVER_BOTTOM</b>,
<br>
<b>VBI_DOUBLE_HEIGHT2</b>,
<br>
<b>VBI_DOUBLE_SIZE2</b>
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Defines the size of a <a class="el" href="structvbi__char.html" title="Attributed character.">vbi_char</a> in a <a class="el" href="structvbi__page.html" title="Formatted Teletext or Closed Caption page.">vbi_page</a>. <a href="group__Page.html#g75a5fe9d9e5f1b6981030c99aa488270">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_vbi_inline vbi_bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Page.html#g159f48fade6a7828ea2c8684111ce438">vbi_is_print</a> (unsigned int unicode)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_vbi_inline vbi_bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Page.html#gabd8aa75f6f863b959538a17ac4b0b5f">vbi_is_gfx</a> (unsigned int unicode)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">_vbi_inline vbi_bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Page.html#g91d143565aca5277b8b28c5f4ebc4ca2">vbi_is_drcs</a> (unsigned int unicode)</td></tr>
</table>
<hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="g5cc7aca92393625043f2e531f238ee32"></a><!-- doxytag: member="format.h::vbi_color" ref="g5cc7aca92393625043f2e531f238ee32" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__Page.html#g5cc7aca92393625043f2e531f238ee32">vbi_color</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Index into the vbi_page->color_map.
<p>
The enumerated color names refer to the Teletext and Closed Caption base palette of eight colors. Note however the color_map really has 40 entries for Teletext Level 2.5+, 32 of which are redefinable, the remaining eight are private colors of libzvbi e. g. for navigational information. So these symbols may not necessarily correspond to the respective color.
</div>
</div><p>
<a class="anchor" name="gb3f248dc4cf23026c2da167b428a5162"></a><!-- doxytag: member="format.h::vbi_opacity" ref="gb3f248dc4cf23026c2da167b428a5162" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__Page.html#gb3f248dc4cf23026c2da167b428a5162">vbi_opacity</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Defines the opacity of a <a class="el" href="structvbi__char.html" title="Attributed character.">vbi_char</a> and <a class="el" href="structvbi__page.html" title="Formatted Teletext or Closed Caption page.">vbi_page</a> border.
<p>
Teletext Level 2.5 defines a special transparent color which permits unusual characters with transparent foreground, opaque background. For simplicity this type of opacity has been omitted. Also renderers shall rely on the opacity attribute and not attempt to interpret the color value as transparency indicator. <dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="ggb3f248dc4cf23026c2da167b428a51620f8eacb19833c4505d76d57f0d28fd74"></a><!-- doxytag: member="VBI_TRANSPARENT_SPACE" ref="ggb3f248dc4cf23026c2da167b428a51620f8eacb19833c4505d76d57f0d28fd74" args="" -->VBI_TRANSPARENT_SPACE</em> </td><td>
This page is supposed to be overlayed onto video, with video displayed in place of this character (or the page border). In other words the character is a space (vbi_char->unicode = U+0020) and the glyph background is transparent. If desired the renderer may also fall back to VBI_SEMI_TRANSPARENT or VBI_OPAQUE mode. For this case vbi_char->background names the color to use as the semi-transparent or opaque background.<p>
VBI_TRANSPARENT_SPACE is the opacity of subtitle pages (both border and characters, while the 'boxed' words are marked as VBI_SEMI_TRANSPARENT), but can also occur on a mainly VBI_OPAQUE page to create a 'window' effect. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="ggb3f248dc4cf23026c2da167b428a516272062319b73325984c2b870f99edd4b7"></a><!-- doxytag: member="VBI_TRANSPARENT_FULL" ref="ggb3f248dc4cf23026c2da167b428a516272062319b73325984c2b870f99edd4b7" args="" -->VBI_TRANSPARENT_FULL</em> </td><td>
Display video instead of the background color. Here the character is <em>not</em> a space and shall be displayed in vbi_char->foreground color. Only in the background of the character video shall look through. Again the renderer may fall back to VBI_SEMI_TRANSPARENT or VBI_OPAQUE. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="ggb3f248dc4cf23026c2da167b428a51622511d5030ed1055b9f8a4413fb7826da"></a><!-- doxytag: member="VBI_SEMI_TRANSPARENT" ref="ggb3f248dc4cf23026c2da167b428a51622511d5030ed1055b9f8a4413fb7826da" args="" -->VBI_SEMI_TRANSPARENT</em> </td><td>
Alpha blend video into background color, the character background becomes translucent. This is the opacity used for 'boxed' text on an otherwise VBI_TRANSPARENT_SPACE page, typically a subtitle or Teletext newsflash page. The renderer may fall back to VBI_OPAQUE. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="ggb3f248dc4cf23026c2da167b428a51620e7504f00aebfac0f1542ffd54d2e74d"></a><!-- doxytag: member="VBI_OPAQUE" ref="ggb3f248dc4cf23026c2da167b428a51620e7504f00aebfac0f1542ffd54d2e74d" args="" -->VBI_OPAQUE</em> </td><td>
Display foreground and background color. Showing foreground or background transparent instead is not recommended because the editor may have swapped foreground and background color, then replaced a glyph by its inverse image, so one cannot really know if the character foreground or background will appear transparent. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g75a5fe9d9e5f1b6981030c99aa488270"></a><!-- doxytag: member="format.h::vbi_size" ref="g75a5fe9d9e5f1b6981030c99aa488270" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__Page.html#g75a5fe9d9e5f1b6981030c99aa488270">vbi_size</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Defines the size of a <a class="el" href="structvbi__char.html" title="Attributed character.">vbi_char</a> in a <a class="el" href="structvbi__page.html" title="Formatted Teletext or Closed Caption page.">vbi_page</a>.
<p>
Double width or height characters expand into the next column right and/or next row below.<p>
Scanning two rows left to right, you will find<br>
<pre>
VBI_NORMAL_SIZE | VBI_DOUBLE_WIDTH VBI_OVER_TOP | VBI_DOUBLE_HEIGHT | VBI_DOUBLE_SIZE VBI_OVER_TOP
x | x x | VBI_DOUBLE_HEIGHT2 | VBI_DOUBLE_SIZE2 VBI_OVER_BOTTOM
</pre><p>
A VBI_DOUBLE_HEIGHT2, VBI_DOUBLE_SIZE2, VBI_OVER_TOP, VBI_OVER_BOTTOM <a class="el" href="structvbi__char.html" title="Attributed character.">vbi_char</a> has the same character unicode and attributes as the top/left anchor. Partial characters (like a single VBI_DOUBLE_HEIGHT2) will not appear, so VBI_DOUBLE_HEIGHT2, VBI_DOUBLE_SIZE2, VBI_OVER_TOP, VBI_OVER_BOTTOM can be safely ignored when scanning the page.
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g159f48fade6a7828ea2c8684111ce438"></a><!-- doxytag: member="lang.h::vbi_is_print" ref="g159f48fade6a7828ea2c8684111ce438" args="(unsigned int unicode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_vbi_inline vbi_bool vbi_is_print </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>unicode</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>unicode</em> </td><td>Unicode as in <a class="el" href="structvbi__char.html" title="Attributed character.">vbi_char</a>.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>TRUE</code> if <em>unicode</em> represents a Teletext or Closed Caption printable character. This excludes Teletext Arabic characters (which are represented by private codes U+E600 ... U+E7FF until the conversion table is ready), the Teletext Turkish currency sign U+E800 which is not representable in Unicode, the Teletext G1 Block Mosaic and G3 Smooth Mosaics and Line Drawing Set, with codes U+EE00 ... U+EFFF, and Teletext DRCS coded U+F000 ... U+F7FF. </dd></dl>
</div>
</div><p>
<a class="anchor" name="gabd8aa75f6f863b959538a17ac4b0b5f"></a><!-- doxytag: member="lang.h::vbi_is_gfx" ref="gabd8aa75f6f863b959538a17ac4b0b5f" args="(unsigned int unicode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_vbi_inline vbi_bool vbi_is_gfx </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>unicode</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>unicode</em> </td><td>Unicode as in <a class="el" href="structvbi__char.html" title="Attributed character.">vbi_char</a>.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>TRUE</code> if <em>unicode</em> represents a Teletext G1 Block Mosaic or G3 Smooth Mosaics and Line Drawing Set, that is a code in range U+EE00 ... U+EFFF. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g91d143565aca5277b8b28c5f4ebc4ca2"></a><!-- doxytag: member="lang.h::vbi_is_drcs" ref="g91d143565aca5277b8b28c5f4ebc4ca2" args="(unsigned int unicode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_vbi_inline vbi_bool vbi_is_drcs </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>unicode</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>unicode</em> </td><td>Unicode as in <a class="el" href="structvbi__char.html" title="Attributed character.">vbi_char</a>.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>TRUE</code> if <em>unicode</em> represents a Teletext DRCS (Dynamically Redefinable Character), that is a code in range U+F000 ... U+F7FF. </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>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
1af184c486f5d5f476d50602700ee0a0
>
files
>
42
