-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathgroup__cpp__kodi__audioengine___defs___audio_engine_data_format.html
202 lines (198 loc) · 13.8 KB
/
group__cpp__kodi__audioengine___defs___audio_engine_data_format.html
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Kodi Development: enum AudioEngineDataFormat</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>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</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="projectlogo"><img alt="Logo" src="kodi-dev.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Kodi Development
 <span id="projectnumber">20.0</span>
</div>
<div id="projectbrief">for Binary and Script based Add-Ons</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__cpp__kodi__audioengine___defs___audio_engine_data_format.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">enum AudioEngineDataFormat<div class="ingroups"><a class="el" href="group__cpp.html">C++</a> » <a class="el" href="group__cpp__kodi__audioengine.html">Interface - kodi::audioengine</a> » <a class="el" href="group__cpp__kodi__audioengine___defs.html">Definitions, structures and enumerators</a></div></div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p><b>Audio sample formats</b><br />
The bit layout of the audio data. </p>
<p>LE = Little Endian, BE = Big Endian, NE = Native Endian</p>
<p>For planar sample formats, each audio channel is in a separate data plane, and linesize is the buffer size, in bytes, for a single plane. All data planes must be the same size. For packed sample formats, only the first data plane is used, and samples for each channel are interleaved. In this case, linesize is the buffer size, in bytes, for the 1 plane.</p>
<dl class="section note"><dt>Note</dt><dd>This is ordered from the worst to best preferred formats</dd></dl>
<hr />
<p><b>Usage example:</b> </p><div class="fragment"><div class="line"><a class="code" href="classkodi_1_1audioengine_1_1_audio_engine_format.html">kodi::audioengine::AudioEngineFormat</a> format;</div>
<div class="line">format.<a class="code" href="group__cpp__kodi__audioengine___defs___audio_engine_format.html#gaaa9c5a3f729a65d24010a085c6104b6e">SetDataFormat</a>(<a class="code" href="group__cpp__kodi__audioengine___defs___audio_engine_data_format.html#ggaa5510e87db1b47c1aa7823fae4950639af00d1c0e3e5c9045d402a459b6d335b3">AUDIOENGINE_FMT_FLOATP</a>);</div>
<div class="ttc" id="aclasskodi_1_1audioengine_1_1_audio_engine_format_html"><div class="ttname"><a href="classkodi_1_1audioengine_1_1_audio_engine_format.html">kodi::audioengine::AudioEngineFormat</a></div><div class="ttdef"><b>Definition:</b> AudioEngine.h:104</div></div>
<div class="ttc" id="agroup__cpp__kodi__audioengine___defs___audio_engine_data_format_html_ggaa5510e87db1b47c1aa7823fae4950639af00d1c0e3e5c9045d402a459b6d335b3"><div class="ttname"><a href="group__cpp__kodi__audioengine___defs___audio_engine_data_format.html#ggaa5510e87db1b47c1aa7823fae4950639af00d1c0e3e5c9045d402a459b6d335b3">AUDIOENGINE_FMT_FLOATP</a></div><div class="ttdeci">@ AUDIOENGINE_FMT_FLOATP</div><div class="ttdef"><b>Definition:</b> audio_engine.h:217</div></div>
<div class="ttc" id="agroup__cpp__kodi__audioengine___defs___audio_engine_format_html_gaaa9c5a3f729a65d24010a085c6104b6e"><div class="ttname"><a href="group__cpp__kodi__audioengine___defs___audio_engine_format.html#gaaa9c5a3f729a65d24010a085c6104b6e">kodi::audioengine::AudioEngineFormat::SetDataFormat</a></div><div class="ttdeci">void SetDataFormat(enum AudioEngineDataFormat format)</div><div class="ttdoc">The stream's data format (eg, AUDIOENGINE_FMT_S16LE)</div><div class="ttdef"><b>Definition:</b> AudioEngine.h:145</div></div>
</div><!-- fragment --> <h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="gaa5510e87db1b47c1aa7823fae4950639"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa5510e87db1b47c1aa7823fae4950639">◆ </a></span>AudioEngineDataFormat</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__cpp__kodi__audioengine___defs___audio_engine_data_format.html#gaa5510e87db1b47c1aa7823fae4950639">AudioEngineDataFormat</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639ac8c51e4a8f8139b71cf3ce02ec8849aa"></a>AUDIOENGINE_FMT_INVALID </td><td class="fielddoc"><p>To define format as invalid. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639a73d6f6f85e2b16f217142e15800c0d32"></a>AUDIOENGINE_FMT_U8 </td><td class="fielddoc"><p>Unsigned integer 8 bit. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639a4c4a3d607addae0d2f2525bdbd3f6924"></a>AUDIOENGINE_FMT_S16BE </td><td class="fielddoc"><p>Big Endian signed integer 16 bit. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639a5b46fb4a678b7f2caf88effcabf634ff"></a>AUDIOENGINE_FMT_S16LE </td><td class="fielddoc"><p>Little Endian signed integer 16 bit. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639a04d60c81bece8421876953475f89d6e6"></a>AUDIOENGINE_FMT_S16NE </td><td class="fielddoc"><p>Native Endian signed integer 16 bit. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639a30552df3eb39cbd56e83b93bd4c2a160"></a>AUDIOENGINE_FMT_S32BE </td><td class="fielddoc"><p>Big Endian signed integer 32 bit. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639abeb5550d929653740089f2cdf9c7e034"></a>AUDIOENGINE_FMT_S32LE </td><td class="fielddoc"><p>Little Endian signed integer 32 bit. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639adff4459f3c9733e639ff8317f96c9953"></a>AUDIOENGINE_FMT_S32NE </td><td class="fielddoc"><p>Native Endian signed integer 32 bit. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639a12ae4266c516759a64b5cef40aac4efb"></a>AUDIOENGINE_FMT_S24BE4 </td><td class="fielddoc"><p>Big Endian signed integer 24 bit (in 4 bytes) </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639a6ccc57b358064ca0d2c6dd3a6092cd31"></a>AUDIOENGINE_FMT_S24LE4 </td><td class="fielddoc"><p>Little Endian signed integer 24 bit (in 4 bytes) </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639a60864161903dabce9d8c3ec292e3d14f"></a>AUDIOENGINE_FMT_S24NE4 </td><td class="fielddoc"><p>Native Endian signed integer 24 bit (in 4 bytes) </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639a86c418246753ce24b369d4d425cd50d5"></a>AUDIOENGINE_FMT_S24NE4MSB </td><td class="fielddoc"><p>S32 with bits_per_sample < 32. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639a19741bd1d3184350847ae80e75ad0d07"></a>AUDIOENGINE_FMT_S24BE3 </td><td class="fielddoc"><p>Big Endian signed integer 24 bit (3 bytes) </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639a712decd7bbb6d692b1e017df50882cea"></a>AUDIOENGINE_FMT_S24LE3 </td><td class="fielddoc"><p>Little Endian signed integer 24 bit (3 bytes) </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639a00b29dbf6fd20d7ef075abf1fc70379f"></a>AUDIOENGINE_FMT_S24NE3 </td><td class="fielddoc"><p>Native Endian signed integer 24 bit (3 bytes) </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639a64614940cb13fa528313648363c8bec1"></a>AUDIOENGINE_FMT_DOUBLE </td><td class="fielddoc"><p>Double floating point. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639a574b7d22bd8b6103467405ffdcdeff4d"></a>AUDIOENGINE_FMT_FLOAT </td><td class="fielddoc"><p>Floating point. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639a2e3f6366cfc76a77a6b97ddccff4737b"></a>AUDIOENGINE_FMT_RAW </td><td class="fielddoc"><p><b>Bitstream</b><br />
RAW Audio format </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639a516a3be79d9805c89fd6fb57bc7f15f5"></a>AUDIOENGINE_FMT_U8P </td><td class="fielddoc"><p><b>Planar format</b><br />
Unsigned byte </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639a300034461ef74e451a2ab66d727f0fd4"></a>AUDIOENGINE_FMT_S16NEP </td><td class="fielddoc"><p><b>Planar format</b><br />
Native Endian signed 16 bit </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639a4c18b34832ae03c40f4f512e990907a8"></a>AUDIOENGINE_FMT_S32NEP </td><td class="fielddoc"><p><b>Planar format</b><br />
Native Endian signed 32 bit </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639ab76e99b671341a0c53c15da174ede394"></a>AUDIOENGINE_FMT_S24NE4P </td><td class="fielddoc"><p><b>Planar format</b><br />
Native Endian signed integer 24 bit (in 4 bytes) </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639a58083659c1a2e111bbd3fef23e0d56a6"></a>AUDIOENGINE_FMT_S24NE4MSBP </td><td class="fielddoc"><p><b>Planar format</b><br />
S32 with bits_per_sample < 32 </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639a3e5777ec1f52e450a2ecb567bef0ef5f"></a>AUDIOENGINE_FMT_S24NE3P </td><td class="fielddoc"><p><b>Planar format</b><br />
Native Endian signed integer 24 bit (in 3 bytes) </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639a2d352890c432b894f947172ea1809935"></a>AUDIOENGINE_FMT_DOUBLEP </td><td class="fielddoc"><p><b>Planar format</b><br />
Double floating point </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639af00d1c0e3e5c9045d402a459b6d335b3"></a>AUDIOENGINE_FMT_FLOATP </td><td class="fielddoc"><p><b>Planar format</b><br />
Floating point </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa5510e87db1b47c1aa7823fae4950639aef35f7d1ae27403cd30993ead792e293"></a>AUDIOENGINE_FMT_MAX </td><td class="fielddoc"><p>Amount of sample formats. </p>
</td></tr>
</table>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>