|
Packit |
971217 |
|
|
Packit |
971217 |
<html>
|
|
Packit |
971217 |
<head>
|
|
Packit |
971217 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
Packit |
971217 |
<title>GstAudioEncoder: 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="GstAudioDecoder.html" title="GstAudioDecoder">
|
|
Packit |
971217 |
<link rel="next" href="GstAudioFilter.html" title="GstAudioFilter">
|
|
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 |
Implemented Interfaces |
|
|
Packit |
971217 |
Properties
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GstAudioEncoder
|
|
Packit |
971217 |
GstAudioEncoder — Base class for audio encoders
|
|
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 |
#define
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GST_AUDIO_ENCODER_SINK_PAD()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
#define
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GST_AUDIO_ENCODER_SRC_PAD()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
#define
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GST_AUDIO_ENCODER_INPUT_SEGMENT()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
#define
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GST_AUDIO_ENCODER_OUTPUT_SEGMENT()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
#define
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GST_AUDIO_ENCODER_STREAM_LOCK()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
#define
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GST_AUDIO_ENCODER_STREAM_UNLOCK()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GstFlowReturn
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_finish_frame ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GstBuffer *
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_allocate_output_buffer ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_get_allocator ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_output_format ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_negotiate ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GstAudioInfo *
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_get_audio_info ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_get_drainable ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gint
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_get_frame_max ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gint
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_get_frame_samples_min ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gint
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_get_frame_samples_max ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_get_hard_min ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_get_hard_resync ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_get_latency ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gint
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_get_lookahead ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_get_mark_granule ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_get_perfect_timestamp ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GstClockTime
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_get_tolerance ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GstCaps *
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_proxy_getcaps ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_drainable ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_frame_max ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_frame_samples_min ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_frame_samples_max ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_hard_min ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_hard_resync ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_headers ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_latency ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_lookahead ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_mark_granule ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_perfect_timestamp ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_tolerance ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_allocation_caps ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_merge_tags ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
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 |
gboolean
|
|
Packit |
971217 |
hard-resync
|
|
Packit |
971217 |
Read / Write
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean
|
|
Packit |
971217 |
mark-granule
|
|
Packit |
971217 |
Read
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean
|
|
Packit |
971217 |
perfect-timestamp
|
|
Packit |
971217 |
Read / Write
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gint64
|
|
Packit |
971217 |
tolerance
|
|
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 |
|
|
Packit |
971217 |
struct
|
|
Packit |
971217 |
GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
struct
|
|
Packit |
971217 |
GstAudioEncoderClass
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
#define
|
|
Packit |
971217 |
GST_AUDIO_ENCODER_SINK_NAME
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
#define
|
|
Packit |
971217 |
GST_AUDIO_ENCODER_SRC_NAME
|
|
Packit |
971217 |
|
|
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 |
╰── GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Implemented Interfaces
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GstAudioEncoder implements
|
|
Packit |
971217 |
GstPreset.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Includes
|
|
Packit |
971217 |
#include <gst/audio/gstaudioencoder.h>
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Description
|
|
Packit |
971217 |
This base class is for audio encoders turning raw audio samples into
|
|
Packit |
971217 |
encoded audio data.
|
|
Packit |
971217 |
GstAudioEncoder and subclass should cooperate as follows.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Configuration
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Initially, GstAudioEncoder calls start
|
|
Packit |
971217 |
when the encoder element
|
|
Packit |
971217 |
is activated, which allows subclass to perform any global setup.
|
|
Packit |
971217 |
GstAudioEncoder calls set_format
|
|
Packit |
971217 |
to inform subclass of the format
|
|
Packit |
971217 |
of input audio data that it is about to receive. Subclass should
|
|
Packit |
971217 |
setup for encoding and configure various base class parameters
|
|
Packit |
971217 |
appropriately, notably those directing desired input data handling.
|
|
Packit |
971217 |
While unlikely, it might be called more than once, if changing input
|
|
Packit |
971217 |
parameters require reconfiguration.
|
|
Packit |
971217 |
GstAudioEncoder calls stop
|
|
Packit |
971217 |
at end of all processing.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
As of configuration stage, and throughout processing, GstAudioEncoder
|
|
Packit |
971217 |
maintains various parameters that provide required context,
|
|
Packit |
971217 |
e.g. describing the format of input audio data.
|
|
Packit |
971217 |
Conversely, subclass can and should configure these context parameters
|
|
Packit |
971217 |
to inform base class of its expectation w.r.t. buffer handling.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Data processing
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Base class gathers input sample data (as directed by the context's
|
|
Packit |
971217 |
frame_samples and frame_max) and provides this to subclass' handle_frame
|
|
Packit |
971217 |
.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
If codec processing results in encoded data, subclass should call
|
|
Packit |
971217 |
gst_audio_encoder_finish_frame() to have encoded data pushed
|
|
Packit |
971217 |
downstream. Alternatively, it might also call
|
|
Packit |
971217 |
gst_audio_encoder_finish_frame() (with a NULL buffer and some number of
|
|
Packit |
971217 |
dropped samples) to indicate dropped (non-encoded) samples.
|
|
Packit |
971217 |
Just prior to actually pushing a buffer downstream,
|
|
Packit |
971217 |
it is passed to pre_push
|
|
Packit |
971217 |
.
|
|
Packit |
971217 |
During the parsing process GstAudioEncoderClass will handle both
|
|
Packit |
971217 |
srcpad and sinkpad events. Sink events will be passed to subclass
|
|
Packit |
971217 |
if event
|
|
Packit |
971217 |
callback has been provided.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Shutdown phase
|
|
Packit |
971217 |
|
|
Packit |
971217 |
to inform the subclass that data
|
|
Packit |
971217 |
parsing will be stopped.
|
|
Packit |
971217 |
Subclass is responsible for providing pad template caps for
|
|
Packit |
971217 |
source and sink pads. The pads need to be named "sink" and "src". It also
|
|
Packit |
971217 |
needs to set the fixed caps on srcpad, when the format is ensured. This
|
|
Packit |
971217 |
is typically when base class calls subclass' set_format
|
|
Packit |
971217 |
function, though
|
|
Packit |
971217 |
it might be delayed until calling gst_audio_encoder_finish_frame
|
|
Packit |
971217 |
.
|
|
Packit |
971217 |
In summary, above process should have subclass concentrating on
|
|
Packit |
971217 |
codec data processing while leaving other matters to base class,
|
|
Packit |
971217 |
such as most notably timestamp handling. While it may exert more control
|
|
Packit |
971217 |
in this area (see e.g. pre_push
|
|
Packit |
971217 |
), it is very much not recommended.
|
|
Packit |
971217 |
In particular, base class will either favor tracking upstream timestamps
|
|
Packit |
971217 |
(at the possible expense of jitter) or aim to arrange for a perfect stream of
|
|
Packit |
971217 |
output timestamps, depending on “perfect-timestamp”.
|
|
Packit |
971217 |
However, in the latter case, the input may not be so perfect or ideal, which
|
|
Packit |
971217 |
is handled as follows. An input timestamp is compared with the expected
|
|
Packit |
971217 |
timestamp as dictated by input sample stream and if the deviation is less
|
|
Packit |
971217 |
than “tolerance”, the deviation is discarded.
|
|
Packit |
971217 |
Otherwise, it is considered a discontuinity and subsequent output timestamp
|
|
Packit |
971217 |
is resynced to the new position after performing configured discontinuity
|
|
Packit |
971217 |
processing. In the non-perfect-timestamp case, an upstream variation
|
|
Packit |
971217 |
exceeding tolerance only leads to marking DISCONT on subsequent outgoing
|
|
Packit |
971217 |
(while timestamps are adjusted to upstream regardless of variation).
|
|
Packit |
971217 |
While DISCONT is also marked in the perfect-timestamp case, this one
|
|
Packit |
971217 |
optionally (see “hard-resync”)
|
|
Packit |
971217 |
performs some additional steps, such as clipping of (early) input samples
|
|
Packit |
971217 |
or draining all currently remaining input data, depending on the direction
|
|
Packit |
971217 |
of the discontuinity.
|
|
Packit |
971217 |
If perfect timestamps are arranged, it is also possible to request baseclass
|
|
Packit |
971217 |
(usually set by subclass) to provide additional buffer metadata (in OFFSET
|
|
Packit |
971217 |
and OFFSET_END) fields according to granule defined semantics currently
|
|
Packit |
971217 |
needed by oggmux. Specifically, OFFSET is set to granulepos (= sample count
|
|
Packit |
971217 |
including buffer) and OFFSET_END to corresponding timestamp (as determined
|
|
Packit |
971217 |
by same sample count and sample rate).
|
|
Packit |
971217 |
Things that subclass need to take care of:
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Provide pad templates
|
|
Packit |
971217 |
Set source pad caps when appropriate
|
|
Packit |
971217 |
Inform base class of buffer processing needs using context's
|
|
Packit |
971217 |
frame_samples and frame_bytes.
|
|
Packit |
971217 |
Set user-configurable properties to sane defaults for format and
|
|
Packit |
971217 |
implementing codec at hand, e.g. those controlling timestamp behaviour
|
|
Packit |
971217 |
and discontinuity processing.
|
|
Packit |
971217 |
Accept data in handle_frame
|
|
Packit |
971217 |
and provide encoded results to
|
|
Packit |
971217 |
gst_audio_encoder_finish_frame() .
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Functions
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GST_AUDIO_ENCODER_SINK_PAD()
|
|
Packit |
971217 |
#define GST_AUDIO_ENCODER_SINK_PAD(obj) (GST_AUDIO_ENCODER_CAST (obj)->sinkpad)
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Gives the pointer to the sink GstPad object of the element.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
obj
|
|
Packit |
971217 |
audio encoder instance
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GST_AUDIO_ENCODER_SRC_PAD()
|
|
Packit |
971217 |
#define GST_AUDIO_ENCODER_SRC_PAD(obj) (GST_AUDIO_ENCODER_CAST (obj)->srcpad)
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Gives the pointer to the source GstPad object of the element.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
obj
|
|
Packit |
971217 |
audio encoder instance
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GST_AUDIO_ENCODER_INPUT_SEGMENT()
|
|
Packit |
971217 |
#define GST_AUDIO_ENCODER_INPUT_SEGMENT(obj) (GST_AUDIO_ENCODER_CAST (obj)->input_segment)
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Gives the input segment of the element.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
obj
|
|
Packit |
971217 |
base parse instance
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GST_AUDIO_ENCODER_OUTPUT_SEGMENT()
|
|
Packit |
971217 |
#define GST_AUDIO_ENCODER_OUTPUT_SEGMENT(obj) (GST_AUDIO_ENCODER_CAST (obj)->output_segment)
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Gives the output segment of the element.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
obj
|
|
Packit |
971217 |
base parse instance
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GST_AUDIO_ENCODER_STREAM_LOCK()
|
|
Packit |
971217 |
#define GST_AUDIO_ENCODER_STREAM_LOCK(enc) g_rec_mutex_lock (&GST_AUDIO_ENCODER (enc)->stream_lock)
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GST_AUDIO_ENCODER_STREAM_UNLOCK()
|
|
Packit |
971217 |
#define GST_AUDIO_ENCODER_STREAM_UNLOCK(enc) g_rec_mutex_unlock (&GST_AUDIO_ENCODER (enc)->stream_lock)
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_finish_frame ()
|
|
Packit |
971217 |
GstFlowReturn
|
|
Packit |
971217 |
gst_audio_encoder_finish_frame (GstAudioEncoder *enc ,
|
|
Packit |
971217 |
GstBuffer *buffer ,
|
|
Packit |
971217 |
gint samples );
|
|
Packit |
971217 |
Collects encoded data and pushes encoded data downstream.
|
|
Packit |
971217 |
Source pad caps must be set when this is called.
|
|
Packit |
971217 |
If samples
|
|
Packit |
971217 |
< 0, then best estimate is all samples provided to encoder
|
|
Packit |
971217 |
(subclass) so far. buf
|
|
Packit |
971217 |
may be NULL, in which case next number of samples
|
|
Packit |
971217 |
|
|
Packit |
971217 |
are considered discarded, e.g. as a result of discontinuous transmission,
|
|
Packit |
971217 |
and a discontinuity is marked.
|
|
Packit |
971217 |
Note that samples received in gst_audio_encoder_handle_frame()
|
|
Packit |
971217 |
may be invalidated by a call to this function.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
buffer
|
|
Packit |
971217 |
encoded data
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
samples
|
|
Packit |
971217 |
number of samples (per channel) represented by encoded data
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Returns
|
|
Packit |
971217 |
a GstFlowReturn that should be escalated to caller (of caller)
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_allocate_output_buffer ()
|
|
Packit |
971217 |
GstBuffer *
|
|
Packit |
971217 |
gst_audio_encoder_allocate_output_buffer
|
|
Packit |
971217 |
(GstAudioEncoder *enc ,
|
|
Packit |
971217 |
gsize size );
|
|
Packit |
971217 |
Helper function that allocates a buffer to hold an encoded audio frame
|
|
Packit |
971217 |
for enc
|
|
Packit |
971217 |
's current output format.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
size
|
|
Packit |
971217 |
size of the buffer
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Returns
|
|
Packit |
971217 |
allocated buffer.
|
|
Packit |
971217 |
[transfer full]
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_get_allocator ()
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
gst_audio_encoder_get_allocator (GstAudioEncoder *enc ,
|
|
Packit |
971217 |
GstAllocator **allocator ,
|
|
Packit |
971217 |
GstAllocationParams *params );
|
|
Packit |
971217 |
Lets GstAudioEncoder sub-classes to know the memory allocator
|
|
Packit |
971217 |
|
|
Packit |
971217 |
used by the base class and its params
|
|
Packit |
971217 |
.
|
|
Packit |
971217 |
Unref the allocator
|
|
Packit |
971217 |
after use it.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
allocator
|
|
Packit |
971217 |
the GstAllocator
|
|
Packit |
971217 |
used.
|
|
Packit |
971217 |
[out][allow-none][transfer full]
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
params
|
|
Packit |
971217 |
the
|
|
Packit |
971217 |
GstAllocatorParams of allocator
|
|
Packit |
971217 |
.
|
|
Packit |
971217 |
[out][allow-none][transfer full]
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_output_format ()
|
|
Packit |
971217 |
gboolean
|
|
Packit |
971217 |
gst_audio_encoder_set_output_format (GstAudioEncoder *enc ,
|
|
Packit |
971217 |
GstCaps *caps );
|
|
Packit |
971217 |
Configure output caps on the srcpad of enc
|
|
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 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
caps
|
|
Packit |
971217 |
GstCaps.
|
|
Packit |
971217 |
[transfer none]
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Returns
|
|
Packit |
971217 |
TRUE on success.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_negotiate ()
|
|
Packit |
971217 |
gboolean
|
|
Packit |
971217 |
gst_audio_encoder_negotiate (GstAudioEncoder *enc );
|
|
Packit |
971217 |
Negotiate with downstream elements to currently configured GstCaps.
|
|
Packit |
971217 |
Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if
|
|
Packit |
971217 |
negotiate fails.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Returns
|
|
Packit |
971217 |
TRUE if the negotiation succeeded, else FALSE .
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_get_audio_info ()
|
|
Packit |
971217 |
GstAudioInfo *
|
|
Packit |
971217 |
gst_audio_encoder_get_audio_info (GstAudioEncoder *enc );
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Returns
|
|
Packit |
971217 |
a GstAudioInfo describing the input audio format
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_get_drainable ()
|
|
Packit |
971217 |
gboolean
|
|
Packit |
971217 |
gst_audio_encoder_get_drainable (GstAudioEncoder *enc );
|
|
Packit |
971217 |
Queries encoder drain handling.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Returns
|
|
Packit |
971217 |
TRUE if drainable handling is enabled.
|
|
Packit |
971217 |
MT safe.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_get_frame_max ()
|
|
Packit |
971217 |
gint
|
|
Packit |
971217 |
gst_audio_encoder_get_frame_max (GstAudioEncoder *enc );
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Returns
|
|
Packit |
971217 |
currently configured maximum handled frames
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_get_frame_samples_min ()
|
|
Packit |
971217 |
gint
|
|
Packit |
971217 |
gst_audio_encoder_get_frame_samples_min
|
|
Packit |
971217 |
(GstAudioEncoder *enc );
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Returns
|
|
Packit |
971217 |
currently minimum requested samples per frame
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_get_frame_samples_max ()
|
|
Packit |
971217 |
gint
|
|
Packit |
971217 |
gst_audio_encoder_get_frame_samples_max
|
|
Packit |
971217 |
(GstAudioEncoder *enc );
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Returns
|
|
Packit |
971217 |
currently maximum requested samples per frame
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_get_hard_min ()
|
|
Packit |
971217 |
gboolean
|
|
Packit |
971217 |
gst_audio_encoder_get_hard_min (GstAudioEncoder *enc );
|
|
Packit |
971217 |
Queries encoder hard minimum handling.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Returns
|
|
Packit |
971217 |
TRUE if hard minimum handling is enabled.
|
|
Packit |
971217 |
MT safe.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_get_hard_resync ()
|
|
Packit |
971217 |
gboolean
|
|
Packit |
971217 |
gst_audio_encoder_get_hard_resync (GstAudioEncoder *enc );
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_get_latency ()
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
gst_audio_encoder_get_latency (GstAudioEncoder *enc ,
|
|
Packit |
971217 |
GstClockTime *min ,
|
|
Packit |
971217 |
GstClockTime *max );
|
|
Packit |
971217 |
Sets the variables pointed to by min
|
|
Packit |
971217 |
and max
|
|
Packit |
971217 |
to the currently configured
|
|
Packit |
971217 |
latency.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
min
|
|
Packit |
971217 |
a pointer to storage to hold minimum latency.
|
|
Packit |
971217 |
[out][allow-none]
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
max
|
|
Packit |
971217 |
a pointer to storage to hold maximum latency.
|
|
Packit |
971217 |
[out][allow-none]
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_get_lookahead ()
|
|
Packit |
971217 |
gint
|
|
Packit |
971217 |
gst_audio_encoder_get_lookahead (GstAudioEncoder *enc );
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Returns
|
|
Packit |
971217 |
currently configured encoder lookahead
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_get_mark_granule ()
|
|
Packit |
971217 |
gboolean
|
|
Packit |
971217 |
gst_audio_encoder_get_mark_granule (GstAudioEncoder *enc );
|
|
Packit |
971217 |
Queries if the encoder will handle granule marking.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Returns
|
|
Packit |
971217 |
TRUE if granule marking is enabled.
|
|
Packit |
971217 |
MT safe.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_get_perfect_timestamp ()
|
|
Packit |
971217 |
gboolean
|
|
Packit |
971217 |
gst_audio_encoder_get_perfect_timestamp
|
|
Packit |
971217 |
(GstAudioEncoder *enc );
|
|
Packit |
971217 |
Queries encoder perfect timestamp behaviour.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Returns
|
|
Packit |
971217 |
TRUE if perfect timestamp setting enabled.
|
|
Packit |
971217 |
MT safe.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_get_tolerance ()
|
|
Packit |
971217 |
GstClockTime
|
|
Packit |
971217 |
gst_audio_encoder_get_tolerance (GstAudioEncoder *enc );
|
|
Packit |
971217 |
Queries current audio jitter tolerance threshold.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Returns
|
|
Packit |
971217 |
encoder audio jitter tolerance threshold.
|
|
Packit |
971217 |
MT safe.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_proxy_getcaps ()
|
|
Packit |
971217 |
GstCaps *
|
|
Packit |
971217 |
gst_audio_encoder_proxy_getcaps (GstAudioEncoder *enc ,
|
|
Packit |
971217 |
GstCaps *caps ,
|
|
Packit |
971217 |
GstCaps *filter );
|
|
Packit |
971217 |
Returns caps that express caps
|
|
Packit |
971217 |
(or sink template caps if caps
|
|
Packit |
971217 |
== NULL)
|
|
Packit |
971217 |
restricted to channel/rate combinations supported by downstream elements
|
|
Packit |
971217 |
(e.g. muxers).
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
caps
|
|
Packit |
971217 |
initial caps.
|
|
Packit |
971217 |
[allow-none]
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
filter
|
|
Packit |
971217 |
filter caps.
|
|
Packit |
971217 |
[allow-none]
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Returns
|
|
Packit |
971217 |
a GstCaps owned by caller.
|
|
Packit |
971217 |
[transfer full]
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_drainable ()
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
gst_audio_encoder_set_drainable (GstAudioEncoder *enc ,
|
|
Packit |
971217 |
gboolean enabled );
|
|
Packit |
971217 |
Configures encoder drain handling. If drainable, subclass might
|
|
Packit |
971217 |
be handed a NULL buffer to have it return any leftover encoded data.
|
|
Packit |
971217 |
Otherwise, it is not considered so capable and will only ever be passed
|
|
Packit |
971217 |
real data.
|
|
Packit |
971217 |
MT safe.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enabled
|
|
Packit |
971217 |
new state
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_frame_max ()
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
gst_audio_encoder_set_frame_max (GstAudioEncoder *enc ,
|
|
Packit |
971217 |
gint num );
|
|
Packit |
971217 |
Sets max number of frames accepted at once (assumed minimally 1).
|
|
Packit |
971217 |
Requires frame_samples_min
|
|
Packit |
971217 |
and frame_samples_max
|
|
Packit |
971217 |
to be the equal.
|
|
Packit |
971217 |
Note: This value will be reset to 0 every time before
|
|
Packit |
971217 |
GstAudioEncoder::set_format() is called.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
num
|
|
Packit |
971217 |
number of frames
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_frame_samples_min ()
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
gst_audio_encoder_set_frame_samples_min
|
|
Packit |
971217 |
(GstAudioEncoder *enc ,
|
|
Packit |
971217 |
gint num );
|
|
Packit |
971217 |
Sets number of samples (per channel) subclass needs to be handed,
|
|
Packit |
971217 |
at least or will be handed all available if 0.
|
|
Packit |
971217 |
If an exact number of samples is required, gst_audio_encoder_set_frame_samples_max()
|
|
Packit |
971217 |
must be called with the same number.
|
|
Packit |
971217 |
Note: This value will be reset to 0 every time before
|
|
Packit |
971217 |
GstAudioEncoder::set_format() is called.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
num
|
|
Packit |
971217 |
number of samples per frame
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_frame_samples_max ()
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
gst_audio_encoder_set_frame_samples_max
|
|
Packit |
971217 |
(GstAudioEncoder *enc ,
|
|
Packit |
971217 |
gint num );
|
|
Packit |
971217 |
Sets number of samples (per channel) subclass needs to be handed,
|
|
Packit |
971217 |
at most or will be handed all available if 0.
|
|
Packit |
971217 |
If an exact number of samples is required, gst_audio_encoder_set_frame_samples_min()
|
|
Packit |
971217 |
must be called with the same number.
|
|
Packit |
971217 |
Note: This value will be reset to 0 every time before
|
|
Packit |
971217 |
GstAudioEncoder::set_format() is called.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
num
|
|
Packit |
971217 |
number of samples per frame
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_hard_min ()
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
gst_audio_encoder_set_hard_min (GstAudioEncoder *enc ,
|
|
Packit |
971217 |
gboolean enabled );
|
|
Packit |
971217 |
Configures encoder hard minimum handling. If enabled, subclass
|
|
Packit |
971217 |
will never be handed less samples than it configured, which otherwise
|
|
Packit |
971217 |
might occur near end-of-data handling. Instead, the leftover samples
|
|
Packit |
971217 |
will simply be discarded.
|
|
Packit |
971217 |
MT safe.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enabled
|
|
Packit |
971217 |
new state
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_hard_resync ()
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
gst_audio_encoder_set_hard_resync (GstAudioEncoder *enc ,
|
|
Packit |
971217 |
gboolean enabled );
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_headers ()
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
gst_audio_encoder_set_headers (GstAudioEncoder *enc ,
|
|
Packit |
971217 |
GList *headers );
|
|
Packit |
971217 |
Set the codec headers to be sent downstream whenever requested.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
headers
|
|
Packit |
971217 |
a list of
|
|
Packit |
971217 |
GstBuffer containing the codec header.
|
|
Packit |
971217 |
[transfer full][element-type Gst.Buffer]
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_latency ()
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
gst_audio_encoder_set_latency (GstAudioEncoder *enc ,
|
|
Packit |
971217 |
GstClockTime min ,
|
|
Packit |
971217 |
GstClockTime max );
|
|
Packit |
971217 |
Sets encoder latency.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
min
|
|
Packit |
971217 |
minimum latency
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
max
|
|
Packit |
971217 |
maximum latency
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_lookahead ()
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
gst_audio_encoder_set_lookahead (GstAudioEncoder *enc ,
|
|
Packit |
971217 |
gint num );
|
|
Packit |
971217 |
Sets encoder lookahead (in units of input rate samples)
|
|
Packit |
971217 |
Note: This value will be reset to 0 every time before
|
|
Packit |
971217 |
GstAudioEncoder::set_format() is called.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
num
|
|
Packit |
971217 |
lookahead
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_mark_granule ()
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
gst_audio_encoder_set_mark_granule (GstAudioEncoder *enc ,
|
|
Packit |
971217 |
gboolean enabled );
|
|
Packit |
971217 |
Enable or disable encoder granule handling.
|
|
Packit |
971217 |
MT safe.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enabled
|
|
Packit |
971217 |
new state
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_perfect_timestamp ()
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
gst_audio_encoder_set_perfect_timestamp
|
|
Packit |
971217 |
(GstAudioEncoder *enc ,
|
|
Packit |
971217 |
gboolean enabled );
|
|
Packit |
971217 |
Enable or disable encoder perfect output timestamp preference.
|
|
Packit |
971217 |
MT safe.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enabled
|
|
Packit |
971217 |
new state
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_tolerance ()
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
gst_audio_encoder_set_tolerance (GstAudioEncoder *enc ,
|
|
Packit |
971217 |
GstClockTime tolerance );
|
|
Packit |
971217 |
Configures encoder audio jitter tolerance threshold.
|
|
Packit |
971217 |
MT safe.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
tolerance
|
|
Packit |
971217 |
new tolerance
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_set_allocation_caps ()
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
gst_audio_encoder_set_allocation_caps (GstAudioEncoder *enc ,
|
|
Packit |
971217 |
GstCaps *allocation_caps );
|
|
Packit |
971217 |
Sets a caps in allocation query which are different from the set
|
|
Packit |
971217 |
pad's caps. Use this function before calling
|
|
Packit |
971217 |
gst_audio_encoder_negotiate() . Setting to NULL the allocation
|
|
Packit |
971217 |
query will use the caps from the pad.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
allocation_caps
|
|
Packit |
971217 |
a GstCaps or NULL .
|
|
Packit |
971217 |
[allow-none]
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Since: 1.10
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_audio_encoder_merge_tags ()
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
gst_audio_encoder_merge_tags (GstAudioEncoder *enc ,
|
|
Packit |
971217 |
const GstTagList *tags ,
|
|
Packit |
971217 |
GstTagMergeMode mode );
|
|
Packit |
971217 |
Sets the audio encoder tags and how they should be merged with any
|
|
Packit |
971217 |
upstream stream tags. This will override any tags previously-set
|
|
Packit |
971217 |
with gst_audio_encoder_merge_tags() .
|
|
Packit |
971217 |
Note that this is provided for convenience, and the subclass is
|
|
Packit |
971217 |
not required to use this and can still do tag handling on its own.
|
|
Packit |
971217 |
MT safe.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enc
|
|
Packit |
971217 |
a GstAudioEncoder
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
tags
|
|
Packit |
971217 |
a GstTagList to merge, or NULL to unset
|
|
Packit |
971217 |
previously-set tags.
|
|
Packit |
971217 |
[allow-none]
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
mode
|
|
Packit |
971217 |
the GstTagMergeMode to use, usually GST_TAG_MERGE_REPLACE
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Types and Values
|
|
Packit |
971217 |
|
|
Packit |
971217 |
struct GstAudioEncoder
|
|
Packit |
971217 |
struct GstAudioEncoder;
|
|
Packit |
971217 |
The opaque GstAudioEncoder data structure.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
struct GstAudioEncoderClass
|
|
Packit |
971217 |
struct GstAudioEncoderClass {
|
|
Packit |
971217 |
GstElementClass element_class;
|
|
Packit |
971217 |
|
|
Packit |
971217 |
/* virtual methods for subclasses */
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean (*start) (GstAudioEncoder *enc);
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean (*stop) (GstAudioEncoder *enc);
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean (*set_format) (GstAudioEncoder *enc,
|
|
Packit |
971217 |
GstAudioInfo *info);
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GstFlowReturn (*handle_frame) (GstAudioEncoder *enc,
|
|
Packit |
971217 |
GstBuffer *buffer);
|
|
Packit |
971217 |
|
|
Packit |
971217 |
void (*flush) (GstAudioEncoder *enc);
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GstFlowReturn (*pre_push) (GstAudioEncoder *enc,
|
|
Packit |
971217 |
GstBuffer **buffer);
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean (*sink_event) (GstAudioEncoder *enc,
|
|
Packit |
971217 |
GstEvent *event);
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean (*src_event) (GstAudioEncoder *enc,
|
|
Packit |
971217 |
GstEvent *event);
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GstCaps * (*getcaps) (GstAudioEncoder *enc, GstCaps *filter);
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean (*open) (GstAudioEncoder *enc);
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean (*close) (GstAudioEncoder *enc);
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean (*negotiate) (GstAudioEncoder *enc);
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean (*decide_allocation) (GstAudioEncoder *enc, GstQuery *query);
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean (*propose_allocation) (GstAudioEncoder * enc,
|
|
Packit |
971217 |
GstQuery * query);
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean (*transform_meta) (GstAudioEncoder *enc, GstBuffer *outbuf,
|
|
Packit |
971217 |
GstMeta *meta, GstBuffer *inbuf);
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean (*sink_query) (GstAudioEncoder *encoder,
|
|
Packit |
971217 |
GstQuery *query);
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean (*src_query) (GstAudioEncoder *encoder,
|
|
Packit |
971217 |
GstQuery *query);
|
|
Packit |
971217 |
};
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Subclasses can override any of the available virtual methods or not, as
|
|
Packit |
971217 |
needed. At minimum set_format
|
|
Packit |
971217 |
and handle_frame
|
|
Packit |
971217 |
needs to be overridden.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Members
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GstElementClass element_class ;
|
|
Packit |
971217 |
The parent class structure
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
start ()
|
|
Packit |
971217 |
Optional.
|
|
Packit |
971217 |
Called when the element starts processing.
|
|
Packit |
971217 |
Allows opening external resources.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
stop ()
|
|
Packit |
971217 |
Optional.
|
|
Packit |
971217 |
Called when the element stops processing.
|
|
Packit |
971217 |
Allows closing external resources.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
set_format ()
|
|
Packit |
971217 |
Notifies subclass of incoming data format.
|
|
Packit |
971217 |
GstAudioInfo contains the format according to provided caps.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
handle_frame ()
|
|
Packit |
971217 |
Provides input samples (or NULL to clear any remaining data)
|
|
Packit |
971217 |
according to directions as configured by the subclass
|
|
Packit |
971217 |
using the API. Input data ref management is performed
|
|
Packit |
971217 |
by base class, subclass should not care or intervene,
|
|
Packit |
971217 |
and input data is only valid until next call to base class,
|
|
Packit |
971217 |
most notably a call to gst_audio_encoder_finish_frame() .
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
flush ()
|
|
Packit |
971217 |
Optional.
|
|
Packit |
971217 |
Instructs subclass to clear any codec caches and discard
|
|
Packit |
971217 |
any pending samples and not yet returned encoded data.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
pre_push ()
|
|
Packit |
971217 |
Optional.
|
|
Packit |
971217 |
Called just prior to pushing (encoded data) buffer downstream.
|
|
Packit |
971217 |
Subclass has full discretionary access to buffer,
|
|
Packit |
971217 |
and a not OK flow return will abort downstream pushing.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
sink_event ()
|
|
Packit |
971217 |
Optional.
|
|
Packit |
971217 |
Event handler on the sink pad. Subclasses should chain up to
|
|
Packit |
971217 |
the parent implementation to invoke the default handler.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
src_event ()
|
|
Packit |
971217 |
Optional.
|
|
Packit |
971217 |
Event handler on the src pad. Subclasses should chain up to
|
|
Packit |
971217 |
the parent implementation to invoke the default handler.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
getcaps ()
|
|
Packit |
971217 |
Optional.
|
|
Packit |
971217 |
Allows for a custom sink getcaps implementation (e.g.
|
|
Packit |
971217 |
for multichannel input specification). If not implemented,
|
|
Packit |
971217 |
default returns gst_audio_encoder_proxy_getcaps
|
|
Packit |
971217 |
applied to sink template caps.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
open ()
|
|
Packit |
971217 |
Optional.
|
|
Packit |
971217 |
Called when the element changes to GST_STATE_READY.
|
|
Packit |
971217 |
Allows opening external resources.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
close ()
|
|
Packit |
971217 |
Optional.
|
|
Packit |
971217 |
Called when the element changes to GST_STATE_NULL.
|
|
Packit |
971217 |
Allows closing external resources.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
negotiate ()
|
|
Packit |
971217 |
Optional.
|
|
Packit |
971217 |
Negotiate with downstream and configure buffer pools, etc.
|
|
Packit |
971217 |
Subclasses should chain up to the parent implementation to
|
|
Packit |
971217 |
invoke the default handler.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
decide_allocation ()
|
|
Packit |
971217 |
Optional.
|
|
Packit |
971217 |
Setup the allocation parameters for allocating output
|
|
Packit |
971217 |
buffers. The passed in query contains the result of the
|
|
Packit |
971217 |
downstream allocation query.
|
|
Packit |
971217 |
Subclasses should chain up to the parent implementation to
|
|
Packit |
971217 |
invoke the default handler.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
propose_allocation ()
|
|
Packit |
971217 |
Optional.
|
|
Packit |
971217 |
Propose buffer allocation parameters for upstream elements.
|
|
Packit |
971217 |
Subclasses should chain up to the parent implementation to
|
|
Packit |
971217 |
invoke the default handler.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
transform_meta ()
|
|
Packit |
971217 |
Optional. Transform the metadata on the input buffer to the
|
|
Packit |
971217 |
output buffer. By default this method copies all meta without
|
|
Packit |
971217 |
tags and meta with only the "audio" tag. subclasses can
|
|
Packit |
971217 |
implement this method and return TRUE if the metadata is to be
|
|
Packit |
971217 |
copied. Since 1.6
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
sink_query ()
|
|
Packit |
971217 |
Optional.
|
|
Packit |
971217 |
Query handler on the sink pad. This function should
|
|
Packit |
971217 |
return TRUE if the query could be performed. Subclasses
|
|
Packit |
971217 |
should chain up to the parent implementation to invoke the
|
|
Packit |
971217 |
default handler. Since 1.6
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
src_query ()
|
|
Packit |
971217 |
Optional.
|
|
Packit |
971217 |
Query handler on the source pad. This function should
|
|
Packit |
971217 |
return TRUE if the query could be performed. Subclasses
|
|
Packit |
971217 |
should chain up to the parent implementation to invoke the
|
|
Packit |
971217 |
default handler. Since 1.6
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GST_AUDIO_ENCODER_SINK_NAME
|
|
Packit |
971217 |
#define GST_AUDIO_ENCODER_SINK_NAME "sink"
|
|
Packit |
971217 |
|
|
Packit |
971217 |
the name of the templates for the sink pad
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GST_AUDIO_ENCODER_SRC_NAME
|
|
Packit |
971217 |
#define GST_AUDIO_ENCODER_SRC_NAME "src"
|
|
Packit |
971217 |
|
|
Packit |
971217 |
the name of the templates for the source pad
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Property Details
|
|
Packit |
971217 |
|
|
Packit |
971217 |
The “hard-resync” property
|
|
Packit |
971217 |
“hard-resync” gboolean
|
|
Packit |
971217 |
Perform clipping and sample flushing upon discontinuity.
|
|
Packit |
971217 |
Flags: Read / Write
|
|
Packit |
971217 |
Default value: FALSE
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
The “mark-granule” property
|
|
Packit |
971217 |
“mark-granule” gboolean
|
|
Packit |
971217 |
Apply granule semantics to buffer metadata (implies perfect-timestamp).
|
|
Packit |
971217 |
Flags: Read
|
|
Packit |
971217 |
Default value: FALSE
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
The “perfect-timestamp” property
|
|
Packit |
971217 |
“perfect-timestamp” gboolean
|
|
Packit |
971217 |
Favour perfect timestamps over tracking upstream timestamps.
|
|
Packit |
971217 |
Flags: Read / Write
|
|
Packit |
971217 |
Default value: FALSE
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
The “tolerance” property
|
|
Packit |
971217 |
“tolerance” gint64
|
|
Packit |
971217 |
Consider discontinuity if timestamp jitter/imperfection exceeds tolerance (ns).
|
|
Packit |
971217 |
Flags: Read / Write
|
|
Packit |
971217 |
Allowed values: >= 0
|
|
Packit |
971217 |
Default value: 40000000
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
See Also
|
|
Packit |
971217 |
GstBaseTransform
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Generated by GTK-Doc V1.27
|
|
Packit |
971217 |
</body>
|
|
Packit |
971217 |
</html>
|