<!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: audio_alsa_sink.h Source File</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 --> <h1>audio_alsa_sink.h</h1><a href="audio__alsa__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 2004 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_AUDIO_ALSA_SINK_H</span> <a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_AUDIO_ALSA_SINK_H</span> <a name="l00025"></a>00025 <span class="preprocessor"></span> <a name="l00026"></a>00026 <span class="comment">// use new ALSA API</span> <a name="l00027"></a><a class="code" href="audio__alsa__sink_8h.html#a705350c14c1f28bb8d6d57dafbf9ccff">00027</a> <span class="preprocessor">#define ALSA_PCM_NEW_HW_PARAMS_API</span> <a name="l00028"></a><a class="code" href="audio__alsa__sink_8h.html#a5b61c3b8eee0c6801209e39a760b928a">00028</a> <span class="preprocessor"></span><span class="preprocessor">#define ALSA_PCM_NEW_SW_PARAMS_API</span> <a name="l00029"></a>00029 <span class="preprocessor"></span> <a name="l00030"></a>00030 <span class="preprocessor">#include <<a class="code" href="gr__sync__block_8h.html">gr_sync_block.h</a>></span> <a name="l00031"></a>00031 <span class="preprocessor">#include <string></span> <a name="l00032"></a>00032 <span class="preprocessor">#include <alsa/asoundlib.h></span> <a name="l00033"></a>00033 <span class="preprocessor">#include <stdexcept></span> <a name="l00034"></a>00034 <a name="l00035"></a>00035 <a name="l00036"></a>00036 <span class="keyword">class </span><a class="code" href="classaudio__alsa__sink.html" title="audio sink using ALSA">audio_alsa_sink</a>; <a name="l00037"></a>00037 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr<audio_alsa_sink></a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">audio_alsa_sink_sptr</a>; <a name="l00038"></a>00038 <span class="comment"></span> <a name="l00039"></a>00039 <span class="comment">/*!</span> <a name="l00040"></a>00040 <span class="comment"> * \brief make an alsa audio sink.</span> <a name="l00041"></a>00041 <span class="comment"> *</span> <a name="l00042"></a>00042 <span class="comment"> * \param sampling_rate sampling rate in Hz</span> <a name="l00043"></a>00043 <span class="comment"> * \param device_name ALSA pcm device name, e.g., "hw:0,0"</span> <a name="l00044"></a>00044 <span class="comment"> * \param ok_to_block (currently ignored)</span> <a name="l00045"></a>00045 <span class="comment"> */</span> <a name="l00046"></a>00046 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">audio_alsa_sink_sptr</a> <a name="l00047"></a>00047 <a class="code" href="audio__alsa__sink_8h.html#ae0229548e70e56e4e741882d4d51efe6" title="make an alsa audio sink.">audio_alsa_make_sink</a> (<span class="keywordtype">int</span> sampling_rate, <a name="l00048"></a>00048 <span class="keyword">const</span> std::string device_name = <span class="stringliteral">""</span>, <a name="l00049"></a>00049 <span class="keywordtype">bool</span> ok_to_block = <span class="keyword">true</span>); <a name="l00050"></a>00050 <span class="comment"></span> <a name="l00051"></a>00051 <span class="comment">/*!</span> <a name="l00052"></a>00052 <span class="comment"> * \brief audio sink using ALSA</span> <a name="l00053"></a>00053 <span class="comment"> *</span> <a name="l00054"></a>00054 <span class="comment"> * The sink has N input streams of floats, where N depends</span> <a name="l00055"></a>00055 <span class="comment"> * on the hardware characteristics of the selected device.</span> <a name="l00056"></a>00056 <span class="comment"> *</span> <a name="l00057"></a>00057 <span class="comment"> * Input samples must be in the range [-1,1].</span> <a name="l00058"></a>00058 <span class="comment"> */</span> <a name="l00059"></a><a class="code" href="classaudio__alsa__sink.html">00059</a> <span class="keyword">class </span><a class="code" href="classaudio__alsa__sink.html" title="audio sink using ALSA">audio_alsa_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...">gr_sync_block</a> { <a name="l00060"></a>00060 <span class="keyword">friend</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">audio_alsa_sink_sptr</a> <a name="l00061"></a>00061 <a class="code" href="classaudio__alsa__sink.html#abe79afff18aa8fdb0f0eba51f3c4f3e5" title="make an alsa audio sink.">audio_alsa_make_sink</a> (<span class="keywordtype">int</span> sampling_rate, <span class="keyword">const</span> std::string device_name, <a name="l00062"></a>00062 <span class="keywordtype">bool</span> ok_to_block); <a name="l00063"></a>00063 <a name="l00064"></a>00064 <span class="comment">// typedef for pointer to class work method</span> <a name="l00065"></a>00065 <span class="keyword">typedef</span> int (<a class="code" href="classaudio__alsa__sink.html" title="audio sink using ALSA">audio_alsa_sink</a>::*work_t)(<span class="keywordtype">int</span> noutput_items, <a name="l00066"></a>00066 <a class="code" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items, <a name="l00067"></a>00067 <a class="code" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items); <a name="l00068"></a>00068 <a name="l00069"></a>00069 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> d_sampling_rate; <a name="l00070"></a>00070 std::string d_device_name; <a name="l00071"></a>00071 snd_pcm_t *d_pcm_handle; <a name="l00072"></a>00072 snd_pcm_hw_params_t *d_hw_params; <a name="l00073"></a>00073 snd_pcm_sw_params_t *d_sw_params; <a name="l00074"></a>00074 snd_pcm_format_t d_format; <a name="l00075"></a>00075 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> d_nperiods; <a name="l00076"></a>00076 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> d_period_time_us; <span class="comment">// microseconds</span> <a name="l00077"></a>00077 snd_pcm_uframes_t d_period_size; <span class="comment">// in frames</span> <a name="l00078"></a>00078 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> d_buffer_size_bytes; <span class="comment">// sizeof of d_buffer</span> <a name="l00079"></a>00079 <span class="keywordtype">char</span> *d_buffer; <a name="l00080"></a>00080 work_t d_worker; <span class="comment">// the work method to use</span> <a name="l00081"></a>00081 <span class="keywordtype">bool</span> d_special_case_mono_to_stereo; <a name="l00082"></a>00082 <a name="l00083"></a>00083 <span class="comment">// random stats</span> <a name="l00084"></a>00084 <span class="keywordtype">int</span> d_nunderuns; <span class="comment">// count of underruns</span> <a name="l00085"></a>00085 <span class="keywordtype">int</span> d_nsuspends; <span class="comment">// count of suspends</span> <a name="l00086"></a>00086 <a name="l00087"></a>00087 <span class="keywordtype">void</span> output_error_msg (<span class="keyword">const</span> <span class="keywordtype">char</span> *msg, <span class="keywordtype">int</span> err); <a name="l00088"></a>00088 <span class="keywordtype">void</span> bail (<span class="keyword">const</span> <span class="keywordtype">char</span> *msg, <span class="keywordtype">int</span> err) <span class="keywordflow">throw</span> (std::runtime_error); <a name="l00089"></a>00089 <a name="l00090"></a>00090 <span class="keyword">protected</span>: <a name="l00091"></a>00091 <a class="code" href="classaudio__alsa__sink.html#a211ce746804f2008b50468a22fbba6e0">audio_alsa_sink</a> (<span class="keywordtype">int</span> sampling_rate, <span class="keyword">const</span> std::string device_name, <a name="l00092"></a>00092 <span class="keywordtype">bool</span> ok_to_block); <a name="l00093"></a>00093 <a name="l00094"></a>00094 <span class="keyword">public</span>: <a name="l00095"></a>00095 <a class="code" href="classaudio__alsa__sink.html#a989b68ae3bce56a99e5f57961afb79ca">~audio_alsa_sink</a> (); <a name="l00096"></a>00096 <a name="l00097"></a>00097 <span class="keywordtype">bool</span> <a class="code" href="classaudio__alsa__sink.html#a656906899e19476cc83337c122ec13a9" title="Confirm that ninputs and noutputs is an acceptable combination.">check_topology</a> (<span class="keywordtype">int</span> ninputs, <span class="keywordtype">int</span> noutputs); <a name="l00098"></a>00098 <a name="l00099"></a>00099 <span class="keywordtype">int</span> <a class="code" href="classaudio__alsa__sink.html#ad9e474188a2ab5e15318bc6b07450084" 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="l00100"></a>00100 <a class="code" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items, <a name="l00101"></a>00101 <a class="code" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items); <a name="l00102"></a>00102 <a name="l00103"></a>00103 <a name="l00104"></a>00104 <span class="keyword">protected</span>: <a name="l00105"></a>00105 <span class="keywordtype">bool</span> <a class="code" href="classaudio__alsa__sink.html#a695706819ce9e3e5c9d35b74c44977c8">write_buffer</a> (<span class="keyword">const</span> <span class="keywordtype">void</span> *buffer, <span class="keywordtype">unsigned</span> nframes, <span class="keywordtype">unsigned</span> sizeof_frame); <a name="l00106"></a>00106 <a name="l00107"></a>00107 <span class="keywordtype">int</span> <a class="code" href="classaudio__alsa__sink.html#af0f16570196bca4d0828c5bb8a379cfe">work_s16</a> (<span class="keywordtype">int</span> noutput_items, <a name="l00108"></a>00108 <a class="code" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items, <a name="l00109"></a>00109 <a class="code" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items); <a name="l00110"></a>00110 <a name="l00111"></a>00111 <span class="keywordtype">int</span> <a class="code" href="classaudio__alsa__sink.html#a1c7cc1947e4310c5c9994130e588af2c">work_s16_1x2</a> (<span class="keywordtype">int</span> noutput_items, <a name="l00112"></a>00112 <a class="code" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items, <a name="l00113"></a>00113 <a class="code" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items); <a name="l00114"></a>00114 <a name="l00115"></a>00115 <span class="keywordtype">int</span> <a class="code" href="classaudio__alsa__sink.html#ad27a55858ad12b9a764aa455e7a2149d">work_s32</a> (<span class="keywordtype">int</span> noutput_items, <a name="l00116"></a>00116 <a class="code" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items, <a name="l00117"></a>00117 <a class="code" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items); <a name="l00118"></a>00118 <a name="l00119"></a>00119 <span class="keywordtype">int</span> <a class="code" href="classaudio__alsa__sink.html#ac12ba0933d6dab3872c434f0ca3d4a16">work_s32_1x2</a> (<span class="keywordtype">int</span> noutput_items, <a name="l00120"></a>00120 <a class="code" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items, <a name="l00121"></a>00121 <a class="code" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items); <a name="l00122"></a>00122 }; <a name="l00123"></a>00123 <a name="l00124"></a>00124 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_AUDIO_ALSA_SINK_H */</span> </pre></div></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>