format.h

Go to the documentation of this file.

#ifndef fooformathfoo
#define fooformathfoo

/***
  This file is part of PulseAudio.

  Copyright 2011 Intel Corporation
  Copyright 2011 Collabora Multimedia
  Copyright 2011 Arun Raghavan <arun.raghavan@collabora.co.uk>

  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 <pulse/cdecl.h>
#include <pulse/gccmacro.h>
#include <pulse/proplist.h>
#include <pulse/sample.h>
#include <pulse/channelmap.h>

PA_C_DECL_BEGIN

typedef enum pa_encoding {
    PA_ENCODING_ANY,
    PA_ENCODING_PCM,
    PA_ENCODING_AC3_IEC61937,
    PA_ENCODING_EAC3_IEC61937,
    PA_ENCODING_MPEG_IEC61937,
    PA_ENCODING_DTS_IEC61937,
    PA_ENCODING_MPEG2_AAC_IEC61937,
    PA_ENCODING_MAX,
    PA_ENCODING_INVALID = -1,
} pa_encoding_t;

#define PA_ENCODING_ANY PA_ENCODING_ANY
#define PA_ENCODING_PCM PA_ENCODING_PCM
#define PA_ENCODING_AC3_IEC61937 PA_ENCODING_AC3_IEC61937
#define PA_ENCODING_EAC3_IEC61937 PA_ENCODING_EAC3_IEC61937
#define PA_ENCODING_MPEG_IEC61937 PA_ENCODING_MPEG_IEC61937
#define PA_ENCODING_DTS_IEC61937 PA_ENCODING_DTS_IEC61937
#define PA_ENCODING_MPEG2_AAC_IEC61937 PA_ENCODING_MPEG2_AAC_IEC61937
#define PA_ENCODING_MAX PA_ENCODING_MAX
#define PA_ENCODING_INVALID PA_ENCODING_INVALID

const char *pa_encoding_to_string(pa_encoding_t e) PA_GCC_CONST;

pa_encoding_t pa_encoding_from_string(const char *encoding);

typedef struct pa_format_info {
    pa_encoding_t encoding;
    pa_proplist *plist;
} pa_format_info;

pa_format_info* pa_format_info_new(void);

pa_format_info* pa_format_info_copy(const pa_format_info *src);

void pa_format_info_free(pa_format_info *f);

int pa_format_info_valid(const pa_format_info *f);

int pa_format_info_is_pcm(const pa_format_info *f);

int pa_format_info_is_compatible(const pa_format_info *first, const pa_format_info *second);

#define PA_FORMAT_INFO_SNPRINT_MAX 256

char *pa_format_info_snprint(char *s, size_t l, const pa_format_info *f);

pa_format_info* pa_format_info_from_string(const char *str);

pa_format_info* pa_format_info_from_sample_spec(const pa_sample_spec *ss, const pa_channel_map *map);

int pa_format_info_to_sample_spec(const pa_format_info *f, pa_sample_spec *ss, pa_channel_map *map);

typedef enum pa_prop_type_t {
    PA_PROP_TYPE_INT,
    PA_PROP_TYPE_INT_RANGE,
    PA_PROP_TYPE_INT_ARRAY,
    PA_PROP_TYPE_STRING,
    PA_PROP_TYPE_STRING_ARRAY,
    PA_PROP_TYPE_INVALID = -1,
} pa_prop_type_t;

#define PA_PROP_TYPE_INT PA_PROP_TYPE_INT
#define PA_PROP_TYPE_INT_RANGE PA_PROP_TYPE_INT_RANGE
#define PA_PROP_TYPE_INT_ARRAY PA_PROP_TYPE_INT_ARRAY
#define PA_PROP_TYPE_STRING PA_PROP_TYPE_STRING
#define PA_PROP_TYPE_STRING_ARRAY PA_PROP_TYPE_STRING_ARRAY
#define PA_PROP_TYPE_INVALID PA_PROP_TYPE_INVALID

pa_prop_type_t pa_format_info_get_prop_type(const pa_format_info *f, const char *key);

int pa_format_info_get_prop_int(const pa_format_info *f, const char *key, int *v);
int pa_format_info_get_prop_int_range(const pa_format_info *f, const char *key, int *min, int *max);
int pa_format_info_get_prop_int_array(const pa_format_info *f, const char *key, int **values, int *n_values);
int pa_format_info_get_prop_string(const pa_format_info *f, const char *key, char **v);
int pa_format_info_get_prop_string_array(const pa_format_info *f, const char *key, char ***values, int *n_values);

void pa_format_info_free_string_array(char **values, int n_values);

void pa_format_info_set_prop_int(pa_format_info *f, const char *key, int value);
void pa_format_info_set_prop_int_array(pa_format_info *f, const char *key, const int *values, int n_values);
void pa_format_info_set_prop_int_range(pa_format_info *f, const char *key, int min, int max);
void pa_format_info_set_prop_string(pa_format_info *f, const char *key, const char *value);
void pa_format_info_set_prop_string_array(pa_format_info *f, const char *key, const char **values, int n_values);

void pa_format_info_set_sample_format(pa_format_info *f, pa_sample_format_t sf);

void pa_format_info_set_rate(pa_format_info *f, int rate);

void pa_format_info_set_channels(pa_format_info *f, int channels);

void pa_format_info_set_channel_map(pa_format_info *f, const pa_channel_map *map);

PA_C_DECL_END

#endif