<!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>libg722_1: g192_bit_stream.h Source File</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="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); $(window).load(resizeHeight); </script> <link href="css.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">libg722_1  <span id="projectnumber">0.1.0</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><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul> </div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('g192__bit__stream_8h_source.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <div class="title">g192_bit_stream.h</div> </div> </div><!--header--> <div class="contents"> <a href="g192__bit__stream_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * broadvoice - a library for the BroadVoice 16 and 32 codecs</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * g192_bit_stream.h</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Copyright 2008-2009 Steve Underwood <steveu@coppice.org></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * All rights reserved.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * This program is free software; you can redistribute it and/or modify</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * it under the terms of the GNU Lesser General Public License version 2.1,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * as published by the Free Software Foundation.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * This program is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * GNU Lesser General Public License for more details.</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> *</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * License along with this program; if not, write to the Free Software</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> *</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * $Id: g192_bit_stream.h,v 1.1.1.1 2009/11/19 12:10:48 steveu Exp $</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> */</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">/*! \file */</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#if !defined(_G192_BIT_STREAM_H_)</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#define _G192_BIT_STREAM_H_</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"></span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">/*! \page g192_bit_stream_page ITU G.192 codec bit stream handling</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">\section g192_bit_stream_page_sec_1 What does it do?</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"></span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">\section g192_bit_stream_page_sec_2 How does it work?</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">*/</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">enum</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  ITU_CODEC_BITSTREAM_PACKED = 0,</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  ITU_CODEC_BITSTREAM_G192 = 1</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> };</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#if defined(__cplusplus)</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> {</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"></span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">/*! \brief Write a frame of data to an output file.</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> \param out_data The buffer for the data to be written.</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> \param number_of_bits The number of bits to be written.</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> \param mode 0 = continuous, 1 = ITU G.192 codec bitstream format.</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> \param fp_bitstream The file context to be written to.*/</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="keywordtype">void</span> <a class="code" href="g192__bit__stream_8h.html#a1f6d9764dcb29ba535bf780bcc949848">itu_codec_bitstream_write</a>(<span class="keyword">const</span> uint8_t out_data[],</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">int</span> number_of_bits,</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">int</span> mode,</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  FILE *fp_bitstream);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"></span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">/*! \brief Read a frame of data from an input file.</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> \param in_data The buffer for the data to be read.</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> \param p_frame_error_flags ???.</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> \param number_of_bits The number of bits to be read.</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> \param mode 0 = continuous, 1 = ITU G.192 codec bitstream format.</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> \param fp_bitstream The file context to be read from.</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> \return The number of words read. */</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="keywordtype">int</span> <a class="code" href="g192__bit__stream_8h.html#a08dcf3ef11fc3de34deb68982a9dd56b">itu_codec_bitstream_read</a>(uint8_t in_data[],</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  int16_t *p_frame_error_flag,</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">int</span> number_of_bits,</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">int</span> mode,</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  FILE *fp_bitstream);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#if defined(__cplusplus)</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> }</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment">/*- End of file ------------------------------------------------------------*/</span></div><div class="ttc" id="g192__bit__stream_8h_html_a1f6d9764dcb29ba535bf780bcc949848"><div class="ttname"><a href="g192__bit__stream_8h.html#a1f6d9764dcb29ba535bf780bcc949848">itu_codec_bitstream_write</a></div><div class="ttdeci">void itu_codec_bitstream_write(const uint8_t out_data[], int number_of_bits, int mode, FILE *fp_bitstream)</div><div class="ttdoc">Write a frame of data to an output file. </div><div class="ttdef"><b>Definition:</b> g192_bit_stream.c:62</div></div> <div class="ttc" id="g192__bit__stream_8h_html_a08dcf3ef11fc3de34deb68982a9dd56b"><div class="ttname"><a href="g192__bit__stream_8h.html#a08dcf3ef11fc3de34deb68982a9dd56b">itu_codec_bitstream_read</a></div><div class="ttdeci">int itu_codec_bitstream_read(uint8_t in_data[], int16_t *p_frame_error_flag, int number_of_bits, int mode, FILE *fp_bitstream)</div><div class="ttdoc">Read a frame of data from an input file. </div><div class="ttdef"><b>Definition:</b> g192_bit_stream.c:94</div></div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="dir_59425e443f801f1f2fd8bbe4959a3ccf.html">tests</a></li><li class="navelem"><a class="el" href="g192__bit__stream_8h.html">g192_bit_stream.h</a></li> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li> </ul> </div> </body> </html>