Blame docs/plugins/html/gst-plugins-base-plugins-audioresample.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>audioresample: GStreamer Base Plugins 1.0 Plugins 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 Plugins Reference Manual">
Packit 971217
<link rel="up" href="ch01.html" title="gst-plugins-base Elements">
Packit 971217
<link rel="prev" href="gst-plugins-base-plugins-audiorate.html" title="audiorate">
Packit 971217
<link rel="next" href="gst-plugins-base-plugins-audiotestsrc.html" title="audiotestsrc">
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
                  Object Hierarchy  | 
Packit 971217
                  Properties
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

audioresample

Packit 971217

audioresample

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Properties

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gint
Packit 971217
quality
Packit 971217
Read / Write / Construct
Packit 971217
Packit 971217
Packit 971217
guint
Packit 971217
sinc-filter-auto-threshold
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
GstAudioResamplerFilterMode
Packit 971217
sinc-filter-mode
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
GstAudioResamplerMethod
Packit 971217
resample-method
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
GstAudioResamplerFilterInterpolation
Packit 971217
sinc-filter-interpolation
Packit 971217
Read / Write
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
struct
Packit 971217
GstAudioResample
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Object Hierarchy

Packit 971217
    GObject
Packit 971217
    ╰── GInitiallyUnowned
Packit 971217
        ╰── GstObject
Packit 971217
            ╰── GstElement
Packit 971217
                ╰── GstBaseTransform
Packit 971217
                    ╰── GstAudioResample
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Description

Packit 971217

audioresample resamples raw audio buffers to different sample rates using

Packit 971217
a configurable windowing function to enhance quality.

Packit 971217

By default, the resampler uses a reduced sinc table, with cubic interpolation filling in

Packit 971217
the gaps. This ensures that the table does not become too big. However, the interpolation
Packit 971217
increases the CPU usage considerably. As an alternative, a full sinc table can be used.
Packit 971217
Doing so can drastically reduce CPU usage (4x faster with 44.1 -> 48 kHz conversions for
Packit 971217
example), at the cost of increased memory consumption, plus the sinc table takes longer
Packit 971217
to initialize when the element is created. A third mode exists, which uses the full table
Packit 971217
unless said table would become too large, in which case the interpolated one is used instead.

Packit 971217
Packit 971217

Example launch line

Packit 971217
Packit 971217
  
Packit 971217
    
Packit 971217
      
Packit 971217
        
1
Packit 971217
        
gst-launch-1.0 -v uridecodebin uri=file:///path/to/audio.ogg ! audioconvert ! audioresample ! audio/x-raw, rate=8000 ! autoaudiosink
Packit 971217
      
Packit 971217
    
Packit 971217
  
Packit 971217
Packit 971217
Packit 971217

Packit 971217
 Decode an audio file and downsample it to 8Khz and play sound.
Packit 971217
To create the Ogg/Vorbis file refer to the documentation of vorbisenc.
Packit 971217
This assumes there is an audio sink that will accept/handle 8kHz audio.

Packit 971217
Packit 971217
Packit 971217

Synopsis

Packit 971217
Packit 971217

Element Information

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

plugin

Packit 971217
Packit 971217
            audioresample
Packit 971217
          
Packit 971217
Packit 971217
Packit 971217

author

Packit 971217
Sebastian Dröge <sebastian.droege@collabora.co.uk>
Packit 971217
Packit 971217
Packit 971217

class

Packit 971217
Filter/Converter/Audio
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

Element Pads

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

name

Packit 971217
sink
Packit 971217
Packit 971217
Packit 971217

direction

Packit 971217
sink
Packit 971217
Packit 971217
Packit 971217

presence

Packit 971217
always
Packit 971217
Packit 971217
Packit 971217

details

Packit 971217
audio/x-raw, format=(string){ 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 }, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], layout=(string){ interleaved, non-interleaved }
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

name

Packit 971217
src
Packit 971217
Packit 971217
Packit 971217

direction

Packit 971217
source
Packit 971217
Packit 971217
Packit 971217

presence

Packit 971217
always
Packit 971217
Packit 971217
Packit 971217

details

Packit 971217
audio/x-raw, format=(string){ 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 }, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], layout=(string){ interleaved, non-interleaved }
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Functions

Packit 971217

Packit 971217
Packit 971217
Packit 971217

Types and Values

Packit 971217
Packit 971217

struct GstAudioResample

Packit 971217
struct GstAudioResample;
Packit 971217

Opaque data structure.

Packit 971217
Packit 971217
Packit 971217
Packit 971217

Property Details

Packit 971217
Packit 971217

The “quality” property

Packit 971217
  “quality”                  gint
Packit 971217

Resample quality with 0 being the lowest and 10 being the best.

Packit 971217

Flags: Read / Write / Construct

Packit 971217

Allowed values: [0,10]

Packit 971217

Default value: 4

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “sinc-filter-auto-threshold” property

Packit 971217
  “sinc-filter-auto-threshold” guint
Packit 971217

Memory usage threshold to use if sinc filter mode is AUTO, given in bytes.

Packit 971217

Flags: Read / Write

Packit 971217

Default value: 1048576

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “sinc-filter-mode” property

Packit 971217
  “sinc-filter-mode”         GstAudioResamplerFilterMode
Packit 971217

What sinc filter table mode to use.

Packit 971217

Flags: Read / Write

Packit 971217

Default value: GST_AUDIO_RESAMPLER_FILTER_MODE_AUTO

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “resample-method” property

Packit 971217
  “resample-method”          GstAudioResamplerMethod
Packit 971217

What resample method to use.

Packit 971217

Flags: Read / Write

Packit 971217

Default value: GST_AUDIO_RESAMPLER_METHOD_KAISER

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “sinc-filter-interpolation” property

Packit 971217
  “sinc-filter-interpolation” GstAudioResamplerFilterInterpolation
Packit 971217

How to interpolate the sinc filter table.

Packit 971217

Flags: Read / Write

Packit 971217

Default value: GST_AUDIO_RESAMPLER_FILTER_INTERPOLATION_CUBIC

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

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