channelmap.h

Go to the documentation of this file.
00001 #ifndef foochannelmaphfoo
00002 #define foochannelmaphfoo
00003 
00004 /***
00005   This file is part of PulseAudio.
00006 
00007   Copyright 2005-2006 Lennart Poettering
00008   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
00009 
00010   PulseAudio is free software; you can redistribute it and/or modify
00011   it under the terms of the GNU Lesser General Public License as published
00012   by the Free Software Foundation; either version 2 of the License,
00013   or (at your option) any later version.
00014 
00015   PulseAudio is distributed in the hope that it will be useful, but
00016   WITHOUT ANY WARRANTY; without even the implied warranty of
00017   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
00018   General Public License for more details.
00019 
00020   You should have received a copy of the GNU Lesser General Public License
00021   along with PulseAudio; if not, write to the Free Software
00022   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023   USA.
00024 ***/
00025 
00026 #include <pulse/sample.h>
00027 #include <pulse/cdecl.h>
00028 #include <pulse/gccmacro.h>
00029 
00069 PA_C_DECL_BEGIN
00070 
00072 typedef enum pa_channel_position {
00073     PA_CHANNEL_POSITION_INVALID = -1,
00074     PA_CHANNEL_POSITION_MONO = 0,
00075 
00076     PA_CHANNEL_POSITION_LEFT,
00077     PA_CHANNEL_POSITION_RIGHT,
00078     PA_CHANNEL_POSITION_CENTER,
00079 
00080     PA_CHANNEL_POSITION_FRONT_LEFT = PA_CHANNEL_POSITION_LEFT,
00081     PA_CHANNEL_POSITION_FRONT_RIGHT = PA_CHANNEL_POSITION_RIGHT,
00082     PA_CHANNEL_POSITION_FRONT_CENTER = PA_CHANNEL_POSITION_CENTER,
00083 
00084     PA_CHANNEL_POSITION_REAR_CENTER,
00085     PA_CHANNEL_POSITION_REAR_LEFT,
00086     PA_CHANNEL_POSITION_REAR_RIGHT,
00087 
00088     PA_CHANNEL_POSITION_LFE,
00089     PA_CHANNEL_POSITION_SUBWOOFER = PA_CHANNEL_POSITION_LFE,
00090 
00091     PA_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER,
00092     PA_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER,
00093 
00094     PA_CHANNEL_POSITION_SIDE_LEFT,
00095     PA_CHANNEL_POSITION_SIDE_RIGHT,
00096 
00097     PA_CHANNEL_POSITION_AUX0,
00098     PA_CHANNEL_POSITION_AUX1,
00099     PA_CHANNEL_POSITION_AUX2,
00100     PA_CHANNEL_POSITION_AUX3,
00101     PA_CHANNEL_POSITION_AUX4,
00102     PA_CHANNEL_POSITION_AUX5,
00103     PA_CHANNEL_POSITION_AUX6,
00104     PA_CHANNEL_POSITION_AUX7,
00105     PA_CHANNEL_POSITION_AUX8,
00106     PA_CHANNEL_POSITION_AUX9,
00107     PA_CHANNEL_POSITION_AUX10,
00108     PA_CHANNEL_POSITION_AUX11,
00109     PA_CHANNEL_POSITION_AUX12,
00110     PA_CHANNEL_POSITION_AUX13,
00111     PA_CHANNEL_POSITION_AUX14,
00112     PA_CHANNEL_POSITION_AUX15,
00113     PA_CHANNEL_POSITION_AUX16,
00114     PA_CHANNEL_POSITION_AUX17,
00115     PA_CHANNEL_POSITION_AUX18,
00116     PA_CHANNEL_POSITION_AUX19,
00117     PA_CHANNEL_POSITION_AUX20,
00118     PA_CHANNEL_POSITION_AUX21,
00119     PA_CHANNEL_POSITION_AUX22,
00120     PA_CHANNEL_POSITION_AUX23,
00121     PA_CHANNEL_POSITION_AUX24,
00122     PA_CHANNEL_POSITION_AUX25,
00123     PA_CHANNEL_POSITION_AUX26,
00124     PA_CHANNEL_POSITION_AUX27,
00125     PA_CHANNEL_POSITION_AUX28,
00126     PA_CHANNEL_POSITION_AUX29,
00127     PA_CHANNEL_POSITION_AUX30,
00128     PA_CHANNEL_POSITION_AUX31,
00129 
00130     PA_CHANNEL_POSITION_TOP_CENTER,
00131 
00132     PA_CHANNEL_POSITION_TOP_FRONT_LEFT,
00133     PA_CHANNEL_POSITION_TOP_FRONT_RIGHT,
00134     PA_CHANNEL_POSITION_TOP_FRONT_CENTER,
00135 
00136     PA_CHANNEL_POSITION_TOP_REAR_LEFT,
00137     PA_CHANNEL_POSITION_TOP_REAR_RIGHT,
00138     PA_CHANNEL_POSITION_TOP_REAR_CENTER,
00139 
00140     PA_CHANNEL_POSITION_MAX
00141 } pa_channel_position_t;
00142 
00144 typedef enum pa_channel_map_def {
00145     PA_CHANNEL_MAP_AIFF,
00148     PA_CHANNEL_MAP_ALSA,
00151     PA_CHANNEL_MAP_AUX,
00154     PA_CHANNEL_MAP_WAVEEX,
00157     PA_CHANNEL_MAP_OSS,
00161     PA_CHANNEL_MAP_DEF_MAX,
00162 
00163     PA_CHANNEL_MAP_DEFAULT = PA_CHANNEL_MAP_AIFF
00165 } pa_channel_map_def_t;
00166 
00170 typedef struct pa_channel_map {
00171     uint8_t channels;
00174     pa_channel_position_t map[PA_CHANNELS_MAX];
00176 } pa_channel_map;
00177 
00179 pa_channel_map* pa_channel_map_init(pa_channel_map *m);
00180 
00182 pa_channel_map* pa_channel_map_init_mono(pa_channel_map *m);
00183 
00185 pa_channel_map* pa_channel_map_init_stereo(pa_channel_map *m);
00186 
00191 pa_channel_map* pa_channel_map_init_auto(pa_channel_map *m, unsigned channels, pa_channel_map_def_t def);
00192 
00197 pa_channel_map* pa_channel_map_init_extend(pa_channel_map *m, unsigned channels, pa_channel_map_def_t def);
00198 
00200 const char* pa_channel_position_to_string(pa_channel_position_t pos) PA_GCC_PURE;
00201 
00203 const char* pa_channel_position_to_pretty_string(pa_channel_position_t pos);
00204 
00206 #define PA_CHANNEL_MAP_SNPRINT_MAX 336
00207 
00209 char* pa_channel_map_snprint(char *s, size_t l, const pa_channel_map *map);
00210 
00212 pa_channel_map *pa_channel_map_parse(pa_channel_map *map, const char *s);
00213 
00215 int pa_channel_map_equal(const pa_channel_map *a, const pa_channel_map *b) PA_GCC_PURE;
00216 
00218 int pa_channel_map_valid(const pa_channel_map *map) PA_GCC_PURE;
00219 
00222 int pa_channel_map_compatible(const pa_channel_map *map, const pa_sample_spec *ss) PA_GCC_PURE;
00223 
00224 PA_C_DECL_END
00225 
00226 #endif

Generated on Tue Sep 16 10:58:58 2008 for PulseAudio by  doxygen 1.5.4