12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093 |
- --- a/src/portaudio.h
- +++ /dev/null
- @@ -1,466 +0,0 @@
- -// NOTE: Copy this file to portaudio.h in order to compile with V18 portaudio
- -
- -
- -#ifndef PORT_AUDIO_H
- -#define PORT_AUDIO_H
- -
- -#ifdef __cplusplus
- -extern "C"
- -{
- -#endif /* __cplusplus */
- -
- -/*
- - * $Id: portaudio.h,v 1.5 2002/03/26 18:04:22 philburk Exp $
- - * PortAudio Portable Real-Time Audio Library
- - * PortAudio API Header File
- - * Latest version available at: http://www.audiomulch.com/portaudio/
- - *
- - * Copyright (c) 1999-2000 Ross Bencina and Phil Burk
- - *
- - * Permission is hereby granted, free of charge, to any person obtaining
- - * a copy of this software and associated documentation files
- - * (the "Software"), to deal in the Software without restriction,
- - * including without limitation the rights to use, copy, modify, merge,
- - * publish, distribute, sublicense, and/or sell copies of the Software,
- - * and to permit persons to whom the Software is furnished to do so,
- - * subject to the following conditions:
- - *
- - * The above copyright notice and this permission notice shall be
- - * included in all copies or substantial portions of the Software.
- - *
- - * Any person wishing to distribute modifications to the Software is
- - * requested to send the modifications to the original developer so that
- - * they can be incorporated into the canonical version.
- - *
- - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
- - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
- - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
- - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
- - * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
- - * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
- - * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- - *
- - */
- -
- -typedef int PaError;
- -typedef enum {
- - paNoError = 0,
- -
- - paHostError = -10000,
- - paInvalidChannelCount,
- - paInvalidSampleRate,
- - paInvalidDeviceId,
- - paInvalidFlag,
- - paSampleFormatNotSupported,
- - paBadIODeviceCombination,
- - paInsufficientMemory,
- - paBufferTooBig,
- - paBufferTooSmall,
- - paNullCallback,
- - paBadStreamPtr,
- - paTimedOut,
- - paInternalError,
- - paDeviceUnavailable
- -} PaErrorNum;
- -
- -/*
- - Pa_Initialize() is the library initialisation function - call this before
- - using the library.
- -
- -*/
- -
- -PaError Pa_Initialize( void );
- -
- -/*
- - Pa_Terminate() is the library termination function - call this after
- - using the library.
- -
- -*/
- -
- -PaError Pa_Terminate( void );
- -
- -/*
- - Pa_GetHostError() returns a host specific error code.
- - This can be called after receiving a PortAudio error code of paHostError.
- -
- -*/
- -
- -long Pa_GetHostError( void );
- -
- -/*
- - Pa_GetErrorText() translates the supplied PortAudio error number
- - into a human readable message.
- -
- -*/
- -
- -const char *Pa_GetErrorText( PaError errnum );
- -
- -/*
- - Sample formats
- -
- - These are formats used to pass sound data between the callback and the
- - stream. Each device has a "native" format which may be used when optimum
- - efficiency or control over conversion is required.
- -
- - Formats marked "always available" are supported (emulated) by all
- - PortAudio implementations.
- -
- - The floating point representation (paFloat32) uses +1.0 and -1.0 as the
- - maximum and minimum respectively.
- -
- - paUInt8 is an unsigned 8 bit format where 128 is considered "ground"
- -
- -*/
- -
- -typedef unsigned long PaSampleFormat;
- -#define paFloat32 ((PaSampleFormat) (1<<0)) /*always available*/
- -#define paInt16 ((PaSampleFormat) (1<<1)) /*always available*/
- -#define paInt32 ((PaSampleFormat) (1<<2)) /*always available*/
- -#define paInt24 ((PaSampleFormat) (1<<3))
- -#define paPackedInt24 ((PaSampleFormat) (1<<4))
- -#define paInt8 ((PaSampleFormat) (1<<5))
- -#define paUInt8 ((PaSampleFormat) (1<<6))
- -#define paCustomFormat ((PaSampleFormat) (1<<16))
- -
- -/*
- - Device enumeration mechanism.
- -
- - Device ids range from 0 to Pa_CountDevices()-1.
- -
- - Devices may support input, output or both.
- -
- -*/
- -
- -typedef int PaDeviceID;
- -#define paNoDevice -1
- -
- -int Pa_CountDevices( void );
- -
- -typedef struct
- -{
- - int structVersion;
- - const char *name;
- - int maxInputChannels;
- - int maxOutputChannels;
- - /* Number of discrete rates, or -1 if range supported. */
- - int numSampleRates;
- - /* Array of supported sample rates, or {min,max} if range supported. */
- - const double *sampleRates;
- - PaSampleFormat nativeSampleFormats;
- -}
- -PaDeviceInfo;
- -
- -/*
- - Pa_GetDefaultInputDeviceID(), Pa_GetDefaultOutputDeviceID() return the
- - default device ids for input and output respectively, or paNoDevice if
- - no device is available.
- - The result can be passed to Pa_OpenStream().
- -
- - On the PC, the user can specify a default device by
- - setting an environment variable. For example, to use device #1.
- -
- - set PA_RECOMMENDED_OUTPUT_DEVICE=1
- -
- - The user should first determine the available device ids by using
- - the supplied application "pa_devs".
- -
- -*/
- -
- -PaDeviceID Pa_GetDefaultInputDeviceID( void );
- -PaDeviceID Pa_GetDefaultOutputDeviceID( void );
- -
- -
- -
- -/*
- - Pa_GetDeviceInfo() returns a pointer to an immutable PaDeviceInfo structure
- - for the device specified.
- - If the device parameter is out of range the function returns NULL.
- -
- - PortAudio manages the memory referenced by the returned pointer, the client
- - must not manipulate or free the memory. The pointer is only guaranteed to be
- - valid between calls to Pa_Initialize() and Pa_Terminate().
- -
- -*/
- -
- -const PaDeviceInfo* Pa_GetDeviceInfo( PaDeviceID device );
- -
- -/*
- - PaTimestamp is used to represent a continuous sample clock with arbitrary
- - start time that can be used for syncronization. The type is used for the
- - outTime argument to the PortAudioCallback and as the result of Pa_StreamTime()
- -
- -*/
- -
- -typedef double PaTimestamp;
- -
- -/*
- - PortAudioCallback is implemented by PortAudio clients.
- -
- - inputBuffer and outputBuffer are arrays of interleaved samples,
- - the format, packing and number of channels used by the buffers are
- - determined by parameters to Pa_OpenStream() (see below).
- -
- - framesPerBuffer is the number of sample frames to be processed by the callback.
- -
- - outTime is the time in samples when the buffer(s) processed by
- - this callback will begin being played at the audio output.
- - See also Pa_StreamTime()
- -
- - userData is the value of a user supplied pointer passed to Pa_OpenStream()
- - intended for storing synthesis data etc.
- -
- - return value:
- - The callback can return a non-zero value to stop the stream. This may be
- - useful in applications such as soundfile players where a specific duration
- - of output is required. However, it is not necessary to utilise this mechanism
- - as StopStream() will also terminate the stream. A callback returning a
- - non-zero value must fill the entire outputBuffer.
- -
- - NOTE: None of the other stream functions may be called from within the
- - callback function except for Pa_GetCPULoad().
- -
- -*/
- -
- -typedef int (PortAudioCallback)(
- - void *inputBuffer, void *outputBuffer,
- - unsigned long framesPerBuffer,
- - PaTimestamp outTime, void *userData );
- -
- -
- -/*
- - Stream flags
- -
- - These flags may be supplied (ored together) in the streamFlags argument to
- - the Pa_OpenStream() function.
- -
- -*/
- -
- -#define paNoFlag (0)
- -#define paClipOff (1<<0) /* disable default clipping of out of range samples */
- -#define paDitherOff (1<<1) /* disable default dithering */
- -#define paPlatformSpecificFlags (0x00010000)
- -typedef unsigned long PaStreamFlags;
- -
- -/*
- - A single PortAudioStream provides multiple channels of real-time
- - input and output audio streaming to a client application.
- - Pointers to PortAudioStream objects are passed between PortAudio functions.
- -*/
- -
- -typedef void PortAudioStream;
- -#define PaStream PortAudioStream
- -
- -/*
- - Pa_OpenStream() opens a stream for either input, output or both.
- -
- - stream is the address of a PortAudioStream pointer which will receive
- - a pointer to the newly opened stream.
- -
- - inputDevice is the id of the device used for input (see PaDeviceID above.)
- - inputDevice may be paNoDevice to indicate that an input device is not required.
- -
- - numInputChannels is the number of channels of sound to be delivered to the
- - callback. It can range from 1 to the value of maxInputChannels in the
- - PaDeviceInfo record for the device specified by the inputDevice parameter.
- - If inputDevice is paNoDevice numInputChannels is ignored.
- -
- - inputSampleFormat is the sample format of inputBuffer provided to the callback
- - function. inputSampleFormat may be any of the formats described by the
- - PaSampleFormat enumeration (see above). PortAudio guarantees support for
- - the device's native formats (nativeSampleFormats in the device info record)
- - and additionally 16 and 32 bit integer and 32 bit floating point formats.
- - Support for other formats is implementation defined.
- -
- - inputDriverInfo is a pointer to an optional driver specific data structure
- - containing additional information for device setup or stream processing.
- - inputDriverInfo is never required for correct operation. If not used
- - inputDriverInfo should be NULL.
- -
- - outputDevice is the id of the device used for output (see PaDeviceID above.)
- - outputDevice may be paNoDevice to indicate that an output device is not required.
- -
- - numOutputChannels is the number of channels of sound to be supplied by the
- - callback. See the definition of numInputChannels above for more details.
- -
- - outputSampleFormat is the sample format of the outputBuffer filled by the
- - callback function. See the definition of inputSampleFormat above for more
- - details.
- -
- - outputDriverInfo is a pointer to an optional driver specific data structure
- - containing additional information for device setup or stream processing.
- - outputDriverInfo is never required for correct operation. If not used
- - outputDriverInfo should be NULL.
- -
- - sampleRate is the desired sampleRate. For full-duplex streams it is the
- - sample rate for both input and output
- -
- - framesPerBuffer is the length in sample frames of all internal sample buffers
- - used for communication with platform specific audio routines. Wherever
- - possible this corresponds to the framesPerBuffer parameter passed to the
- - callback function.
- -
- - numberOfBuffers is the number of buffers used for multibuffered communication
- - with the platform specific audio routines. If you pass zero, then an optimum
- - value will be chosen for you internally. This parameter is provided only
- - as a guide - and does not imply that an implementation must use multibuffered
- - i/o when reliable double buffering is available (such as SndPlayDoubleBuffer()
- - on the Macintosh.)
- -
- - streamFlags may contain a combination of flags ORed together.
- - These flags modify the behaviour of the streaming process. Some flags may only
- - be relevant to certain buffer formats.
- -
- - callback is a pointer to a client supplied function that is responsible
- - for processing and filling input and output buffers (see above for details.)
- -
- - userData is a client supplied pointer which is passed to the callback
- - function. It could for example, contain a pointer to instance data necessary
- - for processing the audio buffers.
- -
- - return value:
- - Upon success Pa_OpenStream() returns PaNoError and places a pointer to a
- - valid PortAudioStream in the stream argument. The stream is inactive (stopped).
- - If a call to Pa_OpenStream() fails a non-zero error code is returned (see
- - PaError above) and the value of stream is invalid.
- -
- -*/
- -
- -PaError Pa_OpenStream( PortAudioStream** stream,
- - PaDeviceID inputDevice,
- - int numInputChannels,
- - PaSampleFormat inputSampleFormat,
- - void *inputDriverInfo,
- - PaDeviceID outputDevice,
- - int numOutputChannels,
- - PaSampleFormat outputSampleFormat,
- - void *outputDriverInfo,
- - double sampleRate,
- - unsigned long framesPerBuffer,
- - unsigned long numberOfBuffers,
- - PaStreamFlags streamFlags,
- - PortAudioCallback *callback,
- - void *userData );
- -
- -
- -/*
- - Pa_OpenDefaultStream() is a simplified version of Pa_OpenStream() that opens
- - the default input and/or output devices. Most parameters have identical meaning
- - to their Pa_OpenStream() counterparts, with the following exceptions:
- -
- - If either numInputChannels or numOutputChannels is 0 the respective device
- - is not opened. This has the same effect as passing paNoDevice in the device
- - arguments to Pa_OpenStream().
- -
- - sampleFormat applies to both the input and output buffers.
- -
- -*/
- -
- -PaError Pa_OpenDefaultStream( PortAudioStream** stream,
- - int numInputChannels,
- - int numOutputChannels,
- - PaSampleFormat sampleFormat,
- - double sampleRate,
- - unsigned long framesPerBuffer,
- - unsigned long numberOfBuffers,
- - PortAudioCallback *callback,
- - void *userData );
- -
- -/*
- - Pa_CloseStream() closes an audio stream, flushing any pending buffers.
- -
- -*/
- -
- -PaError Pa_CloseStream( PortAudioStream* );
- -
- -/*
- - Pa_StartStream() and Pa_StopStream() begin and terminate audio processing.
- - Pa_StopStream() waits until all pending audio buffers have been played.
- - Pa_AbortStream() stops playing immediately without waiting for pending
- - buffers to complete.
- -
- -*/
- -
- -PaError Pa_StartStream( PortAudioStream *stream );
- -
- -PaError Pa_StopStream( PortAudioStream *stream );
- -
- -PaError Pa_AbortStream( PortAudioStream *stream );
- -
- -/*
- - Pa_StreamActive() returns one (1) when the stream is active (ie playing
- - or recording audio), zero (0) when not playing, or a negative error number
- - if the stream is invalid.
- - The stream is active between calls to Pa_StartStream() and Pa_StopStream(),
- - but may also become inactive if the callback returns a non-zero value.
- - In the latter case, the stream is considered inactive after the last
- - buffer has finished playing.
- -
- -*/
- -
- -PaError Pa_StreamActive( PortAudioStream *stream );
- -
- -/*
- - Pa_StreamTime() returns the current output time in samples for the stream.
- - This time may be used as a time reference (for example synchronizing audio to
- - MIDI).
- -
- -*/
- -
- -PaTimestamp Pa_StreamTime( PortAudioStream *stream );
- -
- -/*
- - Pa_GetCPULoad() returns the CPU Load for the stream.
- - The "CPU Load" is a fraction of total CPU time consumed by the stream's
- - audio processing routines including, but not limited to the client supplied
- - callback.
- - A value of 0.5 would imply that PortAudio and the sound generating
- - callback was consuming roughly 50% of the available CPU time.
- - This function may be called from the callback function or the application.
- -
- -*/
- -
- -double Pa_GetCPULoad( PortAudioStream* stream );
- -
- -/*
- - Pa_GetMinNumBuffers() returns the minimum number of buffers required by
- - the current host based on minimum latency.
- - On the PC, for the DirectSound implementation, latency can be optionally set
- - by user by setting an environment variable.
- - For example, to set latency to 200 msec, put:
- -
- - set PA_MIN_LATENCY_MSEC=200
- -
- - in the AUTOEXEC.BAT file and reboot.
- - If the environment variable is not set, then the latency will be determined
- - based on the OS. Windows NT has higher latency than Win95.
- -
- -*/
- -
- -int Pa_GetMinNumBuffers( int framesPerBuffer, double sampleRate );
- -
- -/*
- - Pa_Sleep() puts the caller to sleep for at least 'msec' milliseconds.
- - You may sleep longer than the requested time so don't rely on this for
- - accurate musical timing.
- -
- - Pa_Sleep() is provided as a convenience for authors of portable code (such as
- - the tests and examples in the PortAudio distribution.)
- -
- -*/
- -
- -void Pa_Sleep( long msec );
- -
- -/*
- - Pa_GetSampleSize() returns the size in bytes of a single sample in the
- - supplied PaSampleFormat, or paSampleFormatNotSupported if the format is
- - no supported.
- -
- -*/
- -
- -PaError Pa_GetSampleSize( PaSampleFormat format );
- -
- -
- -#ifdef __cplusplus
- -}
- -#endif /* __cplusplus */
- -#endif /* PORT_AUDIO_H */
- --- a/src/portaudio18.h
- +++ /dev/null
- @@ -1,466 +0,0 @@
- -// NOTE: Copy this file to portaudio.h in order to compile with V18 portaudio
- -
- -
- -#ifndef PORT_AUDIO_H
- -#define PORT_AUDIO_H
- -
- -#ifdef __cplusplus
- -extern "C"
- -{
- -#endif /* __cplusplus */
- -
- -/*
- - * $Id: portaudio.h,v 1.5 2002/03/26 18:04:22 philburk Exp $
- - * PortAudio Portable Real-Time Audio Library
- - * PortAudio API Header File
- - * Latest version available at: http://www.audiomulch.com/portaudio/
- - *
- - * Copyright (c) 1999-2000 Ross Bencina and Phil Burk
- - *
- - * Permission is hereby granted, free of charge, to any person obtaining
- - * a copy of this software and associated documentation files
- - * (the "Software"), to deal in the Software without restriction,
- - * including without limitation the rights to use, copy, modify, merge,
- - * publish, distribute, sublicense, and/or sell copies of the Software,
- - * and to permit persons to whom the Software is furnished to do so,
- - * subject to the following conditions:
- - *
- - * The above copyright notice and this permission notice shall be
- - * included in all copies or substantial portions of the Software.
- - *
- - * Any person wishing to distribute modifications to the Software is
- - * requested to send the modifications to the original developer so that
- - * they can be incorporated into the canonical version.
- - *
- - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
- - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
- - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
- - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
- - * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
- - * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
- - * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- - *
- - */
- -
- -typedef int PaError;
- -typedef enum {
- - paNoError = 0,
- -
- - paHostError = -10000,
- - paInvalidChannelCount,
- - paInvalidSampleRate,
- - paInvalidDeviceId,
- - paInvalidFlag,
- - paSampleFormatNotSupported,
- - paBadIODeviceCombination,
- - paInsufficientMemory,
- - paBufferTooBig,
- - paBufferTooSmall,
- - paNullCallback,
- - paBadStreamPtr,
- - paTimedOut,
- - paInternalError,
- - paDeviceUnavailable
- -} PaErrorNum;
- -
- -/*
- - Pa_Initialize() is the library initialisation function - call this before
- - using the library.
- -
- -*/
- -
- -PaError Pa_Initialize( void );
- -
- -/*
- - Pa_Terminate() is the library termination function - call this after
- - using the library.
- -
- -*/
- -
- -PaError Pa_Terminate( void );
- -
- -/*
- - Pa_GetHostError() returns a host specific error code.
- - This can be called after receiving a PortAudio error code of paHostError.
- -
- -*/
- -
- -long Pa_GetHostError( void );
- -
- -/*
- - Pa_GetErrorText() translates the supplied PortAudio error number
- - into a human readable message.
- -
- -*/
- -
- -const char *Pa_GetErrorText( PaError errnum );
- -
- -/*
- - Sample formats
- -
- - These are formats used to pass sound data between the callback and the
- - stream. Each device has a "native" format which may be used when optimum
- - efficiency or control over conversion is required.
- -
- - Formats marked "always available" are supported (emulated) by all
- - PortAudio implementations.
- -
- - The floating point representation (paFloat32) uses +1.0 and -1.0 as the
- - maximum and minimum respectively.
- -
- - paUInt8 is an unsigned 8 bit format where 128 is considered "ground"
- -
- -*/
- -
- -typedef unsigned long PaSampleFormat;
- -#define paFloat32 ((PaSampleFormat) (1<<0)) /*always available*/
- -#define paInt16 ((PaSampleFormat) (1<<1)) /*always available*/
- -#define paInt32 ((PaSampleFormat) (1<<2)) /*always available*/
- -#define paInt24 ((PaSampleFormat) (1<<3))
- -#define paPackedInt24 ((PaSampleFormat) (1<<4))
- -#define paInt8 ((PaSampleFormat) (1<<5))
- -#define paUInt8 ((PaSampleFormat) (1<<6))
- -#define paCustomFormat ((PaSampleFormat) (1<<16))
- -
- -/*
- - Device enumeration mechanism.
- -
- - Device ids range from 0 to Pa_CountDevices()-1.
- -
- - Devices may support input, output or both.
- -
- -*/
- -
- -typedef int PaDeviceID;
- -#define paNoDevice -1
- -
- -int Pa_CountDevices( void );
- -
- -typedef struct
- -{
- - int structVersion;
- - const char *name;
- - int maxInputChannels;
- - int maxOutputChannels;
- - /* Number of discrete rates, or -1 if range supported. */
- - int numSampleRates;
- - /* Array of supported sample rates, or {min,max} if range supported. */
- - const double *sampleRates;
- - PaSampleFormat nativeSampleFormats;
- -}
- -PaDeviceInfo;
- -
- -/*
- - Pa_GetDefaultInputDeviceID(), Pa_GetDefaultOutputDeviceID() return the
- - default device ids for input and output respectively, or paNoDevice if
- - no device is available.
- - The result can be passed to Pa_OpenStream().
- -
- - On the PC, the user can specify a default device by
- - setting an environment variable. For example, to use device #1.
- -
- - set PA_RECOMMENDED_OUTPUT_DEVICE=1
- -
- - The user should first determine the available device ids by using
- - the supplied application "pa_devs".
- -
- -*/
- -
- -PaDeviceID Pa_GetDefaultInputDeviceID( void );
- -PaDeviceID Pa_GetDefaultOutputDeviceID( void );
- -
- -
- -
- -/*
- - Pa_GetDeviceInfo() returns a pointer to an immutable PaDeviceInfo structure
- - for the device specified.
- - If the device parameter is out of range the function returns NULL.
- -
- - PortAudio manages the memory referenced by the returned pointer, the client
- - must not manipulate or free the memory. The pointer is only guaranteed to be
- - valid between calls to Pa_Initialize() and Pa_Terminate().
- -
- -*/
- -
- -const PaDeviceInfo* Pa_GetDeviceInfo( PaDeviceID device );
- -
- -/*
- - PaTimestamp is used to represent a continuous sample clock with arbitrary
- - start time that can be used for syncronization. The type is used for the
- - outTime argument to the PortAudioCallback and as the result of Pa_StreamTime()
- -
- -*/
- -
- -typedef double PaTimestamp;
- -
- -/*
- - PortAudioCallback is implemented by PortAudio clients.
- -
- - inputBuffer and outputBuffer are arrays of interleaved samples,
- - the format, packing and number of channels used by the buffers are
- - determined by parameters to Pa_OpenStream() (see below).
- -
- - framesPerBuffer is the number of sample frames to be processed by the callback.
- -
- - outTime is the time in samples when the buffer(s) processed by
- - this callback will begin being played at the audio output.
- - See also Pa_StreamTime()
- -
- - userData is the value of a user supplied pointer passed to Pa_OpenStream()
- - intended for storing synthesis data etc.
- -
- - return value:
- - The callback can return a non-zero value to stop the stream. This may be
- - useful in applications such as soundfile players where a specific duration
- - of output is required. However, it is not necessary to utilise this mechanism
- - as StopStream() will also terminate the stream. A callback returning a
- - non-zero value must fill the entire outputBuffer.
- -
- - NOTE: None of the other stream functions may be called from within the
- - callback function except for Pa_GetCPULoad().
- -
- -*/
- -
- -typedef int (PortAudioCallback)(
- - void *inputBuffer, void *outputBuffer,
- - unsigned long framesPerBuffer,
- - PaTimestamp outTime, void *userData );
- -
- -
- -/*
- - Stream flags
- -
- - These flags may be supplied (ored together) in the streamFlags argument to
- - the Pa_OpenStream() function.
- -
- -*/
- -
- -#define paNoFlag (0)
- -#define paClipOff (1<<0) /* disable default clipping of out of range samples */
- -#define paDitherOff (1<<1) /* disable default dithering */
- -#define paPlatformSpecificFlags (0x00010000)
- -typedef unsigned long PaStreamFlags;
- -
- -/*
- - A single PortAudioStream provides multiple channels of real-time
- - input and output audio streaming to a client application.
- - Pointers to PortAudioStream objects are passed between PortAudio functions.
- -*/
- -
- -typedef void PortAudioStream;
- -#define PaStream PortAudioStream
- -
- -/*
- - Pa_OpenStream() opens a stream for either input, output or both.
- -
- - stream is the address of a PortAudioStream pointer which will receive
- - a pointer to the newly opened stream.
- -
- - inputDevice is the id of the device used for input (see PaDeviceID above.)
- - inputDevice may be paNoDevice to indicate that an input device is not required.
- -
- - numInputChannels is the number of channels of sound to be delivered to the
- - callback. It can range from 1 to the value of maxInputChannels in the
- - PaDeviceInfo record for the device specified by the inputDevice parameter.
- - If inputDevice is paNoDevice numInputChannels is ignored.
- -
- - inputSampleFormat is the sample format of inputBuffer provided to the callback
- - function. inputSampleFormat may be any of the formats described by the
- - PaSampleFormat enumeration (see above). PortAudio guarantees support for
- - the device's native formats (nativeSampleFormats in the device info record)
- - and additionally 16 and 32 bit integer and 32 bit floating point formats.
- - Support for other formats is implementation defined.
- -
- - inputDriverInfo is a pointer to an optional driver specific data structure
- - containing additional information for device setup or stream processing.
- - inputDriverInfo is never required for correct operation. If not used
- - inputDriverInfo should be NULL.
- -
- - outputDevice is the id of the device used for output (see PaDeviceID above.)
- - outputDevice may be paNoDevice to indicate that an output device is not required.
- -
- - numOutputChannels is the number of channels of sound to be supplied by the
- - callback. See the definition of numInputChannels above for more details.
- -
- - outputSampleFormat is the sample format of the outputBuffer filled by the
- - callback function. See the definition of inputSampleFormat above for more
- - details.
- -
- - outputDriverInfo is a pointer to an optional driver specific data structure
- - containing additional information for device setup or stream processing.
- - outputDriverInfo is never required for correct operation. If not used
- - outputDriverInfo should be NULL.
- -
- - sampleRate is the desired sampleRate. For full-duplex streams it is the
- - sample rate for both input and output
- -
- - framesPerBuffer is the length in sample frames of all internal sample buffers
- - used for communication with platform specific audio routines. Wherever
- - possible this corresponds to the framesPerBuffer parameter passed to the
- - callback function.
- -
- - numberOfBuffers is the number of buffers used for multibuffered communication
- - with the platform specific audio routines. If you pass zero, then an optimum
- - value will be chosen for you internally. This parameter is provided only
- - as a guide - and does not imply that an implementation must use multibuffered
- - i/o when reliable double buffering is available (such as SndPlayDoubleBuffer()
- - on the Macintosh.)
- -
- - streamFlags may contain a combination of flags ORed together.
- - These flags modify the behaviour of the streaming process. Some flags may only
- - be relevant to certain buffer formats.
- -
- - callback is a pointer to a client supplied function that is responsible
- - for processing and filling input and output buffers (see above for details.)
- -
- - userData is a client supplied pointer which is passed to the callback
- - function. It could for example, contain a pointer to instance data necessary
- - for processing the audio buffers.
- -
- - return value:
- - Upon success Pa_OpenStream() returns PaNoError and places a pointer to a
- - valid PortAudioStream in the stream argument. The stream is inactive (stopped).
- - If a call to Pa_OpenStream() fails a non-zero error code is returned (see
- - PaError above) and the value of stream is invalid.
- -
- -*/
- -
- -PaError Pa_OpenStream( PortAudioStream** stream,
- - PaDeviceID inputDevice,
- - int numInputChannels,
- - PaSampleFormat inputSampleFormat,
- - void *inputDriverInfo,
- - PaDeviceID outputDevice,
- - int numOutputChannels,
- - PaSampleFormat outputSampleFormat,
- - void *outputDriverInfo,
- - double sampleRate,
- - unsigned long framesPerBuffer,
- - unsigned long numberOfBuffers,
- - PaStreamFlags streamFlags,
- - PortAudioCallback *callback,
- - void *userData );
- -
- -
- -/*
- - Pa_OpenDefaultStream() is a simplified version of Pa_OpenStream() that opens
- - the default input and/or output devices. Most parameters have identical meaning
- - to their Pa_OpenStream() counterparts, with the following exceptions:
- -
- - If either numInputChannels or numOutputChannels is 0 the respective device
- - is not opened. This has the same effect as passing paNoDevice in the device
- - arguments to Pa_OpenStream().
- -
- - sampleFormat applies to both the input and output buffers.
- -
- -*/
- -
- -PaError Pa_OpenDefaultStream( PortAudioStream** stream,
- - int numInputChannels,
- - int numOutputChannels,
- - PaSampleFormat sampleFormat,
- - double sampleRate,
- - unsigned long framesPerBuffer,
- - unsigned long numberOfBuffers,
- - PortAudioCallback *callback,
- - void *userData );
- -
- -/*
- - Pa_CloseStream() closes an audio stream, flushing any pending buffers.
- -
- -*/
- -
- -PaError Pa_CloseStream( PortAudioStream* );
- -
- -/*
- - Pa_StartStream() and Pa_StopStream() begin and terminate audio processing.
- - Pa_StopStream() waits until all pending audio buffers have been played.
- - Pa_AbortStream() stops playing immediately without waiting for pending
- - buffers to complete.
- -
- -*/
- -
- -PaError Pa_StartStream( PortAudioStream *stream );
- -
- -PaError Pa_StopStream( PortAudioStream *stream );
- -
- -PaError Pa_AbortStream( PortAudioStream *stream );
- -
- -/*
- - Pa_StreamActive() returns one (1) when the stream is active (ie playing
- - or recording audio), zero (0) when not playing, or a negative error number
- - if the stream is invalid.
- - The stream is active between calls to Pa_StartStream() and Pa_StopStream(),
- - but may also become inactive if the callback returns a non-zero value.
- - In the latter case, the stream is considered inactive after the last
- - buffer has finished playing.
- -
- -*/
- -
- -PaError Pa_StreamActive( PortAudioStream *stream );
- -
- -/*
- - Pa_StreamTime() returns the current output time in samples for the stream.
- - This time may be used as a time reference (for example synchronizing audio to
- - MIDI).
- -
- -*/
- -
- -PaTimestamp Pa_StreamTime( PortAudioStream *stream );
- -
- -/*
- - Pa_GetCPULoad() returns the CPU Load for the stream.
- - The "CPU Load" is a fraction of total CPU time consumed by the stream's
- - audio processing routines including, but not limited to the client supplied
- - callback.
- - A value of 0.5 would imply that PortAudio and the sound generating
- - callback was consuming roughly 50% of the available CPU time.
- - This function may be called from the callback function or the application.
- -
- -*/
- -
- -double Pa_GetCPULoad( PortAudioStream* stream );
- -
- -/*
- - Pa_GetMinNumBuffers() returns the minimum number of buffers required by
- - the current host based on minimum latency.
- - On the PC, for the DirectSound implementation, latency can be optionally set
- - by user by setting an environment variable.
- - For example, to set latency to 200 msec, put:
- -
- - set PA_MIN_LATENCY_MSEC=200
- -
- - in the AUTOEXEC.BAT file and reboot.
- - If the environment variable is not set, then the latency will be determined
- - based on the OS. Windows NT has higher latency than Win95.
- -
- -*/
- -
- -int Pa_GetMinNumBuffers( int framesPerBuffer, double sampleRate );
- -
- -/*
- - Pa_Sleep() puts the caller to sleep for at least 'msec' milliseconds.
- - You may sleep longer than the requested time so don't rely on this for
- - accurate musical timing.
- -
- - Pa_Sleep() is provided as a convenience for authors of portable code (such as
- - the tests and examples in the PortAudio distribution.)
- -
- -*/
- -
- -void Pa_Sleep( long msec );
- -
- -/*
- - Pa_GetSampleSize() returns the size in bytes of a single sample in the
- - supplied PaSampleFormat, or paSampleFormatNotSupported if the format is
- - no supported.
- -
- -*/
- -
- -PaError Pa_GetSampleSize( PaSampleFormat format );
- -
- -
- -#ifdef __cplusplus
- -}
- -#endif /* __cplusplus */
- -#endif /* PORT_AUDIO_H */
- --- a/src/portaudio19.h
- +++ /dev/null
- @@ -1,1127 +0,0 @@
- -// NOTE: Copy this file to portaudio.h in order to compile with V19 portaudio
- -
- -#ifndef PORTAUDIO_H
- -#define PORTAUDIO_H
- -/*
- - * $Id: portaudio.h 1061 2006-06-19 22:46:41Z lschwardt $
- - * PortAudio Portable Real-Time Audio Library
- - * PortAudio API Header File
- - * Latest version available at: http://www.portaudio.com/
- - *
- - * Copyright (c) 1999-2002 Ross Bencina and Phil Burk
- - *
- - * Permission is hereby granted, free of charge, to any person obtaining
- - * a copy of this software and associated documentation files
- - * (the "Software"), to deal in the Software without restriction,
- - * including without limitation the rights to use, copy, modify, merge,
- - * publish, distribute, sublicense, and/or sell copies of the Software,
- - * and to permit persons to whom the Software is furnished to do so,
- - * subject to the following conditions:
- - *
- - * The above copyright notice and this permission notice shall be
- - * included in all copies or substantial portions of the Software.
- - *
- - * Any person wishing to distribute modifications to the Software is
- - * requested to send the modifications to the original developer so that
- - * they can be incorporated into the canonical version.
- - *
- - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
- - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
- - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
- - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
- - * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
- - * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
- - * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- - */
- -
- -/** @file
- - @brief The PortAudio API.
- -*/
- -
- -
- -#ifdef __cplusplus
- -extern "C"
- -{
- -#endif /* __cplusplus */
- -
- -
- -/** Retrieve the release number of the currently running PortAudio build,
- - eg 1900.
- -*/
- -int Pa_GetVersion( void );
- -
- -
- -/** Retrieve a textual description of the current PortAudio build,
- - eg "PortAudio V19-devel 13 October 2002".
- -*/
- -const char* Pa_GetVersionText( void );
- -
- -
- -/** Error codes returned by PortAudio functions.
- - Note that with the exception of paNoError, all PaErrorCodes are negative.
- -*/
- -
- -typedef int PaError;
- -typedef enum PaErrorCode
- -{
- - paNoError = 0,
- -
- - paNotInitialized = -10000,
- - paUnanticipatedHostError,
- - paInvalidChannelCount,
- - paInvalidSampleRate,
- - paInvalidDevice,
- - paInvalidFlag,
- - paSampleFormatNotSupported,
- - paBadIODeviceCombination,
- - paInsufficientMemory,
- - paBufferTooBig,
- - paBufferTooSmall,
- - paNullCallback,
- - paBadStreamPtr,
- - paTimedOut,
- - paInternalError,
- - paDeviceUnavailable,
- - paIncompatibleHostApiSpecificStreamInfo,
- - paStreamIsStopped,
- - paStreamIsNotStopped,
- - paInputOverflowed,
- - paOutputUnderflowed,
- - paHostApiNotFound,
- - paInvalidHostApi,
- - paCanNotReadFromACallbackStream, /**< @todo review error code name */
- - paCanNotWriteToACallbackStream, /**< @todo review error code name */
- - paCanNotReadFromAnOutputOnlyStream, /**< @todo review error code name */
- - paCanNotWriteToAnInputOnlyStream, /**< @todo review error code name */
- - paIncompatibleStreamHostApi,
- - paBadBufferPtr
- -} PaErrorCode;
- -
- -
- -/** Translate the supplied PortAudio error code into a human readable
- - message.
- -*/
- -const char *Pa_GetErrorText( PaError errorCode );
- -
- -
- -/** Library initialization function - call this before using PortAudio.
- - This function initialises internal data structures and prepares underlying
- - host APIs for use. This function MUST be called before using any other
- - PortAudio API functions.
- -
- - If Pa_Initialize() is called multiple times, each successful
- - call must be matched with a corresponding call to Pa_Terminate().
- - Pairs of calls to Pa_Initialize()/Pa_Terminate() may overlap, and are not
- - required to be fully nested.
- -
- - Note that if Pa_Initialize() returns an error code, Pa_Terminate() should
- - NOT be called.
- -
- - @return paNoError if successful, otherwise an error code indicating the cause
- - of failure.
- -
- - @see Pa_Terminate
- -*/
- -PaError Pa_Initialize( void );
- -
- -
- -/** Library termination function - call this when finished using PortAudio.
- - This function deallocates all resources allocated by PortAudio since it was
- - initializied by a call to Pa_Initialize(). In cases where Pa_Initialise() has
- - been called multiple times, each call must be matched with a corresponding call
- - to Pa_Terminate(). The final matching call to Pa_Terminate() will automatically
- - close any PortAudio streams that are still open.
- -
- - Pa_Terminate() MUST be called before exiting a program which uses PortAudio.
- - Failure to do so may result in serious resource leaks, such as audio devices
- - not being available until the next reboot.
- -
- - @return paNoError if successful, otherwise an error code indicating the cause
- - of failure.
- -
- - @see Pa_Initialize
- -*/
- -PaError Pa_Terminate( void );
- -
- -
- -
- -/** The type used to refer to audio devices. Values of this type usually
- - range from 0 to (Pa_DeviceCount-1), and may also take on the PaNoDevice
- - and paUseHostApiSpecificDeviceSpecification values.
- -
- - @see Pa_DeviceCount, paNoDevice, paUseHostApiSpecificDeviceSpecification
- -*/
- -typedef int PaDeviceIndex;
- -
- -
- -/** A special PaDeviceIndex value indicating that no device is available,
- - or should be used.
- -
- - @see PaDeviceIndex
- -*/
- -#define paNoDevice ((PaDeviceIndex)-1)
- -
- -
- -/** A special PaDeviceIndex value indicating that the device(s) to be used
- - are specified in the host api specific stream info structure.
- -
- - @see PaDeviceIndex
- -*/
- -#define paUseHostApiSpecificDeviceSpecification ((PaDeviceIndex)-2)
- -
- -
- -/* Host API enumeration mechanism */
- -
- -/** The type used to enumerate to host APIs at runtime. Values of this type
- - range from 0 to (Pa_GetHostApiCount()-1).
- -
- - @see Pa_GetHostApiCount
- -*/
- -typedef int PaHostApiIndex;
- -
- -
- -/** Retrieve the number of available host APIs. Even if a host API is
- - available it may have no devices available.
- -
- - @return A non-negative value indicating the number of available host APIs
- - or, a PaErrorCode (which are always negative) if PortAudio is not initialized
- - or an error is encountered.
- -
- - @see PaHostApiIndex
- -*/
- -PaHostApiIndex Pa_GetHostApiCount( void );
- -
- -
- -/** Retrieve the index of the default host API. The default host API will be
- - the lowest common denominator host API on the current platform and is
- - unlikely to provide the best performance.
- -
- - @return A non-negative value ranging from 0 to (Pa_GetHostApiCount()-1)
- - indicating the default host API index or, a PaErrorCode (which are always
- - negative) if PortAudio is not initialized or an error is encountered.
- -*/
- -PaHostApiIndex Pa_GetDefaultHostApi( void );
- -
- -
- -/** Unchanging unique identifiers for each supported host API. This type
- - is used in the PaHostApiInfo structure. The values are guaranteed to be
- - unique and to never change, thus allowing code to be written that
- - conditionally uses host API specific extensions.
- -
- - New type ids will be allocated when support for a host API reaches
- - "public alpha" status, prior to that developers should use the
- - paInDevelopment type id.
- -
- - @see PaHostApiInfo
- -*/
- -typedef enum PaHostApiTypeId
- -{
- - paInDevelopment=0, /* use while developing support for a new host API */
- - paDirectSound=1,
- - paMME=2,
- - paASIO=3,
- - paSoundManager=4,
- - paCoreAudio=5,
- - paOSS=7,
- - paALSA=8,
- - paAL=9,
- - paBeOS=10,
- - paWDMKS=11,
- - paJACK=12,
- - paWASAPI=13,
- - paAudioScienceHPI=14
- -} PaHostApiTypeId;
- -
- -
- -/** A structure containing information about a particular host API. */
- -
- -typedef struct PaHostApiInfo
- -{
- - /** this is struct version 1 */
- - int structVersion;
- - /** The well known unique identifier of this host API @see PaHostApiTypeId */
- - PaHostApiTypeId type;
- - /** A textual description of the host API for display on user interfaces. */
- - const char *name;
- -
- - /** The number of devices belonging to this host API. This field may be
- - used in conjunction with Pa_HostApiDeviceIndexToDeviceIndex() to enumerate
- - all devices for this host API.
- - @see Pa_HostApiDeviceIndexToDeviceIndex
- - */
- - int deviceCount;
- -
- - /** The default input device for this host API. The value will be a
- - device index ranging from 0 to (Pa_GetDeviceCount()-1), or paNoDevice
- - if no default input device is available.
- - */
- - PaDeviceIndex defaultInputDevice;
- -
- - /** The default output device for this host API. The value will be a
- - device index ranging from 0 to (Pa_GetDeviceCount()-1), or paNoDevice
- - if no default output device is available.
- - */
- - PaDeviceIndex defaultOutputDevice;
- -
- -} PaHostApiInfo;
- -
- -
- -/** Retrieve a pointer to a structure containing information about a specific
- - host Api.
- -
- - @param hostApi A valid host API index ranging from 0 to (Pa_GetHostApiCount()-1)
- -
- - @return A pointer to an immutable PaHostApiInfo structure describing
- - a specific host API. If the hostApi parameter is out of range or an error
- - is encountered, the function returns NULL.
- -
- - The returned structure is owned by the PortAudio implementation and must not
- - be manipulated or freed. The pointer is only guaranteed to be valid between
- - calls to Pa_Initialize() and Pa_Terminate().
- -*/
- -const PaHostApiInfo * Pa_GetHostApiInfo( PaHostApiIndex hostApi );
- -
- -
- -/** Convert a static host API unique identifier, into a runtime
- - host API index.
- -
- - @param type A unique host API identifier belonging to the PaHostApiTypeId
- - enumeration.
- -
- - @return A valid PaHostApiIndex ranging from 0 to (Pa_GetHostApiCount()-1) or,
- - a PaErrorCode (which are always negative) if PortAudio is not initialized
- - or an error is encountered.
- -
- - The paHostApiNotFound error code indicates that the host API specified by the
- - type parameter is not available.
- -
- - @see PaHostApiTypeId
- -*/
- -PaHostApiIndex Pa_HostApiTypeIdToHostApiIndex( PaHostApiTypeId type );
- -
- -
- -/** Convert a host-API-specific device index to standard PortAudio device index.
- - This function may be used in conjunction with the deviceCount field of
- - PaHostApiInfo to enumerate all devices for the specified host API.
- -
- - @param hostApi A valid host API index ranging from 0 to (Pa_GetHostApiCount()-1)
- -
- - @param hostApiDeviceIndex A valid per-host device index in the range
- - 0 to (Pa_GetHostApiInfo(hostApi)->deviceCount-1)
- -
- - @return A non-negative PaDeviceIndex ranging from 0 to (Pa_GetDeviceCount()-1)
- - or, a PaErrorCode (which are always negative) if PortAudio is not initialized
- - or an error is encountered.
- -
- - A paInvalidHostApi error code indicates that the host API index specified by
- - the hostApi parameter is out of range.
- -
- - A paInvalidDevice error code indicates that the hostApiDeviceIndex parameter
- - is out of range.
- -
- - @see PaHostApiInfo
- -*/
- -PaDeviceIndex Pa_HostApiDeviceIndexToDeviceIndex( PaHostApiIndex hostApi,
- - int hostApiDeviceIndex );
- -
- -
- -
- -/** Structure used to return information about a host error condition.
- -*/
- -typedef struct PaHostErrorInfo{
- - PaHostApiTypeId hostApiType; /**< the host API which returned the error code */
- - long errorCode; /**< the error code returned */
- - const char *errorText; /**< a textual description of the error if available, otherwise a zero-length string */
- -}PaHostErrorInfo;
- -
- -
- -/** Return information about the last host error encountered. The error
- - information returned by Pa_GetLastHostErrorInfo() will never be modified
- - asyncronously by errors occurring in other PortAudio owned threads
- - (such as the thread that manages the stream callback.)
- -
- - This function is provided as a last resort, primarily to enhance debugging
- - by providing clients with access to all available error information.
- -
- - @return A pointer to an immutable structure constaining information about
- - the host error. The values in this structure will only be valid if a
- - PortAudio function has previously returned the paUnanticipatedHostError
- - error code.
- -*/
- -const PaHostErrorInfo* Pa_GetLastHostErrorInfo( void );
- -
- -
- -
- -/* Device enumeration and capabilities */
- -
- -/** Retrieve the number of available devices. The number of available devices
- - may be zero.
- -
- - @return A non-negative value indicating the number of available devices or,
- - a PaErrorCode (which are always negative) if PortAudio is not initialized
- - or an error is encountered.
- -*/
- -PaDeviceIndex Pa_GetDeviceCount( void );
- -
- -
- -/** Retrieve the index of the default input device. The result can be
- - used in the inputDevice parameter to Pa_OpenStream().
- -
- - @return The default input device index for the default host API, or paNoDevice
- - if no default input device is available or an error was encountered.
- -*/
- -PaDeviceIndex Pa_GetDefaultInputDevice( void );
- -
- -
- -/** Retrieve the index of the default output device. The result can be
- - used in the outputDevice parameter to Pa_OpenStream().
- -
- - @return The default output device index for the defualt host API, or paNoDevice
- - if no default output device is available or an error was encountered.
- -
- - @note
- - On the PC, the user can specify a default device by
- - setting an environment variable. For example, to use device #1.
- -<pre>
- - set PA_RECOMMENDED_OUTPUT_DEVICE=1
- -</pre>
- - The user should first determine the available device ids by using
- - the supplied application "pa_devs".
- -*/
- -PaDeviceIndex Pa_GetDefaultOutputDevice( void );
- -
- -
- -/** The type used to represent monotonic time in seconds that can be used
- - for syncronisation. The type is used for the outTime argument to the
- - PaStreamCallback and as the result of Pa_GetStreamTime().
- -
- - @see PaStreamCallback, Pa_GetStreamTime
- -*/
- -typedef double PaTime;
- -
- -
- -/** A type used to specify one or more sample formats. Each value indicates
- - a possible format for sound data passed to and from the stream callback,
- - Pa_ReadStream and Pa_WriteStream.
- -
- - The standard formats paFloat32, paInt16, paInt32, paInt24, paInt8
- - and aUInt8 are usually implemented by all implementations.
- -
- - The floating point representation (paFloat32) uses +1.0 and -1.0 as the
- - maximum and minimum respectively.
- -
- - paUInt8 is an unsigned 8 bit format where 128 is considered "ground"
- -
- - The paNonInterleaved flag indicates that a multichannel buffer is passed
- - as a set of non-interleaved pointers.
- -
- - @see Pa_OpenStream, Pa_OpenDefaultStream, PaDeviceInfo
- - @see paFloat32, paInt16, paInt32, paInt24, paInt8
- - @see paUInt8, paCustomFormat, paNonInterleaved
- -*/
- -typedef unsigned long PaSampleFormat;
- -
- -
- -#define paFloat32 ((PaSampleFormat) 0x00000001) /**< @see PaSampleFormat */
- -#define paInt32 ((PaSampleFormat) 0x00000002) /**< @see PaSampleFormat */
- -#define paInt24 ((PaSampleFormat) 0x00000004) /**< Packed 24 bit format. @see PaSampleFormat */
- -#define paInt16 ((PaSampleFormat) 0x00000008) /**< @see PaSampleFormat */
- -#define paInt8 ((PaSampleFormat) 0x00000010) /**< @see PaSampleFormat */
- -#define paUInt8 ((PaSampleFormat) 0x00000020) /**< @see PaSampleFormat */
- -#define paCustomFormat ((PaSampleFormat) 0x00010000)/**< @see PaSampleFormat */
- -
- -#define paNonInterleaved ((PaSampleFormat) 0x80000000)
- -
- -/** A structure providing information and capabilities of PortAudio devices.
- - Devices may support input, output or both input and output.
- -*/
- -typedef struct PaDeviceInfo
- -{
- - int structVersion; /* this is struct version 2 */
- - const char *name;
- - PaHostApiIndex hostApi; /* note this is a host API index, not a type id*/
- -
- - int maxInputChannels;
- - int maxOutputChannels;
- -
- - /* Default latency values for interactive performance. */
- - PaTime defaultLowInputLatency;
- - PaTime defaultLowOutputLatency;
- - /* Default latency values for robust non-interactive applications (eg. playing sound files). */
- - PaTime defaultHighInputLatency;
- - PaTime defaultHighOutputLatency;
- -
- - double defaultSampleRate;
- -} PaDeviceInfo;
- -
- -
- -/** Retrieve a pointer to a PaDeviceInfo structure containing information
- - about the specified device.
- - @return A pointer to an immutable PaDeviceInfo structure. If the device
- - parameter is out of range the function returns NULL.
- -
- - @param device A valid device index in the range 0 to (Pa_GetDeviceCount()-1)
- -
- - @note PortAudio manages the memory referenced by the returned pointer,
- - the client must not manipulate or free the memory. The pointer is only
- - guaranteed to be valid between calls to Pa_Initialize() and Pa_Terminate().
- -
- - @see PaDeviceInfo, PaDeviceIndex
- -*/
- -const PaDeviceInfo* Pa_GetDeviceInfo( PaDeviceIndex device );
- -
- -
- -/** Parameters for one direction (input or output) of a stream.
- -*/
- -typedef struct PaStreamParameters
- -{
- - /** A valid device index in the range 0 to (Pa_GetDeviceCount()-1)
- - specifying the device to be used or the special constant
- - paUseHostApiSpecificDeviceSpecification which indicates that the actual
- - device(s) to use are specified in hostApiSpecificStreamInfo.
- - This field must not be set to paNoDevice.
- - */
- - PaDeviceIndex device;
- -
- - /** The number of channels of sound to be delivered to the
- - stream callback or accessed by Pa_ReadStream() or Pa_WriteStream().
- - It can range from 1 to the value of maxInputChannels in the
- - PaDeviceInfo record for the device specified by the device parameter.
- - */
- - int channelCount;
- -
- - /** The sample format of the buffer provided to the stream callback,
- - a_ReadStream() or Pa_WriteStream(). It may be any of the formats described
- - by the PaSampleFormat enumeration.
- - */
- - PaSampleFormat sampleFormat;
- -
- - /** The desired latency in seconds. Where practical, implementations should
- - configure their latency based on these parameters, otherwise they may
- - choose the closest viable latency instead. Unless the suggested latency
- - is greater than the absolute upper limit for the device implementations
- - should round the suggestedLatency up to the next practial value - ie to
- - provide an equal or higher latency than suggestedLatency wherever possibe.
- - Actual latency values for an open stream may be retrieved using the
- - inputLatency and outputLatency fields of the PaStreamInfo structure
- - returned by Pa_GetStreamInfo().
- - @see default*Latency in PaDeviceInfo, *Latency in PaStreamInfo
- - */
- - PaTime suggestedLatency;
- -
- - /** An optional pointer to a host api specific data structure
- - containing additional information for device setup and/or stream processing.
- - hostApiSpecificStreamInfo is never required for correct operation,
- - if not used it should be set to NULL.
- - */
- - void *hostApiSpecificStreamInfo;
- -
- -} PaStreamParameters;
- -
- -
- -/** Return code for Pa_IsFormatSupported indicating success. */
- -#define paFormatIsSupported (0)
- -
- -/** Determine whether it would be possible to open a stream with the specified
- - parameters.
- -
- - @param inputParameters A structure that describes the input parameters used to
- - open a stream. The suggestedLatency field is ignored. See PaStreamParameters
- - for a description of these parameters. inputParameters must be NULL for
- - output-only streams.
- -
- - @param outputParameters A structure that describes the output parameters used
- - to open a stream. The suggestedLatency field is ignored. See PaStreamParameters
- - for a description of these parameters. outputParameters must be NULL for
- - input-only streams.
- -
- - @param sampleRate The required sampleRate. For full-duplex streams it is the
- - sample rate for both input and output
- -
- - @return Returns 0 if the format is supported, and an error code indicating why
- - the format is not supported otherwise. The constant paFormatIsSupported is
- - provided to compare with the return value for success.
- -
- - @see paFormatIsSupported, PaStreamParameters
- -*/
- -PaError Pa_IsFormatSupported( const PaStreamParameters *inputParameters,
- - const PaStreamParameters *outputParameters,
- - double sampleRate );
- -
- -
- -
- -/* Streaming types and functions */
- -
- -
- -/**
- - A single PaStream can provide multiple channels of real-time
- - streaming audio input and output to a client application. A stream
- - provides access to audio hardware represented by one or more
- - PaDevices. Depending on the underlying Host API, it may be possible
- - to open multiple streams using the same device, however this behavior
- - is implementation defined. Portable applications should assume that
- - a PaDevice may be simultaneously used by at most one PaStream.
- -
- - Pointers to PaStream objects are passed between PortAudio functions that
- - operate on streams.
- -
- - @see Pa_OpenStream, Pa_OpenDefaultStream, Pa_OpenDefaultStream, Pa_CloseStream,
- - Pa_StartStream, Pa_StopStream, Pa_AbortStream, Pa_IsStreamActive,
- - Pa_GetStreamTime, Pa_GetStreamCpuLoad
- -
- -*/
- -typedef void PaStream;
- -
- -
- -/** Can be passed as the framesPerBuffer parameter to Pa_OpenStream()
- - or Pa_OpenDefaultStream() to indicate that the stream callback will
- - accept buffers of any size.
- -*/
- -#define paFramesPerBufferUnspecified (0)
- -
- -
- -/** Flags used to control the behavior of a stream. They are passed as
- - parameters to Pa_OpenStream or Pa_OpenDefaultStream. Multiple flags may be
- - ORed together.
- -
- - @see Pa_OpenStream, Pa_OpenDefaultStream
- - @see paNoFlag, paClipOff, paDitherOff, paNeverDropInput,
- - paPrimeOutputBuffersUsingStreamCallback, paPlatformSpecificFlags
- -*/
- -typedef unsigned long PaStreamFlags;
- -
- -/** @see PaStreamFlags */
- -#define paNoFlag ((PaStreamFlags) 0)
- -
- -/** Disable default clipping of out of range samples.
- - @see PaStreamFlags
- -*/
- -#define paClipOff ((PaStreamFlags) 0x00000001)
- -
- -/** Disable default dithering.
- - @see PaStreamFlags
- -*/
- -#define paDitherOff ((PaStreamFlags) 0x00000002)
- -
- -/** Flag requests that where possible a full duplex stream will not discard
- - overflowed input samples without calling the stream callback. This flag is
- - only valid for full duplex callback streams and only when used in combination
- - with the paFramesPerBufferUnspecified (0) framesPerBuffer parameter. Using
- - this flag incorrectly results in a paInvalidFlag error being returned from
- - Pa_OpenStream and Pa_OpenDefaultStream.
- -
- - @see PaStreamFlags, paFramesPerBufferUnspecified
- -*/
- -#define paNeverDropInput ((PaStreamFlags) 0x00000004)
- -
- -/** Call the stream callback to fill initial output buffers, rather than the
- - default behavior of priming the buffers with zeros (silence). This flag has
- - no effect for input-only and blocking read/write streams.
- -
- - @see PaStreamFlags
- -*/
- -#define paPrimeOutputBuffersUsingStreamCallback ((PaStreamFlags) 0x00000008)
- -
- -/** A mask specifying the platform specific bits.
- - @see PaStreamFlags
- -*/
- -#define paPlatformSpecificFlags ((PaStreamFlags)0xFFFF0000)
- -
- -/**
- - Timing information for the buffers passed to the stream callback.
- -*/
- -typedef struct PaStreamCallbackTimeInfo{
- - PaTime inputBufferAdcTime;
- - PaTime currentTime;
- - PaTime outputBufferDacTime;
- -} PaStreamCallbackTimeInfo;
- -
- -
- -/**
- - Flag bit constants for the statusFlags to PaStreamCallback.
- -
- - @see paInputUnderflow, paInputOverflow, paOutputUnderflow, paOutputOverflow,
- - paPrimingOutput
- -*/
- -typedef unsigned long PaStreamCallbackFlags;
- -
- -/** In a stream opened with paFramesPerBufferUnspecified, indicates that
- - input data is all silence (zeros) because no real data is available. In a
- - stream opened without paFramesPerBufferUnspecified, it indicates that one or
- - more zero samples have been inserted into the input buffer to compensate
- - for an input underflow.
- - @see PaStreamCallbackFlags
- -*/
- -#define paInputUnderflow ((PaStreamCallbackFlags) 0x00000001)
- -
- -/** In a stream opened with paFramesPerBufferUnspecified, indicates that data
- - prior to the first sample of the input buffer was discarded due to an
- - overflow, possibly because the stream callback is using too much CPU time.
- - Otherwise indicates that data prior to one or more samples in the
- - input buffer was discarded.
- - @see PaStreamCallbackFlags
- -*/
- -#define paInputOverflow ((PaStreamCallbackFlags) 0x00000002)
- -
- -/** Indicates that output data (or a gap) was inserted, possibly because the
- - stream callback is using too much CPU time.
- - @see PaStreamCallbackFlags
- -*/
- -#define paOutputUnderflow ((PaStreamCallbackFlags) 0x00000004)
- -
- -/** Indicates that output data will be discarded because no room is available.
- - @see PaStreamCallbackFlags
- -*/
- -#define paOutputOverflow ((PaStreamCallbackFlags) 0x00000008)
- -
- -/** Some of all of the output data will be used to prime the stream, input
- - data may be zero.
- - @see PaStreamCallbackFlags
- -*/
- -#define paPrimingOutput ((PaStreamCallbackFlags) 0x00000010)
- -
- -/**
- - Allowable return values for the PaStreamCallback.
- - @see PaStreamCallback
- -*/
- -typedef enum PaStreamCallbackResult
- -{
- - paContinue=0,
- - paComplete=1,
- - paAbort=2
- -} PaStreamCallbackResult;
- -
- -
- -/**
- - Functions of type PaStreamCallback are implemented by PortAudio clients.
- - They consume, process or generate audio in response to requests from an
- - active PortAudio stream.
- -
- - @param input and @param output are arrays of interleaved samples,
- - the format, packing and number of channels used by the buffers are
- - determined by parameters to Pa_OpenStream().
- -
- - @param frameCount The number of sample frames to be processed by
- - the stream callback.
- -
- - @param timeInfo The time in seconds when the first sample of the input
- - buffer was received at the audio input, the time in seconds when the first
- - sample of the output buffer will begin being played at the audio output, and
- - the time in seconds when the stream callback was called.
- - See also Pa_GetStreamTime()
- -
- - @param statusFlags Flags indicating whether input and/or output buffers
- - have been inserted or will be dropped to overcome underflow or overflow
- - conditions.
- -
- - @param userData The value of a user supplied pointer passed to
- - Pa_OpenStream() intended for storing synthesis data etc.
- -
- - @return
- - The stream callback should return one of the values in the
- - PaStreamCallbackResult enumeration. To ensure that the callback continues
- - to be called, it should return paContinue (0). Either paComplete or paAbort
- - can be returned to finish stream processing, after either of these values is
- - returned the callback will not be called again. If paAbort is returned the
- - stream will finish as soon as possible. If paComplete is returned, the stream
- - will continue until all buffers generated by the callback have been played.
- - This may be useful in applications such as soundfile players where a specific
- - duration of output is required. However, it is not necessary to utilise this
- - mechanism as Pa_StopStream(), Pa_AbortStream() or Pa_CloseStream() can also
- - be used to stop the stream. The callback must always fill the entire output
- - buffer irrespective of its return value.
- -
- - @see Pa_OpenStream, Pa_OpenDefaultStream
- -
- - @note With the exception of Pa_GetStreamCpuLoad() it is not permissable to call
- - PortAudio API functions from within the stream callback.
- -*/
- -typedef int PaStreamCallback(
- - const void *input, void *output,
- - unsigned long frameCount,
- - const PaStreamCallbackTimeInfo* timeInfo,
- - PaStreamCallbackFlags statusFlags,
- - void *userData );
- -
- -
- -/** Opens a stream for either input, output or both.
- -
- - @param stream The address of a PaStream pointer which will receive
- - a pointer to the newly opened stream.
- -
- - @param inputParameters A structure that describes the input parameters used by
- - the opened stream. See PaStreamParameters for a description of these parameters.
- - inputParameters must be NULL for output-only streams.
- -
- - @param outputParameters A structure that describes the output parameters used by
- - the opened stream. See PaStreamParameters for a description of these parameters.
- - outputParameters must be NULL for input-only streams.
- -
- - @param sampleRate The desired sampleRate. For full-duplex streams it is the
- - sample rate for both input and output
- -
- - @param framesPerBuffer The number of frames passed to the stream callback
- - function, or the preferred block granularity for a blocking read/write stream.
- - The special value paFramesPerBufferUnspecified (0) may be used to request that
- - the stream callback will recieve an optimal (and possibly varying) number of
- - frames based on host requirements and the requested latency settings.
- - Note: With some host APIs, the use of non-zero framesPerBuffer for a callback
- - stream may introduce an additional layer of buffering which could introduce
- - additional latency. PortAudio guarantees that the additional latency
- - will be kept to the theoretical minimum however, it is strongly recommended
- - that a non-zero framesPerBuffer value only be used when your algorithm
- - requires a fixed number of frames per stream callback.
- -
- - @param streamFlags Flags which modify the behaviour of the streaming process.
- - This parameter may contain a combination of flags ORed together. Some flags may
- - only be relevant to certain buffer formats.
- -
- - @param streamCallback A pointer to a client supplied function that is responsible
- - for processing and filling input and output buffers. If this parameter is NULL
- - the stream will be opened in 'blocking read/write' mode. In blocking mode,
- - the client can receive sample data using Pa_ReadStream and write sample data
- - using Pa_WriteStream, the number of samples that may be read or written
- - without blocking is returned by Pa_GetStreamReadAvailable and
- - Pa_GetStreamWriteAvailable respectively.
- -
- - @param userData A client supplied pointer which is passed to the stream callback
- - function. It could for example, contain a pointer to instance data necessary
- - for processing the audio buffers. This parameter is ignored if streamCallback
- - is NULL.
- -
- - @return
- - Upon success Pa_OpenStream() returns paNoError and places a pointer to a
- - valid PaStream in the stream argument. The stream is inactive (stopped).
- - If a call to Pa_OpenStream() fails, a non-zero error code is returned (see
- - PaError for possible error codes) and the value of stream is invalid.
- -
- - @see PaStreamParameters, PaStreamCallback, Pa_ReadStream, Pa_WriteStream,
- - Pa_GetStreamReadAvailable, Pa_GetStreamWriteAvailable
- -*/
- -PaError Pa_OpenStream( PaStream** stream,
- - const PaStreamParameters *inputParameters,
- - const PaStreamParameters *outputParameters,
- - double sampleRate,
- - unsigned long framesPerBuffer,
- - PaStreamFlags streamFlags,
- - PaStreamCallback *streamCallback,
- - void *userData );
- -
- -
- -/** A simplified version of Pa_OpenStream() that opens the default input
- - and/or output devices.
- -
- - @param stream The address of a PaStream pointer which will receive
- - a pointer to the newly opened stream.
- -
- - @param numInputChannels The number of channels of sound that will be supplied
- - to the stream callback or returned by Pa_ReadStream. It can range from 1 to
- - the value of maxInputChannels in the PaDeviceInfo record for the default input
- - device. If 0 the stream is opened as an output-only stream.
- -
- - @param numOutputChannels The number of channels of sound to be delivered to the
- - stream callback or passed to Pa_WriteStream. It can range from 1 to the value
- - of maxOutputChannels in the PaDeviceInfo record for the default output dvice.
- - If 0 the stream is opened as an output-only stream.
- -
- - @param sampleFormat The sample format of both the input and output buffers
- - provided to the callback or passed to and from Pa_ReadStream and Pa_WriteStream.
- - sampleFormat may be any of the formats described by the PaSampleFormat
- - enumeration.
- -
- - @param sampleRate Same as Pa_OpenStream parameter of the same name.
- - @param framesPerBuffer Same as Pa_OpenStream parameter of the same name.
- - @param streamCallback Same as Pa_OpenStream parameter of the same name.
- - @param userData Same as Pa_OpenStream parameter of the same name.
- -
- - @return As for Pa_OpenStream
- -
- - @see Pa_OpenStream, PaStreamCallback
- -*/
- -PaError Pa_OpenDefaultStream( PaStream** stream,
- - int numInputChannels,
- - int numOutputChannels,
- - PaSampleFormat sampleFormat,
- - double sampleRate,
- - unsigned long framesPerBuffer,
- - PaStreamCallback *streamCallback,
- - void *userData );
- -
- -
- -/** Closes an audio stream. If the audio stream is active it
- - discards any pending buffers as if Pa_AbortStream() had been called.
- -*/
- -PaError Pa_CloseStream( PaStream *stream );
- -
- -
- -/** Functions of type PaStreamFinishedCallback are implemented by PortAudio
- - clients. They can be registered with a stream using the Pa_SetStreamFinishedCallback
- - function. Once registered they are called when the stream becomes inactive
- - (ie once a call to Pa_StopStream() will not block).
- - A stream will become inactive after the stream callback returns non-zero,
- - or when Pa_StopStream or Pa_AbortStream is called. For a stream providing audio
- - output, if the stream callback returns paComplete, or Pa_StopStream is called,
- - the stream finished callback will not be called until all generated sample data
- - has been played.
- -
- - @param userData The userData parameter supplied to Pa_OpenStream()
- -
- - @see Pa_SetStreamFinishedCallback
- -*/
- -typedef void PaStreamFinishedCallback( void *userData );
- -
- -
- -/** Register a stream finished callback function which will be called when the
- - stream becomes inactive. See the description of PaStreamFinishedCallback for
- - further details about when the callback will be called.
- -
- - @param stream a pointer to a PaStream that is in the stopped state - if the
- - stream is not stopped, the stream's finished callback will remain unchanged
- - and an error code will be returned.
- -
- - @param streamFinishedCallback a pointer to a function with the same signature
- - as PaStreamFinishedCallback, that will be called when the stream becomes
- - inactive. Passing NULL for this parameter will un-register a previously
- - registered stream finished callback function.
- -
- - @return on success returns paNoError, otherwise an error code indicating the cause
- - of the error.
- -
- - @see PaStreamFinishedCallback
- -*/
- -PaError Pa_SetStreamFinishedCallback( PaStream *stream, PaStreamFinishedCallback* streamFinishedCallback );
- -
- -
- -/** Commences audio processing.
- -*/
- -PaError Pa_StartStream( PaStream *stream );
- -
- -
- -/** Terminates audio processing. It waits until all pending
- - audio buffers have been played before it returns.
- -*/
- -PaError Pa_StopStream( PaStream *stream );
- -
- -
- -/** Terminates audio processing immediately without waiting for pending
- - buffers to complete.
- -*/
- -PaError Pa_AbortStream( PaStream *stream );
- -
- -
- -/** Determine whether the stream is stopped.
- - A stream is considered to be stopped prior to a successful call to
- - Pa_StartStream and after a successful call to Pa_StopStream or Pa_AbortStream.
- - If a stream callback returns a value other than paContinue the stream is NOT
- - considered to be stopped.
- -
- - @return Returns one (1) when the stream is stopped, zero (0) when
- - the stream is running or, a PaErrorCode (which are always negative) if
- - PortAudio is not initialized or an error is encountered.
- -
- - @see Pa_StopStream, Pa_AbortStream, Pa_IsStreamActive
- -*/
- -PaError Pa_IsStreamStopped( PaStream *stream );
- -
- -
- -/** Determine whether the stream is active.
- - A stream is active after a successful call to Pa_StartStream(), until it
- - becomes inactive either as a result of a call to Pa_StopStream() or
- - Pa_AbortStream(), or as a result of a return value other than paContinue from
- - the stream callback. In the latter case, the stream is considered inactive
- - after the last buffer has finished playing.
- -
- - @return Returns one (1) when the stream is active (ie playing or recording
- - audio), zero (0) when not playing or, a PaErrorCode (which are always negative)
- - if PortAudio is not initialized or an error is encountered.
- -
- - @see Pa_StopStream, Pa_AbortStream, Pa_IsStreamStopped
- -*/
- -PaError Pa_IsStreamActive( PaStream *stream );
- -
- -
- -
- -/** A structure containing unchanging information about an open stream.
- - @see Pa_GetStreamInfo
- -*/
- -
- -typedef struct PaStreamInfo
- -{
- - /** this is struct version 1 */
- - int structVersion;
- -
- - /** The input latency of the stream in seconds. This value provides the most
- - accurate estimate of input latency available to the implementation. It may
- - differ significantly from the suggestedLatency value passed to Pa_OpenStream().
- - The value of this field will be zero (0.) for output-only streams.
- - @see PaTime
- - */
- - PaTime inputLatency;
- -
- - /** The output latency of the stream in seconds. This value provides the most
- - accurate estimate of output latency available to the implementation. It may
- - differ significantly from the suggestedLatency value passed to Pa_OpenStream().
- - The value of this field will be zero (0.) for input-only streams.
- - @see PaTime
- - */
- - PaTime outputLatency;
- -
- - /** The sample rate of the stream in Hertz (samples per second). In cases
- - where the hardware sample rate is inaccurate and PortAudio is aware of it,
- - the value of this field may be different from the sampleRate parameter
- - passed to Pa_OpenStream(). If information about the actual hardware sample
- - rate is not available, this field will have the same value as the sampleRate
- - parameter passed to Pa_OpenStream().
- - */
- - double sampleRate;
- -
- -} PaStreamInfo;
- -
- -
- -/** Retrieve a pointer to a PaStreamInfo structure containing information
- - about the specified stream.
- - @return A pointer to an immutable PaStreamInfo structure. If the stream
- - parameter invalid, or an error is encountered, the function returns NULL.
- -
- - @param stream A pointer to an open stream previously created with Pa_OpenStream.
- -
- - @note PortAudio manages the memory referenced by the returned pointer,
- - the client must not manipulate or free the memory. The pointer is only
- - guaranteed to be valid until the specified stream is closed.
- -
- - @see PaStreamInfo
- -*/
- -const PaStreamInfo* Pa_GetStreamInfo( PaStream *stream );
- -
- -
- -/** Determine the current time for the stream according to the same clock used
- - to generate buffer timestamps. This time may be used for syncronising other
- - events to the audio stream, for example synchronizing audio to MIDI.
- -
- - @return The stream's current time in seconds, or 0 if an error occurred.
- -
- - @see PaTime, PaStreamCallback
- -*/
- -PaTime Pa_GetStreamTime( PaStream *stream );
- -
- -
- -/** Retrieve CPU usage information for the specified stream.
- - The "CPU Load" is a fraction of total CPU time consumed by a callback stream's
- - audio processing routines including, but not limited to the client supplied
- - stream callback. This function does not work with blocking read/write streams.
- -
- - This function may be called from the stream callback function or the
- - application.
- -
- - @return
- - A floating point value, typically between 0.0 and 1.0, where 1.0 indicates
- - that the stream callback is consuming the maximum number of CPU cycles possible
- - to maintain real-time operation. A value of 0.5 would imply that PortAudio and
- - the stream callback was consuming roughly 50% of the available CPU time. The
- - return value may exceed 1.0. A value of 0.0 will always be returned for a
- - blocking read/write stream, or if an error occurrs.
- -*/
- -double Pa_GetStreamCpuLoad( PaStream* stream );
- -
- -
- -/** Read samples from an input stream. The function doesn't return until
- - the entire buffer has been filled - this may involve waiting for the operating
- - system to supply the data.
- -
- - @param stream A pointer to an open stream previously created with Pa_OpenStream.
- -
- - @param buffer A pointer to a buffer of sample frames. The buffer contains
- - samples in the format specified by the inputParameters->sampleFormat field
- - used to open the stream, and the number of channels specified by
- - inputParameters->numChannels. If non-interleaved samples were requested,
- - buffer is a pointer to the first element of an array of non-interleaved
- - buffer pointers, one for each channel.
- -
- - @param frames The number of frames to be read into buffer. This parameter
- - is not constrained to a specific range, however high performance applications
- - will want to match this parameter to the framesPerBuffer parameter used
- - when opening the stream.
- -
- - @return On success PaNoError will be returned, or PaInputOverflowed if input
- - data was discarded by PortAudio after the previous call and before this call.
- -*/
- -PaError Pa_ReadStream( PaStream* stream,
- - void *buffer,
- - unsigned long frames );
- -
- -
- -/** Write samples to an output stream. This function doesn't return until the
- - entire buffer has been consumed - this may involve waiting for the operating
- - system to consume the data.
- -
- - @param stream A pointer to an open stream previously created with Pa_OpenStream.
- -
- - @param buffer A pointer to a buffer of sample frames. The buffer contains
- - samples in the format specified by the outputParameters->sampleFormat field
- - used to open the stream, and the number of channels specified by
- - outputParameters->numChannels. If non-interleaved samples were requested,
- - buffer is a pointer to the first element of an array of non-interleaved
- - buffer pointers, one for each channel.
- -
- - @param frames The number of frames to be written from buffer. This parameter
- - is not constrained to a specific range, however high performance applications
- - will want to match this parameter to the framesPerBuffer parameter used
- - when opening the stream.
- -
- - @return On success PaNoError will be returned, or paOutputUnderflowed if
- - additional output data was inserted after the previous call and before this
- - call.
- -*/
- -PaError Pa_WriteStream( PaStream* stream,
- - const void *buffer,
- - unsigned long frames );
- -
- -
- -/** Retrieve the number of frames that can be read from the stream without
- - waiting.
- -
- - @return Returns a non-negative value representing the maximum number of frames
- - that can be read from the stream without blocking or busy waiting or, a
- - PaErrorCode (which are always negative) if PortAudio is not initialized or an
- - error is encountered.
- -*/
- -signed long Pa_GetStreamReadAvailable( PaStream* stream );
- -
- -
- -/** Retrieve the number of frames that can be written to the stream without
- - waiting.
- -
- - @return Returns a non-negative value representing the maximum number of frames
- - that can be written to the stream without blocking or busy waiting or, a
- - PaErrorCode (which are always negative) if PortAudio is not initialized or an
- - error is encountered.
- -*/
- -signed long Pa_GetStreamWriteAvailable( PaStream* stream );
- -
- -
- -/* Miscellaneous utilities */
- -
- -
- -/** Retrieve the size of a given sample format in bytes.
- -
- - @return The size in bytes of a single sample in the specified format,
- - or paSampleFormatNotSupported if the format is not supported.
- -*/
- -PaError Pa_GetSampleSize( PaSampleFormat format );
- -
- -
- -/** Put the caller to sleep for at least 'msec' milliseconds. This function is
- - provided only as a convenience for authors of portable code (such as the tests
- - and examples in the PortAudio distribution.)
- -
- - The function may sleep longer than requested so don't rely on this for accurate
- - musical timing.
- -*/
- -void Pa_Sleep( long msec );
- -
- -
- -
- -#ifdef __cplusplus
- -}
- -#endif /* __cplusplus */
- -#endif /* PORTAUDIO_H */
- --- a/src/wave.cpp
- +++ b/src/wave.cpp
- @@ -31,7 +31,10 @@
- #include <sys/time.h>
- #include <time.h>
-
- -#include "portaudio.h"
- +#ifdef USE_PORTAUDIO
- +#include <portaudio.h>
- +#endif
- +
- #ifdef PLATFORM_WINDOWS
- #include <windows.h>
- #else
- --- a/src/wavegen.cpp
- +++ b/src/wavegen.cpp
- @@ -40,7 +40,7 @@
- #endif
-
- #ifdef USE_PORTAUDIO
- -#include "portaudio.h"
- +#include <portaudio.h>
- #undef USE_PORTAUDIO
- // determine portaudio version by looking for a #define which is not in V18
- #ifdef paNeverDropInput
|