annotate src/portaudio/pablio/pablio.h @ 110:4c576e416934

Add Vamp SDK, move serd/sord to more obvious locations
author Chris Cannam <cannam@all-day-breakfast.com>
date Fri, 04 Jul 2014 08:16:02 +0100
parents 8a15ff55d9af
children
rev   line source
cannam@89 1 #ifndef _PABLIO_H
cannam@89 2 #define _PABLIO_H
cannam@89 3
cannam@89 4 #ifdef __cplusplus
cannam@89 5 extern "C"
cannam@89 6 {
cannam@89 7 #endif /* __cplusplus */
cannam@89 8
cannam@89 9 /*
cannam@89 10 * $Id: pablio.h 1083 2006-08-23 07:30:49Z rossb $
cannam@89 11 * PABLIO.h
cannam@89 12 * Portable Audio Blocking read/write utility.
cannam@89 13 *
cannam@89 14 * Author: Phil Burk, http://www.softsynth.com/portaudio/
cannam@89 15 *
cannam@89 16 * Include file for PABLIO, the Portable Audio Blocking I/O Library.
cannam@89 17 * PABLIO is built on top of PortAudio, the Portable Audio Library.
cannam@89 18 * For more information see: http://www.portaudio.com
cannam@89 19 * Copyright (c) 1999-2000 Ross Bencina and Phil Burk
cannam@89 20 *
cannam@89 21 * Permission is hereby granted, free of charge, to any person obtaining
cannam@89 22 * a copy of this software and associated documentation files
cannam@89 23 * (the "Software"), to deal in the Software without restriction,
cannam@89 24 * including without limitation the rights to use, copy, modify, merge,
cannam@89 25 * publish, distribute, sublicense, and/or sell copies of the Software,
cannam@89 26 * and to permit persons to whom the Software is furnished to do so,
cannam@89 27 * subject to the following conditions:
cannam@89 28 *
cannam@89 29 * The above copyright notice and this permission notice shall be
cannam@89 30 * included in all copies or substantial portions of the Software.
cannam@89 31 *
cannam@89 32 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@89 33 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@89 34 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
cannam@89 35 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
cannam@89 36 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@89 37 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@89 38 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@89 39 */
cannam@89 40
cannam@89 41 /*
cannam@89 42 * The text above constitutes the entire PortAudio license; however,
cannam@89 43 * the PortAudio community also makes the following non-binding requests:
cannam@89 44 *
cannam@89 45 * Any person wishing to distribute modifications to the Software is
cannam@89 46 * requested to send the modifications to the original developer so that
cannam@89 47 * they can be incorporated into the canonical version. It is also
cannam@89 48 * requested that these non-binding requests be included along with the
cannam@89 49 * license above.
cannam@89 50 */
cannam@89 51
cannam@89 52 #include <stdio.h>
cannam@89 53 #include <stdlib.h>
cannam@89 54 #include <math.h>
cannam@89 55 #include "portaudio.h"
cannam@89 56 #include "ringbuffer.h"
cannam@89 57 #include <string.h>
cannam@89 58
cannam@89 59 typedef struct
cannam@89 60 {
cannam@89 61 RingBuffer inFIFO;
cannam@89 62 RingBuffer outFIFO;
cannam@89 63 PortAudioStream *stream;
cannam@89 64 int bytesPerFrame;
cannam@89 65 int samplesPerFrame;
cannam@89 66 }
cannam@89 67 PABLIO_Stream;
cannam@89 68
cannam@89 69 /* Values for flags for OpenAudioStream(). */
cannam@89 70 #define PABLIO_READ (1<<0)
cannam@89 71 #define PABLIO_WRITE (1<<1)
cannam@89 72 #define PABLIO_READ_WRITE (PABLIO_READ|PABLIO_WRITE)
cannam@89 73 #define PABLIO_MONO (1<<2)
cannam@89 74 #define PABLIO_STEREO (1<<3)
cannam@89 75
cannam@89 76 /************************************************************
cannam@89 77 * Write data to ring buffer.
cannam@89 78 * Will not return until all the data has been written.
cannam@89 79 */
cannam@89 80 long WriteAudioStream( PABLIO_Stream *aStream, void *data, long numFrames );
cannam@89 81
cannam@89 82 /************************************************************
cannam@89 83 * Read data from ring buffer.
cannam@89 84 * Will not return until all the data has been read.
cannam@89 85 */
cannam@89 86 long ReadAudioStream( PABLIO_Stream *aStream, void *data, long numFrames );
cannam@89 87
cannam@89 88 /************************************************************
cannam@89 89 * Return the number of frames that could be written to the stream without
cannam@89 90 * having to wait.
cannam@89 91 */
cannam@89 92 long GetAudioStreamWriteable( PABLIO_Stream *aStream );
cannam@89 93
cannam@89 94 /************************************************************
cannam@89 95 * Return the number of frames that are available to be read from the
cannam@89 96 * stream without having to wait.
cannam@89 97 */
cannam@89 98 long GetAudioStreamReadable( PABLIO_Stream *aStream );
cannam@89 99
cannam@89 100 /************************************************************
cannam@89 101 * Opens a PortAudio stream with default characteristics.
cannam@89 102 * Allocates PABLIO_Stream structure.
cannam@89 103 *
cannam@89 104 * flags parameter can be an ORed combination of:
cannam@89 105 * PABLIO_READ, PABLIO_WRITE, or PABLIO_READ_WRITE,
cannam@89 106 * and either PABLIO_MONO or PABLIO_STEREO
cannam@89 107 */
cannam@89 108 PaError OpenAudioStream( PABLIO_Stream **aStreamPtr, double sampleRate,
cannam@89 109 PaSampleFormat format, long flags );
cannam@89 110
cannam@89 111 PaError CloseAudioStream( PABLIO_Stream *aStream );
cannam@89 112
cannam@89 113 #ifdef __cplusplus
cannam@89 114 }
cannam@89 115 #endif /* __cplusplus */
cannam@89 116 #endif /* _PABLIO_H */