2 This file is part of PulseAudio.
4 Copyright 2004-2006 Lennart Poettering
6 PulseAudio is free software; you can redistribute it and/or modify
7 it under the terms of the GNU Lesser General Public License as published
8 by the Free Software Foundation; either version 2.1 of the License,
9 or (at your option) any later version.
11 PulseAudio is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License
17 along with PulseAudio; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
29 #include <pulse/i18n.h>
31 #include <pulsecore/core-util.h>
32 #include <pulsecore/macro.h>
33 #include <pulsecore/sample-util.h>
37 int pa_cvolume_equal(const pa_cvolume
*a
, const pa_cvolume
*b
) {
42 pa_return_val_if_fail(pa_cvolume_valid(a
), 0);
44 if (PA_UNLIKELY(a
== b
))
47 pa_return_val_if_fail(pa_cvolume_valid(b
), 0);
49 if (a
->channels
!= b
->channels
)
52 for (i
= 0; i
< a
->channels
; i
++)
53 if (a
->values
[i
] != b
->values
[i
])
59 pa_cvolume
* pa_cvolume_init(pa_cvolume
*a
) {
66 for (c
= 0; c
< PA_CHANNELS_MAX
; c
++)
67 a
->values
[c
] = (pa_volume_t
) -1;
72 pa_cvolume
* pa_cvolume_set(pa_cvolume
*a
, unsigned channels
, pa_volume_t v
) {
76 pa_assert(channels
> 0);
77 pa_assert(channels
<= PA_CHANNELS_MAX
);
79 a
->channels
= (uint8_t) channels
;
81 for (i
= 0; i
< a
->channels
; i
++)
87 pa_volume_t
pa_cvolume_avg(const pa_cvolume
*a
) {
92 pa_return_val_if_fail(pa_cvolume_valid(a
), PA_VOLUME_MUTED
);
94 for (c
= 0; c
< a
->channels
; c
++)
99 return (pa_volume_t
) sum
;
102 pa_volume_t
pa_cvolume_avg_mask(const pa_cvolume
*a
, const pa_channel_map
*cm
, pa_channel_position_mask_t mask
) {
109 return pa_cvolume_avg(a
);
111 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(a
, cm
), PA_VOLUME_MUTED
);
113 for (c
= n
= 0; c
< a
->channels
; c
++) {
115 if (!(PA_CHANNEL_POSITION_MASK(cm
->map
[c
]) & mask
))
125 return (pa_volume_t
) sum
;
128 pa_volume_t
pa_cvolume_max(const pa_cvolume
*a
) {
129 pa_volume_t m
= PA_VOLUME_MUTED
;
133 pa_return_val_if_fail(pa_cvolume_valid(a
), PA_VOLUME_MUTED
);
135 for (c
= 0; c
< a
->channels
; c
++)
136 if (a
->values
[c
] > m
)
142 pa_volume_t
pa_cvolume_min(const pa_cvolume
*a
) {
143 pa_volume_t m
= (pa_volume_t
) -1;
147 pa_return_val_if_fail(pa_cvolume_valid(a
), PA_VOLUME_MUTED
);
149 for (c
= 0; c
< a
->channels
; c
++)
150 if (m
== (pa_volume_t
) -1 || a
->values
[c
] < m
)
156 pa_volume_t
pa_cvolume_max_mask(const pa_cvolume
*a
, const pa_channel_map
*cm
, pa_channel_position_mask_t mask
) {
157 pa_volume_t m
= PA_VOLUME_MUTED
;
163 return pa_cvolume_max(a
);
165 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(a
, cm
), PA_VOLUME_MUTED
);
167 for (c
= n
= 0; c
< a
->channels
; c
++) {
169 if (!(PA_CHANNEL_POSITION_MASK(cm
->map
[c
]) & mask
))
172 if (a
->values
[c
] > m
)
179 pa_volume_t
pa_cvolume_min_mask(const pa_cvolume
*a
, const pa_channel_map
*cm
, pa_channel_position_mask_t mask
) {
180 pa_volume_t m
= (pa_volume_t
) -1;
186 return pa_cvolume_min(a
);
188 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(a
, cm
), PA_VOLUME_MUTED
);
190 for (c
= n
= 0; c
< a
->channels
; c
++) {
192 if (!(PA_CHANNEL_POSITION_MASK(cm
->map
[c
]) & mask
))
195 if (m
== (pa_volume_t
) -1 || a
->values
[c
] < m
)
202 pa_volume_t
pa_sw_volume_multiply(pa_volume_t a
, pa_volume_t b
) {
203 return pa_sw_volume_from_linear(pa_sw_volume_to_linear(a
) * pa_sw_volume_to_linear(b
));
206 pa_volume_t
pa_sw_volume_divide(pa_volume_t a
, pa_volume_t b
) {
207 double v
= pa_sw_volume_to_linear(b
);
212 return pa_sw_volume_from_linear(pa_sw_volume_to_linear(a
) / v
);
215 /* Amplitude, not power */
216 static double linear_to_dB(double v
) {
217 return 20.0 * log10(v
);
220 static double dB_to_linear(double v
) {
221 return pow(10.0, v
/ 20.0);
224 pa_volume_t
pa_sw_volume_from_dB(double dB
) {
225 if (isinf(dB
) < 0 || dB
<= PA_DECIBEL_MININFTY
)
226 return PA_VOLUME_MUTED
;
228 return pa_sw_volume_from_linear(dB_to_linear(dB
));
231 double pa_sw_volume_to_dB(pa_volume_t v
) {
233 if (v
<= PA_VOLUME_MUTED
)
234 return PA_DECIBEL_MININFTY
;
236 return linear_to_dB(pa_sw_volume_to_linear(v
));
239 pa_volume_t
pa_sw_volume_from_linear(double v
) {
242 return PA_VOLUME_MUTED
;
245 * We use a cubic mapping here, as suggested and discussed here:
247 * http://www.robotplanet.dk/audio/audio_gui_design/
248 * http://lists.linuxaudio.org/pipermail/linux-audio-dev/2009-May/thread.html#23151
250 * We make sure that the conversion to linear and back yields the
251 * same volume value! That's why we need the lround() below!
254 return (pa_volume_t
) lround(cbrt(v
) * PA_VOLUME_NORM
);
257 double pa_sw_volume_to_linear(pa_volume_t v
) {
260 if (v
<= PA_VOLUME_MUTED
)
263 if (v
== PA_VOLUME_NORM
)
266 f
= ((double) v
/ PA_VOLUME_NORM
);
271 char *pa_cvolume_snprint(char *s
, size_t l
, const pa_cvolume
*c
) {
273 pa_bool_t first
= TRUE
;
282 if (!pa_cvolume_valid(c
)) {
283 pa_snprintf(s
, l
, _("(invalid)"));
289 for (channel
= 0; channel
< c
->channels
&& l
> 1; channel
++) {
290 l
-= pa_snprintf(e
, l
, "%s%u: %3u%%",
293 (c
->values
[channel
]*100)/PA_VOLUME_NORM
);
302 char *pa_volume_snprint(char *s
, size_t l
, pa_volume_t v
) {
308 if (v
== (pa_volume_t
) -1) {
309 pa_snprintf(s
, l
, _("(invalid)"));
313 pa_snprintf(s
, l
, "%3u%%", (v
*100)/PA_VOLUME_NORM
);
317 char *pa_sw_cvolume_snprint_dB(char *s
, size_t l
, const pa_cvolume
*c
) {
319 pa_bool_t first
= TRUE
;
328 if (!pa_cvolume_valid(c
)) {
329 pa_snprintf(s
, l
, _("(invalid)"));
335 for (channel
= 0; channel
< c
->channels
&& l
> 1; channel
++) {
336 double f
= pa_sw_volume_to_dB(c
->values
[channel
]);
338 l
-= pa_snprintf(e
, l
, "%s%u: %0.2f dB",
341 isinf(f
) < 0 || f
<= PA_DECIBEL_MININFTY
? -INFINITY
: f
);
350 char *pa_sw_volume_snprint_dB(char *s
, size_t l
, pa_volume_t v
) {
358 if (v
== (pa_volume_t
) -1) {
359 pa_snprintf(s
, l
, _("(invalid)"));
363 f
= pa_sw_volume_to_dB(v
);
364 pa_snprintf(s
, l
, "%0.2f dB",
365 isinf(f
) < 0 || f
<= PA_DECIBEL_MININFTY
? -INFINITY
: f
);
370 int pa_cvolume_channels_equal_to(const pa_cvolume
*a
, pa_volume_t v
) {
374 pa_return_val_if_fail(pa_cvolume_valid(a
), 0);
376 for (c
= 0; c
< a
->channels
; c
++)
377 if (a
->values
[c
] != v
)
383 pa_cvolume
*pa_sw_cvolume_multiply(pa_cvolume
*dest
, const pa_cvolume
*a
, const pa_cvolume
*b
) {
390 pa_return_val_if_fail(pa_cvolume_valid(a
), NULL
);
391 pa_return_val_if_fail(pa_cvolume_valid(b
), NULL
);
393 for (i
= 0; i
< a
->channels
&& i
< b
->channels
; i
++)
394 dest
->values
[i
] = pa_sw_volume_multiply(a
->values
[i
], b
->values
[i
]);
396 dest
->channels
= (uint8_t) i
;
401 pa_cvolume
*pa_sw_cvolume_multiply_scalar(pa_cvolume
*dest
, const pa_cvolume
*a
, pa_volume_t b
) {
407 pa_return_val_if_fail(pa_cvolume_valid(a
), NULL
);
409 for (i
= 0; i
< a
->channels
; i
++)
410 dest
->values
[i
] = pa_sw_volume_multiply(a
->values
[i
], b
);
412 dest
->channels
= (uint8_t) i
;
417 pa_cvolume
*pa_sw_cvolume_divide(pa_cvolume
*dest
, const pa_cvolume
*a
, const pa_cvolume
*b
) {
424 pa_return_val_if_fail(pa_cvolume_valid(a
), NULL
);
425 pa_return_val_if_fail(pa_cvolume_valid(b
), NULL
);
427 for (i
= 0; i
< a
->channels
&& i
< b
->channels
; i
++)
428 dest
->values
[i
] = pa_sw_volume_divide(a
->values
[i
], b
->values
[i
]);
430 dest
->channels
= (uint8_t) i
;
435 pa_cvolume
*pa_sw_cvolume_divide_scalar(pa_cvolume
*dest
, const pa_cvolume
*a
, pa_volume_t b
) {
441 pa_return_val_if_fail(pa_cvolume_valid(a
), NULL
);
443 for (i
= 0; i
< a
->channels
; i
++)
444 dest
->values
[i
] = pa_sw_volume_divide(a
->values
[i
], b
);
446 dest
->channels
= (uint8_t) i
;
451 int pa_cvolume_valid(const pa_cvolume
*v
) {
456 if (v
->channels
<= 0 || v
->channels
> PA_CHANNELS_MAX
)
459 for (c
= 0; c
< v
->channels
; c
++)
460 if (v
->values
[c
] == (pa_volume_t
) -1)
466 static pa_bool_t
on_left(pa_channel_position_t p
) {
467 return !!(PA_CHANNEL_POSITION_MASK(p
) & PA_CHANNEL_POSITION_MASK_LEFT
);
470 static pa_bool_t
on_right(pa_channel_position_t p
) {
471 return !!(PA_CHANNEL_POSITION_MASK(p
) & PA_CHANNEL_POSITION_MASK_RIGHT
);
474 static pa_bool_t
on_center(pa_channel_position_t p
) {
475 return !!(PA_CHANNEL_POSITION_MASK(p
) & PA_CHANNEL_POSITION_MASK_CENTER
);
478 static pa_bool_t
on_lfe(pa_channel_position_t p
) {
479 return p
== PA_CHANNEL_POSITION_LFE
;
482 static pa_bool_t
on_front(pa_channel_position_t p
) {
483 return !!(PA_CHANNEL_POSITION_MASK(p
) & PA_CHANNEL_POSITION_MASK_FRONT
);
486 static pa_bool_t
on_rear(pa_channel_position_t p
) {
487 return !!(PA_CHANNEL_POSITION_MASK(p
) & PA_CHANNEL_POSITION_MASK_REAR
);
490 pa_cvolume
*pa_cvolume_remap(pa_cvolume
*v
, const pa_channel_map
*from
, const pa_channel_map
*to
) {
498 pa_return_val_if_fail(pa_cvolume_valid(v
), NULL
);
499 pa_return_val_if_fail(pa_channel_map_valid(from
), NULL
);
500 pa_return_val_if_fail(pa_channel_map_valid(to
), NULL
);
501 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v
, from
), NULL
);
503 if (pa_channel_map_equal(from
, to
))
506 result
.channels
= to
->channels
;
508 for (b
= 0; b
< to
->channels
; b
++) {
512 for (a
= 0; a
< from
->channels
; a
++)
513 if (from
->map
[a
] == to
->map
[b
]) {
519 for (a
= 0; a
< from
->channels
; a
++)
520 if ((on_left(from
->map
[a
]) && on_left(to
->map
[b
])) ||
521 (on_right(from
->map
[a
]) && on_right(to
->map
[b
])) ||
522 (on_center(from
->map
[a
]) && on_center(to
->map
[b
])) ||
523 (on_lfe(from
->map
[a
]) && on_lfe(to
->map
[b
]))) {
531 k
= pa_cvolume_avg(v
);
535 result
.values
[b
] = k
;
542 int pa_cvolume_compatible(const pa_cvolume
*v
, const pa_sample_spec
*ss
) {
547 pa_return_val_if_fail(pa_cvolume_valid(v
), 0);
548 pa_return_val_if_fail(pa_sample_spec_valid(ss
), 0);
550 return v
->channels
== ss
->channels
;
553 int pa_cvolume_compatible_with_channel_map(const pa_cvolume
*v
, const pa_channel_map
*cm
) {
557 pa_return_val_if_fail(pa_cvolume_valid(v
), 0);
558 pa_return_val_if_fail(pa_channel_map_valid(cm
), 0);
560 return v
->channels
== cm
->channels
;
563 static void get_avg_lr(const pa_channel_map
*map
, const pa_cvolume
*v
, pa_volume_t
*l
, pa_volume_t
*r
) {
565 pa_volume_t left
= 0, right
= 0;
566 unsigned n_left
= 0, n_right
= 0;
570 pa_assert(map
->channels
== v
->channels
);
574 for (c
= 0; c
< map
->channels
; c
++) {
575 if (on_left(map
->map
[c
])) {
576 left
+= v
->values
[c
];
578 } else if (on_right(map
->map
[c
])) {
579 right
+= v
->values
[c
];
592 *r
= right
/ n_right
;
595 float pa_cvolume_get_balance(const pa_cvolume
*v
, const pa_channel_map
*map
) {
596 pa_volume_t left
, right
;
601 pa_return_val_if_fail(pa_cvolume_valid(v
), 0.0f
);
602 pa_return_val_if_fail(pa_channel_map_valid(map
), 0.0f
);
603 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v
, map
), 0.0f
);
605 if (!pa_channel_map_can_balance(map
))
608 get_avg_lr(map
, v
, &left
, &right
);
623 return -1.0f
+ ((float) right
/ (float) left
);
625 return 1.0f
- ((float) left
/ (float) right
);
628 pa_cvolume
* pa_cvolume_set_balance(pa_cvolume
*v
, const pa_channel_map
*map
, float new_balance
) {
629 pa_volume_t left
, nleft
, right
, nright
, m
;
634 pa_assert(new_balance
>= -1.0f
);
635 pa_assert(new_balance
<= 1.0f
);
637 pa_return_val_if_fail(pa_cvolume_valid(v
), NULL
);
638 pa_return_val_if_fail(pa_channel_map_valid(map
), NULL
);
639 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v
, map
), NULL
);
641 if (!pa_channel_map_can_balance(map
))
644 get_avg_lr(map
, v
, &left
, &right
);
646 m
= PA_MAX(left
, right
);
648 if (new_balance
<= 0) {
649 nright
= (new_balance
+ 1.0f
) * m
;
652 nleft
= (1.0f
- new_balance
) * m
;
656 for (c
= 0; c
< map
->channels
; c
++) {
657 if (on_left(map
->map
[c
])) {
659 v
->values
[c
] = nleft
;
661 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) nleft
) / (uint64_t) left
);
662 } else if (on_right(map
->map
[c
])) {
664 v
->values
[c
] = nright
;
666 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) nright
) / (uint64_t) right
);
673 pa_cvolume
* pa_cvolume_scale(pa_cvolume
*v
, pa_volume_t max
) {
679 pa_return_val_if_fail(pa_cvolume_valid(v
), NULL
);
680 pa_return_val_if_fail(max
!= (pa_volume_t
) -1, NULL
);
682 t
= pa_cvolume_max(v
);
684 if (t
<= PA_VOLUME_MUTED
)
685 return pa_cvolume_set(v
, v
->channels
, max
);
687 for (c
= 0; c
< v
->channels
; c
++)
688 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) max
) / (uint64_t) t
);
693 pa_cvolume
* pa_cvolume_scale_mask(pa_cvolume
*v
, pa_volume_t max
, pa_channel_map
*cm
, pa_channel_position_mask_t mask
) {
699 pa_return_val_if_fail(pa_cvolume_valid(v
), NULL
);
700 pa_return_val_if_fail(max
!= (pa_volume_t
) -1, NULL
);
702 t
= pa_cvolume_max_mask(v
, cm
, mask
);
704 if (t
<= PA_VOLUME_MUTED
)
705 return pa_cvolume_set(v
, v
->channels
, max
);
707 for (c
= 0; c
< v
->channels
; c
++)
708 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) max
) / (uint64_t) t
);
713 static void get_avg_fr(const pa_channel_map
*map
, const pa_cvolume
*v
, pa_volume_t
*f
, pa_volume_t
*r
) {
715 pa_volume_t front
= 0, rear
= 0;
716 unsigned n_front
= 0, n_rear
= 0;
720 pa_assert(map
->channels
== v
->channels
);
724 for (c
= 0; c
< map
->channels
; c
++) {
725 if (on_front(map
->map
[c
])) {
726 front
+= v
->values
[c
];
728 } else if (on_rear(map
->map
[c
])) {
729 rear
+= v
->values
[c
];
737 *f
= front
/ n_front
;
745 float pa_cvolume_get_fade(const pa_cvolume
*v
, const pa_channel_map
*map
) {
746 pa_volume_t front
, rear
;
751 pa_return_val_if_fail(pa_cvolume_valid(v
), 0.0f
);
752 pa_return_val_if_fail(pa_channel_map_valid(map
), 0.0f
);
753 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v
, map
), 0.0f
);
755 if (!pa_channel_map_can_fade(map
))
758 get_avg_fr(map
, v
, &front
, &rear
);
764 return -1.0f
+ ((float) front
/ (float) rear
);
766 return 1.0f
- ((float) rear
/ (float) front
);
769 pa_cvolume
* pa_cvolume_set_fade(pa_cvolume
*v
, const pa_channel_map
*map
, float new_fade
) {
770 pa_volume_t front
, nfront
, rear
, nrear
, m
;
775 pa_assert(new_fade
>= -1.0f
);
776 pa_assert(new_fade
<= 1.0f
);
778 pa_return_val_if_fail(pa_cvolume_valid(v
), NULL
);
779 pa_return_val_if_fail(pa_channel_map_valid(map
), NULL
);
780 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v
, map
), NULL
);
782 if (!pa_channel_map_can_fade(map
))
785 get_avg_fr(map
, v
, &front
, &rear
);
787 m
= PA_MAX(front
, rear
);
790 nfront
= (new_fade
+ 1.0f
) * m
;
793 nrear
= (1.0f
- new_fade
) * m
;
797 for (c
= 0; c
< map
->channels
; c
++) {
798 if (on_front(map
->map
[c
])) {
800 v
->values
[c
] = nfront
;
802 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) nfront
) / (uint64_t) front
);
803 } else if (on_rear(map
->map
[c
])) {
805 v
->values
[c
] = nrear
;
807 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) nrear
) / (uint64_t) rear
);
814 pa_cvolume
* pa_cvolume_set_position(
816 const pa_channel_map
*map
,
817 pa_channel_position_t t
,
821 pa_bool_t good
= FALSE
;
826 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(cv
, map
), NULL
);
827 pa_return_val_if_fail(t
< PA_CHANNEL_POSITION_MAX
, NULL
);
829 for (c
= 0; c
< map
->channels
; c
++)
830 if (map
->map
[c
] == t
) {
835 return good
? cv
: NULL
;
838 pa_volume_t
pa_cvolume_get_position(
840 const pa_channel_map
*map
,
841 pa_channel_position_t t
) {
844 pa_volume_t v
= PA_VOLUME_MUTED
;
849 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(cv
, map
), PA_VOLUME_MUTED
);
850 pa_return_val_if_fail(t
< PA_CHANNEL_POSITION_MAX
, PA_VOLUME_MUTED
);
852 for (c
= 0; c
< map
->channels
; c
++)
853 if (map
->map
[c
] == t
)
854 if (cv
->values
[c
] > v
)
860 pa_cvolume
* pa_cvolume_merge(pa_cvolume
*dest
, const pa_cvolume
*a
, const pa_cvolume
*b
) {
867 pa_return_val_if_fail(pa_cvolume_valid(a
), NULL
);
868 pa_return_val_if_fail(pa_cvolume_valid(b
), NULL
);
870 for (i
= 0; i
< a
->channels
&& i
< b
->channels
; i
++)
871 dest
->values
[i
] = PA_MAX(a
->values
[i
], b
->values
[i
]);
873 dest
->channels
= (uint8_t) i
;