<!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_jack_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('audio__jack__sink_8h.html',''); </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <h1>audio_jack_sink.h</h1> </div> </div> <div class="contents"> <a href="audio__jack__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 2005,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_JACK_SINK_H</span> <a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_AUDIO_JACK_SINK_H</span> <a name="l00024"></a>00024 <span class="preprocessor"></span> <a name="l00025"></a>00025 <span class="preprocessor">#include <gr_sync_block.h></span> <a name="l00026"></a>00026 <span class="preprocessor">#include <string></span> <a name="l00027"></a>00027 <span class="preprocessor">#include <jack/jack.h></span> <a name="l00028"></a>00028 <span class="preprocessor">#include <jack/ringbuffer.h></span> <a name="l00029"></a>00029 <span class="preprocessor">#include <stdexcept></span> <a name="l00030"></a>00030 <a name="l00031"></a>00031 <span class="keyword">class </span><a class="code" href="classaudio__jack__sink.html" title="audio sink using JACK">audio_jack_sink</a>; <a name="l00032"></a>00032 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr<audio_jack_sink></a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">audio_jack_sink_sptr</a>; <a name="l00033"></a>00033 <span class="comment"></span> <a name="l00034"></a>00034 <span class="comment">/*!</span> <a name="l00035"></a>00035 <span class="comment"> * \brief make an JACK audio sink.</span> <a name="l00036"></a>00036 <span class="comment"> *</span> <a name="l00037"></a>00037 <span class="comment"> * \param sampling_rate sampling rate in Hz</span> <a name="l00038"></a>00038 <span class="comment"> * \param device_name JACK device name, e.g., "gr_sink"</span> <a name="l00039"></a>00039 <span class="comment"> * \param ok_to_block</span> <a name="l00040"></a>00040 <span class="comment"> */</span> <a name="l00041"></a>00041 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">audio_jack_sink_sptr</a> <a name="l00042"></a>00042 <a class="code" href="audio__jack__sink_8h.html#aa876150f74e9cb1fa0e35e384741f0c2" title="make an JACK audio sink.">audio_jack_make_sink</a> (<span class="keywordtype">int</span> sampling_rate, <a name="l00043"></a>00043 <span class="keyword">const</span> std::string device_name = <span class="stringliteral">""</span>, <a name="l00044"></a>00044 <span class="keywordtype">bool</span> ok_to_block = <span class="keyword">true</span>); <a name="l00045"></a>00045 <a name="l00046"></a>00046 <span class="keywordtype">int</span> <a class="code" href="audio__jack__sink_8h.html#ac98748225d46a0e5736a2e38187a2606">jack_sink_process</a> (jack_nframes_t nframes, <span class="keywordtype">void</span> *arg); <a name="l00047"></a>00047 <span class="comment"></span> <a name="l00048"></a>00048 <span class="comment">/*!</span> <a name="l00049"></a>00049 <span class="comment"> * \brief audio sink using JACK</span> <a name="l00050"></a>00050 <span class="comment"> *</span> <a name="l00051"></a>00051 <span class="comment"> * The sink has one input stream of floats.</span> <a name="l00052"></a>00052 <span class="comment"> *</span> <a name="l00053"></a>00053 <span class="comment"> * Input samples must be in the range [-1,1].</span> <a name="l00054"></a>00054 <span class="comment"> */</span> <a name="l00055"></a><a class="code" href="classaudio__jack__sink.html">00055</a> <span class="keyword">class </span><a class="code" href="classaudio__jack__sink.html" title="audio sink using JACK">audio_jack_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="l00056"></a>00056 <span class="keyword">friend</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">audio_jack_sink_sptr</a> <a name="l00057"></a>00057 <a class="code" href="classaudio__jack__sink.html#add40495c2e7c797faa3064250becd118" title="make an JACK audio sink.">audio_jack_make_sink</a> (<span class="keywordtype">int</span> sampling_rate, <span class="keyword">const</span> std::string device_name, <span class="keywordtype">bool</span> ok_to_block); <a name="l00058"></a>00058 <a name="l00059"></a>00059 <span class="keyword">friend</span> <span class="keywordtype">int</span> <a class="code" href="classaudio__jack__sink.html#ac98748225d46a0e5736a2e38187a2606">jack_sink_process</a> (jack_nframes_t nframes, <span class="keywordtype">void</span> *arg); <a name="l00060"></a>00060 <a name="l00061"></a>00061 <span class="comment">// typedef for pointer to class work method</span> <a name="l00062"></a>00062 <span class="keyword">typedef</span> int (<a class="code" href="classaudio__jack__sink.html" title="audio sink using JACK">audio_jack_sink</a>::*work_t)(<span class="keywordtype">int</span> noutput_items, <a name="l00063"></a>00063 <a class="code" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items, <a name="l00064"></a>00064 <a class="code" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items); <a name="l00065"></a>00065 <a name="l00066"></a>00066 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> d_sampling_rate; <a name="l00067"></a>00067 std::string d_device_name; <a name="l00068"></a>00068 <span class="keywordtype">bool</span> d_ok_to_block; <a name="l00069"></a>00069 <a name="l00070"></a>00070 jack_client_t *d_jack_client; <a name="l00071"></a>00071 jack_port_t *d_jack_output_port; <a name="l00072"></a>00072 jack_ringbuffer_t *d_ringbuffer; <a name="l00073"></a>00073 jack_nframes_t d_jack_buffer_size; <a name="l00074"></a>00074 <a class="code" href="struct____pthread__cond__t.html">pthread_cond_t</a> d_ringbuffer_ready; <a name="l00075"></a>00075 <a class="code" href="struct____pthread__mutex__t.html">pthread_mutex_t</a> d_jack_process_lock; <a name="l00076"></a>00076 <a name="l00077"></a>00077 <span class="comment">// random stats</span> <a name="l00078"></a>00078 <span class="keywordtype">int</span> d_nunderuns; <span class="comment">// count of underruns</span> <a name="l00079"></a>00079 <a name="l00080"></a>00080 <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="l00081"></a>00081 <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="l00082"></a>00082 <a name="l00083"></a>00083 <a name="l00084"></a>00084 <span class="keyword">protected</span>: <a name="l00085"></a>00085 <a class="code" href="classaudio__jack__sink.html#ae72a07079c4c1d11025cad4295ac463f">audio_jack_sink</a> (<span class="keywordtype">int</span> sampling_rate, <span class="keyword">const</span> std::string device_name, <span class="keywordtype">bool</span> ok_to_block); <a name="l00086"></a>00086 <a name="l00087"></a>00087 <span class="keyword">public</span>: <a name="l00088"></a>00088 <a class="code" href="classaudio__jack__sink.html#a01017fbc68d4933ca1be4cfc65f312e7">~audio_jack_sink</a> (); <a name="l00089"></a>00089 <a name="l00090"></a>00090 <span class="keywordtype">bool</span> <a class="code" href="classaudio__jack__sink.html#a0a7b072ca66c1aefecc26a04ca043c50" 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="l00091"></a>00091 <a name="l00092"></a>00092 <span class="keywordtype">int</span> <a class="code" href="classaudio__jack__sink.html#a4e6c21bf5c0a22bf4a05483be7f59a99" 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="l00093"></a>00093 <a class="code" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items, <a name="l00094"></a>00094 <a class="code" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items); <a name="l00095"></a>00095 }; <a name="l00096"></a>00096 <a name="l00097"></a>00097 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_AUDIO_JACK_SINK_H */</span> </pre></div></div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="audio__jack__sink_8h.html">audio_jack_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>