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
210 return (pa_volume_t
) (cbrt(v
) * PA_VOLUME_NORM
);
213 double pa_sw_volume_to_linear(pa_volume_t v
) {
216 if (v
<= PA_VOLUME_MUTED
)
219 if (v
== PA_VOLUME_NORM
)
222 f
= ((double) v
/ PA_VOLUME_NORM
);
227 char *pa_cvolume_snprint(char *s
, size_t l
, const pa_cvolume
*c
) {
229 pa_bool_t first
= TRUE
;
238 if (!pa_cvolume_valid(c
)) {
239 pa_snprintf(s
, l
, _("(invalid)"));
245 for (channel
= 0; channel
< c
->channels
&& l
> 1; channel
++) {
246 l
-= pa_snprintf(e
, l
, "%s%u: %3u%%",
249 (c
->values
[channel
]*100)/PA_VOLUME_NORM
);
258 char *pa_volume_snprint(char *s
, size_t l
, pa_volume_t v
) {
264 if (v
== (pa_volume_t
) -1) {
265 pa_snprintf(s
, l
, _("(invalid)"));
269 pa_snprintf(s
, l
, "%3u%%", (v
*100)/PA_VOLUME_NORM
);
273 char *pa_sw_cvolume_snprint_dB(char *s
, size_t l
, const pa_cvolume
*c
) {
275 pa_bool_t first
= TRUE
;
284 if (!pa_cvolume_valid(c
)) {
285 pa_snprintf(s
, l
, _("(invalid)"));
291 for (channel
= 0; channel
< c
->channels
&& l
> 1; channel
++) {
292 double f
= pa_sw_volume_to_dB(c
->values
[channel
]);
294 l
-= pa_snprintf(e
, l
, "%s%u: %0.2f dB",
297 isinf(f
) < 0 || f
<= PA_DECIBEL_MININFTY
? -INFINITY
: f
);
306 char *pa_sw_volume_snprint_dB(char *s
, size_t l
, pa_volume_t v
) {
314 if (v
== (pa_volume_t
) -1) {
315 pa_snprintf(s
, l
, _("(invalid)"));
319 f
= pa_sw_volume_to_dB(v
);
320 pa_snprintf(s
, l
, "%0.2f dB",
321 isinf(f
) < 0 || f
<= PA_DECIBEL_MININFTY
? -INFINITY
: f
);
326 int pa_cvolume_channels_equal_to(const pa_cvolume
*a
, pa_volume_t v
) {
330 pa_return_val_if_fail(pa_cvolume_valid(a
), 0);
332 for (c
= 0; c
< a
->channels
; c
++)
333 if (a
->values
[c
] != v
)
339 pa_cvolume
*pa_sw_cvolume_multiply(pa_cvolume
*dest
, const pa_cvolume
*a
, const pa_cvolume
*b
) {
346 pa_return_val_if_fail(pa_cvolume_valid(a
), NULL
);
347 pa_return_val_if_fail(pa_cvolume_valid(b
), NULL
);
349 for (i
= 0; i
< a
->channels
&& i
< b
->channels
; i
++)
350 dest
->values
[i
] = pa_sw_volume_multiply(a
->values
[i
], b
->values
[i
]);
352 dest
->channels
= (uint8_t) i
;
357 pa_cvolume
*pa_sw_cvolume_multiply_scalar(pa_cvolume
*dest
, const pa_cvolume
*a
, pa_volume_t b
) {
363 pa_return_val_if_fail(pa_cvolume_valid(a
), NULL
);
365 for (i
= 0; i
< a
->channels
; i
++)
366 dest
->values
[i
] = pa_sw_volume_multiply(a
->values
[i
], b
);
368 dest
->channels
= (uint8_t) i
;
373 pa_cvolume
*pa_sw_cvolume_divide(pa_cvolume
*dest
, const pa_cvolume
*a
, const pa_cvolume
*b
) {
380 pa_return_val_if_fail(pa_cvolume_valid(a
), NULL
);
381 pa_return_val_if_fail(pa_cvolume_valid(b
), NULL
);
383 for (i
= 0; i
< a
->channels
&& i
< b
->channels
; i
++)
384 dest
->values
[i
] = pa_sw_volume_divide(a
->values
[i
], b
->values
[i
]);
386 dest
->channels
= (uint8_t) i
;
391 pa_cvolume
*pa_sw_cvolume_divide_scalar(pa_cvolume
*dest
, const pa_cvolume
*a
, pa_volume_t b
) {
397 pa_return_val_if_fail(pa_cvolume_valid(a
), NULL
);
399 for (i
= 0; i
< a
->channels
; i
++)
400 dest
->values
[i
] = pa_sw_volume_divide(a
->values
[i
], b
);
402 dest
->channels
= (uint8_t) i
;
407 int pa_cvolume_valid(const pa_cvolume
*v
) {
412 if (v
->channels
<= 0 || v
->channels
> PA_CHANNELS_MAX
)
415 for (c
= 0; c
< v
->channels
; c
++)
416 if (v
->values
[c
] == (pa_volume_t
) -1)
422 static pa_bool_t
on_left(pa_channel_position_t p
) {
423 return !!(PA_CHANNEL_POSITION_MASK(p
) & PA_CHANNEL_POSITION_MASK_LEFT
);
426 static pa_bool_t
on_right(pa_channel_position_t p
) {
427 return !!(PA_CHANNEL_POSITION_MASK(p
) & PA_CHANNEL_POSITION_MASK_RIGHT
);
430 static pa_bool_t
on_center(pa_channel_position_t p
) {
431 return !!(PA_CHANNEL_POSITION_MASK(p
) & PA_CHANNEL_POSITION_MASK_CENTER
);
434 static pa_bool_t
on_lfe(pa_channel_position_t p
) {
435 return p
== PA_CHANNEL_POSITION_LFE
;
438 static pa_bool_t
on_front(pa_channel_position_t p
) {
439 return !!(PA_CHANNEL_POSITION_MASK(p
) & PA_CHANNEL_POSITION_MASK_FRONT
);
442 static pa_bool_t
on_rear(pa_channel_position_t p
) {
443 return !!(PA_CHANNEL_POSITION_MASK(p
) & PA_CHANNEL_POSITION_MASK_REAR
);
446 pa_cvolume
*pa_cvolume_remap(pa_cvolume
*v
, const pa_channel_map
*from
, const pa_channel_map
*to
) {
454 pa_return_val_if_fail(pa_cvolume_valid(v
), NULL
);
455 pa_return_val_if_fail(pa_channel_map_valid(from
), NULL
);
456 pa_return_val_if_fail(pa_channel_map_valid(to
), NULL
);
457 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v
, from
), NULL
);
459 if (pa_channel_map_equal(from
, to
))
462 result
.channels
= to
->channels
;
464 for (b
= 0; b
< to
->channels
; b
++) {
468 for (a
= 0; a
< from
->channels
; a
++)
469 if (from
->map
[a
] == to
->map
[b
]) {
475 for (a
= 0; a
< from
->channels
; a
++)
476 if ((on_left(from
->map
[a
]) && on_left(to
->map
[b
])) ||
477 (on_right(from
->map
[a
]) && on_right(to
->map
[b
])) ||
478 (on_center(from
->map
[a
]) && on_center(to
->map
[b
])) ||
479 (on_lfe(from
->map
[a
]) && on_lfe(to
->map
[b
]))) {
487 k
= pa_cvolume_avg(v
);
491 result
.values
[b
] = k
;
498 int pa_cvolume_compatible(const pa_cvolume
*v
, const pa_sample_spec
*ss
) {
503 pa_return_val_if_fail(pa_cvolume_valid(v
), 0);
504 pa_return_val_if_fail(pa_sample_spec_valid(ss
), 0);
506 return v
->channels
== ss
->channels
;
509 int pa_cvolume_compatible_with_channel_map(const pa_cvolume
*v
, const pa_channel_map
*cm
) {
513 pa_return_val_if_fail(pa_cvolume_valid(v
), 0);
514 pa_return_val_if_fail(pa_channel_map_valid(cm
), 0);
516 return v
->channels
== cm
->channels
;
519 static void get_avg_lr(const pa_channel_map
*map
, const pa_cvolume
*v
, pa_volume_t
*l
, pa_volume_t
*r
) {
521 pa_volume_t left
= 0, right
= 0;
522 unsigned n_left
= 0, n_right
= 0;
526 pa_assert(map
->channels
== v
->channels
);
530 for (c
= 0; c
< map
->channels
; c
++) {
531 if (on_left(map
->map
[c
])) {
532 left
+= v
->values
[c
];
534 } else if (on_right(map
->map
[c
])) {
535 right
+= v
->values
[c
];
548 *r
= right
/ n_right
;
551 float pa_cvolume_get_balance(const pa_cvolume
*v
, const pa_channel_map
*map
) {
552 pa_volume_t left
, right
;
557 pa_return_val_if_fail(pa_cvolume_valid(v
), 0.0f
);
558 pa_return_val_if_fail(pa_channel_map_valid(map
), 0.0f
);
559 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v
, map
), 0.0f
);
561 if (!pa_channel_map_can_balance(map
))
564 get_avg_lr(map
, v
, &left
, &right
);
579 return -1.0f
+ ((float) right
/ (float) left
);
581 return 1.0f
- ((float) left
/ (float) right
);
584 pa_cvolume
* pa_cvolume_set_balance(pa_cvolume
*v
, const pa_channel_map
*map
, float new_balance
) {
585 pa_volume_t left
, nleft
, right
, nright
, m
;
590 pa_assert(new_balance
>= -1.0f
);
591 pa_assert(new_balance
<= 1.0f
);
593 pa_return_val_if_fail(pa_cvolume_valid(v
), NULL
);
594 pa_return_val_if_fail(pa_channel_map_valid(map
), NULL
);
595 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v
, map
), NULL
);
597 if (!pa_channel_map_can_balance(map
))
600 get_avg_lr(map
, v
, &left
, &right
);
602 m
= PA_MAX(left
, right
);
604 if (new_balance
<= 0) {
605 nright
= (new_balance
+ 1.0f
) * m
;
608 nleft
= (1.0f
- new_balance
) * m
;
612 for (c
= 0; c
< map
->channels
; c
++) {
613 if (on_left(map
->map
[c
])) {
615 v
->values
[c
] = nleft
;
617 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) nleft
) / (uint64_t) left
);
618 } else if (on_right(map
->map
[c
])) {
620 v
->values
[c
] = nright
;
622 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) nright
) / (uint64_t) right
);
629 pa_cvolume
* pa_cvolume_scale(pa_cvolume
*v
, pa_volume_t max
) {
635 pa_return_val_if_fail(pa_cvolume_valid(v
), NULL
);
636 pa_return_val_if_fail(max
!= (pa_volume_t
) -1, NULL
);
638 t
= pa_cvolume_max(v
);
640 if (t
<= PA_VOLUME_MUTED
)
641 return pa_cvolume_set(v
, v
->channels
, max
);
643 for (c
= 0; c
< v
->channels
; c
++)
644 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) max
) / (uint64_t) t
);
649 pa_cvolume
* pa_cvolume_scale_mask(pa_cvolume
*v
, pa_volume_t max
, pa_channel_map
*cm
, pa_channel_position_mask_t mask
) {
655 pa_return_val_if_fail(pa_cvolume_valid(v
), NULL
);
656 pa_return_val_if_fail(max
!= (pa_volume_t
) -1, NULL
);
658 t
= pa_cvolume_max_mask(v
, cm
, mask
);
660 if (t
<= PA_VOLUME_MUTED
)
661 return pa_cvolume_set(v
, v
->channels
, max
);
663 for (c
= 0; c
< v
->channels
; c
++)
664 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) max
) / (uint64_t) t
);
669 static void get_avg_fr(const pa_channel_map
*map
, const pa_cvolume
*v
, pa_volume_t
*f
, pa_volume_t
*r
) {
671 pa_volume_t front
= 0, rear
= 0;
672 unsigned n_front
= 0, n_rear
= 0;
676 pa_assert(map
->channels
== v
->channels
);
680 for (c
= 0; c
< map
->channels
; c
++) {
681 if (on_front(map
->map
[c
])) {
682 front
+= v
->values
[c
];
684 } else if (on_rear(map
->map
[c
])) {
685 rear
+= v
->values
[c
];
693 *f
= front
/ n_front
;
701 float pa_cvolume_get_fade(const pa_cvolume
*v
, const pa_channel_map
*map
) {
702 pa_volume_t front
, rear
;
707 pa_return_val_if_fail(pa_cvolume_valid(v
), 0.0f
);
708 pa_return_val_if_fail(pa_channel_map_valid(map
), 0.0f
);
709 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v
, map
), 0.0f
);
711 if (!pa_channel_map_can_fade(map
))
714 get_avg_fr(map
, v
, &front
, &rear
);
720 return -1.0f
+ ((float) front
/ (float) rear
);
722 return 1.0f
- ((float) rear
/ (float) front
);
725 pa_cvolume
* pa_cvolume_set_fade(pa_cvolume
*v
, const pa_channel_map
*map
, float new_fade
) {
726 pa_volume_t front
, nfront
, rear
, nrear
, m
;
731 pa_assert(new_fade
>= -1.0f
);
732 pa_assert(new_fade
<= 1.0f
);
734 pa_return_val_if_fail(pa_cvolume_valid(v
), NULL
);
735 pa_return_val_if_fail(pa_channel_map_valid(map
), NULL
);
736 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v
, map
), NULL
);
738 if (!pa_channel_map_can_fade(map
))
741 get_avg_fr(map
, v
, &front
, &rear
);
743 m
= PA_MAX(front
, rear
);
746 nfront
= (new_fade
+ 1.0f
) * m
;
749 nrear
= (1.0f
- new_fade
) * m
;
753 for (c
= 0; c
< map
->channels
; c
++) {
754 if (on_front(map
->map
[c
])) {
756 v
->values
[c
] = nfront
;
758 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) nfront
) / (uint64_t) front
);
759 } else if (on_rear(map
->map
[c
])) {
761 v
->values
[c
] = nrear
;
763 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) nrear
) / (uint64_t) rear
);
770 pa_cvolume
* pa_cvolume_set_position(
772 const pa_channel_map
*map
,
773 pa_channel_position_t t
,
777 pa_bool_t good
= FALSE
;
782 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(cv
, map
), NULL
);
783 pa_return_val_if_fail(t
< PA_CHANNEL_POSITION_MAX
, NULL
);
785 for (c
= 0; c
< map
->channels
; c
++)
786 if (map
->map
[c
] == t
) {
791 return good
? cv
: NULL
;
794 pa_volume_t
pa_cvolume_get_position(
796 const pa_channel_map
*map
,
797 pa_channel_position_t t
) {
800 pa_volume_t v
= PA_VOLUME_MUTED
;
805 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(cv
, map
), PA_VOLUME_MUTED
);
806 pa_return_val_if_fail(t
< PA_CHANNEL_POSITION_MAX
, PA_VOLUME_MUTED
);
808 for (c
= 0; c
< map
->channels
; c
++)
809 if (map
->map
[c
] == t
)
810 if (cv
->values
[c
] > v
)