cannam@124: /*
cannam@124:  * $Id: pablio.c 1151 2006-11-29 02:11:16Z leland_lucius $
cannam@124:  * pablio.c
cannam@124:  * Portable Audio Blocking Input/Output utility.
cannam@124:  *
cannam@124:  * Author: Phil Burk, http://www.softsynth.com
cannam@124:  *
cannam@124:  * This program uses the PortAudio Portable Audio Library.
cannam@124:  * For more information see: http://www.portaudio.com
cannam@124:  * Copyright (c) 1999-2000 Ross Bencina and Phil Burk
cannam@124:  *
cannam@124:  * Permission is hereby granted, free of charge, to any person obtaining
cannam@124:  * a copy of this software and associated documentation files
cannam@124:  * (the "Software"), to deal in the Software without restriction,
cannam@124:  * including without limitation the rights to use, copy, modify, merge,
cannam@124:  * publish, distribute, sublicense, and/or sell copies of the Software,
cannam@124:  * and to permit persons to whom the Software is furnished to do so,
cannam@124:  * subject to the following conditions:
cannam@124:  *
cannam@124:  * The above copyright notice and this permission notice shall be
cannam@124:  * included in all copies or substantial portions of the Software.
cannam@124:  *
cannam@124:  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@124:  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@124:  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
cannam@124:  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
cannam@124:  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@124:  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@124:  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@124:  */
cannam@124: 
cannam@124: /*
cannam@124:  * The text above constitutes the entire PortAudio license; however, 
cannam@124:  * the PortAudio community also makes the following non-binding requests:
cannam@124:  *
cannam@124:  * Any person wishing to distribute modifications to the Software is
cannam@124:  * requested to send the modifications to the original developer so that
cannam@124:  * they can be incorporated into the canonical version. It is also 
cannam@124:  * requested that these non-binding requests be included along with the 
cannam@124:  * license above.
cannam@124:  */
cannam@124: 
cannam@124: #include <stdio.h>
cannam@124: #include <stdlib.h>
cannam@124: #include <math.h>
cannam@124: #include "portaudio.h"
cannam@124: #include "pa_ringbuffer.h"
cannam@124: #include "pablio.h"
cannam@124: #include <string.h>
cannam@124: 
cannam@124: /************************************************************************/
cannam@124: /******** Constants *****************************************************/
cannam@124: /************************************************************************/
cannam@124: 
cannam@124: #define FRAMES_PER_BUFFER    (256)
cannam@124: 
cannam@124: /************************************************************************/
cannam@124: /******** Prototypes ****************************************************/
cannam@124: /************************************************************************/
cannam@124: 
cannam@124: static int blockingIOCallback( void *inputBuffer, void *outputBuffer,
cannam@124:                                unsigned long framesPerBuffer,
cannam@124:                                PaTimestamp outTime, void *userData );
cannam@124: static PaError PABLIO_InitFIFO( RingBuffer *rbuf, long numFrames, long bytesPerFrame );
cannam@124: static PaError PABLIO_TermFIFO( RingBuffer *rbuf );
cannam@124: 
cannam@124: /************************************************************************/
cannam@124: /******** Functions *****************************************************/
cannam@124: /************************************************************************/
cannam@124: 
cannam@124: /* Called from PortAudio.
cannam@124:  * Read and write data only if there is room in FIFOs.
cannam@124:  */
cannam@124: static int blockingIOCallback( void *inputBuffer, void *outputBuffer,
cannam@124:                                unsigned long framesPerBuffer,
cannam@124:                                PaTimestamp outTime, void *userData )
cannam@124: {
cannam@124:     PABLIO_Stream *data = (PABLIO_Stream*)userData;
cannam@124:     long numBytes = data->bytesPerFrame * framesPerBuffer;
cannam@124:     (void) outTime;
cannam@124: 
cannam@124:     /* This may get called with NULL inputBuffer during initial setup. */
cannam@124:     if( inputBuffer != NULL )
cannam@124:     {
cannam@124:         PaUtil_WriteRingBuffer( &data->inFIFO, inputBuffer, numBytes );
cannam@124:     }
cannam@124:     if( outputBuffer != NULL )
cannam@124:     {
cannam@124:         int i;
cannam@124:         int numRead = PaUtil_ReadRingBuffer( &data->outFIFO, outputBuffer, numBytes );
cannam@124:         /* Zero out remainder of buffer if we run out of data. */
cannam@124:         for( i=numRead; i<numBytes; i++ )
cannam@124:         {
cannam@124:             ((char *)outputBuffer)[i] = 0;
cannam@124:         }
cannam@124:     }
cannam@124: 
cannam@124:     return 0;
cannam@124: }
cannam@124: 
cannam@124: /* Allocate buffer. */
cannam@124: static PaError PABLIO_InitFIFO( RingBuffer *rbuf, long numFrames, long bytesPerFrame )
cannam@124: {
cannam@124:     long numBytes = numFrames * bytesPerFrame;
cannam@124:     char *buffer = (char *) malloc( numBytes );
cannam@124:     if( buffer == NULL ) return paInsufficientMemory;
cannam@124:     memset( buffer, 0, numBytes );
cannam@124:     return (PaError) PaUtil_InitializeRingBuffer( rbuf, numBytes, buffer );
cannam@124: }
cannam@124: 
cannam@124: /* Free buffer. */
cannam@124: static PaError PABLIO_TermFIFO( RingBuffer *rbuf )
cannam@124: {
cannam@124:     if( rbuf->buffer ) free( rbuf->buffer );
cannam@124:     rbuf->buffer = NULL;
cannam@124:     return paNoError;
cannam@124: }
cannam@124: 
cannam@124: /************************************************************
cannam@124:  * Write data to ring buffer.
cannam@124:  * Will not return until all the data has been written.
cannam@124:  */
cannam@124: long WriteAudioStream( PABLIO_Stream *aStream, void *data, long numFrames )
cannam@124: {
cannam@124:     long bytesWritten;
cannam@124:     char *p = (char *) data;
cannam@124:     long numBytes = aStream->bytesPerFrame * numFrames;
cannam@124:     while( numBytes > 0)
cannam@124:     {
cannam@124:         bytesWritten = PaUtil_WriteRingBuffer( &aStream->outFIFO, p, numBytes );
cannam@124:         numBytes -= bytesWritten;
cannam@124:         p += bytesWritten;
cannam@124:         if( numBytes > 0) Pa_Sleep(10);
cannam@124:     }
cannam@124:     return numFrames;
cannam@124: }
cannam@124: 
cannam@124: /************************************************************
cannam@124:  * Read data from ring buffer.
cannam@124:  * Will not return until all the data has been read.
cannam@124:  */
cannam@124: long ReadAudioStream( PABLIO_Stream *aStream, void *data, long numFrames )
cannam@124: {
cannam@124:     long bytesRead;
cannam@124:     char *p = (char *) data;
cannam@124:     long numBytes = aStream->bytesPerFrame * numFrames;
cannam@124:     while( numBytes > 0)
cannam@124:     {
cannam@124:         bytesRead = PaUtil_ReadRingBuffer( &aStream->inFIFO, p, numBytes );
cannam@124:         numBytes -= bytesRead;
cannam@124:         p += bytesRead;
cannam@124:         if( numBytes > 0) Pa_Sleep(10);
cannam@124:     }
cannam@124:     return numFrames;
cannam@124: }
cannam@124: 
cannam@124: /************************************************************
cannam@124:  * Return the number of frames that could be written to the stream without
cannam@124:  * having to wait.
cannam@124:  */
cannam@124: long GetAudioStreamWriteable( PABLIO_Stream *aStream )
cannam@124: {
cannam@124:     int bytesEmpty = PaUtil_GetRingBufferWriteAvailable( &aStream->outFIFO );
cannam@124:     return bytesEmpty / aStream->bytesPerFrame;
cannam@124: }
cannam@124: 
cannam@124: /************************************************************
cannam@124:  * Return the number of frames that are available to be read from the
cannam@124:  * stream without having to wait.
cannam@124:  */
cannam@124: long GetAudioStreamReadable( PABLIO_Stream *aStream )
cannam@124: {
cannam@124:     int bytesFull = PaUtil_GetRingBufferReadAvailable( &aStream->inFIFO );
cannam@124:     return bytesFull / aStream->bytesPerFrame;
cannam@124: }
cannam@124: 
cannam@124: /************************************************************/
cannam@124: static unsigned long RoundUpToNextPowerOf2( unsigned long n )
cannam@124: {
cannam@124:     long numBits = 0;
cannam@124:     if( ((n-1) & n) == 0) return n; /* Already Power of two. */
cannam@124:     while( n > 0 )
cannam@124:     {
cannam@124:         n= n>>1;
cannam@124:         numBits++;
cannam@124:     }
cannam@124:     return (1<<numBits);
cannam@124: }
cannam@124: 
cannam@124: /************************************************************
cannam@124:  * Opens a PortAudio stream with default characteristics.
cannam@124:  * Allocates PABLIO_Stream structure.
cannam@124:  *
cannam@124:  * flags parameter can be an ORed combination of:
cannam@124:  *    PABLIO_READ, PABLIO_WRITE, or PABLIO_READ_WRITE,
cannam@124:  *    and either PABLIO_MONO or PABLIO_STEREO
cannam@124:  */
cannam@124: PaError OpenAudioStream( PABLIO_Stream **rwblPtr, double sampleRate,
cannam@124:                          PaSampleFormat format, long flags )
cannam@124: {
cannam@124:     long   bytesPerSample;
cannam@124:     long   doRead = 0;
cannam@124:     long   doWrite = 0;
cannam@124:     PaError err;
cannam@124:     PABLIO_Stream *aStream;
cannam@124:     long   minNumBuffers;
cannam@124:     long   numFrames;
cannam@124: 
cannam@124:     /* Allocate PABLIO_Stream structure for caller. */
cannam@124:     aStream = (PABLIO_Stream *) malloc( sizeof(PABLIO_Stream) );
cannam@124:     if( aStream == NULL ) return paInsufficientMemory;
cannam@124:     memset( aStream, 0, sizeof(PABLIO_Stream) );
cannam@124: 
cannam@124:     /* Determine size of a sample. */
cannam@124:     bytesPerSample = Pa_GetSampleSize( format );
cannam@124:     if( bytesPerSample < 0 )
cannam@124:     {
cannam@124:         err = (PaError) bytesPerSample;
cannam@124:         goto error;
cannam@124:     }
cannam@124:     aStream->samplesPerFrame = ((flags&PABLIO_MONO) != 0) ? 1 : 2;
cannam@124:     aStream->bytesPerFrame = bytesPerSample * aStream->samplesPerFrame;
cannam@124: 
cannam@124:     /* Initialize PortAudio  */
cannam@124:     err = Pa_Initialize();
cannam@124:     if( err != paNoError ) goto error;
cannam@124: 
cannam@124:     /* Warning: numFrames must be larger than amount of data processed per interrupt
cannam@124:      *    inside PA to prevent glitches. Just to be safe, adjust size upwards.
cannam@124:      */
cannam@124:     minNumBuffers = 2 * Pa_GetMinNumBuffers( FRAMES_PER_BUFFER, sampleRate );
cannam@124:     numFrames = minNumBuffers * FRAMES_PER_BUFFER;
cannam@124:     numFrames = RoundUpToNextPowerOf2( numFrames );
cannam@124: 
cannam@124:     /* Initialize Ring Buffers */
cannam@124:     doRead = ((flags & PABLIO_READ) != 0);
cannam@124:     doWrite = ((flags & PABLIO_WRITE) != 0);
cannam@124:     if(doRead)
cannam@124:     {
cannam@124:         err = PABLIO_InitFIFO( &aStream->inFIFO, numFrames, aStream->bytesPerFrame );
cannam@124:         if( err != paNoError ) goto error;
cannam@124:     }
cannam@124:     if(doWrite)
cannam@124:     {
cannam@124:         long numBytes;
cannam@124:         err = PABLIO_InitFIFO( &aStream->outFIFO, numFrames, aStream->bytesPerFrame );
cannam@124:         if( err != paNoError ) goto error;
cannam@124:         /* Make Write FIFO appear full initially. */
cannam@124:         numBytes = PaUtil_GetRingBufferWriteAvailable( &aStream->outFIFO );
cannam@124:         PaUtil_AdvanceRingBufferWriteIndex( &aStream->outFIFO, numBytes );
cannam@124:     }
cannam@124: 
cannam@124:     /* Open a PortAudio stream that we will use to communicate with the underlying
cannam@124:      * audio drivers. */
cannam@124:     err = Pa_OpenStream(
cannam@124:               &aStream->stream,
cannam@124:               (doRead ? Pa_GetDefaultInputDeviceID() : paNoDevice),
cannam@124:               (doRead ? aStream->samplesPerFrame : 0 ),
cannam@124:               format,
cannam@124:               NULL,
cannam@124:               (doWrite ? Pa_GetDefaultOutputDeviceID() : paNoDevice),
cannam@124:               (doWrite ? aStream->samplesPerFrame : 0 ),
cannam@124:               format,
cannam@124:               NULL,
cannam@124:               sampleRate,
cannam@124:               FRAMES_PER_BUFFER,
cannam@124:               minNumBuffers,
cannam@124:               paClipOff,       /* we won't output out of range samples so don't bother clipping them */
cannam@124:               blockingIOCallback,
cannam@124:               aStream );
cannam@124:     if( err != paNoError ) goto error;
cannam@124: 
cannam@124:     err = Pa_StartStream( aStream->stream );
cannam@124:     if( err != paNoError ) goto error;
cannam@124: 
cannam@124:     *rwblPtr = aStream;
cannam@124:     return paNoError;
cannam@124: 
cannam@124: error:
cannam@124:     CloseAudioStream( aStream );
cannam@124:     *rwblPtr = NULL;
cannam@124:     return err;
cannam@124: }
cannam@124: 
cannam@124: /************************************************************/
cannam@124: PaError CloseAudioStream( PABLIO_Stream *aStream )
cannam@124: {
cannam@124:     PaError err;
cannam@124:     int bytesEmpty;
cannam@124:     int byteSize = aStream->outFIFO.bufferSize;
cannam@124: 
cannam@124:     /* If we are writing data, make sure we play everything written. */
cannam@124:     if( byteSize > 0 )
cannam@124:     {
cannam@124:         bytesEmpty = PaUtil_GetRingBufferWriteAvailable( &aStream->outFIFO );
cannam@124:         while( bytesEmpty < byteSize )
cannam@124:         {
cannam@124:             Pa_Sleep( 10 );
cannam@124:             bytesEmpty = PaUtil_GetRingBufferWriteAvailable( &aStream->outFIFO );
cannam@124:         }
cannam@124:     }
cannam@124: 
cannam@124:     err = Pa_StopStream( aStream->stream );
cannam@124:     if( err != paNoError ) goto error;
cannam@124:     err = Pa_CloseStream( aStream->stream );
cannam@124:     if( err != paNoError ) goto error;
cannam@124:     Pa_Terminate();
cannam@124: 
cannam@124: error:
cannam@124:     PABLIO_TermFIFO( &aStream->inFIFO );
cannam@124:     PABLIO_TermFIFO( &aStream->outFIFO );
cannam@124:     free( aStream );
cannam@124:     return err;
cannam@124: }