<!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.8.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Audaspace: libsndfile/SndFileWriter.h Source File</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">Audaspace  <span id="projectnumber">1.3.0</span> </div> <div id="projectbrief">A high level audio library.</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> <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'); /* @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="dir_1e60f77674db49603f90ecbfafaa8328.html">libsndfile</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">SndFileWriter.h</div> </div> </div><!--header--> <div class="contents"> <a href="SndFileWriter_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*******************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright 2009-2016 Jörg Müller</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * You may obtain a copy of the License at</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> ******************************************************************************/</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifdef LIBSNDFILE_PLUGIN</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define AUD_BUILD_PLUGIN</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "<a class="code" href="IWriter_8h.html">file/IWriter.h</a>"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <sndfile.h></span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <a class="code" href="Audaspace_8h.html#acd7584504197a1397aaf57af797e1813">AUD_NAMESPACE_BEGIN</a></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classSndFileWriter.html"> 39</a></span> <span class="keyword">class </span><a class="code" href="Audaspace_8h.html#ae80c5c0f6ce55934dfa1823d908fa25f">AUD_PLUGIN_API</a> <a class="code" href="classSndFileWriter.html">SndFileWriter</a> : <span class="keyword">public</span> <a class="code" href="classIWriter.html">IWriter</a></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordtype">int</span> m_position;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="structDeviceSpecs.html">DeviceSpecs</a> m_specs;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  SNDFILE* m_sndfile;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// delete copy constructor and operator=</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="classSndFileWriter.html">SndFileWriter</a>(<span class="keyword">const</span> <a class="code" href="classSndFileWriter.html">SndFileWriter</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <a class="code" href="classSndFileWriter.html">SndFileWriter</a>& operator=(<span class="keyword">const</span> <a class="code" href="classSndFileWriter.html">SndFileWriter</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <a class="code" href="classSndFileWriter.html">SndFileWriter</a>(std::string filename, <a class="code" href="structDeviceSpecs.html">DeviceSpecs</a> specs, <a class="code" href="IWriter_8h.html#a5cf5525d31d834a76660f18724233639">Container</a> format, <a class="code" href="IWriter_8h.html#a87487bf84e831b40083eb736cc1a237c">Codec</a> codec, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> bitrate);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">virtual</span> ~<a class="code" href="classSndFileWriter.html">SndFileWriter</a>();</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classIWriter.html#a58639a6882bcc9204d507f7d0e301df4">getPosition</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">virtual</span> <a class="code" href="structDeviceSpecs.html">DeviceSpecs</a> <a class="code" href="classIWriter.html#ad76314294b41de306cc7de82909347b9">getSpecs</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classIWriter.html#a5cb757ee0654bf29f9ac2419911210f5">write</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> length, <a class="code" href="Audaspace_8h.html#aa0798f7ea0975b143a1d9deac8c05d43">sample_t</a>* buffer);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> };</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <a class="code" href="Audaspace_8h.html#a4cf7088a9bb0256563f28fd13c80b066">AUD_NAMESPACE_END</a></div><div class="ttc" id="Audaspace_8h_html_acd7584504197a1397aaf57af797e1813"><div class="ttname"><a href="Audaspace_8h.html#acd7584504197a1397aaf57af797e1813">AUD_NAMESPACE_BEGIN</a></div><div class="ttdeci">#define AUD_NAMESPACE_BEGIN</div><div class="ttdoc">Opens the audaspace namespace aud.</div><div class="ttdef"><b>Definition:</b> Audaspace.h:116</div></div> <div class="ttc" id="classIWriter_html_a58639a6882bcc9204d507f7d0e301df4"><div class="ttname"><a href="classIWriter.html#a58639a6882bcc9204d507f7d0e301df4">IWriter::getPosition</a></div><div class="ttdeci">virtual int getPosition() const =0</div><div class="ttdoc">Returns how many samples have been written so far.</div></div> <div class="ttc" id="structDeviceSpecs_html"><div class="ttname"><a href="structDeviceSpecs.html">DeviceSpecs</a></div><div class="ttdoc">Specification of a sound device.</div><div class="ttdef"><b>Definition:</b> Specification.h:119</div></div> <div class="ttc" id="Audaspace_8h_html_aa0798f7ea0975b143a1d9deac8c05d43"><div class="ttname"><a href="Audaspace_8h.html#aa0798f7ea0975b143a1d9deac8c05d43">sample_t</a></div><div class="ttdeci">float sample_t</div><div class="ttdoc">Sample type.(float samples)</div><div class="ttdef"><b>Definition:</b> Audaspace.h:126</div></div> <div class="ttc" id="IWriter_8h_html_a87487bf84e831b40083eb736cc1a237c"><div class="ttname"><a href="IWriter_8h.html#a87487bf84e831b40083eb736cc1a237c">Codec</a></div><div class="ttdeci">Codec</div><div class="ttdoc">Audio codecs for writers.</div><div class="ttdef"><b>Definition:</b> IWriter.h:43</div></div> <div class="ttc" id="Audaspace_8h_html_a4cf7088a9bb0256563f28fd13c80b066"><div class="ttname"><a href="Audaspace_8h.html#a4cf7088a9bb0256563f28fd13c80b066">AUD_NAMESPACE_END</a></div><div class="ttdeci">#define AUD_NAMESPACE_END</div><div class="ttdoc">Closes the audaspace namespace aud.</div><div class="ttdef"><b>Definition:</b> Audaspace.h:119</div></div> <div class="ttc" id="IWriter_8h_html_a5cf5525d31d834a76660f18724233639"><div class="ttname"><a href="IWriter_8h.html#a5cf5525d31d834a76660f18724233639">Container</a></div><div class="ttdeci">Container</div><div class="ttdoc">Container formats for writers.</div><div class="ttdef"><b>Definition:</b> IWriter.h:30</div></div> <div class="ttc" id="classIWriter_html_a5cb757ee0654bf29f9ac2419911210f5"><div class="ttname"><a href="classIWriter.html#a5cb757ee0654bf29f9ac2419911210f5">IWriter::write</a></div><div class="ttdeci">virtual void write(unsigned int length, sample_t *buffer)=0</div><div class="ttdoc">Request to write the next length samples out into the sink.</div></div> <div class="ttc" id="classIWriter_html_ad76314294b41de306cc7de82909347b9"><div class="ttname"><a href="classIWriter.html#ad76314294b41de306cc7de82909347b9">IWriter::getSpecs</a></div><div class="ttdeci">virtual DeviceSpecs getSpecs() const =0</div><div class="ttdoc">Returns the specification of the audio data being written into the sink.</div></div> <div class="ttc" id="Audaspace_8h_html_ae80c5c0f6ce55934dfa1823d908fa25f"><div class="ttname"><a href="Audaspace_8h.html#ae80c5c0f6ce55934dfa1823d908fa25f">AUD_PLUGIN_API</a></div><div class="ttdeci">#define AUD_PLUGIN_API</div><div class="ttdoc">Used for exporting symbols in the shared library.</div><div class="ttdef"><b>Definition:</b> Audaspace.h:94</div></div> <div class="ttc" id="classIWriter_html"><div class="ttname"><a href="classIWriter.html">IWriter</a></div><div class="ttdoc">This class represents a sound sink where audio data can be written to.</div><div class="ttdef"><b>Definition:</b> IWriter.h:60</div></div> <div class="ttc" id="classSndFileWriter_html"><div class="ttname"><a href="classSndFileWriter.html">SndFileWriter</a></div><div class="ttdoc">This class writes a sound file via libsndfile.</div><div class="ttdef"><b>Definition:</b> SndFileWriter.h:39</div></div> <div class="ttc" id="IWriter_8h_html"><div class="ttname"><a href="IWriter_8h.html">IWriter.h</a></div><div class="ttdoc">Defines the IWriter interface as well as Container and Codec types.</div></div> </div><!-- fragment --></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.15 </small></address> </body> </html>