mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-25 06:59:57 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
pipewire/spa/include/spa/param/props.h

128 lines
3.9 KiB
C
Raw Normal View History

treewide: use SPDX tags to specify copyright information SPDX tags make the licensing information easy to understand and clear, and they are machine parseable. See https://spdx.dev for more information.
2023-02-08 18:12:00 +01:00
/* Simple Plugin API */
/* SPDX-FileCopyrightText: Copyright © 2018 Wim Taymans */
/* SPDX-License-Identifier: MIT */
more hacking Move plugin API to separate directory for now Add ringbuffer and way to get ringbuffer from a port
2016-06-28 12:21:56 +02:00
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_PARAM_PROPS_H
#define SPA_PARAM_PROPS_H
more hacking Move plugin API to separate directory for now Add ringbuffer and way to get ringbuffer from a port
2016-06-28 12:21:56 +02:00
#ifdef __cplusplus
extern "C" {
#endif
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_param
* \{
*/
Reorganise SPA tree Reorganise the SPA includes to make it more extensible later Simplify the naming of the buffer and meta params
2017-11-10 13:36:14 +01:00
#include <spa/param/param.h>
rework props with pod
2017-02-27 21:25:33 +01:00
More type cleanups SPA_ID_* -> SPA_TYPE_*. We use 'type' for all registered types. ID refers to either a registered type or an enum. Improve introspection of object ids. Make 0 an invalid enum and use it to look up the object id type. Move some type-info files together. Swap type and id of the object, we first specify the type and then the id because the meaning of the id depends on the object type.
2018-08-27 15:03:11 +02:00
/** properties of SPA_TYPE_OBJECT_PropInfo */
Remove dynamic types Do not use dynamic types anymore. The reason is that it's difficult: - to maintain a shared type database over a network. - the extra overhead when translating between processes and for maintaining the translation tables. - race conditions in translating in RT-threads, this is a problem because we want to make event streams. We now have simple enums with types and extension points for all types. This is also nicer to use in general. We don't need the mapper anymore or pass strings around as types. There is a parallel type info system to get more info about ids and enums and their hierarchy. It can also be used for debugging.
2018-08-23 17:47:57 +02:00
enum spa_prop_info {
spa: remove wrong comment
2020-07-01 15:27:55 +02:00
SPA_PROP_INFO_START,
Remove dynamic types Do not use dynamic types anymore. The reason is that it's difficult: - to maintain a shared type database over a network. - the extra overhead when translating between processes and for maintaining the translation tables. - race conditions in translating in RT-threads, this is a problem because we want to make event streams. We now have simple enums with types and extension points for all types. This is also nicer to use in general. We don't need the mapper anymore or pass strings around as types. There is a parallel type info system to get more info about ids and enums and their hierarchy. It can also be used for debugging.
2018-08-23 17:47:57 +02:00
SPA_PROP_INFO_id, /**< associated id of the property */
SPA_PROP_INFO_name, /**< name of the property */
SPA_PROP_INFO_type, /**< type and range/enums of property */
SPA_PROP_INFO_labels, /**< labels of property if any, this is a
* struct with pairs of values, the first one
* is of the type of the property, the second
* one is a string with a user readable label
* for the value. */
spa: add params property Some properties can be part of a params field in the Props object and contain the string key and the pod value to be configured. This is easier to use than using the regular id. Add the fact that the property is also part of params in the PropInfo.
2021-05-09 21:13:30 +02:00
SPA_PROP_INFO_container, /**< type of container if any (Id) */
SPA_PROP_INFO_params, /**< is part of params property (Bool) */
spa: add description to PropInfo
2021-11-30 17:40:56 +01:00
SPA_PROP_INFO_description, /**< User readable description */
Remove dynamic types Do not use dynamic types anymore. The reason is that it's difficult: - to maintain a shared type database over a network. - the extra overhead when translating between processes and for maintaining the translation tables. - race conditions in translating in RT-threads, this is a problem because we want to make event streams. We now have simple enums with types and extension points for all types. This is also nicer to use in general. We don't need the mapper anymore or pass strings around as types. There is a parallel type info system to get more info about ids and enums and their hierarchy. It can also be used for debugging.
2018-08-23 17:47:57 +02:00
};
Add mapper Ger rid of static ids for interfaces and replace with something we can register dynamically Implement logger.
2016-10-07 13:14:32 +02:00
More type cleanups SPA_ID_* -> SPA_TYPE_*. We use 'type' for all registered types. ID refers to either a registered type or an enum. Improve introspection of object ids. Make 0 an invalid enum and use it to look up the object id type. Move some type-info files together. Swap type and id of the object, we first specify the type and then the id because the meaning of the id depends on the object type.
2018-08-27 15:03:11 +02:00
/** predefined properties for SPA_TYPE_OBJECT_Props */
Remove dynamic types Do not use dynamic types anymore. The reason is that it's difficult: - to maintain a shared type database over a network. - the extra overhead when translating between processes and for maintaining the translation tables. - race conditions in translating in RT-threads, this is a problem because we want to make event streams. We now have simple enums with types and extension points for all types. This is also nicer to use in general. We don't need the mapper anymore or pass strings around as types. There is a parallel type info system to get more info about ids and enums and their hierarchy. It can also be used for debugging.
2018-08-23 17:47:57 +02:00
enum spa_prop {
spa: remove wrong comment
2020-07-01 15:27:55 +02:00
SPA_PROP_START,
v4l2: handle control properties Add the right propId to properties so they can get controls. Keep track of properties and handle the io area for them Check if properties changed and update the v4l2 controls
2018-02-07 18:08:16 +01:00
More type cleanups SPA_ID_* -> SPA_TYPE_*. We use 'type' for all registered types. ID refers to either a registered type or an enum. Improve introspection of object ids. Make 0 an invalid enum and use it to look up the object id type. Move some type-info files together. Swap type and id of the object, we first specify the type and then the id because the meaning of the id depends on the object type.
2018-08-27 15:03:11 +02:00
SPA_PROP_unknown, /**< an unknown property */
v4l2: handle control properties Add the right propId to properties so they can get controls. Keep track of properties and handle the io area for them Check if properties changed and update the v4l2 controls
2018-02-07 18:08:16 +01:00
props: add some paddig between properties
2018-10-15 17:53:14 +02:00
SPA_PROP_START_Device = 0x100, /**< device related properties */
Remove dynamic types Do not use dynamic types anymore. The reason is that it's difficult: - to maintain a shared type database over a network. - the extra overhead when translating between processes and for maintaining the translation tables. - race conditions in translating in RT-threads, this is a problem because we want to make event streams. We now have simple enums with types and extension points for all types. This is also nicer to use in general. We don't need the mapper anymore or pass strings around as types. There is a parallel type info system to get more info about ids and enums and their hierarchy. It can also be used for debugging.
2018-08-23 17:47:57 +02:00
SPA_PROP_device,
SPA_PROP_deviceName,
SPA_PROP_deviceFd,
SPA_PROP_card,
SPA_PROP_cardName,
v4l2: handle control properties Add the right propId to properties so they can get controls. Keep track of properties and handle the io area for them Check if properties changed and update the v4l2 controls
2018-02-07 18:08:16 +01:00
Remove dynamic types Do not use dynamic types anymore. The reason is that it's difficult: - to maintain a shared type database over a network. - the extra overhead when translating between processes and for maintaining the translation tables. - race conditions in translating in RT-threads, this is a problem because we want to make event streams. We now have simple enums with types and extension points for all types. This is also nicer to use in general. We don't need the mapper anymore or pass strings around as types. There is a parallel type info system to get more info about ids and enums and their hierarchy. It can also be used for debugging.
2018-08-23 17:47:57 +02:00
SPA_PROP_minLatency,
SPA_PROP_maxLatency,
SPA_PROP_periods,
SPA_PROP_periodSize,
SPA_PROP_periodEvent,
SPA_PROP_live,
props: add rate property
2018-11-16 16:48:49 +01:00
SPA_PROP_rate,
resample: add quality property
2020-02-14 20:16:50 +01:00
SPA_PROP_quality,
spa: add bluetoothAudioCodec property and type
2021-03-22 20:41:46 +02:00
SPA_PROP_bluetoothAudioCodec,
bluez5: add bluetoothOffloadActive device prop for acquiring transports Add a device prop that causes transports to be acquired.
2022-10-01 15:46:27 +03:00
SPA_PROP_bluetoothOffloadActive,
more hacking Move plugin API to separate directory for now Add ringbuffer and way to get ringbuffer from a port
2016-06-28 12:21:56 +02:00
props: add some paddig between properties
2018-10-15 17:53:14 +02:00
SPA_PROP_START_Audio = 0x10000, /**< audio related properties */
Remove dynamic types Do not use dynamic types anymore. The reason is that it's difficult: - to maintain a shared type database over a network. - the extra overhead when translating between processes and for maintaining the translation tables. - race conditions in translating in RT-threads, this is a problem because we want to make event streams. We now have simple enums with types and extension points for all types. This is also nicer to use in general. We don't need the mapper anymore or pass strings around as types. There is a parallel type info system to get more info about ids and enums and their hierarchy. It can also be used for debugging.
2018-08-23 17:47:57 +02:00
SPA_PROP_waveType,
SPA_PROP_frequency,
spa: add some more docs See #3351
2023-07-17 17:46:04 +02:00
SPA_PROP_volume, /**< a volume (Float), 0.0 silence, 1.0 no attenutation */
acp: add volume base and step Add a READONLY property flag to makr properties READONLY Set the base_volume and volume_step in the acp device Send the base volume and step as REAONLY properties. Use these in pulse layer.
2020-07-07 13:12:57 +02:00
SPA_PROP_mute, /**< mute (Bool) */
Remove dynamic types Do not use dynamic types anymore. The reason is that it's difficult: - to maintain a shared type database over a network. - the extra overhead when translating between processes and for maintaining the translation tables. - race conditions in translating in RT-threads, this is a problem because we want to make event streams. We now have simple enums with types and extension points for all types. This is also nicer to use in general. We don't need the mapper anymore or pass strings around as types. There is a parallel type info system to get more info about ids and enums and their hierarchy. It can also be used for debugging.
2018-08-23 17:47:57 +02:00
SPA_PROP_patternType,
SPA_PROP_ditherType,
SPA_PROP_truncate,
spa: explicitly mention that volumes are linear See #3623
2023-11-04 09:51:14 +01:00
SPA_PROP_channelVolumes, /**< a volume array, one (linear) volume per channel
spa: add some more docs See #3351
2023-07-17 17:46:04 +02:00
* (Array of Float). 0.0 is silence, 1.0 is
spa: explicitly mention that volumes are linear See #3623
2023-11-04 09:51:14 +01:00
* without attenuation. This is the effective
* volume that is applied. It can result
* in a hardware volume and software volume
* (see softVolumes) */
acp: add volume base and step Add a READONLY property flag to makr properties READONLY Set the base_volume and volume_step in the acp device Send the base volume and step as REAONLY properties. Use these in pulse layer.
2020-07-07 13:12:57 +02:00
SPA_PROP_volumeBase, /**< a volume base (Float) */
SPA_PROP_volumeStep, /**< a volume step (Float) */
spa: add channelMap property param
2020-11-23 15:28:24 +01:00
SPA_PROP_channelMap, /**< a channelmap array
* (Array (Id enum spa_audio_channel)) */
spa: add properties for monitor volume/mute
2021-02-05 17:11:58 +01:00
SPA_PROP_monitorMute, /**< mute (Bool) */
spa: explicitly mention that volumes are linear See #3623
2023-11-04 09:51:14 +01:00
SPA_PROP_monitorVolumes, /**< a volume array, one (linear) volume per
spa: add properties for monitor volume/mute
2021-02-05 17:11:58 +01:00
* channel (Array of Float) */
bluez5: add delay adjustment property + fallback value for a2dp-sink Not all devices report their A2DP delay. In those cases, use a fallback value of 150ms by default. Make the delay adjustable with a SPA_Prop, and expose it as a part of the route. Implement the corresponding parts in media-session.
2021-02-13 22:59:04 +02:00
SPA_PROP_latencyOffsetNsec, /**< delay adjustment */
spa: add some more docs See #3351
2023-07-17 17:46:04 +02:00
SPA_PROP_softMute, /**< mute (Bool) applied in software */
spa: explicitly mention that volumes are linear See #3623
2023-11-04 09:51:14 +01:00
SPA_PROP_softVolumes, /**< a volume array, one (linear) volume per channel
spa: add some more docs See #3351
2023-07-17 17:46:04 +02:00
* (Array of Float). 0.0 is silence, 1.0 is without
spa: explicitly mention that volumes are linear See #3623
2023-11-04 09:51:14 +01:00
* attenuation. This is the volume applied in
* software, there might be a part applied in
* hardware. */
Remove dynamic types Do not use dynamic types anymore. The reason is that it's difficult: - to maintain a shared type database over a network. - the extra overhead when translating between processes and for maintaining the translation tables. - race conditions in translating in RT-threads, this is a problem because we want to make event streams. We now have simple enums with types and extension points for all types. This is also nicer to use in general. We don't need the mapper anymore or pass strings around as types. There is a parallel type info system to get more info about ids and enums and their hierarchy. It can also be used for debugging.
2018-08-23 17:47:57 +02:00
spa: add definitions for IEC958 (S/PDIF) Add Format subtype and codec property. Add codecs to include in the format codec property. Add property to configure elements with supported codecs. Add type info.
2021-08-10 09:17:58 +02:00
SPA_PROP_iec958Codecs, /**< enabled IEC958 (S/PDIF) codecs,
* (Array (Id enum spa_audio_iec958_codec) */
spa: move audio props to audio section
2023-04-03 21:30:11 +02:00
SPA_PROP_volumeRampSamples, /**< Samples to ramp the volume over */
SPA_PROP_volumeRampStepSamples, /**< Step or incremental Samples to ramp
* the volume over */
SPA_PROP_volumeRampTime, /**< Time in millisec to ramp the volume over */
SPA_PROP_volumeRampStepTime, /**< Step or incremental Time in nano seconds
* to ramp the */
SPA_PROP_volumeRampScale, /**< the scale or graph to used to ramp the
* volume */
spa: add definitions for IEC958 (S/PDIF) Add Format subtype and codec property. Add codecs to include in the format codec property. Add property to configure elements with supported codecs. Add type info.
2021-08-10 09:17:58 +02:00
props: add some paddig between properties
2018-10-15 17:53:14 +02:00
SPA_PROP_START_Video = 0x20000, /**< video related properties */
Remove dynamic types Do not use dynamic types anymore. The reason is that it's difficult: - to maintain a shared type database over a network. - the extra overhead when translating between processes and for maintaining the translation tables. - race conditions in translating in RT-threads, this is a problem because we want to make event streams. We now have simple enums with types and extension points for all types. This is also nicer to use in general. We don't need the mapper anymore or pass strings around as types. There is a parallel type info system to get more info about ids and enums and their hierarchy. It can also be used for debugging.
2018-08-23 17:47:57 +02:00
SPA_PROP_brightness,
SPA_PROP_contrast,
SPA_PROP_saturation,
SPA_PROP_hue,
SPA_PROP_gamma,
SPA_PROP_exposure,
SPA_PROP_gain,
SPA_PROP_sharpness,
spa: add params property Some properties can be part of a params field in the Props object and contain the string key and the pod value to be configured. This is easier to use than using the regular id. Add the fact that the property is also part of params in the PropInfo.
2021-05-09 21:13:30 +02:00
SPA_PROP_START_Other = 0x80000, /**< other properties */
SPA_PROP_params, /**< simple control params
* (Struct(
* (String : key,
* Pod : value)*)) */
props: add some paddig between properties
2018-10-15 17:53:14 +02:00
SPA_PROP_START_CUSTOM = 0x1000000,
Remove dynamic types Do not use dynamic types anymore. The reason is that it's difficult: - to maintain a shared type database over a network. - the extra overhead when translating between processes and for maintaining the translation tables. - race conditions in translating in RT-threads, this is a problem because we want to make event streams. We now have simple enums with types and extension points for all types. This is also nicer to use in general. We don't need the mapper anymore or pass strings around as types. There is a parallel type info system to get more info about ids and enums and their hierarchy. It can also be used for debugging.
2018-08-23 17:47:57 +02:00
};
v4l2: handle control properties Add the right propId to properties so they can get controls. Keep track of properties and handle the io area for them Check if properties changed and update the v4l2 controls
2018-02-07 18:08:16 +01: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
/**
* \}
*/
more hacking Move plugin API to separate directory for now Add ringbuffer and way to get ringbuffer from a port
2016-06-28 12:21:56 +02: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_PARAM_PROPS_H */
Reference in a new issue Copy permalink