src/pulse/volume.c

   1 /***
   2   This file is part of PulseAudio.
   3
   4   Copyright 2004-2006 Lennart Poettering
   5
   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 of the License,
   9   or (at your option) any later version.
  10
  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.
  15
  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
  19   USA.
  20 ***/
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include <config.h>
  24 #endif
  25
  26 #include <stdio.h>
  27 #include <string.h>
  28
  29 #include <pulse/i18n.h>
  30 #include <pulsecore/core-util.h>
  31 #include <pulsecore/macro.h>
  32
  33 #include "volume.h"
  34
  35 int pa_cvolume_equal(const pa_cvolume *a, const pa_cvolume *b) {
  36     int i;
  37     pa_assert(a);
  38     pa_assert(b);
  39
  40     if (a->channels != b->channels)
  41         return 0;
  42
  43     for (i = 0; i < a->channels; i++)
  44         if (a->values[i] != b->values[i])
  45             return 0;
  46
  47     return 1;
  48 }
  49
  50 pa_cvolume* pa_cvolume_init(pa_cvolume *a) {
  51     unsigned c;
  52
  53     pa_assert(a);
  54
  55     a->channels = 0;
  56
  57     for (c = 0; c < PA_CHANNELS_MAX; c++)
  58         a->values[c] = (pa_volume_t) -1;
  59
  60     return a;
  61 }
  62
  63 pa_cvolume* pa_cvolume_set(pa_cvolume *a, unsigned channels, pa_volume_t v) {
  64     int i;
  65
  66     pa_assert(a);
  67     pa_assert(channels > 0);
  68     pa_assert(channels <= PA_CHANNELS_MAX);
  69
  70     a->channels = (uint8_t) channels;
  71
  72     for (i = 0; i < a->channels; i++)
  73         a->values[i] = v;
  74
  75     return a;
  76 }
  77
  78 pa_volume_t pa_cvolume_avg(const pa_cvolume *a) {
  79     uint64_t sum = 0;
  80     int i;
  81     pa_assert(a);
  82
  83     for (i = 0; i < a->channels; i++)
  84         sum += a->values[i];
  85
  86     sum /= a->channels;
  87
  88     return (pa_volume_t) sum;
  89 }
  90
  91 pa_volume_t pa_cvolume_max(const pa_cvolume *a) {
  92     pa_volume_t m = 0;
  93     int i;
  94     pa_assert(a);
  95
  96     for (i = 0; i < a->channels; i++)
  97         if (a->values[i] > m)
  98             m = a->values[i];
  99
 100     return m;
 101 }
 102
 103 pa_volume_t pa_sw_volume_multiply(pa_volume_t a, pa_volume_t b) {
 104     return pa_sw_volume_from_linear(pa_sw_volume_to_linear(a) * pa_sw_volume_to_linear(b));
 105 }
 106
 107 pa_volume_t pa_sw_volume_divide(pa_volume_t a, pa_volume_t b) {
 108     double v = pa_sw_volume_to_linear(b);
 109
 110     if (v <= 0)
 111         return 0;
 112
 113     return pa_sw_volume_from_linear(pa_sw_volume_to_linear(a) / v);
 114 }
 115
 116 #define USER_DECIBEL_RANGE 60
 117
 118 pa_volume_t pa_sw_volume_from_dB(double dB) {
 119     if (isinf(dB) < 0 || dB <= -USER_DECIBEL_RANGE)
 120         return PA_VOLUME_MUTED;
 121
 122     return (pa_volume_t) lrint((dB/USER_DECIBEL_RANGE+1)*PA_VOLUME_NORM);
 123 }
 124
 125 double pa_sw_volume_to_dB(pa_volume_t v) {
 126     if (v == PA_VOLUME_MUTED)
 127         return PA_DECIBEL_MININFTY;
 128
 129     return ((double) v/PA_VOLUME_NORM-1)*USER_DECIBEL_RANGE;
 130 }
 131
 132 pa_volume_t pa_sw_volume_from_linear(double v) {
 133
 134     if (v <= 0)
 135         return PA_VOLUME_MUTED;
 136
 137     if (v > .999 && v < 1.001)
 138         return PA_VOLUME_NORM;
 139
 140     return pa_sw_volume_from_dB(20*log10(v));
 141 }
 142
 143 double pa_sw_volume_to_linear(pa_volume_t v) {
 144
 145     if (v == PA_VOLUME_MUTED)
 146         return 0;
 147
 148     return pow(10.0, pa_sw_volume_to_dB(v)/20.0);
 149 }
 150
 151 char *pa_cvolume_snprint(char *s, size_t l, const pa_cvolume *c) {
 152     unsigned channel;
 153     pa_bool_t first = TRUE;
 154     char *e;
 155
 156     pa_assert(s);
 157     pa_assert(l > 0);
 158     pa_assert(c);
 159
 160     pa_init_i18n();
 161
 162     if (!pa_cvolume_valid(c)) {
 163         pa_snprintf(s, l, _("(invalid)"));
 164         return s;
 165     }
 166
 167     *(e = s) = 0;
 168
 169     for (channel = 0; channel < c->channels && l > 1; channel++) {
 170         l -= pa_snprintf(e, l, "%s%u: %3u%%",
 171                       first ? "" : " ",
 172                       channel,
 173                       (c->values[channel]*100)/PA_VOLUME_NORM);
 174
 175         e = strchr(e, 0);
 176         first = FALSE;
 177     }
 178
 179     return s;
 180 }
 181
 182 char *pa_volume_snprint(char *s, size_t l, pa_volume_t v) {
 183     pa_assert(s);
 184     pa_assert(l > 0);
 185
 186     pa_init_i18n();
 187
 188     if (v == (pa_volume_t) -1) {
 189         pa_snprintf(s, l, _("(invalid)"));
 190         return s;
 191     }
 192
 193     pa_snprintf(s, l, "%3u%%", (v*100)/PA_VOLUME_NORM);
 194     return s;
 195 }
 196
 197 char *pa_sw_cvolume_snprint_dB(char *s, size_t l, const pa_cvolume *c) {
 198     unsigned channel;
 199     pa_bool_t first = TRUE;
 200     char *e;
 201
 202     pa_assert(s);
 203     pa_assert(l > 0);
 204     pa_assert(c);
 205
 206     pa_init_i18n();
 207
 208     if (!pa_cvolume_valid(c)) {
 209         pa_snprintf(s, l, _("(invalid)"));
 210         return s;
 211     }
 212
 213     *(e = s) = 0;
 214
 215     for (channel = 0; channel < c->channels && l > 1; channel++) {
 216         double f = pa_sw_volume_to_dB(c->values[channel]);
 217
 218         l -= pa_snprintf(e, l, "%s%u: %0.2f dB",
 219                          first ? "" : " ",
 220                          channel,
 221                          isinf(f) < 0 || f <= -USER_DECIBEL_RANGE ? -INFINITY : f);
 222
 223         e = strchr(e, 0);
 224         first = FALSE;
 225     }
 226
 227     return s;
 228 }
 229
 230 char *pa_sw_volume_snprint_dB(char *s, size_t l, pa_volume_t v) {
 231     double f;
 232
 233     pa_assert(s);
 234     pa_assert(l > 0);
 235
 236     pa_init_i18n();
 237
 238     if (v == (pa_volume_t) -1) {
 239         pa_snprintf(s, l, _("(invalid)"));
 240         return s;
 241     }
 242
 243     f = pa_sw_volume_to_dB(v);
 244     pa_snprintf(s, l, "%0.2f dB",
 245                 isinf(f) < 0 || f <= -USER_DECIBEL_RANGE ?  -INFINITY : f);
 246
 247     return s;
 248 }
 249
 250 /** Return non-zero if the volume of all channels is equal to the specified value */
 251 int pa_cvolume_channels_equal_to(const pa_cvolume *a, pa_volume_t v) {
 252     unsigned c;
 253     pa_assert(a);
 254
 255     for (c = 0; c < a->channels; c++)
 256         if (a->values[c] != v)
 257             return 0;
 258
 259     return 1;
 260 }
 261
 262 pa_cvolume *pa_sw_cvolume_multiply(pa_cvolume *dest, const pa_cvolume *a, const pa_cvolume *b) {
 263     unsigned i;
 264
 265     pa_assert(dest);
 266     pa_assert(a);
 267     pa_assert(b);
 268
 269     for (i = 0; i < a->channels && i < b->channels && i < PA_CHANNELS_MAX; i++)
 270         dest->values[i] = pa_sw_volume_multiply(a->values[i], b->values[i]);
 271
 272     dest->channels = (uint8_t) i;
 273
 274     return dest;
 275 }
 276
 277 pa_cvolume *pa_sw_cvolume_divide(pa_cvolume *dest, const pa_cvolume *a, const pa_cvolume *b) {
 278     unsigned i;
 279
 280     pa_assert(dest);
 281     pa_assert(a);
 282     pa_assert(b);
 283
 284     for (i = 0; i < a->channels && i < b->channels && i < PA_CHANNELS_MAX; i++)
 285         dest->values[i] = pa_sw_volume_divide(a->values[i], b->values[i]);
 286
 287     dest->channels = (uint8_t) i;
 288
 289     return dest;
 290 }
 291
 292 int pa_cvolume_valid(const pa_cvolume *v) {
 293     unsigned c;
 294
 295     pa_assert(v);
 296
 297     if (v->channels <= 0 || v->channels > PA_CHANNELS_MAX)
 298         return 0;
 299
 300     for (c = 0; c < v->channels; c++)
 301         if (v->values[c] == (pa_volume_t) -1)
 302             return 0;
 303
 304     return 1;
 305 }
 306
 307 static pa_bool_t on_left(pa_channel_position_t p) {
 308
 309     return
 310         p == PA_CHANNEL_POSITION_FRONT_LEFT ||
 311         p == PA_CHANNEL_POSITION_REAR_LEFT ||
 312         p == PA_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER ||
 313         p == PA_CHANNEL_POSITION_SIDE_LEFT ||
 314         p == PA_CHANNEL_POSITION_TOP_FRONT_LEFT ||
 315         p == PA_CHANNEL_POSITION_TOP_REAR_LEFT;
 316 }
 317
 318 static pa_bool_t on_right(pa_channel_position_t p) {
 319
 320     return
 321         p == PA_CHANNEL_POSITION_FRONT_RIGHT ||
 322         p == PA_CHANNEL_POSITION_REAR_RIGHT ||
 323         p == PA_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER ||
 324         p == PA_CHANNEL_POSITION_SIDE_RIGHT ||
 325         p == PA_CHANNEL_POSITION_TOP_FRONT_RIGHT ||
 326         p == PA_CHANNEL_POSITION_TOP_REAR_RIGHT;
 327 }
 328
 329 static pa_bool_t on_center(pa_channel_position_t p) {
 330
 331     return
 332         p == PA_CHANNEL_POSITION_FRONT_CENTER ||
 333         p == PA_CHANNEL_POSITION_REAR_CENTER ||
 334         p == PA_CHANNEL_POSITION_TOP_CENTER ||
 335         p == PA_CHANNEL_POSITION_TOP_FRONT_CENTER ||
 336         p == PA_CHANNEL_POSITION_TOP_REAR_CENTER;
 337 }
 338
 339 static pa_bool_t on_lfe(pa_channel_position_t p) {
 340     return
 341         p == PA_CHANNEL_POSITION_LFE;
 342 }
 343
 344 pa_cvolume *pa_cvolume_remap(pa_cvolume *v, pa_channel_map *from, pa_channel_map *to) {
 345     int a, b;
 346     pa_cvolume result;
 347
 348     pa_assert(v);
 349     pa_assert(from);
 350     pa_assert(to);
 351     pa_assert(v->channels == from->channels);
 352
 353     if (pa_channel_map_equal(from, to))
 354         return v;
 355
 356     result.channels = to->channels;
 357
 358     for (b = 0; b < to->channels; b++) {
 359         pa_volume_t k = 0;
 360         int n = 0;
 361
 362         for (a = 0; a < from->channels; a++)
 363             if (from->map[a] == to->map[b]) {
 364                 k += v->values[a];
 365                 n ++;
 366             }
 367
 368         if (n <= 0) {
 369             for (a = 0; a < from->channels; a++)
 370                 if ((on_left(from->map[a]) && on_left(to->map[b])) ||
 371                     (on_right(from->map[a]) && on_right(to->map[b])) ||
 372                     (on_center(from->map[a]) && on_center(to->map[b])) ||
 373                     (on_lfe(from->map[a]) && on_lfe(to->map[b]))) {
 374
 375                     k += v->values[a];
 376                     n ++;
 377                 }
 378         }
 379
 380         if (n <= 0)
 381             k = pa_cvolume_avg(v);
 382         else
 383             k /= n;
 384
 385         result.values[b] = k;
 386     }
 387
 388     *v = result;
 389     return v;
 390 }
 391
 392 int pa_cvolume_compatible(const pa_cvolume *v, const pa_sample_spec *ss) {
 393
 394     pa_assert(v);
 395     pa_assert(ss);
 396
 397     if (!pa_cvolume_valid(v))
 398         return 0;
 399
 400     if (!pa_sample_spec_valid(ss))
 401         return 0;
 402
 403     return v->channels == ss->channels;
 404 }
 405
 406 static void get_avg_lr(const pa_channel_map *map, const pa_cvolume *v, pa_volume_t *l, pa_volume_t *r) {
 407     int c;
 408     pa_volume_t left = 0, right = 0;
 409     unsigned n_left = 0, n_right = 0;
 410
 411     pa_assert(v);
 412     pa_assert(map);
 413     pa_assert(map->channels == v->channels);
 414     pa_assert(l);
 415     pa_assert(r);
 416
 417     for (c = 0; c < map->channels; c++) {
 418         if (on_left(map->map[c])) {
 419             left += v->values[c];
 420             n_left++;
 421         } else if (on_right(map->map[c])) {
 422             right += v->values[c];
 423             n_right++;
 424         }
 425     }
 426
 427     *l = left / n_left;
 428     *r = right / n_right;
 429 }
 430
 431 float pa_cvolume_get_balance(const pa_channel_map *map, const pa_cvolume *v) {
 432     pa_volume_t left, right;
 433
 434     pa_assert(v);
 435     pa_assert(map);
 436     pa_assert(map->channels == v->channels);
 437
 438     get_avg_lr(map, v, &left, &right);
 439
 440     if (left == right)
 441         return 0.0f;
 442
 443     /*   1.0,  0.0  =>  -1.0
 444          0.0,  1.0  =>   1.0
 445          0.0,  0.0  =>   0.0
 446          0.5,  0.5  =>   0.0
 447          1.0,  0.5  =>  -0.5
 448          1.0,  0.25 => -0.75
 449          0.75, 0.25 => -0.66
 450          0.5,  0.25 => -0.5   */
 451
 452     if (left > right)
 453         return -1.0f + ((float) right / (float) left);
 454     else
 455         return 1.0f - ((float) left / (float) right);
 456 }
 457
 458 pa_cvolume* pa_cvolume_set_balance(const pa_channel_map *map, pa_cvolume *v, float new_balance) {
 459     pa_volume_t left, nleft, right, nright, m;
 460     unsigned c;
 461
 462     pa_assert(map->channels == v->channels);
 463     pa_assert(map);
 464     pa_assert(v);
 465     pa_assert(new_balance >= -1.0f);
 466     pa_assert(new_balance <= 1.0f);
 467
 468     get_avg_lr(map, v, &left, &right);
 469
 470     m = PA_MAX(left, right);
 471
 472     if (new_balance <= 0) {
 473         nright  = (new_balance + 1.0f) * m;
 474         nleft = m;
 475     } else  {
 476         nleft = (1.0f - new_balance) * m;
 477         nright = m;
 478     }
 479
 480     for (c = 0; c < map->channels; c++) {
 481         if (on_left(map->map[c])) {
 482             if (left == 0)
 483                 v->values[c] = 0;
 484             else
 485                 v->values[c] = (pa_volume_t) (((uint64_t) v->values[c] * (uint64_t) nleft) / (uint64_t) left);
 486         } else if (on_right(map->map[c])) {
 487             if (right == 0)
 488                 v->values[c] = 0;
 489             else
 490                 v->values[c] = (pa_volume_t) (((uint64_t) v->values[c] * (uint64_t) nright) / (uint64_t) right);
 491         }
 492     }
 493
 494     return v;
 495 }