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);
43 pa_return_val_if_fail(pa_cvolume_valid(b
), 0);
45 if (a
->channels
!= b
->channels
)
48 for (i
= 0; i
< a
->channels
; i
++)
49 if (a
->values
[i
] != b
->values
[i
])
55 pa_cvolume
* pa_cvolume_init(pa_cvolume
*a
) {
62 for (c
= 0; c
< PA_CHANNELS_MAX
; c
++)
63 a
->values
[c
] = (pa_volume_t
) -1;
68 pa_cvolume
* pa_cvolume_set(pa_cvolume
*a
, unsigned channels
, pa_volume_t v
) {
72 pa_assert(channels
> 0);
73 pa_assert(channels
<= PA_CHANNELS_MAX
);
75 a
->channels
= (uint8_t) channels
;
77 for (i
= 0; i
< a
->channels
; i
++)
83 pa_volume_t
pa_cvolume_avg(const pa_cvolume
*a
) {
88 pa_return_val_if_fail(pa_cvolume_valid(a
), PA_VOLUME_MUTED
);
90 for (c
= 0; c
< a
->channels
; c
++)
95 return (pa_volume_t
) sum
;
98 pa_volume_t
pa_cvolume_avg_mask(const pa_cvolume
*a
, const pa_channel_map
*cm
, pa_channel_position_mask_t mask
) {
105 return pa_cvolume_avg(a
);
107 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(a
, cm
), PA_VOLUME_MUTED
);
109 for (c
= n
= 0; c
< a
->channels
; c
++) {
111 if (!(PA_CHANNEL_POSITION_MASK(cm
->map
[c
]) & mask
))
121 return (pa_volume_t
) sum
;
124 pa_volume_t
pa_cvolume_max(const pa_cvolume
*a
) {
129 pa_return_val_if_fail(pa_cvolume_valid(a
), PA_VOLUME_MUTED
);
131 for (c
= 0; c
< a
->channels
; c
++)
132 if (a
->values
[c
] > m
)
138 pa_volume_t
pa_cvolume_max_mask(const pa_cvolume
*a
, const pa_channel_map
*cm
, pa_channel_position_mask_t mask
) {
145 return pa_cvolume_max(a
);
147 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(a
, cm
), PA_VOLUME_MUTED
);
149 for (c
= n
= 0; c
< a
->channels
; c
++) {
151 if (!(PA_CHANNEL_POSITION_MASK(cm
->map
[c
]) & mask
))
154 if (a
->values
[c
] > m
)
161 pa_volume_t
pa_sw_volume_multiply(pa_volume_t a
, pa_volume_t b
) {
162 return pa_sw_volume_from_linear(pa_sw_volume_to_linear(a
) * pa_sw_volume_to_linear(b
));
165 pa_volume_t
pa_sw_volume_divide(pa_volume_t a
, pa_volume_t b
) {
166 double v
= pa_sw_volume_to_linear(b
);
171 return pa_sw_volume_from_linear(pa_sw_volume_to_linear(a
) / v
);
174 /* Amplitude, not power */
175 static double linear_to_dB(double v
) {
176 return 20.0 * log10(v
);
179 static double dB_to_linear(double v
) {
180 return pow(10.0, v
/ 20.0);
183 pa_volume_t
pa_sw_volume_from_dB(double dB
) {
184 if (isinf(dB
) < 0 || dB
<= PA_DECIBEL_MININFTY
)
185 return PA_VOLUME_MUTED
;
187 return pa_sw_volume_from_linear(dB_to_linear(dB
));
190 double pa_sw_volume_to_dB(pa_volume_t v
) {
192 if (v
<= PA_VOLUME_MUTED
)
193 return PA_DECIBEL_MININFTY
;
195 return linear_to_dB(pa_sw_volume_to_linear(v
));
198 pa_volume_t
pa_sw_volume_from_linear(double v
) {
201 return PA_VOLUME_MUTED
;
204 * We use a cubic mapping here, as suggested and discussed here:
206 * http://www.robotplanet.dk/audio/audio_gui_design/
207 * http://lists.linuxaudio.org/pipermail/linux-audio-dev/2009-May/thread.html#23151
209 * We make sure that the conversion to linear and back yields the
210 * same volume value! That's why we need the lround() below!
213 return (pa_volume_t
) lround(cbrt(v
) * PA_VOLUME_NORM
);
216 double pa_sw_volume_to_linear(pa_volume_t v
) {
219 if (v
<= PA_VOLUME_MUTED
)
222 if (v
== PA_VOLUME_NORM
)
225 f
= ((double) v
/ PA_VOLUME_NORM
);
230 char *pa_cvolume_snprint(char *s
, size_t l
, const pa_cvolume
*c
) {
232 pa_bool_t first
= TRUE
;
241 if (!pa_cvolume_valid(c
)) {
242 pa_snprintf(s
, l
, _("(invalid)"));
248 for (channel
= 0; channel
< c
->channels
&& l
> 1; channel
++) {
249 l
-= pa_snprintf(e
, l
, "%s%u: %3u%%",
252 (c
->values
[channel
]*100)/PA_VOLUME_NORM
);
261 char *pa_volume_snprint(char *s
, size_t l
, pa_volume_t v
) {
267 if (v
== (pa_volume_t
) -1) {
268 pa_snprintf(s
, l
, _("(invalid)"));
272 pa_snprintf(s
, l
, "%3u%%", (v
*100)/PA_VOLUME_NORM
);
276 char *pa_sw_cvolume_snprint_dB(char *s
, size_t l
, const pa_cvolume
*c
) {
278 pa_bool_t first
= TRUE
;
287 if (!pa_cvolume_valid(c
)) {
288 pa_snprintf(s
, l
, _("(invalid)"));
294 for (channel
= 0; channel
< c
->channels
&& l
> 1; channel
++) {
295 double f
= pa_sw_volume_to_dB(c
->values
[channel
]);
297 l
-= pa_snprintf(e
, l
, "%s%u: %0.2f dB",
300 isinf(f
) < 0 || f
<= PA_DECIBEL_MININFTY
? -INFINITY
: f
);
309 char *pa_sw_volume_snprint_dB(char *s
, size_t l
, pa_volume_t v
) {
317 if (v
== (pa_volume_t
) -1) {
318 pa_snprintf(s
, l
, _("(invalid)"));
322 f
= pa_sw_volume_to_dB(v
);
323 pa_snprintf(s
, l
, "%0.2f dB",
324 isinf(f
) < 0 || f
<= PA_DECIBEL_MININFTY
? -INFINITY
: f
);
329 int pa_cvolume_channels_equal_to(const pa_cvolume
*a
, pa_volume_t v
) {
333 pa_return_val_if_fail(pa_cvolume_valid(a
), 0);
335 for (c
= 0; c
< a
->channels
; c
++)
336 if (a
->values
[c
] != v
)
342 pa_cvolume
*pa_sw_cvolume_multiply(pa_cvolume
*dest
, const pa_cvolume
*a
, const pa_cvolume
*b
) {
349 pa_return_val_if_fail(pa_cvolume_valid(a
), NULL
);
350 pa_return_val_if_fail(pa_cvolume_valid(b
), NULL
);
352 for (i
= 0; i
< a
->channels
&& i
< b
->channels
; i
++)
353 dest
->values
[i
] = pa_sw_volume_multiply(a
->values
[i
], b
->values
[i
]);
355 dest
->channels
= (uint8_t) i
;
360 pa_cvolume
*pa_sw_cvolume_multiply_scalar(pa_cvolume
*dest
, const pa_cvolume
*a
, pa_volume_t b
) {
366 pa_return_val_if_fail(pa_cvolume_valid(a
), NULL
);
368 for (i
= 0; i
< a
->channels
; i
++)
369 dest
->values
[i
] = pa_sw_volume_multiply(a
->values
[i
], b
);
371 dest
->channels
= (uint8_t) i
;
376 pa_cvolume
*pa_sw_cvolume_divide(pa_cvolume
*dest
, const pa_cvolume
*a
, const pa_cvolume
*b
) {
383 pa_return_val_if_fail(pa_cvolume_valid(a
), NULL
);
384 pa_return_val_if_fail(pa_cvolume_valid(b
), NULL
);
386 for (i
= 0; i
< a
->channels
&& i
< b
->channels
; i
++)
387 dest
->values
[i
] = pa_sw_volume_divide(a
->values
[i
], b
->values
[i
]);
389 dest
->channels
= (uint8_t) i
;
394 pa_cvolume
*pa_sw_cvolume_divide_scalar(pa_cvolume
*dest
, const pa_cvolume
*a
, pa_volume_t b
) {
400 pa_return_val_if_fail(pa_cvolume_valid(a
), NULL
);
402 for (i
= 0; i
< a
->channels
; i
++)
403 dest
->values
[i
] = pa_sw_volume_divide(a
->values
[i
], b
);
405 dest
->channels
= (uint8_t) i
;
410 int pa_cvolume_valid(const pa_cvolume
*v
) {
415 if (v
->channels
<= 0 || v
->channels
> PA_CHANNELS_MAX
)
418 for (c
= 0; c
< v
->channels
; c
++)
419 if (v
->values
[c
] == (pa_volume_t
) -1)
425 static pa_bool_t
on_left(pa_channel_position_t p
) {
426 return !!(PA_CHANNEL_POSITION_MASK(p
) & PA_CHANNEL_POSITION_MASK_LEFT
);
429 static pa_bool_t
on_right(pa_channel_position_t p
) {
430 return !!(PA_CHANNEL_POSITION_MASK(p
) & PA_CHANNEL_POSITION_MASK_RIGHT
);
433 static pa_bool_t
on_center(pa_channel_position_t p
) {
434 return !!(PA_CHANNEL_POSITION_MASK(p
) & PA_CHANNEL_POSITION_MASK_CENTER
);
437 static pa_bool_t
on_lfe(pa_channel_position_t p
) {
438 return p
== PA_CHANNEL_POSITION_LFE
;
441 static pa_bool_t
on_front(pa_channel_position_t p
) {
442 return !!(PA_CHANNEL_POSITION_MASK(p
) & PA_CHANNEL_POSITION_MASK_FRONT
);
445 static pa_bool_t
on_rear(pa_channel_position_t p
) {
446 return !!(PA_CHANNEL_POSITION_MASK(p
) & PA_CHANNEL_POSITION_MASK_REAR
);
449 pa_cvolume
*pa_cvolume_remap(pa_cvolume
*v
, const pa_channel_map
*from
, const pa_channel_map
*to
) {
457 pa_return_val_if_fail(pa_cvolume_valid(v
), NULL
);
458 pa_return_val_if_fail(pa_channel_map_valid(from
), NULL
);
459 pa_return_val_if_fail(pa_channel_map_valid(to
), NULL
);
460 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v
, from
), NULL
);
462 if (pa_channel_map_equal(from
, to
))
465 result
.channels
= to
->channels
;
467 for (b
= 0; b
< to
->channels
; b
++) {
471 for (a
= 0; a
< from
->channels
; a
++)
472 if (from
->map
[a
] == to
->map
[b
]) {
478 for (a
= 0; a
< from
->channels
; a
++)
479 if ((on_left(from
->map
[a
]) && on_left(to
->map
[b
])) ||
480 (on_right(from
->map
[a
]) && on_right(to
->map
[b
])) ||
481 (on_center(from
->map
[a
]) && on_center(to
->map
[b
])) ||
482 (on_lfe(from
->map
[a
]) && on_lfe(to
->map
[b
]))) {
490 k
= pa_cvolume_avg(v
);
494 result
.values
[b
] = k
;
501 int pa_cvolume_compatible(const pa_cvolume
*v
, const pa_sample_spec
*ss
) {
506 pa_return_val_if_fail(pa_cvolume_valid(v
), 0);
507 pa_return_val_if_fail(pa_sample_spec_valid(ss
), 0);
509 return v
->channels
== ss
->channels
;
512 int pa_cvolume_compatible_with_channel_map(const pa_cvolume
*v
, const pa_channel_map
*cm
) {
516 pa_return_val_if_fail(pa_cvolume_valid(v
), 0);
517 pa_return_val_if_fail(pa_channel_map_valid(cm
), 0);
519 return v
->channels
== cm
->channels
;
522 static void get_avg_lr(const pa_channel_map
*map
, const pa_cvolume
*v
, pa_volume_t
*l
, pa_volume_t
*r
) {
524 pa_volume_t left
= 0, right
= 0;
525 unsigned n_left
= 0, n_right
= 0;
529 pa_assert(map
->channels
== v
->channels
);
533 for (c
= 0; c
< map
->channels
; c
++) {
534 if (on_left(map
->map
[c
])) {
535 left
+= v
->values
[c
];
537 } else if (on_right(map
->map
[c
])) {
538 right
+= v
->values
[c
];
551 *r
= right
/ n_right
;
554 float pa_cvolume_get_balance(const pa_cvolume
*v
, const pa_channel_map
*map
) {
555 pa_volume_t left
, right
;
560 pa_return_val_if_fail(pa_cvolume_valid(v
), 0.0f
);
561 pa_return_val_if_fail(pa_channel_map_valid(map
), 0.0f
);
562 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v
, map
), 0.0f
);
564 if (!pa_channel_map_can_balance(map
))
567 get_avg_lr(map
, v
, &left
, &right
);
582 return -1.0f
+ ((float) right
/ (float) left
);
584 return 1.0f
- ((float) left
/ (float) right
);
587 pa_cvolume
* pa_cvolume_set_balance(pa_cvolume
*v
, const pa_channel_map
*map
, float new_balance
) {
588 pa_volume_t left
, nleft
, right
, nright
, m
;
593 pa_assert(new_balance
>= -1.0f
);
594 pa_assert(new_balance
<= 1.0f
);
596 pa_return_val_if_fail(pa_cvolume_valid(v
), NULL
);
597 pa_return_val_if_fail(pa_channel_map_valid(map
), NULL
);
598 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v
, map
), NULL
);
600 if (!pa_channel_map_can_balance(map
))
603 get_avg_lr(map
, v
, &left
, &right
);
605 m
= PA_MAX(left
, right
);
607 if (new_balance
<= 0) {
608 nright
= (new_balance
+ 1.0f
) * m
;
611 nleft
= (1.0f
- new_balance
) * m
;
615 for (c
= 0; c
< map
->channels
; c
++) {
616 if (on_left(map
->map
[c
])) {
618 v
->values
[c
] = nleft
;
620 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) nleft
) / (uint64_t) left
);
621 } else if (on_right(map
->map
[c
])) {
623 v
->values
[c
] = nright
;
625 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) nright
) / (uint64_t) right
);
632 pa_cvolume
* pa_cvolume_scale(pa_cvolume
*v
, pa_volume_t max
) {
638 pa_return_val_if_fail(pa_cvolume_valid(v
), NULL
);
639 pa_return_val_if_fail(max
!= (pa_volume_t
) -1, NULL
);
641 t
= pa_cvolume_max(v
);
643 if (t
<= PA_VOLUME_MUTED
)
644 return pa_cvolume_set(v
, v
->channels
, max
);
646 for (c
= 0; c
< v
->channels
; c
++)
647 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) max
) / (uint64_t) t
);
652 pa_cvolume
* pa_cvolume_scale_mask(pa_cvolume
*v
, pa_volume_t max
, pa_channel_map
*cm
, pa_channel_position_mask_t mask
) {
658 pa_return_val_if_fail(pa_cvolume_valid(v
), NULL
);
659 pa_return_val_if_fail(max
!= (pa_volume_t
) -1, NULL
);
661 t
= pa_cvolume_max_mask(v
, cm
, mask
);
663 if (t
<= PA_VOLUME_MUTED
)
664 return pa_cvolume_set(v
, v
->channels
, max
);
666 for (c
= 0; c
< v
->channels
; c
++)
667 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) max
) / (uint64_t) t
);
672 static void get_avg_fr(const pa_channel_map
*map
, const pa_cvolume
*v
, pa_volume_t
*f
, pa_volume_t
*r
) {
674 pa_volume_t front
= 0, rear
= 0;
675 unsigned n_front
= 0, n_rear
= 0;
679 pa_assert(map
->channels
== v
->channels
);
683 for (c
= 0; c
< map
->channels
; c
++) {
684 if (on_front(map
->map
[c
])) {
685 front
+= v
->values
[c
];
687 } else if (on_rear(map
->map
[c
])) {
688 rear
+= v
->values
[c
];
696 *f
= front
/ n_front
;
704 float pa_cvolume_get_fade(const pa_cvolume
*v
, const pa_channel_map
*map
) {
705 pa_volume_t front
, rear
;
710 pa_return_val_if_fail(pa_cvolume_valid(v
), 0.0f
);
711 pa_return_val_if_fail(pa_channel_map_valid(map
), 0.0f
);
712 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v
, map
), 0.0f
);
714 if (!pa_channel_map_can_fade(map
))
717 get_avg_fr(map
, v
, &front
, &rear
);
723 return -1.0f
+ ((float) front
/ (float) rear
);
725 return 1.0f
- ((float) rear
/ (float) front
);
728 pa_cvolume
* pa_cvolume_set_fade(pa_cvolume
*v
, const pa_channel_map
*map
, float new_fade
) {
729 pa_volume_t front
, nfront
, rear
, nrear
, m
;
734 pa_assert(new_fade
>= -1.0f
);
735 pa_assert(new_fade
<= 1.0f
);
737 pa_return_val_if_fail(pa_cvolume_valid(v
), NULL
);
738 pa_return_val_if_fail(pa_channel_map_valid(map
), NULL
);
739 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v
, map
), NULL
);
741 if (!pa_channel_map_can_fade(map
))
744 get_avg_fr(map
, v
, &front
, &rear
);
746 m
= PA_MAX(front
, rear
);
749 nfront
= (new_fade
+ 1.0f
) * m
;
752 nrear
= (1.0f
- new_fade
) * m
;
756 for (c
= 0; c
< map
->channels
; c
++) {
757 if (on_front(map
->map
[c
])) {
759 v
->values
[c
] = nfront
;
761 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) nfront
) / (uint64_t) front
);
762 } else if (on_rear(map
->map
[c
])) {
764 v
->values
[c
] = nrear
;
766 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) nrear
) / (uint64_t) rear
);
773 pa_cvolume
* pa_cvolume_set_position(
775 const pa_channel_map
*map
,
776 pa_channel_position_t t
,
780 pa_bool_t good
= FALSE
;
785 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(cv
, map
), NULL
);
786 pa_return_val_if_fail(t
< PA_CHANNEL_POSITION_MAX
, NULL
);
788 for (c
= 0; c
< map
->channels
; c
++)
789 if (map
->map
[c
] == t
) {
794 return good
? cv
: NULL
;
797 pa_volume_t
pa_cvolume_get_position(
799 const pa_channel_map
*map
,
800 pa_channel_position_t t
) {
803 pa_volume_t v
= PA_VOLUME_MUTED
;
808 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(cv
, map
), PA_VOLUME_MUTED
);
809 pa_return_val_if_fail(t
< PA_CHANNEL_POSITION_MAX
, PA_VOLUME_MUTED
);
811 for (c
= 0; c
< map
->channels
; c
++)
812 if (map
->map
[c
] == t
)
813 if (cv
->values
[c
] > v
)