cannam@162: #ifndef PA_LINUX_ALSA_H
cannam@162: #define PA_LINUX_ALSA_H
cannam@162: 
cannam@162: /*
cannam@162:  * $Id$
cannam@162:  * PortAudio Portable Real-Time Audio Library
cannam@162:  * ALSA-specific extensions
cannam@162:  *
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: /** @file
cannam@162:  *  @ingroup public_header
cannam@162:  *  @brief ALSA-specific PortAudio API extension header file.
cannam@162:  */
cannam@162: 
cannam@162: #include "portaudio.h"
cannam@162: 
cannam@162: #ifdef __cplusplus
cannam@162: extern "C" {
cannam@162: #endif
cannam@162: 
cannam@162: typedef struct PaAlsaStreamInfo
cannam@162: {
cannam@162:     unsigned long size;
cannam@162:     PaHostApiTypeId hostApiType;
cannam@162:     unsigned long version;
cannam@162: 
cannam@162:     const char *deviceString;
cannam@162: }
cannam@162: PaAlsaStreamInfo;
cannam@162: 
cannam@162: /** Initialize host API specific structure, call this before setting relevant attributes. */
cannam@162: void PaAlsa_InitializeStreamInfo( PaAlsaStreamInfo *info );
cannam@162: 
cannam@162: /** Instruct whether to enable real-time priority when starting the audio thread.
cannam@162:  *
cannam@162:  * If this is turned on by the stream is started, the audio callback thread will be created
cannam@162:  * with the FIFO scheduling policy, which is suitable for realtime operation.
cannam@162:  **/
cannam@162: void PaAlsa_EnableRealtimeScheduling( PaStream *s, int enable );
cannam@162: 
cannam@162: #if 0
cannam@162: void PaAlsa_EnableWatchdog( PaStream *s, int enable );
cannam@162: #endif
cannam@162: 
cannam@162: /** Get the ALSA-lib card index of this stream's input device. */
cannam@162: PaError PaAlsa_GetStreamInputCard( PaStream *s, int *card );
cannam@162: 
cannam@162: /** Get the ALSA-lib card index of this stream's output device. */
cannam@162: PaError PaAlsa_GetStreamOutputCard( PaStream *s, int *card );
cannam@162: 
cannam@162: /** Set the number of periods (buffer fragments) to configure devices with.
cannam@162:  *
cannam@162:  * By default the number of periods is 4, this is the lowest number of periods that works well on
cannam@162:  * the author's soundcard.
cannam@162:  * @param numPeriods The number of periods.
cannam@162:  */
cannam@162: PaError PaAlsa_SetNumPeriods( int numPeriods );
cannam@162: 
cannam@162: /** Set the maximum number of times to retry opening busy device (sleeping for a
cannam@162:  * short interval inbetween).
cannam@162:  */
cannam@162: PaError PaAlsa_SetRetriesBusy( int retries );
cannam@162: 
cannam@162: /** Set the path and name of ALSA library file if PortAudio is configured to load it dynamically (see
cannam@162:  *  PA_ALSA_DYNAMIC). This setting will overwrite the default name set by PA_ALSA_PATHNAME define.
cannam@162:  * @param pathName Full path with filename. Only filename can be used, but dlopen() will lookup default
cannam@162:  *                 searchable directories (/usr/lib;/usr/local/lib) then.
cannam@162:  */
cannam@162: void PaAlsa_SetLibraryPathName( const char *pathName );
cannam@162: 
cannam@162: #ifdef __cplusplus
cannam@162: }
cannam@162: #endif
cannam@162: 
cannam@162: #endif