volume.h

Go to the documentation of this file.

#ifndef foovolumehfoo
#define foovolumehfoo

/***
  This file is part of PulseAudio.

  Copyright 2004-2006 Lennart Poettering
  Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB

  PulseAudio is free software; you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License as published
  by the Free Software Foundation; either version 2.1 of the License,
  or (at your option) any later version.

  PulseAudio is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
***/

#include <inttypes.h>
#include <limits.h>

#include <pulse/cdecl.h>
#include <pulse/gccmacro.h>
#include <pulse/sample.h>
#include <pulse/channelmap.h>
#include <pulse/version.h>

PA_C_DECL_BEGIN

typedef uint32_t pa_volume_t;

#define PA_VOLUME_NORM ((pa_volume_t) 0x10000U)

#define PA_VOLUME_MUTED ((pa_volume_t) 0U)

#define PA_VOLUME_MAX ((pa_volume_t) UINT32_MAX/2)

#define PA_VOLUME_UI_MAX (pa_sw_volume_from_dB(+11.0))

#define PA_VOLUME_INVALID ((pa_volume_t) UINT32_MAX)

#define PA_VOLUME_IS_VALID(v) ((v) <= PA_VOLUME_MAX)

#define PA_CLAMP_VOLUME(v) (PA_CLAMP_UNLIKELY((v), PA_VOLUME_MUTED, PA_VOLUME_MAX))

typedef struct pa_cvolume {
    uint8_t channels;                     
    pa_volume_t values[PA_CHANNELS_MAX];  
} pa_cvolume;

int pa_cvolume_equal(const pa_cvolume *a, const pa_cvolume *b) PA_GCC_PURE;

pa_cvolume* pa_cvolume_init(pa_cvolume *a);

#define pa_cvolume_reset(a, n) pa_cvolume_set((a), (n), PA_VOLUME_NORM)

#define pa_cvolume_mute(a, n) pa_cvolume_set((a), (n), PA_VOLUME_MUTED)

pa_cvolume* pa_cvolume_set(pa_cvolume *a, unsigned channels, pa_volume_t v);

#define PA_CVOLUME_SNPRINT_MAX 320

char *pa_cvolume_snprint(char *s, size_t l, const pa_cvolume *c);

#define PA_SW_CVOLUME_SNPRINT_DB_MAX 448

char *pa_sw_cvolume_snprint_dB(char *s, size_t l, const pa_cvolume *c);

#define PA_CVOLUME_SNPRINT_VERBOSE_MAX 1984

char *pa_cvolume_snprint_verbose(char *s, size_t l, const pa_cvolume *c, const pa_channel_map *map, int print_dB);

#define PA_VOLUME_SNPRINT_MAX 10

char *pa_volume_snprint(char *s, size_t l, pa_volume_t v);

#define PA_SW_VOLUME_SNPRINT_DB_MAX 11

char *pa_sw_volume_snprint_dB(char *s, size_t l, pa_volume_t v);

#define PA_VOLUME_SNPRINT_VERBOSE_MAX 35

char *pa_volume_snprint_verbose(char *s, size_t l, pa_volume_t v, int print_dB);

pa_volume_t pa_cvolume_avg(const pa_cvolume *a) PA_GCC_PURE;

pa_volume_t pa_cvolume_avg_mask(const pa_cvolume *a, const pa_channel_map *cm, pa_channel_position_mask_t mask) PA_GCC_PURE;

pa_volume_t pa_cvolume_max(const pa_cvolume *a) PA_GCC_PURE;

pa_volume_t pa_cvolume_max_mask(const pa_cvolume *a, const pa_channel_map *cm, pa_channel_position_mask_t mask) PA_GCC_PURE;

pa_volume_t pa_cvolume_min(const pa_cvolume *a) PA_GCC_PURE;

pa_volume_t pa_cvolume_min_mask(const pa_cvolume *a, const pa_channel_map *cm, pa_channel_position_mask_t mask) PA_GCC_PURE;

int pa_cvolume_valid(const pa_cvolume *v) PA_GCC_PURE;

int pa_cvolume_channels_equal_to(const pa_cvolume *a, pa_volume_t v) PA_GCC_PURE;

#define pa_cvolume_is_muted(a) pa_cvolume_channels_equal_to((a), PA_VOLUME_MUTED)

#define pa_cvolume_is_norm(a) pa_cvolume_channels_equal_to((a), PA_VOLUME_NORM)

pa_volume_t pa_sw_volume_multiply(pa_volume_t a, pa_volume_t b) PA_GCC_CONST;

pa_cvolume *pa_sw_cvolume_multiply(pa_cvolume *dest, const pa_cvolume *a, const pa_cvolume *b);

pa_cvolume *pa_sw_cvolume_multiply_scalar(pa_cvolume *dest, const pa_cvolume *a, pa_volume_t b);

pa_volume_t pa_sw_volume_divide(pa_volume_t a, pa_volume_t b) PA_GCC_CONST;

pa_cvolume *pa_sw_cvolume_divide(pa_cvolume *dest, const pa_cvolume *a, const pa_cvolume *b);

pa_cvolume *pa_sw_cvolume_divide_scalar(pa_cvolume *dest, const pa_cvolume *a, pa_volume_t b);

pa_volume_t pa_sw_volume_from_dB(double f) PA_GCC_CONST;

double pa_sw_volume_to_dB(pa_volume_t v) PA_GCC_CONST;

pa_volume_t pa_sw_volume_from_linear(double v) PA_GCC_CONST;

double pa_sw_volume_to_linear(pa_volume_t v) PA_GCC_CONST;

#ifdef INFINITY
#define PA_DECIBEL_MININFTY ((double) -INFINITY)
#else

#define PA_DECIBEL_MININFTY ((double) -200.0)
#endif

pa_cvolume *pa_cvolume_remap(pa_cvolume *v, const pa_channel_map *from, const pa_channel_map *to);

int pa_cvolume_compatible(const pa_cvolume *v, const pa_sample_spec *ss) PA_GCC_PURE;

int pa_cvolume_compatible_with_channel_map(const pa_cvolume *v, const pa_channel_map *cm) PA_GCC_PURE;

float pa_cvolume_get_balance(const pa_cvolume *v, const pa_channel_map *map) PA_GCC_PURE;

pa_cvolume* pa_cvolume_set_balance(pa_cvolume *v, const pa_channel_map *map, float new_balance);

float pa_cvolume_get_fade(const pa_cvolume *v, const pa_channel_map *map) PA_GCC_PURE;

pa_cvolume* pa_cvolume_set_fade(pa_cvolume *v, const pa_channel_map *map, float new_fade);

float pa_cvolume_get_lfe_balance(const pa_cvolume *v, const pa_channel_map *map) PA_GCC_PURE;

pa_cvolume* pa_cvolume_set_lfe_balance(pa_cvolume *v, const pa_channel_map *map, float new_balance);

pa_cvolume* pa_cvolume_scale(pa_cvolume *v, pa_volume_t max);

pa_cvolume* pa_cvolume_scale_mask(pa_cvolume *v, pa_volume_t max, pa_channel_map *cm, pa_channel_position_mask_t mask);

pa_cvolume* pa_cvolume_set_position(pa_cvolume *cv, const pa_channel_map *map, pa_channel_position_t t, pa_volume_t v);

pa_volume_t pa_cvolume_get_position(pa_cvolume *cv, const pa_channel_map *map, pa_channel_position_t t) PA_GCC_PURE;

pa_cvolume* pa_cvolume_merge(pa_cvolume *dest, const pa_cvolume *a, const pa_cvolume *b);

pa_cvolume* pa_cvolume_inc_clamp(pa_cvolume *v, pa_volume_t inc, pa_volume_t limit);

pa_cvolume* pa_cvolume_inc(pa_cvolume *v, pa_volume_t inc);

pa_cvolume* pa_cvolume_dec(pa_cvolume *v, pa_volume_t dec);

PA_C_DECL_END

#endif