Blame docs/libs/html/gst-plugins-base-libs-GstAudioConverter.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>GstAudioConverter: 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-Audio-channels.html" title="Audio-channels">
Packit 971217
<link rel="next" href="gst-plugins-base-libs-GstAudioQuantize.html" title="GstAudioQuantize">
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

GstAudioConverter

Packit 971217

GstAudioConverter

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
GstAudioConverter *
Packit 971217
Packit 971217
Packit 971217
gst_audio_converter_new ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
Packit 971217
Packit 971217
gst_audio_converter_free ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
Packit 971217
Packit 971217
gst_audio_converter_samples ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
Packit 971217
Packit 971217
gst_audio_converter_convert ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gsize
Packit 971217
Packit 971217
Packit 971217
gst_audio_converter_get_in_frames ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gsize
Packit 971217
Packit 971217
Packit 971217
gst_audio_converter_get_max_latency ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gsize
Packit 971217
Packit 971217
Packit 971217
gst_audio_converter_get_out_frames ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
Packit 971217
Packit 971217
gst_audio_converter_update_config ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
const GstStructure *
Packit 971217
Packit 971217
Packit 971217
gst_audio_converter_get_config ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
Packit 971217
Packit 971217
gst_audio_converter_reset ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
Packit 971217
Packit 971217
gst_audio_converter_supports_inplace ()
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
 
Packit 971217
GstAudioConverter
Packit 971217
Packit 971217
Packit 971217
enum
Packit 971217
GstAudioConverterFlags
Packit 971217
Packit 971217
Packit 971217
#define
Packit 971217
GST_AUDIO_CONVERTER_OPT_DITHER_METHOD
Packit 971217
Packit 971217
Packit 971217
#define
Packit 971217
GST_AUDIO_CONVERTER_OPT_NOISE_SHAPING_METHOD
Packit 971217
Packit 971217
Packit 971217
#define
Packit 971217
GST_AUDIO_CONVERTER_OPT_QUANTIZATION
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Includes

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

Description

Packit 971217
Packit 971217
Packit 971217

Functions

Packit 971217
Packit 971217

gst_audio_converter_new ()

Packit 971217
GstAudioConverter *
Packit 971217
gst_audio_converter_new (GstAudioConverterFlags flags,
Packit 971217
                         GstAudioInfo *in_info,
Packit 971217
                         GstAudioInfo *out_info,
Packit 971217
                         GstStructure *config);
Packit 971217

Create a new GstAudioConverter that is able to convert between in

Packit 971217
 and out
Packit 971217
Packit 971217
audio formats.

Packit 971217

config

Packit 971217
 contains extra configuration options, see GST_VIDEO_CONVERTER_OPT_*
Packit 971217
parameters for details about the options and values.

Packit 971217
Packit 971217

Parameters

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

flags

Packit 971217

extra GstAudioConverterFlags

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

in_info

Packit 971217

a source GstAudioInfo

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

out_info

Packit 971217

a destination GstAudioInfo

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

config

Packit 971217

a GstStructure with configuration options.

Packit 971217
[transfer full][nullable]
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

a GstAudioConverter or NULL if conversion is not possible.

Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_audio_converter_free ()

Packit 971217
void
Packit 971217
gst_audio_converter_free (GstAudioConverter *convert);
Packit 971217

Free a previously allocated convert

Packit 971217
 instance.

Packit 971217
Packit 971217

Parameters

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

convert

Packit 971217

a GstAudioConverter

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

Packit 971217
Packit 971217

gst_audio_converter_samples ()

Packit 971217
gboolean
Packit 971217
gst_audio_converter_samples (GstAudioConverter *convert,
Packit 971217
                             GstAudioConverterFlags flags,
Packit 971217
                             gpointer in[],
Packit 971217
                             gsize in_frames,
Packit 971217
                             gpointer out[],
Packit 971217
                             gsize out_frames);
Packit 971217

Perform the conversion with in_frames

Packit 971217
 in in
Packit 971217
 to out_frames
Packit 971217
 in out
Packit 971217
Packit 971217
using convert
Packit 971217
.

Packit 971217

In case the samples are interleaved, in

Packit 971217
 and out
Packit 971217
 must point to an
Packit 971217
array with a single element pointing to a block of interleaved samples.

Packit 971217

If non-interleaved samples are used, in

Packit 971217
 and out
Packit 971217
 must point to an
Packit 971217
array with pointers to memory blocks, one for each channel.

Packit 971217

in

Packit 971217
 may be NULL, in which case in_frames
Packit 971217
 of silence samples are processed
Packit 971217
by the converter.

Packit 971217

This function always produces out_frames

Packit 971217
 of output and consumes in_frames
Packit 971217
 of
Packit 971217
input. Use gst_audio_converter_get_out_frames() and
Packit 971217
gst_audio_converter_get_in_frames() to make sure in_frames
Packit 971217
 and out_frames
Packit 971217
Packit 971217
are matching and in
Packit 971217
 and out
Packit 971217
 point to enough memory.

Packit 971217
Packit 971217

Parameters

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

convert

Packit 971217

a GstAudioConverter

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

flags

Packit 971217

extra GstAudioConverterFlags

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

in

Packit 971217

input frames

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

in_frames

Packit 971217

number of input frames

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

out

Packit 971217

output frames

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

out_frames

Packit 971217

number of output frames

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

Returns

Packit 971217

TRUE is the conversion could be performed.

Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_audio_converter_convert ()

Packit 971217
gboolean
Packit 971217
gst_audio_converter_convert (GstAudioConverter *convert,
Packit 971217
                             GstAudioConverterFlags flags,
Packit 971217
                             gpointer in,
Packit 971217
                             gsize in_size,
Packit 971217
                             gpointer *out,
Packit 971217
                             gsize *out_size);
Packit 971217

Convenience wrapper around gst_audio_converter_samples(), which will

Packit 971217
perform allocation of the output buffer based on the result from
Packit 971217
gst_audio_converter_get_out_frames().

Packit 971217
Packit 971217

Parameters

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

flags

Packit 971217

extra GstAudioConverterFlags

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

in

Packit 971217

input data.

Packit 971217
[array length=in_size][element-type guint8]
Packit 971217
Packit 971217
Packit 971217

in_size

Packit 971217

size of in

Packit 971217

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

out

Packit 971217

a pointer where

Packit 971217
the output data will be written. 

Packit 971217
[out][array length=out_size][element-type guint8]
Packit 971217
Packit 971217
Packit 971217

out_size

Packit 971217

a pointer where the size of out

Packit 971217
will be written. 

Packit 971217
[out]
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

TRUE is the conversion could be performed.

Packit 971217
Packit 971217

Since: 1.14

Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_audio_converter_get_in_frames ()

Packit 971217
gsize
Packit 971217
gst_audio_converter_get_in_frames (GstAudioConverter *convert,
Packit 971217
                                   gsize out_frames);
Packit 971217

Calculate how many input frames are currently needed by convert

Packit 971217
 to produce
Packit 971217
out_frames
Packit 971217
 of output frames.

Packit 971217
Packit 971217

Parameters

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

convert

Packit 971217

a GstAudioConverter

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

out_frames

Packit 971217

number of output frames

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

Returns

Packit 971217

the number of input frames

Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_audio_converter_get_max_latency ()

Packit 971217
gsize
Packit 971217
gst_audio_converter_get_max_latency (GstAudioConverter *convert);
Packit 971217

Get the maximum number of input frames that the converter would

Packit 971217
need before producing output.

Packit 971217
Packit 971217

Parameters

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

convert

Packit 971217

a GstAudioConverter

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

Returns

Packit 971217

the latency of convert

Packit 971217
as expressed in the number of
Packit 971217
frames.

Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_audio_converter_get_out_frames ()

Packit 971217
gsize
Packit 971217
gst_audio_converter_get_out_frames (GstAudioConverter *convert,
Packit 971217
                                    gsize in_frames);
Packit 971217

Calculate how many output frames can be produced when in_frames

Packit 971217
 input
Packit 971217
frames are given to convert
Packit 971217
.

Packit 971217
Packit 971217

Parameters

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

convert

Packit 971217

a GstAudioConverter

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

in_frames

Packit 971217

number of input frames

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

Returns

Packit 971217

the number of output frames

Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_audio_converter_update_config ()

Packit 971217
gboolean
Packit 971217
gst_audio_converter_update_config (GstAudioConverter *convert,
Packit 971217
                                   gint in_rate,
Packit 971217
                                   gint out_rate,
Packit 971217
                                   GstStructure *config);
Packit 971217

Set in_rate

Packit 971217
, out_rate
Packit 971217
 and config
Packit 971217
 as extra configuration for convert
Packit 971217
.

Packit 971217

in_rate

Packit 971217
 and out_rate
Packit 971217
 specify the new sample rates of input and output
Packit 971217
formats. A value of 0 leaves the sample rate unchanged.

Packit 971217

config

Packit 971217
 can be NULL, in which case, the current configuration is not
Packit 971217
changed.

Packit 971217

If the parameters in config

Packit 971217
 can not be set exactly, this function returns
Packit 971217
FALSE and will try to update as much state as possible. The new state can
Packit 971217
then be retrieved and refined with gst_audio_converter_get_config().

Packit 971217

Look at the GST_AUDIO_CONVERTER_OPT_* fields to check valid configuration

Packit 971217
option and values.

Packit 971217
Packit 971217

Parameters

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

convert

Packit 971217

a GstAudioConverter

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

in_rate

Packit 971217

input rate

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

out_rate

Packit 971217

output rate

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

config

Packit 971217

a GstStructure or NULL.

Packit 971217
[transfer full][allow-none]
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

TRUE when the new parameters could be set

Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_audio_converter_get_config ()

Packit 971217
const GstStructure *
Packit 971217
gst_audio_converter_get_config (GstAudioConverter *convert,
Packit 971217
                                gint *in_rate,
Packit 971217
                                gint *out_rate);
Packit 971217

Get the current configuration of convert

Packit 971217
.

Packit 971217
Packit 971217

Parameters

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

convert

Packit 971217

a GstAudioConverter

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

in_rate

Packit 971217

result input rate.

Packit 971217
[out][optional]
Packit 971217
Packit 971217
Packit 971217

out_rate

Packit 971217

result output rate.

Packit 971217
[out][optional]
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

a GstStructure that remains valid for as long as convert

Packit 971217
is valid
Packit 971217
or until gst_audio_converter_update_config() is called. 

Packit 971217

[transfer none]

Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_audio_converter_reset ()

Packit 971217
void
Packit 971217
gst_audio_converter_reset (GstAudioConverter *convert);
Packit 971217

Reset convert

Packit 971217
 to the state it was when it was first created, clearing
Packit 971217
any history it might currently have.

Packit 971217
Packit 971217

Parameters

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

convert

Packit 971217

a GstAudioConverter

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

Packit 971217
Packit 971217

gst_audio_converter_supports_inplace ()

Packit 971217
gboolean
Packit 971217
gst_audio_converter_supports_inplace (GstAudioConverter *convert);
Packit 971217

Returns whether the audio converter can perform the conversion in-place.

Packit 971217
The return value would be typically input to gst_base_transform_set_in_place()

Packit 971217
Packit 971217

Parameters

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

convert

Packit 971217

a GstAudioConverter

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

Returns

Packit 971217

TRUE when the conversion can be done in place.

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Types and Values

Packit 971217
Packit 971217

GstAudioConverter

Packit 971217
typedef struct _GstAudioConverter GstAudioConverter;
Packit 971217
Packit 971217

Packit 971217
Packit 971217

enum GstAudioConverterFlags

Packit 971217

Extra flags passed to gst_audio_converter_new() and gst_audio_converter_samples().

Packit 971217
Packit 971217

Members

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

GST_AUDIO_CONVERTER_FLAG_NONE

Packit 971217
Packit 971217

no flag

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GST_AUDIO_CONVERTER_FLAG_IN_WRITABLE

Packit 971217
Packit 971217

the input sample arrays are writable and can be

Packit 971217
   used as temporary storage during conversion.

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GST_AUDIO_CONVERTER_FLAG_VARIABLE_RATE

Packit 971217
Packit 971217

allow arbitrary rate updates with

Packit 971217
   gst_audio_converter_update_config().

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

Packit 971217
Packit 971217

GST_AUDIO_CONVERTER_OPT_DITHER_METHOD

Packit 971217
#define GST_AUDIO_CONVERTER_OPT_DITHER_METHOD   "GstAudioConverter.dither-method"
Packit 971217
Packit 971217

GST_TYPE_AUDIO_DITHER_METHOD, The dither method to use when

Packit 971217
changing bit depth.
Packit 971217
Default is GST_AUDIO_DITHER_NONE.

Packit 971217
Packit 971217

Packit 971217
Packit 971217

GST_AUDIO_CONVERTER_OPT_NOISE_SHAPING_METHOD

Packit 971217
#define GST_AUDIO_CONVERTER_OPT_NOISE_SHAPING_METHOD   "GstAudioConverter.noise-shaping-method"
Packit 971217
Packit 971217

GST_TYPE_AUDIO_NOISE_SHAPING_METHOD, The noise shaping method to use

Packit 971217
to mask noise from quantization errors.
Packit 971217
Default is GST_AUDIO_NOISE_SHAPING_NONE.

Packit 971217
Packit 971217

Packit 971217
Packit 971217

GST_AUDIO_CONVERTER_OPT_QUANTIZATION

Packit 971217
#define GST_AUDIO_CONVERTER_OPT_QUANTIZATION   "GstAudioConverter.quantization"
Packit 971217
Packit 971217

G_TYPE_UINT, The quantization amount. Components will be

Packit 971217
quantized to multiples of this value.
Packit 971217
Default is 1

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

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