mp3common_8h_source.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2 <html xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/> 6 <meta name="generator" content="Doxygen 1.8.14"/> 7 <meta name="viewport" content="width=device-width, initial-scale=1"/> 8 <title>Adafruit mp3: src/mp3common.h Source File</title> 9 <link href="tabs.css" rel="stylesheet" type="text/css"/> 10 <script type="text/javascript" src="jquery.js"></script> 11 <script type="text/javascript" src="dynsections.js"></script> 12 <link href="search/search.css" rel="stylesheet" type="text/css"/> 13 <script type="text/javascript" src="search/searchdata.js"></script> 14 <script type="text/javascript" src="search/search.js"></script> 15 <link href="doxygen.css" rel="stylesheet" type="text/css" /> 16 </head> 17 <body> 18 <div id="top"><!-- do not remove this div, it is closed by doxygen! --> 19 <div id="titlearea"> 20 <table cellspacing="0" cellpadding="0"> 21 <tbody> 22 <tr style="height: 56px;"> 23 <td id="projectalign" style="padding-left: 0.5em;"> 24 <div id="projectname">Adafruit mp3 25 </div> 26 </td> 27 </tr> 28 </tbody> 29 </table> 30 </div> 31 <!-- end header part --> 32 <!-- Generated by Doxygen 1.8.14 --> 33 <script type="text/javascript"> 34 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 35 var searchBox = new SearchBox("searchBox", "search",false,'Search'); 36 /* @license-end */ 37 </script> 38 <script type="text/javascript" src="menudata.js"></script> 39 <script type="text/javascript" src="menu.js"></script> 40 <script type="text/javascript"> 41 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 42 $(function() { 43 initMenu('',true,false,'search.php','Search'); 44 $(document).ready(function() { init_search(); }); 45 }); 46 /* @license-end */</script> 47 <div id="main-nav"></div> 48 <!-- window showing the filter options --> 49 <div id="MSearchSelectWindow" 50 onmouseover="return searchBox.OnSearchSelectShow()" 51 onmouseout="return searchBox.OnSearchSelectHide()" 52 onkeydown="return searchBox.OnSearchSelectKey(event)"> 53 </div> 54 55 <!-- iframe showing the search results (closed by default) --> 56 <div id="MSearchResultsWindow"> 57 <iframe src="javascript:void(0)" frameborder="0" 58 name="MSearchResults" id="MSearchResults"> 59 </iframe> 60 </div> 61 62 <div id="nav-path" class="navpath"> 63 <ul> 64 <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul> 65 </div> 66 </div><!-- top --> 67 <div class="header"> 68 <div class="headertitle"> 69 <div class="title">mp3common.h</div> </div> 70 </div><!--header--> 71 <div class="contents"> 72 <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* ***** BEGIN LICENSE BLOCK ***** </span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Version: RCSL 1.0/RPSL 1.0 </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"> * Portions Copyright (c) 1995-2002 RealNetworks, Inc. All Rights Reserved. </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"> * The contents of this file, and the files included with this file, are </span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * subject to the current version of the RealNetworks Public Source License </span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * Version 1.0 (the "RPSL") available at </span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * http://www.helixcommunity.org/content/rpsl unless you have licensed </span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * the file under the RealNetworks Community Source License Version 1.0 </span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * (the "RCSL") available at http://www.helixcommunity.org/content/rcsl, </span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * in which case the RCSL will apply. You may also obtain the license terms </span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * directly from RealNetworks. You may not use this file except in </span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * compliance with the RPSL or, if you have a valid RCSL with RealNetworks </span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * applicable to this file, the RCSL. Please see the applicable RPSL or </span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * RCSL for the rights, obligations and limitations governing use of the </span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * contents of the file. </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"> * This file is part of the Helix DNA Technology. RealNetworks is the </span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * developer of the Original Code and owns the copyrights in the portions </span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * it created. </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"> * This file, and the files included with this file, is distributed and made </span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER </span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS ALL SUCH WARRANTIES, </span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS </span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. </span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * </span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * Technology Compatibility Kit Test Suite(s) Location: </span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * http://www.helixcommunity.org/content/tck </span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * </span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * Contributor(s): </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"> * ***** END LICENSE BLOCK ***** */</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">/**************************************************************************************</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * Fixed-point MP3 decoder</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * Jon Recker (jrecker@real.com), Ken Cooke (kenc@real.com)</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * June 2003</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> *</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * mp3common.h - implementation-independent API's, datatypes, and definitions</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> **************************************************************************************/</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#ifndef _MP3COMMON_H</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#define _MP3COMMON_H</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#include "mp3dec.h"</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#include "statname.h"</span> <span class="comment">/* do name-mangling for static linking */</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#define MAX_SCFBD 4 </span><span class="comment">/* max scalefactor bands per channel */</span><span class="preprocessor"></span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#define NGRANS_MPEG1 2</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor">#define NGRANS_MPEG2 1</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">/* 11-bit syncword if MPEG 2.5 extensions are enabled */</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#define SYNCWORDH 0xff</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#define SYNCWORDL 0xe0</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">/* 12-bit syncword if MPEG 1,2 only are supported </span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> * #define SYNCWORDH 0xff</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * #define SYNCWORDL 0xf0</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> */</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="struct__MP3DecInfo.html"> 63</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct__MP3DecInfo.html">_MP3DecInfo</a> {</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">/* pointers to platform-specific data structures */</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">void</span> *FrameHeaderPS;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">void</span> *SideInfoPS;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">void</span> *ScaleFactorInfoPS;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">void</span> *HuffmanInfoPS;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordtype">void</span> *DequantInfoPS;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">void</span> *IMDCTInfoPS;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">void</span> *SubbandInfoPS;</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="comment">/* buffer which must be large enough to hold largest possible main_data section */</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> mainBuf[MAINBUF_SIZE];</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="comment">/* special info for "free" bitrate files */</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordtype">int</span> freeBitrateFlag;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">int</span> freeBitrateSlots;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="comment">/* user-accessible info */</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordtype">int</span> bitrate;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">int</span> nChans;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">int</span> samprate;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">int</span> nGrans; <span class="comment">/* granules per frame */</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">int</span> nGranSamps; <span class="comment">/* samples per granule */</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">int</span> nSlots;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">int</span> layer;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  MPEGVersion version;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordtype">int</span> mainDataBegin;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordtype">int</span> mainDataBytes;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordtype">int</span> part23Length[MAX_NGRAN][MAX_NCHAN];</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> } <a class="code" href="struct__MP3DecInfo.html">MP3DecInfo</a>;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="struct__SFBandTable.html"> 97</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct__SFBandTable.html">_SFBandTable</a> {</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordtype">short</span> l[23];</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordtype">short</span> s[14];</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> } <a class="code" href="struct__SFBandTable.html">SFBandTable</a>;</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment">/* decoder functions which must be implemented for each platform */</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <a class="code" href="struct__MP3DecInfo.html">MP3DecInfo</a> *AllocateBuffers(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="keywordtype">void</span> FreeBuffers(<a class="code" href="struct__MP3DecInfo.html">MP3DecInfo</a> *mp3DecInfo);</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="keywordtype">int</span> CheckPadBit(<a class="code" href="struct__MP3DecInfo.html">MP3DecInfo</a> *mp3DecInfo);</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="keywordtype">int</span> UnpackFrameHeader(<a class="code" href="struct__MP3DecInfo.html">MP3DecInfo</a> *mp3DecInfo, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buf);</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="keywordtype">int</span> UnpackSideInfo(<a class="code" href="struct__MP3DecInfo.html">MP3DecInfo</a> *mp3DecInfo, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buf);</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="keywordtype">int</span> DecodeHuffman(<a class="code" href="struct__MP3DecInfo.html">MP3DecInfo</a> *mp3DecInfo, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buf, <span class="keywordtype">int</span> *bitOffset, <span class="keywordtype">int</span> huffBlockBits, <span class="keywordtype">int</span> gr, <span class="keywordtype">int</span> ch);</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="keywordtype">int</span> Dequantize(<a class="code" href="struct__MP3DecInfo.html">MP3DecInfo</a> *mp3DecInfo, <span class="keywordtype">int</span> gr);</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="keywordtype">int</span> IMDCT(<a class="code" href="struct__MP3DecInfo.html">MP3DecInfo</a> *mp3DecInfo, <span class="keywordtype">int</span> gr, <span class="keywordtype">int</span> ch);</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="keywordtype">int</span> UnpackScaleFactors(<a class="code" href="struct__MP3DecInfo.html">MP3DecInfo</a> *mp3DecInfo, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buf, <span class="keywordtype">int</span> *bitOffset, <span class="keywordtype">int</span> bitsAvail, <span class="keywordtype">int</span> gr, <span class="keywordtype">int</span> ch);</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="keywordtype">int</span> Subband(<a class="code" href="struct__MP3DecInfo.html">MP3DecInfo</a> *mp3DecInfo, <span class="keywordtype">short</span> *pcmBuf);</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment">/* mp3tabs.c - global ROM tables */</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">int</span> samplerateTab[3][3];</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">short</span> bitrateTab[3][3][15];</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">short</span> samplesPerFrameTab[3][3];</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">short</span> bitsPerSlotTab[3];</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">short</span> sideBytesTab[3][2];</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">short</span> slotTab[3][3][15];</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="keyword">extern</span> <span class="keyword">const</span> <a class="code" href="struct__SFBandTable.html">SFBandTable</a> sfBandTable[3][3];</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="preprocessor">#endif </span><span class="comment">/* _MP3COMMON_H */</span><span class="preprocessor"></span></div><div class="ttc" id="struct__MP3DecInfo_html"><div class="ttname"><a href="struct__MP3DecInfo.html">_MP3DecInfo</a></div><div class="ttdef"><b>Definition:</b> mp3common.h:63</div></div> 73 <div class="ttc" id="struct__SFBandTable_html"><div class="ttname"><a href="struct__SFBandTable.html">_SFBandTable</a></div><div class="ttdef"><b>Definition:</b> mp3common.h:97</div></div> 74 </div><!-- fragment --></div><!-- contents --> 75 <!-- start footer part --> 76 <hr class="footer"/><address class="footer"><small> 77 Generated by  <a href="http://www.doxygen.org/index.html"> 78 <img class="footer" src="doxygen.png" alt="doxygen"/> 79 </a> 1.8.14 80 </small></address> 81 </body> 82 </html>