cannam@116: #ifndef PORTAUDIO_H cannam@116: #define PORTAUDIO_H cannam@116: /* cannam@141: * $Id$ cannam@116: * PortAudio Portable Real-Time Audio Library cannam@116: * PortAudio API Header File cannam@116: * Latest version available at: http://www.portaudio.com/ cannam@116: * cannam@116: * Copyright (c) 1999-2002 Ross Bencina and Phil Burk cannam@116: * cannam@116: * Permission is hereby granted, free of charge, to any person obtaining cannam@116: * a copy of this software and associated documentation files cannam@116: * (the "Software"), to deal in the Software without restriction, cannam@116: * including without limitation the rights to use, copy, modify, merge, cannam@116: * publish, distribute, sublicense, and/or sell copies of the Software, cannam@116: * and to permit persons to whom the Software is furnished to do so, cannam@116: * subject to the following conditions: cannam@116: * cannam@116: * The above copyright notice and this permission notice shall be cannam@116: * included in all copies or substantial portions of the Software. cannam@116: * cannam@116: * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, cannam@116: * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF cannam@116: * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. cannam@116: * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR cannam@116: * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF cannam@116: * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION cannam@116: * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. cannam@116: */ cannam@116: cannam@116: /* cannam@116: * The text above constitutes the entire PortAudio license; however, cannam@116: * the PortAudio community also makes the following non-binding requests: cannam@116: * cannam@116: * Any person wishing to distribute modifications to the Software is cannam@116: * requested to send the modifications to the original developer so that cannam@116: * they can be incorporated into the canonical version. It is also cannam@116: * requested that these non-binding requests be included along with the cannam@116: * license above. cannam@116: */ cannam@116: cannam@116: /** @file cannam@116: @ingroup public_header cannam@116: @brief The portable PortAudio API. cannam@116: */ cannam@116: cannam@116: cannam@116: #ifdef __cplusplus cannam@116: extern "C" cannam@116: { cannam@116: #endif /* __cplusplus */ cannam@116: cannam@141: /** Retrieve the release number of the currently running PortAudio build. cannam@141: For example, for version "19.5.1" this will return 0x00130501. cannam@141: cannam@141: @see paMakeVersionNumber cannam@116: */ cannam@116: int Pa_GetVersion( void ); cannam@116: cannam@141: /** Retrieve a textual description of the current PortAudio build, cannam@141: e.g. "PortAudio V19.5.0-devel, revision 1952M". cannam@141: The format of the text may change in the future. Do not try to parse the cannam@141: returned string. cannam@116: cannam@141: @deprecated As of 19.5.0, use Pa_GetVersionInfo()->versionText instead. cannam@116: */ cannam@116: const char* Pa_GetVersionText( void ); cannam@116: cannam@141: /** cannam@141: Generate a packed integer version number in the same format used cannam@141: by Pa_GetVersion(). Use this to compare a specified version number with cannam@141: the currently running version. For example: cannam@141: cannam@141: @code cannam@141: if( Pa_GetVersion() < paMakeVersionNumber(19,5,1) ) {} cannam@141: @endcode cannam@141: cannam@141: @see Pa_GetVersion, Pa_GetVersionInfo cannam@141: @version Available as of 19.5.0. cannam@141: */ cannam@141: #define paMakeVersionNumber(major, minor, subminor) \ cannam@141: (((major)&0xFF)<<16 | ((minor)&0xFF)<<8 | ((subminor)&0xFF)) cannam@141: cannam@141: cannam@141: /** cannam@141: A structure containing PortAudio API version information. cannam@141: @see Pa_GetVersionInfo, paMakeVersionNumber cannam@141: @version Available as of 19.5.0. cannam@141: */ cannam@141: typedef struct PaVersionInfo { cannam@141: int versionMajor; cannam@141: int versionMinor; cannam@141: int versionSubMinor; cannam@141: /** cannam@141: This is currently the Git revision hash but may change in the future. cannam@141: The versionControlRevision is updated by running a script before compiling the library. cannam@141: If the update does not occur, this value may refer to an earlier revision. cannam@141: */ cannam@141: const char *versionControlRevision; cannam@141: /** Version as a string, for example "PortAudio V19.5.0-devel, revision 1952M" */ cannam@141: const char *versionText; cannam@141: } PaVersionInfo; cannam@141: cannam@141: /** Retrieve version information for the currently running PortAudio build. cannam@141: @return A pointer to an immutable PaVersionInfo structure. cannam@141: cannam@141: @note This function can be called at any time. It does not require PortAudio cannam@141: to be initialized. The structure pointed to is statically allocated. Do not cannam@141: attempt to free it or modify it. cannam@141: cannam@141: @see PaVersionInfo, paMakeVersionNumber cannam@141: @version Available as of 19.5.0. cannam@141: */ cannam@141: const PaVersionInfo* Pa_GetVersionInfo(); cannam@141: cannam@116: cannam@116: /** Error codes returned by PortAudio functions. cannam@116: Note that with the exception of paNoError, all PaErrorCodes are negative. cannam@116: */ cannam@116: cannam@116: typedef int PaError; cannam@116: typedef enum PaErrorCode cannam@116: { cannam@116: paNoError = 0, cannam@116: cannam@116: paNotInitialized = -10000, cannam@116: paUnanticipatedHostError, cannam@116: paInvalidChannelCount, cannam@116: paInvalidSampleRate, cannam@116: paInvalidDevice, cannam@116: paInvalidFlag, cannam@116: paSampleFormatNotSupported, cannam@116: paBadIODeviceCombination, cannam@116: paInsufficientMemory, cannam@116: paBufferTooBig, cannam@116: paBufferTooSmall, cannam@116: paNullCallback, cannam@116: paBadStreamPtr, cannam@116: paTimedOut, cannam@116: paInternalError, cannam@116: paDeviceUnavailable, cannam@116: paIncompatibleHostApiSpecificStreamInfo, cannam@116: paStreamIsStopped, cannam@116: paStreamIsNotStopped, cannam@116: paInputOverflowed, cannam@116: paOutputUnderflowed, cannam@116: paHostApiNotFound, cannam@116: paInvalidHostApi, cannam@116: paCanNotReadFromACallbackStream, cannam@116: paCanNotWriteToACallbackStream, cannam@116: paCanNotReadFromAnOutputOnlyStream, cannam@116: paCanNotWriteToAnInputOnlyStream, cannam@116: paIncompatibleStreamHostApi, cannam@116: paBadBufferPtr cannam@116: } PaErrorCode; cannam@116: cannam@116: cannam@116: /** Translate the supplied PortAudio error code into a human readable cannam@116: message. cannam@116: */ cannam@116: const char *Pa_GetErrorText( PaError errorCode ); cannam@116: cannam@116: cannam@116: /** Library initialization function - call this before using PortAudio. cannam@116: This function initializes internal data structures and prepares underlying cannam@116: host APIs for use. With the exception of Pa_GetVersion(), Pa_GetVersionText(), cannam@116: and Pa_GetErrorText(), this function MUST be called before using any other cannam@116: PortAudio API functions. cannam@116: cannam@116: If Pa_Initialize() is called multiple times, each successful cannam@116: call must be matched with a corresponding call to Pa_Terminate(). cannam@116: Pairs of calls to Pa_Initialize()/Pa_Terminate() may overlap, and are not cannam@116: required to be fully nested. cannam@116: cannam@116: Note that if Pa_Initialize() returns an error code, Pa_Terminate() should cannam@116: NOT be called. cannam@116: cannam@116: @return paNoError if successful, otherwise an error code indicating the cause cannam@116: of failure. cannam@116: cannam@116: @see Pa_Terminate cannam@116: */ cannam@116: PaError Pa_Initialize( void ); cannam@116: cannam@116: cannam@116: /** Library termination function - call this when finished using PortAudio. cannam@116: This function deallocates all resources allocated by PortAudio since it was cannam@116: initialized by a call to Pa_Initialize(). In cases where Pa_Initialise() has cannam@116: been called multiple times, each call must be matched with a corresponding call cannam@116: to Pa_Terminate(). The final matching call to Pa_Terminate() will automatically cannam@116: close any PortAudio streams that are still open. cannam@116: cannam@116: Pa_Terminate() MUST be called before exiting a program which uses PortAudio. cannam@116: Failure to do so may result in serious resource leaks, such as audio devices cannam@116: not being available until the next reboot. cannam@116: cannam@116: @return paNoError if successful, otherwise an error code indicating the cause cannam@116: of failure. cannam@116: cannam@116: @see Pa_Initialize cannam@116: */ cannam@116: PaError Pa_Terminate( void ); cannam@116: cannam@116: cannam@116: cannam@116: /** The type used to refer to audio devices. Values of this type usually cannam@116: range from 0 to (Pa_GetDeviceCount()-1), and may also take on the PaNoDevice cannam@116: and paUseHostApiSpecificDeviceSpecification values. cannam@116: cannam@116: @see Pa_GetDeviceCount, paNoDevice, paUseHostApiSpecificDeviceSpecification cannam@116: */ cannam@116: typedef int PaDeviceIndex; cannam@116: cannam@116: cannam@116: /** A special PaDeviceIndex value indicating that no device is available, cannam@116: or should be used. cannam@116: cannam@116: @see PaDeviceIndex cannam@116: */ cannam@116: #define paNoDevice ((PaDeviceIndex)-1) cannam@116: cannam@116: cannam@116: /** A special PaDeviceIndex value indicating that the device(s) to be used cannam@116: are specified in the host api specific stream info structure. cannam@116: cannam@116: @see PaDeviceIndex cannam@116: */ cannam@116: #define paUseHostApiSpecificDeviceSpecification ((PaDeviceIndex)-2) cannam@116: cannam@116: cannam@116: /* Host API enumeration mechanism */ cannam@116: cannam@116: /** The type used to enumerate to host APIs at runtime. Values of this type cannam@116: range from 0 to (Pa_GetHostApiCount()-1). cannam@116: cannam@116: @see Pa_GetHostApiCount cannam@116: */ cannam@116: typedef int PaHostApiIndex; cannam@116: cannam@116: cannam@116: /** Retrieve the number of available host APIs. Even if a host API is cannam@116: available it may have no devices available. cannam@116: cannam@116: @return A non-negative value indicating the number of available host APIs cannam@116: or, a PaErrorCode (which are always negative) if PortAudio is not initialized cannam@116: or an error is encountered. cannam@116: cannam@116: @see PaHostApiIndex cannam@116: */ cannam@116: PaHostApiIndex Pa_GetHostApiCount( void ); cannam@116: cannam@116: cannam@116: /** Retrieve the index of the default host API. The default host API will be cannam@116: the lowest common denominator host API on the current platform and is cannam@116: unlikely to provide the best performance. cannam@116: cannam@116: @return A non-negative value ranging from 0 to (Pa_GetHostApiCount()-1) cannam@116: indicating the default host API index or, a PaErrorCode (which are always cannam@116: negative) if PortAudio is not initialized or an error is encountered. cannam@116: */ cannam@116: PaHostApiIndex Pa_GetDefaultHostApi( void ); cannam@116: cannam@116: cannam@116: /** Unchanging unique identifiers for each supported host API. This type cannam@116: is used in the PaHostApiInfo structure. The values are guaranteed to be cannam@116: unique and to never change, thus allowing code to be written that cannam@116: conditionally uses host API specific extensions. cannam@116: cannam@116: New type ids will be allocated when support for a host API reaches cannam@116: "public alpha" status, prior to that developers should use the cannam@116: paInDevelopment type id. cannam@116: cannam@116: @see PaHostApiInfo cannam@116: */ cannam@116: typedef enum PaHostApiTypeId cannam@116: { cannam@116: paInDevelopment=0, /* use while developing support for a new host API */ cannam@116: paDirectSound=1, cannam@116: paMME=2, cannam@116: paASIO=3, cannam@116: paSoundManager=4, cannam@116: paCoreAudio=5, cannam@116: paOSS=7, cannam@116: paALSA=8, cannam@116: paAL=9, cannam@116: paBeOS=10, cannam@116: paWDMKS=11, cannam@116: paJACK=12, cannam@116: paWASAPI=13, cannam@116: paAudioScienceHPI=14 cannam@116: } PaHostApiTypeId; cannam@116: cannam@116: cannam@116: /** A structure containing information about a particular host API. */ cannam@116: cannam@116: typedef struct PaHostApiInfo cannam@116: { cannam@116: /** this is struct version 1 */ cannam@116: int structVersion; cannam@116: /** The well known unique identifier of this host API @see PaHostApiTypeId */ cannam@116: PaHostApiTypeId type; cannam@116: /** A textual description of the host API for display on user interfaces. */ cannam@116: const char *name; cannam@116: cannam@116: /** The number of devices belonging to this host API. This field may be cannam@116: used in conjunction with Pa_HostApiDeviceIndexToDeviceIndex() to enumerate cannam@116: all devices for this host API. cannam@116: @see Pa_HostApiDeviceIndexToDeviceIndex cannam@116: */ cannam@116: int deviceCount; cannam@116: cannam@116: /** The default input device for this host API. The value will be a cannam@116: device index ranging from 0 to (Pa_GetDeviceCount()-1), or paNoDevice cannam@116: if no default input device is available. cannam@116: */ cannam@116: PaDeviceIndex defaultInputDevice; cannam@116: cannam@116: /** The default output device for this host API. The value will be a cannam@116: device index ranging from 0 to (Pa_GetDeviceCount()-1), or paNoDevice cannam@116: if no default output device is available. cannam@116: */ cannam@116: PaDeviceIndex defaultOutputDevice; cannam@116: cannam@116: } PaHostApiInfo; cannam@116: cannam@116: cannam@116: /** Retrieve a pointer to a structure containing information about a specific cannam@116: host Api. cannam@116: cannam@116: @param hostApi A valid host API index ranging from 0 to (Pa_GetHostApiCount()-1) cannam@116: cannam@116: @return A pointer to an immutable PaHostApiInfo structure describing cannam@116: a specific host API. If the hostApi parameter is out of range or an error cannam@116: is encountered, the function returns NULL. cannam@116: cannam@116: The returned structure is owned by the PortAudio implementation and must not cannam@116: be manipulated or freed. The pointer is only guaranteed to be valid between cannam@116: calls to Pa_Initialize() and Pa_Terminate(). cannam@116: */ cannam@116: const PaHostApiInfo * Pa_GetHostApiInfo( PaHostApiIndex hostApi ); cannam@116: cannam@116: cannam@116: /** Convert a static host API unique identifier, into a runtime cannam@116: host API index. cannam@116: cannam@116: @param type A unique host API identifier belonging to the PaHostApiTypeId cannam@116: enumeration. cannam@116: cannam@116: @return A valid PaHostApiIndex ranging from 0 to (Pa_GetHostApiCount()-1) or, cannam@116: a PaErrorCode (which are always negative) if PortAudio is not initialized cannam@116: or an error is encountered. cannam@116: cannam@116: The paHostApiNotFound error code indicates that the host API specified by the cannam@116: type parameter is not available. cannam@116: cannam@116: @see PaHostApiTypeId cannam@116: */ cannam@116: PaHostApiIndex Pa_HostApiTypeIdToHostApiIndex( PaHostApiTypeId type ); cannam@116: cannam@116: cannam@116: /** Convert a host-API-specific device index to standard PortAudio device index. cannam@116: This function may be used in conjunction with the deviceCount field of cannam@116: PaHostApiInfo to enumerate all devices for the specified host API. cannam@116: cannam@116: @param hostApi A valid host API index ranging from 0 to (Pa_GetHostApiCount()-1) cannam@116: cannam@116: @param hostApiDeviceIndex A valid per-host device index in the range cannam@116: 0 to (Pa_GetHostApiInfo(hostApi)->deviceCount-1) cannam@116: cannam@116: @return A non-negative PaDeviceIndex ranging from 0 to (Pa_GetDeviceCount()-1) cannam@116: or, a PaErrorCode (which are always negative) if PortAudio is not initialized cannam@116: or an error is encountered. cannam@116: cannam@116: A paInvalidHostApi error code indicates that the host API index specified by cannam@116: the hostApi parameter is out of range. cannam@116: cannam@116: A paInvalidDevice error code indicates that the hostApiDeviceIndex parameter cannam@116: is out of range. cannam@116: cannam@116: @see PaHostApiInfo cannam@116: */ cannam@116: PaDeviceIndex Pa_HostApiDeviceIndexToDeviceIndex( PaHostApiIndex hostApi, cannam@116: int hostApiDeviceIndex ); cannam@116: cannam@116: cannam@116: cannam@116: /** Structure used to return information about a host error condition. cannam@116: */ cannam@116: typedef struct PaHostErrorInfo{ cannam@116: PaHostApiTypeId hostApiType; /**< the host API which returned the error code */ cannam@116: long errorCode; /**< the error code returned */ cannam@116: const char *errorText; /**< a textual description of the error if available, otherwise a zero-length string */ cannam@116: }PaHostErrorInfo; cannam@116: cannam@116: cannam@116: /** Return information about the last host error encountered. The error cannam@116: information returned by Pa_GetLastHostErrorInfo() will never be modified cannam@116: asynchronously by errors occurring in other PortAudio owned threads cannam@116: (such as the thread that manages the stream callback.) cannam@116: cannam@116: This function is provided as a last resort, primarily to enhance debugging cannam@116: by providing clients with access to all available error information. cannam@116: cannam@116: @return A pointer to an immutable structure constraining information about cannam@116: the host error. The values in this structure will only be valid if a cannam@116: PortAudio function has previously returned the paUnanticipatedHostError cannam@116: error code. cannam@116: */ cannam@116: const PaHostErrorInfo* Pa_GetLastHostErrorInfo( void ); cannam@116: cannam@116: cannam@116: cannam@116: /* Device enumeration and capabilities */ cannam@116: cannam@116: /** Retrieve the number of available devices. The number of available devices cannam@116: may be zero. cannam@116: cannam@116: @return A non-negative value indicating the number of available devices or, cannam@116: a PaErrorCode (which are always negative) if PortAudio is not initialized cannam@116: or an error is encountered. cannam@116: */ cannam@116: PaDeviceIndex Pa_GetDeviceCount( void ); cannam@116: cannam@116: cannam@116: /** Retrieve the index of the default input device. The result can be cannam@116: used in the inputDevice parameter to Pa_OpenStream(). cannam@116: cannam@116: @return The default input device index for the default host API, or paNoDevice cannam@116: if no default input device is available or an error was encountered. cannam@116: */ cannam@116: PaDeviceIndex Pa_GetDefaultInputDevice( void ); cannam@116: cannam@116: cannam@116: /** Retrieve the index of the default output device. The result can be cannam@116: used in the outputDevice parameter to Pa_OpenStream(). cannam@116: cannam@116: @return The default output device index for the default host API, or paNoDevice cannam@116: if no default output device is available or an error was encountered. cannam@116: cannam@116: @note cannam@116: On the PC, the user can specify a default device by cannam@116: setting an environment variable. For example, to use device #1. cannam@116: 
cannam@116:  set PA_RECOMMENDED_OUTPUT_DEVICE=1
cannam@116:
cannam@116: The user should first determine the available device ids by using cannam@116: the supplied application "pa_devs". cannam@116: */ cannam@116: PaDeviceIndex Pa_GetDefaultOutputDevice( void ); cannam@116: cannam@116: cannam@116: /** The type used to represent monotonic time in seconds. PaTime is cannam@116: used for the fields of the PaStreamCallbackTimeInfo argument to the cannam@116: PaStreamCallback and as the result of Pa_GetStreamTime(). cannam@116: cannam@116: PaTime values have unspecified origin. cannam@116: cannam@116: @see PaStreamCallback, PaStreamCallbackTimeInfo, Pa_GetStreamTime cannam@116: */ cannam@116: typedef double PaTime; cannam@116: cannam@116: cannam@116: /** A type used to specify one or more sample formats. Each value indicates cannam@116: a possible format for sound data passed to and from the stream callback, cannam@116: Pa_ReadStream and Pa_WriteStream. cannam@116: cannam@116: The standard formats paFloat32, paInt16, paInt32, paInt24, paInt8 cannam@116: and aUInt8 are usually implemented by all implementations. cannam@116: cannam@116: The floating point representation (paFloat32) uses +1.0 and -1.0 as the cannam@116: maximum and minimum respectively. cannam@116: cannam@116: paUInt8 is an unsigned 8 bit format where 128 is considered "ground" cannam@116: cannam@116: The paNonInterleaved flag indicates that audio data is passed as an array cannam@116: of pointers to separate buffers, one buffer for each channel. Usually, cannam@116: when this flag is not used, audio data is passed as a single buffer with cannam@116: all channels interleaved. cannam@116: cannam@116: @see Pa_OpenStream, Pa_OpenDefaultStream, PaDeviceInfo cannam@116: @see paFloat32, paInt16, paInt32, paInt24, paInt8 cannam@116: @see paUInt8, paCustomFormat, paNonInterleaved cannam@116: */ cannam@116: typedef unsigned long PaSampleFormat; cannam@116: cannam@116: cannam@116: #define paFloat32 ((PaSampleFormat) 0x00000001) /**< @see PaSampleFormat */ cannam@116: #define paInt32 ((PaSampleFormat) 0x00000002) /**< @see PaSampleFormat */ cannam@116: #define paInt24 ((PaSampleFormat) 0x00000004) /**< Packed 24 bit format. @see PaSampleFormat */ cannam@116: #define paInt16 ((PaSampleFormat) 0x00000008) /**< @see PaSampleFormat */ cannam@116: #define paInt8 ((PaSampleFormat) 0x00000010) /**< @see PaSampleFormat */ cannam@116: #define paUInt8 ((PaSampleFormat) 0x00000020) /**< @see PaSampleFormat */ cannam@116: #define paCustomFormat ((PaSampleFormat) 0x00010000) /**< @see PaSampleFormat */ cannam@116: cannam@116: #define paNonInterleaved ((PaSampleFormat) 0x80000000) /**< @see PaSampleFormat */ cannam@116: cannam@116: /** A structure providing information and capabilities of PortAudio devices. cannam@116: Devices may support input, output or both input and output. cannam@116: */ cannam@116: typedef struct PaDeviceInfo cannam@116: { cannam@116: int structVersion; /* this is struct version 2 */ cannam@116: const char *name; cannam@141: PaHostApiIndex hostApi; /**< note this is a host API index, not a type id*/ cannam@116: cannam@116: int maxInputChannels; cannam@116: int maxOutputChannels; cannam@116: cannam@141: /** Default latency values for interactive performance. */ cannam@116: PaTime defaultLowInputLatency; cannam@116: PaTime defaultLowOutputLatency; cannam@141: /** Default latency values for robust non-interactive applications (eg. playing sound files). */ cannam@116: PaTime defaultHighInputLatency; cannam@116: PaTime defaultHighOutputLatency; cannam@116: cannam@116: double defaultSampleRate; cannam@116: } PaDeviceInfo; cannam@116: cannam@116: cannam@116: /** Retrieve a pointer to a PaDeviceInfo structure containing information cannam@116: about the specified device. cannam@116: @return A pointer to an immutable PaDeviceInfo structure. If the device cannam@116: parameter is out of range the function returns NULL. cannam@116: cannam@116: @param device A valid device index in the range 0 to (Pa_GetDeviceCount()-1) cannam@116: cannam@116: @note PortAudio manages the memory referenced by the returned pointer, cannam@116: the client must not manipulate or free the memory. The pointer is only cannam@116: guaranteed to be valid between calls to Pa_Initialize() and Pa_Terminate(). cannam@116: cannam@116: @see PaDeviceInfo, PaDeviceIndex cannam@116: */ cannam@116: const PaDeviceInfo* Pa_GetDeviceInfo( PaDeviceIndex device ); cannam@116: cannam@116: cannam@116: /** Parameters for one direction (input or output) of a stream. cannam@116: */ cannam@116: typedef struct PaStreamParameters cannam@116: { cannam@116: /** A valid device index in the range 0 to (Pa_GetDeviceCount()-1) cannam@116: specifying the device to be used or the special constant cannam@116: paUseHostApiSpecificDeviceSpecification which indicates that the actual cannam@116: device(s) to use are specified in hostApiSpecificStreamInfo. cannam@116: This field must not be set to paNoDevice. cannam@116: */ cannam@116: PaDeviceIndex device; cannam@116: cannam@116: /** The number of channels of sound to be delivered to the cannam@116: stream callback or accessed by Pa_ReadStream() or Pa_WriteStream(). cannam@116: It can range from 1 to the value of maxInputChannels in the cannam@116: PaDeviceInfo record for the device specified by the device parameter. cannam@116: */ cannam@116: int channelCount; cannam@116: cannam@116: /** The sample format of the buffer provided to the stream callback, cannam@116: a_ReadStream() or Pa_WriteStream(). It may be any of the formats described cannam@116: by the PaSampleFormat enumeration. cannam@116: */ cannam@116: PaSampleFormat sampleFormat; cannam@116: cannam@116: /** The desired latency in seconds. Where practical, implementations should cannam@116: configure their latency based on these parameters, otherwise they may cannam@116: choose the closest viable latency instead. Unless the suggested latency cannam@116: is greater than the absolute upper limit for the device implementations cannam@116: should round the suggestedLatency up to the next practical value - ie to cannam@116: provide an equal or higher latency than suggestedLatency wherever possible. cannam@116: Actual latency values for an open stream may be retrieved using the cannam@116: inputLatency and outputLatency fields of the PaStreamInfo structure cannam@116: returned by Pa_GetStreamInfo(). cannam@116: @see default*Latency in PaDeviceInfo, *Latency in PaStreamInfo cannam@116: */ cannam@116: PaTime suggestedLatency; cannam@116: cannam@116: /** An optional pointer to a host api specific data structure cannam@116: containing additional information for device setup and/or stream processing. cannam@116: hostApiSpecificStreamInfo is never required for correct operation, cannam@116: if not used it should be set to NULL. cannam@116: */ cannam@116: void *hostApiSpecificStreamInfo; cannam@116: cannam@116: } PaStreamParameters; cannam@116: cannam@116: cannam@116: /** Return code for Pa_IsFormatSupported indicating success. */ cannam@116: #define paFormatIsSupported (0) cannam@116: cannam@116: /** Determine whether it would be possible to open a stream with the specified cannam@116: parameters. cannam@116: cannam@116: @param inputParameters A structure that describes the input parameters used to cannam@116: open a stream. The suggestedLatency field is ignored. See PaStreamParameters cannam@116: for a description of these parameters. inputParameters must be NULL for cannam@116: output-only streams. cannam@116: cannam@116: @param outputParameters A structure that describes the output parameters used cannam@116: to open a stream. The suggestedLatency field is ignored. See PaStreamParameters cannam@116: for a description of these parameters. outputParameters must be NULL for cannam@116: input-only streams. cannam@116: cannam@116: @param sampleRate The required sampleRate. For full-duplex streams it is the cannam@116: sample rate for both input and output cannam@116: cannam@116: @return Returns 0 if the format is supported, and an error code indicating why cannam@116: the format is not supported otherwise. The constant paFormatIsSupported is cannam@116: provided to compare with the return value for success. cannam@116: cannam@116: @see paFormatIsSupported, PaStreamParameters cannam@116: */ cannam@116: PaError Pa_IsFormatSupported( const PaStreamParameters *inputParameters, cannam@116: const PaStreamParameters *outputParameters, cannam@116: double sampleRate ); cannam@116: cannam@116: cannam@116: cannam@116: /* Streaming types and functions */ cannam@116: cannam@116: cannam@116: /** cannam@116: A single PaStream can provide multiple channels of real-time cannam@116: streaming audio input and output to a client application. A stream cannam@116: provides access to audio hardware represented by one or more cannam@116: PaDevices. Depending on the underlying Host API, it may be possible cannam@116: to open multiple streams using the same device, however this behavior cannam@116: is implementation defined. Portable applications should assume that cannam@116: a PaDevice may be simultaneously used by at most one PaStream. cannam@116: cannam@116: Pointers to PaStream objects are passed between PortAudio functions that cannam@116: operate on streams. cannam@116: cannam@116: @see Pa_OpenStream, Pa_OpenDefaultStream, Pa_OpenDefaultStream, Pa_CloseStream, cannam@116: Pa_StartStream, Pa_StopStream, Pa_AbortStream, Pa_IsStreamActive, cannam@116: Pa_GetStreamTime, Pa_GetStreamCpuLoad cannam@116: cannam@116: */ cannam@116: typedef void PaStream; cannam@116: cannam@116: cannam@116: /** Can be passed as the framesPerBuffer parameter to Pa_OpenStream() cannam@116: or Pa_OpenDefaultStream() to indicate that the stream callback will cannam@116: accept buffers of any size. cannam@116: */ cannam@116: #define paFramesPerBufferUnspecified (0) cannam@116: cannam@116: cannam@116: /** Flags used to control the behavior of a stream. They are passed as cannam@116: parameters to Pa_OpenStream or Pa_OpenDefaultStream. Multiple flags may be cannam@116: ORed together. cannam@116: cannam@116: @see Pa_OpenStream, Pa_OpenDefaultStream cannam@116: @see paNoFlag, paClipOff, paDitherOff, paNeverDropInput, cannam@116: paPrimeOutputBuffersUsingStreamCallback, paPlatformSpecificFlags cannam@116: */ cannam@116: typedef unsigned long PaStreamFlags; cannam@116: cannam@116: /** @see PaStreamFlags */ cannam@116: #define paNoFlag ((PaStreamFlags) 0) cannam@116: cannam@116: /** Disable default clipping of out of range samples. cannam@116: @see PaStreamFlags cannam@116: */ cannam@116: #define paClipOff ((PaStreamFlags) 0x00000001) cannam@116: cannam@116: /** Disable default dithering. cannam@116: @see PaStreamFlags cannam@116: */ cannam@116: #define paDitherOff ((PaStreamFlags) 0x00000002) cannam@116: cannam@116: /** Flag requests that where possible a full duplex stream will not discard cannam@116: overflowed input samples without calling the stream callback. This flag is cannam@116: only valid for full duplex callback streams and only when used in combination cannam@116: with the paFramesPerBufferUnspecified (0) framesPerBuffer parameter. Using cannam@116: this flag incorrectly results in a paInvalidFlag error being returned from cannam@116: Pa_OpenStream and Pa_OpenDefaultStream. cannam@116: cannam@116: @see PaStreamFlags, paFramesPerBufferUnspecified cannam@116: */ cannam@116: #define paNeverDropInput ((PaStreamFlags) 0x00000004) cannam@116: cannam@116: /** Call the stream callback to fill initial output buffers, rather than the cannam@116: default behavior of priming the buffers with zeros (silence). This flag has cannam@116: no effect for input-only and blocking read/write streams. cannam@116: cannam@116: @see PaStreamFlags cannam@116: */ cannam@116: #define paPrimeOutputBuffersUsingStreamCallback ((PaStreamFlags) 0x00000008) cannam@116: cannam@116: /** A mask specifying the platform specific bits. cannam@116: @see PaStreamFlags cannam@116: */ cannam@116: #define paPlatformSpecificFlags ((PaStreamFlags)0xFFFF0000) cannam@116: cannam@116: /** cannam@116: Timing information for the buffers passed to the stream callback. cannam@141: cannam@141: Time values are expressed in seconds and are synchronised with the time base used by Pa_GetStreamTime() for the associated stream. cannam@141: cannam@141: @see PaStreamCallback, Pa_GetStreamTime cannam@116: */ cannam@116: typedef struct PaStreamCallbackTimeInfo{ cannam@141: PaTime inputBufferAdcTime; /**< The time when the first sample of the input buffer was captured at the ADC input */ cannam@141: PaTime currentTime; /**< The time when the stream callback was invoked */ cannam@141: PaTime outputBufferDacTime; /**< The time when the first sample of the output buffer will output the DAC */ cannam@116: } PaStreamCallbackTimeInfo; cannam@116: cannam@116: cannam@116: /** cannam@116: Flag bit constants for the statusFlags to PaStreamCallback. cannam@116: cannam@116: @see paInputUnderflow, paInputOverflow, paOutputUnderflow, paOutputOverflow, cannam@116: paPrimingOutput cannam@116: */ cannam@116: typedef unsigned long PaStreamCallbackFlags; cannam@116: cannam@116: /** In a stream opened with paFramesPerBufferUnspecified, indicates that cannam@116: input data is all silence (zeros) because no real data is available. In a cannam@116: stream opened without paFramesPerBufferUnspecified, it indicates that one or cannam@116: more zero samples have been inserted into the input buffer to compensate cannam@116: for an input underflow. cannam@116: @see PaStreamCallbackFlags cannam@116: */ cannam@116: #define paInputUnderflow ((PaStreamCallbackFlags) 0x00000001) cannam@116: cannam@116: /** In a stream opened with paFramesPerBufferUnspecified, indicates that data cannam@116: prior to the first sample of the input buffer was discarded due to an cannam@116: overflow, possibly because the stream callback is using too much CPU time. cannam@116: Otherwise indicates that data prior to one or more samples in the cannam@116: input buffer was discarded. cannam@116: @see PaStreamCallbackFlags cannam@116: */ cannam@116: #define paInputOverflow ((PaStreamCallbackFlags) 0x00000002) cannam@116: cannam@116: /** Indicates that output data (or a gap) was inserted, possibly because the cannam@116: stream callback is using too much CPU time. cannam@116: @see PaStreamCallbackFlags cannam@116: */ cannam@116: #define paOutputUnderflow ((PaStreamCallbackFlags) 0x00000004) cannam@116: cannam@116: /** Indicates that output data will be discarded because no room is available. cannam@116: @see PaStreamCallbackFlags cannam@116: */ cannam@116: #define paOutputOverflow ((PaStreamCallbackFlags) 0x00000008) cannam@116: cannam@116: /** Some of all of the output data will be used to prime the stream, input cannam@116: data may be zero. cannam@116: @see PaStreamCallbackFlags cannam@116: */ cannam@116: #define paPrimingOutput ((PaStreamCallbackFlags) 0x00000010) cannam@116: cannam@116: /** cannam@116: Allowable return values for the PaStreamCallback. cannam@116: @see PaStreamCallback cannam@116: */ cannam@116: typedef enum PaStreamCallbackResult cannam@116: { cannam@141: paContinue=0, /**< Signal that the stream should continue invoking the callback and processing audio. */ cannam@141: paComplete=1, /**< Signal that the stream should stop invoking the callback and finish once all output samples have played. */ cannam@141: paAbort=2 /**< Signal that the stream should stop invoking the callback and finish as soon as possible. */ cannam@116: } PaStreamCallbackResult; cannam@116: cannam@116: cannam@116: /** cannam@116: Functions of type PaStreamCallback are implemented by PortAudio clients. cannam@116: They consume, process or generate audio in response to requests from an cannam@116: active PortAudio stream. cannam@141: cannam@141: When a stream is running, PortAudio calls the stream callback periodically. cannam@141: The callback function is responsible for processing buffers of audio samples cannam@141: passed via the input and output parameters. cannam@141: cannam@141: The PortAudio stream callback runs at very high or real-time priority. cannam@141: It is required to consistently meet its time deadlines. Do not allocate cannam@141: memory, access the file system, call library functions or call other functions cannam@141: from the stream callback that may block or take an unpredictable amount of cannam@141: time to complete. cannam@141: cannam@141: In order for a stream to maintain glitch-free operation the callback cannam@141: must consume and return audio data faster than it is recorded and/or cannam@141: played. PortAudio anticipates that each callback invocation may execute for cannam@141: a duration approaching the duration of frameCount audio frames at the stream cannam@141: sample rate. It is reasonable to expect to be able to utilise 70% or more of cannam@141: the available CPU time in the PortAudio callback. However, due to buffer size cannam@141: adaption and other factors, not all host APIs are able to guarantee audio cannam@141: stability under heavy CPU load with arbitrary fixed callback buffer sizes. cannam@141: When high callback CPU utilisation is required the most robust behavior cannam@141: can be achieved by using paFramesPerBufferUnspecified as the cannam@141: Pa_OpenStream() framesPerBuffer parameter. cannam@116: cannam@116: @param input and @param output are either arrays of interleaved samples or; cannam@116: if non-interleaved samples were requested using the paNonInterleaved sample cannam@116: format flag, an array of buffer pointers, one non-interleaved buffer for cannam@116: each channel. cannam@116: cannam@116: The format, packing and number of channels used by the buffers are cannam@116: determined by parameters to Pa_OpenStream(). cannam@116: cannam@116: @param frameCount The number of sample frames to be processed by cannam@116: the stream callback. cannam@116: cannam@141: @param timeInfo Timestamps indicating the ADC capture time of the first sample cannam@141: in the input buffer, the DAC output time of the first sample in the output buffer cannam@141: and the time the callback was invoked. cannam@141: See PaStreamCallbackTimeInfo and Pa_GetStreamTime() cannam@116: cannam@116: @param statusFlags Flags indicating whether input and/or output buffers cannam@116: have been inserted or will be dropped to overcome underflow or overflow cannam@116: conditions. cannam@116: cannam@116: @param userData The value of a user supplied pointer passed to cannam@116: Pa_OpenStream() intended for storing synthesis data etc. cannam@116: cannam@116: @return cannam@116: The stream callback should return one of the values in the cannam@141: ::PaStreamCallbackResult enumeration. To ensure that the callback continues cannam@116: to be called, it should return paContinue (0). Either paComplete or paAbort cannam@116: can be returned to finish stream processing, after either of these values is cannam@116: returned the callback will not be called again. If paAbort is returned the cannam@116: stream will finish as soon as possible. If paComplete is returned, the stream cannam@116: will continue until all buffers generated by the callback have been played. cannam@116: This may be useful in applications such as soundfile players where a specific cannam@116: duration of output is required. However, it is not necessary to utilize this cannam@116: mechanism as Pa_StopStream(), Pa_AbortStream() or Pa_CloseStream() can also cannam@116: be used to stop the stream. The callback must always fill the entire output cannam@116: buffer irrespective of its return value. cannam@116: cannam@116: @see Pa_OpenStream, Pa_OpenDefaultStream cannam@116: cannam@116: @note With the exception of Pa_GetStreamCpuLoad() it is not permissible to call cannam@116: PortAudio API functions from within the stream callback. cannam@116: */ cannam@116: typedef int PaStreamCallback( cannam@116: const void *input, void *output, cannam@116: unsigned long frameCount, cannam@116: const PaStreamCallbackTimeInfo* timeInfo, cannam@116: PaStreamCallbackFlags statusFlags, cannam@116: void *userData ); cannam@116: cannam@116: cannam@116: /** Opens a stream for either input, output or both. cannam@116: cannam@116: @param stream The address of a PaStream pointer which will receive cannam@116: a pointer to the newly opened stream. cannam@116: cannam@116: @param inputParameters A structure that describes the input parameters used by cannam@116: the opened stream. See PaStreamParameters for a description of these parameters. cannam@116: inputParameters must be NULL for output-only streams. cannam@116: cannam@116: @param outputParameters A structure that describes the output parameters used by cannam@116: the opened stream. See PaStreamParameters for a description of these parameters. cannam@116: outputParameters must be NULL for input-only streams. cannam@116: cannam@116: @param sampleRate The desired sampleRate. For full-duplex streams it is the cannam@116: sample rate for both input and output cannam@116: cannam@116: @param framesPerBuffer The number of frames passed to the stream callback cannam@116: function, or the preferred block granularity for a blocking read/write stream. cannam@116: The special value paFramesPerBufferUnspecified (0) may be used to request that cannam@116: the stream callback will receive an optimal (and possibly varying) number of cannam@116: frames based on host requirements and the requested latency settings. cannam@116: Note: With some host APIs, the use of non-zero framesPerBuffer for a callback cannam@116: stream may introduce an additional layer of buffering which could introduce cannam@116: additional latency. PortAudio guarantees that the additional latency cannam@116: will be kept to the theoretical minimum however, it is strongly recommended cannam@116: that a non-zero framesPerBuffer value only be used when your algorithm cannam@116: requires a fixed number of frames per stream callback. cannam@116: cannam@116: @param streamFlags Flags which modify the behavior of the streaming process. cannam@116: This parameter may contain a combination of flags ORed together. Some flags may cannam@116: only be relevant to certain buffer formats. cannam@116: cannam@116: @param streamCallback A pointer to a client supplied function that is responsible cannam@116: for processing and filling input and output buffers. If this parameter is NULL cannam@116: the stream will be opened in 'blocking read/write' mode. In blocking mode, cannam@116: the client can receive sample data using Pa_ReadStream and write sample data cannam@116: using Pa_WriteStream, the number of samples that may be read or written cannam@116: without blocking is returned by Pa_GetStreamReadAvailable and cannam@116: Pa_GetStreamWriteAvailable respectively. cannam@116: cannam@116: @param userData A client supplied pointer which is passed to the stream callback cannam@116: function. It could for example, contain a pointer to instance data necessary cannam@116: for processing the audio buffers. This parameter is ignored if streamCallback cannam@116: is NULL. cannam@116: cannam@116: @return cannam@116: Upon success Pa_OpenStream() returns paNoError and places a pointer to a cannam@116: valid PaStream in the stream argument. The stream is inactive (stopped). cannam@116: If a call to Pa_OpenStream() fails, a non-zero error code is returned (see cannam@116: PaError for possible error codes) and the value of stream is invalid. cannam@116: cannam@116: @see PaStreamParameters, PaStreamCallback, Pa_ReadStream, Pa_WriteStream, cannam@116: Pa_GetStreamReadAvailable, Pa_GetStreamWriteAvailable cannam@116: */ cannam@116: PaError Pa_OpenStream( PaStream** stream, cannam@116: const PaStreamParameters *inputParameters, cannam@116: const PaStreamParameters *outputParameters, cannam@116: double sampleRate, cannam@116: unsigned long framesPerBuffer, cannam@116: PaStreamFlags streamFlags, cannam@116: PaStreamCallback *streamCallback, cannam@116: void *userData ); cannam@116: cannam@116: cannam@116: /** A simplified version of Pa_OpenStream() that opens the default input cannam@116: and/or output devices. cannam@116: cannam@116: @param stream The address of a PaStream pointer which will receive cannam@116: a pointer to the newly opened stream. cannam@116: cannam@116: @param numInputChannels The number of channels of sound that will be supplied cannam@116: to the stream callback or returned by Pa_ReadStream. It can range from 1 to cannam@116: the value of maxInputChannels in the PaDeviceInfo record for the default input cannam@116: device. If 0 the stream is opened as an output-only stream. cannam@116: cannam@116: @param numOutputChannels The number of channels of sound to be delivered to the cannam@116: stream callback or passed to Pa_WriteStream. It can range from 1 to the value cannam@116: of maxOutputChannels in the PaDeviceInfo record for the default output device. cannam@116: If 0 the stream is opened as an output-only stream. cannam@116: cannam@116: @param sampleFormat The sample format of both the input and output buffers cannam@116: provided to the callback or passed to and from Pa_ReadStream and Pa_WriteStream. cannam@116: sampleFormat may be any of the formats described by the PaSampleFormat cannam@116: enumeration. cannam@116: cannam@116: @param sampleRate Same as Pa_OpenStream parameter of the same name. cannam@116: @param framesPerBuffer Same as Pa_OpenStream parameter of the same name. cannam@116: @param streamCallback Same as Pa_OpenStream parameter of the same name. cannam@116: @param userData Same as Pa_OpenStream parameter of the same name. cannam@116: cannam@116: @return As for Pa_OpenStream cannam@116: cannam@116: @see Pa_OpenStream, PaStreamCallback cannam@116: */ cannam@116: PaError Pa_OpenDefaultStream( PaStream** stream, cannam@116: int numInputChannels, cannam@116: int numOutputChannels, cannam@116: PaSampleFormat sampleFormat, cannam@116: double sampleRate, cannam@116: unsigned long framesPerBuffer, cannam@116: PaStreamCallback *streamCallback, cannam@116: void *userData ); cannam@116: cannam@116: cannam@116: /** Closes an audio stream. If the audio stream is active it cannam@116: discards any pending buffers as if Pa_AbortStream() had been called. cannam@116: */ cannam@116: PaError Pa_CloseStream( PaStream *stream ); cannam@116: cannam@116: cannam@116: /** Functions of type PaStreamFinishedCallback are implemented by PortAudio cannam@116: clients. They can be registered with a stream using the Pa_SetStreamFinishedCallback cannam@116: function. Once registered they are called when the stream becomes inactive cannam@116: (ie once a call to Pa_StopStream() will not block). cannam@116: A stream will become inactive after the stream callback returns non-zero, cannam@116: or when Pa_StopStream or Pa_AbortStream is called. For a stream providing audio cannam@141: output, if the stream callback returns paComplete, or Pa_StopStream() is called, cannam@116: the stream finished callback will not be called until all generated sample data cannam@116: has been played. cannam@116: cannam@116: @param userData The userData parameter supplied to Pa_OpenStream() cannam@116: cannam@116: @see Pa_SetStreamFinishedCallback cannam@116: */ cannam@116: typedef void PaStreamFinishedCallback( void *userData ); cannam@116: cannam@116: cannam@116: /** Register a stream finished callback function which will be called when the cannam@116: stream becomes inactive. See the description of PaStreamFinishedCallback for cannam@116: further details about when the callback will be called. cannam@116: cannam@116: @param stream a pointer to a PaStream that is in the stopped state - if the cannam@116: stream is not stopped, the stream's finished callback will remain unchanged cannam@116: and an error code will be returned. cannam@116: cannam@116: @param streamFinishedCallback a pointer to a function with the same signature cannam@116: as PaStreamFinishedCallback, that will be called when the stream becomes cannam@116: inactive. Passing NULL for this parameter will un-register a previously cannam@116: registered stream finished callback function. cannam@116: cannam@116: @return on success returns paNoError, otherwise an error code indicating the cause cannam@116: of the error. cannam@116: cannam@116: @see PaStreamFinishedCallback cannam@116: */ cannam@116: PaError Pa_SetStreamFinishedCallback( PaStream *stream, PaStreamFinishedCallback* streamFinishedCallback ); cannam@116: cannam@116: cannam@116: /** Commences audio processing. cannam@116: */ cannam@116: PaError Pa_StartStream( PaStream *stream ); cannam@116: cannam@116: cannam@116: /** Terminates audio processing. It waits until all pending cannam@116: audio buffers have been played before it returns. cannam@116: */ cannam@116: PaError Pa_StopStream( PaStream *stream ); cannam@116: cannam@116: cannam@116: /** Terminates audio processing immediately without waiting for pending cannam@116: buffers to complete. cannam@116: */ cannam@116: PaError Pa_AbortStream( PaStream *stream ); cannam@116: cannam@116: cannam@116: /** Determine whether the stream is stopped. cannam@116: A stream is considered to be stopped prior to a successful call to cannam@116: Pa_StartStream and after a successful call to Pa_StopStream or Pa_AbortStream. cannam@116: If a stream callback returns a value other than paContinue the stream is NOT cannam@116: considered to be stopped. cannam@116: cannam@116: @return Returns one (1) when the stream is stopped, zero (0) when cannam@116: the stream is running or, a PaErrorCode (which are always negative) if cannam@116: PortAudio is not initialized or an error is encountered. cannam@116: cannam@116: @see Pa_StopStream, Pa_AbortStream, Pa_IsStreamActive cannam@116: */ cannam@116: PaError Pa_IsStreamStopped( PaStream *stream ); cannam@116: cannam@116: cannam@116: /** Determine whether the stream is active. cannam@116: A stream is active after a successful call to Pa_StartStream(), until it cannam@116: becomes inactive either as a result of a call to Pa_StopStream() or cannam@116: Pa_AbortStream(), or as a result of a return value other than paContinue from cannam@116: the stream callback. In the latter case, the stream is considered inactive cannam@116: after the last buffer has finished playing. cannam@116: cannam@116: @return Returns one (1) when the stream is active (ie playing or recording cannam@116: audio), zero (0) when not playing or, a PaErrorCode (which are always negative) cannam@116: if PortAudio is not initialized or an error is encountered. cannam@116: cannam@116: @see Pa_StopStream, Pa_AbortStream, Pa_IsStreamStopped cannam@116: */ cannam@116: PaError Pa_IsStreamActive( PaStream *stream ); cannam@116: cannam@116: cannam@116: cannam@116: /** A structure containing unchanging information about an open stream. cannam@116: @see Pa_GetStreamInfo cannam@116: */ cannam@116: cannam@116: typedef struct PaStreamInfo cannam@116: { cannam@116: /** this is struct version 1 */ cannam@116: int structVersion; cannam@116: cannam@116: /** The input latency of the stream in seconds. This value provides the most cannam@116: accurate estimate of input latency available to the implementation. It may cannam@116: differ significantly from the suggestedLatency value passed to Pa_OpenStream(). cannam@116: The value of this field will be zero (0.) for output-only streams. cannam@116: @see PaTime cannam@116: */ cannam@116: PaTime inputLatency; cannam@116: cannam@116: /** The output latency of the stream in seconds. This value provides the most cannam@116: accurate estimate of output latency available to the implementation. It may cannam@116: differ significantly from the suggestedLatency value passed to Pa_OpenStream(). cannam@116: The value of this field will be zero (0.) for input-only streams. cannam@116: @see PaTime cannam@116: */ cannam@116: PaTime outputLatency; cannam@116: cannam@116: /** The sample rate of the stream in Hertz (samples per second). In cases cannam@116: where the hardware sample rate is inaccurate and PortAudio is aware of it, cannam@116: the value of this field may be different from the sampleRate parameter cannam@116: passed to Pa_OpenStream(). If information about the actual hardware sample cannam@116: rate is not available, this field will have the same value as the sampleRate cannam@116: parameter passed to Pa_OpenStream(). cannam@116: */ cannam@116: double sampleRate; cannam@116: cannam@116: } PaStreamInfo; cannam@116: cannam@116: cannam@116: /** Retrieve a pointer to a PaStreamInfo structure containing information cannam@116: about the specified stream. cannam@116: @return A pointer to an immutable PaStreamInfo structure. If the stream cannam@141: parameter is invalid, or an error is encountered, the function returns NULL. cannam@116: cannam@116: @param stream A pointer to an open stream previously created with Pa_OpenStream. cannam@116: cannam@116: @note PortAudio manages the memory referenced by the returned pointer, cannam@116: the client must not manipulate or free the memory. The pointer is only cannam@116: guaranteed to be valid until the specified stream is closed. cannam@116: cannam@116: @see PaStreamInfo cannam@116: */ cannam@116: const PaStreamInfo* Pa_GetStreamInfo( PaStream *stream ); cannam@116: cannam@116: cannam@116: /** Returns the current time in seconds for a stream according to the same clock used cannam@116: to generate callback PaStreamCallbackTimeInfo timestamps. The time values are cannam@116: monotonically increasing and have unspecified origin. cannam@116: cannam@116: Pa_GetStreamTime returns valid time values for the entire life of the stream, cannam@116: from when the stream is opened until it is closed. Starting and stopping the stream cannam@116: does not affect the passage of time returned by Pa_GetStreamTime. cannam@116: cannam@116: This time may be used for synchronizing other events to the audio stream, for cannam@116: example synchronizing audio to MIDI. cannam@116: cannam@116: @return The stream's current time in seconds, or 0 if an error occurred. cannam@116: cannam@116: @see PaTime, PaStreamCallback, PaStreamCallbackTimeInfo cannam@116: */ cannam@116: PaTime Pa_GetStreamTime( PaStream *stream ); cannam@116: cannam@116: cannam@116: /** Retrieve CPU usage information for the specified stream. cannam@116: The "CPU Load" is a fraction of total CPU time consumed by a callback stream's cannam@116: audio processing routines including, but not limited to the client supplied cannam@116: stream callback. This function does not work with blocking read/write streams. cannam@116: cannam@116: This function may be called from the stream callback function or the cannam@116: application. cannam@116: cannam@116: @return cannam@116: A floating point value, typically between 0.0 and 1.0, where 1.0 indicates cannam@116: that the stream callback is consuming the maximum number of CPU cycles possible cannam@116: to maintain real-time operation. A value of 0.5 would imply that PortAudio and cannam@116: the stream callback was consuming roughly 50% of the available CPU time. The cannam@116: return value may exceed 1.0. A value of 0.0 will always be returned for a cannam@116: blocking read/write stream, or if an error occurs. cannam@116: */ cannam@116: double Pa_GetStreamCpuLoad( PaStream* stream ); cannam@116: cannam@116: cannam@116: /** Read samples from an input stream. The function doesn't return until cannam@116: the entire buffer has been filled - this may involve waiting for the operating cannam@116: system to supply the data. cannam@116: cannam@116: @param stream A pointer to an open stream previously created with Pa_OpenStream. cannam@116: cannam@116: @param buffer A pointer to a buffer of sample frames. The buffer contains cannam@116: samples in the format specified by the inputParameters->sampleFormat field cannam@116: used to open the stream, and the number of channels specified by cannam@116: inputParameters->numChannels. If non-interleaved samples were requested using cannam@116: the paNonInterleaved sample format flag, buffer is a pointer to the first element cannam@116: of an array of buffer pointers, one non-interleaved buffer for each channel. cannam@116: cannam@116: @param frames The number of frames to be read into buffer. This parameter cannam@116: is not constrained to a specific range, however high performance applications cannam@116: will want to match this parameter to the framesPerBuffer parameter used cannam@116: when opening the stream. cannam@116: cannam@116: @return On success PaNoError will be returned, or PaInputOverflowed if input cannam@116: data was discarded by PortAudio after the previous call and before this call. cannam@116: */ cannam@116: PaError Pa_ReadStream( PaStream* stream, cannam@116: void *buffer, cannam@116: unsigned long frames ); cannam@116: cannam@116: cannam@116: /** Write samples to an output stream. This function doesn't return until the cannam@141: entire buffer has been written - this may involve waiting for the operating cannam@116: system to consume the data. cannam@116: cannam@116: @param stream A pointer to an open stream previously created with Pa_OpenStream. cannam@116: cannam@116: @param buffer A pointer to a buffer of sample frames. The buffer contains cannam@116: samples in the format specified by the outputParameters->sampleFormat field cannam@116: used to open the stream, and the number of channels specified by cannam@116: outputParameters->numChannels. If non-interleaved samples were requested using cannam@116: the paNonInterleaved sample format flag, buffer is a pointer to the first element cannam@116: of an array of buffer pointers, one non-interleaved buffer for each channel. cannam@116: cannam@116: @param frames The number of frames to be written from buffer. This parameter cannam@116: is not constrained to a specific range, however high performance applications cannam@116: will want to match this parameter to the framesPerBuffer parameter used cannam@116: when opening the stream. cannam@116: cannam@116: @return On success PaNoError will be returned, or paOutputUnderflowed if cannam@116: additional output data was inserted after the previous call and before this cannam@116: call. cannam@116: */ cannam@116: PaError Pa_WriteStream( PaStream* stream, cannam@116: const void *buffer, cannam@116: unsigned long frames ); cannam@116: cannam@116: cannam@116: /** Retrieve the number of frames that can be read from the stream without cannam@116: waiting. cannam@116: cannam@116: @return Returns a non-negative value representing the maximum number of frames cannam@116: that can be read from the stream without blocking or busy waiting or, a cannam@116: PaErrorCode (which are always negative) if PortAudio is not initialized or an cannam@116: error is encountered. cannam@116: */ cannam@116: signed long Pa_GetStreamReadAvailable( PaStream* stream ); cannam@116: cannam@116: cannam@116: /** Retrieve the number of frames that can be written to the stream without cannam@116: waiting. cannam@116: cannam@116: @return Returns a non-negative value representing the maximum number of frames cannam@116: that can be written to the stream without blocking or busy waiting or, a cannam@116: PaErrorCode (which are always negative) if PortAudio is not initialized or an cannam@116: error is encountered. cannam@116: */ cannam@116: signed long Pa_GetStreamWriteAvailable( PaStream* stream ); cannam@116: cannam@116: cannam@116: /* Miscellaneous utilities */ cannam@116: cannam@116: cannam@116: /** Retrieve the size of a given sample format in bytes. cannam@116: cannam@116: @return The size in bytes of a single sample in the specified format, cannam@116: or paSampleFormatNotSupported if the format is not supported. cannam@116: */ cannam@116: PaError Pa_GetSampleSize( PaSampleFormat format ); cannam@116: cannam@116: cannam@116: /** Put the caller to sleep for at least 'msec' milliseconds. This function is cannam@116: provided only as a convenience for authors of portable code (such as the tests cannam@116: and examples in the PortAudio distribution.) cannam@116: cannam@116: The function may sleep longer than requested so don't rely on this for accurate cannam@116: musical timing. cannam@116: */ cannam@116: void Pa_Sleep( long msec ); cannam@116: cannam@116: cannam@116: cannam@116: #ifdef __cplusplus cannam@116: } cannam@116: #endif /* __cplusplus */ cannam@116: #endif /* PORTAUDIO_H */