Read-write client delay instead of adjustments

Author: arkq

doc/bluealsa-plugins.7.rst

@@ -429,7 +429,7 @@ CTL Parameters
 
   EXT
     Causes the plugin to include extra controls. These are the controls for
-    Bluetooth codec selection, volume mode selection, delay adjustment (sync)
+    Bluetooth codec selection, volume mode selection, client delay (sync)
     and/or battery level indicator.
     If the value is **yes** then all of these additional controls are included;
     if the value is **no** then none of them are included. The default is
@@ -452,13 +452,13 @@ CTL Parameters
     See the `Volume control` section in the ``bluealsad(8)`` for more
     information on the software volume setting.
 
-    The delay adjustment controls are called "Sync". They can be used to apply
+    The client delay controls are called "Sync". They can be used to apply
     a fixed adjustment to the delay reported by the associated PCM to the
     application, and may be useful with applications that need to synchronize
     the bluetooth audio stream with some some other stream, such as a video.
     The values are in milliseconds from ``-3275 ms`` to ``+3275 ms`` in steps
     of ``25 ms``. The playback control has index 0 and the capture control has
-    index 1. Each codec supported by a PCM has its own delay adjustment value.
+    index 1. Each codec supported by a PCM has its own client delay value.
     Note that this control changes only the delay value reported to the
     application by ALSA, it does not affect the actual delay (latency) of the
     PCM stream. Values set by this control type are saved in the BlueALSA

doc/bluealsactl.1.rst

@@ -195,16 +195,15 @@ soft-volume *PCM_PATH* [*STATE*]
     for soft-volume on, or **off**, **no**, **false**, **n** or **0** for
     soft-volume off.
 
-delay-adjustment *PCM_PATH* [*ADJUSTMENT*]
-    Get or set the DelayAdjustment property of the given PCM for the current
-    codec.
+client-delay *PCM_PATH* [[-]\ *DELAY*]
+    Get or set the ClientDelay property of the given PCM.
 
-    If the *ADJUSTMENT* argument is given, set the DelayAdjustment property for
-    the current codec in the given PCM. This property may be used by clients to
+    If the *DELAY* argument is given, set the ClientDelay property for the
+    given PCM. This property may be used by clients to
     adjust the reported audio delay and may be useful with PCM devices that do
     not report an accurate Delay property.
 
-    The *ADJUSTMENT* value is in milliseconds and must be a decimal number with
+    The *DELAY* value is in milliseconds and must be a decimal number with
     optional sign prefix (e.g. **250**, **-500**, **+360.4**). The permitted
     range is [-3276.8, 3276.7].
 

doc/org.bluealsa.PCM1.7.rst

@@ -80,22 +80,6 @@ void SelectCodec(string codec, dict props)
         dbus.Error.NotSupported
         dbus.Error.Failed
 
-void SetDelayAdjustment(string codec, int16 adjustment)
-    Set an arbitrary adjustment (+/-) to the reported Delay in 1/10 of
-    millisecond for a specific codec. This adjustment is applied to the Delay
-    property when that codec is selected, and can be used to compensate for
-    devices that do not report accurate Delay values.
-
-    Possible Errors:
-    ::
-
-        dbus.Error.InvalidArguments
-
-array{string, int16} GetDelayAdjustments()
-    Return the array of currently set delay adjustments. Each entry of the
-    array gives the name of a codec and the adjustment that the PCM will apply
-    to the Delay property when that codec is selected.
-
 Properties
 ----------
 
@@ -165,10 +149,14 @@ array{byte} CodecConfiguration [readonly]
 uint16 Delay [readonly]
     Approximate PCM delay in 1/10 of millisecond.
 
-int16 DelayAdjustment [readonly]
-    An adjustment (+/-) included within the reported Delay in 1/10 of
-    millisecond to compensate for devices that do not report accurate delay
-    values.
+int16 ClientDelay [readwrite]
+    Positive (or negative) client side delay in 1/10 of millisecond.
+
+    This property shall be set by the client in order to account for the client
+    side delay. In case of PCM source it shall be set to a value reported by a
+    playback subsystem to account for playback delay. In case of PCM sink it
+    can be used to adjust the Delay property to compensate for devices that do
+    not report accurate delay values.
 
 boolean SoftVolume [readwrite]
     This property determines whether BlueALSA will make volume control

misc/bash-completion/bluealsad

@@ -291,7 +291,7 @@ _bluealsactl() {
 
 	# the command names supported by this version of bluealsactl
 	local simple_commands="list-pcms list-services monitor status"
-	local path_commands="codec delay-adjustment info mute open soft-volume volume"
+	local path_commands="codec client-delay info mute open soft-volume volume"
 
 	# options that may appear before or after the command
 	local global_shortopts="-h"

src/asound/bluealsa-ctl.c

@@ -131,7 +131,7 @@ struct bluealsa_ctl {
 	bool show_codec;
 	/* if true, show volume mode control */
 	bool show_vol_mode;
-	/* if true, show delay adjustment sync control */
+	/* if true, show client delay sync control */
 	bool show_delay_sync;
 	/* if true, show battery level indicator */
 	bool show_battery;
@@ -707,7 +707,7 @@ static size_t bluealsa_elem_list_add_pcm_elems(struct bluealsa_ctl *ctl,
 		n++;
 	}
 
-	/* add special delay adjustment "sync" element */
+	/* add special client delay "sync" element */
 	if (ctl->show_delay_sync) {
 		elem_list[n].type = CTL_ELEM_TYPE_DELAY_SYNC;
 		elem_list[n].dev = dev;
@@ -1243,7 +1243,7 @@ static int bluealsa_read_enumerated(snd_ctl_ext_t *ext, snd_ctl_ext_key_t key,
 		items[0] = pcm->soft_volume ? 1 : 0;
 		break;
 	case CTL_ELEM_TYPE_DELAY_SYNC:
-		items[0] = DIV_ROUND(pcm->delay_adjustment - INT16_MIN, DELAY_SYNC_STEP);
+		items[0] = DIV_ROUND(pcm->client_delay - INT16_MIN, DELAY_SYNC_STEP);
 		break;
 	case CTL_ELEM_TYPE_BATTERY:
 	case CTL_ELEM_TYPE_SWITCH:
@@ -1296,16 +1296,16 @@ static int bluealsa_write_enumerated(snd_ctl_ext_t *ext, snd_ctl_ext_key_t key,
 			return 0;
 		pcm->soft_volume = soft_volume;
 		if (!ba_dbus_pcm_update(&ctl->dbus_ctx, pcm, BLUEALSA_PCM_SOFT_VOLUME, NULL))
-			return -ENOMEM;
+			return -EIO;
 		break;
 	case CTL_ELEM_TYPE_DELAY_SYNC:
 		if (items[0] >= DELAY_SYNC_NUM_VALUES)
 			return -EINVAL;
-		const int16_t delay_adjustment = items[0] * DELAY_SYNC_STEP + DELAY_SYNC_MIN_VALUE;
-		if (pcm->delay_adjustment == delay_adjustment)
+		const int16_t delay = items[0] * DELAY_SYNC_STEP + DELAY_SYNC_MIN_VALUE;
+		if (pcm->client_delay == delay)
 			return 0;
-		if (!ba_dbus_pcm_set_delay_adjustment(&ctl->dbus_ctx, pcm->pcm_path,
-					pcm->codec.name, delay_adjustment, NULL))
+		pcm->client_delay = delay;
+		if (!ba_dbus_pcm_update(&ctl->dbus_ctx, pcm, BLUEALSA_PCM_CLIENT_DELAY, NULL))
 			return -EIO;
 		process_events(&ctl->ext);
 		break;

src/asound/bluealsa-pcm.c

@@ -934,6 +934,8 @@ static snd_pcm_sframes_t bluealsa_calculate_delay(snd_pcm_ioplug_t *io) {
 
 	/* data transfer (communication) and encoding/decoding */
 	delay += (io->rate / 100) * pcm->ba_pcm.delay / 100;
+	/* additional delay specified by the client */
+	delay += (io->rate / 100) * pcm->ba_pcm.client_delay / 100;
 
 	delay += pcm->delay_ex;
 

src/ba-transport-pcm.c

@@ -85,15 +85,12 @@ int transport_pcm_init(
 
 	pthread_mutex_init(&pcm->mutex, NULL);
 	pthread_mutex_init(&pcm->state_mtx, NULL);
-	pthread_mutex_init(&pcm->delay_adjustments_mtx, NULL);
 	pthread_mutex_init(&pcm->client_mtx, NULL);
 	pthread_cond_init(&pcm->cond, NULL);
 
 	if (pipe(pcm->pipe) == -1)
 		return -1;
 
-	pcm->delay_adjustments = g_hash_table_new(NULL, NULL);
-
 	pcm->ba_dbus_path = g_strdup_printf("%s/%s/%s",
 			t->d->ba_dbus_path, transport_get_dbus_path_type(t->profile),
 			mode == BA_TRANSPORT_PCM_MODE_SOURCE ? "source" : "sink");
@@ -110,7 +107,6 @@ void transport_pcm_free(
 
 	pthread_mutex_destroy(&pcm->mutex);
 	pthread_mutex_destroy(&pcm->state_mtx);
-	pthread_mutex_destroy(&pcm->delay_adjustments_mtx);
 	pthread_mutex_destroy(&pcm->client_mtx);
 	pthread_cond_destroy(&pcm->cond);
 
@@ -119,7 +115,6 @@ void transport_pcm_free(
 	if (pcm->pipe[1] != -1)
 		close(pcm->pipe[1]);
 
-	g_hash_table_unref(pcm->delay_adjustments);
 	g_free(pcm->ba_dbus_path);
 
 }
@@ -726,7 +721,6 @@ int ba_transport_pcm_get_delay(const struct ba_transport_pcm *pcm) {
 	const struct ba_transport *t = pcm->t;
 
 	int delay = pcm->codec_delay_dms + pcm->processing_delay_dms;
-	delay += ba_transport_pcm_delay_adjustment_get(pcm);
 
 	if (t->profile & BA_TRANSPORT_PROFILE_MASK_A2DP)
 		delay += t->a2dp.delay;
@@ -736,33 +730,6 @@ int ba_transport_pcm_get_delay(const struct ba_transport_pcm *pcm) {
 	return delay;
 }
 
-int16_t ba_transport_pcm_delay_adjustment_get(
-		const struct ba_transport_pcm *pcm) {
-
-	struct ba_transport *t = pcm->t;
-	uint32_t codec_id = ba_transport_get_codec(t);
-	int16_t adjustment = 0;
-
-	pthread_mutex_lock(MUTABLE(&pcm->delay_adjustments_mtx));
-	void *val = g_hash_table_lookup(pcm->delay_adjustments, GINT_TO_POINTER(codec_id));
-	pthread_mutex_unlock(MUTABLE(&pcm->delay_adjustments_mtx));
-
-	if (val != NULL)
-		adjustment = GPOINTER_TO_INT(val);
-
-	return adjustment;
-}
-
-void ba_transport_pcm_delay_adjustment_set(
-		struct ba_transport_pcm *pcm,
-		uint32_t codec_id,
-		int16_t adjustment) {
-	pthread_mutex_lock(&pcm->delay_adjustments_mtx);
-	g_hash_table_insert(pcm->delay_adjustments,
-			GINT_TO_POINTER(codec_id), GINT_TO_POINTER(adjustment));
-	pthread_mutex_unlock(&pcm->delay_adjustments_mtx);
-}
-
 const char *ba_transport_pcm_channel_to_string(
 		enum ba_transport_pcm_channel channel) {
 	switch (channel) {

src/ba-transport-pcm.h

@@ -129,12 +129,8 @@ struct ba_transport_pcm {
 	 * the host computational power. It is used to compensate for the time
 	 * required to encode or decode audio. */
 	unsigned int processing_delay_dms;
-
-	/* guard delay adjustments access */
-	pthread_mutex_t delay_adjustments_mtx;
-	/* PCM delay adjustments in 1/10 of millisecond, set by client API to allow
-	 * user correction of delay reporting inaccuracy. */
-	GHashTable *delay_adjustments;
+	/* Positive (or negative) delay reported by the client. */
+	int client_delay_dms;
 
 	/* indicates whether FIFO buffer was synchronized */
 	bool synced;
@@ -260,13 +256,6 @@ int ba_transport_pcm_get_hardware_volume(
 int ba_transport_pcm_get_delay(
 		const struct ba_transport_pcm *pcm);
 
-int16_t ba_transport_pcm_delay_adjustment_get(
-		const struct ba_transport_pcm *pcm);
-void ba_transport_pcm_delay_adjustment_set(
-		struct ba_transport_pcm *pcm,
-		uint32_t codec_id,
-		int16_t adjustment);
-
 const char *ba_transport_pcm_channel_to_string(
 		enum ba_transport_pcm_channel channel);
 

src/ba-transport.c

@@ -816,6 +816,12 @@ void ba_transport_unref(struct ba_transport *t) {
 	if (ref_count > 0)
 		return;
 
+	debug("Freeing transport: %s", ba_transport_debug_name(t));
+	g_assert_cmpint(ref_count, ==, 0);
+
+	if (t->bt_fd != -1)
+		close(t->bt_fd);
+
 	if (t->profile & BA_TRANSPORT_PROFILE_MASK_A2DP) {
 		storage_pcm_data_update(&t->a2dp.pcm);
 		storage_pcm_data_update(&t->a2dp.pcm_bc);
@@ -825,12 +831,6 @@ void ba_transport_unref(struct ba_transport *t) {
 		storage_pcm_data_update(&t->sco.pcm_mic);
 	}
 
-	debug("Freeing transport: %s", ba_transport_debug_name(t));
-	g_assert_cmpint(ref_count, ==, 0);
-
-	if (t->bt_fd != -1)
-		close(t->bt_fd);
-
 	ba_device_unref(d);
 
 #if DEBUG