GstAudioFormatPack ()

void
(*GstAudioFormatPack) (const GstAudioFormatInfo *info,
                       GstAudioPackFlags flags,
                       const gpointer src,
                       gpointer data,
                       gint length);

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 .

GstAudioFormatUnpack ()

void
(*GstAudioFormatUnpack) (const GstAudioFormatInfo *info,
                         GstAudioPackFlags flags,
                         gpointer dest,
                         const gpointer data,
                         gint length);

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.

gst_audio_info_init ()

void
gst_audio_info_init (GstAudioInfo *info);

Initialize info with default values.

gst_audio_info_from_caps ()

gboolean
gst_audio_info_from_caps (GstAudioInfo *info,
                          const GstCaps *caps);

Parse caps and update info .

gst_audio_info_to_caps ()

GstCaps *
gst_audio_info_to_caps (const GstAudioInfo *info);

Convert the values of info into a GstCaps.

gst_audio_info_convert ()

gboolean
gst_audio_info_convert (const GstAudioInfo *info,
                        GstFormat src_fmt,
                        gint64 src_val,
                        GstFormat dest_fmt,
                        gint64 *dest_val);

Converts among various GstFormat types. This function handles GST_FORMAT_BYTES, GST_FORMAT_TIME, and GST_FORMAT_DEFAULT. For raw audio, GST_FORMAT_DEFAULT corresponds to audio frames. This function can be used to handle pad queries of the type GST_QUERY_CONVERT.

gst_audio_format_get_info ()

const GstAudioFormatInfo *
gst_audio_format_get_info (GstAudioFormat format);

Get the GstAudioFormatInfo for format

gst_audio_info_copy ()

GstAudioInfo *
gst_audio_info_copy (const GstAudioInfo *info);

Copy a GstAudioInfo structure.

gst_audio_info_free ()

void
gst_audio_info_free (GstAudioInfo *info);

Free a GstAudioInfo structure previously allocated with gst_audio_info_new() or gst_audio_info_copy().

gst_audio_info_new ()

GstAudioInfo *
gst_audio_info_new (void);

Allocate a new GstAudioInfo that is also initialized with gst_audio_info_init().

gst_audio_info_set_format ()

void
gst_audio_info_set_format (GstAudioInfo *info,
                           GstAudioFormat format,
                           gint rate,
                           gint channels,
                           const GstAudioChannelPosition *position);

Set the default info for the audio info of format and rate and channels .

Note: This initializes info first, no values are preserved.

gst_audio_info_is_equal ()

gboolean
gst_audio_info_is_equal (const GstAudioInfo *info,
                         const GstAudioInfo *other);

Compares two GstAudioInfo and returns whether they are equal or not

Since: 1.2

gst_audio_format_build_integer ()

GstAudioFormat
gst_audio_format_build_integer (gboolean sign,
                                gint endianness,
                                gint width,
                                gint depth);

Construct a GstAudioFormat with given parameters.

gst_audio_format_fill_silence ()

void
gst_audio_format_fill_silence (const GstAudioFormatInfo *info,
                               gpointer dest,
                               gsize length);

Fill length bytes in dest with silence samples for info .

gst_audio_format_from_string ()

GstAudioFormat
gst_audio_format_from_string (const gchar *format);

Convert the format string to its GstAudioFormat.

gst_audio_format_to_string ()

const gchar *
gst_audio_format_to_string (GstAudioFormat format);

GST_AUDIO_FORMAT_INFO_DEPTH()

#define GST_AUDIO_FORMAT_INFO_DEPTH(info)            ((info)->depth)

GST_AUDIO_FORMAT_INFO_ENDIANNESS()

#define GST_AUDIO_FORMAT_INFO_ENDIANNESS(info)       ((info)->endianness)

GST_AUDIO_FORMAT_INFO_FLAGS()

#define GST_AUDIO_FORMAT_INFO_FLAGS(info)            ((info)->flags)

GST_AUDIO_FORMAT_INFO_FORMAT()

#define GST_AUDIO_FORMAT_INFO_FORMAT(info)           ((info)->format)

GST_AUDIO_FORMAT_INFO_IS_FLOAT()

#define GST_AUDIO_FORMAT_INFO_IS_FLOAT(info)         !!((info)->flags & GST_AUDIO_FORMAT_FLAG_FLOAT)

GST_AUDIO_FORMAT_INFO_IS_INTEGER()

#define GST_AUDIO_FORMAT_INFO_IS_INTEGER(info)       !!((info)->flags & GST_AUDIO_FORMAT_FLAG_INTEGER)

GST_AUDIO_FORMAT_INFO_IS_BIG_ENDIAN()

#define GST_AUDIO_FORMAT_INFO_IS_BIG_ENDIAN(info)    ((info)->endianness == G_BIG_ENDIAN)

GST_AUDIO_FORMAT_INFO_IS_LITTLE_ENDIAN()

#define GST_AUDIO_FORMAT_INFO_IS_LITTLE_ENDIAN(info) ((info)->endianness == G_LITTLE_ENDIAN)

GST_AUDIO_FORMAT_INFO_IS_SIGNED()

#define GST_AUDIO_FORMAT_INFO_IS_SIGNED(info)        !!((info)->flags & GST_AUDIO_FORMAT_FLAG_SIGNED)

GST_AUDIO_FORMAT_INFO_NAME()

#define GST_AUDIO_FORMAT_INFO_NAME(info)             ((info)->name)

GST_AUDIO_FORMAT_INFO_WIDTH()

#define GST_AUDIO_FORMAT_INFO_WIDTH(info)            ((info)->width)

GST_AUDIO_INFO_BPF()

#define GST_AUDIO_INFO_BPF(info)             ((info)->bpf)

GST_AUDIO_INFO_BPS()

#define GST_AUDIO_INFO_BPS(info)             (GST_AUDIO_INFO_DEPTH(info) >> 3)

GST_AUDIO_INFO_CHANNELS()

#define GST_AUDIO_INFO_CHANNELS(info)        ((info)->channels)

GST_AUDIO_INFO_DEPTH()

#define GST_AUDIO_INFO_DEPTH(i)              (GST_AUDIO_FORMAT_INFO_DEPTH((i)->finfo))

GST_AUDIO_INFO_FLAGS()

#define GST_AUDIO_INFO_FLAGS(info)           ((info)->flags)

GST_AUDIO_INFO_FORMAT()

#define GST_AUDIO_INFO_FORMAT(i)             (GST_AUDIO_FORMAT_INFO_FORMAT((i)->finfo))

GST_AUDIO_INFO_NAME()

#define GST_AUDIO_INFO_NAME(i)               (GST_AUDIO_FORMAT_INFO_NAME((i)->finfo))

GST_AUDIO_INFO_POSITION()

#define GST_AUDIO_INFO_POSITION(info,c)      ((info)->position[c])

GST_AUDIO_INFO_RATE()

#define GST_AUDIO_INFO_RATE(info)            ((info)->rate)

GST_AUDIO_INFO_WIDTH()

#define GST_AUDIO_INFO_WIDTH(i)              (GST_AUDIO_FORMAT_INFO_WIDTH((i)->finfo))

GST_AUDIO_INFO_ENDIANNESS()

#define GST_AUDIO_INFO_ENDIANNESS(i)         (GST_AUDIO_FORMAT_INFO_ENDIANNESS((i)->finfo))

GST_AUDIO_INFO_IS_BIG_ENDIAN()

#define GST_AUDIO_INFO_IS_BIG_ENDIAN(i)      (GST_AUDIO_FORMAT_INFO_IS_BIG_ENDIAN((i)->finfo))

GST_AUDIO_INFO_IS_FLOAT()

#define GST_AUDIO_INFO_IS_FLOAT(i)           (GST_AUDIO_FORMAT_INFO_IS_FLOAT((i)->finfo))

GST_AUDIO_INFO_IS_INTEGER()

#define GST_AUDIO_INFO_IS_INTEGER(i)         (GST_AUDIO_FORMAT_INFO_IS_INTEGER((i)->finfo))

GST_AUDIO_INFO_IS_LITTLE_ENDIAN()

#define GST_AUDIO_INFO_IS_LITTLE_ENDIAN(i)   (GST_AUDIO_FORMAT_INFO_IS_LITTLE_ENDIAN((i)->finfo))

GST_AUDIO_INFO_IS_SIGNED()

#define GST_AUDIO_INFO_IS_SIGNED(i)          (GST_AUDIO_FORMAT_INFO_IS_SIGNED((i)->finfo))

GST_AUDIO_INFO_IS_UNPOSITIONED()

#define GST_AUDIO_INFO_IS_UNPOSITIONED(info) ((info)->flags & GST_AUDIO_FLAG_UNPOSITIONED)

GST_AUDIO_INFO_IS_VALID()

#define GST_AUDIO_INFO_IS_VALID(i)           ((i)->finfo != NULL && (i)->rate > 0 && (i)->channels > 0 && (i)->bpf > 0)

GST_AUDIO_INFO_LAYOUT()

#define GST_AUDIO_INFO_LAYOUT(info)          ((info)->layout)

GST_FRAMES_TO_CLOCK_TIME()

#define             GST_FRAMES_TO_CLOCK_TIME(frames, rate)

Calculate clocktime from sample frames and rate .

GST_CLOCK_TIME_TO_FRAMES()

#define             GST_CLOCK_TIME_TO_FRAMES(clocktime, rate)

Calculate frames from clocktime and sample rate .

GST_AUDIO_NE()

# define GST_AUDIO_NE(s) G_STRINGIFY(s)"LE"

Turns audio format string s into the format string for native endianness.

GST_AUDIO_OE()

# define GST_AUDIO_OE(s) G_STRINGIFY(s)"BE"

Turns audio format string s into the format string for other endianness.

GST_AUDIO_CAPS_MAKE()

#define             GST_AUDIO_CAPS_MAKE(format)

Generic caps string for audio, for use in pad templates.

gst_audio_buffer_clip ()

GstBuffer *
gst_audio_buffer_clip (GstBuffer *buffer,
                       const GstSegment *segment,
                       gint rate,
                       gint bpf);

Clip the buffer to the given GstSegment.

After calling this function the caller does not own a reference to buffer anymore.

enum GstAudioFlags

Extra audio flags

enum GstAudioFormat

Enum value describing the most common audio formats.

enum GstAudioFormatFlags

The different audio flags that a format info can have.

struct GstAudioFormatInfo

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;
};

Information for an audio format.

struct GstAudioInfo

struct GstAudioInfo {
  const GstAudioFormatInfo *finfo;
  GstAudioFlags             flags;
  GstAudioLayout            layout;
  gint                      rate;
  gint                      channels;
  gint                      bpf;
  GstAudioChannelPosition   position[64];
};

Information describing audio properties. This information can be filled in from GstCaps with gst_audio_info_from_caps().

Use the provided macros to access the info in this structure.

enum GstAudioLayout

Layout of the audio samples for the different channels.

enum GstAudioPackFlags

The different flags that can be used when packing and unpacking.

GST_META_TAG_AUDIO_STR

#define GST_META_TAG_AUDIO_STR "audio"

This metadata is relevant for audio streams.

Since: 1.2

GST_META_TAG_AUDIO_CHANNELS_STR

#define GST_META_TAG_AUDIO_CHANNELS_STR "channels"

This metadata stays relevant as long as channels are unchanged.

Since: 1.2

GST_META_TAG_AUDIO_RATE_STR

#define GST_META_TAG_AUDIO_RATE_STR "rate"

This metadata stays relevant as long as sample rate is unchanged.

Since: 1.8

GST_AUDIO_RATE_RANGE

#define GST_AUDIO_RATE_RANGE "(int) [ 1, max ]"

Maximum range of allowed sample rates, for use in template caps strings.

GST_AUDIO_CHANNELS_RANGE

#define GST_AUDIO_CHANNELS_RANGE "(int) [ 1, max ]"

Maximum range of allowed channels, for use in template caps strings.

GST_AUDIO_FORMATS_ALL

#define             GST_AUDIO_FORMATS_ALL

List of all audio formats, for use in template caps strings.

GST_AUDIO_DEF_RATE

#define GST_AUDIO_DEF_RATE 44100

Standard sampling rate used in consumer audio.

GST_AUDIO_DEF_CHANNELS

#define GST_AUDIO_DEF_CHANNELS 2

Standard number of channels used in consumer audio.

GST_AUDIO_DEF_FORMAT

#define GST_AUDIO_DEF_FORMAT "S16LE"

Standard format used in consumer audio.