← Back to branch summary

~ubuntu-branches/ubuntu/precise/gst-plugins-base0.10/precise-updates

« back to all changes in this revision

Viewing changes to gst-libs/gst/audio/audio.h

  • Committer: Package Import Robot
  • Author(s): Sebastian Dröge
  • Date: 2011-12-11 19:27:10 UTC
  • mfrom: (11.7.12) (33.1.11 sid)
  • mto: This revision was merged to the branch mainline in revision 58.
  • Revision ID: package-import@ubuntu.com-20111211192710-f52020gqtas8705f
Tags: 0.10.35.2-1
http://bugs.debian.org/647485
* New upstream pre-release:
  + debian/rules,
    debian/build-deps.in:
    - Build-depend on GStreamer core >= 0.10.35.2.
    - Build-depend on GLib >= 2.24.
    - Build-depend on GTK+ 3.0.
    - Build-depend on zlib.
  + debian/patches/99_ltmain_as-needed.patch:
    - Refresh to apply cleanly again.
  + debian/libgstreamer-plugins-base.symbols:
    - Update symbols file with new API.
* debian/rules:
  + Remove all dependency_libs from the .la files.
* debian/control.in:
  + Put GI package into section introspection.
* debian/build-deps.in,
  debian/compat,
  debian/control.in,
  debian/gir1.2-gst-plugins-base.install,
  debian/gstreamer-alsa.install,
  debian/gstreamer-gnomevfs.install,
  debian/gstreamer-plugins-base.install,
  debian/gstreamer-x.install,
  debian/libgstreamer-plugins-base-dev.install,
  debian/libgstreamer-plugins-base.install,
  debian/rules:
  + Transition package to multi-arch (Closes: #647485).
    Patch taken from the Ubuntu package.

Show diffs side-by-side

added added

removed removed

Lines of Context:
gst-libs/gst/audio/audio.h
23
23
#ifndef __GST_AUDIO_AUDIO_H__
24
24
#define __GST_AUDIO_AUDIO_H__
25
25
 
 
26
#include <gst/audio/multichannel.h>
 
27
 
26
28
G_BEGIN_DECLS
27
29
 
 
30
#if G_BYTE_ORDER == G_BIG_ENDIAN
 
31
#define _GST_AUDIO_FORMAT_NE(fmt) GST_AUDIO_FORMAT_ ## fmt ## BE
 
32
#elif G_BYTE_ORDER == G_LITTLE_ENDIAN
 
33
#define _GST_AUDIO_FORMAT_NE(fmt) GST_AUDIO_FORMAT_ ## fmt ## LE
 
34
#endif
 
35
 
 
36
/**
 
37
 * GstAudioFormat:
 
38
 * @GST_AUDIO_FORMAT_UNKNOWN: unknown audio format
 
39
 * @GST_AUDIO_FORMAT_S8: 8 bits in 8 bits, signed
 
40
 * @GST_AUDIO_FORMAT_U8: 8 bits in 8 bits, unsigned
 
41
 * @GST_AUDIO_FORMAT_S16LE: 16 bits in 16 bits, signed, little endian
 
42
 * @GST_AUDIO_FORMAT_S16BE: 16 bits in 16 bits, signed, big endian
 
43
 * @GST_AUDIO_FORMAT_U16LE: 16 bits in 16 bits, unsigned, little endian
 
44
 * @GST_AUDIO_FORMAT_U16BE: 16 bits in 16 bits, unsigned, big endian
 
45
 * @GST_AUDIO_FORMAT_S24_32LE: 24 bits in 32 bits, signed, little endian
 
46
 * @GST_AUDIO_FORMAT_S24_32BE: 24 bits in 32 bits, signed, big endian
 
47
 * @GST_AUDIO_FORMAT_U24_32LE: 24 bits in 32 bits, unsigned, little endian
 
48
 * @GST_AUDIO_FORMAT_U24_32BE: 24 bits in 32 bits, unsigned, big endian
 
49
 * @GST_AUDIO_FORMAT_S32LE: 32 bits in 32 bits, signed, little endian
 
50
 * @GST_AUDIO_FORMAT_S32BE: 32 bits in 32 bits, signed, big endian
 
51
 * @GST_AUDIO_FORMAT_U32LE: 32 bits in 32 bits, unsigned, little endian
 
52
 * @GST_AUDIO_FORMAT_U32BE: 32 bits in 32 bits, unsigned, big endian
 
53
 * @GST_AUDIO_FORMAT_S24LE: 24 bits in 24 bits, signed, little endian
 
54
 * @GST_AUDIO_FORMAT_S24BE: 24 bits in 24 bits, signed, big endian
 
55
 * @GST_AUDIO_FORMAT_U24LE: 24 bits in 24 bits, unsigned, little endian
 
56
 * @GST_AUDIO_FORMAT_U24BE: 24 bits in 24 bits, unsigned, big endian
 
57
 * @GST_AUDIO_FORMAT_S20LE: 20 bits in 24 bits, signed, little endian
 
58
 * @GST_AUDIO_FORMAT_S20BE: 20 bits in 24 bits, signed, big endian
 
59
 * @GST_AUDIO_FORMAT_U20LE: 20 bits in 24 bits, unsigned, little endian
 
60
 * @GST_AUDIO_FORMAT_U20BE: 20 bits in 24 bits, unsigned, big endian
 
61
 * @GST_AUDIO_FORMAT_S18LE: 18 bits in 24 bits, signed, little endian
 
62
 * @GST_AUDIO_FORMAT_S18BE: 18 bits in 24 bits, signed, big endian
 
63
 * @GST_AUDIO_FORMAT_U18LE: 18 bits in 24 bits, unsigned, little endian
 
64
 * @GST_AUDIO_FORMAT_U18BE: 18 bits in 24 bits, unsigned, big endian
 
65
 * @GST_AUDIO_FORMAT_F32LE: 32-bit floating point samples, little endian
 
66
 * @GST_AUDIO_FORMAT_F32BE: 32-bit floating point samples, big endian
 
67
 * @GST_AUDIO_FORMAT_F64LE: 64-bit floating point samples, little endian
 
68
 * @GST_AUDIO_FORMAT_F64BE: 64-bit floating point samples, big endian
 
69
 * @GST_AUDIO_FORMAT_S16: 16 bits in 16 bits, signed, native endianness
 
70
 * @GST_AUDIO_FORMAT_U16: 16 bits in 16 bits, unsigned, native endianness
 
71
 * @GST_AUDIO_FORMAT_S24_32: 24 bits in 32 bits, signed, native endianness
 
72
 * @GST_AUDIO_FORMAT_U24_32: 24 bits in 32 bits, unsigned, native endianness
 
73
 * @GST_AUDIO_FORMAT_S32: 32 bits in 32 bits, signed, native endianness
 
74
 * @GST_AUDIO_FORMAT_U32: 32 bits in 32 bits, unsigned, native endianness
 
75
 * @GST_AUDIO_FORMAT_S24: 24 bits in 24 bits, signed, native endianness
 
76
 * @GST_AUDIO_FORMAT_U24: 24 bits in 24 bits, unsigned, native endianness
 
77
 * @GST_AUDIO_FORMAT_S20: 20 bits in 24 bits, signed, native endianness
 
78
 * @GST_AUDIO_FORMAT_U20: 20 bits in 24 bits, unsigned, native endianness
 
79
 * @GST_AUDIO_FORMAT_S18: 18 bits in 24 bits, signed, native endianness
 
80
 * @GST_AUDIO_FORMAT_U18: 18 bits in 24 bits, unsigned, native endianness
 
81
 * @GST_AUDIO_FORMAT_F32: 32-bit floating point samples, native endianness
 
82
 * @GST_AUDIO_FORMAT_F64: 64-bit floating point samples, native endianness
 
83
 *
 
84
 * Enum value describing the most common audio formats.
 
85
 *
 
86
 * Since: 0.10.36
 
87
 */
 
88
typedef enum {
 
89
  GST_AUDIO_FORMAT_UNKNOWN,
 
90
  /* 8 bit */
 
91
  GST_AUDIO_FORMAT_S8,
 
92
  GST_AUDIO_FORMAT_U8,
 
93
  /* 16 bit */
 
94
  GST_AUDIO_FORMAT_S16LE,
 
95
  GST_AUDIO_FORMAT_S16BE,
 
96
  GST_AUDIO_FORMAT_U16LE,
 
97
  GST_AUDIO_FORMAT_U16BE,
 
98
  /* 24 bit in low 3 bytes of 32 bits*/
 
99
  GST_AUDIO_FORMAT_S24_32LE,
 
100
  GST_AUDIO_FORMAT_S24_32BE,
 
101
  GST_AUDIO_FORMAT_U24_32LE,
 
102
  GST_AUDIO_FORMAT_U24_32BE,
 
103
  /* 32 bit */
 
104
  GST_AUDIO_FORMAT_S32LE,
 
105
  GST_AUDIO_FORMAT_S32BE,
 
106
  GST_AUDIO_FORMAT_U32LE,
 
107
  GST_AUDIO_FORMAT_U32BE,
 
108
  /* 24 bit in 3 bytes*/
 
109
  GST_AUDIO_FORMAT_S24LE,
 
110
  GST_AUDIO_FORMAT_S24BE,
 
111
  GST_AUDIO_FORMAT_U24LE,
 
112
  GST_AUDIO_FORMAT_U24BE,
 
113
  /* 20 bit in 3 bytes*/
 
114
  GST_AUDIO_FORMAT_S20LE,
 
115
  GST_AUDIO_FORMAT_S20BE,
 
116
  GST_AUDIO_FORMAT_U20LE,
 
117
  GST_AUDIO_FORMAT_U20BE,
 
118
  /* 18 bit in 3 bytes*/
 
119
  GST_AUDIO_FORMAT_S18LE,
 
120
  GST_AUDIO_FORMAT_S18BE,
 
121
  GST_AUDIO_FORMAT_U18LE,
 
122
  GST_AUDIO_FORMAT_U18BE,
 
123
  /* float */
 
124
  GST_AUDIO_FORMAT_F32LE,
 
125
  GST_AUDIO_FORMAT_F32BE,
 
126
  GST_AUDIO_FORMAT_F64LE,
 
127
  GST_AUDIO_FORMAT_F64BE,
 
128
  /* native endianness equivalents */
 
129
  GST_AUDIO_FORMAT_S16 = _GST_AUDIO_FORMAT_NE(S16),
 
130
  GST_AUDIO_FORMAT_U16 = _GST_AUDIO_FORMAT_NE(U16),
 
131
  GST_AUDIO_FORMAT_S24_32 = _GST_AUDIO_FORMAT_NE(S24_32),
 
132
  GST_AUDIO_FORMAT_U24_32 = _GST_AUDIO_FORMAT_NE(U24_32),
 
133
  GST_AUDIO_FORMAT_S32 = _GST_AUDIO_FORMAT_NE(S32),
 
134
  GST_AUDIO_FORMAT_U32 = _GST_AUDIO_FORMAT_NE(U32),
 
135
  GST_AUDIO_FORMAT_S24 = _GST_AUDIO_FORMAT_NE(S24),
 
136
  GST_AUDIO_FORMAT_U24 = _GST_AUDIO_FORMAT_NE(U24),
 
137
  GST_AUDIO_FORMAT_S20 = _GST_AUDIO_FORMAT_NE(S20),
 
138
  GST_AUDIO_FORMAT_U20 = _GST_AUDIO_FORMAT_NE(U20),
 
139
  GST_AUDIO_FORMAT_S18 = _GST_AUDIO_FORMAT_NE(S18),
 
140
  GST_AUDIO_FORMAT_U18 = _GST_AUDIO_FORMAT_NE(U18),
 
141
  GST_AUDIO_FORMAT_F32 = _GST_AUDIO_FORMAT_NE(F32),
 
142
  GST_AUDIO_FORMAT_F64 = _GST_AUDIO_FORMAT_NE(F64)
 
143
} GstAudioFormat;
 
144
 
 
145
/* FIXME: need GTypes */
 
146
typedef struct _GstAudioFormatInfo GstAudioFormatInfo;
 
147
typedef struct _GstAudioInfo GstAudioInfo;
 
148
 
 
149
/**
 
150
 * GstAudioFormatFlags:
 
151
 * @GST_AUDIO_FORMAT_FLAG_INTEGER: integer samples
 
152
 * @GST_AUDIO_FORMAT_FLAG_FLOAT: float samples
 
153
 * @GST_AUDIO_FORMAT_FLAG_SIGNED: signed samples
 
154
 * @GST_AUDIO_FORMAT_FLAG_COMPLEX: complex layout
 
155
 *
 
156
 * The different audio flags that a format info can have.
 
157
 *
 
158
 * Since: 0.10.36
 
159
 */
 
160
typedef enum
 
161
{
 
162
  GST_AUDIO_FORMAT_FLAG_INTEGER  = (1 << 0),
 
163
  GST_AUDIO_FORMAT_FLAG_FLOAT    = (1 << 1),
 
164
  GST_AUDIO_FORMAT_FLAG_SIGNED   = (1 << 2),
 
165
  GST_AUDIO_FORMAT_FLAG_COMPLEX  = (1 << 4)
 
166
} GstAudioFormatFlags;
 
167
 
 
168
/**
 
169
 * GstAudioFormatInfo:
 
170
 * @format: #GstAudioFormat
 
171
 * @name: string representation of the format
 
172
 * @flags: #GstAudioFormatFlags
 
173
 * @endianness: the endianness
 
174
 * @width: amount of bits used for one sample
 
175
 * @depth: amount of valid bits in @width
 
176
 * @silence: @width/8 bytes with 1 silent sample
 
177
 *
 
178
 * Information for an audio format.
 
179
 *
 
180
 * Since: 0.10.36
 
181
 */
 
182
struct _GstAudioFormatInfo {
 
183
  GstAudioFormat      format;
 
184
  const gchar *       name;
 
185
  GstAudioFormatFlags flags;
 
186
  gint                endianness;
 
187
  gint                width;
 
188
  gint                depth;
 
189
  guint8              silence[8];
 
190
  /*< private >*/
 
191
  guint               padding_i[4];
 
192
  gpointer            padding_p[4];
 
193
};
 
194
 
 
195
#define GST_AUDIO_FORMAT_INFO_FORMAT(info)           ((info)->format)
 
196
#define GST_AUDIO_FORMAT_INFO_NAME(info)             ((info)->name)
 
197
#define GST_AUDIO_FORMAT_INFO_FLAGS(info)            ((info)->flags)
 
198
 
 
199
#define GST_AUDIO_FORMAT_INFO_IS_INTEGER(info)       !!((info)->flags & GST_AUDIO_FORMAT_FLAG_INTEGER)
 
200
#define GST_AUDIO_FORMAT_INFO_IS_FLOAT(info)         !!((info)->flags & GST_AUDIO_FORMAT_FLAG_FLOAT)
 
201
#define GST_AUDIO_FORMAT_INFO_IS_SIGNED(info)        !!((info)->flags & GST_AUDIO_FORMAT_FLAG_SIGNED)
 
202
 
 
203
#define GST_AUDIO_FORMAT_INFO_ENDIANNESS(info)       ((info)->endianness)
 
204
#define GST_AUDIO_FORMAT_INFO_IS_LITTLE_ENDIAN(info) ((info)->endianness == G_LITTLE_ENDIAN)
 
205
#define GST_AUDIO_FORMAT_INFO_IS_BIG_ENDIAN(info)    ((info)->endianness == G_BIG_ENDIAN)
 
206
#define GST_AUDIO_FORMAT_INFO_WIDTH(info)            ((info)->width)
 
207
#define GST_AUDIO_FORMAT_INFO_DEPTH(info)            ((info)->depth)
 
208
 
 
209
const GstAudioFormatInfo * gst_audio_format_get_info (GstAudioFormat format) G_GNUC_CONST;
 
210
 
 
211
/**
 
212
 * GstAudioFlags:
 
213
 * @GST_AUDIO_FLAG_NONE: no valid flag
 
214
 * @GST_AUDIO_FLAG_DEFAULT_POSITIONS: unpositioned audio layout, position array
 
215
 *     contains the default layout (meaning that the channel layout was not
 
216
 *     explicitly specified in the caps)
 
217
 *
 
218
 * Extra audio flags
 
219
 *
 
220
 * Since: 0.10.36
 
221
 */
 
222
typedef enum {
 
223
  GST_AUDIO_FLAG_NONE         = 0,
 
224
  GST_AUDIO_FLAG_DEFAULT_POSITIONS = (1 << 0)
 
225
} GstAudioFlags;
 
226
 
 
227
/**
 
228
 * GstAudioInfo:
 
229
 * @finfo: the format info of the audio
 
230
 * @flags: additional audio flags
 
231
 * @rate: the audio sample rate
 
232
 * @channels: the number of channels
 
233
 * @bpf: the number of bytes for one frame, this is the size of one
 
234
 *         sample * @channels
 
235
 * @position: the position for each channel (assume all NONE for >64 channels)
 
236
 *
 
237
 * Information describing audio properties. This information can be filled
 
238
 * in from GstCaps with gst_audio_info_from_caps().
 
239
 *
 
240
 * Use the provided macros to access the info in this structure.
 
241
 *
 
242
 * Since: 0.10.36
 
243
 */
 
244
struct _GstAudioInfo {
 
245
  const GstAudioFormatInfo *finfo;
 
246
  GstAudioFlags             flags;
 
247
  gint                      rate;
 
248
  gint                      channels;
 
249
  gint                      bpf;
 
250
  GstAudioChannelPosition   position[64];
 
251
};
 
252
 
 
253
#define GST_AUDIO_INFO_IS_VALID(i)           ((i)->finfo != NULL && (i)->rate > 0 && (i)->channels > 0 && (i)->bpf > 0)
 
254
 
 
255
#define GST_AUDIO_INFO_FORMAT(i)             (GST_AUDIO_FORMAT_INFO_FORMAT((i)->finfo))
 
256
#define GST_AUDIO_INFO_NAME(i)               (GST_AUDIO_FORMAT_INFO_NAME((i)->finfo))
 
257
#define GST_AUDIO_INFO_WIDTH(i)              (GST_AUDIO_FORMAT_INFO_WIDTH((i)->finfo))
 
258
#define GST_AUDIO_INFO_DEPTH(i)              (GST_AUDIO_FORMAT_INFO_DEPTH((i)->finfo))
 
259
#define GST_AUDIO_INFO_BPS(info)             (GST_AUDIO_INFO_DEPTH(info) >> 3)
 
260
 
 
261
#define GST_AUDIO_INFO_IS_INTEGER(i)         (GST_AUDIO_FORMAT_INFO_IS_INTEGER((i)->finfo))
 
262
#define GST_AUDIO_INFO_IS_FLOAT(i)           (GST_AUDIO_FORMAT_INFO_IS_FLOAT((i)->finfo))
 
263
#define GST_AUDIO_INFO_IS_SIGNED(i)          (GST_AUDIO_FORMAT_INFO_IS_SIGNED((i)->finfo))
 
264
 
 
265
#define GST_AUDIO_INFO_ENDIANNESS(i)         (GST_AUDIO_FORMAT_INFO_ENDIANNES((i)->finfo))
 
266
#define GST_AUDIO_INFO_IS_LITTLE_ENDIAN(i)   (GST_AUDIO_FORMAT_INFO_IS_LITTLE_ENDIAN((i)->finfo))
 
267
#define GST_AUDIO_INFO_IS_BIG_ENDIAN(i)      (GST_AUDIO_FORMAT_INFO_IS_BIG_ENDIAN((i)->finfo))
 
268
 
 
269
#define GST_AUDIO_INFO_FLAGS(info)           ((info)->flags)
 
270
#define GST_AUDIO_INFO_HAS_DEFAULT_POSITIONS(info) ((info)->flags & GST_AUDIO_FLAG_DEFAULT_POSITIONS)
 
271
 
 
272
#define GST_AUDIO_INFO_RATE(info)            ((info)->rate)
 
273
#define GST_AUDIO_INFO_CHANNELS(info)        ((info)->channels)
 
274
#define GST_AUDIO_INFO_BPF(info)             ((info)->bpf)
 
275
#define GST_AUDIO_INFO_POSITION(info,c)      ((info)->position[c])
 
276
 
 
277
void           gst_audio_info_init  (GstAudioInfo * info);
 
278
void           gst_audio_info_clear (GstAudioInfo * info);
 
279
 
 
280
GstAudioInfo * gst_audio_info_copy  (GstAudioInfo * info);
 
281
void           gst_audio_info_free  (GstAudioInfo * info);
 
282
 
 
283
gboolean       gst_audio_info_from_caps (GstAudioInfo * info, const GstCaps * caps);
 
284
GstCaps *      gst_audio_info_to_caps   (GstAudioInfo * info);
 
285
 
 
286
gboolean       gst_audio_info_convert   (GstAudioInfo * info,
 
287
                                         GstFormat src_fmt,  gint64   src_val,
 
288
                                         GstFormat dest_fmt, gint64 * dest_val);
 
289
 
28
290
/* For people that are looking at this source: the purpose of these defines is
29
291
 * to make GstCaps a bit easier, in that you don't have to know all of the
30
292
 * properties that need to be defined. you can just use these macros. currently