<!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.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>gavl: Audio format definitions</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">gavl
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<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="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Audio format definitions<div class="ingroups"><a class="el" href="group__audio.html">Audio</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Definitions for several variations of audio data.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Audio Format. <a href="structgavl__audio__format__t.html#details">More...</a><br /></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="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gadf04f3cec52fc5df08390e0feca392d8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__format.html#gadf04f3cec52fc5df08390e0feca392d8">GAVL_MAX_CHANNELS</a>   128</td></tr>
<tr class="memdesc:gadf04f3cec52fc5df08390e0feca392d8"><td class="mdescLeft"> </td><td class="mdescRight">Maximum number of audio channels. <a href="#gadf04f3cec52fc5df08390e0feca392d8">More...</a><br /></td></tr>
<tr class="separator:gadf04f3cec52fc5df08390e0feca392d8"><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:ga08ca85571b963dca380529d3c64e8d04"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__format.html#ga08ca85571b963dca380529d3c64e8d04">gavl_sample_format_t</a> { <br />
  <a class="el" href="group__audio__format.html#gga08ca85571b963dca380529d3c64e8d04a5681e0131192ef4c5baf7aabfd53d470">GAVL_SAMPLE_NONE</a> = 0,
<br />
  <a class="el" href="group__audio__format.html#gga08ca85571b963dca380529d3c64e8d04a5a99cb841b307045c0a9f2c90ebdddc7">GAVL_SAMPLE_U8</a> = 1,
<br />
  <a class="el" href="group__audio__format.html#gga08ca85571b963dca380529d3c64e8d04a75aa6db07e83e2cb7ab52ebc8943ec9a">GAVL_SAMPLE_S8</a> = 2,
<br />
  <a class="el" href="group__audio__format.html#gga08ca85571b963dca380529d3c64e8d04a8c81b8d4cdf85b942f9131b2c8cf04f5">GAVL_SAMPLE_U16</a> = 3,
<br />
  <a class="el" href="group__audio__format.html#gga08ca85571b963dca380529d3c64e8d04aabaddf765acac09e8e104c0a1c0abfd3">GAVL_SAMPLE_S16</a> = 4,
<br />
  <a class="el" href="group__audio__format.html#gga08ca85571b963dca380529d3c64e8d04af51697b6266eea712dfa0fd884d956ee">GAVL_SAMPLE_S32</a> = 5,
<br />
  <a class="el" href="group__audio__format.html#gga08ca85571b963dca380529d3c64e8d04a3edfde34e4bb95751ba81ee688c2c91a">GAVL_SAMPLE_FLOAT</a> = 6,
<br />
  <a class="el" href="group__audio__format.html#gga08ca85571b963dca380529d3c64e8d04ab9aecd4dd6cacbbea7fc1170b065d53c">GAVL_SAMPLE_DOUBLE</a> = 7
<br />
}<tr class="memdesc:ga08ca85571b963dca380529d3c64e8d04"><td class="mdescLeft"> </td><td class="mdescRight">Format of one audio sample. <a href="group__audio__format.html#ga08ca85571b963dca380529d3c64e8d04">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ga08ca85571b963dca380529d3c64e8d04"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7ed6d11fe342b9d77d2252da737fe70c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__format.html#ga7ed6d11fe342b9d77d2252da737fe70c">gavl_interleave_mode_t</a> { <br />
  <a class="el" href="group__audio__format.html#gga7ed6d11fe342b9d77d2252da737fe70caa98036ec9c35e15773f7eee9cfb5c4a7">GAVL_INTERLEAVE_NONE</a> = 0,
<br />
  <a class="el" href="group__audio__format.html#gga7ed6d11fe342b9d77d2252da737fe70ca502a85cc59d5839c1935196cb0ebec8b">GAVL_INTERLEAVE_2</a> = 1,
<br />
  <a class="el" href="group__audio__format.html#gga7ed6d11fe342b9d77d2252da737fe70ca5af921652b91c139a5e107a01f43888e">GAVL_INTERLEAVE_ALL</a> = 2
<br />
}</td></tr>
<tr class="separator:ga7ed6d11fe342b9d77d2252da737fe70c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0167e2e6a67aadb417ad7735ce85dc8c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__format.html#ga0167e2e6a67aadb417ad7735ce85dc8c">gavl_channel_id_t</a> { <br />
  <a class="el" href="group__audio__format.html#gga0167e2e6a67aadb417ad7735ce85dc8ca96f1678288e5e15465e83ca0b4ff5b8c">GAVL_CHID_NONE</a> = 0,
<br />
  <a class="el" href="group__audio__format.html#gga0167e2e6a67aadb417ad7735ce85dc8cafc8c33d89aae92eedd2a9cc6460496d8">GAVL_CHID_FRONT_CENTER</a>,
<br />
  <a class="el" href="group__audio__format.html#gga0167e2e6a67aadb417ad7735ce85dc8ca5f3cbff9e18df5d430b794ad26a8ebe0">GAVL_CHID_FRONT_LEFT</a>,
<br />
  <a class="el" href="group__audio__format.html#gga0167e2e6a67aadb417ad7735ce85dc8ca0d09580f5510ec0384353b7927cdb5cc">GAVL_CHID_FRONT_RIGHT</a>,
<br />
  <a class="el" href="group__audio__format.html#gga0167e2e6a67aadb417ad7735ce85dc8caa6178f1146615d4000d3cf48465ec54a">GAVL_CHID_FRONT_CENTER_LEFT</a>,
<br />
  <a class="el" href="group__audio__format.html#gga0167e2e6a67aadb417ad7735ce85dc8caf53beeb74f046a3d7fc9b00458065fd6">GAVL_CHID_FRONT_CENTER_RIGHT</a>,
<br />
  <a class="el" href="group__audio__format.html#gga0167e2e6a67aadb417ad7735ce85dc8ca7481629b20d13bb3b7b199e12e7fb9d9">GAVL_CHID_REAR_LEFT</a>,
<br />
  <a class="el" href="group__audio__format.html#gga0167e2e6a67aadb417ad7735ce85dc8caccfda1a5cafdc82d9d701c8eb2c6c42b">GAVL_CHID_REAR_RIGHT</a>,
<br />
  <a class="el" href="group__audio__format.html#gga0167e2e6a67aadb417ad7735ce85dc8cac527fed53e7225bcb00c92e3c9d71a8b">GAVL_CHID_REAR_CENTER</a>,
<br />
  <a class="el" href="group__audio__format.html#gga0167e2e6a67aadb417ad7735ce85dc8ca8d304398b8347447c1277ea966722a74">GAVL_CHID_SIDE_LEFT</a>,
<br />
  <a class="el" href="group__audio__format.html#gga0167e2e6a67aadb417ad7735ce85dc8ca0abe864a9e34165cdb7c0720d126c706">GAVL_CHID_SIDE_RIGHT</a>,
<br />
  <a class="el" href="group__audio__format.html#gga0167e2e6a67aadb417ad7735ce85dc8cacbc8b1ee07f3315da917e0486b672ba7">GAVL_CHID_LFE</a>,
<br />
  <a class="el" href="group__audio__format.html#gga0167e2e6a67aadb417ad7735ce85dc8cad31c6ef1ed7499a2856bb5b8c5df8524">GAVL_CHID_AUX</a>
<br />
}<tr class="memdesc:ga0167e2e6a67aadb417ad7735ce85dc8c"><td class="mdescLeft"> </td><td class="mdescRight">Audio channel setup. <a href="group__audio__format.html#ga0167e2e6a67aadb417ad7735ce85dc8c">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ga0167e2e6a67aadb417ad7735ce85dc8c"><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:gad9ea76294adc1d6735eff6ba1857191a"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__format.html#gad9ea76294adc1d6735eff6ba1857191a">gavl_sample_format_to_string</a> (<a class="el" href="group__audio__format.html#ga08ca85571b963dca380529d3c64e8d04">gavl_sample_format_t</a> format)</td></tr>
<tr class="memdesc:gad9ea76294adc1d6735eff6ba1857191a"><td class="mdescLeft"> </td><td class="mdescRight">Convert a gavl_sample_format_t to a human readable string. <a href="#gad9ea76294adc1d6735eff6ba1857191a">More...</a><br /></td></tr>
<tr class="separator:gad9ea76294adc1d6735eff6ba1857191a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8067174ffec304b9bb7c74a009381ae4"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC <a class="el" href="group__audio__format.html#ga08ca85571b963dca380529d3c64e8d04">gavl_sample_format_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__format.html#ga8067174ffec304b9bb7c74a009381ae4">gavl_string_to_sample_format</a> (const char *str)</td></tr>
<tr class="memdesc:ga8067174ffec304b9bb7c74a009381ae4"><td class="mdescLeft"> </td><td class="mdescRight">Convert a string to a sample format. <a href="#ga8067174ffec304b9bb7c74a009381ae4">More...</a><br /></td></tr>
<tr class="separator:ga8067174ffec304b9bb7c74a009381ae4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7e5a70e2645a0b91ab0894428acb7897"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__format.html#ga7e5a70e2645a0b91ab0894428acb7897">gavl_num_sample_formats</a> ()</td></tr>
<tr class="memdesc:ga7e5a70e2645a0b91ab0894428acb7897"><td class="mdescLeft"> </td><td class="mdescRight">Get total number of supported sample formats. <a href="#ga7e5a70e2645a0b91ab0894428acb7897">More...</a><br /></td></tr>
<tr class="separator:ga7e5a70e2645a0b91ab0894428acb7897"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6eebc350f7d91bcd69ee700b610c2020"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC <a class="el" href="group__audio__format.html#ga08ca85571b963dca380529d3c64e8d04">gavl_sample_format_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__format.html#ga6eebc350f7d91bcd69ee700b610c2020">gavl_get_sample_format</a> (int index)</td></tr>
<tr class="memdesc:ga6eebc350f7d91bcd69ee700b610c2020"><td class="mdescLeft"> </td><td class="mdescRight">Get the sample format from index. <a href="#ga6eebc350f7d91bcd69ee700b610c2020">More...</a><br /></td></tr>
<tr class="separator:ga6eebc350f7d91bcd69ee700b610c2020"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga31e8418019af5bdeb9a73c876bac0e65"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__format.html#ga31e8418019af5bdeb9a73c876bac0e65">gavl_channel_id_to_string</a> (<a class="el" href="group__audio__format.html#ga0167e2e6a67aadb417ad7735ce85dc8c">gavl_channel_id_t</a> id)</td></tr>
<tr class="memdesc:ga31e8418019af5bdeb9a73c876bac0e65"><td class="mdescLeft"> </td><td class="mdescRight">Convert a gavl_channel_id_t to a human readable string. <a href="#ga31e8418019af5bdeb9a73c876bac0e65">More...</a><br /></td></tr>
<tr class="separator:ga31e8418019af5bdeb9a73c876bac0e65"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabcb856be7fa689fd1c675dda81595113"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__format.html#gabcb856be7fa689fd1c675dda81595113">gavl_interleave_mode_to_string</a> (<a class="el" href="group__audio__format.html#ga7ed6d11fe342b9d77d2252da737fe70c">gavl_interleave_mode_t</a> mode)</td></tr>
<tr class="memdesc:gabcb856be7fa689fd1c675dda81595113"><td class="mdescLeft"> </td><td class="mdescRight">Convert a gavl_interleave_mode_t to a human readable string. <a href="#gabcb856be7fa689fd1c675dda81595113">More...</a><br /></td></tr>
<tr class="separator:gabcb856be7fa689fd1c675dda81595113"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa2d9ff1e5b43099590184144eeba95ab"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__format.html#gaa2d9ff1e5b43099590184144eeba95ab">gavl_audio_format_dump</a> (const <a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a> *format)</td></tr>
<tr class="memdesc:gaa2d9ff1e5b43099590184144eeba95ab"><td class="mdescLeft"> </td><td class="mdescRight">Dump an audio format to stderr. <a href="#gaa2d9ff1e5b43099590184144eeba95ab">More...</a><br /></td></tr>
<tr class="separator:gaa2d9ff1e5b43099590184144eeba95ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga234f80024bfc5453d0524cc8de1516c8"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__format.html#ga234f80024bfc5453d0524cc8de1516c8">gavl_channel_index</a> (const <a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a> *format, <a class="el" href="group__audio__format.html#ga0167e2e6a67aadb417ad7735ce85dc8c">gavl_channel_id_t</a> id)</td></tr>
<tr class="memdesc:ga234f80024bfc5453d0524cc8de1516c8"><td class="mdescLeft"> </td><td class="mdescRight">Get the index of a particular channel for a given format. <a href="#ga234f80024bfc5453d0524cc8de1516c8">More...</a><br /></td></tr>
<tr class="separator:ga234f80024bfc5453d0524cc8de1516c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga815cb5429b6a814860119e5ef7c8deef"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__format.html#ga815cb5429b6a814860119e5ef7c8deef">gavl_front_channels</a> (const <a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a> *format)</td></tr>
<tr class="memdesc:ga815cb5429b6a814860119e5ef7c8deef"><td class="mdescLeft"> </td><td class="mdescRight">Get number of front channels for a given format. <a href="#ga815cb5429b6a814860119e5ef7c8deef">More...</a><br /></td></tr>
<tr class="separator:ga815cb5429b6a814860119e5ef7c8deef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabb7b66e606066a3c302b063ab93afdb7"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__format.html#gabb7b66e606066a3c302b063ab93afdb7">gavl_rear_channels</a> (const <a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a> *format)</td></tr>
<tr class="memdesc:gabb7b66e606066a3c302b063ab93afdb7"><td class="mdescLeft"> </td><td class="mdescRight">Get number of rear channels for a given format. <a href="#gabb7b66e606066a3c302b063ab93afdb7">More...</a><br /></td></tr>
<tr class="separator:gabb7b66e606066a3c302b063ab93afdb7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4130aff13ee9595d4c9a304e8b05adcd"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__format.html#ga4130aff13ee9595d4c9a304e8b05adcd">gavl_side_channels</a> (const <a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a> *format)</td></tr>
<tr class="memdesc:ga4130aff13ee9595d4c9a304e8b05adcd"><td class="mdescLeft"> </td><td class="mdescRight">Get number of side channels for a given format. <a href="#ga4130aff13ee9595d4c9a304e8b05adcd">More...</a><br /></td></tr>
<tr class="separator:ga4130aff13ee9595d4c9a304e8b05adcd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab146748fadfdc5e2a518a36988fb0eb3"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__format.html#gab146748fadfdc5e2a518a36988fb0eb3">gavl_aux_channels</a> (const <a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a> *format)</td></tr>
<tr class="memdesc:gab146748fadfdc5e2a518a36988fb0eb3"><td class="mdescLeft"> </td><td class="mdescRight">Get number of aux channels for a given format. <a href="#gab146748fadfdc5e2a518a36988fb0eb3">More...</a><br /></td></tr>
<tr class="separator:gab146748fadfdc5e2a518a36988fb0eb3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga502a73eef08caa003c29b962376301df"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__format.html#ga502a73eef08caa003c29b962376301df">gavl_lfe_channels</a> (const <a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a> *format)</td></tr>
<tr class="memdesc:ga502a73eef08caa003c29b962376301df"><td class="mdescLeft"> </td><td class="mdescRight">Get number of LFE channels for a given format. <a href="#ga502a73eef08caa003c29b962376301df">More...</a><br /></td></tr>
<tr class="separator:ga502a73eef08caa003c29b962376301df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga161efe9868875d58827c93fa452db78d"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__format.html#ga161efe9868875d58827c93fa452db78d">gavl_audio_format_copy</a> (<a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a> *dst, const <a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a> *src)</td></tr>
<tr class="memdesc:ga161efe9868875d58827c93fa452db78d"><td class="mdescLeft"> </td><td class="mdescRight">Copy one audio format to another. <a href="#ga161efe9868875d58827c93fa452db78d">More...</a><br /></td></tr>
<tr class="separator:ga161efe9868875d58827c93fa452db78d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadca0772d3ff0cfb5d325e0a67889cae6"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__format.html#gadca0772d3ff0cfb5d325e0a67889cae6">gavl_audio_formats_equal</a> (const <a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a> *format_1, const <a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a> *format_2)</td></tr>
<tr class="memdesc:gadca0772d3ff0cfb5d325e0a67889cae6"><td class="mdescLeft"> </td><td class="mdescRight">Compare 2 audio formats. <a href="#gadca0772d3ff0cfb5d325e0a67889cae6">More...</a><br /></td></tr>
<tr class="separator:gadca0772d3ff0cfb5d325e0a67889cae6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4afb1dc2219da8ee1a74d8024ab5fde8"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__format.html#ga4afb1dc2219da8ee1a74d8024ab5fde8">gavl_set_channel_setup</a> (<a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a> *format)</td></tr>
<tr class="memdesc:ga4afb1dc2219da8ee1a74d8024ab5fde8"><td class="mdescLeft"> </td><td class="mdescRight">Set the default channel setup and indices. <a href="#ga4afb1dc2219da8ee1a74d8024ab5fde8">More...</a><br /></td></tr>
<tr class="separator:ga4afb1dc2219da8ee1a74d8024ab5fde8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga89333e682b542c89bd936ad27dcc8227"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__audio__format.html#ga89333e682b542c89bd936ad27dcc8227">gavl_bytes_per_sample</a> (<a class="el" href="group__audio__format.html#ga08ca85571b963dca380529d3c64e8d04">gavl_sample_format_t</a> format)</td></tr>
<tr class="memdesc:ga89333e682b542c89bd936ad27dcc8227"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of bytes per sample for a given sample format. <a href="#ga89333e682b542c89bd936ad27dcc8227">More...</a><br /></td></tr>
<tr class="separator:ga89333e682b542c89bd936ad27dcc8227"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Definitions for several variations of audio data. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="gadf04f3cec52fc5df08390e0feca392d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadf04f3cec52fc5df08390e0feca392d8">§ </a></span>GAVL_MAX_CHANNELS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GAVL_MAX_CHANNELS   128</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum number of audio channels. </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga08ca85571b963dca380529d3c64e8d04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga08ca85571b963dca380529d3c64e8d04">§ </a></span>gavl_sample_format_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__audio__format.html#ga08ca85571b963dca380529d3c64e8d04">gavl_sample_format_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Format of one audio sample. </p>
<p>For multibyte numbers, the byte order is always machine native endian </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga08ca85571b963dca380529d3c64e8d04a5681e0131192ef4c5baf7aabfd53d470"></a>GAVL_SAMPLE_NONE </td><td class="fielddoc"><p>Undefined </p>
</td></tr>
<tr><td class="fieldname"><a id="gga08ca85571b963dca380529d3c64e8d04a5a99cb841b307045c0a9f2c90ebdddc7"></a>GAVL_SAMPLE_U8 </td><td class="fielddoc"><p>Unsigned 8 bit </p>
</td></tr>
<tr><td class="fieldname"><a id="gga08ca85571b963dca380529d3c64e8d04a75aa6db07e83e2cb7ab52ebc8943ec9a"></a>GAVL_SAMPLE_S8 </td><td class="fielddoc"><p>Signed 8 bit </p>
</td></tr>
<tr><td class="fieldname"><a id="gga08ca85571b963dca380529d3c64e8d04a8c81b8d4cdf85b942f9131b2c8cf04f5"></a>GAVL_SAMPLE_U16 </td><td class="fielddoc"><p>Unsigned 16 bit </p>
</td></tr>
<tr><td class="fieldname"><a id="gga08ca85571b963dca380529d3c64e8d04aabaddf765acac09e8e104c0a1c0abfd3"></a>GAVL_SAMPLE_S16 </td><td class="fielddoc"><p>Signed 16 bit </p>
</td></tr>
<tr><td class="fieldname"><a id="gga08ca85571b963dca380529d3c64e8d04af51697b6266eea712dfa0fd884d956ee"></a>GAVL_SAMPLE_S32 </td><td class="fielddoc"><p>Signed 32 bit </p>
</td></tr>
<tr><td class="fieldname"><a id="gga08ca85571b963dca380529d3c64e8d04a3edfde34e4bb95751ba81ee688c2c91a"></a>GAVL_SAMPLE_FLOAT </td><td class="fielddoc"><p>Floating point (-1.0 .. 1.0) </p>
</td></tr>
<tr><td class="fieldname"><a id="gga08ca85571b963dca380529d3c64e8d04ab9aecd4dd6cacbbea7fc1170b065d53c"></a>GAVL_SAMPLE_DOUBLE </td><td class="fielddoc"><p>Double (-1.0 .. 1.0) </p>
</td></tr>
</table>
</div>
</div>
<a id="ga7ed6d11fe342b9d77d2252da737fe70c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7ed6d11fe342b9d77d2252da737fe70c">§ </a></span>gavl_interleave_mode_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__audio__format.html#ga7ed6d11fe342b9d77d2252da737fe70c">gavl_interleave_mode_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Interleave mode of the channels </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga7ed6d11fe342b9d77d2252da737fe70caa98036ec9c35e15773f7eee9cfb5c4a7"></a>GAVL_INTERLEAVE_NONE </td><td class="fielddoc"><p>No interleaving, all channels separate </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7ed6d11fe342b9d77d2252da737fe70ca502a85cc59d5839c1935196cb0ebec8b"></a>GAVL_INTERLEAVE_2 </td><td class="fielddoc"><p>Interleaved pairs of channels </p>
</td></tr>
<tr><td class="fieldname"><a id="gga7ed6d11fe342b9d77d2252da737fe70ca5af921652b91c139a5e107a01f43888e"></a>GAVL_INTERLEAVE_ALL </td><td class="fielddoc"><p>Everything interleaved </p>
</td></tr>
</table>
</div>
</div>
<a id="ga0167e2e6a67aadb417ad7735ce85dc8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0167e2e6a67aadb417ad7735ce85dc8c">§ </a></span>gavl_channel_id_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__audio__format.html#ga0167e2e6a67aadb417ad7735ce85dc8c">gavl_channel_id_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Audio channel setup. </p>
<p>These are the channel locations used to identify the channel order for an audio format </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga0167e2e6a67aadb417ad7735ce85dc8ca96f1678288e5e15465e83ca0b4ff5b8c"></a>GAVL_CHID_NONE </td><td class="fielddoc"><p>Undefined </p>
</td></tr>
<tr><td class="fieldname"><a id="gga0167e2e6a67aadb417ad7735ce85dc8cafc8c33d89aae92eedd2a9cc6460496d8"></a>GAVL_CHID_FRONT_CENTER </td><td class="fielddoc"><p>For mono </p>
</td></tr>
<tr><td class="fieldname"><a id="gga0167e2e6a67aadb417ad7735ce85dc8ca5f3cbff9e18df5d430b794ad26a8ebe0"></a>GAVL_CHID_FRONT_LEFT </td><td class="fielddoc"><p>Front left </p>
</td></tr>
<tr><td class="fieldname"><a id="gga0167e2e6a67aadb417ad7735ce85dc8ca0d09580f5510ec0384353b7927cdb5cc"></a>GAVL_CHID_FRONT_RIGHT </td><td class="fielddoc"><p>Front right </p>
</td></tr>
<tr><td class="fieldname"><a id="gga0167e2e6a67aadb417ad7735ce85dc8caa6178f1146615d4000d3cf48465ec54a"></a>GAVL_CHID_FRONT_CENTER_LEFT </td><td class="fielddoc"><p>Left of Center </p>
</td></tr>
<tr><td class="fieldname"><a id="gga0167e2e6a67aadb417ad7735ce85dc8caf53beeb74f046a3d7fc9b00458065fd6"></a>GAVL_CHID_FRONT_CENTER_RIGHT </td><td class="fielddoc"><p>Right of Center </p>
</td></tr>
<tr><td class="fieldname"><a id="gga0167e2e6a67aadb417ad7735ce85dc8ca7481629b20d13bb3b7b199e12e7fb9d9"></a>GAVL_CHID_REAR_LEFT </td><td class="fielddoc"><p>Rear left </p>
</td></tr>
<tr><td class="fieldname"><a id="gga0167e2e6a67aadb417ad7735ce85dc8caccfda1a5cafdc82d9d701c8eb2c6c42b"></a>GAVL_CHID_REAR_RIGHT </td><td class="fielddoc"><p>Rear right </p>
</td></tr>
<tr><td class="fieldname"><a id="gga0167e2e6a67aadb417ad7735ce85dc8cac527fed53e7225bcb00c92e3c9d71a8b"></a>GAVL_CHID_REAR_CENTER </td><td class="fielddoc"><p>Rear Center </p>
</td></tr>
<tr><td class="fieldname"><a id="gga0167e2e6a67aadb417ad7735ce85dc8ca8d304398b8347447c1277ea966722a74"></a>GAVL_CHID_SIDE_LEFT </td><td class="fielddoc"><p>Side left </p>
</td></tr>
<tr><td class="fieldname"><a id="gga0167e2e6a67aadb417ad7735ce85dc8ca0abe864a9e34165cdb7c0720d126c706"></a>GAVL_CHID_SIDE_RIGHT </td><td class="fielddoc"><p>Side right </p>
</td></tr>
<tr><td class="fieldname"><a id="gga0167e2e6a67aadb417ad7735ce85dc8cacbc8b1ee07f3315da917e0486b672ba7"></a>GAVL_CHID_LFE </td><td class="fielddoc"><p>Subwoofer </p>
</td></tr>
<tr><td class="fieldname"><a id="gga0167e2e6a67aadb417ad7735ce85dc8cad31c6ef1ed7499a2856bb5b8c5df8524"></a>GAVL_CHID_AUX </td><td class="fielddoc"><p>Additional channel (can be more than one) </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gad9ea76294adc1d6735eff6ba1857191a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad9ea76294adc1d6735eff6ba1857191a">§ </a></span>gavl_sample_format_to_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC const char* gavl_sample_format_to_string </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__audio__format.html#ga08ca85571b963dca380529d3c64e8d04">gavl_sample_format_t</a> </td>
<td class="paramname"><em>format</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert a gavl_sample_format_t to a human readable string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">format</td><td>A sample format </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A string describing the format </dd></dl>
</div>
</div>
<a id="ga8067174ffec304b9bb7c74a009381ae4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8067174ffec304b9bb7c74a009381ae4">§ </a></span>gavl_string_to_sample_format()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC <a class="el" href="group__audio__format.html#ga08ca85571b963dca380529d3c64e8d04">gavl_sample_format_t</a> gavl_string_to_sample_format </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert a string to a sample format. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>String</td></tr>
</table>
</dd>
</dl>
<p>str must be one of the strings returned by <a class="el" href="group__audio__format.html#gad9ea76294adc1d6735eff6ba1857191a">gavl_sample_format_to_string</a> </p>
</div>
</div>
<a id="ga7e5a70e2645a0b91ab0894428acb7897"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7e5a70e2645a0b91ab0894428acb7897">§ </a></span>gavl_num_sample_formats()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC int gavl_num_sample_formats </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get total number of supported sample formats. </p>
<dl class="section return"><dt>Returns</dt><dd>total number of supported sample formats </dd></dl>
</div>
</div>
<a id="ga6eebc350f7d91bcd69ee700b610c2020"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6eebc350f7d91bcd69ee700b610c2020">§ </a></span>gavl_get_sample_format()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC <a class="el" href="group__audio__format.html#ga08ca85571b963dca380529d3c64e8d04">gavl_sample_format_t</a> gavl_get_sample_format </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the sample format from index. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>index (must be between 0 and the result of <a class="el" href="group__audio__format.html#ga7e5a70e2645a0b91ab0894428acb7897">gavl_num_sample_formats</a>) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The sample format corresponding to index or GAVL_SAMPLE_NONE. </dd></dl>
</div>
</div>
<a id="ga31e8418019af5bdeb9a73c876bac0e65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga31e8418019af5bdeb9a73c876bac0e65">§ </a></span>gavl_channel_id_to_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC const char* gavl_channel_id_to_string </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__audio__format.html#ga0167e2e6a67aadb417ad7735ce85dc8c">gavl_channel_id_t</a> </td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert a gavl_channel_id_t to a human readable string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>A channel id </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gabcb856be7fa689fd1c675dda81595113"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabcb856be7fa689fd1c675dda81595113">§ </a></span>gavl_interleave_mode_to_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC const char* gavl_interleave_mode_to_string </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__audio__format.html#ga7ed6d11fe342b9d77d2252da737fe70c">gavl_interleave_mode_t</a> </td>
<td class="paramname"><em>mode</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert a gavl_interleave_mode_t to a human readable string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mode</td><td>An interleave mode </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaa2d9ff1e5b43099590184144eeba95ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa2d9ff1e5b43099590184144eeba95ab">§ </a></span>gavl_audio_format_dump()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC void gavl_audio_format_dump </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a> * </td>
<td class="paramname"><em>format</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Dump an audio format to stderr. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">format</td><td>An audio format </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga234f80024bfc5453d0524cc8de1516c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga234f80024bfc5453d0524cc8de1516c8">§ </a></span>gavl_channel_index()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC int gavl_channel_index </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a> * </td>
<td class="paramname"><em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__audio__format.html#ga0167e2e6a67aadb417ad7735ce85dc8c">gavl_channel_id_t</a> </td>
<td class="paramname"><em>id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the index of a particular channel for a given format. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">format</td><td>An audio format </td></tr>
<tr><td class="paramname">id</td><td>A channel id </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The index of the channel in the format or -1 if such a channel is not present </dd></dl>
</div>
</div>
<a id="ga815cb5429b6a814860119e5ef7c8deef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga815cb5429b6a814860119e5ef7c8deef">§ </a></span>gavl_front_channels()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC int gavl_front_channels </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a> * </td>
<td class="paramname"><em>format</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get number of front channels for a given format. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">format</td><td>An audio format </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gabb7b66e606066a3c302b063ab93afdb7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabb7b66e606066a3c302b063ab93afdb7">§ </a></span>gavl_rear_channels()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC int gavl_rear_channels </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a> * </td>
<td class="paramname"><em>format</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get number of rear channels for a given format. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">format</td><td>An audio format </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga4130aff13ee9595d4c9a304e8b05adcd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4130aff13ee9595d4c9a304e8b05adcd">§ </a></span>gavl_side_channels()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC int gavl_side_channels </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a> * </td>
<td class="paramname"><em>format</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get number of side channels for a given format. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">format</td><td>An audio format </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gab146748fadfdc5e2a518a36988fb0eb3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab146748fadfdc5e2a518a36988fb0eb3">§ </a></span>gavl_aux_channels()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC int gavl_aux_channels </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a> * </td>
<td class="paramname"><em>format</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get number of aux channels for a given format. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">format</td><td>An audio format </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga502a73eef08caa003c29b962376301df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga502a73eef08caa003c29b962376301df">§ </a></span>gavl_lfe_channels()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC int gavl_lfe_channels </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a> * </td>
<td class="paramname"><em>format</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get number of LFE channels for a given format. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">format</td><td>An audio format </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga161efe9868875d58827c93fa452db78d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga161efe9868875d58827c93fa452db78d">§ </a></span>gavl_audio_format_copy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC void gavl_audio_format_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a> * </td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a> * </td>
<td class="paramname"><em>src</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy one audio format to another. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dst</td><td>Destination format </td></tr>
<tr><td class="paramname">src</td><td>Source format </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gadca0772d3ff0cfb5d325e0a67889cae6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadca0772d3ff0cfb5d325e0a67889cae6">§ </a></span>gavl_audio_formats_equal()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC int gavl_audio_formats_equal </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a> * </td>
<td class="paramname"><em>format_1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a> * </td>
<td class="paramname"><em>format_2</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Compare 2 audio formats. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">format_1</td><td>First format </td></tr>
<tr><td class="paramname">format_2</td><td>Second format </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if the formats are equal, 0 else </dd></dl>
</div>
</div>
<a id="ga4afb1dc2219da8ee1a74d8024ab5fde8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4afb1dc2219da8ee1a74d8024ab5fde8">§ </a></span>gavl_set_channel_setup()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC void gavl_set_channel_setup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgavl__audio__format__t.html">gavl_audio_format_t</a> * </td>
<td class="paramname"><em>format</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the default channel setup and indices. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">format</td><td>An audio format</td></tr>
</table>
</dd>
</dl>
<p>Set a default channel setup and channel indices if only the number of channels is known. The result might be wrong if you have something else than mono or stereo from a stream, which has no informtions about the speaker configurations. </p>
</div>
</div>
<a id="ga89333e682b542c89bd936ad27dcc8227"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga89333e682b542c89bd936ad27dcc8227">§ </a></span>gavl_bytes_per_sample()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GAVL_PUBLIC int gavl_bytes_per_sample </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__audio__format.html#ga08ca85571b963dca380529d3c64e8d04">gavl_sample_format_t</a> </td>
<td class="paramname"><em>format</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of bytes per sample for a given sample format. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">format</td><td>A sample format </td></tr>
</table>
</dd>
</dl>
</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.12
</small></address>
</body>
</html>
