Blame docs/libs/html/gst-plugins-base-libs-GstAudioDownmixMeta.html

Packit 971217
Packit 971217
<html>
Packit 971217
<head>
Packit 971217
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit 971217
<title>GstAudioDownmixMeta: GStreamer Base Plugins 1.0 Library Reference Manual</title>
Packit 971217
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
Packit 971217
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Library Reference Manual">
Packit 971217
<link rel="up" href="gstreamer-audio.html" title="Audio Library">
Packit 971217
<link rel="prev" href="gst-plugins-base-libs-GstAudio.html" title="GstAudio">
Packit 971217
<link rel="next" href="GstAudioAggregator.html" title="GstAudioAggregator">
Packit 971217
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
Packit 971217
<link rel="stylesheet" href="style.css" type="text/css">
Packit 971217
</head>
Packit 971217
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit 971217
Packit 971217
Packit 971217
Top  | 
Packit 971217
                  Description
Packit 971217
Packit 971217
Home
Packit 971217
Up
Packit 971217
Prev
Packit 971217
Next
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

GstAudioDownmixMeta

Packit 971217

GstAudioDownmixMeta — Buffer metadata for audio downmix matrix handling

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Functions

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstAudioDownmixMeta *
Packit 971217
Packit 971217
Packit 971217
gst_buffer_add_audio_downmix_meta ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
#define
Packit 971217
Packit 971217
gst_buffer_get_audio_downmix_meta()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstAudioDownmixMeta *
Packit 971217
Packit 971217
Packit 971217
gst_buffer_get_audio_downmix_meta_for_channels ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstAudioClippingMeta *
Packit 971217
Packit 971217
Packit 971217
gst_buffer_add_audio_clipping_meta ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
#define
Packit 971217
Packit 971217
gst_buffer_get_audio_clipping_meta()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Types and Values

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
struct
Packit 971217
GstAudioDownmixMeta
Packit 971217
Packit 971217
Packit 971217
struct
Packit 971217
GstAudioClippingMeta
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Includes

Packit 971217
#include <gst/audio/gstaudiometa.h>
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Description

Packit 971217

GstAudioDownmixMeta defines an audio downmix matrix to be send along with

Packit 971217
audio buffers. These functions in this module help to create and attach the
Packit 971217
meta as well as extracting it.

Packit 971217
Packit 971217
Packit 971217

Functions

Packit 971217
Packit 971217

gst_buffer_add_audio_downmix_meta ()

Packit 971217
GstAudioDownmixMeta *
Packit 971217
gst_buffer_add_audio_downmix_meta (GstBuffer *buffer,
Packit 971217
                                   const GstAudioChannelPosition *from_position,
Packit 971217
                                   gint from_channels,
Packit 971217
                                   const GstAudioChannelPosition *to_position,
Packit 971217
                                   gint to_channels,
Packit 971217
                                   const gfloat **matrix);
Packit 971217

Attaches GstAudioDownmixMeta metadata to buffer

Packit 971217
 with the given parameters.

Packit 971217

matrix

Packit 971217
 is an two-dimensional array of to_channels
Packit 971217
 times from_channels
Packit 971217
Packit 971217
coefficients, i.e. the i-th output channels is constructed by multiplicating
Packit 971217
the input channels with the coefficients in matrix
Packit 971217
[i] and taking the sum
Packit 971217
of the results.

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

buffer

Packit 971217

a GstBuffer

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

from_position

Packit 971217

the channel positions

Packit 971217
of the source. 

Packit 971217
[array length=from_channels]
Packit 971217
Packit 971217
Packit 971217

from_channels

Packit 971217

The number of channels of the source

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

to_position

Packit 971217

the channel positions of

Packit 971217
the destination. 

Packit 971217
[array length=to_channels]
Packit 971217
Packit 971217
Packit 971217

to_channels

Packit 971217

The number of channels of the destination

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

matrix

Packit 971217

The matrix coefficients.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

the GstAudioDownmixMeta on buffer

Packit 971217
. 

Packit 971217

[transfer none]

Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_buffer_get_audio_downmix_meta()

Packit 971217
#define gst_buffer_get_audio_downmix_meta(b) ((GstAudioDownmixMeta*)gst_buffer_get_meta((b), GST_AUDIO_DOWNMIX_META_API_TYPE))
Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_buffer_get_audio_downmix_meta_for_channels ()

Packit 971217
GstAudioDownmixMeta *
Packit 971217
gst_buffer_get_audio_downmix_meta_for_channels
Packit 971217
                               (GstBuffer *buffer,
Packit 971217
                                const GstAudioChannelPosition *to_position,
Packit 971217
                                gint to_channels);
Packit 971217

Find the GstAudioDownmixMeta on buffer

Packit 971217
 for the given destination
Packit 971217
channel positions.

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

buffer

Packit 971217

a GstBuffer

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

to_position

Packit 971217

the channel positions of

Packit 971217
the destination. 

Packit 971217
[array length=to_channels]
Packit 971217
Packit 971217
Packit 971217

to_channels

Packit 971217

The number of channels of the destination

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

the GstAudioDownmixMeta on buffer

Packit 971217
. 

Packit 971217

[transfer none]

Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_buffer_add_audio_clipping_meta ()

Packit 971217
GstAudioClippingMeta *
Packit 971217
gst_buffer_add_audio_clipping_meta (GstBuffer *buffer,
Packit 971217
                                    GstFormat format,
Packit 971217
                                    guint64 start,
Packit 971217
                                    guint64 end);
Packit 971217

Attaches GstAudioClippingMeta metadata to buffer

Packit 971217
 with the given parameters.

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

buffer

Packit 971217

a GstBuffer

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

format

Packit 971217

GstFormat of start

Packit 971217
and stop
Packit 971217
, GST_FORMAT_DEFAULT is samples

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

start

Packit 971217

Amount of audio to clip from start of buffer

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

end

Packit 971217

Amount of to clip from end of buffer

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

the GstAudioClippingMeta on buffer

Packit 971217
. 

Packit 971217

[transfer none]

Packit 971217
Packit 971217

Since: 1.8

Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_buffer_get_audio_clipping_meta()

Packit 971217
#define gst_buffer_get_audio_clipping_meta(b) ((GstAudioClippingMeta*)gst_buffer_get_meta((b), GST_AUDIO_CLIPPING_META_API_TYPE))
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Types and Values

Packit 971217
Packit 971217

struct GstAudioDownmixMeta

Packit 971217
struct GstAudioDownmixMeta {
Packit 971217
  GstMeta      meta;
Packit 971217
Packit 971217
  GstAudioChannelPosition *from_position;
Packit 971217
  GstAudioChannelPosition *to_position;
Packit 971217
  gint        from_channels, to_channels;
Packit 971217
  gfloat       **matrix;
Packit 971217
};
Packit 971217
Packit 971217

Extra buffer metadata describing audio downmixing matrix. This metadata is

Packit 971217
attached to audio buffers and contains a matrix to downmix the buffer number
Packit 971217
of channels to channels
Packit 971217
.

Packit 971217

matrix

Packit 971217
 is an two-dimensional array of to_channels
Packit 971217
 times from_channels
Packit 971217
Packit 971217
coefficients, i.e. the i-th output channels is constructed by multiplicating
Packit 971217
the input channels with the coefficients in matrix
Packit 971217
[i] and taking the sum
Packit 971217
of the results.

Packit 971217
Packit 971217

Members

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

GstMeta meta;

Packit 971217

parent GstMeta

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GstAudioChannelPosition *from_position;

Packit 971217

the channel positions of the source

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GstAudioChannelPosition *to_position;

Packit 971217

the channel positions of the destination

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

gint from_channels;

Packit 971217

the number of channels of the source

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

gint to_channels;

Packit 971217

the number of channels of the destination

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

gfloat **matrix;

Packit 971217

the matrix coefficients.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

struct GstAudioClippingMeta

Packit 971217
struct GstAudioClippingMeta {
Packit 971217
  GstMeta   meta;
Packit 971217
Packit 971217
  GstFormat format;
Packit 971217
  guint64   start;
Packit 971217
  guint64   end;
Packit 971217
};
Packit 971217
Packit 971217

Extra buffer metadata describing how much audio has to be clipped from

Packit 971217
the start or end of a buffer. This is used for compressed formats, where
Packit 971217
the first frame usually has some additional samples due to encoder and
Packit 971217
decoder delays, and the last frame usually has some additional samples to
Packit 971217
be able to fill the complete last frame.

Packit 971217

This is used to ensure that decoded data in the end has the same amount of

Packit 971217
samples, and multiply decoded streams can be gaplessly concatenated.

Packit 971217

Note: If clipping of the start is done by adjusting the segment, this meta

Packit 971217
has to be dropped from buffers as otherwise clipping could happen twice.

Packit 971217
Packit 971217

Members

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

GstMeta meta;

Packit 971217

parent GstMeta

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GstFormat format;

Packit 971217

GstFormat of start

Packit 971217
and stop
Packit 971217
, GST_FORMAT_DEFAULT is samples

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

guint64 start;

Packit 971217

Amount of audio to clip from start of buffer

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

guint64 end;

Packit 971217

Amount of to clip from end of buffer

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Since: 1.8

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Generated by GTK-Doc V1.27
Packit 971217
</body>
Packit 971217
</html>