mirror of
https://github.com/pschatzmann/arduino-audio-tools.git
synced 2024-09-21 10:27:27 +00:00
368 lines
35 KiB
HTML
368 lines
35 KiB
HTML
<!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>arduino-audio-tools: WavIMADecoder Class Reference</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="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>
|
|
<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">arduino-audio-tools
|
|
</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>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- 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 id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceaudio__tools.html">audio_tools</a></li><li class="navelem"><a class="el" href="classaudio__tools_1_1_wav_i_m_a_decoder.html">WavIMADecoder</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="classaudio__tools_1_1_wav_i_m_a_decoder-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">WavIMADecoder Class Reference<div class="ingroups"><a class="el" href="group__main.html">Arduino Audio Tools</a> » <a class="el" href="group__codecs.html">Codecs</a> | <a class="el" href="group__main.html">Arduino Audio Tools</a> » <a class="el" href="group__codecs.html">Codecs</a> » <a class="el" href="group__decoder.html">Decoder</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Obsolete: <a class="el" href="classaudio__tools_1_1_wav_i_m_a_decoder.html" title="Obsolete: WavIMADecoder - based on WAVDecoder - We parse the header data as we receive it and send th...">WavIMADecoder</a> - based on <a class="el" href="classaudio__tools_1_1_w_a_v_decoder.html" title="A simple WAVDecoder: We parse the header data on the first record to determine the format....">WAVDecoder</a> - We parse the header data as we receive it and send the sound data to the stream which was indicated in the constructor. Only WAV files with WAVE_FORMAT_IMA_ADPCM are supported by this codec!
|
|
<a href="classaudio__tools_1_1_wav_i_m_a_decoder.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_codec_wav_i_m_a_8h_source.html">CodecWavIMA.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for WavIMADecoder:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classaudio__tools_1_1_wav_i_m_a_decoder.png" usemap="#WavIMADecoder_map" alt=""/>
|
|
<map id="WavIMADecoder_map" name="WavIMADecoder_map">
|
|
<area href="classaudio__tools_1_1_audio_decoder.html" title="Docoding of encoded audio into PCM data." alt="AudioDecoder" shape="rect" coords="60,112,170,136"/>
|
|
<area href="classaudio__tools_1_1_audio_writer.html" title="E.g. used by Encoders and Decoders." alt="AudioWriter" shape="rect" coords="0,56,110,80"/>
|
|
<area href="classaudio__tools_1_1_audio_info_source.html" title="Supports the subscription to audio change notifications." alt="AudioInfoSource" shape="rect" coords="120,56,230,80"/>
|
|
<area href="classaudio__tools_1_1_audio_info_support.html" title="Supports changes to the sampling rate, bits and channels." alt="AudioInfoSupport" shape="rect" coords="0,0,110,24"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a00e41f386087cda4eaf92bd7024ed6bb"><td class="memItemLeft" align="right" valign="top"><a id="a00e41f386087cda4eaf92bd7024ed6bb"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_wav_i_m_a_decoder.html#a00e41f386087cda4eaf92bd7024ed6bb">WavIMADecoder</a> ()</td></tr>
|
|
<tr class="memdesc:a00e41f386087cda4eaf92bd7024ed6bb"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new <a class="el" href="classaudio__tools_1_1_wav_i_m_a_decoder.html" title="Obsolete: WavIMADecoder - based on WAVDecoder - We parse the header data as we receive it and send th...">WavIMADecoder</a> object. <br /></td></tr>
|
|
<tr class="separator:a00e41f386087cda4eaf92bd7024ed6bb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a61202c4d1b5ae76fd4a42b7ea0854362"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_wav_i_m_a_decoder.html#a61202c4d1b5ae76fd4a42b7ea0854362">WavIMADecoder</a> (<a class="el" href="classaudio__tools_1_1_print.html">Print</a> &out_stream, <a class="el" href="classaudio__tools_1_1_audio_info_support.html">AudioInfoSupport</a> &bi)</td></tr>
|
|
<tr class="memdesc:a61202c4d1b5ae76fd4a42b7ea0854362"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new <a class="el" href="classaudio__tools_1_1_wav_i_m_a_decoder.html" title="Obsolete: WavIMADecoder - based on WAVDecoder - We parse the header data as we receive it and send th...">WavIMADecoder</a> object. <a href="classaudio__tools_1_1_wav_i_m_a_decoder.html#a61202c4d1b5ae76fd4a42b7ea0854362">More...</a><br /></td></tr>
|
|
<tr class="separator:a61202c4d1b5ae76fd4a42b7ea0854362"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af3311b0c1e6c2ea362e91fca3b053f2b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_wav_i_m_a_decoder.html#af3311b0c1e6c2ea362e91fca3b053f2b">WavIMADecoder</a> (<a class="el" href="classaudio__tools_1_1_print.html">Print</a> &out_stream, bool active=true)</td></tr>
|
|
<tr class="memdesc:af3311b0c1e6c2ea362e91fca3b053f2b"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new <a class="el" href="classaudio__tools_1_1_wav_i_m_a_decoder.html" title="Obsolete: WavIMADecoder - based on WAVDecoder - We parse the header data as we receive it and send th...">WavIMADecoder</a> object. <a href="classaudio__tools_1_1_wav_i_m_a_decoder.html#af3311b0c1e6c2ea362e91fca3b053f2b">More...</a><br /></td></tr>
|
|
<tr class="separator:af3311b0c1e6c2ea362e91fca3b053f2b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a727a24459787e1eeeb7a37ba888394a6"><td class="memItemLeft" align="right" valign="top"><a id="a727a24459787e1eeeb7a37ba888394a6"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_info_source.html#a727a24459787e1eeeb7a37ba888394a6">addNotifyAudioChange</a> (<a class="el" href="classaudio__tools_1_1_audio_info_support.html">AudioInfoSupport</a> &bi)</td></tr>
|
|
<tr class="memdesc:a727a24459787e1eeeb7a37ba888394a6"><td class="mdescLeft"> </td><td class="mdescRight">Adds target to be notified about audio changes. <br /></td></tr>
|
|
<tr class="separator:a727a24459787e1eeeb7a37ba888394a6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aed4bf0d5ce93f27242be485943d0b37d"><td class="memItemLeft" align="right" valign="top"><a id="aed4bf0d5ce93f27242be485943d0b37d"></a>
|
|
<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_wav_i_m_a_decoder.html#aed4bf0d5ce93f27242be485943d0b37d">audioInfo</a> () override</td></tr>
|
|
<tr class="memdesc:aed4bf0d5ce93f27242be485943d0b37d"><td class="mdescLeft"> </td><td class="mdescRight">provides the actual input <a class="el" href="structaudio__tools_1_1_audio_info.html" title="Basic Audio information which drives e.g. I2S.">AudioInfo</a> <br /></td></tr>
|
|
<tr class="separator:aed4bf0d5ce93f27242be485943d0b37d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aacdcb417be13af4678ab502139633282"><td class="memItemLeft" align="right" valign="top"><a id="aacdcb417be13af4678ab502139633282"></a>
|
|
<a class="el" href="structaudio__tools_1_1_wav_i_m_a_audio_info.html">WavIMAAudioInfo</a> & </td><td class="memItemRight" valign="bottom"><b>audioInfoEx</b> ()</td></tr>
|
|
<tr class="separator:aacdcb417be13af4678ab502139633282"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1c77cb3dbe910c765ea439d103bdcbb9"><td class="memItemLeft" align="right" valign="top"><a id="a1c77cb3dbe910c765ea439d103bdcbb9"></a>
|
|
virtual <a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_info_support.html#a1c77cb3dbe910c765ea439d103bdcbb9">audioInfoOut</a> ()</td></tr>
|
|
<tr class="memdesc:a1c77cb3dbe910c765ea439d103bdcbb9"><td class="mdescLeft"> </td><td class="mdescRight">provides the actual output <a class="el" href="structaudio__tools_1_1_audio_info.html" title="Basic Audio information which drives e.g. I2S.">AudioInfo</a>: this is usually the same as <a class="el" href="classaudio__tools_1_1_audio_info_support.html#ae0d5f156b0564368220fa8d328db3880" title="provides the actual input AudioInfo">audioInfo()</a> unless we use a transforming stream <br /></td></tr>
|
|
<tr class="separator:a1c77cb3dbe910c765ea439d103bdcbb9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a601fb7cf1fc15db50c71a826f084f934"><td class="memItemLeft" align="right" valign="top"><a id="a601fb7cf1fc15db50c71a826f084f934"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>begin</b> ()</td></tr>
|
|
<tr class="separator:a601fb7cf1fc15db50c71a826f084f934"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a53535f66e5ffb2b3074fccc630c1b8ee"><td class="memItemLeft" align="right" valign="top"><a id="a53535f66e5ffb2b3074fccc630c1b8ee"></a>
|
|
virtual bool </td><td class="memItemRight" valign="bottom"><b>begin</b> (<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> info) override</td></tr>
|
|
<tr class="separator:a53535f66e5ffb2b3074fccc630c1b8ee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:affd15675a5e391c34cccefa7181354bb"><td class="memItemLeft" align="right" valign="top"><a id="affd15675a5e391c34cccefa7181354bb"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_info_source.html#affd15675a5e391c34cccefa7181354bb">clearNotifyAudioChange</a> ()</td></tr>
|
|
<tr class="memdesc:affd15675a5e391c34cccefa7181354bb"><td class="mdescLeft"> </td><td class="mdescRight">Deletes all change notify subscriptions. <br /></td></tr>
|
|
<tr class="separator:affd15675a5e391c34cccefa7181354bb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaf81d3fdaf258088d7692fa70cece087"><td class="memItemLeft" align="right" valign="top"><a id="aaf81d3fdaf258088d7692fa70cece087"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>end</b> ()</td></tr>
|
|
<tr class="separator:aaf81d3fdaf258088d7692fa70cece087"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a475bc9908ea8a1d67e5cc1c1f67a71b2"><td class="memItemLeft" align="right" valign="top"><a id="a475bc9908ea8a1d67e5cc1c1f67a71b2"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_info_source.html#a475bc9908ea8a1d67e5cc1c1f67a71b2">isNotifyActive</a> ()</td></tr>
|
|
<tr class="memdesc:a475bc9908ea8a1d67e5cc1c1f67a71b2"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the automatic <a class="el" href="structaudio__tools_1_1_audio_info.html" title="Basic Audio information which drives e.g. I2S.">AudioInfo</a> update is active. <br /></td></tr>
|
|
<tr class="separator:a475bc9908ea8a1d67e5cc1c1f67a71b2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2b485ba5b9d96f94384f4a3840f84314"><td class="memItemLeft" align="right" valign="top"><a id="a2b485ba5b9d96f94384f4a3840f84314"></a>
|
|
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_decoder.html#a2b485ba5b9d96f94384f4a3840f84314">isResultPCM</a> ()</td></tr>
|
|
<tr class="memdesc:a2b485ba5b9d96f94384f4a3840f84314"><td class="mdescLeft"> </td><td class="mdescRight">If true, the decoding result is PCM data. <br /></td></tr>
|
|
<tr class="separator:a2b485ba5b9d96f94384f4a3840f84314"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a270b0b803120d1fd87b919d29e083979"><td class="memItemLeft" align="right" valign="top"><a id="a270b0b803120d1fd87b919d29e083979"></a>
|
|
const char * </td><td class="memItemRight" valign="bottom"><b>mime</b> ()</td></tr>
|
|
<tr class="separator:a270b0b803120d1fd87b919d29e083979"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0d52c0ed98e047d782054fa126b281e5"><td class="memItemLeft" align="right" valign="top"><a id="a0d52c0ed98e047d782054fa126b281e5"></a>
|
|
virtual </td><td class="memItemRight" valign="bottom"><b>operator bool</b> ()</td></tr>
|
|
<tr class="separator:a0d52c0ed98e047d782054fa126b281e5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab754136602e0bb22ec2be26dedd9ff50"><td class="memItemLeft" align="right" valign="top"><a id="ab754136602e0bb22ec2be26dedd9ff50"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_wav_i_m_a_decoder.html#ab754136602e0bb22ec2be26dedd9ff50">readStream</a> (<a class="el" href="classaudio__tools_1_1_stream.html">Stream</a> &in)</td></tr>
|
|
<tr class="memdesc:ab754136602e0bb22ec2be26dedd9ff50"><td class="mdescLeft"> </td><td class="mdescRight">Alternative API which provides the data from an input stream. <br /></td></tr>
|
|
<tr class="separator:ab754136602e0bb22ec2be26dedd9ff50"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa5b1cdb06807ff2dc37acbaff63410b9"><td class="memItemLeft" align="right" valign="top"><a id="aa5b1cdb06807ff2dc37acbaff63410b9"></a>
|
|
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_info_source.html#aa5b1cdb06807ff2dc37acbaff63410b9">removeNotifyAudioChange</a> (<a class="el" href="classaudio__tools_1_1_audio_info_support.html">AudioInfoSupport</a> &bi)</td></tr>
|
|
<tr class="memdesc:aa5b1cdb06807ff2dc37acbaff63410b9"><td class="mdescLeft"> </td><td class="mdescRight">Removes a target in order not to be notified about audio changes. <br /></td></tr>
|
|
<tr class="separator:aa5b1cdb06807ff2dc37acbaff63410b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:accee684614189e73bdc9f1b2f7abf919"><td class="memItemLeft" align="right" valign="top"><a id="accee684614189e73bdc9f1b2f7abf919"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_decoder.html#accee684614189e73bdc9f1b2f7abf919">setAudioInfo</a> (<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> from) override</td></tr>
|
|
<tr class="memdesc:accee684614189e73bdc9f1b2f7abf919"><td class="mdescLeft"> </td><td class="mdescRight">for most decoders this is not needed <br /></td></tr>
|
|
<tr class="separator:accee684614189e73bdc9f1b2f7abf919"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a909f118906f9cf7024baae224dcd90a7"><td class="memItemLeft" align="right" valign="top"><a id="a909f118906f9cf7024baae224dcd90a7"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_info_source.html#a909f118906f9cf7024baae224dcd90a7">setNotifyActive</a> (bool flag)</td></tr>
|
|
<tr class="memdesc:a909f118906f9cf7024baae224dcd90a7"><td class="mdescLeft"> </td><td class="mdescRight">Deactivate/Reactivate automatic <a class="el" href="structaudio__tools_1_1_audio_info.html" title="Basic Audio information which drives e.g. I2S.">AudioInfo</a> updates: (default is active) <br /></td></tr>
|
|
<tr class="separator:a909f118906f9cf7024baae224dcd90a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acf58dd0aedd8748b499ca948bd2cdf5d"><td class="memItemLeft" align="right" valign="top"><a id="acf58dd0aedd8748b499ca948bd2cdf5d"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_decoder.html#acf58dd0aedd8748b499ca948bd2cdf5d">setOutput</a> (<a class="el" href="classaudio__tools_1_1_audio_output.html">AudioOutput</a> &out_stream)</td></tr>
|
|
<tr class="memdesc:acf58dd0aedd8748b499ca948bd2cdf5d"><td class="mdescLeft"> </td><td class="mdescRight">Defines where the decoded result is written to. <br /></td></tr>
|
|
<tr class="separator:acf58dd0aedd8748b499ca948bd2cdf5d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a74fb348e7fbaed39364af8869fb05231"><td class="memItemLeft" align="right" valign="top"><a id="a74fb348e7fbaed39364af8869fb05231"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_decoder.html#a74fb348e7fbaed39364af8869fb05231">setOutput</a> (<a class="el" href="classaudio__tools_1_1_audio_stream.html">AudioStream</a> &out_stream)</td></tr>
|
|
<tr class="memdesc:a74fb348e7fbaed39364af8869fb05231"><td class="mdescLeft"> </td><td class="mdescRight">Defines where the decoded result is written to. <br /></td></tr>
|
|
<tr class="separator:a74fb348e7fbaed39364af8869fb05231"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a93b5bd320ae10a808fb0de3eb5e5b387"><td class="memItemLeft" align="right" valign="top"><a id="a93b5bd320ae10a808fb0de3eb5e5b387"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_wav_i_m_a_decoder.html#a93b5bd320ae10a808fb0de3eb5e5b387">setOutput</a> (<a class="el" href="classaudio__tools_1_1_print.html">Print</a> &out_stream)</td></tr>
|
|
<tr class="memdesc:a93b5bd320ae10a808fb0de3eb5e5b387"><td class="mdescLeft"> </td><td class="mdescRight">Defines the output <a class="el" href="classaudio__tools_1_1_stream.html">Stream</a>. <br /></td></tr>
|
|
<tr class="separator:a93b5bd320ae10a808fb0de3eb5e5b387"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8b8471dbbdc5527cdf9bfd31612cc973"><td class="memItemLeft" align="right" valign="top"><a id="a8b8471dbbdc5527cdf9bfd31612cc973"></a>
|
|
virtual size_t </td><td class="memItemRight" valign="bottom"><b>write</b> (const uint8_t *data, size_t len)</td></tr>
|
|
<tr class="separator:a8b8471dbbdc5527cdf9bfd31612cc973"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a7441ef0865bcb3db9b8064dd7375c1ea"><td class="memItemLeft" align="right" valign="top"><a id="a7441ef0865bcb3db9b8064dd7375c1ea"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_decoder.html#a7441ef0865bcb3db9b8064dd7375c1ea">id</a></td></tr>
|
|
<tr class="memdesc:a7441ef0865bcb3db9b8064dd7375c1ea"><td class="mdescLeft"> </td><td class="mdescRight">custom id to be used by application <br /></td></tr>
|
|
<tr class="separator:a7441ef0865bcb3db9b8064dd7375c1ea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:a7fd2198e7250e5e56e698253f1431ea6"><td class="memItemLeft" align="right" valign="top"><a id="a7fd2198e7250e5e56e698253f1431ea6"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>decodeBlock</b> (int channels)</td></tr>
|
|
<tr class="separator:a7fd2198e7250e5e56e698253f1431ea6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaee0a49d8b7d59c31a7558ac5446cae9"><td class="memItemLeft" align="right" valign="top"><a id="aaee0a49d8b7d59c31a7558ac5446cae9"></a>
|
|
int16_t </td><td class="memItemRight" valign="bottom"><b>decodeSample</b> (uint8_t sample, int channel=0)</td></tr>
|
|
<tr class="separator:aaee0a49d8b7d59c31a7558ac5446cae9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6a9a665a387a8c4fbf7fed14bbbfc093"><td class="memItemLeft" align="right" valign="top"><a id="a6a9a665a387a8c4fbf7fed14bbbfc093"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>notifyAudioChange</b> (<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> info)</td></tr>
|
|
<tr class="separator:a6a9a665a387a8c4fbf7fed14bbbfc093"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abad7406167eaebb1a5396d35de4f756a"><td class="memItemLeft" align="right" valign="top"><a id="abad7406167eaebb1a5396d35de4f756a"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>processInput</b> (const uint8_t *data, size_t size)</td></tr>
|
|
<tr class="separator:abad7406167eaebb1a5396d35de4f756a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2e475070d3df18395c90a10c9d38eb0a"><td class="memItemLeft" align="right" valign="top"><a id="a2e475070d3df18395c90a10c9d38eb0a"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>writeBlocking</b> (<a class="el" href="classaudio__tools_1_1_print.html">Print</a> *out, uint8_t *data, size_t len)</td></tr>
|
|
<tr class="separator:a2e475070d3df18395c90a10c9d38eb0a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
|
|
Protected Attributes</h2></td></tr>
|
|
<tr class="memitem:a03c996f9fcf0e10baeb3e700be0c409a"><td class="memItemLeft" align="right" valign="top"><a id="a03c996f9fcf0e10baeb3e700be0c409a"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>active</b></td></tr>
|
|
<tr class="separator:a03c996f9fcf0e10baeb3e700be0c409a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6a5e04a7398c9a7ddec1656ed69bea87"><td class="memItemLeft" align="right" valign="top"><a id="a6a5e04a7398c9a7ddec1656ed69bea87"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>bytes_per_decoded_block</b> = 0</td></tr>
|
|
<tr class="separator:a6a5e04a7398c9a7ddec1656ed69bea87"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae8f0417d5355301e6ce68e91c17141f3"><td class="memItemLeft" align="right" valign="top"><a id="ae8f0417d5355301e6ce68e91c17141f3"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>bytes_per_encoded_block</b> = 0</td></tr>
|
|
<tr class="separator:ae8f0417d5355301e6ce68e91c17141f3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa06fffbe79c28ca6757aec571c76e25d"><td class="memItemLeft" align="right" valign="top"><a id="aa06fffbe79c28ca6757aec571c76e25d"></a>
|
|
<a class="el" href="classaudio__tools_1_1_wav_i_m_a_header.html">WavIMAHeader</a> </td><td class="memItemRight" valign="bottom"><b>header</b></td></tr>
|
|
<tr class="separator:aa06fffbe79c28ca6757aec571c76e25d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a36f9c87ea0427c86e4045497a1f3c9e2"><td class="memItemLeft" align="right" valign="top"><a id="a36f9c87ea0427c86e4045497a1f3c9e2"></a>
|
|
<a class="el" href="structaudio__tools_1_1_i_m_a_state.html">IMAState</a> </td><td class="memItemRight" valign="bottom"><b>ima_states</b> [2]</td></tr>
|
|
<tr class="separator:a36f9c87ea0427c86e4045497a1f3c9e2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a47385aa19435f5fca9d3083a748258c5"><td class="memItemLeft" align="right" valign="top"><a id="a47385aa19435f5fca9d3083a748258c5"></a>
|
|
<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> </td><td class="memItemRight" valign="bottom"><b>info</b></td></tr>
|
|
<tr class="separator:a47385aa19435f5fca9d3083a748258c5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae871caa30d42adf5b8c4e1faa06e47f1"><td class="memItemLeft" align="right" valign="top"><a id="ae871caa30d42adf5b8c4e1faa06e47f1"></a>
|
|
uint8_t * </td><td class="memItemRight" valign="bottom"><b>input_buffer</b> = nullptr</td></tr>
|
|
<tr class="separator:ae871caa30d42adf5b8c4e1faa06e47f1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1a95fcde18383614094824818184468d"><td class="memItemLeft" align="right" valign="top"><a id="a1a95fcde18383614094824818184468d"></a>
|
|
int32_t </td><td class="memItemRight" valign="bottom"><b>input_pos</b> = 0</td></tr>
|
|
<tr class="separator:a1a95fcde18383614094824818184468d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeaba7fcedcb403536c79ee7f04de17fc"><td class="memItemLeft" align="right" valign="top"><a id="aeaba7fcedcb403536c79ee7f04de17fc"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>is_notify_active</b> = true</td></tr>
|
|
<tr class="separator:aeaba7fcedcb403536c79ee7f04de17fc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a08d2a3449f250840171ef25487990223"><td class="memItemLeft" align="right" valign="top"><a id="a08d2a3449f250840171ef25487990223"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>isFirst</b> = true</td></tr>
|
|
<tr class="separator:a08d2a3449f250840171ef25487990223"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8cc8d1cb67b70386f41455552f3a56f4"><td class="memItemLeft" align="right" valign="top"><a id="a8cc8d1cb67b70386f41455552f3a56f4"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>isValid</b> = true</td></tr>
|
|
<tr class="separator:a8cc8d1cb67b70386f41455552f3a56f4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad35c4e2ef458c36e8d36676958cc9cd3"><td class="memItemLeft" align="right" valign="top"><a id="ad35c4e2ef458c36e8d36676958cc9cd3"></a>
|
|
<a class="el" href="classaudio__tools_1_1_vector.html">Vector</a>< <a class="el" href="classaudio__tools_1_1_audio_info_support.html">AudioInfoSupport</a> * > </td><td class="memItemRight" valign="bottom"><b>notify_vector</b></td></tr>
|
|
<tr class="separator:ad35c4e2ef458c36e8d36676958cc9cd3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab1e77b1e9512ce8dc31ef853e0abc02c"><td class="memItemLeft" align="right" valign="top"><a id="ab1e77b1e9512ce8dc31ef853e0abc02c"></a>
|
|
<a class="el" href="classaudio__tools_1_1_print.html">Print</a> * </td><td class="memItemRight" valign="bottom"><b>out</b></td></tr>
|
|
<tr class="separator:ab1e77b1e9512ce8dc31ef853e0abc02c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ef78c3a68dfd69313cd4383b93a0e47"><td class="memItemLeft" align="right" valign="top"><a id="a5ef78c3a68dfd69313cd4383b93a0e47"></a>
|
|
int16_t * </td><td class="memItemRight" valign="bottom"><b>output_buffer</b> = nullptr</td></tr>
|
|
<tr class="separator:a5ef78c3a68dfd69313cd4383b93a0e47"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acdad90adc3ba71f7b1e16444c23b5502"><td class="memItemLeft" align="right" valign="top"><a id="acdad90adc3ba71f7b1e16444c23b5502"></a>
|
|
<a class="el" href="classaudio__tools_1_1_print.html">Print</a> * </td><td class="memItemRight" valign="bottom"><b>p_print</b> = nullptr</td></tr>
|
|
<tr class="separator:acdad90adc3ba71f7b1e16444c23b5502"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aafe7cc7e1370d5f3ea8534f88cce064e"><td class="memItemLeft" align="right" valign="top"><a id="aafe7cc7e1370d5f3ea8534f88cce064e"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>remaining_bytes</b> = 0</td></tr>
|
|
<tr class="separator:aafe7cc7e1370d5f3ea8534f88cce064e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac89622cbb7df150e1aac16c6b1f92c03"><td class="memItemLeft" align="right" valign="top"><a id="ac89622cbb7df150e1aac16c6b1f92c03"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>samples_per_decoded_block</b> = 0</td></tr>
|
|
<tr class="separator:ac89622cbb7df150e1aac16c6b1f92c03"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Obsolete: <a class="el" href="classaudio__tools_1_1_wav_i_m_a_decoder.html" title="Obsolete: WavIMADecoder - based on WAVDecoder - We parse the header data as we receive it and send th...">WavIMADecoder</a> - based on <a class="el" href="classaudio__tools_1_1_w_a_v_decoder.html" title="A simple WAVDecoder: We parse the header data on the first record to determine the format....">WAVDecoder</a> - We parse the header data as we receive it and send the sound data to the stream which was indicated in the constructor. Only WAV files with WAVE_FORMAT_IMA_ADPCM are supported by this codec! </p>
|
|
<p>We recommend using the <a class="el" href="classaudio__tools_1_1_w_a_v_decoder.html" title="A simple WAVDecoder: We parse the header data on the first record to determine the format....">WAVDecoder</a> with a corresponding <a class="el" href="classaudio__tools_1_1_a_d_p_c_m_decoder.html" title="Decoder for ADPCM. Depends on https://github.com/pschatzmann/adpcm.">ADPCMDecoder</a> instead.</p>
|
|
<dl class="section author"><dt>Author</dt><dd>Phil Schatzmann </dd>
|
|
<dd>
|
|
Norman Ritz </dd></dl>
|
|
<dl class="section copyright"><dt>Copyright</dt><dd>GPLv3 </dd></dl>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="af3311b0c1e6c2ea362e91fca3b053f2b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af3311b0c1e6c2ea362e91fca3b053f2b">◆ </a></span>WavIMADecoder() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classaudio__tools_1_1_wav_i_m_a_decoder.html">WavIMADecoder</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classaudio__tools_1_1_print.html">Print</a> & </td>
|
|
<td class="paramname"><em>out_stream</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>active</em> = <code>true</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct a new <a class="el" href="classaudio__tools_1_1_wav_i_m_a_decoder.html" title="Obsolete: WavIMADecoder - based on WAVDecoder - We parse the header data as we receive it and send th...">WavIMADecoder</a> object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">out_stream</td><td>Output <a class="el" href="classaudio__tools_1_1_stream.html">Stream</a> to which we write the decoded result </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a61202c4d1b5ae76fd4a42b7ea0854362"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a61202c4d1b5ae76fd4a42b7ea0854362">◆ </a></span>WavIMADecoder() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classaudio__tools_1_1_wav_i_m_a_decoder.html">WavIMADecoder</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classaudio__tools_1_1_print.html">Print</a> & </td>
|
|
<td class="paramname"><em>out_stream</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classaudio__tools_1_1_audio_info_support.html">AudioInfoSupport</a> & </td>
|
|
<td class="paramname"><em>bi</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct a new <a class="el" href="classaudio__tools_1_1_wav_i_m_a_decoder.html" title="Obsolete: WavIMADecoder - based on WAVDecoder - We parse the header data as we receive it and send th...">WavIMADecoder</a> object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">out_stream</td><td>Output <a class="el" href="classaudio__tools_1_1_stream.html">Stream</a> to which we write the decoded result </td></tr>
|
|
<tr><td class="paramname">bi</td><td>Object that will be notified about the Audio Formt (Changes) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>src/AudioCodecs/<a class="el" href="_codec_wav_i_m_a_8h_source.html">CodecWavIMA.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
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
|
|
</small></address>
|
|
</body>
|
|
</html>
|