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 (i = 0; i < a->channels; i++)
93 return (pa_volume_t) sum;
96 pa_volume_t pa_cvolume_max(const pa_cvolume *a) {
101 pa_return_val_if_fail(pa_cvolume_valid(a), PA_VOLUME_MUTED);
103 for (i = 0; i < a->channels; i++)
104 if (a->values[i] > m)
110 pa_volume_t pa_sw_volume_multiply(pa_volume_t a, pa_volume_t b) {
111 return pa_sw_volume_from_linear(pa_sw_volume_to_linear(a) * pa_sw_volume_to_linear(b));
114 pa_volume_t pa_sw_volume_divide(pa_volume_t a, pa_volume_t b) {
115 double v = pa_sw_volume_to_linear(b);
120 return pa_sw_volume_from_linear(pa_sw_volume_to_linear(a) / v);
123 #define USER_DECIBEL_RANGE 90
125 pa_volume_t pa_sw_volume_from_dB(double dB) {
126 if (isinf(dB) < 0 || dB <= -USER_DECIBEL_RANGE)
127 return PA_VOLUME_MUTED;
129 return (pa_volume_t) lrint(ceil((dB/USER_DECIBEL_RANGE+1.0)*PA_VOLUME_NORM));
132 double pa_sw_volume_to_dB(pa_volume_t v) {
133 if (v == PA_VOLUME_MUTED)
134 return PA_DECIBEL_MININFTY;
136 return ((double) v/PA_VOLUME_NORM-1)*USER_DECIBEL_RANGE;
139 pa_volume_t pa_sw_volume_from_linear(double v) {
142 return PA_VOLUME_MUTED;
144 if (v > .999 && v < 1.001)
145 return PA_VOLUME_NORM;
147 return pa_sw_volume_from_dB(20.0*log10(v));
150 double pa_sw_volume_to_linear(pa_volume_t v) {
152 if (v == PA_VOLUME_MUTED)
155 return pow(10.0, pa_sw_volume_to_dB(v)/20.0);
158 char *pa_cvolume_snprint(char *s, size_t l, const pa_cvolume *c) {
160 pa_bool_t first = TRUE;
169 if (!pa_cvolume_valid(c)) {
170 pa_snprintf(s, l, _("(invalid)"));
176 for (channel = 0; channel < c->channels && l > 1; channel++) {
177 l -= pa_snprintf(e, l, "%s%u: %3u%%",
180 (c->values[channel]*100)/PA_VOLUME_NORM);
189 char *pa_volume_snprint(char *s, size_t l, pa_volume_t v) {
195 if (v == (pa_volume_t) -1) {
196 pa_snprintf(s, l, _("(invalid)"));
200 pa_snprintf(s, l, "%3u%%", (v*100)/PA_VOLUME_NORM);
204 char *pa_sw_cvolume_snprint_dB(char *s, size_t l, const pa_cvolume *c) {
206 pa_bool_t first = TRUE;
215 if (!pa_cvolume_valid(c)) {
216 pa_snprintf(s, l, _("(invalid)"));
222 for (channel = 0; channel < c->channels && l > 1; channel++) {
223 double f = pa_sw_volume_to_dB(c->values[channel]);
225 l -= pa_snprintf(e, l, "%s%u: %0.2f dB",
228 isinf(f) < 0 || f <= -USER_DECIBEL_RANGE ? -INFINITY : f);
237 char *pa_sw_volume_snprint_dB(char *s, size_t l, pa_volume_t v) {
245 if (v == (pa_volume_t) -1) {
246 pa_snprintf(s, l, _("(invalid)"));
250 f = pa_sw_volume_to_dB(v);
251 pa_snprintf(s, l, "%0.2f dB",
252 isinf(f) < 0 || f <= -USER_DECIBEL_RANGE ? -INFINITY : f);
257 int pa_cvolume_channels_equal_to(const pa_cvolume *a, pa_volume_t v) {
261 pa_return_val_if_fail(pa_cvolume_valid(a), 0);
263 for (c = 0; c < a->channels; c++)
264 if (a->values[c] != v)
270 pa_cvolume *pa_sw_cvolume_multiply(pa_cvolume *dest, const pa_cvolume *a, const pa_cvolume *b) {
277 pa_return_val_if_fail(pa_cvolume_valid(a), NULL);
278 pa_return_val_if_fail(pa_cvolume_valid(b), NULL);
280 for (i = 0; i < a->channels && i < b->channels && i < PA_CHANNELS_MAX; i++)
281 dest->values[i] = pa_sw_volume_multiply(a->values[i], b->values[i]);
283 dest->channels = (uint8_t) i;
288 pa_cvolume *pa_sw_cvolume_divide(pa_cvolume *dest, const pa_cvolume *a, const pa_cvolume *b) {
295 pa_return_val_if_fail(pa_cvolume_valid(a), NULL);
296 pa_return_val_if_fail(pa_cvolume_valid(b), NULL);
298 for (i = 0; i < a->channels && i < b->channels && i < PA_CHANNELS_MAX; i++)
299 dest->values[i] = pa_sw_volume_divide(a->values[i], b->values[i]);
301 dest->channels = (uint8_t) i;
306 int pa_cvolume_valid(const pa_cvolume *v) {
311 if (v->channels <= 0 || v->channels > PA_CHANNELS_MAX)
314 for (c = 0; c < v->channels; c++)
315 if (v->values[c] == (pa_volume_t) -1)
321 static pa_bool_t on_left(pa_channel_position_t p) {
324 p == PA_CHANNEL_POSITION_FRONT_LEFT ||
325 p == PA_CHANNEL_POSITION_REAR_LEFT ||
326 p == PA_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER ||
327 p == PA_CHANNEL_POSITION_SIDE_LEFT ||
328 p == PA_CHANNEL_POSITION_TOP_FRONT_LEFT ||
329 p == PA_CHANNEL_POSITION_TOP_REAR_LEFT;
332 static pa_bool_t on_right(pa_channel_position_t p) {
335 p == PA_CHANNEL_POSITION_FRONT_RIGHT ||
336 p == PA_CHANNEL_POSITION_REAR_RIGHT ||
337 p == PA_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER ||
338 p == PA_CHANNEL_POSITION_SIDE_RIGHT ||
339 p == PA_CHANNEL_POSITION_TOP_FRONT_RIGHT ||
340 p == PA_CHANNEL_POSITION_TOP_REAR_RIGHT;
343 static pa_bool_t on_center(pa_channel_position_t p) {
346 p == PA_CHANNEL_POSITION_FRONT_CENTER ||
347 p == PA_CHANNEL_POSITION_REAR_CENTER ||
348 p == PA_CHANNEL_POSITION_TOP_CENTER ||
349 p == PA_CHANNEL_POSITION_TOP_FRONT_CENTER ||
350 p == PA_CHANNEL_POSITION_TOP_REAR_CENTER;
353 static pa_bool_t on_lfe(pa_channel_position_t p) {
356 p == PA_CHANNEL_POSITION_LFE;
359 static pa_bool_t on_front(pa_channel_position_t p) {
362 p == PA_CHANNEL_POSITION_FRONT_LEFT ||
363 p == PA_CHANNEL_POSITION_FRONT_RIGHT ||
364 p == PA_CHANNEL_POSITION_FRONT_CENTER ||
365 p == PA_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER ||
366 p == PA_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER ||
367 p == PA_CHANNEL_POSITION_TOP_FRONT_LEFT ||
368 p == PA_CHANNEL_POSITION_TOP_FRONT_RIGHT ||
369 p == PA_CHANNEL_POSITION_TOP_FRONT_CENTER;
372 static pa_bool_t on_rear(pa_channel_position_t p) {
375 p == PA_CHANNEL_POSITION_REAR_LEFT ||
376 p == PA_CHANNEL_POSITION_REAR_RIGHT ||
377 p == PA_CHANNEL_POSITION_REAR_CENTER ||
378 p == PA_CHANNEL_POSITION_TOP_REAR_LEFT ||
379 p == PA_CHANNEL_POSITION_TOP_REAR_RIGHT ||
380 p == PA_CHANNEL_POSITION_TOP_REAR_CENTER;
383 pa_cvolume *pa_cvolume_remap(pa_cvolume *v, const pa_channel_map *from, const pa_channel_map *to) {
391 pa_return_val_if_fail(pa_cvolume_valid(v), NULL);
392 pa_return_val_if_fail(pa_channel_map_valid(from), NULL);
393 pa_return_val_if_fail(pa_channel_map_valid(to), NULL);
394 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v, from), NULL);
396 if (pa_channel_map_equal(from, to))
399 result.channels = to->channels;
401 for (b = 0; b < to->channels; b++) {
405 for (a = 0; a < from->channels; a++)
406 if (from->map[a] == to->map[b]) {
412 for (a = 0; a < from->channels; a++)
413 if ((on_left(from->map[a]) && on_left(to->map[b])) ||
414 (on_right(from->map[a]) && on_right(to->map[b])) ||
415 (on_center(from->map[a]) && on_center(to->map[b])) ||
416 (on_lfe(from->map[a]) && on_lfe(to->map[b]))) {
424 k = pa_cvolume_avg(v);
428 result.values[b] = k;
435 int pa_cvolume_compatible(const pa_cvolume *v, const pa_sample_spec *ss) {
440 pa_return_val_if_fail(pa_cvolume_valid(v), 0);
441 pa_return_val_if_fail(pa_sample_spec_valid(ss), 0);
443 return v->channels == ss->channels;
446 int pa_cvolume_compatible_with_channel_map(const pa_cvolume *v, const pa_channel_map *cm) {
450 pa_return_val_if_fail(pa_cvolume_valid(v), 0);
451 pa_return_val_if_fail(pa_channel_map_valid(cm), 0);
453 return v->channels == cm->channels;
456 static void get_avg_lr(const pa_channel_map *map, const pa_cvolume *v, pa_volume_t *l, pa_volume_t *r) {
458 pa_volume_t left = 0, right = 0;
459 unsigned n_left = 0, n_right = 0;
463 pa_assert(map->channels == v->channels);
467 for (c = 0; c < map->channels; c++) {
468 if (on_left(map->map[c])) {
469 left += v->values[c];
471 } else if (on_right(map->map[c])) {
472 right += v->values[c];
485 *r = right / n_right;
488 float pa_cvolume_get_balance(const pa_cvolume *v, const pa_channel_map *map) {
489 pa_volume_t left, right;
494 pa_return_val_if_fail(pa_cvolume_valid(v), 0.0f);
495 pa_return_val_if_fail(pa_channel_map_valid(map), 0.0f);
496 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v, map), 0.0f);
498 if (!pa_channel_map_can_balance(map))
501 get_avg_lr(map, v, &left, &right);
516 return -1.0f + ((float) right / (float) left);
518 return 1.0f - ((float) left / (float) right);
521 pa_cvolume* pa_cvolume_set_balance(pa_cvolume *v, const pa_channel_map *map, float new_balance) {
522 pa_volume_t left, nleft, right, nright, m;
527 pa_assert(new_balance >= -1.0f);
528 pa_assert(new_balance <= 1.0f);
530 pa_return_val_if_fail(pa_cvolume_valid(v), NULL);
531 pa_return_val_if_fail(pa_channel_map_valid(map), NULL);
532 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v, map), NULL);
534 if (!pa_channel_map_can_balance(map))
537 get_avg_lr(map, v, &left, &right);
539 m = PA_MAX(left, right);
541 if (new_balance <= 0) {
542 nright = (new_balance + 1.0f) * m;
545 nleft = (1.0f - new_balance) * m;
549 for (c = 0; c < map->channels; c++) {
550 if (on_left(map->map[c])) {
552 v->values[c] = nleft;
554 v->values[c] = (pa_volume_t) (((uint64_t) v->values[c] * (uint64_t) nleft) / (uint64_t) left);
555 } else if (on_right(map->map[c])) {
557 v->values[c] = nright;
559 v->values[c] = (pa_volume_t) (((uint64_t) v->values[c] * (uint64_t) nright) / (uint64_t) right);
566 pa_cvolume* pa_cvolume_scale(pa_cvolume *v, pa_volume_t max) {
572 pa_return_val_if_fail(pa_cvolume_valid(v), NULL);
573 pa_return_val_if_fail(max != (pa_volume_t) -1, NULL);
575 for (c = 0; c < v->channels; c++)
576 if (v->values[c] > t)
580 return pa_cvolume_set(v, v->channels, max);
582 for (c = 0; c < v->channels; c++)
583 v->values[c] = (pa_volume_t) (((uint64_t) v->values[c] * (uint64_t) max) / (uint64_t) t);
588 static void get_avg_fr(const pa_channel_map *map, const pa_cvolume *v, pa_volume_t *f, pa_volume_t *r) {
590 pa_volume_t front = 0, rear = 0;
591 unsigned n_front = 0, n_rear = 0;
595 pa_assert(map->channels == v->channels);
599 for (c = 0; c < map->channels; c++) {
600 if (on_front(map->map[c])) {
601 front += v->values[c];
603 } else if (on_rear(map->map[c])) {
604 rear += v->values[c];
612 *f = front / n_front;
620 float pa_cvolume_get_fade(const pa_cvolume *v, const pa_channel_map *map) {
621 pa_volume_t front, rear;
626 pa_return_val_if_fail(pa_cvolume_valid(v), 0.0f);
627 pa_return_val_if_fail(pa_channel_map_valid(map), 0.0f);
628 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v, map), 0.0f);
630 if (!pa_channel_map_can_fade(map))
633 get_avg_fr(map, v, &front, &rear);
639 return -1.0f + ((float) front / (float) rear);
641 return 1.0f - ((float) rear / (float) front);
644 pa_cvolume* pa_cvolume_set_fade(pa_cvolume *v, const pa_channel_map *map, float new_fade) {
645 pa_volume_t front, nfront, rear, nrear, m;
650 pa_assert(new_fade >= -1.0f);
651 pa_assert(new_fade <= 1.0f);
653 pa_return_val_if_fail(pa_cvolume_valid(v), NULL);
654 pa_return_val_if_fail(pa_channel_map_valid(map), NULL);
655 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(v, map), NULL);
657 if (!pa_channel_map_can_fade(map))
660 get_avg_fr(map, v, &front, &rear);
662 m = PA_MAX(front, rear);
665 nfront = (new_fade + 1.0f) * m;
668 nrear = (1.0f - new_fade) * m;
672 for (c = 0; c < map->channels; c++) {
673 if (on_front(map->map[c])) {
675 v->values[c] = nfront;
677 v->values[c] = (pa_volume_t) (((uint64_t) v->values[c] * (uint64_t) nfront) / (uint64_t) front);
678 } else if (on_rear(map->map[c])) {
680 v->values[c] = nrear;
682 v->values[c] = (pa_volume_t) (((uint64_t) v->values[c] * (uint64_t) nrear) / (uint64_t) rear);
689 pa_cvolume* pa_cvolume_set_position(
691 const pa_channel_map *map,
692 pa_channel_position_t t,
696 pa_bool_t good = FALSE;
701 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(cv, map), NULL);
702 pa_return_val_if_fail(t < PA_CHANNEL_POSITION_MAX, NULL);
704 for (c = 0; c < map->channels; c++)
705 if (map->map[c] == t) {
710 return good ? cv : NULL;
713 pa_volume_t pa_cvolume_get_position(
715 const pa_channel_map *map,
716 pa_channel_position_t t) {
719 pa_volume_t v = PA_VOLUME_MUTED;
724 pa_return_val_if_fail(pa_cvolume_compatible_with_channel_map(cv, map), PA_VOLUME_MUTED);
725 pa_return_val_if_fail(t < PA_CHANNEL_POSITION_MAX, PA_VOLUME_MUTED);
727 for (c = 0; c < map->channels; c++)
728 if (map->map[c] == t)
729 if (cv->values[c] > v)