PulseAudio  6.0
format.h
Go to the documentation of this file.
1 #ifndef fooformathfoo
2 #define fooformathfoo
3 
4 /***
5  This file is part of PulseAudio.
6 
7  Copyright 2011 Intel Corporation
8  Copyright 2011 Collabora Multimedia
9  Copyright 2011 Arun Raghavan <arun.raghavan@collabora.co.uk>
10 
11  PulseAudio is free software; you can redistribute it and/or modify
12  it under the terms of the GNU Lesser General Public License as published
13  by the Free Software Foundation; either version 2.1 of the License,
14  or (at your option) any later version.
15 
16  PulseAudio is distributed in the hope that it will be useful, but
17  WITHOUT ANY WARRANTY; without even the implied warranty of
18  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  General Public License for more details.
20 
21  You should have received a copy of the GNU Lesser General Public License
22  along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
23 ***/
24 
25 #include <pulse/cdecl.h>
26 #include <pulse/gccmacro.h>
27 #include <pulse/proplist.h>
28 #include <pulse/sample.h>
29 #include <pulse/channelmap.h>
30 
34 PA_C_DECL_BEGIN
35 
37 typedef enum pa_encoding {
65 
67 #define PA_ENCODING_ANY PA_ENCODING_ANY
68 #define PA_ENCODING_PCM PA_ENCODING_PCM
69 #define PA_ENCODING_AC3_IEC61937 PA_ENCODING_AC3_IEC61937
70 #define PA_ENCODING_EAC3_IEC61937 PA_ENCODING_EAC3_IEC61937
71 #define PA_ENCODING_MPEG_IEC61937 PA_ENCODING_MPEG_IEC61937
72 #define PA_ENCODING_DTS_IEC61937 PA_ENCODING_DTS_IEC61937
73 #define PA_ENCODING_MPEG2_AAC_IEC61937 PA_ENCODING_MPEG2_AAC_IEC61937
74 #define PA_ENCODING_MAX PA_ENCODING_MAX
75 #define PA_ENCODING_INVALID PA_ENCODING_INVALID
76 
80 
82 pa_encoding_t pa_encoding_from_string(const char *encoding);
83 
85 typedef struct pa_format_info {
92 
95 
98 
101 
104 
107 
115 int pa_format_info_is_compatible(const pa_format_info *first, const pa_format_info *second);
116 
122 #define PA_FORMAT_INFO_SNPRINT_MAX 256
123 
125 char *pa_format_info_snprint(char *s, size_t l, const pa_format_info *f);
126 
130 
144 
151 
153 typedef enum pa_prop_type_t {
172 
174 #define PA_PROP_TYPE_INT PA_PROP_TYPE_INT
175 #define PA_PROP_TYPE_INT_RANGE PA_PROP_TYPE_INT_RANGE
176 #define PA_PROP_TYPE_INT_ARRAY PA_PROP_TYPE_INT_ARRAY
177 #define PA_PROP_TYPE_STRING PA_PROP_TYPE_STRING
178 #define PA_PROP_TYPE_STRING_ARRAY PA_PROP_TYPE_STRING_ARRAY
179 #define PA_PROP_TYPE_INVALID PA_PROP_TYPE_INVALID
180 
184 
186 int pa_format_info_get_prop_int(const pa_format_info *f, const char *key, int *v);
189 int pa_format_info_get_prop_int_range(const pa_format_info *f, const char *key, int *min, int *max);
193 int pa_format_info_get_prop_int_array(const pa_format_info *f, const char *key, int **values, int *n_values);
196 int pa_format_info_get_prop_string(const pa_format_info *f, const char *key, char **v);
200 int pa_format_info_get_prop_string_array(const pa_format_info *f, const char *key, char ***values, int *n_values);
201 
203 void pa_format_info_free_string_array(char **values, int n_values);
204 
206 void pa_format_info_set_prop_int(pa_format_info *f, const char *key, int value);
208 void pa_format_info_set_prop_int_array(pa_format_info *f, const char *key, const int *values, int n_values);
210 void pa_format_info_set_prop_int_range(pa_format_info *f, const char *key, int min, int max);
212 void pa_format_info_set_prop_string(pa_format_info *f, const char *key, const char *value);
214 void pa_format_info_set_prop_string_array(pa_format_info *f, const char *key, const char **values, int n_values);
215 
226 
236 void pa_format_info_set_rate(pa_format_info *f, int rate);
237 
247 void pa_format_info_set_channels(pa_format_info *f, int channels);
248 
259 
260 PA_C_DECL_END
261 
262 #endif
pa_format_info * pa_format_info_from_string(const char *str)
Parse a human-readable string of the form generated by pa_format_info_snprint() into a pa_format_info...
pa_format_info * pa_format_info_copy(const pa_format_info *src)
Returns a new pa_format_info struct and representing the same format as src.
A sample format and attribute specification.
Definition: sample.h:248
pa_format_info * pa_format_info_from_sample_spec(const pa_sample_spec *ss, const pa_channel_map *map)
Utility function to take a pa_sample_spec and generate the corresponding pa_format_info.
MPEG-2 AAC data encapsulated in IEC 61937 header/padding.
Definition: format.h:56
void pa_format_info_set_channels(pa_format_info *f, int channels)
Convenience method to set the number of channels as a property on the given format.
EAC3 data encapsulated in IEC 61937 header/padding.
Definition: format.h:47
void pa_format_info_free(pa_format_info *f)
Frees a pa_format_info structure.
void pa_format_info_set_prop_string(pa_format_info *f, const char *key, const char *value)
Sets a string property on the given format info.
pa_encoding_t encoding
The encoding used for the format.
Definition: format.h:86
Integer range property.
Definition: format.h:157
pa_encoding
Represents the type of encoding used in a stream or accepted by a sink.
Definition: format.h:37
pa_prop_type_t pa_format_info_get_prop_type(const pa_format_info *f, const char *key)
Gets the type of property key in a given pa_format_info.
int pa_format_info_get_prop_string(const pa_format_info *f, const char *key, char **v)
Gets a string property from the given format info.
#define PA_GCC_CONST
This function's return value depends only the arguments list (stricter version of PA_GCC_PURE) ...
Definition: gccmacro.h:82
enum pa_encoding pa_encoding_t
Represents the type of encoding used in a stream or accepted by a sink.
void pa_format_info_set_prop_int_array(pa_format_info *f, const char *key, const int *values, int n_values)
Sets a property with a list of integer values on the given format info.
Valid encoding types must be less than this value.
Definition: format.h:59
enum pa_sample_format pa_sample_format_t
Sample format.
pa_format_info * pa_format_info_new(void)
Allocates a new pa_format_info structure.
Represents an invalid type.
Definition: format.h:169
int pa_format_info_get_prop_int_array(const pa_format_info *f, const char *key, int **values, int *n_values)
Gets an integer array property from the given format info.
Constants and routines for channel mapping handling.
pa_prop_type_t
Represents the type of value type of a property on a pa_format_info.
Definition: format.h:153
void pa_format_info_set_channel_map(pa_format_info *f, const pa_channel_map *map)
Convenience method to set the channel map as a property on the given format.
int pa_format_info_get_prop_int(const pa_format_info *f, const char *key, int *v)
Gets an integer property from the given format info.
pa_proplist * plist
Additional encoding-specific properties such as sample rate, bitrate, etc.
Definition: format.h:89
String property.
Definition: format.h:163
GCC attribute macros.
Integer array property.
Definition: format.h:160
Represents an invalid encoding.
Definition: format.h:62
int pa_format_info_valid(const pa_format_info *f)
Returns non-zero when the format info structure is valid.
DTS data encapsulated in IEC 61937 header/padding.
Definition: format.h:53
int pa_format_info_get_prop_int_range(const pa_format_info *f, const char *key, int *min, int *max)
Gets an integer range property from the given format info.
void pa_format_info_free_string_array(char **values, int n_values)
Frees a string array returned by pa_format_info_get_prop_string_array.
MPEG-1 or MPEG-2 (Part 3, not AAC) data encapsulated in IEC 61937 header/padding. ...
Definition: format.h:50
int pa_format_info_get_prop_string_array(const pa_format_info *f, const char *key, char ***values, int *n_values)
Gets a string array property from the given format info.
Integer property.
Definition: format.h:154
void pa_format_info_set_prop_string_array(pa_format_info *f, const char *key, const char **values, int n_values)
Sets a property with a list of string values on the given format info.
void pa_format_info_set_prop_int_range(pa_format_info *f, const char *key, int min, int max)
Sets a property which can have any value in a given integer range on the given format info...
Constants and routines for sample type handling.
char * pa_format_info_snprint(char *s, size_t l, const pa_format_info *f)
Return a human-readable string representing the given format.
int pa_format_info_is_compatible(const pa_format_info *first, const pa_format_info *second)
Returns non-zero if the format represented by first is a subset of the format represented by second...
int pa_format_info_to_sample_spec(const pa_format_info *f, pa_sample_spec *ss, pa_channel_map *map)
Utility function to generate a pa_sample_spec and pa_channel_map corresponding to a given pa_format_i...
void pa_format_info_set_prop_int(pa_format_info *f, const char *key, int value)
Sets an integer property on the given format info.
int pa_format_info_is_pcm(const pa_format_info *f)
Returns non-zero when the format info structure represents a PCM (i.e. uncompressed data) format...
String array property.
Definition: format.h:166
Any PCM format.
Definition: format.h:41
const char * pa_encoding_to_string(pa_encoding_t e) PA_GCC_CONST
Returns a printable string representing the given encoding type.
Any encoding format, PCM or compressed.
Definition: format.h:38
Represents the format of data provided in a stream or processed by a sink.
Definition: format.h:85
A channel map which can be used to attach labels to specific channels of a stream.
Definition: channelmap.h:262
struct pa_proplist pa_proplist
A property list object.
Definition: proplist.h:272
AC3 data encapsulated in IEC 61937 header/padding.
Definition: format.h:44
void pa_format_info_set_rate(pa_format_info *f, int rate)
Convenience method to set the sampling rate as a property on the given format.
Property list constants and functions.
struct pa_format_info pa_format_info
Represents the format of data provided in a stream or processed by a sink.
pa_encoding_t pa_encoding_from_string(const char *encoding)
Converts a string of the form returned by pa_encoding_to_string() back to a pa_encoding_t.
void pa_format_info_set_sample_format(pa_format_info *f, pa_sample_format_t sf)
Convenience method to set the sample format as a property on the given format.