1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
/* Copyright (c) 2012 The Chromium Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
/* From dev/ppb_audio_input_dev.idl modified Tue Dec 04 15:13:31 2012. */
#ifndef PPAPI_C_DEV_PPB_AUDIO_INPUT_DEV_H_
#define PPAPI_C_DEV_PPB_AUDIO_INPUT_DEV_H_
#include "ppapi/c/dev/ppb_device_ref_dev.h"
#include "ppapi/c/pp_array_output.h"
#include "ppapi/c/pp_bool.h"
#include "ppapi/c/pp_completion_callback.h"
#include "ppapi/c/pp_instance.h"
#include "ppapi/c/pp_macros.h"
#include "ppapi/c/pp_resource.h"
#include "ppapi/c/pp_stdint.h"
#define PPB_AUDIO_INPUT_DEV_INTERFACE_0_2 "PPB_AudioInput(Dev);0.2"
#define PPB_AUDIO_INPUT_DEV_INTERFACE_0_3 "PPB_AudioInput(Dev);0.3"
#define PPB_AUDIO_INPUT_DEV_INTERFACE PPB_AUDIO_INPUT_DEV_INTERFACE_0_3
/**
* @file
* This file defines the <code>PPB_AudioInput_Dev</code> interface, which
* provides realtime audio input capture.
*/
/**
* @addtogroup Typedefs
* @{
*/
/**
* <code>PPB_AudioInput_Callback</code> defines the type of an audio callback
* function used to provide the audio buffer with data. This callback will be
* called on a separate thread from the creation thread.
*/
typedef void (*PPB_AudioInput_Callback)(const void* sample_buffer,
uint32_t buffer_size_in_bytes,
void* user_data);
/**
* @}
*/
/**
* @addtogroup Interfaces
* @{
*/
/**
* The <code>PPB_AudioInput_Dev</code> interface contains pointers to several
* functions for handling audio input resources.
*
* TODO(brettw) before moving out of dev, we need to resolve the issue of
* the mismatch between the current audio config interface and this one.
*
* In particular, the params for input assume stereo, but this class takes
* everything as mono. We either need to not use an audio config resource, or
* add mono support.
*
* In addition, RecommendSampleFrameCount is completely wrong for audio input.
* RecommendSampleFrameCount returns the frame count for the current
* low-latency output device, which is likely inappropriate for a random input
* device. We may want to move the "recommend" functions to the input or output
* classes rather than the config.
*/
struct PPB_AudioInput_Dev_0_3 {
/**
* Creates an audio input resource.
*
* @param[in] instance A <code>PP_Instance</code> identifying one instance of
* a module.
*
* @return A <code>PP_Resource</code> corresponding to an audio input resource
* if successful, 0 if failed.
*/
PP_Resource (*Create)(PP_Instance instance);
/**
* Determines if the given resource is an audio input resource.
*
* @param[in] resource A <code>PP_Resource</code> containing a resource.
*
* @return A <code>PP_Bool</code> containing <code>PP_TRUE</code> if the given
* resource is an audio input resource, otherwise <code>PP_FALSE</code>.
*/
PP_Bool (*IsAudioInput)(PP_Resource resource);
/**
* Enumerates audio input devices.
*
* @param[in] audio_input A <code>PP_Resource</code> corresponding to an audio
* input resource.
* @param[in] output An output array which will receive
* <code>PPB_DeviceRef_Dev</code> resources on success. Please note that the
* ref count of those resources has already been increased by 1 for the
* caller.
* @param[in] callback A <code>PP_CompletionCallback</code> to run on
* completion.
*
* @return An error code from <code>pp_errors.h</code>.
*/
int32_t (*EnumerateDevices)(PP_Resource audio_input,
struct PP_ArrayOutput output,
struct PP_CompletionCallback callback);
/**
* Requests device change notifications.
*
* @param[in] audio_input A <code>PP_Resource</code> corresponding to an audio
* input resource.
* @param[in] callback The callback to receive notifications. If not NULL, it
* will be called once for the currently available devices, and then every
* time the list of available devices changes. All calls will happen on the
* same thread as the one on which MonitorDeviceChange() is called. It will
* receive notifications until <code>audio_input</code> is destroyed or
* <code>MonitorDeviceChange()</code> is called to set a new callback for
* <code>audio_input</code>. You can pass NULL to cancel sending
* notifications.
* @param[inout] user_data An opaque pointer that will be passed to
* <code>callback</code>.
*
* @return An error code from <code>pp_errors.h</code>.
*/
int32_t (*MonitorDeviceChange)(PP_Resource audio_input,
PP_MonitorDeviceChangeCallback callback,
void* user_data);
/**
* Opens an audio input device. No sound will be captured until
* StartCapture() is called.
*
* @param[in] audio_input A <code>PP_Resource</code> corresponding to an audio
* input resource.
* @param[in] device_ref Identifies an audio input device. It could be one of
* the resource in the array returned by EnumerateDevices(), or 0 which means
* the default device.
* @param[in] config A <code>PPB_AudioConfig</code> audio configuration
* resource.
* @param[in] audio_input_callback A <code>PPB_AudioInput_Callback</code>
* function that will be called when data is available.
* @param[inout] user_data An opaque pointer that will be passed into
* <code>audio_input_callback</code>.
* @param[in] callback A <code>PP_CompletionCallback</code> to run when this
* open operation is completed.
*
* @return An error code from <code>pp_errors.h</code>.
*/
int32_t (*Open)(PP_Resource audio_input,
PP_Resource device_ref,
PP_Resource config,
PPB_AudioInput_Callback audio_input_callback,
void* user_data,
struct PP_CompletionCallback callback);
/**
* Returns an audio config resource for the given audio input resource.
*
* @param[in] audio_input A <code>PP_Resource</code> corresponding to an audio
* input resource.
*
* @return A <code>PP_Resource</code> containing the audio config resource if
* successful.
*/
PP_Resource (*GetCurrentConfig)(PP_Resource audio_input);
/**
* Starts the capture of the audio input resource and begins periodically
* calling the callback.
*
* @param[in] audio_input A <code>PP_Resource</code> corresponding to an audio
* input resource.
*
* @return A <code>PP_Bool</code> containing <code>PP_TRUE</code> if
* successful, otherwise <code>PP_FALSE</code>.
* Also returns <code>PP_TRUE</code> (and is a no-op) if called while capture
* is already started.
*/
PP_Bool (*StartCapture)(PP_Resource audio_input);
/**
* Stops the capture of the audio input resource.
*
* @param[in] audio_input A PP_Resource containing the audio input resource.
*
* @return A <code>PP_Bool</code> containing <code>PP_TRUE</code> if
* successful, otherwise <code>PP_FALSE</code>.
* Also returns <code>PP_TRUE</code> (and is a no-op) if called while capture
* is already stopped. If a buffer is being captured, StopCapture will block
* until the call completes.
*/
PP_Bool (*StopCapture)(PP_Resource audio_input);
/**
* Closes the audio input device, and stops capturing if necessary. It is
* not valid to call Open() again after a call to this method.
* If an audio input resource is destroyed while a device is still open, then
* it will be implicitly closed, so you are not required to call this method.
*
* @param[in] audio_input A <code>PP_Resource</code> corresponding to an audio
* input resource.
*/
void (*Close)(PP_Resource audio_input);
};
typedef struct PPB_AudioInput_Dev_0_3 PPB_AudioInput_Dev;
struct PPB_AudioInput_Dev_0_2 {
PP_Resource (*Create)(PP_Instance instance);
PP_Bool (*IsAudioInput)(PP_Resource resource);
int32_t (*EnumerateDevices)(PP_Resource audio_input,
PP_Resource* devices,
struct PP_CompletionCallback callback);
int32_t (*Open)(PP_Resource audio_input,
PP_Resource device_ref,
PP_Resource config,
PPB_AudioInput_Callback audio_input_callback,
void* user_data,
struct PP_CompletionCallback callback);
PP_Resource (*GetCurrentConfig)(PP_Resource audio_input);
PP_Bool (*StartCapture)(PP_Resource audio_input);
PP_Bool (*StopCapture)(PP_Resource audio_input);
void (*Close)(PP_Resource audio_input);
};
/**
* @}
*/
#endif /* PPAPI_C_DEV_PPB_AUDIO_INPUT_DEV_H_ */
|
