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>
30 #include <pulsecore/core-util.h>
31 #include <pulsecore/macro.h>
35 int pa_cvolume_equal(const pa_cvolume
*a
, const pa_cvolume
*b
) {
40 pa_return_val_if_fail(pa_cvolume_valid(a
), 0);
41 pa_return_val_if_fail(pa_cvolume_valid(b
), 0);
43 if (a
->channels
!= b
->channels
)
46 for (i
= 0; i
< a
->channels
; i
++)
47 if (a
->values
[i
] != b
->values
[i
])
53 pa_cvolume
* pa_cvolume_init(pa_cvolume
*a
) {
60 for (c
= 0; c
< PA_CHANNELS_MAX
; c
++)
61 a
->values
[c
] = (pa_volume_t
) -1;
66 pa_cvolume
* pa_cvolume_set(pa_cvolume
*a
, unsigned channels
, pa_volume_t v
) {
70 pa_assert(channels
> 0);
71 pa_assert(channels
<= PA_CHANNELS_MAX
);
73 a
->channels
= (uint8_t) channels
;
75 for (i
= 0; i
< a
->channels
; i
++)
81 pa_volume_t
pa_cvolume_avg(const pa_cvolume
*a
) {
86 pa_return_val_if_fail(pa_cvolume_valid(a
), PA_VOLUME_MUTED
);
88 for (c
= 0; c
< a
->channels
; c
++)
93 return (pa_volume_t
) sum
;
96 pa_volume_t
pa_cvolume_avg_mask(const pa_cvolume
*a
, const pa_channel_map
*cm
, pa_channel_position_mask_t mask
) {
103 return pa_cvolume_avg(a
);
105 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(a
, cm
), PA_VOLUME_MUTED
);
107 for (c
= n
= 0; c
< a
->channels
; c
++) {
109 if (!(PA_CHANNEL_POSITION_MASK(cm
->map
[c
]) & mask
))
119 return (pa_volume_t
) sum
;
122 pa_volume_t
pa_cvolume_max(const pa_cvolume
*a
) {
127 pa_return_val_if_fail(pa_cvolume_valid(a
), PA_VOLUME_MUTED
);
129 for (c
= 0; c
< a
->channels
; c
++)
130 if (a
->values
[c
] > m
)
136 pa_volume_t
pa_cvolume_max_mask(const pa_cvolume
*a
, const pa_channel_map
*cm
, pa_channel_position_mask_t mask
) {
143 return pa_cvolume_max(a
);
145 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(a
, cm
), PA_VOLUME_MUTED
);
147 for (c
= n
= 0; c
< a
->channels
; c
++) {
149 if (!(PA_CHANNEL_POSITION_MASK(cm
->map
[c
]) & mask
))
152 if (a
->values
[c
] > m
)
159 pa_volume_t
pa_sw_volume_multiply(pa_volume_t a
, pa_volume_t b
) {
160 return pa_sw_volume_from_linear(pa_sw_volume_to_linear(a
) * pa_sw_volume_to_linear(b
));
163 pa_volume_t
pa_sw_volume_divide(pa_volume_t a
, pa_volume_t b
) {
164 double v
= pa_sw_volume_to_linear(b
);
169 return pa_sw_volume_from_linear(pa_sw_volume_to_linear(a
) / v
);
172 /* Amplitude, not power */
173 static double linear_to_dB(double v
) {
174 return 20.0 * log10(v
);
177 static double dB_to_linear(double v
) {
178 return pow(10.0, v
/ 20.0);
181 pa_volume_t
pa_sw_volume_from_dB(double dB
) {
182 if (isinf(dB
) < 0 || dB
<= PA_DECIBEL_MININFTY
)
183 return PA_VOLUME_MUTED
;
185 return pa_sw_volume_from_linear(dB_to_linear(dB
));
188 double pa_sw_volume_to_dB(pa_volume_t v
) {
190 if (v
<= PA_VOLUME_MUTED
)
191 return PA_DECIBEL_MININFTY
;
193 return linear_to_dB(pa_sw_volume_to_linear(v
));
196 pa_volume_t
pa_sw_volume_from_linear(double v
) {
199 return PA_VOLUME_MUTED
;
202 * We use a cubic mapping here, as suggested and discussed here:
204 * http://www.robotplanet.dk/audio/audio_gui_design/
205 * http://lists.linuxaudio.org/pipermail/linux-audio-dev/2009-May/thread.html#23151
208 return (pa_volume_t
) (cbrt(v
) * PA_VOLUME_NORM
);
211 double pa_sw_volume_to_linear(pa_volume_t v
) {
214 if (v
<= PA_VOLUME_MUTED
)
217 if (v
== PA_VOLUME_NORM
)
220 f
= ((double) v
/ PA_VOLUME_NORM
);
225 char *pa_cvolume_snprint(char *s
, size_t l
, const pa_cvolume
*c
) {
227 pa_bool_t first
= TRUE
;
236 if (!pa_cvolume_valid(c
)) {
237 pa_snprintf(s
, l
, _("(invalid)"));
243 for (channel
= 0; channel
< c
->channels
&& l
> 1; channel
++) {
244 l
-= pa_snprintf(e
, l
, "%s%u: %3u%%",
247 (c
->values
[channel
]*100)/PA_VOLUME_NORM
);
256 char *pa_volume_snprint(char *s
, size_t l
, pa_volume_t v
) {
262 if (v
== (pa_volume_t
) -1) {
263 pa_snprintf(s
, l
, _("(invalid)"));
267 pa_snprintf(s
, l
, "%3u%%", (v
*100)/PA_VOLUME_NORM
);
271 char *pa_sw_cvolume_snprint_dB(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 double f
= pa_sw_volume_to_dB(c
->values
[channel
]);
292 l
-= pa_snprintf(e
, l
, "%s%u: %0.2f dB",
295 isinf(f
) < 0 || f
<= PA_DECIBEL_MININFTY
? -INFINITY
: f
);
304 char *pa_sw_volume_snprint_dB(char *s
, size_t l
, pa_volume_t v
) {
312 if (v
== (pa_volume_t
) -1) {
313 pa_snprintf(s
, l
, _("(invalid)"));
317 f
= pa_sw_volume_to_dB(v
);
318 pa_snprintf(s
, l
, "%0.2f dB",
319 isinf(f
) < 0 || f
<= PA_DECIBEL_MININFTY
? -INFINITY
: f
);
324 int pa_cvolume_channels_equal_to(const pa_cvolume
*a
, pa_volume_t v
) {
328 pa_return_val_if_fail(pa_cvolume_valid(a
), 0);
330 for (c
= 0; c
< a
->channels
; c
++)
331 if (a
->values
[c
] != v
)
337 pa_cvolume
*pa_sw_cvolume_multiply(pa_cvolume
*dest
, const pa_cvolume
*a
, const pa_cvolume
*b
) {
344 pa_return_val_if_fail(pa_cvolume_valid(a
), NULL
);
345 pa_return_val_if_fail(pa_cvolume_valid(b
), NULL
);
347 for (i
= 0; i
< a
->channels
&& i
< b
->channels
&& i
< PA_CHANNELS_MAX
; i
++)
348 dest
->values
[i
] = pa_sw_volume_multiply(a
->values
[i
], b
->values
[i
]);
350 dest
->channels
= (uint8_t) i
;
355 pa_cvolume
*pa_sw_cvolume_divide(pa_cvolume
*dest
, const pa_cvolume
*a
, const pa_cvolume
*b
) {
362 pa_return_val_if_fail(pa_cvolume_valid(a
), NULL
);
363 pa_return_val_if_fail(pa_cvolume_valid(b
), NULL
);
365 for (i
= 0; i
< a
->channels
&& i
< b
->channels
&& i
< PA_CHANNELS_MAX
; i
++)
366 dest
->values
[i
] = pa_sw_volume_divide(a
->values
[i
], b
->values
[i
]);
368 dest
->channels
= (uint8_t) i
;
373 int pa_cvolume_valid(const pa_cvolume
*v
) {
378 if (v
->channels
<= 0 || v
->channels
> PA_CHANNELS_MAX
)
381 for (c
= 0; c
< v
->channels
; c
++)
382 if (v
->values
[c
] == (pa_volume_t
) -1)
388 static pa_bool_t
on_left(pa_channel_position_t p
) {
391 p
== PA_CHANNEL_POSITION_FRONT_LEFT
||
392 p
== PA_CHANNEL_POSITION_REAR_LEFT
||
393 p
== PA_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER
||
394 p
== PA_CHANNEL_POSITION_SIDE_LEFT
||
395 p
== PA_CHANNEL_POSITION_TOP_FRONT_LEFT
||
396 p
== PA_CHANNEL_POSITION_TOP_REAR_LEFT
;
399 static pa_bool_t
on_right(pa_channel_position_t p
) {
402 p
== PA_CHANNEL_POSITION_FRONT_RIGHT
||
403 p
== PA_CHANNEL_POSITION_REAR_RIGHT
||
404 p
== PA_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER
||
405 p
== PA_CHANNEL_POSITION_SIDE_RIGHT
||
406 p
== PA_CHANNEL_POSITION_TOP_FRONT_RIGHT
||
407 p
== PA_CHANNEL_POSITION_TOP_REAR_RIGHT
;
410 static pa_bool_t
on_center(pa_channel_position_t p
) {
413 p
== PA_CHANNEL_POSITION_FRONT_CENTER
||
414 p
== PA_CHANNEL_POSITION_REAR_CENTER
||
415 p
== PA_CHANNEL_POSITION_TOP_CENTER
||
416 p
== PA_CHANNEL_POSITION_TOP_FRONT_CENTER
||
417 p
== PA_CHANNEL_POSITION_TOP_REAR_CENTER
;
420 static pa_bool_t
on_lfe(pa_channel_position_t p
) {
423 p
== PA_CHANNEL_POSITION_LFE
;
426 static pa_bool_t
on_front(pa_channel_position_t p
) {
429 p
== PA_CHANNEL_POSITION_FRONT_LEFT
||
430 p
== PA_CHANNEL_POSITION_FRONT_RIGHT
||
431 p
== PA_CHANNEL_POSITION_FRONT_CENTER
||
432 p
== PA_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER
||
433 p
== PA_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER
||
434 p
== PA_CHANNEL_POSITION_TOP_FRONT_LEFT
||
435 p
== PA_CHANNEL_POSITION_TOP_FRONT_RIGHT
||
436 p
== PA_CHANNEL_POSITION_TOP_FRONT_CENTER
;
439 static pa_bool_t
on_rear(pa_channel_position_t p
) {
442 p
== PA_CHANNEL_POSITION_REAR_LEFT
||
443 p
== PA_CHANNEL_POSITION_REAR_RIGHT
||
444 p
== PA_CHANNEL_POSITION_REAR_CENTER
||
445 p
== PA_CHANNEL_POSITION_TOP_REAR_LEFT
||
446 p
== PA_CHANNEL_POSITION_TOP_REAR_RIGHT
||
447 p
== PA_CHANNEL_POSITION_TOP_REAR_CENTER
;
450 pa_cvolume
*pa_cvolume_remap(pa_cvolume
*v
, const pa_channel_map
*from
, const pa_channel_map
*to
) {
458 pa_return_val_if_fail(pa_cvolume_valid(v
), NULL
);
459 pa_return_val_if_fail(pa_channel_map_valid(from
), NULL
);
460 pa_return_val_if_fail(pa_channel_map_valid(to
), NULL
);
461 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v
, from
), NULL
);
463 if (pa_channel_map_equal(from
, to
))
466 result
.channels
= to
->channels
;
468 for (b
= 0; b
< to
->channels
; b
++) {
472 for (a
= 0; a
< from
->channels
; a
++)
473 if (from
->map
[a
] == to
->map
[b
]) {
479 for (a
= 0; a
< from
->channels
; a
++)
480 if ((on_left(from
->map
[a
]) && on_left(to
->map
[b
])) ||
481 (on_right(from
->map
[a
]) && on_right(to
->map
[b
])) ||
482 (on_center(from
->map
[a
]) && on_center(to
->map
[b
])) ||
483 (on_lfe(from
->map
[a
]) && on_lfe(to
->map
[b
]))) {
491 k
= pa_cvolume_avg(v
);
495 result
.values
[b
] = k
;
502 int pa_cvolume_compatible(const pa_cvolume
*v
, const pa_sample_spec
*ss
) {
507 pa_return_val_if_fail(pa_cvolume_valid(v
), 0);
508 pa_return_val_if_fail(pa_sample_spec_valid(ss
), 0);
510 return v
->channels
== ss
->channels
;
513 int pa_cvolume_compatible_with_channel_map(const pa_cvolume
*v
, const pa_channel_map
*cm
) {
517 pa_return_val_if_fail(pa_cvolume_valid(v
), 0);
518 pa_return_val_if_fail(pa_channel_map_valid(cm
), 0);
520 return v
->channels
== cm
->channels
;
523 static void get_avg_lr(const pa_channel_map
*map
, const pa_cvolume
*v
, pa_volume_t
*l
, pa_volume_t
*r
) {
525 pa_volume_t left
= 0, right
= 0;
526 unsigned n_left
= 0, n_right
= 0;
530 pa_assert(map
->channels
== v
->channels
);
534 for (c
= 0; c
< map
->channels
; c
++) {
535 if (on_left(map
->map
[c
])) {
536 left
+= v
->values
[c
];
538 } else if (on_right(map
->map
[c
])) {
539 right
+= v
->values
[c
];
552 *r
= right
/ n_right
;
555 float pa_cvolume_get_balance(const pa_cvolume
*v
, const pa_channel_map
*map
) {
556 pa_volume_t left
, right
;
561 pa_return_val_if_fail(pa_cvolume_valid(v
), 0.0f
);
562 pa_return_val_if_fail(pa_channel_map_valid(map
), 0.0f
);
563 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v
, map
), 0.0f
);
565 if (!pa_channel_map_can_balance(map
))
568 get_avg_lr(map
, v
, &left
, &right
);
583 return -1.0f
+ ((float) right
/ (float) left
);
585 return 1.0f
- ((float) left
/ (float) right
);
588 pa_cvolume
* pa_cvolume_set_balance(pa_cvolume
*v
, const pa_channel_map
*map
, float new_balance
) {
589 pa_volume_t left
, nleft
, right
, nright
, m
;
594 pa_assert(new_balance
>= -1.0f
);
595 pa_assert(new_balance
<= 1.0f
);
597 pa_return_val_if_fail(pa_cvolume_valid(v
), NULL
);
598 pa_return_val_if_fail(pa_channel_map_valid(map
), NULL
);
599 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v
, map
), NULL
);
601 if (!pa_channel_map_can_balance(map
))
604 get_avg_lr(map
, v
, &left
, &right
);
606 m
= PA_MAX(left
, right
);
608 if (new_balance
<= 0) {
609 nright
= (new_balance
+ 1.0f
) * m
;
612 nleft
= (1.0f
- new_balance
) * m
;
616 for (c
= 0; c
< map
->channels
; c
++) {
617 if (on_left(map
->map
[c
])) {
619 v
->values
[c
] = nleft
;
621 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) nleft
) / (uint64_t) left
);
622 } else if (on_right(map
->map
[c
])) {
624 v
->values
[c
] = nright
;
626 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) nright
) / (uint64_t) right
);
633 pa_cvolume
* pa_cvolume_scale(pa_cvolume
*v
, pa_volume_t max
) {
639 pa_return_val_if_fail(pa_cvolume_valid(v
), NULL
);
640 pa_return_val_if_fail(max
!= (pa_volume_t
) -1, NULL
);
642 t
= pa_cvolume_max(v
);
644 if (t
<= PA_VOLUME_MUTED
)
645 return pa_cvolume_set(v
, v
->channels
, max
);
647 for (c
= 0; c
< v
->channels
; c
++)
648 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) max
) / (uint64_t) t
);
653 pa_cvolume
* pa_cvolume_scale_mask(pa_cvolume
*v
, pa_volume_t max
, pa_channel_map
*cm
, pa_channel_position_mask_t mask
) {
659 pa_return_val_if_fail(pa_cvolume_valid(v
), NULL
);
660 pa_return_val_if_fail(max
!= (pa_volume_t
) -1, NULL
);
662 t
= pa_cvolume_max_mask(v
, cm
, mask
);
664 if (t
<= PA_VOLUME_MUTED
)
665 return pa_cvolume_set(v
, v
->channels
, max
);
667 for (c
= 0; c
< v
->channels
; c
++)
668 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) max
) / (uint64_t) t
);
673 static void get_avg_fr(const pa_channel_map
*map
, const pa_cvolume
*v
, pa_volume_t
*f
, pa_volume_t
*r
) {
675 pa_volume_t front
= 0, rear
= 0;
676 unsigned n_front
= 0, n_rear
= 0;
680 pa_assert(map
->channels
== v
->channels
);
684 for (c
= 0; c
< map
->channels
; c
++) {
685 if (on_front(map
->map
[c
])) {
686 front
+= v
->values
[c
];
688 } else if (on_rear(map
->map
[c
])) {
689 rear
+= v
->values
[c
];
697 *f
= front
/ n_front
;
705 float pa_cvolume_get_fade(const pa_cvolume
*v
, const pa_channel_map
*map
) {
706 pa_volume_t front
, rear
;
711 pa_return_val_if_fail(pa_cvolume_valid(v
), 0.0f
);
712 pa_return_val_if_fail(pa_channel_map_valid(map
), 0.0f
);
713 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v
, map
), 0.0f
);
715 if (!pa_channel_map_can_fade(map
))
718 get_avg_fr(map
, v
, &front
, &rear
);
724 return -1.0f
+ ((float) front
/ (float) rear
);
726 return 1.0f
- ((float) rear
/ (float) front
);
729 pa_cvolume
* pa_cvolume_set_fade(pa_cvolume
*v
, const pa_channel_map
*map
, float new_fade
) {
730 pa_volume_t front
, nfront
, rear
, nrear
, m
;
735 pa_assert(new_fade
>= -1.0f
);
736 pa_assert(new_fade
<= 1.0f
);
738 pa_return_val_if_fail(pa_cvolume_valid(v
), NULL
);
739 pa_return_val_if_fail(pa_channel_map_valid(map
), NULL
);
740 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v
, map
), NULL
);
742 if (!pa_channel_map_can_fade(map
))
745 get_avg_fr(map
, v
, &front
, &rear
);
747 m
= PA_MAX(front
, rear
);
750 nfront
= (new_fade
+ 1.0f
) * m
;
753 nrear
= (1.0f
- new_fade
) * m
;
757 for (c
= 0; c
< map
->channels
; c
++) {
758 if (on_front(map
->map
[c
])) {
760 v
->values
[c
] = nfront
;
762 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) nfront
) / (uint64_t) front
);
763 } else if (on_rear(map
->map
[c
])) {
765 v
->values
[c
] = nrear
;
767 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) nrear
) / (uint64_t) rear
);
774 pa_cvolume
* pa_cvolume_set_position(
776 const pa_channel_map
*map
,
777 pa_channel_position_t t
,
781 pa_bool_t good
= FALSE
;
786 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(cv
, map
), NULL
);
787 pa_return_val_if_fail(t
< PA_CHANNEL_POSITION_MAX
, NULL
);
789 for (c
= 0; c
< map
->channels
; c
++)
790 if (map
->map
[c
] == t
) {
795 return good
? cv
: NULL
;
798 pa_volume_t
pa_cvolume_get_position(
800 const pa_channel_map
*map
,
801 pa_channel_position_t t
) {
804 pa_volume_t v
= PA_VOLUME_MUTED
;
809 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(cv
, map
), PA_VOLUME_MUTED
);
810 pa_return_val_if_fail(t
< PA_CHANNEL_POSITION_MAX
, PA_VOLUME_MUTED
);
812 for (c
= 0; c
< map
->channels
; c
++)
813 if (map
->map
[c
] == t
)
814 if (cv
->values
[c
] > v
)