<!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"/> <title>GNU Radio 3.2.2 C++ API: gr_wavfile_source Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.2 --> <div class="contents"> <h1>gr_wavfile_source Class Reference<br/> <small> [<a class="el" href="group__source__blk.html">Signal Sources</a>]</small> </h1><!-- doxytag: class="gr_wavfile_source" --><!-- doxytag: inherits="gr_sync_block" --> <p>Read stream from a Microsoft PCM (.wav) file, output floats. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="gr__wavfile__source_8h_source.html">gr_wavfile_source.h</a>></code></p> <div class="dynheader"> Inheritance diagram for gr_wavfile_source:</div> <div class="dynsection"> <div class="center"><img src="classgr__wavfile__source__inherit__graph.png" border="0" usemap="#gr__wavfile__source_inherit__map" alt="Inheritance graph"/></div> <map name="gr__wavfile__source_inherit__map" id="gr__wavfile__source_inherit__map"> <area shape="rect" id="node2" href="classgr__sync__block.html" title="synchronous 1:1 input to output with historyOverride work to provide the signal processing..." alt="" coords="15,160,121,189"/><area shape="rect" id="node4" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing..." alt="" coords="33,83,103,112"/><area shape="rect" id="node6" href="classgr__basic__block.html" title="The abstract base class for all signal processing blocks.Basic blocks are the bare..." alt="" coords="13,5,123,35"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classgr__wavfile__source-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__wavfile__source.html#a27f6016605f5d89ebb79c04ac8086315">~gr_wavfile_source</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__wavfile__source.html#a222de96b0c15ba344a17f1b37f6d38f6">work</a> (int noutput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items, <a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">just like <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197" title="compute output items from input items">gr_block::general_work</a>, only this arranges to call consume_each for you <a href="#a222de96b0c15ba344a17f1b37f6d38f6"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__wavfile__source.html#a57ca32ca943d17f86287ad41f4b2baa5">sample_rate</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Read the sample rate as specified in the wav file header. <a href="#a57ca32ca943d17f86287ad41f4b2baa5"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__wavfile__source.html#ad0f364a65212fa443b56a23328061908">bits_per_sample</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of bits per sample as specified in the wav file header. Only 8 or 16 bit are supported here. <a href="#ad0f364a65212fa443b56a23328061908"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__wavfile__source.html#a80561ba64ab0c3e9e8840a48a0276b83">channels</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of channels in the wav file as specified in the wav file header. This is also the max number of outputs you can have. <a href="#a80561ba64ab0c3e9e8840a48a0276b83"></a><br/></td></tr> <tr><td colspan="2"><h2>Friends</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_wavfile_source_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__wavfile__source.html#ae82a61e2429deb2ec48d9515262ecb44">gr_make_wavfile_source</a> (const char *filename, <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> repeat)</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Read stream from a Microsoft PCM (.wav) file, output floats. </p> <p>Unless otherwise called, values are within [-1;1]. Check <a class="el" href="classgr__wavfile__source.html#ae82a61e2429deb2ec48d9515262ecb44">gr_make_wavfile_source()</a> for extra info. </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a27f6016605f5d89ebb79c04ac8086315"></a><!-- doxytag: member="gr_wavfile_source::~gr_wavfile_source" ref="a27f6016605f5d89ebb79c04ac8086315" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gr_wavfile_source::~gr_wavfile_source </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ad0f364a65212fa443b56a23328061908"></a><!-- doxytag: member="gr_wavfile_source::bits_per_sample" ref="ad0f364a65212fa443b56a23328061908" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int gr_wavfile_source::bits_per_sample </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Return the number of bits per sample as specified in the wav file header. Only 8 or 16 bit are supported here. </p> </div> </div> <a class="anchor" id="a80561ba64ab0c3e9e8840a48a0276b83"></a><!-- doxytag: member="gr_wavfile_source::channels" ref="a80561ba64ab0c3e9e8840a48a0276b83" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int gr_wavfile_source::channels </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Return the number of channels in the wav file as specified in the wav file header. This is also the max number of outputs you can have. </p> </div> </div> <a class="anchor" id="a57ca32ca943d17f86287ad41f4b2baa5"></a><!-- doxytag: member="gr_wavfile_source::sample_rate" ref="a57ca32ca943d17f86287ad41f4b2baa5" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned int gr_wavfile_source::sample_rate </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Read the sample rate as specified in the wav file header. </p> </div> </div> <a class="anchor" id="a222de96b0c15ba344a17f1b37f6d38f6"></a><!-- doxytag: member="gr_wavfile_source::work" ref="a222de96b0c15ba344a17f1b37f6d38f6" args="(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int gr_wavfile_source::work </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>noutput_items</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> & </td> <td class="paramname"> <em>input_items</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> & </td> <td class="paramname"> <em>output_items</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>just like <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197" title="compute output items from input items">gr_block::general_work</a>, only this arranges to call consume_each for you </p> <p>The user must override work to define the signal processing code </p> <p>Implements <a class="el" href="classgr__sync__block.html#a0c523f4285a6eb690f677ee6295ab117">gr_sync_block</a>.</p> </div> </div> <hr/><h2>Friends And Related Function Documentation</h2> <a class="anchor" id="ae82a61e2429deb2ec48d9515262ecb44"></a><!-- doxytag: member="gr_wavfile_source::gr_make_wavfile_source" ref="ae82a61e2429deb2ec48d9515262ecb44" args="(const char *filename, bool repeat)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_wavfile_source_sptr</a> gr_make_wavfile_source </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>filename</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td> <td class="paramname"> <em>repeat</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [friend]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="gr__wavfile__source_8h_source.html">gr_wavfile_source.h</a></li> </ul> </div> <hr size="1"/><address style="text-align: right;"><small>Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address> </body> </html>