cannam@162: #ifndef _PABLIO_H
cannam@162: #define _PABLIO_H
cannam@162: 
cannam@162: #ifdef __cplusplus
cannam@162: extern "C"
cannam@162: {
cannam@162: #endif /* __cplusplus */
cannam@162: 
cannam@162: /*
cannam@162:  * $Id$
cannam@162:  * PABLIO.h
cannam@162:  * Portable Audio Blocking read/write utility.
cannam@162:  *
cannam@162:  * Author: Phil Burk, http://www.softsynth.com/portaudio/
cannam@162:  *
cannam@162:  * Include file for PABLIO, the Portable Audio Blocking I/O Library.
cannam@162:  * PABLIO is built on top of PortAudio, the Portable Audio Library.
cannam@162:  * For more information see: http://www.portaudio.com
cannam@162:  * Copyright (c) 1999-2000 Ross Bencina and Phil Burk
cannam@162:  *
cannam@162:  * Permission is hereby granted, free of charge, to any person obtaining
cannam@162:  * a copy of this software and associated documentation files
cannam@162:  * (the "Software"), to deal in the Software without restriction,
cannam@162:  * including without limitation the rights to use, copy, modify, merge,
cannam@162:  * publish, distribute, sublicense, and/or sell copies of the Software,
cannam@162:  * and to permit persons to whom the Software is furnished to do so,
cannam@162:  * subject to the following conditions:
cannam@162:  *
cannam@162:  * The above copyright notice and this permission notice shall be
cannam@162:  * included in all copies or substantial portions of the Software.
cannam@162:  *
cannam@162:  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@162:  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@162:  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
cannam@162:  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
cannam@162:  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@162:  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@162:  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@162:  */
cannam@162: 
cannam@162: /*
cannam@162:  * The text above constitutes the entire PortAudio license; however, 
cannam@162:  * the PortAudio community also makes the following non-binding requests:
cannam@162:  *
cannam@162:  * Any person wishing to distribute modifications to the Software is
cannam@162:  * requested to send the modifications to the original developer so that
cannam@162:  * they can be incorporated into the canonical version. It is also 
cannam@162:  * requested that these non-binding requests be included along with the 
cannam@162:  * license above.
cannam@162:  */
cannam@162: 
cannam@162: #include <stdio.h>
cannam@162: #include <stdlib.h>
cannam@162: #include <math.h>
cannam@162: #include "portaudio.h"
cannam@162: #include "pa_ringbuffer.h"
cannam@162: #include <string.h>
cannam@162: 
cannam@162: typedef struct
cannam@162: {
cannam@162:     RingBuffer   inFIFO;
cannam@162:     RingBuffer   outFIFO;
cannam@162:     PortAudioStream *stream;
cannam@162:     int          bytesPerFrame;
cannam@162:     int          samplesPerFrame;
cannam@162: }
cannam@162: PABLIO_Stream;
cannam@162: 
cannam@162: /* Values for flags for OpenAudioStream(). */
cannam@162: #define PABLIO_READ     (1<<0)
cannam@162: #define PABLIO_WRITE    (1<<1)
cannam@162: #define PABLIO_READ_WRITE    (PABLIO_READ|PABLIO_WRITE)
cannam@162: #define PABLIO_MONO     (1<<2)
cannam@162: #define PABLIO_STEREO   (1<<3)
cannam@162: 
cannam@162: /************************************************************
cannam@162:  * Write data to ring buffer.
cannam@162:  * Will not return until all the data has been written.
cannam@162:  */
cannam@162: long WriteAudioStream( PABLIO_Stream *aStream, void *data, long numFrames );
cannam@162: 
cannam@162: /************************************************************
cannam@162:  * Read data from ring buffer.
cannam@162:  * Will not return until all the data has been read.
cannam@162:  */
cannam@162: long ReadAudioStream( PABLIO_Stream *aStream, void *data, long numFrames );
cannam@162: 
cannam@162: /************************************************************
cannam@162:  * Return the number of frames that could be written to the stream without
cannam@162:  * having to wait.
cannam@162:  */
cannam@162: long GetAudioStreamWriteable( PABLIO_Stream *aStream );
cannam@162: 
cannam@162: /************************************************************
cannam@162:  * Return the number of frames that are available to be read from the
cannam@162:  * stream without having to wait.
cannam@162:  */
cannam@162: long GetAudioStreamReadable( PABLIO_Stream *aStream );
cannam@162: 
cannam@162: /************************************************************
cannam@162:  * Opens a PortAudio stream with default characteristics.
cannam@162:  * Allocates PABLIO_Stream structure.
cannam@162:  *
cannam@162:  * flags parameter can be an ORed combination of:
cannam@162:  *    PABLIO_READ, PABLIO_WRITE, or PABLIO_READ_WRITE,
cannam@162:  *    and either PABLIO_MONO or PABLIO_STEREO
cannam@162:  */
cannam@162: PaError OpenAudioStream( PABLIO_Stream **aStreamPtr, double sampleRate,
cannam@162:                          PaSampleFormat format, long flags );
cannam@162: 
cannam@162: PaError CloseAudioStream( PABLIO_Stream *aStream );
cannam@162: 
cannam@162: #ifdef __cplusplus
cannam@162: }
cannam@162: #endif /* __cplusplus */
cannam@162: #endif /* _PABLIO_H */