<!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: Character set conversion functions</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>Character set conversion functions<br>
<small>
[<a class="el" href="group__LowDec.html">Low Level Decoding</a>]</small>
</h1>Helper functions to convert between Closed Caption, Teletext, Unicode and the locale character set.
<a href="#_details">More...</a>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gca955407d450ed6065f2e219c9f879e6"></a><!-- doxytag: member="Conv::VBI_NUL_TERMINATED" ref="gca955407d450ed6065f2e219c9f879e6" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>VBI_NUL_TERMINATED</b> -1</td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Conv.html#g80b5eb70475e34a24733e5ccaa3e9b9f">vbi_strlen_ucs2</a> (const uint16_t *src)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Conv.html#gc19f92bda7624f3d096ee58b388840fc">vbi_strndup_iconv_ucs2</a> (const char *dst_codeset, const uint16_t *src, long src_length, int repl_char)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Conv.html#gb360448d13ec1cd3c4a7a4babb07243f">vbi_strndup_iconv</a> (const char *dst_codeset, const char *src_codeset, const char *src, unsigned long src_size, int repl_char)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">vbi_bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Conv.html#gac3f3b17d6fe089ea66541f8d14255e6">vbi_fputs_iconv</a> (FILE *fp, const char *dst_codeset, const char *src_codeset, const char *src, unsigned long src_size, int repl_char)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">vbi_bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Conv.html#geffd10bd2ffee99cd428b2268c380f4b">vbi_fputs_iconv_ucs2</a> (FILE *fp, const char *dst_codeset, const uint16_t *src, long src_length, int repl_char)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Conv.html#g69e68f14e65c01622db558df3e6a11f6">vbi_locale_codeset</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Conv.html#ged83a362d4a7e408f5c42a82fa02e356">vbi_strndup_iconv_caption</a> (const char *dst_codeset, const char *src, long src_length, int repl_char) _vbi_alloc</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Conv.html#gdbe555b3d116e51d6accc7ec45fa5ef6">vbi_caption_unicode</a> (unsigned int c, vbi_bool to_upper)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Helper functions to convert between Closed Caption, Teletext, Unicode and the locale character set. <hr><h2>Function Documentation</h2>
<a class="anchor" name="g80b5eb70475e34a24733e5ccaa3e9b9f"></a><!-- doxytag: member="conv.c::vbi_strlen_ucs2" ref="g80b5eb70475e34a24733e5ccaa3e9b9f" args="(const uint16_t *src)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long vbi_strlen_ucs2 </td>
<td>(</td>
<td class="paramtype">const uint16_t * </td>
<td class="paramname"> <em>src</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>src</em> </td><td>NUL-terminated UCS-2 string.</td></tr>
</table>
</dl>
Counts the characters in the string, up to and excluding the terminating NUL.<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.2.23 </dd></dl>
</div>
</div><p>
<a class="anchor" name="gc19f92bda7624f3d096ee58b388840fc"></a><!-- doxytag: member="conv.c::vbi_strndup_iconv_ucs2" ref="gc19f92bda7624f3d096ee58b388840fc" args="(const char *dst_codeset, const uint16_t *src, long src_length, int repl_char)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * vbi_strndup_iconv_ucs2 </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>dst_codeset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint16_t * </td>
<td class="paramname"> <em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"> <em>src_length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>repl_char</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></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>dst_codeset</em> </td><td>Character set name for iconv() conversion, for example "ISO-8859-1". When <code>NULL</code> the default is UTF-8. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>Source string in UCS-2 format, can be <code>NULL</code>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>src_length</em> </td><td>Number of characters (not bytes) in the source string. Can be -1 if the string is NUL terminated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>repl_char</em> </td><td>UCS-2 replacement for characters which are not representable in <em>dst_codeset</em>. When zero the function will fail if the source buffer contains unrepresentable characters.</td></tr>
</table>
</dl>
Converts a UCS-2 string with iconv() and writes the result with a terminating NUL character into a newly allocated buffer.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the allocated buffer. You must free() the buffer when it is no longer needed. The function returns <code>NULL</code> when the conversion fails, when it runs out of memory or when <em>src</em> is <code>NULL</code>.</dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.2.23 </dd></dl>
</div>
</div><p>
<a class="anchor" name="gb360448d13ec1cd3c4a7a4babb07243f"></a><!-- doxytag: member="conv.c::vbi_strndup_iconv" ref="gb360448d13ec1cd3c4a7a4babb07243f" args="(const char *dst_codeset, const char *src_codeset, const char *src, unsigned long src_size, int repl_char)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * vbi_strndup_iconv </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>dst_codeset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>src_codeset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"> <em>src_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>repl_char</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></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>dst_codeset</em> </td><td>Character set name for iconv() conversion, for example "ISO-8859-1". When <code>NULL</code> the default is UTF-8. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>src_codeset</em> </td><td>Character set name for iconv() conversion, for example "ISO-8859-1". When <code>NULL</code> the default is UTF-8. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>Source buffer, can be <code>NULL</code>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>src_size</em> </td><td>Number of bytes in the source string (excluding the terminating NUL, if any). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>repl_char</em> </td><td>UCS-2 replacement for characters which are not representable in <em>dst_codeset</em>. When zero the function will fail if the source buffer contains unrepresentable characters.</td></tr>
</table>
</dl>
Converts a string with iconv() and writes the result with a terminating NUL character into a newly allocated buffer.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the allocated buffer. You must free() the buffer when it is no longer needed. The function returns <code>NULL</code> when the conversion fails, when it runs out of memory or when <em>src</em> is <code>NULL</code>.</dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.2.23 </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="examples_2network_8c-example.html#a6">examples/network.c</a>.</dl>
</div>
</div><p>
<a class="anchor" name="gac3f3b17d6fe089ea66541f8d14255e6"></a><!-- doxytag: member="conv.c::vbi_fputs_iconv" ref="gac3f3b17d6fe089ea66541f8d14255e6" args="(FILE *fp, const char *dst_codeset, const char *src_codeset, const char *src, unsigned long src_size, int repl_char)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vbi_bool vbi_fputs_iconv </td>
<td>(</td>
<td class="paramtype">FILE * </td>
<td class="paramname"> <em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>dst_codeset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>src_codeset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"> <em>src_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>repl_char</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></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>fp</em> </td><td>Output file. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dst_codeset</em> </td><td>Character set name for iconv() conversion, for example "ISO-8859-1". When <code>NULL</code> the default is UTF-8. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>src_codeset</em> </td><td>Character set name for iconv() conversion, for example "ISO-8859-1". When <code>NULL</code> the default is UTF-8. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>Source buffer, can be <code>NULL</code>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>src_size</em> </td><td>Number of bytes in the source string (excluding the terminating NUL, if any). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>repl_char</em> </td><td>UCS-2 replacement for characters which are not representable in <em>dst_codeset</em>. When zero the function will fail if the source buffer contains unrepresentable characters.</td></tr>
</table>
</dl>
Converts a string with iconv() and writes the result into the given file.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>FALSE on failure.</dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.2.23 </dd></dl>
</div>
</div><p>
<a class="anchor" name="geffd10bd2ffee99cd428b2268c380f4b"></a><!-- doxytag: member="conv.c::vbi_fputs_iconv_ucs2" ref="geffd10bd2ffee99cd428b2268c380f4b" args="(FILE *fp, const char *dst_codeset, const uint16_t *src, long src_length, int repl_char)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vbi_bool vbi_fputs_iconv_ucs2 </td>
<td>(</td>
<td class="paramtype">FILE * </td>
<td class="paramname"> <em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>dst_codeset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint16_t * </td>
<td class="paramname"> <em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"> <em>src_length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>repl_char</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></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>fp</em> </td><td>Output file. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dst_codeset</em> </td><td>Character set name for iconv() conversion, for example "ISO-8859-1". When <code>NULL</code> the default is UTF-8. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>Source string in UCS-2 format, can be <code>NULL</code>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>src_length</em> </td><td>Number of characters (not bytes) in the source string. Can be -1 if the string is NUL terminated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>repl_char</em> </td><td>UCS-2 replacement for characters which are not representable in <em>dst_codeset</em>. When zero the function will fail if the source buffer contains unrepresentable characters.</td></tr>
</table>
</dl>
Converts a UCS-2 string with iconv() and writes the result into the given file.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>FALSE on failure.</dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.2.23 </dd></dl>
</div>
</div><p>
<a class="anchor" name="g69e68f14e65c01622db558df3e6a11f6"></a><!-- doxytag: member="conv.c::vbi_locale_codeset" ref="g69e68f14e65c01622db558df3e6a11f6" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * vbi_locale_codeset </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the character encoding used by the current locale, for example "UTF-8". <code>NULL</code> if unknown.<p>
Note applications must call <div class="fragment"><pre class="fragment"> setlocale (LC_ALL, <span class="stringliteral">""</span>);
</pre></div> to use the locale specified by the environment. The default C locale uses ASCII encoding.<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.2.23 </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="examples_2network_8c-example.html#a7">examples/network.c</a>.</dl>
</div>
</div><p>
<a class="anchor" name="ged83a362d4a7e408f5c42a82fa02e356"></a><!-- doxytag: member="conv.h::vbi_strndup_iconv_caption" ref="ged83a362d4a7e408f5c42a82fa02e356" args="(const char *dst_codeset, const char *src, long src_length, int repl_char) _vbi_alloc" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* vbi_strndup_iconv_caption </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>dst_codeset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"> <em>src_length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>repl_char</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></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>dst_codeset</em> </td><td>Character set name for iconv() conversion, for example "ISO-8859-1". When <code>NULL</code> the default is UTF-8. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>String of Closed Caption characters, can be <code>NULL</code>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>src_length</em> </td><td>Number of characters (= bytes) in the source string. Can be -1 if the <em>src</em> string is NUL terminated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>repl_char</em> </td><td>UCS-2 replacement for characters which are not representable in <em>dst_codeset</em>. When zero the function will fail if the source buffer contains unrepresentable characters.</td></tr>
</table>
</dl>
Converts a string of EIA 608 Closed Caption characters to another format and stores the result with a terminating NUL in a newly allocated buffer. The function ignores parity bits and the bytes 0x00 ... 0x1F except two byte special and extended characters (e.g. music note 0x11 0x37).<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__Conv.html#gdbe555b3d116e51d6accc7ec45fa5ef6">vbi_caption_unicode()</a></dd></dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the allocated buffer. You must free() the buffer when it is no longer needed. The function returns <code>NULL</code> when the source buffer contains invalid two byte characters, when the conversion fails, when it runs out of memory or when <em>src</em> is <code>NULL</code>.</dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.2.23 </dd></dl>
</div>
</div><p>
<a class="anchor" name="gdbe555b3d116e51d6accc7ec45fa5ef6"></a><!-- doxytag: member="lang.c::vbi_caption_unicode" ref="gdbe555b3d116e51d6accc7ec45fa5ef6" args="(unsigned int c, vbi_bool to_upper)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int vbi_caption_unicode </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vbi_bool </td>
<td class="paramname"> <em>to_upper</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></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>c</em> </td><td>Character code in range 0x20 ... 0x7F, 0x1130 ... 0x113F, 0x1930 ... 0x193F, 0x1220 ... 0x123F, 0x1A20 ... 0x1A3F, 0x1320 ... 0x133F, 0x1B20 ... 0x1B3F. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>to_upper</em> </td><td>Convert the character to upper case. (Often programs are captioned in all upper case, but except for one character the basic and special CC character sets contain only lower case accented characters.)</td></tr>
</table>
</dl>
Converts a Closed Caption character code to Unicode. Codes in range 0x1130 to 0x1B3F are "special characters" and "extended characters" (e.g. caption command 11 37).<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__Conv.html#ged83a362d4a7e408f5c42a82fa02e356">vbi_strndup_iconv_caption()</a></dd></dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Unicode value or 0 if <em>c</em> is outside the valid ranges.</dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.2.23 </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
>
30
