mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-15 07:00:05 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
pipewire/spa/include/spa/monitor/device.h

308 lines
11 KiB
C
Raw Normal View History

device: add device object Make a device object, let the v4l2 monitor create device objects The device object is responsible for dynamically creating nodes.
2018-11-23 12:43:47 +01:00
/* Simple Plugin API
*
* Copyright © 2018 Wim Taymans
*
* Permission is hereby granted, 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 (including the next
* paragraph) 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.
*/
Don't use __ in defines or declarations, it's reserved SPA_TYPE -> SPA_TYPE_INFO for type info strings improve includes Fixes #115
2019-01-14 12:58:23 +01:00
#ifndef SPA_DEVICE_H
#define SPA_DEVICE_H
device: add device object Make a device object, let the v4l2 monitor create device objects The device object is responsible for dynamically creating nodes.
2018-11-23 12:43:47 +01:00
#ifdef __cplusplus
extern "C" {
#endif
#include <spa/utils/defs.h>
fix includes
2019-10-25 15:01:02 +02:00
#include <spa/utils/hook.h>
device: add device object Make a device object, let the v4l2 monitor create device objects The device object is responsible for dynamically creating nodes.
2018-11-23 12:43:47 +01:00
#include <spa/utils/dict.h>
monitor: remove enum_items Make the monitor and device emit the info and items when the callbacks are set. This makes it easier to implement the monitor because there is much less state to keep around and invalidate etc. Rework the monitors Add bluez5 device
2018-11-26 12:18:53 +01:00
#include <spa/pod/event.h>
device: add device object Make a device object, let the v4l2 monitor create device objects The device object is responsible for dynamically creating nodes.
2018-11-23 12:43:47 +01:00
interface: add an interface struct The interface struct has the type,version and methods of the interface. Make spa interfaces extend from spa_interface and make a separate structure for the methods. Pass a generic void* as the first argument of methods, like we don in PipeWire. Bundle the methods + implementation in a versioned inteface and use that to invoke methods. This way we can do version checks on the methods. Make resource and proxy interfaces that we can can call. We can then make the core interfaces independent on proxy/resource and hide them in the lower layers. Add add_listener method to methods of core interfaces, just like SPA.
2019-05-20 16:11:23 +02:00
/**
doc: reorganize Doxygen groups/modules to make more sense The Doxygen "Modules" page is not very illuminative, as different parts of the API are mixed together and not all parts are included. Try to address this: Put all parts of the public API to some Doxygen group, usually one group per header file. Use short, systematic names. Make these groups sub-groups of a few top-level groups, roughly corresponding to the different logical parts of the API (core, impl, stream, filter, spa, utilities).
2021-10-02 20:55:53 +03:00
* \defgroup spa_device Device
interface: add an interface struct The interface struct has the type,version and methods of the interface. Make spa interfaces extend from spa_interface and make a separate structure for the methods. Pass a generic void* as the first argument of methods, like we don in PipeWire. Bundle the methods + implementation in a versioned inteface and use that to invoke methods. This way we can do version checks on the methods. Make resource and proxy interfaces that we can can call. We can then make the core interfaces independent on proxy/resource and hide them in the lower layers. Add add_listener method to methods of core interfaces, just like SPA.
2019-05-20 16:11:23 +02:00
*
add some docs
2019-10-25 15:01:27 +02:00
* The device interface can be used to monitor all kinds of devices
* and create objects as a result. Objects a typically other
* Devices or Nodes.
*
interface: add an interface struct The interface struct has the type,version and methods of the interface. Make spa interfaces extend from spa_interface and make a separate structure for the methods. Pass a generic void* as the first argument of methods, like we don in PipeWire. Bundle the methods + implementation in a versioned inteface and use that to invoke methods. This way we can do version checks on the methods. Make resource and proxy interfaces that we can can call. We can then make the core interfaces independent on proxy/resource and hide them in the lower layers. Add add_listener method to methods of core interfaces, just like SPA.
2019-05-20 16:11:23 +02:00
*/
spa: group the spa headers into doxygen modules Subdirectories buffer, control, debug, monitor, pod, support and utils, others are still missing. Headers are grouped either per subdirectory (e.g. buffer/ gets added to group spa_buffer) or per-file (e.g. spa_json is a separate group), whatever seemed like the most sensible approach.
2021-05-21 14:03:07 +10:00
/**
* \addtogroup spa_device
* \{
*/
Make interface types a string This is more in line with wayland and it allows us to create new interfaces in modules without having to add anything to the type enum. It also removes some lookups to map type_id to readable name in debug.
2019-12-19 13:15:10 +01:00
#define SPA_TYPE_INTERFACE_Device SPA_TYPE_INFO_INTERFACE_BASE "Device"
#define SPA_VERSION_DEVICE 0
interface: add an interface struct The interface struct has the type,version and methods of the interface. Make spa interfaces extend from spa_interface and make a separate structure for the methods. Pass a generic void* as the first argument of methods, like we don in PipeWire. Bundle the methods + implementation in a versioned inteface and use that to invoke methods. This way we can do version checks on the methods. Make resource and proxy interfaces that we can can call. We can then make the core interfaces independent on proxy/resource and hide them in the lower layers. Add add_listener method to methods of core interfaces, just like SPA.
2019-05-20 16:11:23 +02:00
struct spa_device { struct spa_interface iface; };
add some docs
2019-10-25 15:01:27 +02:00
/**
* Information about the device and parameters it supports
*
* This information is part of the info event on a device.
*/
device: improve callbacks Pass info structures to device callbacks to make it more extensible. Also notify about the supported params on the device because we can.
2019-02-13 11:13:46 +01:00
struct spa_device_info {
#define SPA_VERSION_DEVICE_INFO 0
uint32_t version;
node: make add_listener method Make struct spa_node_events for events emited from the main thread and keep the spa_node_callbacks for the data thread callbacks. The add_listener method installs the events and it's possible to install multiple handles. Adding a listener first emits the info and port_info events when installed, similar to how the PipeWire proxy bind works. This removes the need for the spa_pending_queue and makes it easier to implement the _sync versions. Add some helpers to make it easier for plugins to emit all the info to new listeners. Use the listeners for devices as well.
2019-03-01 12:00:42 +01:00
#define SPA_DEVICE_CHANGE_MASK_FLAGS (1u<<0)
#define SPA_DEVICE_CHANGE_MASK_PROPS (1u<<1)
#define SPA_DEVICE_CHANGE_MASK_PARAMS (1u<<2)
device: improve callbacks Pass info structures to device callbacks to make it more extensible. Also notify about the supported params on the device because we can.
2019-02-13 11:13:46 +01:00
uint64_t change_mask;
node: make add_listener method Make struct spa_node_events for events emited from the main thread and keep the spa_node_callbacks for the data thread callbacks. The add_listener method installs the events and it's possible to install multiple handles. Adding a listener first emits the info and port_info events when installed, similar to how the PipeWire proxy bind works. This removes the need for the spa_pending_queue and makes it easier to implement the _sync versions. Add some helpers to make it easier for plugins to emit all the info to new listeners. Use the listeners for devices as well.
2019-03-01 12:00:42 +01:00
uint64_t flags;
add some docs
2019-10-25 15:01:27 +02:00
const struct spa_dict *props; /**< device properties */
struct spa_param_info *params; /**< supported parameters */
uint32_t n_params; /**< number of elements in params */
device: improve callbacks Pass info structures to device callbacks to make it more extensible. Also notify about the supported params on the device because we can.
2019-02-13 11:13:46 +01:00
};
#define SPA_DEVICE_INFO_INIT() (struct spa_device_info){ SPA_VERSION_DEVICE_INFO, }
add some docs
2019-10-25 15:01:27 +02:00
/**
* Information about a device object
*
* This information is part of the object_info event on the device.
*/
device: improve callbacks Pass info structures to device callbacks to make it more extensible. Also notify about the supported params on the device because we can.
2019-02-13 11:13:46 +01:00
struct spa_device_object_info {
#define SPA_VERSION_DEVICE_OBJECT_INFO 0
uint32_t version;
Make interface types a string This is more in line with wayland and it allows us to create new interfaces in modules without having to add anything to the type enum. It also removes some lookups to map type_id to readable name in debug.
2019-12-19 13:15:10 +01:00
const char *type; /**< the object type managed by this device */
add some docs
2019-10-25 15:01:27 +02:00
const char *factory_name; /**< a factory name that implements the object */
device: improve callbacks Pass info structures to device callbacks to make it more extensible. Also notify about the supported params on the device because we can.
2019-02-13 11:13:46 +01:00
node: make add_listener method Make struct spa_node_events for events emited from the main thread and keep the spa_node_callbacks for the data thread callbacks. The add_listener method installs the events and it's possible to install multiple handles. Adding a listener first emits the info and port_info events when installed, similar to how the PipeWire proxy bind works. This removes the need for the spa_pending_queue and makes it easier to implement the _sync versions. Add some helpers to make it easier for plugins to emit all the info to new listeners. Use the listeners for devices as well.
2019-03-01 12:00:42 +01:00
#define SPA_DEVICE_OBJECT_CHANGE_MASK_FLAGS (1u<<0)
#define SPA_DEVICE_OBJECT_CHANGE_MASK_PROPS (1u<<1)
device: improve callbacks Pass info structures to device callbacks to make it more extensible. Also notify about the supported params on the device because we can.
2019-02-13 11:13:46 +01:00
uint64_t change_mask;
node: make add_listener method Make struct spa_node_events for events emited from the main thread and keep the spa_node_callbacks for the data thread callbacks. The add_listener method installs the events and it's possible to install multiple handles. Adding a listener first emits the info and port_info events when installed, similar to how the PipeWire proxy bind works. This removes the need for the spa_pending_queue and makes it easier to implement the _sync versions. Add some helpers to make it easier for plugins to emit all the info to new listeners. Use the listeners for devices as well.
2019-03-01 12:00:42 +01:00
uint64_t flags;
add some docs
2019-10-25 15:01:27 +02:00
const struct spa_dict *props; /**< extra object properties */
device: improve callbacks Pass info structures to device callbacks to make it more extensible. Also notify about the supported params on the device because we can.
2019-02-13 11:13:46 +01:00
};
#define SPA_DEVICE_OBJECT_INFO_INIT() (struct spa_device_object_info){ SPA_VERSION_DEVICE_OBJECT_INFO, }
Improve async handling Don't use special callback in node to receive the results. Instead, use a generic result callback to receive the result. This makes things a bit more symetric and generic again because then you can choose how to match the result to the request and you have a generic way to handle both the sync and async case. We can then also remove the wait method. This also makes the remote interface and spa interface to objects very similar. Make a helper object to receive and dispatch results. Use this in the helper for enum_params. Make device use the same result callbacks.
2019-02-25 12:29:57 +01:00
/** the result of spa_device_enum_params() */
spa: add result type We need this to know the type of result, especially when serializing.
2019-05-28 13:59:48 +02:00
#define SPA_RESULT_TYPE_DEVICE_PARAMS 1
Improve async handling Don't use special callback in node to receive the results. Instead, use a generic result callback to receive the result. This makes things a bit more symetric and generic again because then you can choose how to match the result to the request and you have a generic way to handle both the sync and async case. We can then also remove the wait method. This also makes the remote interface and spa interface to objects very similar. Make a helper object to receive and dispatch results. Use this in the helper for enum_params. Make device use the same result callbacks.
2019-02-25 12:29:57 +01:00
struct spa_result_device_params {
uint32_t id;
uint32_t index;
uint32_t next;
struct spa_pod *param;
};
add index of method, event and callback defines
2019-05-28 13:53:07 +02:00
#define SPA_DEVICE_EVENT_INFO 0
#define SPA_DEVICE_EVENT_RESULT 1
#define SPA_DEVICE_EVENT_EVENT 2
#define SPA_DEVICE_EVENT_OBJECT_INFO 3
#define SPA_DEVICE_EVENT_NUM 4
device: add device object Make a device object, let the v4l2 monitor create device objects The device object is responsible for dynamically creating nodes.
2018-11-23 12:43:47 +01:00
/**
node: make add_listener method Make struct spa_node_events for events emited from the main thread and keep the spa_node_callbacks for the data thread callbacks. The add_listener method installs the events and it's possible to install multiple handles. Adding a listener first emits the info and port_info events when installed, similar to how the PipeWire proxy bind works. This removes the need for the spa_pending_queue and makes it easier to implement the _sync versions. Add some helpers to make it easier for plugins to emit all the info to new listeners. Use the listeners for devices as well.
2019-03-01 12:00:42 +01:00
* spa_device_events:
*
Run codespell on the entire codebase This tool detects and fixes common English spelling mistakes, with generally very few mistakes. Here is the command I used to generate this commit. There were a few changes that had to be done manually, and of course adding the ignore file: ```shell codespell -I .codespell-ignore -x .codespell-ignore -w ``` I didn’t add it to the CI, but this would be a good place for it.
2020-07-22 20:54:06 +02:00
* Events are always emitted from the main thread
device: add device object Make a device object, let the v4l2 monitor create device objects The device object is responsible for dynamically creating nodes.
2018-11-23 12:43:47 +01:00
*/
node: make add_listener method Make struct spa_node_events for events emited from the main thread and keep the spa_node_callbacks for the data thread callbacks. The add_listener method installs the events and it's possible to install multiple handles. Adding a listener first emits the info and port_info events when installed, similar to how the PipeWire proxy bind works. This removes the need for the spa_pending_queue and makes it easier to implement the _sync versions. Add some helpers to make it easier for plugins to emit all the info to new listeners. Use the listeners for devices as well.
2019-03-01 12:00:42 +01:00
struct spa_device_events {
device: add device object Make a device object, let the v4l2 monitor create device objects The device object is responsible for dynamically creating nodes.
2018-11-23 12:43:47 +01:00
/** version of the structure */
node: make add_listener method Make struct spa_node_events for events emited from the main thread and keep the spa_node_callbacks for the data thread callbacks. The add_listener method installs the events and it's possible to install multiple handles. Adding a listener first emits the info and port_info events when installed, similar to how the PipeWire proxy bind works. This removes the need for the spa_pending_queue and makes it easier to implement the _sync versions. Add some helpers to make it easier for plugins to emit all the info to new listeners. Use the listeners for devices as well.
2019-03-01 12:00:42 +01:00
#define SPA_VERSION_DEVICE_EVENTS 0
device: add device object Make a device object, let the v4l2 monitor create device objects The device object is responsible for dynamically creating nodes.
2018-11-23 12:43:47 +01:00
uint32_t version;
device: improve callbacks Pass info structures to device callbacks to make it more extensible. Also notify about the supported params on the device because we can.
2019-02-13 11:13:46 +01:00
/** notify extra information about the device */
interfaces: make events return void Events are dispatched with hooks and have no return value. Make it possible to get the last resource and proxy sender value for where we need it.
2019-03-01 14:04:05 +01:00
void (*info) (void *data, const struct spa_device_info *info);
monitor: remove enum_items Make the monitor and device emit the info and items when the callbacks are set. This makes it easier to implement the monitor because there is much less state to keep around and invalidate etc. Rework the monitors Add bluez5 device
2018-11-26 12:18:53 +01:00
Improve async handling Don't use special callback in node to receive the results. Instead, use a generic result callback to receive the result. This makes things a bit more symetric and generic again because then you can choose how to match the result to the request and you have a generic way to handle both the sync and async case. We can then also remove the wait method. This also makes the remote interface and spa interface to objects very similar. Make a helper object to receive and dispatch results. Use this in the helper for enum_params. Make device use the same result callbacks.
2019-02-25 12:29:57 +01:00
/** notify a result */
spa: add result type We need this to know the type of result, especially when serializing.
2019-05-28 13:59:48 +02:00
void (*result) (void *data, int seq, int res, uint32_t type, const void *result);
Improve async handling Don't use special callback in node to receive the results. Instead, use a generic result callback to receive the result. This makes things a bit more symetric and generic again because then you can choose how to match the result to the request and you have a generic way to handle both the sync and async case. We can then also remove the wait method. This also makes the remote interface and spa interface to objects very similar. Make a helper object to receive and dispatch results. Use this in the helper for enum_params. Make device use the same result callbacks.
2019-02-25 12:29:57 +01:00
monitor: remove enum_items Make the monitor and device emit the info and items when the callbacks are set. This makes it easier to implement the monitor because there is much less state to keep around and invalidate etc. Rework the monitors Add bluez5 device
2018-11-26 12:18:53 +01:00
/** a device event */
add const to spa_event and spa_command
2019-05-28 13:51:12 +02:00
void (*event) (void *data, const struct spa_event *event);
monitor: remove enum_items Make the monitor and device emit the info and items when the callbacks are set. This makes it easier to implement the monitor because there is much less state to keep around and invalidate etc. Rework the monitors Add bluez5 device
2018-11-26 12:18:53 +01:00
device: improve callbacks Pass info structures to device callbacks to make it more extensible. Also notify about the supported params on the device because we can.
2019-02-13 11:13:46 +01:00
/** info changed for an object managed by the device, info is NULL when
* the object is removed */
interfaces: make events return void Events are dispatched with hooks and have no return value. Make it possible to get the last resource and proxy sender value for where we need it.
2019-03-01 14:04:05 +01:00
void (*object_info) (void *data, uint32_t id,
interfaces: improve remote API Add return values to events and method callbacks. This makes it possible to pass any error or async return value. Add sync/done/error in both directions so that both proxy and resource and perform/reply sync and produce errors. Return a SPA_ASYNC from remote method calls (and events), keep the sequence number in the connection. With the core sync/done we can remove the client-node done method and it's internal sequence number along with the seq number in method calls. We can also use the method/event async return value to perform a sync with as the unique sequence number for this method. Add sync method and done/error event to proxy and resource.
2019-02-18 12:31:36 +01:00
const struct spa_device_object_info *info);
device: add device object Make a device object, let the v4l2 monitor create device objects The device object is responsible for dynamically creating nodes.
2018-11-23 12:43:47 +01:00
};
add index of method, event and callback defines
2019-05-28 13:53:07 +02:00
#define SPA_DEVICE_METHOD_ADD_LISTENER 0
device: add sync operation
2019-05-28 13:55:36 +02:00
#define SPA_DEVICE_METHOD_SYNC 1
#define SPA_DEVICE_METHOD_ENUM_PARAMS 2
#define SPA_DEVICE_METHOD_SET_PARAM 3
#define SPA_DEVICE_METHOD_NUM 4
add index of method, event and callback defines
2019-05-28 13:53:07 +02:00
device: add device object Make a device object, let the v4l2 monitor create device objects The device object is responsible for dynamically creating nodes.
2018-11-23 12:43:47 +01:00
/**
interface: add an interface struct The interface struct has the type,version and methods of the interface. Make spa interfaces extend from spa_interface and make a separate structure for the methods. Pass a generic void* as the first argument of methods, like we don in PipeWire. Bundle the methods + implementation in a versioned inteface and use that to invoke methods. This way we can do version checks on the methods. Make resource and proxy interfaces that we can can call. We can then make the core interfaces independent on proxy/resource and hide them in the lower layers. Add add_listener method to methods of core interfaces, just like SPA.
2019-05-20 16:11:23 +02:00
* spa_device_methods:
device: add device object Make a device object, let the v4l2 monitor create device objects The device object is responsible for dynamically creating nodes.
2018-11-23 12:43:47 +01:00
*/
interface: add an interface struct The interface struct has the type,version and methods of the interface. Make spa interfaces extend from spa_interface and make a separate structure for the methods. Pass a generic void* as the first argument of methods, like we don in PipeWire. Bundle the methods + implementation in a versioned inteface and use that to invoke methods. This way we can do version checks on the methods. Make resource and proxy interfaces that we can can call. We can then make the core interfaces independent on proxy/resource and hide them in the lower layers. Add add_listener method to methods of core interfaces, just like SPA.
2019-05-20 16:11:23 +02:00
struct spa_device_methods {
/* the version of the methods. This can be used to expand this
device: add device object Make a device object, let the v4l2 monitor create device objects The device object is responsible for dynamically creating nodes.
2018-11-23 12:43:47 +01:00
* structure in the future */
interface: add an interface struct The interface struct has the type,version and methods of the interface. Make spa interfaces extend from spa_interface and make a separate structure for the methods. Pass a generic void* as the first argument of methods, like we don in PipeWire. Bundle the methods + implementation in a versioned inteface and use that to invoke methods. This way we can do version checks on the methods. Make resource and proxy interfaces that we can can call. We can then make the core interfaces independent on proxy/resource and hide them in the lower layers. Add add_listener method to methods of core interfaces, just like SPA.
2019-05-20 16:11:23 +02:00
#define SPA_VERSION_DEVICE_METHODS 0
device: add device object Make a device object, let the v4l2 monitor create device objects The device object is responsible for dynamically creating nodes.
2018-11-23 12:43:47 +01:00
uint32_t version;
/**
node: make add_listener method Make struct spa_node_events for events emited from the main thread and keep the spa_node_callbacks for the data thread callbacks. The add_listener method installs the events and it's possible to install multiple handles. Adding a listener first emits the info and port_info events when installed, similar to how the PipeWire proxy bind works. This removes the need for the spa_pending_queue and makes it easier to implement the _sync versions. Add some helpers to make it easier for plugins to emit all the info to new listeners. Use the listeners for devices as well.
2019-03-01 12:00:42 +01:00
* Set events to receive asynchronous notifications from
device: add device object Make a device object, let the v4l2 monitor create device objects The device object is responsible for dynamically creating nodes.
2018-11-23 12:43:47 +01:00
* the device.
*
node: make add_listener method Make struct spa_node_events for events emited from the main thread and keep the spa_node_callbacks for the data thread callbacks. The add_listener method installs the events and it's possible to install multiple handles. Adding a listener first emits the info and port_info events when installed, similar to how the PipeWire proxy bind works. This removes the need for the spa_pending_queue and makes it easier to implement the _sync versions. Add some helpers to make it easier for plugins to emit all the info to new listeners. Use the listeners for devices as well.
2019-03-01 12:00:42 +01:00
* Setting the events will trigger the info event and an
add some docs
2019-10-25 15:01:27 +02:00
* object_info event for each managed object on the new
node: make add_listener method Make struct spa_node_events for events emited from the main thread and keep the spa_node_callbacks for the data thread callbacks. The add_listener method installs the events and it's possible to install multiple handles. Adding a listener first emits the info and port_info events when installed, similar to how the PipeWire proxy bind works. This removes the need for the spa_pending_queue and makes it easier to implement the _sync versions. Add some helpers to make it easier for plugins to emit all the info to new listeners. Use the listeners for devices as well.
2019-03-01 12:00:42 +01:00
* listener.
monitor: remove enum_items Make the monitor and device emit the info and items when the callbacks are set. This makes it easier to implement the monitor because there is much less state to keep around and invalidate etc. Rework the monitors Add bluez5 device
2018-11-26 12:18:53 +01:00
*
spa: fix few doxygen errors
2021-05-21 10:35:43 +10:00
* \param object a \ref spa_device
node: make add_listener method Make struct spa_node_events for events emited from the main thread and keep the spa_node_callbacks for the data thread callbacks. The add_listener method installs the events and it's possible to install multiple handles. Adding a listener first emits the info and port_info events when installed, similar to how the PipeWire proxy bind works. This removes the need for the spa_pending_queue and makes it easier to implement the _sync versions. Add some helpers to make it easier for plugins to emit all the info to new listeners. Use the listeners for devices as well.
2019-03-01 12:00:42 +01:00
* \param listener a listener
spa: fix few doxygen errors
2021-05-21 10:35:43 +10:00
* \param events a struct \ref spa_device_events
node: make add_listener method Make struct spa_node_events for events emited from the main thread and keep the spa_node_callbacks for the data thread callbacks. The add_listener method installs the events and it's possible to install multiple handles. Adding a listener first emits the info and port_info events when installed, similar to how the PipeWire proxy bind works. This removes the need for the spa_pending_queue and makes it easier to implement the _sync versions. Add some helpers to make it easier for plugins to emit all the info to new listeners. Use the listeners for devices as well.
2019-03-01 12:00:42 +01:00
* \param data data passed as first argument in functions of \a events
device: add device object Make a device object, let the v4l2 monitor create device objects The device object is responsible for dynamically creating nodes.
2018-11-23 12:43:47 +01:00
* \return 0 on success
* < 0 errno on error
*/
interface: add an interface struct The interface struct has the type,version and methods of the interface. Make spa interfaces extend from spa_interface and make a separate structure for the methods. Pass a generic void* as the first argument of methods, like we don in PipeWire. Bundle the methods + implementation in a versioned inteface and use that to invoke methods. This way we can do version checks on the methods. Make resource and proxy interfaces that we can can call. We can then make the core interfaces independent on proxy/resource and hide them in the lower layers. Add add_listener method to methods of core interfaces, just like SPA.
2019-05-20 16:11:23 +02:00
int (*add_listener) (void *object,
node: make add_listener method Make struct spa_node_events for events emited from the main thread and keep the spa_node_callbacks for the data thread callbacks. The add_listener method installs the events and it's possible to install multiple handles. Adding a listener first emits the info and port_info events when installed, similar to how the PipeWire proxy bind works. This removes the need for the spa_pending_queue and makes it easier to implement the _sync versions. Add some helpers to make it easier for plugins to emit all the info to new listeners. Use the listeners for devices as well.
2019-03-01 12:00:42 +01:00
struct spa_hook *listener,
const struct spa_device_events *events,
void *data);
device: add sync operation
2019-05-28 13:55:36 +02:00
/**
* Perform a sync operation.
*
* This method will emit the result event with the given sequence
* number synchronously or with the returned async return value
* asynchronously.
*
* Because all methods are serialized in the device, this can be used
* to wait for completion of all previous method calls.
*
* \param seq a sequence number
* \return 0 on success
* -EINVAL when node is NULL
* an async result
*/
int (*sync) (void *object, int seq);
alsa: implement monitor and device
2018-11-23 17:41:39 +01:00
/**
* Enumerate the parameters of a device.
*
* Parameters are identified with an \a id. Some parameters can have
* multiple values, see the documentation of the parameter id.
*
* Parameters can be filtered by passing a non-NULL \a filter.
*
spa: fix few doxygen errors
2021-05-21 10:35:43 +10:00
* The result callback will be called at most \a max times with a
node: make add_listener method Make struct spa_node_events for events emited from the main thread and keep the spa_node_callbacks for the data thread callbacks. The add_listener method installs the events and it's possible to install multiple handles. Adding a listener first emits the info and port_info events when installed, similar to how the PipeWire proxy bind works. This removes the need for the spa_pending_queue and makes it easier to implement the _sync versions. Add some helpers to make it easier for plugins to emit all the info to new listeners. Use the listeners for devices as well.
2019-03-01 12:00:42 +01:00
* struct spa_result_device_params as the result.
alsa: implement monitor and device
2018-11-23 17:41:39 +01:00
*
node: make add_listener method Make struct spa_node_events for events emited from the main thread and keep the spa_node_callbacks for the data thread callbacks. The add_listener method installs the events and it's possible to install multiple handles. Adding a listener first emits the info and port_info events when installed, similar to how the PipeWire proxy bind works. This removes the need for the spa_pending_queue and makes it easier to implement the _sync versions. Add some helpers to make it easier for plugins to emit all the info to new listeners. Use the listeners for devices as well.
2019-03-01 12:00:42 +01:00
* This function must be called from the main thread.
Improve async handling Don't use special callback in node to receive the results. Instead, use a generic result callback to receive the result. This makes things a bit more symetric and generic again because then you can choose how to match the result to the request and you have a generic way to handle both the sync and async case. We can then also remove the wait method. This also makes the remote interface and spa interface to objects very similar. Make a helper object to receive and dispatch results. Use this in the helper for enum_params. Make device use the same result callbacks.
2019-02-25 12:29:57 +01:00
*
alsa: implement monitor and device
2018-11-23 17:41:39 +01:00
* \param device a \ref spa_device
Run codespell on the entire codebase This tool detects and fixes common English spelling mistakes, with generally very few mistakes. Here is the command I used to generate this commit. There were a few changes that had to be done manually, and of course adding the ignore file: ```shell codespell -I .codespell-ignore -x .codespell-ignore -w ``` I didn’t add it to the CI, but this would be a good place for it.
2020-07-22 20:54:06 +02:00
* \param seq a sequence number to pass to the result function
alsa: implement monitor and device
2018-11-23 17:41:39 +01:00
* \param id the param id to enumerate
Improve async handling Don't use special callback in node to receive the results. Instead, use a generic result callback to receive the result. This makes things a bit more symetric and generic again because then you can choose how to match the result to the request and you have a generic way to handle both the sync and async case. We can then also remove the wait method. This also makes the remote interface and spa interface to objects very similar. Make a helper object to receive and dispatch results. Use this in the helper for enum_params. Make device use the same result callbacks.
2019-02-25 12:29:57 +01:00
* \param index the index of enumeration, pass 0 for the first item.
node: make add_listener method Make struct spa_node_events for events emited from the main thread and keep the spa_node_callbacks for the data thread callbacks. The add_listener method installs the events and it's possible to install multiple handles. Adding a listener first emits the info and port_info events when installed, similar to how the PipeWire proxy bind works. This removes the need for the spa_pending_queue and makes it easier to implement the _sync versions. Add some helpers to make it easier for plugins to emit all the info to new listeners. Use the listeners for devices as well.
2019-03-01 12:00:42 +01:00
* \param max the maximum number of items to iterate
alsa: implement monitor and device
2018-11-23 17:41:39 +01:00
* \param filter and optional filter to use
Improve async handling Don't use special callback in node to receive the results. Instead, use a generic result callback to receive the result. This makes things a bit more symetric and generic again because then you can choose how to match the result to the request and you have a generic way to handle both the sync and async case. We can then also remove the wait method. This also makes the remote interface and spa interface to objects very similar. Make a helper object to receive and dispatch results. Use this in the helper for enum_params. Make device use the same result callbacks.
2019-02-25 12:29:57 +01:00
* \return 0 when there are no more parameters to enumerate
alsa: implement monitor and device
2018-11-23 17:41:39 +01:00
* -EINVAL when invalid arguments are given
* -ENOENT the parameter \a id is unknown
* -ENOTSUP when there are no parameters
* implemented on \a device
*/
interface: add an interface struct The interface struct has the type,version and methods of the interface. Make spa interfaces extend from spa_interface and make a separate structure for the methods. Pass a generic void* as the first argument of methods, like we don in PipeWire. Bundle the methods + implementation in a versioned inteface and use that to invoke methods. This way we can do version checks on the methods. Make resource and proxy interfaces that we can can call. We can then make the core interfaces independent on proxy/resource and hide them in the lower layers. Add add_listener method to methods of core interfaces, just like SPA.
2019-05-20 16:11:23 +02:00
int (*enum_params) (void *object, int seq,
node: make add_listener method Make struct spa_node_events for events emited from the main thread and keep the spa_node_callbacks for the data thread callbacks. The add_listener method installs the events and it's possible to install multiple handles. Adding a listener first emits the info and port_info events when installed, similar to how the PipeWire proxy bind works. This removes the need for the spa_pending_queue and makes it easier to implement the _sync versions. Add some helpers to make it easier for plugins to emit all the info to new listeners. Use the listeners for devices as well.
2019-03-01 12:00:42 +01:00
uint32_t id, uint32_t index, uint32_t max,
Improve async handling Don't use special callback in node to receive the results. Instead, use a generic result callback to receive the result. This makes things a bit more symetric and generic again because then you can choose how to match the result to the request and you have a generic way to handle both the sync and async case. We can then also remove the wait method. This also makes the remote interface and spa interface to objects very similar. Make a helper object to receive and dispatch results. Use this in the helper for enum_params. Make device use the same result callbacks.
2019-02-25 12:29:57 +01:00
const struct spa_pod *filter);
alsa: implement monitor and device
2018-11-23 17:41:39 +01:00
/**
* Set the configurable parameter in \a device.
*
* Usually, \a param will be obtained from enum_params and then
* modified but it is also possible to set another spa_pod
* as long as its keys and types match a supported object.
*
* Objects with property keys that are not known are ignored.
*
* This function must be called from the main thread.
*
spa: fix few doxygen errors
2021-05-21 10:35:43 +10:00
* \param object \ref spa_device
alsa: implement monitor and device
2018-11-23 17:41:39 +01:00
* \param id the parameter id to configure
* \param flags additional flags
* \param param the parameter to configure
*
* \return 0 on success
* -EINVAL when invalid arguments are given
* -ENOTSUP when there are no parameters implemented on \a device
* -ENOENT the parameter is unknown
*/
interface: add an interface struct The interface struct has the type,version and methods of the interface. Make spa interfaces extend from spa_interface and make a separate structure for the methods. Pass a generic void* as the first argument of methods, like we don in PipeWire. Bundle the methods + implementation in a versioned inteface and use that to invoke methods. This way we can do version checks on the methods. Make resource and proxy interfaces that we can can call. We can then make the core interfaces independent on proxy/resource and hide them in the lower layers. Add add_listener method to methods of core interfaces, just like SPA.
2019-05-20 16:11:23 +02:00
int (*set_param) (void *object,
alsa: implement monitor and device
2018-11-23 17:41:39 +01:00
uint32_t id, uint32_t flags,
const struct spa_pod *param);
device: add device object Make a device object, let the v4l2 monitor create device objects The device object is responsible for dynamically creating nodes.
2018-11-23 12:43:47 +01:00
};
interface: add an interface struct The interface struct has the type,version and methods of the interface. Make spa interfaces extend from spa_interface and make a separate structure for the methods. Pass a generic void* as the first argument of methods, like we don in PipeWire. Bundle the methods + implementation in a versioned inteface and use that to invoke methods. This way we can do version checks on the methods. Make resource and proxy interfaces that we can can call. We can then make the core interfaces independent on proxy/resource and hide them in the lower layers. Add add_listener method to methods of core interfaces, just like SPA.
2019-05-20 16:11:23 +02:00
#define spa_device_method(o,method,version,...) \
({ \
int _res = -ENOTSUP; \
struct spa_device *_o = o; \
spa_interface_call_res(&_o->iface, \
struct spa_device_methods, _res, \
method, version, ##__VA_ARGS__); \
_res; \
})
#define spa_device_add_listener(d,...) spa_device_method(d, add_listener, 0, __VA_ARGS__)
device: add sync operation
2019-05-28 13:55:36 +02:00
#define spa_device_sync(d,...) spa_device_method(d, sync, 0, __VA_ARGS__)
interface: add an interface struct The interface struct has the type,version and methods of the interface. Make spa interfaces extend from spa_interface and make a separate structure for the methods. Pass a generic void* as the first argument of methods, like we don in PipeWire. Bundle the methods + implementation in a versioned inteface and use that to invoke methods. This way we can do version checks on the methods. Make resource and proxy interfaces that we can can call. We can then make the core interfaces independent on proxy/resource and hide them in the lower layers. Add add_listener method to methods of core interfaces, just like SPA.
2019-05-20 16:11:23 +02:00
#define spa_device_enum_params(d,...) spa_device_method(d, enum_params, 0, __VA_ARGS__)
#define spa_device_set_param(d,...) spa_device_method(d, set_param, 0, __VA_ARGS__)
device: add device object Make a device object, let the v4l2 monitor create device objects The device object is responsible for dynamically creating nodes.
2018-11-23 12:43:47 +01:00
monitor: remove monitor API and use device Remove the monitor API, we can use the device API for it. Make sure we support creating devices (like alsa) from another device (udev). Use new object.id to store the object id in the object properties. Use the port.id/node.id etc to make relations to other objects.
2019-09-20 13:04:14 +02:00
#define SPA_KEY_DEVICE_ENUM_API "device.enum.api" /**< the api used to discover this
* device */
spa: add keys for properties Define and document property keys
2019-06-03 16:48:01 +02:00
#define SPA_KEY_DEVICE_API "device.api" /**< the api used by the device
monitor: remove monitor API and use device Remove the monitor API, we can use the device API for it. Make sure we support creating devices (like alsa) from another device (udev). Use new object.id to store the object id in the object properties. Use the port.id/node.id etc to make relations to other objects.
2019-09-20 13:04:14 +02:00
* Ex. "udev", "alsa", "v4l2". */
spa: add keys for properties Define and document property keys
2019-06-03 16:48:01 +02:00
#define SPA_KEY_DEVICE_NAME "device.name" /**< the name of the device */
Run codespell on the entire codebase This tool detects and fixes common English spelling mistakes, with generally very few mistakes. Here is the command I used to generate this commit. There were a few changes that had to be done manually, and of course adding the ignore file: ```shell codespell -I .codespell-ignore -x .codespell-ignore -w ``` I didn’t add it to the CI, but this would be a good place for it.
2020-07-22 20:54:06 +02:00
#define SPA_KEY_DEVICE_ALIAS "device.alias" /**< alternative name of the device */
spa: add keys for properties Define and document property keys
2019-06-03 16:48:01 +02:00
#define SPA_KEY_DEVICE_NICK "device.nick" /**< the device short name */
#define SPA_KEY_DEVICE_DESCRIPTION "device.description" /**< a device description */
#define SPA_KEY_DEVICE_ICON "device.icon" /**< icon for the device. A base64 blob
* containing PNG image data */
#define SPA_KEY_DEVICE_ICON_NAME "device.icon-name" /**< an XDG icon name for the device.
* Ex. "sound-card-speakers-usb" */
#define SPA_KEY_DEVICE_PLUGGED_USEC "device.plugged.usec" /**< when the device was plugged */
keys: rename device.id to device.bus-id
2019-08-16 21:52:32 +02:00
#define SPA_KEY_DEVICE_BUS_ID "device.bus-id" /**< the device bus-id */
spa: add keys for properties Define and document property keys
2019-06-03 16:48:01 +02:00
#define SPA_KEY_DEVICE_BUS_PATH "device.bus-path" /**< bus path to the device in the OS'
* format.
* Ex. "pci-0000:00:14.0-usb-0:3.2:1.0" */
#define SPA_KEY_DEVICE_BUS "device.bus" /**< bus of the device if applicable. One of
* "isa", "pci", "usb", "firewire",
* "bluetooth" */
#define SPA_KEY_DEVICE_SUBSYSTEM "device.subsystem" /**< device subsystem */
#define SPA_KEY_DEVICE_SYSFS_PATH "device.sysfs.path" /**< device sysfs path */
#define SPA_KEY_DEVICE_VENDOR_ID "device.vendor.id" /**< vendor ID if applicable */
#define SPA_KEY_DEVICE_VENDOR_NAME "device.vendor.name" /**< vendor name if applicable */
#define SPA_KEY_DEVICE_PRODUCT_ID "device.product.id" /**< product ID if applicable */
#define SPA_KEY_DEVICE_PRODUCT_NAME "device.product.name" /**< product name if applicable */
#define SPA_KEY_DEVICE_SERIAL "device.serial" /**< Serial number if applicable */
#define SPA_KEY_DEVICE_CLASS "device.class" /**< device class */
#define SPA_KEY_DEVICE_CAPABILITIES "device.capabilities" /**< api specific device capabilities */
#define SPA_KEY_DEVICE_FORM_FACTOR "device.form-factor" /**< form factor if applicable. One of
* "internal", "speaker", "handset", "tv",
* "webcam", "microphone", "headset",
* "headphone", "hands-free", "car", "hifi",
* "computer", "portable" */
acp: pass udev PROFILE_SETS to acp device
2020-07-28 13:00:45 +02:00
#define SPA_KEY_DEVICE_PROFILE "device.profile " /**< profile for the device */
#define SPA_KEY_DEVICE_PROFILE_SET "device.profile-set" /**< profile set for the device */
bluez5: add device.string in properties See #842
2021-03-18 12:44:09 +01:00
#define SPA_KEY_DEVICE_STRING "device.string" /**< device string in the underlying
* layer's format. E.g. "surround51:0" */
spa: add keys for properties Define and document property keys
2019-06-03 16:48:01 +02:00
spa: group the spa headers into doxygen modules Subdirectories buffer, control, debug, monitor, pod, support and utils, others are still missing. Headers are grouped either per subdirectory (e.g. buffer/ gets added to group spa_buffer) or per-file (e.g. spa_json is a separate group), whatever seemed like the most sensible approach.
2021-05-21 14:03:07 +10:00
/**
* \}
*/
spa: add keys for properties Define and document property keys
2019-06-03 16:48:01 +02:00
device: add device object Make a device object, let the v4l2 monitor create device objects The device object is responsible for dynamically creating nodes.
2018-11-23 12:43:47 +01:00
#ifdef __cplusplus
} /* extern "C" */
#endif
Don't use __ in defines or declarations, it's reserved SPA_TYPE -> SPA_TYPE_INFO for type info strings improve includes Fixes #115
2019-01-14 12:58:23 +01:00
#endif /* SPA_DEVICE_H */
Reference in a new issue Copy permalink