1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
6 Secret Rabbit Code (aka libsamplerate)
8 <META NAME=
"Author" CONTENT=
"Erik de Castro Lopo (erikd AT mega-nerd DOT com)">
9 <META NAME=
"Version" CONTENT=
"libsamplerate-0.1.8">
10 <META NAME=
"Description" CONTENT=
"The Secret Rabbit Code Home Page">
11 <META NAME=
"Keywords" CONTENT=
"libsamplerate sound resample audio dsp Linux">
12 <LINK REL=StyleSheet
HREF=
"SRC.css" TYPE=
"text/css" MEDIA=
"all">
15 <BODY TEXT=
"#FFFFFF" BGCOLOR=
"#000000" LINK=
"#FB1465" VLINK=
"#FB1465" ALINK=
"#FB1465">
18 <IMG SRC=
"SRC.png" HEIGHT=
100 WIDTH=
760 ALT=
"SRC.png">
23 <TABLE ALIGN=
"center" WIDTH=
"98%">
29 <A HREF=
"index.html">Home
</A><BR>
30 <A HREF=
"license.html">License
</A><BR>
31 <A HREF=
"history.html">History
</A><BR>
32 <A HREF=
"download.html">Download
</A><BR>
33 <A HREF=
"quality.html">Quality
</A><BR>
34 <A HREF=
"api.html">API
</A><BR>
35 <A HREF=
"bugs.html">Bug Reporting
</A><BR>
36 <A HREF=
"win32.html">On Win32
</A><BR>
37 <A HREF=
"faq.html">FAQ
</A><BR>
38 <A HREF=
"lists.html">Mailing Lists
</A><BR>
39 <A HREF=
"ChangeLog">ChangeLog
</A><BR>
42 Author :
<BR>Erik de Castro Lopo
49 "/cgi-bin/Count.cgi?ft=6|frgb=55;55;55|tr=0|md=6|dd=B|st=1|sh=1|df=src_api.dat"
50 HEIGHT=
30 WIDTH=
100 ALT=
"counter.gif">
55 <!-- ######################################################################## -->
60 <H1><B>Applications Programming Interface
</B></H1>
62 The publically callable functions of libsamplerate are all listed in the
63 <B><samplerate.h
></B> header file.
64 In order to use any of the functionality of libsamplerate, you need to add
67 #include
<samplerate.h
>
70 to the top of any function that call any of the following functions.
71 You will also need to link you binary with the libsamplerate library.
74 The API allows three methods for accessing the capabilies of the library:
77 <LI>A
<A HREF=
"api_simple.html">simple interface
</A> which can sample rate convert
78 a single block of samples (one or more channels) in one go.
79 The simple API is less capable than the full API.
80 <LI>A
<A HREF=
"api_full.html">more fully featured interface
</A> which allows time
81 varying sample rate conversion on streaming data (again one or more
83 <LI>A
<A HREF=
"api_callback.html">callback interface
</A> which has the same
84 functionality as the interface above but allows the details of input and
85 output to be separated.
86 The output is generated by call a read function and the library calls a user
87 supplied callback function to obtain its input.
88 This interface is particularly well suited to applications where the output
89 sample rate is varied with time.
93 <b>NB :
</b> All three access methods are able to process multi channel interleaved
98 The parts of the API which are common to all three interfaces are:
101 <LI> The
<A HREF=
"api_misc.html#ErrorReporting">error reporting
</A> mechanisim.
102 <LI> The available
<A HREF=
"api_misc.html#Converters">converter
</A> types.
103 <LI> The
<A HREF=
"api_misc.html#SRC_DATA">SRC_DATA
</A> struct.
106 All three versions of the API are restricted to operating on buffers of ISO C
107 Standard
<B>float
</B> data.
108 However, there are two
109 <A HREF=
"api_misc.html#Aux">auxillary functions
</A>
110 for converting arrays of float data to and from short data.
114 <B>Note:
</B> The
<B>tests/
</B> and
<B>examples/
</B> directories of the source code
115 distribution contain numerous example programs showing the use of the library.
119 <!-- <A HREF="mailto:aldel0305@mega-nerd.com">For the spam bots</A> -->