<!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.3.0 C++ API: audio_portaudio_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.3 -->
<h1>audio_portaudio_sink.h</h1><a href="audio__portaudio__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 2006 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 <span class="preprocessor">#ifndef INCLUDED_AUDIO_PORTAUDIO_SINK_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_AUDIO_PORTAUDIO_SINK_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include <<a class="code" href="gr__sync__block_8h.html">gr_sync_block.h</a>></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <<a class="code" href="gr__buffer_8h.html">gr_buffer.h</a>></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <<a class="code" href="thread_8h.html">gruel/thread.h</a>></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <string></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <portaudio.h></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <stdexcept></span>
<a name="l00031"></a>00031 <span class="comment">//#include <gri_logger.h></span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keyword">class </span><a class="code" href="classaudio__portaudio__sink.html">audio_portaudio_sink</a>;
<a name="l00034"></a>00034 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr<audio_portaudio_sink></a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">audio_portaudio_sink_sptr</a>;
<a name="l00035"></a>00035 <span class="comment"></span>
<a name="l00036"></a>00036 <span class="comment">/*!</span>
<a name="l00037"></a>00037 <span class="comment"> * \brief PORTAUDIO audio sink.</span>
<a name="l00038"></a>00038 <span class="comment"> *</span>
<a name="l00039"></a>00039 <span class="comment"> * \param sampling_rate sampling rate in Hz</span>
<a name="l00040"></a>00040 <span class="comment"> * \param device_name PORTAUDIO device name, e.g., "pa:"</span>
<a name="l00041"></a>00041 <span class="comment"> * \param ok_to_block true if it's ok for us to block</span>
<a name="l00042"></a>00042 <span class="comment"> */</span>
<a name="l00043"></a>00043 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">audio_portaudio_sink_sptr</a>
<a name="l00044"></a>00044 <a class="code" href="audio__portaudio__sink_8h.html#a319b221559ad2412619020163f5fa930" title="PORTAUDIO audio sink.">audio_portaudio_make_sink</a> (<span class="keywordtype">int</span> sampling_rate,
<a name="l00045"></a>00045 <span class="keyword">const</span> std::string device_name = <span class="stringliteral">""</span>,
<a name="l00046"></a>00046 <span class="keywordtype">bool</span> ok_to_block = <span class="keyword">true</span>);
<a name="l00047"></a>00047
<a name="l00048"></a><a class="code" href="audio__portaudio__sink_8h.html#aad0142eba2a2ee8a0e20c16ee8337130">00048</a> PaStreamCallback <a class="code" href="audio__portaudio__sink_8h.html#aad0142eba2a2ee8a0e20c16ee8337130">portaudio_sink_callback</a>;
<a name="l00049"></a>00049
<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"> * \ Audio sink using PORTAUDIO</span>
<a name="l00053"></a>00053 <span class="comment"> *</span>
<a name="l00054"></a>00054 <span class="comment"> * Input samples must be in the range [-1,1].</span>
<a name="l00055"></a>00055 <span class="comment"> */</span>
<a name="l00056"></a><a class="code" href="classaudio__portaudio__sink.html">00056</a> <span class="keyword">class </span><a class="code" href="classaudio__portaudio__sink.html">audio_portaudio_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="l00057"></a>00057 <span class="keyword">friend</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">audio_portaudio_sink_sptr</a>
<a name="l00058"></a>00058 <a class="code" href="classaudio__portaudio__sink.html#a038859035fd37affccce1308a8005a59" title="PORTAUDIO audio sink.">audio_portaudio_make_sink</a> (<span class="keywordtype">int</span> sampling_rate,
<a name="l00059"></a>00059 <span class="keyword">const</span> std::string device_name,
<a name="l00060"></a>00060 <span class="keywordtype">bool</span> ok_to_block);
<a name="l00061"></a>00061
<a name="l00062"></a><a class="code" href="classaudio__portaudio__sink.html#aea834c6ebe46a1635d5a8fe5446e3b18">00062</a> <span class="keyword">friend</span> PaStreamCallback <a class="code" href="classaudio__portaudio__sink.html#aea834c6ebe46a1635d5a8fe5446e3b18">portaudio_sink_callback</a>;
<a name="l00063"></a>00063
<a name="l00064"></a>00064
<a name="l00065"></a>00065 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> d_sampling_rate;
<a name="l00066"></a>00066 std::string d_device_name;
<a name="l00067"></a>00067 <span class="keywordtype">bool</span> d_ok_to_block;
<a name="l00068"></a>00068 <span class="keywordtype">bool</span> d_verbose;
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> d_portaudio_buffer_size_frames; <span class="comment">// number of frames in a portaudio buffer</span>
<a name="l00071"></a>00071
<a name="l00072"></a>00072 PaStream *d_stream;
<a name="l00073"></a>00073 PaStreamParameters d_output_parameters;
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <a class="code" href="classboost_1_1shared__ptr.html">gr_buffer_sptr</a> d_writer; <span class="comment">// buffer used between work and callback</span>
<a name="l00076"></a>00076 <a class="code" href="classboost_1_1shared__ptr.html">gr_buffer_reader_sptr</a> d_reader;
<a name="l00077"></a>00077
<a name="l00078"></a>00078 gruel::mutex d_ringbuffer_mutex;
<a name="l00079"></a>00079 gruel::condition_variable d_ringbuffer_cond;
<a name="l00080"></a>00080 <span class="keywordtype">bool</span> d_ringbuffer_ready;
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="comment">// random stats</span>
<a name="l00083"></a>00083 <span class="keywordtype">int</span> d_nunderuns; <span class="comment">// count of underruns</span>
<a name="l00084"></a>00084 <span class="comment">//gri_logger_sptr d_log; // handle to non-blocking logging instance</span>
<a name="l00085"></a>00085
<a name="l00086"></a>00086 <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="l00087"></a>00087 <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="l00088"></a>00088 <span class="keywordtype">void</span> create_ringbuffer();
<a name="l00089"></a>00089
<a name="l00090"></a>00090
<a name="l00091"></a>00091 <span class="keyword">protected</span>:
<a name="l00092"></a>00092 <a class="code" href="classaudio__portaudio__sink.html#a387f47e510264f54f764e9bc5a734148">audio_portaudio_sink</a> (<span class="keywordtype">int</span> sampling_rate, <span class="keyword">const</span> std::string device_name,
<a name="l00093"></a>00093 <span class="keywordtype">bool</span> ok_to_block);
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="keyword">public</span>:
<a name="l00096"></a>00096 <a class="code" href="classaudio__portaudio__sink.html#a545391fdb3bc4313282dfe9709bc2e07">~audio_portaudio_sink</a> ();
<a name="l00097"></a>00097
<a name="l00098"></a>00098 <span class="keywordtype">bool</span> <a class="code" href="classaudio__portaudio__sink.html#a03c5b233e14c6afd06897383ee6128a1" 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="l00099"></a>00099
<a name="l00100"></a>00100 <span class="keywordtype">int</span> <a class="code" href="classaudio__portaudio__sink.html#ae2bfcbeaa2eed543014bcb2057f5eb45" 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="l00101"></a>00101 <a class="code" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items,
<a name="l00102"></a>00102 <a class="code" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items);
<a name="l00103"></a>00103 };
<a name="l00104"></a>00104
<a name="l00105"></a>00105 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_AUDIO_PORTAUDIO_SINK_H */</span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:50:59 2010 for GNU Radio 3.3.0 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
