/usr/share/doc/libquicktime-doc/apiref/group__audio.html is in libquicktime-doc 2:1.2.4-10+deb9u1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 | <!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libquicktime: Audio</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="doxygen.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">libquicktime
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#groups">Modules</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Audio</div> </div>
</div><!--header-->
<div class="contents">
<p>Audio related definitions and functions.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__audio__decode"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__decode.html">Audio decoding</a></td></tr>
<tr class="memdesc:group__audio__decode"><td class="mdescLeft"> </td><td class="mdescRight">Audio related definitions and functions (reading) <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__audio__encode"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__encode.html">Audio encoding</a></td></tr>
<tr class="memdesc:group__audio__encode"><td class="mdescLeft"> </td><td class="mdescRight">Audio related definitions and functions (writing) <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__multichannel"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__multichannel.html">Multichannel support</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga1bc8892b20c04e8d9dbbed7666e85dd8"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio.html#ga1bc8892b20c04e8d9dbbed7666e85dd8">lqt_sample_format_t</a> { <br />
  <a class="el" href="group__audio.html#gga1bc8892b20c04e8d9dbbed7666e85dd8acc93dc9b43e854a63f09177cc9a887b9">LQT_SAMPLE_UNDEFINED</a> = 0,
<br />
  <a class="el" href="group__audio.html#gga1bc8892b20c04e8d9dbbed7666e85dd8a118658720ae0b9750c33a28f15954a38">LQT_SAMPLE_INT8</a>,
<br />
  <a class="el" href="group__audio.html#gga1bc8892b20c04e8d9dbbed7666e85dd8af1350eabe516c4bb1c7f27f12046415a">LQT_SAMPLE_UINT8</a>,
<br />
  <a class="el" href="group__audio.html#gga1bc8892b20c04e8d9dbbed7666e85dd8a60d6a8c3a788b1b75f6e7aded988b2a6">LQT_SAMPLE_INT16</a>,
<br />
  <a class="el" href="group__audio.html#gga1bc8892b20c04e8d9dbbed7666e85dd8a898817c17919e3fce7aec54ffd646a6b">LQT_SAMPLE_INT32</a>,
<br />
  <a class="el" href="group__audio.html#gga1bc8892b20c04e8d9dbbed7666e85dd8abc7fa82547e45f59a8fc557b8570f347">LQT_SAMPLE_FLOAT</a>,
<br />
  <a class="el" href="group__audio.html#gga1bc8892b20c04e8d9dbbed7666e85dd8ab401e92dfa324c2ae18270ef0088f2a5">LQT_SAMPLE_DOUBLE</a>
<br />
}<tr class="memdesc:ga1bc8892b20c04e8d9dbbed7666e85dd8"><td class="mdescLeft"> </td><td class="mdescRight">Sample format definitions for audio. <a href="group__audio.html#ga1bc8892b20c04e8d9dbbed7666e85dd8">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ga1bc8892b20c04e8d9dbbed7666e85dd8"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga282a31a22a6819423512b93a0e3595aa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio.html#ga282a31a22a6819423512b93a0e3595aa">lqt_set_audio_parameter</a> (<a class="el" href="group__general.html#gaef65e7300455a3b25eafc7485ec2efa4">quicktime_t</a> *file, int track, const char *key, const void *value)</td></tr>
<tr class="memdesc:ga282a31a22a6819423512b93a0e3595aa"><td class="mdescLeft"> </td><td class="mdescRight">Set a codec parameter for an audio track. <a href="#ga282a31a22a6819423512b93a0e3595aa">More...</a><br /></td></tr>
<tr class="separator:ga282a31a22a6819423512b93a0e3595aa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab58293547a1b774cc938d574df9fedbe"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio.html#gab58293547a1b774cc938d574df9fedbe">lqt_sample_format_to_string</a> (<a class="el" href="group__audio.html#ga1bc8892b20c04e8d9dbbed7666e85dd8">lqt_sample_format_t</a> sampleformat)</td></tr>
<tr class="memdesc:gab58293547a1b774cc938d574df9fedbe"><td class="mdescLeft"> </td><td class="mdescRight">Get a human readable description for a sample format. <a href="#gab58293547a1b774cc938d574df9fedbe">More...</a><br /></td></tr>
<tr class="separator:gab58293547a1b774cc938d574df9fedbe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabde4021e8da716ad38a91c238aa40df0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__audio.html#ga1bc8892b20c04e8d9dbbed7666e85dd8">lqt_sample_format_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio.html#gabde4021e8da716ad38a91c238aa40df0">lqt_get_sample_format</a> (<a class="el" href="group__general.html#gaef65e7300455a3b25eafc7485ec2efa4">quicktime_t</a> *file, int track)</td></tr>
<tr class="memdesc:gabde4021e8da716ad38a91c238aa40df0"><td class="mdescLeft"> </td><td class="mdescRight">Return the sample format used natively by the codec. <a href="#gabde4021e8da716ad38a91c238aa40df0">More...</a><br /></td></tr>
<tr class="separator:gabde4021e8da716ad38a91c238aa40df0"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Audio related definitions and functions. </p>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga1bc8892b20c04e8d9dbbed7666e85dd8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1bc8892b20c04e8d9dbbed7666e85dd8">◆ </a></span>lqt_sample_format_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__audio.html#ga1bc8892b20c04e8d9dbbed7666e85dd8">lqt_sample_format_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sample format definitions for audio. </p>
<p>This defines the datatype for audio samples, which will be used by a particular codec. You'll need this, if you want to use <a class="el" href="group__audio__decode.html#ga8143c4405296ba9b61ff2ac69722b12b">lqt_decode_audio_raw</a> or <a class="el" href="group__audio__encode.html#ga440f3f940a6d0ffce972b7d7e57930f4">lqt_encode_audio_raw</a> . Byte order of the data is always machine native. Endianess conversion is responsibility of the codec. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga1bc8892b20c04e8d9dbbed7666e85dd8acc93dc9b43e854a63f09177cc9a887b9"></a>LQT_SAMPLE_UNDEFINED </td><td class="fielddoc"><p>If this is returned, we have an error </p>
</td></tr>
<tr><td class="fieldname"><a id="gga1bc8892b20c04e8d9dbbed7666e85dd8a118658720ae0b9750c33a28f15954a38"></a>LQT_SAMPLE_INT8 </td><td class="fielddoc"><p>int8_t </p>
</td></tr>
<tr><td class="fieldname"><a id="gga1bc8892b20c04e8d9dbbed7666e85dd8af1350eabe516c4bb1c7f27f12046415a"></a>LQT_SAMPLE_UINT8 </td><td class="fielddoc"><p>uint8_t </p>
</td></tr>
<tr><td class="fieldname"><a id="gga1bc8892b20c04e8d9dbbed7666e85dd8a60d6a8c3a788b1b75f6e7aded988b2a6"></a>LQT_SAMPLE_INT16 </td><td class="fielddoc"><p>int16_t </p>
</td></tr>
<tr><td class="fieldname"><a id="gga1bc8892b20c04e8d9dbbed7666e85dd8a898817c17919e3fce7aec54ffd646a6b"></a>LQT_SAMPLE_INT32 </td><td class="fielddoc"><p>int32_t </p>
</td></tr>
<tr><td class="fieldname"><a id="gga1bc8892b20c04e8d9dbbed7666e85dd8abc7fa82547e45f59a8fc557b8570f347"></a>LQT_SAMPLE_FLOAT </td><td class="fielddoc"><p>Float (machine native) </p>
</td></tr>
<tr><td class="fieldname"><a id="gga1bc8892b20c04e8d9dbbed7666e85dd8ab401e92dfa324c2ae18270ef0088f2a5"></a>LQT_SAMPLE_DOUBLE </td><td class="fielddoc"><p>Double (machine native, since version 1.0.3) </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga282a31a22a6819423512b93a0e3595aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga282a31a22a6819423512b93a0e3595aa">◆ </a></span>lqt_set_audio_parameter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lqt_set_audio_parameter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__general.html#gaef65e7300455a3b25eafc7485ec2efa4">quicktime_t</a> * </td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>track</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a codec parameter for an audio track. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>A quicktime handle </td></tr>
<tr><td class="paramname">track</td><td>Track index (starting with 0) </td></tr>
<tr><td class="paramname">key</td><td>Short name of the parameter </td></tr>
<tr><td class="paramname">value</td><td>Parameter value.</td></tr>
</table>
</dd>
</dl>
<p>For integer parameters, value must be of the type int*. For string parameters, use char*. For floating-point parameters, use float*. </p>
</div>
</div>
<a id="gab58293547a1b774cc938d574df9fedbe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab58293547a1b774cc938d574df9fedbe">◆ </a></span>lqt_sample_format_to_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* lqt_sample_format_to_string </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__audio.html#ga1bc8892b20c04e8d9dbbed7666e85dd8">lqt_sample_format_t</a> </td>
<td class="paramname"><em>sampleformat</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a human readable description for a sample format. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sampleformat</td><td>A sampleformat </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The description or NULL </dd></dl>
</div>
</div>
<a id="gabde4021e8da716ad38a91c238aa40df0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabde4021e8da716ad38a91c238aa40df0">◆ </a></span>lqt_get_sample_format()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__audio.html#ga1bc8892b20c04e8d9dbbed7666e85dd8">lqt_sample_format_t</a> lqt_get_sample_format </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__general.html#gaef65e7300455a3b25eafc7485ec2efa4">quicktime_t</a> * </td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>track</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the sample format used natively by the codec. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>A quicktime handle </td></tr>
<tr><td class="paramname">track</td><td>Track index (starting with 0) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The sampleformat</dd></dl>
<p>Use this function if you want to use <a class="el" href="group__audio__decode.html#ga8143c4405296ba9b61ff2ac69722b12b">lqt_decode_audio_raw</a> or <a class="el" href="group__audio__encode.html#ga440f3f940a6d0ffce972b7d7e57930f4">lqt_encode_audio_raw</a> to bypass libquicktimes internal sample format conversion routines.</p>
<p><em>Note</em> Some codecs call </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
|