<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>GNU Radio 3.6.4.1 C++ API: audio_osx_source Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<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.6.4.1 C++ API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classaudio__osx__source.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classaudio__osx__source-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">audio_osx_source Class Reference<div class="ingroups"><a class="el" href="group__audio__blk.html">Audio Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>audio source using OSXInput signature is one or two streams of floats. Samples must be in the range [-1,1].
<a href="classaudio__osx__source.html#details">More...</a></p>
<p><code>#include <<a class="el" href="audio__osx__source_8h_source.html">audio_osx_source.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for audio_osx_source:</div>
<div class="dyncontent">
<div class="center"><img src="classaudio__osx__source__inherit__graph.png" border="0" usemap="#audio__osx__source_inherit__map" alt="Inheritance graph"/></div>
<map name="audio__osx__source_inherit__map" id="audio__osx__source_inherit__map">
<area shape="rect" id="node2" href="classaudio__source.html" title="Creates a source from an audio device." alt="" coords="104,408,203,435"/><area shape="rect" id="node4" href="classgr__sync__block.html" title="synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa..." alt="" coords="100,333,207,360"/><area shape="rect" id="node6" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing flow is constructed ..." alt="" coords="118,259,188,285"/><area shape="rect" id="node8" href="classgr__basic__block.html" title="The abstract base class for all signal processing blocks.Basic blocks are the bare abstraction of an ..." alt="" coords="99,184,208,211"/><area shape="rect" id="node10" href="classgr__msg__accepter.html" title="Accepts messages and inserts them into a message queue, then notifies subclass gr_basic_block there i..." alt="" coords="13,95,136,121"/><area shape="rect" id="node12" href="classgruel_1_1msg__accepter.html" title="Virtual base class that accepts messages." alt="" coords="5,5,144,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad1999c15b0c96b1746ff25bdc2da97a5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__osx__source.html#ad1999c15b0c96b1746ff25bdc2da97a5">audio_osx_source</a> (int sample_rate=44100, const std::string device_name="", bool do_block=true, int channel_config=-1, int max_sample_count=-1)</td></tr>
<tr class="separator:ad1999c15b0c96b1746ff25bdc2da97a5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aff4c56407d1602f1986338211e975222"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__osx__source.html#aff4c56407d1602f1986338211e975222">~audio_osx_source</a> ()</td></tr>
<tr class="separator:aff4c56407d1602f1986338211e975222"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a783cf6498ede9ffb14396b72fffbb731"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__osx__source.html#a783cf6498ede9ffb14396b72fffbb731">start</a> ()</td></tr>
<tr class="memdesc:a783cf6498ede9ffb14396b72fffbb731"><td class="mdescLeft"> </td><td class="mdescRight">Called to enable drivers, etc for i/o devices. <a href="#a783cf6498ede9ffb14396b72fffbb731"></a><br/></td></tr>
<tr class="separator:a783cf6498ede9ffb14396b72fffbb731"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a902595b2e1886706ffbca4465ea71e04"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__osx__source.html#a902595b2e1886706ffbca4465ea71e04">stop</a> ()</td></tr>
<tr class="memdesc:a902595b2e1886706ffbca4465ea71e04"><td class="mdescLeft"> </td><td class="mdescRight">Called to disable drivers, etc for i/o devices. <a href="#a902595b2e1886706ffbca4465ea71e04"></a><br/></td></tr>
<tr class="separator:a902595b2e1886706ffbca4465ea71e04"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5bd8338506d281198a754d7e0342c701"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__osx__source.html#a5bd8338506d281198a754d7e0342c701">IsRunning</a> ()</td></tr>
<tr class="separator:a5bd8338506d281198a754d7e0342c701"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a89cbd64f5112de6231ef7d25bcdfb2"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__osx__source.html#a3a89cbd64f5112de6231ef7d25bcdfb2">check_topology</a> (int ninputs, int noutputs)</td></tr>
<tr class="memdesc:a3a89cbd64f5112de6231ef7d25bcdfb2"><td class="mdescLeft"> </td><td class="mdescRight">Confirm that ninputs and noutputs is an acceptable combination. <a href="#a3a89cbd64f5112de6231ef7d25bcdfb2"></a><br/></td></tr>
<tr class="separator:a3a89cbd64f5112de6231ef7d25bcdfb2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a54dfec211e4fca4f58891ed65a7c25bc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__osx__source.html#a54dfec211e4fca4f58891ed65a7c25bc">work</a> (int noutput_items, <a class="el" href="gr__types_8h.html#a9852a3d906d823cb70eb9c29e7f2a43d">gr_vector_const_void_star</a> &input_items, <a class="el" href="gr__types_8h.html#acd3f499576e769966ea44554b359d949">gr_vector_void_star</a> &output_items)</td></tr>
<tr class="memdesc:a54dfec211e4fca4f58891ed65a7c25bc"><td class="mdescLeft"> </td><td class="mdescRight">just like <a class="el" href="classgr__block.html#adf59080d10f322e3816b7ac8f7cb2a7c" title="compute output items from input items">gr_block::general_work</a>, only this arranges to call consume_each for you <a href="#a54dfec211e4fca4f58891ed65a7c25bc"></a><br/></td></tr>
<tr class="separator:a54dfec211e4fca4f58891ed65a7c25bc"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_classaudio__source"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classaudio__source')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classaudio__source.html">audio_source</a></td></tr>
<tr class="memitem:a2135ef650ecacb1d5d18367d28b67ed8 inherit pub_types_classaudio__source"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classboost_1_1shared__ptr.html">boost::shared_ptr</a><br class="typebreak"/>
< <a class="el" href="classaudio__source.html">audio_source</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__source.html#a2135ef650ecacb1d5d18367d28b67ed8">sptr</a></td></tr>
<tr class="separator:a2135ef650ecacb1d5d18367d28b67ed8 inherit pub_types_classaudio__source"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_types_classgr__basic__block"><td colspan="2" onclick="javascript:toggleInherit('pro_types_classgr__basic__block')"><img src="closed.png" alt="-"/> Protected Types inherited from <a class="el" href="classgr__basic__block.html">gr_basic_block</a></td></tr>
<tr class="memitem:a5c90b7c003ddd61f8df6bef2aceeab3d inherit pro_types_classgr__basic__block"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__basic__block.html#a5c90b7c003ddd61f8df6bef2aceeab3d">vcolor</a> { <a class="el" href="classgr__basic__block.html#a5c90b7c003ddd61f8df6bef2aceeab3da476d594a077e729bad0f2cfa2008c899">WHITE</a>,
<a class="el" href="classgr__basic__block.html#a5c90b7c003ddd61f8df6bef2aceeab3daa6cce7ec34a3f9cf917e545a743dc89f">GREY</a>,
<a class="el" href="classgr__basic__block.html#a5c90b7c003ddd61f8df6bef2aceeab3da0abd1c82699481ffa502e5bb8d7bdaec">BLACK</a>
}</td></tr>
<tr class="separator:a5c90b7c003ddd61f8df6bef2aceeab3d inherit pro_types_classgr__basic__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_methods_classgr__sync__block"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classgr__sync__block')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classgr__sync__block.html">gr_sync_block</a></td></tr>
<tr class="memitem:a8e8100cc8cafbc89a0cd64fbc2fc4153 inherit pro_methods_classgr__sync__block"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sync__block.html#a8e8100cc8cafbc89a0cd64fbc2fc4153">gr_sync_block</a> (<a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a>)</td></tr>
<tr class="separator:a8e8100cc8cafbc89a0cd64fbc2fc4153 inherit pro_methods_classgr__sync__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a832d8dad2dbd38e8e9cfa0b954d37c87 inherit pro_methods_classgr__sync__block"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sync__block.html#a832d8dad2dbd38e8e9cfa0b954d37c87">gr_sync_block</a> (const std::string &<a class="el" href="classgr__basic__block.html#aa12a20d8b8eab341da935530d29299d2">name</a>, <a class="el" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> <a class="el" href="classgr__basic__block.html#a58f6d05e85931200f3771d3e50741281">input_signature</a>, <a class="el" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> <a class="el" href="classgr__basic__block.html#add68b96f012dfe352700b4fd1c3a184a">output_signature</a>)</td></tr>
<tr class="separator:a832d8dad2dbd38e8e9cfa0b954d37c87 inherit pro_methods_classgr__sync__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_attribs_classgr__block"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classgr__block')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classgr__block.html">gr_block</a></td></tr>
<tr class="memitem:ab467fa14adf6b63148588ffbbe266d82 inherit pro_attribs_classgr__block"><td class="memItemLeft" align="right" valign="top">std::vector< long > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#ab467fa14adf6b63148588ffbbe266d82">d_max_output_buffer</a></td></tr>
<tr class="separator:ab467fa14adf6b63148588ffbbe266d82 inherit pro_attribs_classgr__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9c331f7d38508c9955ef01f483c573d6 inherit pro_attribs_classgr__block"><td class="memItemLeft" align="right" valign="top">std::vector< long > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#a9c331f7d38508c9955ef01f483c573d6">d_min_output_buffer</a></td></tr>
<tr class="separator:a9c331f7d38508c9955ef01f483c573d6 inherit pro_attribs_classgr__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ace960ec997da0fff8fc44168983b1a55 inherit pro_attribs_classgr__block"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegruel.html#a16a913898c1d7f7a8ee459eb7ace413d">gruel::mutex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#ace960ec997da0fff8fc44168983b1a55">d_setlock</a></td></tr>
<tr class="separator:ace960ec997da0fff8fc44168983b1a55 inherit pro_attribs_classgr__block"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>audio source using OSX</p>
<p>Input signature is one or two streams of floats. Samples must be in the range [-1,1]. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="ad1999c15b0c96b1746ff25bdc2da97a5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">audio_osx_source::audio_osx_source </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>sample_rate</em> = <code>44100</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string </td>
<td class="paramname"><em>device_name</em> = <code>""</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>do_block</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>channel_config</em> = <code>-1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>max_sample_count</em> = <code>-1</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aff4c56407d1602f1986338211e975222"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">audio_osx_source::~audio_osx_source </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a3a89cbd64f5112de6231ef7d25bcdfb2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool audio_osx_source::check_topology </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>ninputs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>noutputs</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Confirm that ninputs and noutputs is an acceptable combination. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ninputs</td><td>number of input streams connected </td></tr>
<tr><td class="paramname">noutputs</td><td>number of output streams connected</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if this is a valid configuration for this block.</dd></dl>
<p>This function is called by the runtime system whenever the topology changes. Most classes do not need to override this. This check is in addition to the constraints specified by the input and output gr_io_signatures. </p>
<p>Reimplemented from <a class="el" href="classgr__basic__block.html#a50a714df9c3ce8c03854a09ac84e589b">gr_basic_block</a>.</p>
</div>
</div>
<a class="anchor" id="a5bd8338506d281198a754d7e0342c701"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool audio_osx_source::IsRunning </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a783cf6498ede9ffb14396b72fffbb731"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool audio_osx_source::start </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called to enable drivers, etc for i/o devices. </p>
<p>This allows a block to enable an associated driver to begin transfering data just before we start to execute the scheduler. The end result is that this reduces latency in the pipeline when dealing with audio devices, usrps, etc. </p>
<p>Reimplemented from <a class="el" href="classgr__block.html#a49ea94a86f3199f23563bb837633ea1f">gr_block</a>.</p>
</div>
</div>
<a class="anchor" id="a902595b2e1886706ffbca4465ea71e04"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool audio_osx_source::stop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called to disable drivers, etc for i/o devices. </p>
<p>Reimplemented from <a class="el" href="classgr__block.html#a53c2c89c037e4e393b75414d605e36b1">gr_block</a>.</p>
</div>
</div>
<a class="anchor" id="a54dfec211e4fca4f58891ed65a7c25bc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int audio_osx_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="gr__types_8h.html#a9852a3d906d823cb70eb9c29e7f2a43d">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="gr__types_8h.html#acd3f499576e769966ea44554b359d949">gr_vector_void_star</a> & </td>
<td class="paramname"><em>output_items</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>just like <a class="el" href="classgr__block.html#adf59080d10f322e3816b7ac8f7cb2a7c" 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/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="audio__osx__source_8h_source.html">audio_osx_source.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classaudio__osx__source.html">audio_osx_source</a></li>
<li class="footer">Generated on Fri Apr 19 2013 16:20:36 for GNU Radio 3.6.4.1 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li>
</ul>
</div>
</body>
</html>
