me/portaudio
Watch
1
0
Fork
You've already forked portaudio
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

improved documentation of paNoInterleaved flag

Browse source
This commit is contained in:
rossb 2010-10-14 03:34:34 +00:00
commit e47e43deb8
1 changed files with 18 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

30
include/portaudio.h
View file

@ -419,8 +419,10 @@ typedef double PaTime;
paUInt8 is an unsigned 8 bit format where 128 is considered "ground" paUInt8 is an unsigned 8 bit format where 128 is considered "ground"
The paNonInterleaved flag indicates that a multichannel buffer is passed The paNonInterleaved flag indicates that audio data is passed as an array
as a set of non-interleaved pointers. of pointers to separate buffers, one buffer for each channel. Usually,
when this flag is not used, audio data is passed as a single buffer with
all channels interleaved.
@see Pa_OpenStream, Pa_OpenDefaultStream, PaDeviceInfo @see Pa_OpenStream, Pa_OpenDefaultStream, PaDeviceInfo
@see paFloat32, paInt16, paInt32, paInt24, paInt8 @see paFloat32, paInt16, paInt32, paInt24, paInt8
@ -435,9 +437,9 @@ typedef unsigned long PaSampleFormat;
#define paInt16 ((PaSampleFormat) 0x00000008) /**< @see PaSampleFormat */ #define paInt16 ((PaSampleFormat) 0x00000008) /**< @see PaSampleFormat */
#define paInt8 ((PaSampleFormat) 0x00000010) /**< @see PaSampleFormat */ #define paInt8 ((PaSampleFormat) 0x00000010) /**< @see PaSampleFormat */
#define paUInt8 ((PaSampleFormat) 0x00000020) /**< @see PaSampleFormat */ #define paUInt8 ((PaSampleFormat) 0x00000020) /**< @see PaSampleFormat */
#define paCustomFormat ((PaSampleFormat) 0x00010000)/**< @see PaSampleFormat */ #define paCustomFormat ((PaSampleFormat) 0x00010000) /**< @see PaSampleFormat */
#define paNonInterleaved ((PaSampleFormat) 0x80000000) #define paNonInterleaved ((PaSampleFormat) 0x80000000) /**< @see PaSampleFormat */
/** A structure providing information and capabilities of PortAudio devices. /** A structure providing information and capabilities of PortAudio devices.
Devices may support input, output or both input and output. Devices may support input, output or both input and output.
@ -704,8 +706,12 @@ typedef enum PaStreamCallbackResult
They consume, process or generate audio in response to requests from an They consume, process or generate audio in response to requests from an
active PortAudio stream. active PortAudio stream.
@param input and @param output are arrays of interleaved samples, @param input and @param output are either arrays of interleaved samples or;
the format, packing and number of channels used by the buffers are if non-interleaved samples were requested using the paNonInterleaved sample
format flag, an array of buffer pointers, one non-interleaved buffer for
each channel.
The format, packing and number of channels used by the buffers are
determined by parameters to Pa_OpenStream(). determined by parameters to Pa_OpenStream().
@param frameCount The number of sample frames to be processed by @param frameCount The number of sample frames to be processed by
@ -1040,9 +1046,9 @@ double Pa_GetStreamCpuLoad( PaStream* stream );
@param buffer A pointer to a buffer of sample frames. The buffer contains @param buffer A pointer to a buffer of sample frames. The buffer contains
samples in the format specified by the inputParameters->sampleFormat field samples in the format specified by the inputParameters->sampleFormat field
used to open the stream, and the number of channels specified by used to open the stream, and the number of channels specified by
inputParameters->numChannels. If non-interleaved samples were requested, inputParameters->numChannels. If non-interleaved samples were requested using
buffer is a pointer to the first element of an array of non-interleaved the paNonInterleaved sample format flag, buffer is a pointer to the first element
buffer pointers, one for each channel. of an array of buffer pointers, one non-interleaved buffer for each channel.
@param frames The number of frames to be read into buffer. This parameter @param frames The number of frames to be read into buffer. This parameter
is not constrained to a specific range, however high performance applications is not constrained to a specific range, however high performance applications
@ -1066,9 +1072,9 @@ PaError Pa_ReadStream( PaStream* stream,
@param buffer A pointer to a buffer of sample frames. The buffer contains @param buffer A pointer to a buffer of sample frames. The buffer contains
samples in the format specified by the outputParameters->sampleFormat field samples in the format specified by the outputParameters->sampleFormat field
used to open the stream, and the number of channels specified by used to open the stream, and the number of channels specified by
outputParameters->numChannels. If non-interleaved samples were requested, outputParameters->numChannels. If non-interleaved samples were requested using
buffer is a pointer to the first element of an array of non-interleaved the paNonInterleaved sample format flag, buffer is a pointer to the first element
buffer pointers, one for each channel. of an array of buffer pointers, one non-interleaved buffer for each channel.
@param frames The number of frames to be written from buffer. This parameter @param frames The number of frames to be written from buffer. This parameter
is not constrained to a specific range, however high performance applications is not constrained to a specific range, however high performance applications