From dae0ccacfc70514e11b5394e3abb914c648e244b Mon Sep 17 00:00:00 2001 From: Wim Taymans Date: Sat, 4 Nov 2023 09:51:14 +0100 Subject: [PATCH] spa: explicitly mention that volumes are linear See #3623 --- spa/include/spa/param/props.h | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/spa/include/spa/param/props.h b/spa/include/spa/param/props.h index 8665013fe..a7a2e4c25 100644 --- a/spa/include/spa/param/props.h +++ b/spa/include/spa/param/props.h @@ -64,24 +64,26 @@ enum spa_prop { SPA_PROP_patternType, SPA_PROP_ditherType, SPA_PROP_truncate, - SPA_PROP_channelVolumes, /**< a volume array, one volume per channel + SPA_PROP_channelVolumes, /**< a volume array, one (linear) volume per channel * (Array of Float). 0.0 is silence, 1.0 is - * without attenuation. This is the effective volume - * that is applied. It can result in a hardware volume - * and software volume (see softVolumes) */ + * without attenuation. This is the effective + * volume that is applied. It can result + * in a hardware volume and software volume + * (see softVolumes) */ SPA_PROP_volumeBase, /**< a volume base (Float) */ SPA_PROP_volumeStep, /**< a volume step (Float) */ SPA_PROP_channelMap, /**< a channelmap array * (Array (Id enum spa_audio_channel)) */ SPA_PROP_monitorMute, /**< mute (Bool) */ - SPA_PROP_monitorVolumes, /**< a volume array, one volume per + SPA_PROP_monitorVolumes, /**< a volume array, one (linear) volume per * channel (Array of Float) */ SPA_PROP_latencyOffsetNsec, /**< delay adjustment */ SPA_PROP_softMute, /**< mute (Bool) applied in software */ - SPA_PROP_softVolumes, /**< a volume array, one volume per channel + SPA_PROP_softVolumes, /**< a volume array, one (linear) volume per channel * (Array of Float). 0.0 is silence, 1.0 is without - * attenuation. This is the volume applied in software, - * there might be a part applied in hardware. */ + * attenuation. This is the volume applied in + * software, there might be a part applied in + * hardware. */ SPA_PROP_iec958Codecs, /**< enabled IEC958 (S/PDIF) codecs, * (Array (Id enum spa_audio_iec958_codec) */