← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/audacity/gutsy

« back to all changes in this revision

Viewing changes to lib-src/portaudio-v19/include/pa_asio.h

  • Committer: Bazaar Package Importer
  • Author(s): Free Ekanayaka
  • Date: 2007-05-17 02:36:41 UTC
  • mfrom: (1.2.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070517023641-5yjqt9434cbcb6ph
Tags: 1.3.2-4
* debian/patches:
   - desktop_file.patch: fixed broken Category entry
* debian/audacity.mime:
   - added entry for application/x-audacity-project

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib-src/portaudio-v19/include/pa_asio.h
 
1
#ifndef PA_ASIO_H
 
2
#define PA_ASIO_H
 
3
/*
 
4
 * $Id: pa_asio.h,v 1.2 2006/09/23 18:42:45 llucius Exp $
 
5
 * PortAudio Portable Real-Time Audio Library
 
6
 * ASIO specific extensions
 
7
 *
 
8
 * Copyright (c) 1999-2000 Ross Bencina and Phil Burk
 
9
 *
 
10
 * Permission is hereby granted, free of charge, to any person obtaining
 
11
 * a copy of this software and associated documentation files
 
12
 * (the "Software"), to deal in the Software without restriction,
 
13
 * including without limitation the rights to use, copy, modify, merge,
 
14
 * publish, distribute, sublicense, and/or sell copies of the Software,
 
15
 * and to permit persons to whom the Software is furnished to do so,
 
16
 * subject to the following conditions:
 
17
 *
 
18
 * The above copyright notice and this permission notice shall be
 
19
 * included in all copies or substantial portions of the Software.
 
20
 *
 
21
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 
22
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 
23
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 
24
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
 
25
 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
 
26
 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 
27
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
28
 */
 
29
 
 
30
/*
 
31
 * The text above constitutes the entire PortAudio license; however, 
 
32
 * the PortAudio community also makes the following non-binding requests:
 
33
 *
 
34
 * Any person wishing to distribute modifications to the Software is
 
35
 * requested to send the modifications to the original developer so that
 
36
 * they can be incorporated into the canonical version. It is also 
 
37
 * requested that these non-binding requests be included along with the 
 
38
 * license above.
 
39
 */
 
40
 
 
41
 
 
42
/** @file
 
43
 @brief ASIO-specific PortAudio API extension header file.
 
44
*/
 
45
 
 
46
 
 
47
#include "portaudio.h"
 
48
 
 
49
#ifdef __cplusplus
 
50
extern "C"
 
51
{
 
52
#endif /* __cplusplus */
 
53
 
 
54
 
 
55
/** Retrieve legal latency settings for the specificed device, in samples.
 
56
 
 
57
 @param device The global index of the device about which the query is being made.
 
58
 @param minLatency A pointer to the location which will recieve the minimum latency value.
 
59
 @param maxLatency A pointer to the location which will recieve the maximum latency value.
 
60
 @param preferredLatency A pointer to the location which will recieve the preferred latency value.
 
61
 @param granularity A pointer to the location which will recieve the granularity. This value 
 
62
 determines which values between minLatency and maxLatency are available. ie the step size,
 
63
 if granularity is -1 then available latency settings are powers of two.
 
64
 
 
65
 @see ASIOGetBufferSize in the ASIO SDK.
 
66
 
 
67
 @todo This function should have a better name, any suggestions?
 
68
*/
 
69
PaError PaAsio_GetAvailableLatencyValues( PaDeviceIndex device,
 
70
                long *minLatency, long *maxLatency, long *preferredLatency, long *granularity );
 
71
 
 
72
        
 
73
/** Display the ASIO control panel for the specified device.
 
74
 
 
75
  @param device The global index of the device whose control panel is to be displayed.
 
76
  @param systemSpecific On Windows, the calling application's main window handle,
 
77
  on Macintosh this value should be zero.
 
78
*/
 
79
PaError PaAsio_ShowControlPanel( PaDeviceIndex device, void* systemSpecific );
 
80
 
 
81
 
 
82
 
 
83
 
 
84
/** Retrieve a pointer to a string containing the name of the specified
 
85
 input channel. The string is valid until Pa_Terminate is called.
 
86
 
 
87
 The string will be no longer than 32 characters including the null terminator.
 
88
*/
 
89
PaError PaAsio_GetInputChannelName( PaDeviceIndex device, int channelIndex,
 
90
        const char** channelName );
 
91
 
 
92
        
 
93
/** Retrieve a pointer to a string containing the name of the specified
 
94
 input channel. The string is valid until Pa_Terminate is called.
 
95
 
 
96
 The string will be no longer than 32 characters including the null terminator.
 
97
*/
 
98
PaError PaAsio_GetOutputChannelName( PaDeviceIndex device, int channelIndex,
 
99
        const char** channelName );
 
100
 
 
101
 
 
102
#define paAsioUseChannelSelectors      (0x01)
 
103
 
 
104
typedef struct PaAsioStreamInfo{
 
105
    unsigned long size;             /**< sizeof(PaAsioStreamInfo) */
 
106
    PaHostApiTypeId hostApiType;    /**< paASIO */
 
107
    unsigned long version;          /**< 1 */
 
108
 
 
109
    unsigned long flags;
 
110
 
 
111
    /* Support for opening only specific channels of an ASIO device.
 
112
        If the paAsioUseChannelSelectors flag is set, channelSelectors is a
 
113
        pointer to an array of integers specifying the device channels to use.
 
114
        When used, the length of the channelSelectors array must match the
 
115
        corresponding channelCount parameter to Pa_OpenStream() otherwise a
 
116
        crash may result.
 
117
        The values in the selectors array must specify channels within the
 
118
        range of supported channels for the device or paInvalidChannelCount will
 
119
        result.
 
120
    */
 
121
    int *channelSelectors;
 
122
}PaAsioStreamInfo;
 
123
 
 
124
 
 
125
#ifdef __cplusplus
 
126
}
 
127
#endif /* __cplusplus */
 
128
 
 
129
#endif /* PA_ASIO_H */