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