PipeWire  0.3.24
impl-device.h
Go to the documentation of this file.
1 /* PipeWire
2  *
3  * Copyright © 2018 Wim Taymans
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a
6  * copy of this software and associated documentation files (the "Software"),
7  * to deal in the Software without restriction, including without limitation
8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9  * and/or sell copies of the Software, and to permit persons to whom the
10  * Software is furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice (including the next
13  * paragraph) shall be included in all copies or substantial portions of the
14  * Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22  * DEALINGS IN THE SOFTWARE.
23  */
24 
25 #ifndef PIPEWIRE_IMPL_DEVICE_H
26 #define PIPEWIRE_IMPL_DEVICE_H
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
43 struct pw_impl_device;
44 
45 #include <spa/monitor/device.h>
46 
47 #include <pipewire/context.h>
48 #include <pipewire/global.h>
49 #include <pipewire/properties.h>
50 #include <pipewire/resource.h>
51 
54 #define PW_VERSION_IMPL_DEVICE_EVENTS 0
55  uint32_t version;
56 
58  void (*destroy) (void *data);
60  void (*free) (void *data);
62  void (*initialized) (void *data);
63 
65  void (*info_changed) (void *data, const struct pw_device_info *info);
66 };
67 
68 struct pw_impl_device *pw_context_create_device(struct pw_context *context,
69  struct pw_properties *properties,
70  size_t user_data_size);
71 
72 int pw_impl_device_register(struct pw_impl_device *device,
73  struct pw_properties *properties);
74 
75 void pw_impl_device_destroy(struct pw_impl_device *device);
76 
77 void *pw_impl_device_get_user_data(struct pw_impl_device *device);
78 
80 int pw_impl_device_set_implementation(struct pw_impl_device *device, struct spa_device *spa_device);
82 struct spa_device *pw_impl_device_get_implementation(struct pw_impl_device *device);
83 
85 struct pw_global *pw_impl_device_get_global(struct pw_impl_device *device);
86 
89  struct spa_hook *listener,
90  const struct pw_impl_device_events *events,
91  void *data);
92 
93 int pw_impl_device_update_properties(struct pw_impl_device *device, const struct spa_dict *dict);
94 
95 const struct pw_properties *pw_impl_device_get_properties(struct pw_impl_device *device);
96 
98  int seq, uint32_t param_id,
99  uint32_t index, uint32_t max,
100  const struct spa_pod *filter,
101  int (*callback) (void *data, int seq,
102  uint32_t id, uint32_t index, uint32_t next,
103  struct spa_pod *param),
104  void *data);
105 #ifdef __cplusplus
106 }
107 #endif
108 
109 #endif /* PIPEWIRE_IMPL_DEVICE_H */
A collection of key/value pairs.
Definition: properties.h:45
struct pw_impl_device * pw_context_create_device(struct pw_context *context, struct pw_properties *properties, size_t user_data_size)
Definition: impl-device.c:140
PipeWire device interface.
int pw_impl_device_update_properties(struct pw_impl_device *device, const struct spa_dict *dict)
Definition: impl-device.c:902
void(* free)(void *data)
the device is freed
Definition: impl-device.h:60
void(* destroy)(void *data)
the device is destroyed
Definition: impl-device.h:58
void pw_impl_device_add_listener(struct pw_impl_device *device, struct spa_hook *listener, const struct pw_impl_device_events *events, void *data)
Add an event listener.
Definition: impl-device.c:922
void * pw_impl_device_get_user_data(struct pw_impl_device *device)
Definition: impl-device.c:910
int pw_impl_device_for_each_param(struct pw_impl_device *device, int seq, uint32_t param_id, uint32_t index, uint32_t max, const struct spa_pod *filter, int(*callback)(void *data, int seq, uint32_t id, uint32_t index, uint32_t next, struct spa_pod *param), void *data)
Definition: impl-device.c:293
Device events, listen to them with pw_impl_device_add_listener.
Definition: impl-device.h:53
The device information.
Definition: device.h:43
void(* initialized)(void *data)
the device is initialized
Definition: impl-device.h:62
struct spa_device * pw_impl_device_get_implementation(struct pw_impl_device *device)
Get the device implementation.
Definition: impl-device.c:890
int pw_impl_device_set_implementation(struct pw_impl_device *device, struct spa_device *spa_device)
Set the device implementation.
Definition: impl-device.c:873
static uint32_t int seq
Definition: core.h:325
struct pw_global * pw_impl_device_get_global(struct pw_impl_device *device)
Get the global of this device.
Definition: impl-device.c:916
int pw_impl_device_register(struct pw_impl_device *device, struct pw_properties *properties)
Definition: impl-device.c:554
void pw_impl_device_destroy(struct pw_impl_device *device)
Definition: impl-device.c:194
Definition: filter.c:79
uint32_t version
Definition: impl-device.h:55
Definition: filter.c:116
A global object visible to remote clients.
the PipeWire context
void(* info_changed)(void *data, const struct pw_device_info *info)
the device info changed
Definition: impl-device.h:65
const struct pw_properties * pw_impl_device_get_properties(struct pw_impl_device *device)
Definition: impl-device.c:896
Definition: filter.c:74