<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>aubio: io/source.h File 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">aubio
 <span id="projectnumber">0.4.2~alpha</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_bc161955dc3a3d2485839eba21420d01.html">io</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">source.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Media source to read blocks of consecutive audio samples from file.
<a href="#details">More...</a></p>
<p><a href="source_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a1a29eaffe41a16145b0c77134fea24c7"><td class="memItemLeft" align="right" valign="top"><a id="a1a29eaffe41a16145b0c77134fea24c7"></a>
typedef struct _aubio_source_t </td><td class="memItemRight" valign="bottom"><a class="el" href="source_8h.html#a1a29eaffe41a16145b0c77134fea24c7">aubio_source_t</a></td></tr>
<tr class="memdesc:a1a29eaffe41a16145b0c77134fea24c7"><td class="mdescLeft"> </td><td class="mdescRight">media source object <br /></td></tr>
<tr class="separator:a1a29eaffe41a16145b0c77134fea24c7"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a095a681b83bfe88697c8b0c7918f6b53"><td class="memItemLeft" align="right" valign="top"><a class="el" href="source_8h.html#a1a29eaffe41a16145b0c77134fea24c7">aubio_source_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="source_8h.html#a095a681b83bfe88697c8b0c7918f6b53">new_aubio_source</a> (<a class="el" href="types_8h.html#a40bb5262bf908c328fbcfbe5d29d0201">char_t</a> *uri, <a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> samplerate, <a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> hop_size)</td></tr>
<tr class="memdesc:a095a681b83bfe88697c8b0c7918f6b53"><td class="mdescLeft"> </td><td class="mdescRight">create new <a class="el" href="source_8h.html#a1a29eaffe41a16145b0c77134fea24c7" title="media source object ">aubio_source_t</a> <a href="#a095a681b83bfe88697c8b0c7918f6b53">More...</a><br /></td></tr>
<tr class="separator:a095a681b83bfe88697c8b0c7918f6b53"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae6e5a0145ff75675fd7704d415be582d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="source_8h.html#ae6e5a0145ff75675fd7704d415be582d">aubio_source_do</a> (<a class="el" href="source_8h.html#a1a29eaffe41a16145b0c77134fea24c7">aubio_source_t</a> *s, <a class="el" href="structfvec__t.html">fvec_t</a> *read_to, <a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> *read)</td></tr>
<tr class="memdesc:ae6e5a0145ff75675fd7704d415be582d"><td class="mdescLeft"> </td><td class="mdescRight">read monophonic vector of length hop_size from source object <a href="#ae6e5a0145ff75675fd7704d415be582d">More...</a><br /></td></tr>
<tr class="separator:ae6e5a0145ff75675fd7704d415be582d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8dac8dc20d895ff5649dc4b582ef2712"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="source_8h.html#a8dac8dc20d895ff5649dc4b582ef2712">aubio_source_do_multi</a> (<a class="el" href="source_8h.html#a1a29eaffe41a16145b0c77134fea24c7">aubio_source_t</a> *s, <a class="el" href="structfmat__t.html">fmat_t</a> *read_to, <a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> *read)</td></tr>
<tr class="memdesc:a8dac8dc20d895ff5649dc4b582ef2712"><td class="mdescLeft"> </td><td class="mdescRight">read polyphonic vector of length hop_size from source object <a href="#a8dac8dc20d895ff5649dc4b582ef2712">More...</a><br /></td></tr>
<tr class="separator:a8dac8dc20d895ff5649dc4b582ef2712"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0aff78c30722264daba2b93ceaa98361"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="source_8h.html#a0aff78c30722264daba2b93ceaa98361">aubio_source_get_samplerate</a> (<a class="el" href="source_8h.html#a1a29eaffe41a16145b0c77134fea24c7">aubio_source_t</a> *s)</td></tr>
<tr class="memdesc:a0aff78c30722264daba2b93ceaa98361"><td class="mdescLeft"> </td><td class="mdescRight">get samplerate of source object <a href="#a0aff78c30722264daba2b93ceaa98361">More...</a><br /></td></tr>
<tr class="separator:a0aff78c30722264daba2b93ceaa98361"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0b93063cfe2620cea7347061652c389c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="source_8h.html#a0b93063cfe2620cea7347061652c389c">aubio_source_get_channels</a> (<a class="el" href="source_8h.html#a1a29eaffe41a16145b0c77134fea24c7">aubio_source_t</a> *s)</td></tr>
<tr class="memdesc:a0b93063cfe2620cea7347061652c389c"><td class="mdescLeft"> </td><td class="mdescRight">get channels of source object <a href="#a0b93063cfe2620cea7347061652c389c">More...</a><br /></td></tr>
<tr class="separator:a0b93063cfe2620cea7347061652c389c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad2f97420bccc32e7ba67762d10ceb879"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="source_8h.html#ad2f97420bccc32e7ba67762d10ceb879">aubio_source_seek</a> (<a class="el" href="source_8h.html#a1a29eaffe41a16145b0c77134fea24c7">aubio_source_t</a> *s, <a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> pos)</td></tr>
<tr class="memdesc:ad2f97420bccc32e7ba67762d10ceb879"><td class="mdescLeft"> </td><td class="mdescRight">seek source object <a href="#ad2f97420bccc32e7ba67762d10ceb879">More...</a><br /></td></tr>
<tr class="separator:ad2f97420bccc32e7ba67762d10ceb879"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aca279ad4069fa5ebce50ce5bee960522"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="source_8h.html#aca279ad4069fa5ebce50ce5bee960522">aubio_source_close</a> (<a class="el" href="source_8h.html#a1a29eaffe41a16145b0c77134fea24c7">aubio_source_t</a> *s)</td></tr>
<tr class="memdesc:aca279ad4069fa5ebce50ce5bee960522"><td class="mdescLeft"> </td><td class="mdescRight">close source object <a href="#aca279ad4069fa5ebce50ce5bee960522">More...</a><br /></td></tr>
<tr class="separator:aca279ad4069fa5ebce50ce5bee960522"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a997e8620fd445889d498627f7e27d5c6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="source_8h.html#a997e8620fd445889d498627f7e27d5c6">del_aubio_source</a> (<a class="el" href="source_8h.html#a1a29eaffe41a16145b0c77134fea24c7">aubio_source_t</a> *s)</td></tr>
<tr class="memdesc:a997e8620fd445889d498627f7e27d5c6"><td class="mdescLeft"> </td><td class="mdescRight">close source and cleanup memory <a href="#a997e8620fd445889d498627f7e27d5c6">More...</a><br /></td></tr>
<tr class="separator:a997e8620fd445889d498627f7e27d5c6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Media source to read blocks of consecutive audio samples from file. </p>
<p>To write to file, use <a class="el" href="sink_8h.html#ab3fd37f3117e99c10c63cb595821c31d" title="media sink object ">aubio_sink_t</a>.</p>
<p>Depending on how aubio was compiled, the following sources will be available.</p>
<p>When creating a new source using <a class="el" href="source_8h.html#a095a681b83bfe88697c8b0c7918f6b53" title="create new aubio_source_t ">new_aubio_source</a>, the new function of each of the compiled-in sources will be used, in the following order, until one of them gets successfully created. If all sources returned NULL, <a class="el" href="source_8h.html#a095a681b83bfe88697c8b0c7918f6b53" title="create new aubio_source_t ">new_aubio_source</a> will return NULL.</p>
<p><b><code>source_avcodec</code> </b>: libav</p>
<p>aubio can be optionally compiled with <a href="http://libav.org">libav</a>, which can read from a very large number of audio and video formats, including over different network protocols such as HTTP.</p>
<p><b><code>source_apple_audio</code> </b>: ExtAudioFileRef</p>
<p>On Mac and iOS platforms, aubio should be compiled with CoreAudio <a href="https://developer.apple.com/library/mac/documentation/MusicAudio/Reference/ExtendedAudioFileServicesReference/Reference/reference.html">Extended Audio File Services</a>. This provides access to most common audio file formats, including compressed ones.</p>
<p><b><code>source_sndfile</code> </b>: libsndfile</p>
<p>Also optional, aubio can be built against <a href="http://www.mega-nerd.com/libsndfile/">libsndfile</a>, which can read <a href="http://www.mega-nerd.com/libsndfile/#Features">most uncompressed formats</a>.</p>
<p><b><code>source_wavread</code> </b>: native WAV reader</p>
<p>A simple source to read from 16-bits PCM RIFF encoded WAV files. </p>
<p class="definition">Definition in file <a class="el" href="source_8h_source.html">source.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="aca279ad4069fa5ebce50ce5bee960522"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca279ad4069fa5ebce50ce5bee960522">◆ </a></span>aubio_source_close()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> aubio_source_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="source_8h.html#a1a29eaffe41a16145b0c77134fea24c7">aubio_source_t</a> * </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>close source object </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>source object, created with <a class="el" href="source_8h.html#a095a681b83bfe88697c8b0c7918f6b53" title="create new aubio_source_t ">new_aubio_source</a></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if sucessful, non-zero on failure </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="io_2test-source_8c-example.html#a6">io/test-source.c</a>.</dd>
</dl>
</div>
</div>
<a id="ae6e5a0145ff75675fd7704d415be582d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6e5a0145ff75675fd7704d415be582d">◆ </a></span>aubio_source_do()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void aubio_source_do </td>
<td>(</td>
<td class="paramtype"><a class="el" href="source_8h.html#a1a29eaffe41a16145b0c77134fea24c7">aubio_source_t</a> * </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structfvec__t.html">fvec_t</a> * </td>
<td class="paramname"><em>read_to</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> * </td>
<td class="paramname"><em>read</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>read monophonic vector of length hop_size from source object </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>source object, created with <a class="el" href="source_8h.html#a095a681b83bfe88697c8b0c7918f6b53" title="create new aubio_source_t ">new_aubio_source</a> </td></tr>
<tr><td class="paramname">read_to</td><td><a class="el" href="structfvec__t.html" title="Buffer for real data. ">fvec_t</a> of data to read to </td></tr>
<tr><td class="paramname">read</td><td>upon returns, equals to number of frames actually read</td></tr>
</table>
</dd>
</dl>
<p>Upon returns, <code>read</code> contains the number of frames actually read from the source. <code>hop_size</code> if enough frames could be read, less otherwise. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="io_2test-sink_8c-example.html#a5">io/test-sink.c</a>, <a class="el" href="io_2test-source_8c-example.html#a4">io/test-source.c</a>, <a class="el" href="onset_2test-onset_8c-example.html#a5">onset/test-onset.c</a>, <a class="el" href="synth_2test-sampler_8c-example.html#a7">synth/test-sampler.c</a>, and <a class="el" href="tempo_2test-tempo_8c-example.html#a5">tempo/test-tempo.c</a>.</dd>
</dl>
</div>
</div>
<a id="a8dac8dc20d895ff5649dc4b582ef2712"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8dac8dc20d895ff5649dc4b582ef2712">◆ </a></span>aubio_source_do_multi()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void aubio_source_do_multi </td>
<td>(</td>
<td class="paramtype"><a class="el" href="source_8h.html#a1a29eaffe41a16145b0c77134fea24c7">aubio_source_t</a> * </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structfmat__t.html">fmat_t</a> * </td>
<td class="paramname"><em>read_to</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> * </td>
<td class="paramname"><em>read</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>read polyphonic vector of length hop_size from source object </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">s</td><td>source object, created with <a class="el" href="source_8h.html#a095a681b83bfe88697c8b0c7918f6b53" title="create new aubio_source_t ">new_aubio_source</a> </td></tr>
<tr><td class="paramdir"></td><td class="paramname">read_to</td><td><a class="el" href="structfmat__t.html" title="Buffer for real data. ">fmat_t</a> of data to read to </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">read</td><td>upon returns, equals to number of frames actually read</td></tr>
</table>
</dd>
</dl>
<p>Upon returns, <code>read</code> contains the number of frames actually read from the source. <code>hop_size</code> if enough frames could be read, less otherwise. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="io_2test-source_multi_8c-example.html#a5">io/test-source_multi.c</a>.</dd>
</dl>
</div>
</div>
<a id="a0b93063cfe2620cea7347061652c389c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b93063cfe2620cea7347061652c389c">◆ </a></span>aubio_source_get_channels()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> aubio_source_get_channels </td>
<td>(</td>
<td class="paramtype"><a class="el" href="source_8h.html#a1a29eaffe41a16145b0c77134fea24c7">aubio_source_t</a> * </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get channels of source object </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>source object, created with <a class="el" href="source_8h.html#a095a681b83bfe88697c8b0c7918f6b53" title="create new aubio_source_t ">new_aubio_source</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>channels </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="io_2test-source_multi_8c-example.html#a2">io/test-source_multi.c</a>.</dd>
</dl>
</div>
</div>
<a id="a0aff78c30722264daba2b93ceaa98361"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0aff78c30722264daba2b93ceaa98361">◆ </a></span>aubio_source_get_samplerate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> aubio_source_get_samplerate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="source_8h.html#a1a29eaffe41a16145b0c77134fea24c7">aubio_source_t</a> * </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get samplerate of source object </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>source object, created with <a class="el" href="source_8h.html#a095a681b83bfe88697c8b0c7918f6b53" title="create new aubio_source_t ">new_aubio_source</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>samplerate, in Hz </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="io_2test-sink_8c-example.html#a3">io/test-sink.c</a>, <a class="el" href="io_2test-source_8c-example.html#a3">io/test-source.c</a>, <a class="el" href="io_2test-source_multi_8c-example.html#a1">io/test-source_multi.c</a>, <a class="el" href="onset_2test-onset_8c-example.html#a1">onset/test-onset.c</a>, <a class="el" href="synth_2test-sampler_8c-example.html#a3">synth/test-sampler.c</a>, and <a class="el" href="tempo_2test-tempo_8c-example.html#a1">tempo/test-tempo.c</a>.</dd>
</dl>
</div>
</div>
<a id="ad2f97420bccc32e7ba67762d10ceb879"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2f97420bccc32e7ba67762d10ceb879">◆ </a></span>aubio_source_seek()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> aubio_source_seek </td>
<td>(</td>
<td class="paramtype"><a class="el" href="source_8h.html#a1a29eaffe41a16145b0c77134fea24c7">aubio_source_t</a> * </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td>
<td class="paramname"><em>pos</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>seek source object </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>source object, created with <a class="el" href="source_8h.html#a095a681b83bfe88697c8b0c7918f6b53" title="create new aubio_source_t ">new_aubio_source</a> </td></tr>
<tr><td class="paramname">pos</td><td>position to seek to, in frames</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if sucessful, non-zero on failure </dd></dl>
</div>
</div>
<a id="a997e8620fd445889d498627f7e27d5c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a997e8620fd445889d498627f7e27d5c6">◆ </a></span>del_aubio_source()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void del_aubio_source </td>
<td>(</td>
<td class="paramtype"><a class="el" href="source_8h.html#a1a29eaffe41a16145b0c77134fea24c7">aubio_source_t</a> * </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>close source and cleanup memory </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>source object, created with <a class="el" href="source_8h.html#a095a681b83bfe88697c8b0c7918f6b53" title="create new aubio_source_t ">new_aubio_source</a> </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="io_2test-sink_8c-example.html#a8">io/test-sink.c</a>, <a class="el" href="io_2test-source_8c-example.html#a8">io/test-source.c</a>, <a class="el" href="io_2test-source_multi_8c-example.html#a8">io/test-source_multi.c</a>, <a class="el" href="onset_2test-onset_8c-example.html#a11">onset/test-onset.c</a>, <a class="el" href="synth_2test-sampler_8c-example.html#a13">synth/test-sampler.c</a>, and <a class="el" href="tempo_2test-tempo_8c-example.html#a15">tempo/test-tempo.c</a>.</dd>
</dl>
</div>
</div>
<a id="a095a681b83bfe88697c8b0c7918f6b53"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a095a681b83bfe88697c8b0c7918f6b53">◆ </a></span>new_aubio_source()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="source_8h.html#a1a29eaffe41a16145b0c77134fea24c7">aubio_source_t</a>* new_aubio_source </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a40bb5262bf908c328fbcfbe5d29d0201">char_t</a> * </td>
<td class="paramname"><em>uri</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td>
<td class="paramname"><em>samplerate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td>
<td class="paramname"><em>hop_size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>create new <a class="el" href="source_8h.html#a1a29eaffe41a16145b0c77134fea24c7" title="media source object ">aubio_source_t</a> </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uri</td><td>the file path or uri to read from </td></tr>
<tr><td class="paramname">samplerate</td><td>sampling rate to view the fie at </td></tr>
<tr><td class="paramname">hop_size</td><td>the size of the blocks to read from</td></tr>
</table>
</dd>
</dl>
<p>Creates a new source object. If <code>0</code> is passed as <code>samplerate</code>, the sample rate of the original file is used.</p>
<p>The samplerate of newly created source can be obtained using <a class="el" href="source_8h.html#a0aff78c30722264daba2b93ceaa98361" title="get samplerate of source object ">aubio_source_get_samplerate</a>. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="io_2test-sink_8c-example.html#a2">io/test-sink.c</a>, <a class="el" href="io_2test-source_8c-example.html#a0">io/test-source.c</a>, <a class="el" href="io_2test-source_multi_8c-example.html#a0">io/test-source_multi.c</a>, <a class="el" href="onset_2test-onset_8c-example.html#a0">onset/test-onset.c</a>, <a class="el" href="synth_2test-sampler_8c-example.html#a2">synth/test-sampler.c</a>, and <a class="el" href="tempo_2test-tempo_8c-example.html#a0">tempo/test-tempo.c</a>.</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
