Blame docs/plugins/html/gst-plugins-base-plugins-rawaudioparse.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>rawaudioparse: 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-playsink.html" title="playsink">
Packit 971217
<link rel="next" href="gst-plugins-base-plugins-rawvideoparse.html" title="rawvideoparse">
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

rawaudioparse

Packit 971217

rawaudioparse

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
Packit 971217
GValueArray *
Packit 971217
channel-positions
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
GstRawAudioParseFormat
Packit 971217
format
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
interleaved
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
gint
Packit 971217
num-channels
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
GstAudioFormat
Packit 971217
pcm-format
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
gint
Packit 971217
sample-rate
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
GstRawAudioParse
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
                ╰── GstBaseParse
Packit 971217
                    ╰── GstRawBaseParse
Packit 971217
                        ╰── GstRawAudioParse
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Description

Packit 971217

This element parses incoming data as raw audio samples and timestamps it.

Packit 971217
It also handles seek queries in said raw audio data, and ensures that output
Packit 971217
buffers contain an integer number of samples, even if the input buffers don't.
Packit 971217
For example, with sample format S16LE and 2 channels, an input buffer of 411
Packit 971217
bytes contains 102.75 samples. rawaudioparse will then output 102 samples
Packit 971217
(= 408 bytes) and keep the remaining 3 bytes. These will then be prepended to
Packit 971217
the next input data.

Packit 971217

The element implements the properties and sink caps configuration as specified

Packit 971217
in the GstRawBaseParse documentation. The properties configuration can be
Packit 971217
modified by using the sample-rate, num-channels, channel-positions, format,
Packit 971217
and pcm-format properties.

Packit 971217

Currently, this parser supports raw data in a-law, mu-law, or linear PCM format.

Packit 971217

To facilitate operation with the unalignedaudioparse element, rawaudioparse

Packit 971217
supports the "audio/x-unaligned-raw" media type. This is treated identically to
Packit 971217
"audio/x-raw", except that it is used by source elements which do not guarantee
Packit 971217
that the buffers they push out are timestamped and contain an integer amount of
Packit 971217
samples (see the 411 bytes example above). By using a different media type, it
Packit 971217
is guaranteed that unalignedaudioparse is autoplugged, making sure that the
Packit 971217
autoplugged chain does not push unparsed content downstream. The source caps'
Packit 971217
media type with linear PCM data is always "audio/x-raw", even if the sink caps
Packit 971217
use "audio/x-unaligned-raw".

Packit 971217

The channel-positions property can be used to set explicit position information

Packit 971217
for each channel. If the array that is passed to this property does not match
Packit 971217
the number of channels indicated by num-channels, then said number of channels
Packit 971217
is updated to the array length. If channel-positions is NULL, then the default
Packit 971217
GStreamer positioning is used. This property is also useful for swapping left
Packit 971217
and right in a stereo signal for example.

Packit 971217
Packit 971217

Example pipelines

Packit 971217
Packit 971217
  
Packit 971217
    
Packit 971217
      
Packit 971217
        
1
Packit 971217
2
Packit 971217
        
gst-launch-1.0 souphttpsrc http://my-dlna-server/track.l16 \
Packit 971217
    rawaudioparse ! audioconvert ! audioresample ! autoaudiosink
Packit 971217
      
Packit 971217
    
Packit 971217
  
Packit 971217
Packit 971217
Packit 971217

Packit 971217
 Receive L16 data from a DLNA server, parse and timestamp it with
Packit 971217
rawaudioparse, and play it. use-sink-caps is set to true since souphttpsrc
Packit 971217
will set its source pad's caps to audio/x-unaligned-raw for the L16 stream.

Packit 971217
Packit 971217
  
Packit 971217
    
Packit 971217
      
Packit 971217
        
1
Packit 971217
2
Packit 971217
3
Packit 971217
        
gst-launch-1.0 filesrc location=audio.raw ! rawaudioparse use-sink-caps=false \
Packit 971217
        format=pcm pcm-format=s16le sample-rate=48000 num-channels=2 \
Packit 971217
        audioconvert ! audioresample ! autoaudiosink
Packit 971217
      
Packit 971217
    
Packit 971217
  
Packit 971217
Packit 971217
Packit 971217

Packit 971217
 Read raw data from a local file and parse it as PCM data with 48000 Hz sample
Packit 971217
rate, signed 16 bit integer samples, and 2 channels. use-sink-caps is set to
Packit 971217
false to ensure the property information is used and the parser does not expect
Packit 971217
audio/x-raw or audio/x-unaligned-raw caps.

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
            rawparse
Packit 971217
          
Packit 971217
Packit 971217
Packit 971217

author

Packit 971217
Carlos Rafael Giani <dv@pseudoterminal.org>
Packit 971217
Packit 971217
Packit 971217

class

Packit 971217
Codec/Parser/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-unaligned-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
 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
 audio/x-alaw, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]
Packit 971217
Packit 971217
Packit 971217

Packit 971217
 audio/x-mulaw, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]
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
 audio/x-alaw, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]
Packit 971217
Packit 971217
Packit 971217

Packit 971217
 audio/x-mulaw, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]
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 GstRawAudioParse

Packit 971217
struct GstRawAudioParse;
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Property Details

Packit 971217
Packit 971217

The “channel-positions” property

Packit 971217
  “channel-positions”        GValueArray *
Packit 971217

Channel positions used on the output.

Packit 971217

Flags: Read / Write

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “format” property

Packit 971217
  “format”                   GstRawAudioParseFormat
Packit 971217

Format of the raw audio stream.

Packit 971217

Flags: Read / Write

Packit 971217

Default value: PCM

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “interleaved” property

Packit 971217
  “interleaved”              gboolean
Packit 971217

True if audio has interleaved layout.

Packit 971217

Flags: Read / Write

Packit 971217

Default value: TRUE

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “num-channels” property

Packit 971217
  “num-channels”             gint
Packit 971217

Number of channels in raw stream.

Packit 971217

Flags: Read / Write

Packit 971217

Allowed values: >= 1

Packit 971217

Default value: 2

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “pcm-format” property

Packit 971217
  “pcm-format”               GstAudioFormat
Packit 971217

Format of audio samples in PCM stream (ignored if format property is not set to pcm).

Packit 971217

Flags: Read / Write

Packit 971217

Default value: GST_AUDIO_FORMAT_UNKNOWN

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “sample-rate” property

Packit 971217
  “sample-rate”              gint
Packit 971217

Rate of audio samples in raw stream.

Packit 971217

Flags: Read / Write

Packit 971217

Allowed values: >= 1

Packit 971217

Default value: 44100

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

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