Jamoma API  0.6.0.a19
pa_linux_alsa.h
Go to the documentation of this file.
1 #ifndef PA_LINUX_ALSA_H
2 #define PA_LINUX_ALSA_H
3 
4 /*
5  * $Id: pa_linux_alsa.h 1236 2007-06-24 20:39:26Z aknudsen $
6  * PortAudio Portable Real-Time Audio Library
7  * ALSA-specific extensions
8  *
9  * Copyright (c) 1999-2000 Ross Bencina and Phil Burk
10  *
11  * Permission is hereby granted, free of charge, to any person obtaining
12  * a copy of this software and associated documentation files
13  * (the "Software"), to deal in the Software without restriction,
14  * including without limitation the rights to use, copy, modify, merge,
15  * publish, distribute, sublicense, and/or sell copies of the Software,
16  * and to permit persons to whom the Software is furnished to do so,
17  * subject to the following conditions:
18  *
19  * The above copyright notice and this permission notice shall be
20  * included in all copies or substantial portions of the Software.
21  *
22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
23  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
25  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
26  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
27  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
28  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
29  */
30 
31 /*
32  * The text above constitutes the entire PortAudio license; however,
33  * the PortAudio community also makes the following non-binding requests:
34  *
35  * Any person wishing to distribute modifications to the Software is
36  * requested to send the modifications to the original developer so that
37  * they can be incorporated into the canonical version. It is also
38  * requested that these non-binding requests be included along with the
39  * license above.
40  */
41 
42 /** @file
43  * ALSA-specific PortAudio API extension header file.
44  */
45 #include "portaudio.h"
46 
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50 
51 typedef struct PaAlsaStreamInfo
52 {
53  unsigned long size;
54  PaHostApiTypeId hostApiType;
55  unsigned long version;
56 
57  const char *deviceString;
58 }
59 PaAlsaStreamInfo;
60 
61 /** Initialize host API specific structure, call this before setting relevant attributes. */
62 void PaAlsa_InitializeStreamInfo( PaAlsaStreamInfo *info );
63 
64 /** Instruct whether to enable real-time priority when starting the audio thread.
65  *
66  * If this is turned on by the stream is started, the audio callback thread will be created
67  * with the FIFO scheduling policy, which is suitable for realtime operation.
68  **/
69 void PaAlsa_EnableRealtimeScheduling( PaStream *s, int enable );
70 
71 #if 0
72 void PaAlsa_EnableWatchdog( PaStream *s, int enable );
73 #endif
74 
75 /** Get the ALSA-lib card index of this stream's input device. */
77 
78 /** Get the ALSA-lib card index of this stream's output device. */
80 
81 /** Set the number of periods (buffer fragments) to configure devices with.
82  *
83  * By default the number of periods is 4, this is the lowest number of periods that works well on
84  * the author's soundcard.
85  * @param numPeriods The number of periods.
86  */
87 PaError PaAlsa_SetNumPeriods( int numPeriods );
88 
89 #ifdef __cplusplus
90 }
91 #endif
92 
93 #endif
void PaStream
A single PaStream can provide multiple channels of real-time streaming audio input and output to a cl...
Definition: portaudio.h:579
void PaAlsa_InitializeStreamInfo(PaAlsaStreamInfo *info)
Initialize host API specific structure, call this before setting relevant attributes.
The PortAudio API.
void PaAlsa_EnableRealtimeScheduling(PaStream *s, int enable)
Instruct whether to enable real-time priority when starting the audio thread.
int PaError
Error codes returned by PortAudio functions.
Definition: portaudio.h:69
PaHostApiTypeId
Unchanging unique identifiers for each supported host API.
Definition: portaudio.h:223
PaError PaAlsa_SetNumPeriods(int numPeriods)
Set the number of periods (buffer fragments) to configure devices with.
PaError PaAlsa_GetStreamInputCard(PaStream *s, int *card)
Get the ALSA-lib card index of this stream's input device.
PaError PaAlsa_GetStreamOutputCard(PaStream *s, int *card)
Get the ALSA-lib card index of this stream's output device.