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
) {
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_max_mask(const pa_cvolume
*a
, const pa_channel_map
*cm
, pa_channel_position_mask_t mask
) {
149 return pa_cvolume_max(a
);
151 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(a
, cm
), PA_VOLUME_MUTED
);
153 for (c
= n
= 0; c
< a
->channels
; c
++) {
155 if (!(PA_CHANNEL_POSITION_MASK(cm
->map
[c
]) & mask
))
158 if (a
->values
[c
] > m
)
165 pa_volume_t
pa_sw_volume_multiply(pa_volume_t a
, pa_volume_t b
) {
166 return pa_sw_volume_from_linear(pa_sw_volume_to_linear(a
) * pa_sw_volume_to_linear(b
));
169 pa_volume_t
pa_sw_volume_divide(pa_volume_t a
, pa_volume_t b
) {
170 double v
= pa_sw_volume_to_linear(b
);
175 return pa_sw_volume_from_linear(pa_sw_volume_to_linear(a
) / v
);
178 /* Amplitude, not power */
179 static double linear_to_dB(double v
) {
180 return 20.0 * log10(v
);
183 static double dB_to_linear(double v
) {
184 return pow(10.0, v
/ 20.0);
187 pa_volume_t
pa_sw_volume_from_dB(double dB
) {
188 if (isinf(dB
) < 0 || dB
<= PA_DECIBEL_MININFTY
)
189 return PA_VOLUME_MUTED
;
191 return pa_sw_volume_from_linear(dB_to_linear(dB
));
194 double pa_sw_volume_to_dB(pa_volume_t v
) {
196 if (v
<= PA_VOLUME_MUTED
)
197 return PA_DECIBEL_MININFTY
;
199 return linear_to_dB(pa_sw_volume_to_linear(v
));
202 pa_volume_t
pa_sw_volume_from_linear(double v
) {
205 return PA_VOLUME_MUTED
;
208 * We use a cubic mapping here, as suggested and discussed here:
210 * http://www.robotplanet.dk/audio/audio_gui_design/
211 * http://lists.linuxaudio.org/pipermail/linux-audio-dev/2009-May/thread.html#23151
213 * We make sure that the conversion to linear and back yields the
214 * same volume value! That's why we need the lround() below!
217 return (pa_volume_t
) lround(cbrt(v
) * PA_VOLUME_NORM
);
220 double pa_sw_volume_to_linear(pa_volume_t v
) {
223 if (v
<= PA_VOLUME_MUTED
)
226 if (v
== PA_VOLUME_NORM
)
229 f
= ((double) v
/ PA_VOLUME_NORM
);
234 char *pa_cvolume_snprint(char *s
, size_t l
, const pa_cvolume
*c
) {
236 pa_bool_t first
= TRUE
;
245 if (!pa_cvolume_valid(c
)) {
246 pa_snprintf(s
, l
, _("(invalid)"));
252 for (channel
= 0; channel
< c
->channels
&& l
> 1; channel
++) {
253 l
-= pa_snprintf(e
, l
, "%s%u: %3u%%",
256 (c
->values
[channel
]*100)/PA_VOLUME_NORM
);
265 char *pa_volume_snprint(char *s
, size_t l
, pa_volume_t v
) {
271 if (v
== (pa_volume_t
) -1) {
272 pa_snprintf(s
, l
, _("(invalid)"));
276 pa_snprintf(s
, l
, "%3u%%", (v
*100)/PA_VOLUME_NORM
);
280 char *pa_sw_cvolume_snprint_dB(char *s
, size_t l
, const pa_cvolume
*c
) {
282 pa_bool_t first
= TRUE
;
291 if (!pa_cvolume_valid(c
)) {
292 pa_snprintf(s
, l
, _("(invalid)"));
298 for (channel
= 0; channel
< c
->channels
&& l
> 1; channel
++) {
299 double f
= pa_sw_volume_to_dB(c
->values
[channel
]);
301 l
-= pa_snprintf(e
, l
, "%s%u: %0.2f dB",
304 isinf(f
) < 0 || f
<= PA_DECIBEL_MININFTY
? -INFINITY
: f
);
313 char *pa_sw_volume_snprint_dB(char *s
, size_t l
, pa_volume_t v
) {
321 if (v
== (pa_volume_t
) -1) {
322 pa_snprintf(s
, l
, _("(invalid)"));
326 f
= pa_sw_volume_to_dB(v
);
327 pa_snprintf(s
, l
, "%0.2f dB",
328 isinf(f
) < 0 || f
<= PA_DECIBEL_MININFTY
? -INFINITY
: f
);
333 int pa_cvolume_channels_equal_to(const pa_cvolume
*a
, pa_volume_t v
) {
337 pa_return_val_if_fail(pa_cvolume_valid(a
), 0);
339 for (c
= 0; c
< a
->channels
; c
++)
340 if (a
->values
[c
] != v
)
346 pa_cvolume
*pa_sw_cvolume_multiply(pa_cvolume
*dest
, const pa_cvolume
*a
, const pa_cvolume
*b
) {
353 pa_return_val_if_fail(pa_cvolume_valid(a
), NULL
);
354 pa_return_val_if_fail(pa_cvolume_valid(b
), NULL
);
356 for (i
= 0; i
< a
->channels
&& i
< b
->channels
; i
++)
357 dest
->values
[i
] = pa_sw_volume_multiply(a
->values
[i
], b
->values
[i
]);
359 dest
->channels
= (uint8_t) i
;
364 pa_cvolume
*pa_sw_cvolume_multiply_scalar(pa_cvolume
*dest
, const pa_cvolume
*a
, pa_volume_t b
) {
370 pa_return_val_if_fail(pa_cvolume_valid(a
), NULL
);
372 for (i
= 0; i
< a
->channels
; i
++)
373 dest
->values
[i
] = pa_sw_volume_multiply(a
->values
[i
], b
);
375 dest
->channels
= (uint8_t) i
;
380 pa_cvolume
*pa_sw_cvolume_divide(pa_cvolume
*dest
, const pa_cvolume
*a
, const pa_cvolume
*b
) {
387 pa_return_val_if_fail(pa_cvolume_valid(a
), NULL
);
388 pa_return_val_if_fail(pa_cvolume_valid(b
), NULL
);
390 for (i
= 0; i
< a
->channels
&& i
< b
->channels
; i
++)
391 dest
->values
[i
] = pa_sw_volume_divide(a
->values
[i
], b
->values
[i
]);
393 dest
->channels
= (uint8_t) i
;
398 pa_cvolume
*pa_sw_cvolume_divide_scalar(pa_cvolume
*dest
, const pa_cvolume
*a
, pa_volume_t b
) {
404 pa_return_val_if_fail(pa_cvolume_valid(a
), NULL
);
406 for (i
= 0; i
< a
->channels
; i
++)
407 dest
->values
[i
] = pa_sw_volume_divide(a
->values
[i
], b
);
409 dest
->channels
= (uint8_t) i
;
414 int pa_cvolume_valid(const pa_cvolume
*v
) {
419 if (v
->channels
<= 0 || v
->channels
> PA_CHANNELS_MAX
)
422 for (c
= 0; c
< v
->channels
; c
++)
423 if (v
->values
[c
] == (pa_volume_t
) -1)
429 static pa_bool_t
on_left(pa_channel_position_t p
) {
430 return !!(PA_CHANNEL_POSITION_MASK(p
) & PA_CHANNEL_POSITION_MASK_LEFT
);
433 static pa_bool_t
on_right(pa_channel_position_t p
) {
434 return !!(PA_CHANNEL_POSITION_MASK(p
) & PA_CHANNEL_POSITION_MASK_RIGHT
);
437 static pa_bool_t
on_center(pa_channel_position_t p
) {
438 return !!(PA_CHANNEL_POSITION_MASK(p
) & PA_CHANNEL_POSITION_MASK_CENTER
);
441 static pa_bool_t
on_lfe(pa_channel_position_t p
) {
442 return p
== PA_CHANNEL_POSITION_LFE
;
445 static pa_bool_t
on_front(pa_channel_position_t p
) {
446 return !!(PA_CHANNEL_POSITION_MASK(p
) & PA_CHANNEL_POSITION_MASK_FRONT
);
449 static pa_bool_t
on_rear(pa_channel_position_t p
) {
450 return !!(PA_CHANNEL_POSITION_MASK(p
) & PA_CHANNEL_POSITION_MASK_REAR
);
453 pa_cvolume
*pa_cvolume_remap(pa_cvolume
*v
, const pa_channel_map
*from
, const pa_channel_map
*to
) {
461 pa_return_val_if_fail(pa_cvolume_valid(v
), NULL
);
462 pa_return_val_if_fail(pa_channel_map_valid(from
), NULL
);
463 pa_return_val_if_fail(pa_channel_map_valid(to
), NULL
);
464 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v
, from
), NULL
);
466 if (pa_channel_map_equal(from
, to
))
469 result
.channels
= to
->channels
;
471 for (b
= 0; b
< to
->channels
; b
++) {
475 for (a
= 0; a
< from
->channels
; a
++)
476 if (from
->map
[a
] == to
->map
[b
]) {
482 for (a
= 0; a
< from
->channels
; a
++)
483 if ((on_left(from
->map
[a
]) && on_left(to
->map
[b
])) ||
484 (on_right(from
->map
[a
]) && on_right(to
->map
[b
])) ||
485 (on_center(from
->map
[a
]) && on_center(to
->map
[b
])) ||
486 (on_lfe(from
->map
[a
]) && on_lfe(to
->map
[b
]))) {
494 k
= pa_cvolume_avg(v
);
498 result
.values
[b
] = k
;
505 int pa_cvolume_compatible(const pa_cvolume
*v
, const pa_sample_spec
*ss
) {
510 pa_return_val_if_fail(pa_cvolume_valid(v
), 0);
511 pa_return_val_if_fail(pa_sample_spec_valid(ss
), 0);
513 return v
->channels
== ss
->channels
;
516 int pa_cvolume_compatible_with_channel_map(const pa_cvolume
*v
, const pa_channel_map
*cm
) {
520 pa_return_val_if_fail(pa_cvolume_valid(v
), 0);
521 pa_return_val_if_fail(pa_channel_map_valid(cm
), 0);
523 return v
->channels
== cm
->channels
;
526 static void get_avg_lr(const pa_channel_map
*map
, const pa_cvolume
*v
, pa_volume_t
*l
, pa_volume_t
*r
) {
528 pa_volume_t left
= 0, right
= 0;
529 unsigned n_left
= 0, n_right
= 0;
533 pa_assert(map
->channels
== v
->channels
);
537 for (c
= 0; c
< map
->channels
; c
++) {
538 if (on_left(map
->map
[c
])) {
539 left
+= v
->values
[c
];
541 } else if (on_right(map
->map
[c
])) {
542 right
+= v
->values
[c
];
555 *r
= right
/ n_right
;
558 float pa_cvolume_get_balance(const pa_cvolume
*v
, const pa_channel_map
*map
) {
559 pa_volume_t left
, right
;
564 pa_return_val_if_fail(pa_cvolume_valid(v
), 0.0f
);
565 pa_return_val_if_fail(pa_channel_map_valid(map
), 0.0f
);
566 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v
, map
), 0.0f
);
568 if (!pa_channel_map_can_balance(map
))
571 get_avg_lr(map
, v
, &left
, &right
);
586 return -1.0f
+ ((float) right
/ (float) left
);
588 return 1.0f
- ((float) left
/ (float) right
);
591 pa_cvolume
* pa_cvolume_set_balance(pa_cvolume
*v
, const pa_channel_map
*map
, float new_balance
) {
592 pa_volume_t left
, nleft
, right
, nright
, m
;
597 pa_assert(new_balance
>= -1.0f
);
598 pa_assert(new_balance
<= 1.0f
);
600 pa_return_val_if_fail(pa_cvolume_valid(v
), NULL
);
601 pa_return_val_if_fail(pa_channel_map_valid(map
), NULL
);
602 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v
, map
), NULL
);
604 if (!pa_channel_map_can_balance(map
))
607 get_avg_lr(map
, v
, &left
, &right
);
609 m
= PA_MAX(left
, right
);
611 if (new_balance
<= 0) {
612 nright
= (new_balance
+ 1.0f
) * m
;
615 nleft
= (1.0f
- new_balance
) * m
;
619 for (c
= 0; c
< map
->channels
; c
++) {
620 if (on_left(map
->map
[c
])) {
622 v
->values
[c
] = nleft
;
624 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) nleft
) / (uint64_t) left
);
625 } else if (on_right(map
->map
[c
])) {
627 v
->values
[c
] = nright
;
629 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) nright
) / (uint64_t) right
);
636 pa_cvolume
* pa_cvolume_scale(pa_cvolume
*v
, pa_volume_t max
) {
642 pa_return_val_if_fail(pa_cvolume_valid(v
), NULL
);
643 pa_return_val_if_fail(max
!= (pa_volume_t
) -1, NULL
);
645 t
= pa_cvolume_max(v
);
647 if (t
<= PA_VOLUME_MUTED
)
648 return pa_cvolume_set(v
, v
->channels
, max
);
650 for (c
= 0; c
< v
->channels
; c
++)
651 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) max
) / (uint64_t) t
);
656 pa_cvolume
* pa_cvolume_scale_mask(pa_cvolume
*v
, pa_volume_t max
, pa_channel_map
*cm
, pa_channel_position_mask_t mask
) {
662 pa_return_val_if_fail(pa_cvolume_valid(v
), NULL
);
663 pa_return_val_if_fail(max
!= (pa_volume_t
) -1, NULL
);
665 t
= pa_cvolume_max_mask(v
, cm
, mask
);
667 if (t
<= PA_VOLUME_MUTED
)
668 return pa_cvolume_set(v
, v
->channels
, max
);
670 for (c
= 0; c
< v
->channels
; c
++)
671 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) max
) / (uint64_t) t
);
676 static void get_avg_fr(const pa_channel_map
*map
, const pa_cvolume
*v
, pa_volume_t
*f
, pa_volume_t
*r
) {
678 pa_volume_t front
= 0, rear
= 0;
679 unsigned n_front
= 0, n_rear
= 0;
683 pa_assert(map
->channels
== v
->channels
);
687 for (c
= 0; c
< map
->channels
; c
++) {
688 if (on_front(map
->map
[c
])) {
689 front
+= v
->values
[c
];
691 } else if (on_rear(map
->map
[c
])) {
692 rear
+= v
->values
[c
];
700 *f
= front
/ n_front
;
708 float pa_cvolume_get_fade(const pa_cvolume
*v
, const pa_channel_map
*map
) {
709 pa_volume_t front
, rear
;
714 pa_return_val_if_fail(pa_cvolume_valid(v
), 0.0f
);
715 pa_return_val_if_fail(pa_channel_map_valid(map
), 0.0f
);
716 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v
, map
), 0.0f
);
718 if (!pa_channel_map_can_fade(map
))
721 get_avg_fr(map
, v
, &front
, &rear
);
727 return -1.0f
+ ((float) front
/ (float) rear
);
729 return 1.0f
- ((float) rear
/ (float) front
);
732 pa_cvolume
* pa_cvolume_set_fade(pa_cvolume
*v
, const pa_channel_map
*map
, float new_fade
) {
733 pa_volume_t front
, nfront
, rear
, nrear
, m
;
738 pa_assert(new_fade
>= -1.0f
);
739 pa_assert(new_fade
<= 1.0f
);
741 pa_return_val_if_fail(pa_cvolume_valid(v
), NULL
);
742 pa_return_val_if_fail(pa_channel_map_valid(map
), NULL
);
743 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v
, map
), NULL
);
745 if (!pa_channel_map_can_fade(map
))
748 get_avg_fr(map
, v
, &front
, &rear
);
750 m
= PA_MAX(front
, rear
);
753 nfront
= (new_fade
+ 1.0f
) * m
;
756 nrear
= (1.0f
- new_fade
) * m
;
760 for (c
= 0; c
< map
->channels
; c
++) {
761 if (on_front(map
->map
[c
])) {
763 v
->values
[c
] = nfront
;
765 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) nfront
) / (uint64_t) front
);
766 } else if (on_rear(map
->map
[c
])) {
768 v
->values
[c
] = nrear
;
770 v
->values
[c
] = (pa_volume_t
) (((uint64_t) v
->values
[c
] * (uint64_t) nrear
) / (uint64_t) rear
);
777 pa_cvolume
* pa_cvolume_set_position(
779 const pa_channel_map
*map
,
780 pa_channel_position_t t
,
784 pa_bool_t good
= FALSE
;
789 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(cv
, map
), NULL
);
790 pa_return_val_if_fail(t
< PA_CHANNEL_POSITION_MAX
, NULL
);
792 for (c
= 0; c
< map
->channels
; c
++)
793 if (map
->map
[c
] == t
) {
798 return good
? cv
: NULL
;
801 pa_volume_t
pa_cvolume_get_position(
803 const pa_channel_map
*map
,
804 pa_channel_position_t t
) {
807 pa_volume_t v
= PA_VOLUME_MUTED
;
812 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(cv
, map
), PA_VOLUME_MUTED
);
813 pa_return_val_if_fail(t
< PA_CHANNEL_POSITION_MAX
, PA_VOLUME_MUTED
);
815 for (c
= 0; c
< map
->channels
; c
++)
816 if (map
->map
[c
] == t
)
817 if (cv
->values
[c
] > v
)
823 pa_cvolume
* pa_cvolume_merge(pa_cvolume
*dest
, const pa_cvolume
*a
, const pa_cvolume
*b
) {
830 pa_return_val_if_fail(pa_cvolume_valid(a
), NULL
);
831 pa_return_val_if_fail(pa_cvolume_valid(b
), NULL
);
833 for (i
= 0; i
< a
->channels
&& i
< b
->channels
; i
++)
834 dest
->values
[i
] = PA_MAX(a
->values
[i
], b
->values
[i
]);
836 dest
->channels
= (uint8_t) i
;