<!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_sink.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GNU Radio 3.2.2 C++ API</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('gr__wavfile__sink_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<h1>gr_wavfile_sink.h</h1> </div>
</div>
<div class="contents">
<a href="gr__wavfile__sink_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright 2008 Free Software Foundation, Inc.</span>
<a name="l00004"></a>00004 <span class="comment"> * </span>
<a name="l00005"></a>00005 <span class="comment"> * This file is part of GNU Radio</span>
<a name="l00006"></a>00006 <span class="comment"> * </span>
<a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span>
<a name="l00010"></a>00010 <span class="comment"> * any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> * </span>
<a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> * </span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00018"></a>00018 <span class="comment"> * along with GNU Radio; see the file COPYING. If not, write to</span>
<a name="l00019"></a>00019 <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span>
<a name="l00020"></a>00020 <span class="comment"> * Boston, MA 02110-1301, USA.</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef INCLUDED_GR_WAVFILE_SINK_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GR_WAVFILE_SINK_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <gr_sync_block.h></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <<a class="code" href="gr__file__sink__base_8h.html">gr_file_sink_base.h</a>></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <gnuradio/omnithread.h></span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="keyword">class </span><a class="code" href="classgr__wavfile__sink.html" title="Read stream from a Microsoft PCM (.wav) file, output floats.">gr_wavfile_sink</a>;
<a name="l00031"></a>00031 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr<gr_wavfile_sink></a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_wavfile_sink_sptr</a>;
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="comment">/*</span>
<a name="l00034"></a>00034 <span class="comment"> * \p filename The .wav file to be opened</span>
<a name="l00035"></a>00035 <span class="comment"> * \p n_channels Number of channels (2 = stereo or I/Q output)</span>
<a name="l00036"></a>00036 <span class="comment"> * \p sample_rate Sample rate [S/s]</span>
<a name="l00037"></a>00037 <span class="comment"> * \p bits_per_sample 16 or 8 bit, default is 16</span>
<a name="l00038"></a>00038 <span class="comment"> */</span>
<a name="l00039"></a>00039 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_wavfile_sink_sptr</a>
<a name="l00040"></a>00040 <a class="code" href="gr__wavfile__sink_8h.html#a915a9e0cc9b733cfdcf8e047e7bb90be">gr_make_wavfile_sink</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *filename,
<a name="l00041"></a>00041 <span class="keywordtype">int</span> n_channels,
<a name="l00042"></a>00042 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sample_rate,
<a name="l00043"></a>00043 <span class="keywordtype">int</span> bits_per_sample = 16);
<a name="l00044"></a>00044 <span class="comment"></span>
<a name="l00045"></a>00045 <span class="comment">/*!</span>
<a name="l00046"></a>00046 <span class="comment"> * \brief Read stream from a Microsoft PCM (.wav) file, output floats</span>
<a name="l00047"></a>00047 <span class="comment"> *</span>
<a name="l00048"></a>00048 <span class="comment"> * Values are within [-1;1].</span>
<a name="l00049"></a>00049 <span class="comment"> * Check gr_make_wavfile_source() for extra info.</span>
<a name="l00050"></a>00050 <span class="comment"> *</span>
<a name="l00051"></a>00051 <span class="comment"> * \ingroup sink_blk</span>
<a name="l00052"></a>00052 <span class="comment"> */</span>
<a name="l00053"></a><a class="code" href="classgr__wavfile__sink.html">00053</a> <span class="keyword">class </span><a class="code" href="classgr__wavfile__sink.html" title="Read stream from a Microsoft PCM (.wav) file, output floats.">gr_wavfile_sink</a> : <span class="keyword">public</span> <a class="code" href="classgr__sync__block.html" title="synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...">gr_sync_block</a>
<a name="l00054"></a>00054 {
<a name="l00055"></a>00055 <span class="keyword">private</span>:
<a name="l00056"></a>00056 <span class="keyword">friend</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_wavfile_sink_sptr</a> <a class="code" href="classgr__wavfile__sink.html#a681ee7d6dd9c45c843907ef2153ae6e4">gr_make_wavfile_sink</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *filename,
<a name="l00057"></a>00057 <span class="keywordtype">int</span> n_channels,
<a name="l00058"></a>00058 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sample_rate,
<a name="l00059"></a>00059 <span class="keywordtype">int</span> bits_per_sample);
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <a class="code" href="classgr__wavfile__sink.html" title="Read stream from a Microsoft PCM (.wav) file, output floats.">gr_wavfile_sink</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *filename,
<a name="l00062"></a>00062 <span class="keywordtype">int</span> n_channels,
<a name="l00063"></a>00063 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sample_rate,
<a name="l00064"></a>00064 <span class="keywordtype">int</span> bits_per_sample);
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="keywordtype">unsigned</span> d_sample_rate;
<a name="l00067"></a>00067 <span class="keywordtype">int</span> d_nchans;
<a name="l00068"></a>00068 <span class="keywordtype">unsigned</span> d_sample_count;
<a name="l00069"></a>00069 <span class="keywordtype">int</span> d_bytes_per_sample;
<a name="l00070"></a>00070 <span class="keywordtype">int</span> d_bytes_per_sample_new;
<a name="l00071"></a>00071 <span class="keywordtype">int</span> d_max_sample_val;
<a name="l00072"></a>00072 <span class="keywordtype">int</span> d_min_sample_val;
<a name="l00073"></a>00073 <span class="keywordtype">int</span> d_normalize_shift;
<a name="l00074"></a>00074 <span class="keywordtype">int</span> d_normalize_fac;
<a name="l00075"></a>00075
<a name="l00076"></a>00076 FILE *d_fp;
<a name="l00077"></a>00077 FILE *d_new_fp;
<a name="l00078"></a>00078 <span class="keywordtype">bool</span> d_updated;
<a name="l00079"></a>00079 <a class="code" href="classomni__mutex.html">omni_mutex</a> d_mutex;
<a name="l00080"></a>00080 <span class="comment"></span>
<a name="l00081"></a>00081 <span class="comment"> /*!</span>
<a name="l00082"></a>00082 <span class="comment"> * \brief Convert a sample value within [-1;+1] to a corresponding</span>
<a name="l00083"></a>00083 <span class="comment"> * short integer value</span>
<a name="l00084"></a>00084 <span class="comment"> */</span>
<a name="l00085"></a>00085 <span class="keywordtype">short</span> convert_to_short(<span class="keywordtype">float</span> sample);
<a name="l00086"></a>00086 <span class="comment"></span>
<a name="l00087"></a>00087 <span class="comment"> /*!</span>
<a name="l00088"></a>00088 <span class="comment"> * \brief Writes information to the WAV header which is not available</span>
<a name="l00089"></a>00089 <span class="comment"> * a-priori (chunk size etc.) and closes the file. Not thread-safe and</span>
<a name="l00090"></a>00090 <span class="comment"> * assumes d_fp is a valid file pointer, should thus only be called by</span>
<a name="l00091"></a>00091 <span class="comment"> * other methods.</span>
<a name="l00092"></a>00092 <span class="comment"> */</span>
<a name="l00093"></a>00093 <span class="keywordtype">void</span> close_wav();
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="keyword">public</span>:
<a name="l00096"></a>00096 <a class="code" href="classgr__wavfile__sink.html#a14bc835ccf40e076b95ca3da70d80f35">~gr_wavfile_sink</a> ();
<a name="l00097"></a>00097 <span class="comment"></span>
<a name="l00098"></a>00098 <span class="comment"> /*!</span>
<a name="l00099"></a>00099 <span class="comment"> * \brief Opens a new file and writes a WAV header. Thread-safe.</span>
<a name="l00100"></a>00100 <span class="comment"> */</span>
<a name="l00101"></a>00101 <span class="keywordtype">bool</span> <a class="code" href="classgr__wavfile__sink.html#a51cb540475618ad3c5563d02860d99bd" title="Opens a new file and writes a WAV header. Thread-safe.">open</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* filename);
<a name="l00102"></a>00102 <span class="comment"></span>
<a name="l00103"></a>00103 <span class="comment"> /*!</span>
<a name="l00104"></a>00104 <span class="comment"> * \brief Closes the currently active file and completes the WAV</span>
<a name="l00105"></a>00105 <span class="comment"> * header. Thread-safe.</span>
<a name="l00106"></a>00106 <span class="comment"> */</span>
<a name="l00107"></a>00107 <span class="keywordtype">void</span> <a class="code" href="classgr__wavfile__sink.html#a53790ce139385802d2249d94a3872b3b" title="Closes the currently active file and completes the WAV header. Thread-safe.">close</a>();
<a name="l00108"></a>00108 <span class="comment"></span>
<a name="l00109"></a>00109 <span class="comment"> /*!</span>
<a name="l00110"></a>00110 <span class="comment"> * \brief If any file changes have occurred, update now. This is called</span>
<a name="l00111"></a>00111 <span class="comment"> * internally by work() and thus doesn't usually need to be called by</span>
<a name="l00112"></a>00112 <span class="comment"> * hand.</span>
<a name="l00113"></a>00113 <span class="comment"> */</span>
<a name="l00114"></a>00114 <span class="keywordtype">void</span> <a class="code" href="classgr__wavfile__sink.html#a35f3a886f6ae00996ad92fdda3c801aa" title="If any file changes have occurred, update now. This is called internally by work() and thus doesn&#39...">do_update</a>();
<a name="l00115"></a>00115 <span class="comment"></span>
<a name="l00116"></a>00116 <span class="comment"> /*!</span>
<a name="l00117"></a>00117 <span class="comment"> * \brief Set the sample rate. This will not affect the WAV file</span>
<a name="l00118"></a>00118 <span class="comment"> * currently opened. Any following open() calls will use this new</span>
<a name="l00119"></a>00119 <span class="comment"> * sample rate.</span>
<a name="l00120"></a>00120 <span class="comment"> */</span>
<a name="l00121"></a>00121 <span class="keywordtype">void</span> <a class="code" href="classgr__wavfile__sink.html#a7dbab3fa08b9a3ba1e3d49e9ac2b919a" title="Set the sample rate. This will not affect the WAV file currently opened. Any following open() calls w...">set_sample_rate</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sample_rate);
<a name="l00122"></a>00122 <span class="comment"></span>
<a name="l00123"></a>00123 <span class="comment"> /*!</span>
<a name="l00124"></a>00124 <span class="comment"> * \brief Set bits per sample. This will not affect the WAV file</span>
<a name="l00125"></a>00125 <span class="comment"> * currently opened (see set_sample_rate()). If the value is neither</span>
<a name="l00126"></a>00126 <span class="comment"> * 8 nor 16, the call is ignored and the current value is kept.</span>
<a name="l00127"></a>00127 <span class="comment"> */</span>
<a name="l00128"></a>00128 <span class="keywordtype">void</span> <a class="code" href="classgr__wavfile__sink.html#aa4a5e558c4056a947fb3fa5544fa5618" title="Set bits per sample. This will not affect the WAV file currently opened (see set_sample_rate()). If the value is neither 8 nor 16, the call is ignored and the current value is kept.">set_bits_per_sample</a>(<span class="keywordtype">int</span> bits_per_sample);
<a name="l00129"></a>00129
<a name="l00130"></a>00130
<a name="l00131"></a>00131 <span class="keywordtype">int</span> <a class="code" href="classgr__wavfile__sink.html#a8f899963a641af16db502576990462d2" title="just like gr_block::general_work, only this arranges to call consume_each for you">work</a>(<span class="keywordtype">int</span> noutput_items,
<a name="l00132"></a>00132 <a class="code" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items,
<a name="l00133"></a>00133 <a class="code" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items);
<a name="l00134"></a>00134
<a name="l00135"></a>00135 };
<a name="l00136"></a>00136
<a name="l00137"></a>00137 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_GR_WAVFILE_SINK_H */</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="gr__wavfile__sink_8h.html">gr_wavfile_sink.h</a> </li>
<li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
5537
