PipeWire  0.3.66
aec.h
1 /* PipeWire */
2 /* SPDX-FileCopyrightText: Copyright © 2021 Wim Taymans <wim.taymans@gmail.com> */
3 /* SPDX-License-Identifier: MIT */
4 
5 #include <spa/pod/builder.h>
6 #include <spa/utils/dict.h>
7 #include <spa/utils/hook.h>
8 #include <spa/param/audio/raw.h>
9 
10 #ifndef SPA_AUDIO_AEC_H
11 #define SPA_AUDIO_AEC_H
12 
13 #ifdef __cplusplus
14 extern "C" {
15 #endif
16 
17 #define SPA_TYPE_INTERFACE_AUDIO_AEC SPA_TYPE_INFO_INTERFACE_BASE "Audio:AEC"
18 
19 #define SPA_VERSION_AUDIO_AEC 1
20 struct spa_audio_aec {
21  struct spa_interface iface;
22  const char *name;
23  const struct spa_dict *info;
24  const char *latency;
25 };
26 
27 struct spa_audio_aec_info {
28 #define SPA_AUDIO_AEC_CHANGE_MASK_PROPS (1u<<0)
29  uint64_t change_mask;
30 
31  const struct spa_dict *props;
32 };
33 
34 struct spa_audio_aec_events {
35 #define SPA_VERSION_AUDIO_AEC_EVENTS 0
36  uint32_t version;
39  void (*info) (void *data, const struct spa_audio_aec_info *info);
40 };
41 
42 struct spa_audio_aec_methods {
43 #define SPA_VERSION_AUDIO_AEC_METHODS 2
44  uint32_t version;
45 
46  int (*add_listener) (void *object,
47  struct spa_hook *listener,
48  const struct spa_audio_aec_events *events,
49  void *data);
50 
51  int (*init) (void *object, const struct spa_dict *args, const struct spa_audio_info_raw *info);
52  int (*run) (void *object, const float *rec[], const float *play[], float *out[], uint32_t n_samples);
53  int (*set_props) (void *object, const struct spa_dict *args);
54  /* since 0.3.58, version 1:1 */
55  int (*activate) (void *object);
56  /* since 0.3.58, version 1:1 */
57  int (*deactivate) (void *object);
58 
59  /* version 1:2 */
60  int (*enum_props) (void* object, int index, struct spa_pod_builder* builder);
61  int (*get_params) (void* object, struct spa_pod_builder* builder);
62  int (*set_params) (void *object, const struct spa_pod *args);
63 };
64 
65 #define spa_audio_aec_method(o,method,version,...) \
66 ({ \
67  int _res = -ENOTSUP; \
68  struct spa_audio_aec *_o = (o); \
69  spa_interface_call_res(&_o->iface, \
70  struct spa_audio_aec_methods, _res, \
71  method, (version), ##__VA_ARGS__); \
72  _res; \
73 })
74 
75 #define spa_audio_aec_add_listener(o,...) spa_audio_aec_method(o, add_listener, 0, __VA_ARGS__)
76 #define spa_audio_aec_init(o,...) spa_audio_aec_method(o, init, 0, __VA_ARGS__)
77 #define spa_audio_aec_run(o,...) spa_audio_aec_method(o, run, 0, __VA_ARGS__)
78 #define spa_audio_aec_set_props(o,...) spa_audio_aec_method(o, set_props, 0, __VA_ARGS__)
79 #define spa_audio_aec_activate(o) spa_audio_aec_method(o, activate, 1)
80 #define spa_audio_aec_deactivate(o) spa_audio_aec_method(o, deactivate, 1)
81 #define spa_audio_aec_enum_props(o,...) spa_audio_aec_method(o, enum_props, 2, __VA_ARGS__)
82 #define spa_audio_aec_get_params(o,...) spa_audio_aec_method(o, get_params, 2, __VA_ARGS__)
83 #define spa_audio_aec_set_params(o,...) spa_audio_aec_method(o, set_params, 2, __VA_ARGS__)
84 
85 #ifdef __cplusplus
86 } /* extern "C" */
87 #endif
88 
89 #endif /* SPA_AUDIO_AEC_H */
spa/param/audio/raw.h
spa/pod/builder.h
spa/utils/hook.h
Definition: aec.h:41
void(* info)(void *data, const struct spa_audio_aec_info *info)
Emitted when info changes.
Definition: aec.h:47
uint32_t version
version of this structure
Definition: aec.h:44
Definition: aec.h:33
uint64_t change_mask
Definition: aec.h:36
Definition: aec.h:50
int(* get_params)(void *object, struct spa_pod_builder *builder)
Definition: aec.h:70
int(* add_listener)(void *object, struct spa_hook *listener, const struct spa_audio_aec_events *events, void *data)
Definition: aec.h:55
int(* set_props)(void *object, const struct spa_dict *args)
Definition: aec.h:62
int(* deactivate)(void *object)
Definition: aec.h:66
int(* activate)(void *object)
Definition: aec.h:64
int(* enum_props)(void *object, int index, struct spa_pod_builder *builder)
Definition: aec.h:69
int(* run)(void *object, const float *rec[], const float *play[], float *out[], uint32_t n_samples)
Definition: aec.h:61
int(* set_params)(void *object, const struct spa_pod *args)
Definition: aec.h:71
int(* init)(void *object, const struct spa_dict *args, const struct spa_audio_info_raw *info)
Definition: aec.h:60
Definition: aec.h:26
const struct spa_dict * info
Definition: aec.h:29
const char * latency
Definition: aec.h:30
struct spa_interface iface
Definition: aec.h:27
Audio information description.
Definition: audio/raw.h:278
Definition: utils/dict.h:39
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:331
Definition: hook.h:138
Definition: builder.h:53
Definition: pod/pod.h:43
spa/utils/dict.h