/usr/include/gstreamer-1.0/gst/audio/audio-format.h is in libgstreamer-plugins-base1.0-dev 1.2.4-1~ubuntu2.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 | /* GStreamer
* Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
* Library <2001> Thomas Vander Stichele <thomas@apestaart.org>
* <2011> Wim Taymans <wim.taymans@gmail.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef __GST_AUDIO_AUDIO_H__
#include <gst/audio/audio.h>
#endif
#ifndef __GST_AUDIO_FORMAT_H__
#define __GST_AUDIO_FORMAT_H__
G_BEGIN_DECLS
#if G_BYTE_ORDER == G_BIG_ENDIAN
#define _GST_AUDIO_FORMAT_NE(fmt) GST_AUDIO_FORMAT_ ## fmt ## BE
#define _GST_AUDIO_FORMAT_OE(fmt) GST_AUDIO_FORMAT_ ## fmt ## LE
#elif G_BYTE_ORDER == G_LITTLE_ENDIAN
#define _GST_AUDIO_FORMAT_NE(fmt) GST_AUDIO_FORMAT_ ## fmt ## LE
#define _GST_AUDIO_FORMAT_OE(fmt) GST_AUDIO_FORMAT_ ## fmt ## BE
#endif
/**
* GstAudioFormat:
* @GST_AUDIO_FORMAT_UNKNOWN: unknown or unset audio format
* @GST_AUDIO_FORMAT_ENCODED: encoded audio format
* @GST_AUDIO_FORMAT_S8: 8 bits in 8 bits, signed
* @GST_AUDIO_FORMAT_U8: 8 bits in 8 bits, unsigned
* @GST_AUDIO_FORMAT_S16LE: 16 bits in 16 bits, signed, little endian
* @GST_AUDIO_FORMAT_S16BE: 16 bits in 16 bits, signed, big endian
* @GST_AUDIO_FORMAT_U16LE: 16 bits in 16 bits, unsigned, little endian
* @GST_AUDIO_FORMAT_U16BE: 16 bits in 16 bits, unsigned, big endian
* @GST_AUDIO_FORMAT_S24_32LE: 24 bits in 32 bits, signed, little endian
* @GST_AUDIO_FORMAT_S24_32BE: 24 bits in 32 bits, signed, big endian
* @GST_AUDIO_FORMAT_U24_32LE: 24 bits in 32 bits, unsigned, little endian
* @GST_AUDIO_FORMAT_U24_32BE: 24 bits in 32 bits, unsigned, big endian
* @GST_AUDIO_FORMAT_S32LE: 32 bits in 32 bits, signed, little endian
* @GST_AUDIO_FORMAT_S32BE: 32 bits in 32 bits, signed, big endian
* @GST_AUDIO_FORMAT_U32LE: 32 bits in 32 bits, unsigned, little endian
* @GST_AUDIO_FORMAT_U32BE: 32 bits in 32 bits, unsigned, big endian
* @GST_AUDIO_FORMAT_S24LE: 24 bits in 24 bits, signed, little endian
* @GST_AUDIO_FORMAT_S24BE: 24 bits in 24 bits, signed, big endian
* @GST_AUDIO_FORMAT_U24LE: 24 bits in 24 bits, unsigned, little endian
* @GST_AUDIO_FORMAT_U24BE: 24 bits in 24 bits, unsigned, big endian
* @GST_AUDIO_FORMAT_S20LE: 20 bits in 24 bits, signed, little endian
* @GST_AUDIO_FORMAT_S20BE: 20 bits in 24 bits, signed, big endian
* @GST_AUDIO_FORMAT_U20LE: 20 bits in 24 bits, unsigned, little endian
* @GST_AUDIO_FORMAT_U20BE: 20 bits in 24 bits, unsigned, big endian
* @GST_AUDIO_FORMAT_S18LE: 18 bits in 24 bits, signed, little endian
* @GST_AUDIO_FORMAT_S18BE: 18 bits in 24 bits, signed, big endian
* @GST_AUDIO_FORMAT_U18LE: 18 bits in 24 bits, unsigned, little endian
* @GST_AUDIO_FORMAT_U18BE: 18 bits in 24 bits, unsigned, big endian
* @GST_AUDIO_FORMAT_F32LE: 32-bit floating point samples, little endian
* @GST_AUDIO_FORMAT_F32BE: 32-bit floating point samples, big endian
* @GST_AUDIO_FORMAT_F64LE: 64-bit floating point samples, little endian
* @GST_AUDIO_FORMAT_F64BE: 64-bit floating point samples, big endian
* @GST_AUDIO_FORMAT_S16: 16 bits in 16 bits, signed, native endianness
* @GST_AUDIO_FORMAT_U16: 16 bits in 16 bits, unsigned, native endianness
* @GST_AUDIO_FORMAT_S24_32: 24 bits in 32 bits, signed, native endianness
* @GST_AUDIO_FORMAT_U24_32: 24 bits in 32 bits, unsigned, native endianness
* @GST_AUDIO_FORMAT_S32: 32 bits in 32 bits, signed, native endianness
* @GST_AUDIO_FORMAT_U32: 32 bits in 32 bits, unsigned, native endianness
* @GST_AUDIO_FORMAT_S24: 24 bits in 24 bits, signed, native endianness
* @GST_AUDIO_FORMAT_U24: 24 bits in 24 bits, unsigned, native endianness
* @GST_AUDIO_FORMAT_S20: 20 bits in 24 bits, signed, native endianness
* @GST_AUDIO_FORMAT_U20: 20 bits in 24 bits, unsigned, native endianness
* @GST_AUDIO_FORMAT_S18: 18 bits in 24 bits, signed, native endianness
* @GST_AUDIO_FORMAT_U18: 18 bits in 24 bits, unsigned, native endianness
* @GST_AUDIO_FORMAT_F32: 32-bit floating point samples, native endianness
* @GST_AUDIO_FORMAT_F64: 64-bit floating point samples, native endianness
*
* Enum value describing the most common audio formats.
*/
typedef enum {
GST_AUDIO_FORMAT_UNKNOWN,
GST_AUDIO_FORMAT_ENCODED,
/* 8 bit */
GST_AUDIO_FORMAT_S8,
GST_AUDIO_FORMAT_U8,
/* 16 bit */
GST_AUDIO_FORMAT_S16LE,
GST_AUDIO_FORMAT_S16BE,
GST_AUDIO_FORMAT_U16LE,
GST_AUDIO_FORMAT_U16BE,
/* 24 bit in low 3 bytes of 32 bits*/
GST_AUDIO_FORMAT_S24_32LE,
GST_AUDIO_FORMAT_S24_32BE,
GST_AUDIO_FORMAT_U24_32LE,
GST_AUDIO_FORMAT_U24_32BE,
/* 32 bit */
GST_AUDIO_FORMAT_S32LE,
GST_AUDIO_FORMAT_S32BE,
GST_AUDIO_FORMAT_U32LE,
GST_AUDIO_FORMAT_U32BE,
/* 24 bit in 3 bytes*/
GST_AUDIO_FORMAT_S24LE,
GST_AUDIO_FORMAT_S24BE,
GST_AUDIO_FORMAT_U24LE,
GST_AUDIO_FORMAT_U24BE,
/* 20 bit in 3 bytes*/
GST_AUDIO_FORMAT_S20LE,
GST_AUDIO_FORMAT_S20BE,
GST_AUDIO_FORMAT_U20LE,
GST_AUDIO_FORMAT_U20BE,
/* 18 bit in 3 bytes*/
GST_AUDIO_FORMAT_S18LE,
GST_AUDIO_FORMAT_S18BE,
GST_AUDIO_FORMAT_U18LE,
GST_AUDIO_FORMAT_U18BE,
/* float */
GST_AUDIO_FORMAT_F32LE,
GST_AUDIO_FORMAT_F32BE,
GST_AUDIO_FORMAT_F64LE,
GST_AUDIO_FORMAT_F64BE,
/* native endianness equivalents */
GST_AUDIO_FORMAT_S16 = _GST_AUDIO_FORMAT_NE(S16),
GST_AUDIO_FORMAT_U16 = _GST_AUDIO_FORMAT_NE(U16),
GST_AUDIO_FORMAT_S24_32 = _GST_AUDIO_FORMAT_NE(S24_32),
GST_AUDIO_FORMAT_U24_32 = _GST_AUDIO_FORMAT_NE(U24_32),
GST_AUDIO_FORMAT_S32 = _GST_AUDIO_FORMAT_NE(S32),
GST_AUDIO_FORMAT_U32 = _GST_AUDIO_FORMAT_NE(U32),
GST_AUDIO_FORMAT_S24 = _GST_AUDIO_FORMAT_NE(S24),
GST_AUDIO_FORMAT_U24 = _GST_AUDIO_FORMAT_NE(U24),
GST_AUDIO_FORMAT_S20 = _GST_AUDIO_FORMAT_NE(S20),
GST_AUDIO_FORMAT_U20 = _GST_AUDIO_FORMAT_NE(U20),
GST_AUDIO_FORMAT_S18 = _GST_AUDIO_FORMAT_NE(S18),
GST_AUDIO_FORMAT_U18 = _GST_AUDIO_FORMAT_NE(U18),
GST_AUDIO_FORMAT_F32 = _GST_AUDIO_FORMAT_NE(F32),
GST_AUDIO_FORMAT_F64 = _GST_AUDIO_FORMAT_NE(F64)
} GstAudioFormat;
typedef struct _GstAudioFormatInfo GstAudioFormatInfo;
/**
* GstAudioFormatFlags:
* @GST_AUDIO_FORMAT_FLAG_INTEGER: integer samples
* @GST_AUDIO_FORMAT_FLAG_FLOAT: float samples
* @GST_AUDIO_FORMAT_FLAG_SIGNED: signed samples
* @GST_AUDIO_FORMAT_FLAG_COMPLEX: complex layout
* @GST_AUDIO_FORMAT_FLAG_UNPACK: the format can be used in
* #GstAudioFormatUnpack and #GstAudioFormatPack functions
*
* The different audio flags that a format info can have.
*/
typedef enum
{
GST_AUDIO_FORMAT_FLAG_INTEGER = (1 << 0),
GST_AUDIO_FORMAT_FLAG_FLOAT = (1 << 1),
GST_AUDIO_FORMAT_FLAG_SIGNED = (1 << 2),
GST_AUDIO_FORMAT_FLAG_COMPLEX = (1 << 4),
GST_AUDIO_FORMAT_FLAG_UNPACK = (1 << 5)
} GstAudioFormatFlags;
/**
* GstAudioPackFlags:
* @GST_AUDIO_PACK_FLAG_NONE: No flag
*
* The different flags that can be used when packing and unpacking.
*/
typedef enum
{
GST_AUDIO_PACK_FLAG_NONE = 0
} GstAudioPackFlags;
/**
* GstAudioFormatUnpack:
* @info: a #GstAudioFormatInfo
* @dest: (array) (element-type guint8): a destination array
* @data: (array) (element-type guint8): pointer to the audio data
* @length: the amount of samples to unpack.
*
* Unpacks @length samples from the given data of format @info.
* The samples will be unpacked into @dest which each channel
* interleaved. @dest should at least be big enough to hold @length *
* channels * size(unpack_format) bytes.
*/
typedef void (*GstAudioFormatUnpack) (const GstAudioFormatInfo *info,
GstAudioPackFlags flags, gpointer dest,
const gpointer data, gint length);
/**
* GstAudioFormatPack:
* @info: a #GstAudioFormatInfo
* @src: (array) (element-type guint8): a source array
* @data: (array) (element-type guint8): pointer to the destination
* data
* @length: the amount of samples to pack.
*
* Packs @length samples from @src to the data array in format @info.
* The samples from source have each channel interleaved
* and will be packed into @data.
*/
typedef void (*GstAudioFormatPack) (const GstAudioFormatInfo *info,
GstAudioPackFlags flags, const gpointer src,
gpointer data, gint length);
/**
* GstAudioFormatInfo:
* @format: #GstAudioFormat
* @name: string representation of the format
* @description: user readable description of the format
* @flags: #GstAudioFormatFlags
* @endianness: the endianness
* @width: amount of bits used for one sample
* @depth: amount of valid bits in @width
* @silence: @width/8 bytes with 1 silent sample
* @unpack_format: the format of the unpacked samples
* @unpack_func: function to unpack samples
* @pack_func: function to pack samples
*
* Information for an audio format.
*/
struct _GstAudioFormatInfo {
GstAudioFormat format;
const gchar *name;
const gchar *description;
GstAudioFormatFlags flags;
gint endianness;
gint width;
gint depth;
guint8 silence[8];
GstAudioFormat unpack_format;
GstAudioFormatUnpack unpack_func;
GstAudioFormatPack pack_func;
/*< private >*/
gpointer _gst_reserved[GST_PADDING];
};
GType gst_audio_format_info_get_type (void);
#define GST_AUDIO_FORMAT_INFO_FORMAT(info) ((info)->format)
#define GST_AUDIO_FORMAT_INFO_NAME(info) ((info)->name)
#define GST_AUDIO_FORMAT_INFO_FLAGS(info) ((info)->flags)
#define GST_AUDIO_FORMAT_INFO_IS_INTEGER(info) !!((info)->flags & GST_AUDIO_FORMAT_FLAG_INTEGER)
#define GST_AUDIO_FORMAT_INFO_IS_FLOAT(info) !!((info)->flags & GST_AUDIO_FORMAT_FLAG_FLOAT)
#define GST_AUDIO_FORMAT_INFO_IS_SIGNED(info) !!((info)->flags & GST_AUDIO_FORMAT_FLAG_SIGNED)
#define GST_AUDIO_FORMAT_INFO_ENDIANNESS(info) ((info)->endianness)
#define GST_AUDIO_FORMAT_INFO_IS_LITTLE_ENDIAN(info) ((info)->endianness == G_LITTLE_ENDIAN)
#define GST_AUDIO_FORMAT_INFO_IS_BIG_ENDIAN(info) ((info)->endianness == G_BIG_ENDIAN)
#define GST_AUDIO_FORMAT_INFO_WIDTH(info) ((info)->width)
#define GST_AUDIO_FORMAT_INFO_DEPTH(info) ((info)->depth)
GstAudioFormat gst_audio_format_build_integer (gboolean sign, gint endianness,
gint width, gint depth) G_GNUC_CONST;
GstAudioFormat gst_audio_format_from_string (const gchar *format) G_GNUC_CONST;
const gchar * gst_audio_format_to_string (GstAudioFormat format) G_GNUC_CONST;
const GstAudioFormatInfo *
gst_audio_format_get_info (GstAudioFormat format) G_GNUC_CONST;
void gst_audio_format_fill_silence (const GstAudioFormatInfo *info,
gpointer dest, gsize length);
/**
* GST_AUDIO_RATE_RANGE:
*
* Maximum range of allowed sample rates, for use in template caps strings.
*/
#define GST_AUDIO_RATE_RANGE "(int) [ 1, max ]"
/**
* GST_AUDIO_CHANNELS_RANGE:
*
* Maximum range of allowed channels, for use in template caps strings.
*/
#define GST_AUDIO_CHANNELS_RANGE "(int) [ 1, max ]"
/**
* GST_AUDIO_NE:
* @s: format string without endianness marker
*
* Turns audio format string @s into the format string for native endianness.
*/
/**
* GST_AUDIO_OE:
* @s: format string without endianness marker
*
* Turns audio format string @s into the format string for other endianness.
*/
#if G_BYTE_ORDER == G_LITTLE_ENDIAN
# define GST_AUDIO_NE(s) G_STRINGIFY(s)"LE"
# define GST_AUDIO_OE(s) G_STRINGIFY(s)"BE"
#else
# define GST_AUDIO_NE(s) G_STRINGIFY(s)"BE"
# define GST_AUDIO_OE(s) G_STRINGIFY(s)"LE"
#endif
/**
* GST_AUDIO_FORMATS_ALL:
*
* List of all audio formats, for use in template caps strings.
*/
#define GST_AUDIO_FORMATS_ALL " { S8, U8, " \
"S16LE, S16BE, U16LE, U16BE, " \
"S24_32LE, S24_32BE, U24_32LE, U24_32BE, " \
"S32LE, S32BE, U32LE, U32BE, " \
"S24LE, S24BE, U24LE, U24BE, " \
"S20LE, S20BE, U20LE, U20BE, " \
"S18LE, S18BE, U18LE, U18BE, " \
"F32LE, F32BE, F64LE, F64BE }"
/**
* GST_AUDIO_CAPS_MAKE:
* @format: string format that describes the sample layout, as string
* (e.g. "S16LE", "S8", etc.)
*
* Generic caps string for audio, for use in pad templates.
*/
#define GST_AUDIO_CAPS_MAKE(format) \
"audio/x-raw, " \
"format = (string) " format ", " \
"rate = " GST_AUDIO_RATE_RANGE ", " \
"channels = " GST_AUDIO_CHANNELS_RANGE
/**
* GST_AUDIO_DEF_RATE:
*
* Standard sampling rate used in consumer audio.
*/
#define GST_AUDIO_DEF_RATE 44100
/**
* GST_AUDIO_DEF_CHANNELS:
*
* Standard number of channels used in consumer audio.
*/
#define GST_AUDIO_DEF_CHANNELS 2
/**
* GST_AUDIO_DEF_FORMAT:
*
* Standard format used in consumer audio.
*/
#define GST_AUDIO_DEF_FORMAT "S16LE"
G_END_DECLS
#endif /* __GST_AUDIO_FORMAT_H__ */
|