mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-10-29 05:40:27 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
pipewire/spa/plugins/alsa/alsa-pcm.h

363 lines
8.4 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
/* Spa ALSA Sink */
/* SPDX-FileCopyrightText: Copyright © 2018 Wim Taymans */
/* SPDX-License-Identifier: MIT */
Cleanups
2016-09-20 11:20:43 +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_ALSA_UTILS_H
#define SPA_ALSA_UTILS_H
Cleanups
2016-09-20 11:20:43 +02:00
#ifdef __cplusplus
extern "C" {
#endif
#include <stddef.h>
alsa: add dll to estimate clock drift Make delay signed in the clock io so that we can simply add it to the tick to get the hw position. Add clock drift to clock info
2018-11-09 15:24:24 +01:00
#include <math.h>
Cleanups
2016-09-20 11:20:43 +02:00
alsa: handle alsa-lib 1.1.9 alsa-lib 1.1.9 removed /usr/include/alsa from the include path, we must include <alsa/asoundlib.h>
2019-05-23 09:25:51 +02:00
#include <alsa/asoundlib.h>
alsa: include version.h to get the version macros
2023-04-14 19:49:44 +02:00
#include <alsa/version.h>
alsa: if we are passed a UCM device, make sure to open UCM UCM devices can require local data from use_case_mgr_open() but since we do that in a separate process, make sure we reopen the use case manager in case we are passed a UCM device so that the config is available. See #1251
2021-06-02 13:23:08 +02:00
#include <alsa/use-case.h>
Cleanups
2016-09-20 11:20:43 +02:00
fix includes
2019-10-25 15:01:02 +02:00
#include <spa/support/plugin.h>
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/support/loop.h>
#include <spa/utils/list.h>
spa: improve info parsing Make info parsing a bit easier to read by assigning the key and value to temporary variables. Improve the parsing of channelmap using json parser to make it support more cases. Add a unit test for channelmap parsing options.
2021-03-18 18:40:56 +01:00
#include <spa/utils/json.h>
spa: mode dll to utils
2022-03-30 17:22:26 +02:00
#include <spa/utils/dll.h>
spa: add spa_ratelimit
2023-07-11 19:25:13 +02:00
#include <spa/utils/ratelimit.h>
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/node/node.h>
Move implementation helpers to utils
2019-05-20 10:14:00 +02:00
#include <spa/node/utils.h>
node: Add id to set_io Make it possible to configure multiple io areas on a port by giving an id to set_io. Add some types to enumerate the supported ids Make an area to exchange buffers and one to specify pull ranges. The idea is to make more area types for controlable properties. Implement enumeration of IO areas in volume.
2017-11-21 19:34:37 +01:00
#include <spa/node/io.h>
alsa: make it possible to fix format
2020-12-09 20:33:57 +01:00
#include <spa/debug/types.h>
More type fixes Param ids and IO ids are now simple enums. Move some type info in one place, delete some type-info files Fix type debug Make audio layout an enum Mark more enums as enums in types so they show us with their names in the debug.
2018-08-25 12:08:29 +02:00
#include <spa/param/param.h>
spa: add some latency helpers Add more fields to the latency object. Add methods to create, parse and process latency info.
2021-05-24 18:01:19 +02:00
#include <spa/param/latency-utils.h>
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/audio/format-utils.h>
json: add helper function to parse channel positions Use the helper instead of duplicating the same code. Also add some helpers to parse a json array of uint32_t Move some functions to convert between type name and id.
2024-09-18 09:54:34 +02:00
#include <spa/param/audio/raw-json.h>
alsa: add Tag set and enum support So that we can see the tags on the sinks and sources.
2023-10-11 15:56:52 +02:00
#include <spa/param/tag-utils.h>
Cleanups
2016-09-20 11:20:43 +02:00
spa: implement a log topic for alsa
2021-09-23 14:25:32 +10:00
#include "alsa.h"
alsa: refactor dll code
2020-12-09 12:09:40 +01:00
alsa: add audio.allowed-rates param Add a construct and runtime param to limit the amount of allowed samplerates used by the node. Fixes #1932
2022-01-03 16:03:23 +01:00
#define MAX_RATES 16
alsa: use position duration as period size Use half of the configured quantum as the period size in batch mode. This gives lower latency for USB devices depending on the quantum.
2021-12-17 16:08:08 +01:00
#define DEFAULT_PERIOD 1024u
fix sign confusion
2019-01-07 15:52:42 +01:00
#define DEFAULT_RATE 48000u
#define DEFAULT_CHANNELS 2u
alsa: use chmap by default when using UCM Fixes #2648
2024-01-25 10:26:11 +01:00
/* CHMAP defaults to true when using UCM */
alsa: add option do use chmap from alsa, disable by default This should be more in line with what PulseAudio does and so lead to less surprises. See #289
2020-09-14 20:15:48 +02:00
#define DEFAULT_USE_CHMAP false
spa: make a #define for default rate and channels
2018-06-15 11:26:03 +02:00
alsa: disable htimestamp when it seems to error too much
2023-06-29 16:40:21 +02:00
#define MAX_HTIMESTAMP_ERROR 64
indent
2017-05-26 17:25:58 +02:00
struct props {
char device[64];
char device_name[128];
char card_name[128];
alsa: add option do use chmap from alsa, disable by default This should be more in line with what PulseAudio does and so lead to less surprises. See #289
2020-09-14 20:15:48 +02:00
bool use_chmap;
spa: don't use typedef for struct and enum
2017-05-25 13:28:15 +02:00
};
Cleanups
2016-09-20 11:20:43 +02:00
alsa: improve ringbuffer handling Add max-latency property to configure the maximum amount we write to the device. Only try to pull after we consumed our current buffers.
2017-10-31 15:59:08 +01:00
#define MAX_BUFFERS 32
alsa: Implement period-based wakeups Provides configuration to disable timer-based scheduling. This can be useful at low latencies, for example, where period-based interrupts might be more reliable than timers.
2023-02-28 13:55:04 -05:00
#define MAX_POLL 16
mem: remove memory stuff Remove the memory stuff from the spa API, we can do thing more simple and efficiently if we always allocate buffers outside of the plugins and only implement an alloc function on the node when it can do something clever. Move serialize code to the props/format/buffer code Make it possible to copy a format and properties.
2016-09-29 18:18:59 +02:00
indent
2017-05-26 17:25:58 +02:00
struct buffer {
buffer: remove buffer id The buffer id is not needed/used, we use the index of the buffer in the buffer array when configuring the port.
2019-01-07 17:57:03 +01:00
uint32_t id;
node: add port and node params Add a new struct spa_param_info that lists the available params on a node/port and if they are readable/writable/updated. We can use this to replace and improve the PARAM_List and also to notify property change and updates. Update elements and code to deal with this new param stuff. Add port and node info to most elements and signal changes. Use async enum_params in -inspect and use the param info to know which ones to enumerate. Use the port info to know what parameters to update in the remote-node.
2019-02-27 16:43:01 +01:00
#define BUFFER_FLAG_OUT (1<<0)
buffer: remove buffer id The buffer id is not needed/used, we use the index of the buffer in the buffer array when configuring the port.
2019-01-07 17:57:03 +01:00
uint32_t flags;
alsa: cleanups Use a periodic timer to catch underruns Small cleanups
2018-05-11 09:56:46 +02:00
struct spa_buffer *buf;
indent
2017-05-26 17:25:58 +02:00
struct spa_meta_header *h;
struct spa_list link;
Cleanups
2016-09-20 11:20:43 +02:00
};
alsa: improve capture slave resync When we underrun, send out a buffer of 0 samples and catch up next time. Detect discont in the master and resync.
2019-04-29 10:00:42 +02:00
#define BW_MAX 0.128
alsa: improve rate control Try to match the delay with the target delay. Use the rate to adjust the timeout period for master or the resampler rate for slaves.
2019-04-23 17:31:29 +02:00
#define BW_MED 0.064
#define BW_MIN 0.016
alsa: improve clock slaving for source
2019-04-25 12:53:23 +02:00
#define BW_PERIOD (3 * SPA_NSEC_PER_SEC)
alsa: add dll to estimate clock drift Make delay signed in the clock io so that we can simply add it to the tick to get the hw position. Add clock drift to clock info
2018-11-09 15:24:24 +01:00
alsa: allow override of channel map
2020-12-28 14:24:59 +01:00
struct channel_map {
uint32_t channels;
uint32_t pos[SPA_AUDIO_MAX_CHANNELS];
};
alsa: keep track of rate in card object Expose the card object and always obtain one per pcm. Keep the configured format in the card object. Add a api.alsa.multi-rate property. When multi_rate is disabled, only allow the last configured card rate on all PCMs. This works around drivers that can't handle multiple samplerates on their PCMs. With this patch it should be mostly safe to configure multiple sample rates in pipewire.conf See #1547
2021-11-23 11:28:41 +01:00
struct card {
struct spa_list link;
int ref;
uint32_t index;
snd_use_case_mgr_t *ucm;
char *ucm_prefix;
int format_ref;
uint32_t rate;
};
alsa: sync followers from the driver Keep track or the follower state and do the sync from the driver wakeup. This improves sync between devices because the sync no longer depends on when the node was woken up in the graph and scheduled. We would have been able to handle this difference by using the htimestamp but that doesn't seen to work reliably on some hardware. This is also essential for the interrupt based scheduling.
2023-09-18 14:53:15 +02:00
struct rt_state {
struct spa_list followers;
struct state *driver;
struct spa_list driver_link;
unsigned int sources_added:1;
unsigned int following:1;
};
alsa: Add a mechanism to bind ALSA controls as prop params This adds an api.alsa.bind-ctls property to alsa-pcm sink and source nodes, to bind a property to an ALSA PCM ctl. The property is an array of ctl names that should be bound. This can be handy, for example, to bind the Playback/Capture Rate controls on a USB gadget, in order to track the PCM's state via a node param. This is currently wired to be read-only, but it should be easy enough to make it writable.
2023-11-07 14:02:26 -05:00
struct bound_ctl {
char name[256];
snd_ctl_elem_info_t *info;
snd_ctl_elem_value_t *value;
};
indent
2017-05-26 17:25:58 +02:00
struct state {
struct spa_handle handle;
struct spa_node node;
struct spa_log *log;
simply use INTERFACE_Loop for the main-loop
2019-06-06 15:20:43 +02:00
struct spa_system *data_system;
indent
2017-05-26 17:25:58 +02:00
struct spa_loop *data_loop;
alsa: Move ctl sources to a main loop It doesn't make sense to hang these on the data loop, so let's have these on the main loop instead. Also avoids a potential crash while removing them (since removal happens on the main loop and the data loop might be polling while we're doing the remove).
2023-11-21 17:05:24 -05:00
struct spa_loop *main_loop;
indent
2017-05-26 17:25:58 +02:00
alsa: redirect alsa output to log file Make a custom snd_output object that redirects output to the log file.
2022-08-05 14:01:37 +02:00
FILE *log_file;
spa: add spa_ratelimit
2023-07-11 19:25:13 +02:00
struct spa_ratelimit rate_limit;
alsa: redirect alsa output to log file Make a custom snd_output object that redirects output to the log file.
2022-08-05 14:01:37 +02:00
spa: alsa: change index type The `card` structure uses `uint32_t` for its index member, on the other hand, the `state` structure uses `int`. No code depends on it being `int`, therefore change it to `uint32_t` for consistency.
2021-12-20 19:20:38 +01:00
uint32_t card_index;
alsa: keep track of rate in card object Expose the card object and always obtain one per pcm. Keep the configured format in the card object. Add a api.alsa.multi-rate property. When multi_rate is disabled, only allow the last configured card rate on all PCMs. This works around drivers that can't handle multiple samplerates on their PCMs. With this patch it should be mostly safe to configure multiple sample rates in pipewire.conf See #1547
2021-11-23 11:28:41 +01:00
struct card *card;
indent
2017-05-26 17:25:58 +02:00
snd_pcm_stream_t stream;
snd_output_t *output;
alsa: improve debug Use a new state variable to store the device name and direction so that we consistently can debug those.
2023-09-15 09:09:04 +02:00
char name[64];
indent
2017-05-26 17:25:58 +02: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_hook_list hooks;
hook: separate spa_callbacks from the hook Make a spa_callbacks with just the functions and data and use this in the hook and objects.
2019-05-15 12:17:52 +02:00
struct spa_callbacks callbacks;
indent
2017-05-26 17:25:58 +02: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
uint64_t info_all;
node: add port and node params Add a new struct spa_param_info that lists the available params on a node/port and if they are readable/writable/updated. We can use this to replace and improve the PARAM_List and also to notify property change and updates. Update elements and code to deal with this new param stuff. Add port and node info to most elements and signal changes. Use async enum_params in -inspect and use the param info to know which ones to enumerate. Use the port info to know what parameters to update in the remote-node.
2019-02-27 16:43:01 +01:00
struct spa_node_info info;
alsa: use ProcessLatency param to get and set internal latency
2021-08-17 09:14:40 +02:00
#define NODE_PropInfo 0
#define NODE_Props 1
#define NODE_IO 2
#define NODE_ProcessLatency 3
#define N_NODE_PARAMS 4
alsa: clean up port and node params
2021-05-21 11:08:52 +02:00
struct spa_param_info params[N_NODE_PARAMS];
indent
2017-05-26 17:25:58 +02:00
struct props props;
alsa: add spa_alsa_prepare() Split the spa_alsa_start() in a prepare and start function. Prepare will then also reset state and prefill the playback buffer with silence. This makes it possible to reuse the prepare function in recover().
2023-09-15 11:15:26 +02:00
unsigned int opened:1;
unsigned int prepared:1;
unsigned int started:1;
indent
2017-05-26 17:25:58 +02:00
snd_pcm_t *hndl;
bool have_format;
struct spa_audio_info current_format;
alsa: add option to configure period-size api.alsa.period-size can be set to something else than 1024 with this config option.
2021-01-05 12:44:10 +01:00
uint32_t default_period_size;
alsa: add api.alsa.period-num param To configure the amount of periods. By default we use as many as possible but it is now possible to force a value. See #1473
2021-12-17 16:09:52 +01:00
uint32_t default_period_num;
alsa: add api.alsa.headroom setting Can be used to tweak the extra distance kept between the hardware and software pointers when reading and writing. See #289
2021-01-14 17:10:05 +01:00
uint32_t default_headroom;
alsa: add start-delay parameters to sink The start-delay adds extra silence to the buffer before starting the playback. The idea is to have more time to adapt to the device startup and set the timer more accurately. See #983, #431
2021-03-29 13:20:14 +02:00
uint32_t default_start_delay;
alsa: make it possible to fix format
2020-12-09 20:33:57 +01:00
uint32_t default_format;
alsa-pcm: allow setting number of channels Allow passing the number of channels when creating a device to restrict the negotiated channels.
2020-07-01 12:54:27 +02:00
unsigned int default_channels;
alsa: add option to force a samplerate
2020-09-16 15:14:26 +02:00
unsigned int default_rate;
alsa: add audio.allowed-rates param Add a construct and runtime param to limit the amount of allowed samplerates used by the node. Fixes #1932
2022-01-03 16:03:23 +01:00
uint32_t allowed_rates[MAX_RATES];
uint32_t n_allowed_rates;
alsa: allow override of channel map
2020-12-28 14:24:59 +01:00
struct channel_map default_pos;
alsa: sync followers from the driver Keep track or the follower state and do the sync from the driver wakeup. This improves sync between devices because the sync no longer depends on when the node was woken up in the graph and scheduled. We would have been able to handle this difference by using the htimestamp but that doesn't seen to work reliably on some hardware. This is also essential for the interrupt based scheduling.
2023-09-18 14:53:15 +02:00
unsigned int disable_mmap:1;
unsigned int disable_batch:1;
unsigned int disable_tsched:1;
alsa: make it possible to configure the clock name When nodes are synchronized to a common clock, the clock name can be set to the same value on the alsa nodes and no resampling will be done.
2021-12-10 11:04:38 +01:00
char clock_name[64];
Use configured quantum_limit instead of hardcoded value Parse the quantum_limit parameters and use this to scale the buffers so that they can contain the maximum allowed samples instead of the hardcoded 8192 value. See #1931
2022-01-12 17:50:12 +01:00
uint32_t quantum_limit;
alsa-pcm: allow setting number of channels Allow passing the number of channels when creating a device to restrict the negotiated channels.
2020-07-01 12:54:27 +02:00
indent
2017-05-26 17:25:58 +02:00
snd_pcm_uframes_t buffer_frames;
snd_pcm_uframes_t period_frames;
snd_pcm_format_t format;
int rate;
int channels;
size_t frame_size;
pw-cat: fix DSF playback again Make the DSD buffers a little bigger because we scale down the rate. Read an interleaved number of samples to fill one quantum.
2022-04-28 12:32:08 +02:00
size_t frame_scale;
alsa: support planar formats
2020-07-01 11:42:10 +02:00
int blocks;
alsa: handle target better Rework how we handle the current device fill level and our desired fill level so that we handle it more consistently.
2019-09-05 13:41:59 +02:00
uint32_t delay;
uint32_t read_size;
alsa: refactor read and write functions Separate the sync logic from the read/write functions so that we can use it in the wakeup logic as well.
2023-09-15 12:21:18 +02:00
uint32_t max_read;
indent
2017-05-26 17:25:58 +02: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
uint64_t port_info_all;
node: add port and node params Add a new struct spa_param_info that lists the available params on a node/port and if they are readable/writable/updated. We can use this to replace and improve the PARAM_List and also to notify property change and updates. Update elements and code to deal with this new param stuff. Add port and node info to most elements and signal changes. Use async enum_params in -inspect and use the param info to know which ones to enumerate. Use the port info to know what parameters to update in the remote-node.
2019-02-27 16:43:01 +01:00
struct spa_port_info port_info;
alsa: use ProcessLatency param to get and set internal latency
2021-08-17 09:14:40 +02:00
#define PORT_EnumFormat 0
#define PORT_Meta 1
#define PORT_IO 2
#define PORT_Format 3
#define PORT_Buffers 4
#define PORT_Latency 5
alsa: add Tag set and enum support So that we can see the tags on the sinks and sources.
2023-10-11 15:56:52 +02:00
#define PORT_Tag 6
#define N_PORT_PARAMS 7
alsa: clean up port and node params
2021-05-21 11:08:52 +02:00
struct spa_param_info port_params[N_PORT_PARAMS];
alsa: keep track of input and output latency track and report both input and output latency.
2021-06-24 09:43:58 +02:00
enum spa_direction port_direction;
node: Add id to set_io Make it possible to configure multiple io areas on a port by giving an id to set_io. Add some types to enumerate the supported ids Make an area to exchange buffers and one to specify pull ranges. The idea is to make more area types for controlable properties. Implement enumeration of IO areas in volume.
2017-11-21 19:34:37 +01:00
struct spa_io_buffers *io;
clock: remove clock interface Remove the clock interface, we need to get timing information with an io area to get the required precision and performance.
2018-07-17 09:50:51 +02:00
struct spa_io_clock *clock;
alsa: implement set_io and handle position io Use position io for deciding the size of the output buffers in alsasrc
2018-10-24 10:27:57 +02:00
struct spa_io_position *position;
Improve rate matching and clock slaving Use a new rate_match io area to exhange rate matching info between sink/source and resampler. Compensate for the rate match delay when scheduling timeouts. Let the resampler notify the source of how many samples it needs to produce the desired quantum. Make sure we keep an extra buffer in the device to be able to make this possible. Let the adapter directly call the slave node process function.
2019-07-09 16:56:05 +02:00
struct spa_io_rate_match *rate_match;
indent
2017-05-26 17:25:58 +02:00
struct buffer buffers[MAX_BUFFERS];
unsigned int n_buffers;
struct spa_list free;
struct spa_list ready;
alsa: improve ringbuffer handling Add max-latency property to configure the maximum amount we write to the device. Only try to pull after we consumed our current buffers.
2017-10-31 15:59:08 +01:00
buffer: don't use ringbuffer in chunk We can't use a ringbuffer on the chunk because it implies the consumer would write to it to update the read position, which we can't do because the chunk is read-only and might even be shared. Go back to offset/size pairs, which can sortof do the same thing if we want later when we keep a non-shared read pointer in the consumer. Keep alsa timestamp around and filled state for future. mmap the input port meta/data/chunk as read-only. Only do clock update requests when asked.
2017-11-21 12:30:15 +01:00
size_t ready_offset;
alsa: Implement period-based wakeups Provides configuration to disable timer-based scheduling. This can be useful at low latencies, for example, where period-based interrupts might be more reliable than timers.
2023-02-28 13:55:04 -05:00
/* Either a single source for tsched, or a set of pollfds from ALSA */
struct spa_source source[MAX_POLL];
indent
2017-05-26 17:25:58 +02:00
int timerfd;
alsa: Implement period-based wakeups Provides configuration to disable timer-based scheduling. This can be useful at low latencies, for example, where period-based interrupts might be more reliable than timers.
2023-02-28 13:55:04 -05:00
struct pollfd pfds[MAX_POLL];
int n_fds;
fix sign confusion
2019-01-07 15:52:42 +01:00
uint32_t threshold;
alsa: handle quantum changes
2019-04-25 16:15:52 +02:00
uint32_t last_threshold;
alsa: handle batch devices For batch devices that are not usb devices, lower the period and add an extra period of heardoom to avoid xruns. See !330
2020-12-11 17:38:27 +01:00
uint32_t headroom;
alsa: add start-delay parameters to sink The start-delay adds extra silence to the buffer before starting the playback. The idea is to have more time to adapt to the device startup and set the timer more accurately. See #983, #431
2021-03-29 13:20:14 +02:00
uint32_t start_delay;
alsa: increase target for a52 and dca For encoded format, we need to send bigger chunks to make the encoder happy. Add a new min_delay variable with this info so that we never leave less than that amount of samples in the ringbuffer. Fixes #2650
2022-12-14 12:27:33 +01:00
uint32_t min_delay;
alsa: improve target delay in ALSA Don't just limit the max delay of samples we keep in the ALSA ringbuffer to the buffer_size but to half of it. Make this into a max_delay variable. If we have a buffer size of 8192 samples and a headroom of 8192 samples, when capturing, we would wait for the ringbuffer to contain at least 8192 samples, which would always xrun. When we limit the size to half, we can still read the data without xruns. Fixes #2972
2023-03-03 14:10:33 +01:00
uint32_t max_delay;
alsa: disable htimestamp when it seems to error too much
2023-06-29 16:40:21 +02:00
uint32_t htimestamp_error;
alsa: Added handle for controlling htimestamp autodisable You can now do this to permanently enable htimestamp: pw-cli s 38 Props '{ params: [ api.alsa.htimestamp.max-errors: 0, api.alsa.htimestamp: true ]}'
2024-02-20 08:47:03 +01:00
uint32_t htimestamp_max_errors;
Improve rate matching and clock slaving Use a new rate_match io area to exhange rate matching info between sink/source and resampler. Compensate for the rate match delay when scheduling timeouts. Let the resampler notify the source of how many samples it needs to produce the desired quantum. Make sure we keep an extra buffer in the device to be able to make this possible. Let the adapter directly call the slave node process function.
2019-07-09 16:56:05 +02:00
alsa: set the driver rate in the clock io Rename some variables to make it clear that we are dealing with the rate and duration of the driver. Set the driver rate in the clock instead of the target_rate, which we might have rejected.
2023-09-20 11:32:34 +02:00
struct spa_fraction driver_rate;
uint32_t driver_duration;
alsa: improve rate control Try to match the delay with the target delay. Use the rate to adjust the timeout period for master or the resampler rate for slaves.
2019-04-23 17:31:29 +02:00
unsigned int alsa_started:1;
unsigned int alsa_sync:1;
alsa-pcm: Do not log warning when resync was expected Log as info instead of warning when alsa sync was expected.
2022-05-11 17:41:56 +02:00
unsigned int alsa_sync_warning:1;
slave -> follower We use master/follower terminology everywhere.
2020-02-21 10:47:32 +01:00
unsigned int following:1;
alsa: Disable rate matching for the same card Add a clock name to the clock, remove the old api/clock_id. This makes it easier to add descriptive names Place the alsa card number in the clock name. Check the clock name of the master clock and if it matches our own clock, disable rate matching.
2019-10-23 16:04:03 +02:00
unsigned int matching:1;
alsa-pcm: also follow resampler insize when resampling Use the input size of the resampler as the amount of samples to read when we are resampling.
2020-07-27 15:56:20 +02:00
unsigned int resample:1;
alsa: add read/write access mode Add support for read/write access mode when mmap is not available. See #526
2021-01-05 17:48:09 +01:00
unsigned int use_mmap:1;
unsigned int planar:1;
alsa: pause/resume when entering/exiting freewheel When we start freewheeling, pause the device and resume when we finish freewheel. In freewheel mode, just discard samples in the sink and produce silence in the source.
2021-05-07 11:51:22 +02:00
unsigned int freewheel:1;
alsa: rework UCM open Use _alibpref to check if a device needs a UCM local config. Mark the device as such and use this to set the OPEN_UCM property on the device. Open the UCM for a card when the device has the property set. Use the same logic for loading the UCM as the acp code. See #1251
2021-06-02 17:25:21 +02:00
unsigned int open_ucm:1;
alsa: add enumeration of iec958 format For hdmi and iec958 devices, enumerate the iec958 formats and codecs. Initially only PCM is supported as a codec but with a property or an init option, the list of codecs can be dynamically configured.
2021-08-12 14:08:20 +02:00
unsigned int is_iec958:1;
unsigned int is_hdmi:1;
alsa: keep track of rate in card object Expose the card object and always obtain one per pcm. Keep the configured format in the card object. Add a api.alsa.multi-rate property. When multi_rate is disabled, only allow the last configured card rate on all PCMs. This works around drivers that can't handle multiple samplerates on their PCMs. With this patch it should be mostly safe to configure multiple sample rates in pipewire.conf See #1547
2021-11-23 11:28:41 +01:00
unsigned int multi_rate:1;
alsa: add option to disable htimestamps Add api.alsa.htimestamp to disable the use of hires timestamps.
2023-06-29 16:23:39 +02:00
unsigned int htimestamp:1;
alsa: add device.profile.pro property It is set to true when the node is using a pro audio profile.
2023-08-28 10:06:29 +02:00
unsigned int is_pro:1;
alsa: rework the state sync code Make one function to sync the state with the realtime thread.
2023-09-18 14:46:56 +02:00
unsigned int sources_added:1;
alsa: add api.alsa.auto-link option Add an option to automatically use snd_pcm_link when the follower clock is matching the driver. Only set this to true in pro-audio and when nodes are scheduled together. See #3556
2023-10-09 10:10:46 +02:00
unsigned int auto_link:1;
alsa: link driver and follower When we are using the same clock (!matching) try to link the two PCM devices together. This starts and stops the devices at the same time and gives better latency.
2023-09-11 11:04:49 +02:00
unsigned int linked:1;
alsa: improve headroom calculations Make a function to recalculate the headroom and call it whenever the resample state of the node can change. When we are IRQ based scheduling but need to resample, we are actually not driving the graph whit IRQ and need to adjust our period size and headroom as if we are using timers.
2023-10-18 14:45:47 +02:00
unsigned int is_batch:1;
alsa-pcm: don't force quantum for iec958 formats This fixes an issue introduced in 771f71f62242284a7041a574122ff731f9c706a8 where the quantum is forced and may break applications the specify their own quantum. Signed-off-by: Lukas Rusak <lorusak@gmail.com>
2024-04-27 13:28:51 -07:00
unsigned int force_rate:1;
alsa: add enumeration of iec958 format For hdmi and iec958 devices, enumerate the iec958 formats and codecs. Initially only PCM is supported as a codec but with a property or an init option, the list of codecs can be dynamically configured.
2021-08-12 14:08:20 +02:00
uint64_t iec958_codecs;
indent
2017-05-26 17:25:58 +02:00
int64_t sample_count;
alsa: rework timing Use a DLL to track the hardware pointer and use this to set the timer. Handle XRUN and recover.
2018-11-16 17:00:40 +01:00
int64_t sample_time;
uint64_t next_time;
alsa: improve rate control Try to match the delay with the target delay. Use the rate to adjust the timeout period for master or the resampler rate for slaves.
2019-04-23 17:31:29 +02:00
uint64_t base_time;
alsa: report underrun better
2017-10-24 18:04:03 +02:00
uint64_t underrun;
alsa: improve rate control Try to match the delay with the target delay. Use the rate to adjust the timeout period for master or the resampler rate for slaves.
2019-04-23 17:31:29 +02:00
alsa: refactor dll code
2020-12-09 12:09:40 +01:00
struct spa_dll dll;
alsa: various improvements Remove some magic constants that are not needed anymore with the headroom. Clamp the error to some reasonable value so that we don't adjust the rate too much but still apply all of the correction calculated by the dll. Remove the bandwidth adjustment. Also update the matching and resample fields when we reassign the node to a new driver. This could cause the new follower to not activate the adaptive resampler and get out of sync.
2021-03-03 15:40:10 +01:00
double max_error;
alsa: separate max_error and max_resync Use a separate variable to hold the maximum amount of drift we allow between driver and follower. Ensure this value is smaller than the max_error and period size so that we have at most 1 period of drift.
2023-04-10 16:28:55 +02:00
double max_resync;
alsa: dynamically adjust the DLL bandwidth Keep a running average and variance of the error. Use this to periodically update the DLL bandwidth. When the variance gets smaller, we update the DLL more slowly to stay closer to the ideal rate. This seems to improve the rate stability.
2024-10-04 10:47:47 +02:00
double err_avg, err_var, err_wdw;
spa: Implement latency reporting Implement latency reporting in alsa Implement latency reporting on audioconf by passing on the latency from the follower to outside of the adapter.
2021-05-21 10:01:37 +02:00
alsa: keep track of input and output latency track and report both input and output latency.
2021-06-24 09:43:58 +02:00
struct spa_latency_info latency[2];
alsa: use ProcessLatency param to get and set internal latency
2021-08-17 09:14:40 +02:00
struct spa_process_latency_info process_latency;
alsa: Implement playback/capture rate control for USB gadgets If we detect Playback/Capture Pitch 1000000, we can adjust those values to update the feedback endpoint for the host. On the capture side, this will instruct the host to adjust the rate at which data is being sent. On the playback side, this will adjust the amount of data the USB gadget driver sends out in each USB tick.
2023-06-08 17:37:04 -04:00
alsa: add Tag set and enum support So that we can see the tags on the sinks and sources.
2023-10-11 15:56:52 +02:00
struct spa_pod *tag[2];
alsa: Add a mechanism to bind ALSA controls as prop params This adds an api.alsa.bind-ctls property to alsa-pcm sink and source nodes, to bind a property to an ALSA PCM ctl. The property is an array of ctl names that should be bound. This can be handy, for example, to bind the Playback/Capture Rate controls on a USB gadget, in order to track the PCM's state via a node param. This is currently wired to be read-only, but it should be easy enough to make it writable.
2023-11-07 14:02:26 -05:00
/* for rate match and bind ctls */
alsa: Implement playback/capture rate control for USB gadgets If we detect Playback/Capture Pitch 1000000, we can adjust those values to update the feedback endpoint for the host. On the capture side, this will instruct the host to adjust the rate at which data is being sent. On the playback side, this will adjust the amount of data the USB gadget driver sends out in each USB tick.
2023-06-08 17:37:04 -04:00
snd_ctl_t *ctl;
alsa: Add a mechanism to bind ALSA controls as prop params This adds an api.alsa.bind-ctls property to alsa-pcm sink and source nodes, to bind a property to an ALSA PCM ctl. The property is an array of ctl names that should be bound. This can be handy, for example, to bind the Playback/Capture Rate controls on a USB gadget, in order to track the PCM's state via a node param. This is currently wired to be read-only, but it should be easy enough to make it writable.
2023-11-07 14:02:26 -05:00
/* Rate match via an ALSA ctl */
alsa: Implement playback/capture rate control for USB gadgets If we detect Playback/Capture Pitch 1000000, we can adjust those values to update the feedback endpoint for the host. On the capture side, this will instruct the host to adjust the rate at which data is being sent. On the playback side, this will adjust the amount of data the USB gadget driver sends out in each USB tick.
2023-06-08 17:37:04 -04:00
snd_ctl_elem_value_t *pitch_elem;
double last_rate;
alsa: keep states in global list
2023-09-18 09:40:52 +02:00
alsa: Add a mechanism to bind ALSA controls as prop params This adds an api.alsa.bind-ctls property to alsa-pcm sink and source nodes, to bind a property to an ALSA PCM ctl. The property is an array of ctl names that should be bound. This can be handy, for example, to bind the Playback/Capture Rate controls on a USB gadget, in order to track the PCM's state via a node param. This is currently wired to be read-only, but it should be easy enough to make it writable.
2023-11-07 14:02:26 -05:00
/* ALSA ctls exposed as params */
unsigned int num_bind_ctls;
struct bound_ctl bound_ctls[16];
spa: alsa: Read ctl events instead of doing a global diff This does a couple of things: first, we implement revents demangling, which seems to be required (although hw: devices work fine without it). The second is to actually read the ctl events so we can tell when elements we care about have changed, instead of reading everything and trying to do a diff. The latter is also required from a correctness perspective, as otherwise the ctl might keep triggering wakeups while the fd is ready to be read.
2024-03-14 10:13:41 -04:00
struct pollfd ctl_pfds[MAX_POLL];
alsa: Add a mechanism to bind ALSA controls as prop params This adds an api.alsa.bind-ctls property to alsa-pcm sink and source nodes, to bind a property to an ALSA PCM ctl. The property is an array of ctl names that should be bound. This can be handy, for example, to bind the Playback/Capture Rate controls on a USB gadget, in order to track the PCM's state via a node param. This is currently wired to be read-only, but it should be easy enough to make it writable.
2023-11-07 14:02:26 -05:00
struct spa_source ctl_sources[MAX_POLL];
int ctl_n_fds;
alsa: keep states in global list
2023-09-18 09:40:52 +02:00
struct spa_list link;
alsa: sync followers from the driver Keep track or the follower state and do the sync from the driver wakeup. This improves sync between devices because the sync no longer depends on when the node was woken up in the graph and scheduled. We would have been able to handle this difference by using the htimestamp but that doesn't seen to work reliably on some hardware. This is also essential for the interrupt based scheduling.
2023-09-18 14:53:15 +02:00
struct spa_list followers;
struct state *driver;
struct spa_list driver_link;
struct rt_state rt;
Cleanups
2016-09-20 11:20:43 +02:00
};
alsa: expose all config options as params Add PropInfo for all the params that we can configure at construct time and also add them as PROP_params. This way you can configure the headroom at runtime with this: pw-cli s <id> Props '{ params = [ "api.alsa.headroom" 1024 ] }'
2021-11-30 17:43:07 +01:00
struct spa_pod *spa_alsa_enum_propinfo(struct state *state,
alsa: don't set id in PropInfo for params The id is useless when dealing with props params, we need to use the name of the property as the key. Also the id can clash with other ids of other plugins.
2021-12-01 11:39:30 +01:00
uint32_t idx, struct spa_pod_builder *b);
alsa: expose all config options as params Add PropInfo for all the params that we can configure at construct time and also add them as PROP_params. This way you can configure the headroom at runtime with this: pw-cli s <id> Props '{ params = [ "api.alsa.headroom" 1024 ] }'
2021-11-30 17:43:07 +01:00
int spa_alsa_add_prop_params(struct state *state, struct spa_pod_builder *b);
int spa_alsa_parse_prop_params(struct state *state, struct spa_pod *params);
int spa_alsa_enum_format(struct state *state, int seq,
node: improve async handling Remove the done and error callbacks. The error callback is in an error message. The done callback is replace with spa_pending. Make enum_params take a callback and data for the results. This allows us to push the results one after another to the app and avoids ownership issues of the passed data. We can then extend this to handle the async case by doing a _wait call with a spa_pending+callback+data that will be called when the _enum_params returns and async result. Add a sync method. All methods can now return SPA_RESULT_IS_ASYNC return values and you can use spa_node_wait() to register a callback when they complete with optional extra parameters. This makes it easier to sync and handle the reply. Make helper methods to simulate the sync enum_params behaviour for sync nodes. Let the transport generate the sequence number for pw_resource_sync() and pw_proxy_sync(). That way we don't need to keep track of numbers ourselves and we can match the reply to the request easily.
2019-02-20 17:51:05 +01:00
uint32_t start, uint32_t num,
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 enum_format
2017-04-04 19:44:00 +02:00
indent
2017-05-26 17:25:58 +02:00
int spa_alsa_set_format(struct state *state, struct spa_audio_info *info, uint32_t flags);
alsa: Implement playback/capture rate control for USB gadgets If we detect Playback/Capture Pitch 1000000, we can adjust those values to update the feedback endpoint for the host. On the capture side, this will instruct the host to adjust the rate at which data is being sent. On the playback side, this will adjust the amount of data the USB gadget driver sends out in each USB tick.
2023-06-08 17:37:04 -04:00
int spa_alsa_update_rate_match(struct state *state);
Cleanups
2016-09-20 11:20:43 +02:00
alsa: refactor property parsing Move the common property parsing to the init function.
2021-11-23 12:27:36 +01:00
int spa_alsa_init(struct state *state, const struct spa_dict *info);
alsa: if we are passed a UCM device, make sure to open UCM UCM devices can require local data from use_case_mgr_open() but since we do that in a separate process, make sure we reopen the use case manager in case we are passed a UCM device so that the config is available. See #1251
2021-06-02 13:23:08 +02:00
int spa_alsa_clear(struct state *state);
alsa: pass AES bits to S/PDIF devices This is the right thing to do and might even fix output to some devices.
2021-09-14 12:42:03 +02:00
int spa_alsa_open(struct state *state, const char *params);
alsa: add spa_alsa_prepare() Split the spa_alsa_start() in a prepare and start function. Prepare will then also reset state and prefill the playback buffer with silence. This makes it possible to reuse the prepare function in recover().
2023-09-15 11:15:26 +02:00
int spa_alsa_prepare(struct state *state);
alsa: rework timing Use a DLL to track the hardware pointer and use this to set the timer. Handle XRUN and recover.
2018-11-16 17:00:40 +01:00
int spa_alsa_start(struct state *state);
slave -> follower We use master/follower terminology everywhere.
2020-02-21 10:47:32 +01:00
int spa_alsa_reassign_follower(struct state *state);
alsa: rework timing Use a DLL to track the hardware pointer and use this to set the timer. Handle XRUN and recover.
2018-11-16 17:00:40 +01:00
int spa_alsa_pause(struct state *state);
indent
2017-05-26 17:25:58 +02:00
int spa_alsa_close(struct state *state);
Cleanups
2016-09-20 11:20:43 +02:00
alsa: add read/write access mode Add support for read/write access mode when mmap is not available. See #526
2021-01-05 17:48:09 +01:00
int spa_alsa_write(struct state *state);
alsa: pause/resume when entering/exiting freewheel When we start freewheeling, pause the device and resume when we finish freewheel. In freewheel mode, just discard samples in the sink and produce silence in the source.
2021-05-07 11:51:22 +02:00
int spa_alsa_read(struct state *state);
int spa_alsa_skip(struct state *state);
alsa: add dll to estimate clock drift Make delay signed in the clock io so that we can simply add it to the tick to get the hw position. Add clock drift to clock info
2018-11-09 15:24:24 +01:00
alsa: fix buffer recycle We only set the OUT flag when we put the buffer on an io area and might need to recycle later. Before placing the output buffer into the io area, recycle any buffer that might be left in there. Only emit the ready callback when we have some data queued.
2020-03-19 13:12:49 +01:00
void spa_alsa_recycle_buffer(struct state *state, uint32_t buffer_id);
alsa: Share node/port info emission code between sink and source It's mostly the same, and it allows us to trigger this code in the shared alsa-pcm.c code as well.
2023-11-07 13:01:52 -05:00
void spa_alsa_emit_node_info(struct state *state, bool full);
void spa_alsa_emit_port_info(struct state *state, bool full);
spa: improve info parsing Make info parsing a bit easier to read by assigning the key and value to temporary variables. Improve the parsing of channelmap using json parser to make it support more cases. Add a unit test for channelmap parsing options.
2021-03-18 18:40:56 +01:00
static inline void spa_alsa_parse_position(struct channel_map *map, const char *val, size_t len)
{
json: add helper function to parse channel positions Use the helper instead of duplicating the same code. Also add some helpers to parse a json array of uint32_t Move some functions to convert between type name and id.
2024-09-18 09:54:34 +02:00
spa_audio_parse_position(val, len, map->pos, &map->channels);
spa: improve info parsing Make info parsing a bit easier to read by assigning the key and value to temporary variables. Improve the parsing of channelmap using json parser to make it support more cases. Add a unit test for channelmap parsing options.
2021-03-18 18:40:56 +01:00
}
alsa: add audio.allowed-rates param Add a construct and runtime param to limit the amount of allowed samplerates used by the node. Fixes #1932
2022-01-03 16:03:23 +01:00
static inline uint32_t spa_alsa_parse_rates(uint32_t *rates, uint32_t max, const char *val, size_t len)
{
json: add helper function to parse channel positions Use the helper instead of duplicating the same code. Also add some helpers to parse a json array of uint32_t Move some functions to convert between type name and id.
2024-09-18 09:54:34 +02:00
return spa_json_str_array_uint32(val, len, rates, max);
alsa: add audio.allowed-rates param Add a construct and runtime param to limit the amount of allowed samplerates used by the node. Fixes #1932
2022-01-03 16:03:23 +01:00
}
alsa: add enumeration of iec958 format For hdmi and iec958 devices, enumerate the iec958 formats and codecs. Initially only PCM is supported as a codec but with a property or an init option, the list of codecs can be dynamically configured.
2021-08-12 14:08:20 +02:00
static inline uint32_t spa_alsa_iec958_codec_from_name(const char *name)
{
json: add helper function to parse channel positions Use the helper instead of duplicating the same code. Also add some helpers to parse a json array of uint32_t Move some functions to convert between type name and id.
2024-09-18 09:54:34 +02:00
return spa_type_audio_iec958_codec_from_short_name(name);
alsa: add enumeration of iec958 format For hdmi and iec958 devices, enumerate the iec958 formats and codecs. Initially only PCM is supported as a codec but with a property or an init option, the list of codecs can be dynamically configured.
2021-08-12 14:08:20 +02:00
}
static inline void spa_alsa_parse_iec958_codecs(uint64_t *codecs, const char *val, size_t len)
{
spa: add spa_json_begin_array/object and relaxed versions Add spa_json_begin_array/object to replace spa_json_init+spa_json_begin_array/object This function is better because it does not waste a useless spa_json structure as an iterator. The relaxed versions also error out when the container is mismatched because parsing a mismatched container is not going to give any results anyway.
2024-09-13 13:09:54 +02:00
struct spa_json it[1];
alsa: add enumeration of iec958 format For hdmi and iec958 devices, enumerate the iec958 formats and codecs. Initially only PCM is supported as a codec but with a property or an init option, the list of codecs can be dynamically configured.
2021-08-12 14:08:20 +02:00
char v[256];
spa: add spa_json_begin_array/object and relaxed versions Add spa_json_begin_array/object to replace spa_json_init+spa_json_begin_array/object This function is better because it does not waste a useless spa_json structure as an iterator. The relaxed versions also error out when the container is mismatched because parsing a mismatched container is not going to give any results anyway.
2024-09-13 13:09:54 +02:00
if (spa_json_begin_array_relax(&it[0], val, len) <= 0)
return;
alsa: add enumeration of iec958 format For hdmi and iec958 devices, enumerate the iec958 formats and codecs. Initially only PCM is supported as a codec but with a property or an init option, the list of codecs can be dynamically configured.
2021-08-12 14:08:20 +02:00
*codecs = 0;
spa: add spa_json_begin_array/object and relaxed versions Add spa_json_begin_array/object to replace spa_json_init+spa_json_begin_array/object This function is better because it does not waste a useless spa_json structure as an iterator. The relaxed versions also error out when the container is mismatched because parsing a mismatched container is not going to give any results anyway.
2024-09-13 13:09:54 +02:00
while (spa_json_get_string(&it[0], v, sizeof(v)) > 0)
alsa: add enumeration of iec958 format For hdmi and iec958 devices, enumerate the iec958 formats and codecs. Initially only PCM is supported as a codec but with a property or an init option, the list of codecs can be dynamically configured.
2021-08-12 14:08:20 +02:00
*codecs |= 1ULL << spa_alsa_iec958_codec_from_name(v);
}
static inline uint32_t spa_alsa_get_iec958_codecs(struct state *state, uint32_t *codecs,
uint32_t max_codecs)
{
uint64_t mask = state->iec958_codecs;
uint32_t i = 0, j = 0;
alsa: only list IEC958 codecs when iec958 or hdmi device.
2021-08-18 10:52:04 +02:00
if (!(state->is_iec958 || state->is_hdmi))
return 0;
alsa: add enumeration of iec958 format For hdmi and iec958 devices, enumerate the iec958 formats and codecs. Initially only PCM is supported as a codec but with a property or an init option, the list of codecs can be dynamically configured.
2021-08-12 14:08:20 +02:00
while (mask && i < max_codecs) {
if (mask & 1)
codecs[i++] = j;
mask >>= 1;
j++;
}
return i;
}
alsa: hopefully fix compilation on ubuntu CI
2023-04-17 10:05:54 +02:00
/* This function is also as snd_pcm_channel_area_addr() since 1.2.6 which is not yet
* in ubuntu and I can't figure out how to do the ALSA version check. */
alsa: handle old alsa version Out Ubuntu CI seems to have an older alsa version that doesn't have snd_pcm_channel_area_addr so include it here.
2023-04-14 19:25:51 +02:00
static inline void *channel_area_addr(const snd_pcm_channel_area_t *area, snd_pcm_uframes_t offset)
{
return (char *)area->addr + (area->first + area->step * offset) / 8;
}
alsa: rate limit some warnings
2022-09-21 15:52:24 +02:00
Cleanups
2016-09-20 11:20:43 +02:00
#ifdef __cplusplus
indent
2017-05-26 08:05:01 +02:00
} /* extern "C" */
Cleanups
2016-09-20 11:20:43 +02:00
#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_ALSA_UTILS_H */
Reference in a new issue Copy permalink