-
Notifications
You must be signed in to change notification settings - Fork 673
/
audio_pipeline.h
488 lines (444 loc) · 17.1 KB
/
audio_pipeline.h
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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
/*
* ESPRESSIF MIT License
*
* Copyright (c) 2018 <ESPRESSIF SYSTEMS (SHANGHAI) PTE LTD>
*
* Permission is hereby granted for use on all ESPRESSIF SYSTEMS products, in which case,
* it is free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the Software is furnished
* to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or
* substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
*/
#ifndef _AUDIO_PIPELINE_H_
#define _AUDIO_PIPELINE_H_
#include "audio_element.h"
#ifdef __cplusplus
extern "C" {
#endif
typedef struct audio_pipeline *audio_pipeline_handle_t;
/**
* @brief Audio Pipeline configurations
*/
typedef struct audio_pipeline_cfg {
int rb_size; /*!< Audio Pipeline ringbuffer size */
} audio_pipeline_cfg_t;
#define DEFAULT_PIPELINE_RINGBUF_SIZE (8*1024)
#define DEFAULT_AUDIO_PIPELINE_CONFIG() {\
.rb_size = DEFAULT_PIPELINE_RINGBUF_SIZE,\
}
/**
* @brief Initialize audio_pipeline_handle_t object
* audio_pipeline is responsible for controlling the audio data stream and connecting the audio elements with the ringbuffer
* It will connect and start the audio element in order, responsible for retrieving the data from the previous element
* and passing it to the element after it. Also get events from each element, process events or pass it to a higher layer
*
* @param config The configuration - audio_pipeline_cfg_t
*
* @return
* - audio_pipeline_handle_t on success
* - NULL when any errors
*/
audio_pipeline_handle_t audio_pipeline_init(audio_pipeline_cfg_t *config);
/**
* @brief This function removes all of the element's links in audio_pipeline,
* cancels the registration of all events, invokes the destroy functions of the registered elements,
* and frees the memory allocated by the init function.
* Briefly, frees all memory
*
* @param[in] pipeline The Audio Pipeline Handle
*
* @return ESP_OK
*/
esp_err_t audio_pipeline_deinit(audio_pipeline_handle_t pipeline);
/**
* @brief Registering an element for audio_pipeline, each element can be registered multiple times,
* but `name` (as String) must be unique in audio_pipeline,
* which is used to identify the element for link creation mentioned in the `audio_pipeline_link`
*
* @note Because of stop pipeline or pause pipeline depend much on register order.
* Please register element strictly in the following order: input element first, process middle, output element last.
*
* @param[in] pipeline The Audio Pipeline Handle
* @param[in] el The Audio Element Handle
* @param[in] name The name identifier of the audio_element in this audio_pipeline
*
* @return
* - ESP_OK on success
* - ESP_FAIL when any errors
*/
esp_err_t audio_pipeline_register(audio_pipeline_handle_t pipeline, audio_element_handle_t el, const char *name);
/**
* @brief Unregister the audio_element in audio_pipeline, remove it from the list
*
* @param[in] pipeline The Audio Pipeline Handle
* @param[in] el The Audio Element Handle
*
* @return
* - ESP_OK on success
* - ESP_FAIL when any errors
*/
esp_err_t audio_pipeline_unregister(audio_pipeline_handle_t pipeline, audio_element_handle_t el);
/**
* @brief Start Audio Pipeline.
*
* With this function audio_pipeline will create tasks for all elements,
* that have been linked using the linking functions.
*
* @param[in] pipeline The Audio Pipeline Handle
*
* @return
* - ESP_OK on success
* - ESP_FAIL when any errors
*/
esp_err_t audio_pipeline_run(audio_pipeline_handle_t pipeline);
/**
* @brief Stop Audio Pipeline.
*
* With this function audio_pipeline will destroy tasks of all elements,
* that have been linked using the linking functions.
*
* @param[in] pipeline The Audio Pipeline Handle
*
* @return
* - ESP_OK on success
* - ESP_FAIL when any errors
*/
esp_err_t audio_pipeline_terminate(audio_pipeline_handle_t pipeline);
/**
* @brief Stop Audio Pipeline with specific ticks for timeout
*
* With this function audio_pipeline will destroy tasks of all elements,
* that have been linked using the linking functions.
*
* @param[in] pipeline The Audio Pipeline Handle
* @param[in] ticks_to_wait The maximum amount of time to block wait for element destroy
*
* @return
* - ESP_OK
* - ESP_FAIL
*/
esp_err_t audio_pipeline_terminate_with_ticks(audio_pipeline_handle_t pipeline, TickType_t ticks_to_wait);
/**
* @brief This function will set all the elements to the `RUNNING` state and process the audio data as an inherent feature of audio_pipeline.
*
* @param[in] pipeline The Audio Pipeline Handle
*
* @return
* - ESP_OK on success
* - ESP_FAIL when any errors
*/
esp_err_t audio_pipeline_resume(audio_pipeline_handle_t pipeline);
/**
* @brief This function will set all the elements to the `PAUSED` state. Everything remains the same except the data processing is stopped
*
* @param[in] pipeline The Audio Pipeline Handle
*
* @return
* - ESP_OK on success
* - ESP_FAIL when any errors
*/
esp_err_t audio_pipeline_pause(audio_pipeline_handle_t pipeline);
/**
* @brief Stop all of the linked elements. Used with `audio_pipeline_wait_for_stop` to keep in sync.
* The link state of the elements in the pipeline is kept, events are still registered.
* The stopped audio_pipeline restart by `audio_pipeline_resume`.
*
* @param[in] pipeline The Audio Pipeline Handle
*
* @return
* - ESP_OK on success
* - ESP_FAIL when any errors
*/
esp_err_t audio_pipeline_stop(audio_pipeline_handle_t pipeline);
/**
* @brief The `audio_pipeline_stop` function sends requests to the elements and exits.
* But they need time to get rid of time-blocking tasks.
* This function will wait `portMAX_DELAY` until all the Elements in the pipeline actually stop
*
* @param[in] pipeline The Audio Pipeline Handle
*
* @return
* - ESP_OK on success
* - ESP_FAIL when any errors
*/
esp_err_t audio_pipeline_wait_for_stop(audio_pipeline_handle_t pipeline);
/**
* @brief The `audio_pipeline_stop` function sends requests to the elements and exits.
* But they need time to get rid of time-blocking tasks.
* This function will wait `ticks_to_wait` until all the Elements in the pipeline actually stop
*
* @param[in] pipeline The Audio Pipeline Handle
* @param[in] ticks_to_wait The maximum amount of time to block wait for stop
*
* @return
* - ESP_OK on success
* - ESP_FAIL when any errors
*/
esp_err_t audio_pipeline_wait_for_stop_with_ticks(audio_pipeline_handle_t pipeline, TickType_t ticks_to_wait);
/**
* @brief The audio_element added to audio_pipeline will be unconnected before it is called by this function.
* Based on element's `name` already registered by `audio_pipeline_register`, the path of the data will be linked in the order of the link_tag.
* Element at index 0 is first, and index `link_num -1` is final.
* As well as audio_pipeline will subscribe all element's events
*
* @param[in] pipeline The Audio Pipeline Handle
* @param link_tag Array of element `name` was registered by `audio_pipeline_register`
* @param[in] link_num Total number of elements of the `link_tag` array
*
* @return
* - ESP_OK on success
* - ESP_FAIL when any errors
*/
esp_err_t audio_pipeline_link(audio_pipeline_handle_t pipeline, const char *link_tag[], int link_num);
/**
* @brief Removes the connection of the elements, as well as unsubscribe events
*
* @param[in] pipeline The Audio Pipeline Handle
*
* @return
* - ESP_OK on success
* - ESP_FAIL when any errors
*/
esp_err_t audio_pipeline_unlink(audio_pipeline_handle_t pipeline);
/**
* @brief Find un-kept element from registered pipeline by tag
*
* @param[in] pipeline The Audio Pipeline Handle
* @param[in] tag A char pointer
*
* @return
* - NULL when any errors
* - Others on success
*/
audio_element_handle_t audio_pipeline_get_el_by_tag(audio_pipeline_handle_t pipeline, const char *tag);
/**
* @brief Based on beginning element to find un-kept element from registered pipeline by tag
*
* @param[in] pipeline The Audio Pipeline Handle
* @param[in] start_el Specific beginning element
* @param[in] tag A char pointer
*
* @return
* - NULL when any errors
* - Others on success
*/
audio_element_handle_t audio_pipeline_get_el_once(audio_pipeline_handle_t pipeline, const audio_element_handle_t start_el, const char *tag);
/**
* @brief Remove event listener from this audio_pipeline
*
* @param[in] pipeline The Audio Pipeline Handle
*
* @return
* - ESP_OK on success
* - ESP_FAIL when any errors
*/
esp_err_t audio_pipeline_remove_listener(audio_pipeline_handle_t pipeline);
/**
* @brief Set event listner for this audio_pipeline, any event from this pipeline can be listen to by `evt`
*
* @param[in] pipeline The Audio Pipeline Handle
* @param[in] evt The Event Handle
*
* @return
* - ESP_OK on success
* - ESP_FAIL when any errors
*/
esp_err_t audio_pipeline_set_listener(audio_pipeline_handle_t pipeline, audio_event_iface_handle_t evt);
/**
* @brief Get the event iface using by this pipeline
*
* @param[in] pipeline The pipeline
*
* @return The Event Handle
*/
audio_event_iface_handle_t audio_pipeline_get_event_iface(audio_pipeline_handle_t pipeline);
/**
* @brief Insert the specific audio_element to audio_pipeline, previous element connect to the next element by ring buffer.
*
* @param[in] pipeline The audio pipeline handle
* @param[in] first Previous element is first input element, need to set `true`
* @param[in] prev Previous element
* @param[in] conect_rb Connect ring buffer
* @param[in] next Next element
*
* @return
* - ESP_OK
* - ESP_FAIL
*/
esp_err_t audio_pipeline_link_insert(audio_pipeline_handle_t pipeline, bool first, audio_element_handle_t prev,
ringbuf_handle_t conect_rb, audio_element_handle_t next);
/**
* @brief Register a NULL-terminated list of elements to audio_pipeline.
*
* @param[in] pipeline The audio pipeline handle
* @param[in] element_1 The element to add to the audio_pipeline.
* @param[in] ... Additional elements to add to the audio_pipeline.
*
* @return
* - ESP_OK
* - ESP_FAIL
*/
esp_err_t audio_pipeline_register_more(audio_pipeline_handle_t pipeline, audio_element_handle_t element_1, ...);
/**
* @brief Unregister a NULL-terminated list of elements to audio_pipeline.
*
* @param[in] pipeline The audio pipeline handle
* @param[in] element_1 The element to add to the audio_pipeline.
* @param[in] ... Additional elements to add to the audio_pipeline.
*
* @return
* - ESP_OK
* - ESP_FAIL
*/
esp_err_t audio_pipeline_unregister_more(audio_pipeline_handle_t pipeline, audio_element_handle_t element_1, ...);
/**
* @brief Adds a NULL-terminated list of elements to audio_pipeline.
*
* @param[in] pipeline The audio pipeline handle
* @param[in] element_1 The element to add to the audio_pipeline.
* @param[in] ... Additional elements to add to the audio_pipeline.
*
* @return
* - ESP_OK
* - ESP_FAIL
*/
esp_err_t audio_pipeline_link_more(audio_pipeline_handle_t pipeline, audio_element_handle_t element_1, ...);
/**
* @brief Subscribe a NULL-terminated list of element's events to audio_pipeline.
*
* @param[in] pipeline The audio pipeline handle
* @param[in] element_1 The element event to subscribe to the audio_pipeline.
* @param[in] ... Additional elements event to subscribe to the audio_pipeline.
*
* @return
* - ESP_OK
* - ESP_FAIL
*/
esp_err_t audio_pipeline_listen_more(audio_pipeline_handle_t pipeline, audio_element_handle_t element_1, ...);
/**
* @brief Update the destination element state and check the all of linked elements state are same.
*
* @param[in] pipeline The audio pipeline handle
* @param[in] dest_el Destination element
* @param[in] status The new status
*
* @return
* - ESP_OK All linked elements state are same.
* - ESP_FAIL All linked elements state are not same.
*/
esp_err_t audio_pipeline_check_items_state(audio_pipeline_handle_t pipeline, audio_element_handle_t dest_el, audio_element_status_t status);
/**
* @brief Reset pipeline element items state to `AEL_STATUS_NONE`
*
* @param[in] pipeline The Audio Pipeline Handle
*
* @return
* - ESP_OK on success
* - ESP_FAIL when any errors
*/
esp_err_t audio_pipeline_reset_items_state(audio_pipeline_handle_t pipeline);
/**
* @brief Reset pipeline element ringbuffer
*
* @param[in] pipeline The Audio Pipeline Handle
*
* @return
* - ESP_OK on success
* - ESP_FAIL when any errors
*/
esp_err_t audio_pipeline_reset_ringbuffer(audio_pipeline_handle_t pipeline);
/**
* @brief Reset Pipeline linked elements state
*
* @param[in] pipeline The Audio Pipeline Handle
*
* @return
* - ESP_OK on success
* - ESP_FAIL when any errors
*/
esp_err_t audio_pipeline_reset_elements(audio_pipeline_handle_t pipeline);
/**
* @brief Reset the specific element kept state
*
* @param[in] pipeline The Audio Pipeline Handle
* @param[in] el The Audio element Handle
*
* @return
* - ESP_OK on success
* - ESP_FAIL when any errors
*/
esp_err_t audio_pipeline_reset_kept_state(audio_pipeline_handle_t pipeline, audio_element_handle_t el);
/**
* @brief Break up all the linked elements of specific `pipeline`.
* The include and before `kept_ctx_el` working (AEL_STATE_RUNNING or AEL_STATE_PAUSED) elements
* and connected ringbuffer will be reserved.
*
* @note There is no element reserved when `kept_ctx_el` is NULL.
* This function will unsubscribe all element's events.
*
* @param[in] pipeline The audio pipeline handle
* @param[in] kept_ctx_el Destination keep elements
*
* @return
* - ESP_OK All linked elements state are same.
* - ESP_ERR_INVALID_ARG Invalid parameters.
*/
esp_err_t audio_pipeline_breakup_elements(audio_pipeline_handle_t pipeline, audio_element_handle_t kept_ctx_el);
/**
* @brief Basing on element's `name` already registered by `audio_pipeline_register`,
* relink the pipeline following the order of `names` in the `link_tag.
*
* @note If the ringbuffer is not enough to connect the new pipeline will create new ringbuffer.
*
* @param[in] pipeline The Audio Pipeline Handle
* @param link_tag Array of elements `name` that was registered by `audio_pipeline_register`
* @param[in] link_num Total number of elements of the `link_tag` array
*
* @return
* - ESP_OK All linked elements state are same.
* - ESP_FAIL Error.
* - ESP_ERR_INVALID_ARG Invalid parameters.
*/
esp_err_t audio_pipeline_relink(audio_pipeline_handle_t pipeline, const char *link_tag[], int link_num);
/**
* @brief Adds a NULL-terminated list of elements to audio_pipeline.
*
* @note If the ringbuffer is not enough to connect the new pipeline will create new ringbuffer.
*
* @param[in] pipeline The Audio Pipeline Handle
* @param[in] element_1 The element to add to the audio_pipeline.
* @param[in] ... Additional elements to add to the audio_pipeline.
*
* @return
* - ESP_OK All linked elements state are same.
* - ESP_FAIL Error.
* - ESP_ERR_INVALID_ARG Invalid parameters.
*/
esp_err_t audio_pipeline_relink_more(audio_pipeline_handle_t pipeline, audio_element_handle_t element_1, ...);
/**
* @brief Set the pipeline state.
*
* @param[in] pipeline The Audio Pipeline Handle
* @param[in] new_state The new state will be set
*
* @return
* - ESP_OK All linked elements state are same.
* - ESP_FAIL Error.
*/
esp_err_t audio_pipeline_change_state(audio_pipeline_handle_t pipeline, audio_element_state_t new_state);
#ifdef __cplusplus
}
#endif
#endif /* _AUDIO_PIPELINE_H_ */