mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-23 16:50:47 +00:00
228 lines
9 KiB
C
228 lines
9 KiB
C
/* GStreamer
|
|
* Copyright (C) 2011 Mark Nauwelaerts <mark.nauwelaerts@collabora.co.uk>.
|
|
* Copyright (C) 2011 Nokia Corporation. All rights reserved.
|
|
* Contact: Stefan Kost <stefan.kost@nokia.com>
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Library General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Library General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Library General Public
|
|
* License along with this library; if not, write to the
|
|
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
* Boston, MA 02111-1307, USA.
|
|
*/
|
|
|
|
#ifndef __GST_BASE_AUDIO_ENCODER_H__
|
|
#define __GST_BASE_AUDIO_ENCODER_H__
|
|
|
|
#ifndef GST_USE_UNSTABLE_API
|
|
#warning "GstBaseAudioEncoder is unstable API and may change in future."
|
|
#warning "You can define GST_USE_UNSTABLE_API to avoid this warning."
|
|
#endif
|
|
|
|
#include <gst/gst.h>
|
|
#include <gst/audio/gstbaseaudioutils.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
#define GST_TYPE_BASE_AUDIO_ENCODER (gst_base_audio_encoder_get_type())
|
|
#define GST_BASE_AUDIO_ENCODER(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_BASE_AUDIO_ENCODER,GstBaseAudioEncoder))
|
|
#define GST_BASE_AUDIO_ENCODER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_BASE_AUDIO_ENCODER,GstBaseAudioEncoderClass))
|
|
#define GST_BASE_AUDIO_ENCODER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),GST_TYPE_BASE_AUDIO_ENCODER,GstBaseAudioEncoderClass))
|
|
#define GST_IS_BASE_AUDIO_ENCODER(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_BASE_AUDIO_ENCODER))
|
|
#define GST_IS_BASE_AUDIO_ENCODER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_BASE_AUDIO_ENCODER))
|
|
#define GST_BASE_AUDIO_ENCODER_CAST(obj) ((GstBaseAudioEncoder *)(obj))
|
|
|
|
/**
|
|
* GST_BASE_AUDIO_ENCODER_SINK_NAME:
|
|
*
|
|
* the name of the templates for the sink pad
|
|
*/
|
|
#define GST_BASE_AUDIO_ENCODER_SINK_NAME "sink"
|
|
/**
|
|
* GST_BASE_AUDIO_ENCODER_SRC_NAME:
|
|
*
|
|
* the name of the templates for the source pad
|
|
*/
|
|
#define GST_BASE_AUDIO_ENCODER_SRC_NAME "src"
|
|
|
|
/**
|
|
* GST_BASE_AUDIO_ENCODER_SRC_PAD:
|
|
* @obj: base parse instance
|
|
*
|
|
* Gives the pointer to the source #GstPad object of the element.
|
|
*
|
|
* Since: 0.10.x
|
|
*/
|
|
#define GST_BASE_AUDIO_ENCODER_SRC_PAD(obj) (GST_BASE_AUDIO_ENCODER_CAST (obj)->srcpad)
|
|
|
|
/**
|
|
* GST_BASE_AUDIO_ENCODER_SINK_PAD:
|
|
* @obj: base parse instance
|
|
*
|
|
* Gives the pointer to the sink #GstPad object of the element.
|
|
*
|
|
* Since: 0.10.x
|
|
*/
|
|
#define GST_BASE_AUDIO_ENCODER_SINK_PAD(obj) (GST_BASE_AUDIO_ENCODER_CAST (obj)->sinkpad)
|
|
|
|
/**
|
|
* GST_BASE_AUDIO_ENCODER_SEGMENT:
|
|
* @obj: base parse instance
|
|
*
|
|
* Gives the segment of the element.
|
|
*
|
|
* Since: 0.10.x
|
|
*/
|
|
#define GST_BASE_AUDIO_ENCODER_SEGMENT(obj) (GST_BASE_AUDIO_ENCODER_CAST (obj)->segment)
|
|
|
|
|
|
typedef struct _GstBaseAudioEncoder GstBaseAudioEncoder;
|
|
typedef struct _GstBaseAudioEncoderClass GstBaseAudioEncoderClass;
|
|
|
|
typedef struct _GstBaseAudioEncoderPrivate GstBaseAudioEncoderPrivate;
|
|
|
|
/**
|
|
* GstBaseAudioEncoder:
|
|
* @element: the parent element.
|
|
*
|
|
* The opaque #GstBaseAudioEncoder data structure.
|
|
*/
|
|
struct _GstBaseAudioEncoder {
|
|
GstElement element;
|
|
|
|
/*< protected >*/
|
|
/* source and sink pads */
|
|
GstPad *sinkpad;
|
|
GstPad *srcpad;
|
|
|
|
/* MT-protected (with STREAM_LOCK) */
|
|
GstSegment segment;
|
|
|
|
/*< private >*/
|
|
GstBaseAudioEncoderPrivate *priv;
|
|
gpointer _gst_reserved[GST_PADDING_LARGE];
|
|
};
|
|
|
|
/**
|
|
* GstBaseAudioEncoderClass:
|
|
* @start: Optional.
|
|
* Called when the element starts processing.
|
|
* Allows opening external resources.
|
|
* @stop: Optional.
|
|
* Called when the element stops processing.
|
|
* Allows closing external resources.
|
|
* @set_format: Notifies subclass of incoming data format.
|
|
* GstBaseAudioEncoderContext fields have already been
|
|
* set according to provided caps.
|
|
* @handle_frame: Provides input samples (or NULL to clear any remaining data)
|
|
* according to directions as provided by subclass in the
|
|
* #GstBaseAudioEncoderContext. Input data ref management
|
|
* is performed by base class, subclass should not care or
|
|
* intervene.
|
|
* @flush: Optional.
|
|
* Instructs subclass to clear any codec caches and discard
|
|
* any pending samples and not yet returned encoded data.
|
|
* @event: Optional.
|
|
* Event handler on the sink pad. This function should return
|
|
* TRUE if the event was handled and should be discarded
|
|
* (i.e. not unref'ed).
|
|
* @pre_push: Optional.
|
|
* Called just prior to pushing (encoded data) buffer downstream.
|
|
* Subclass has full discretionary access to buffer,
|
|
* and a not OK flow return will abort downstream pushing.
|
|
* @getcaps: Optional.
|
|
* Allows for a custom sink getcaps implementation (e.g.
|
|
* for multichannel input specification). If not implemented,
|
|
* default returns gst_base_audio_encoder_proxy_getcaps
|
|
* applied to sink template caps.
|
|
*
|
|
* Subclasses can override any of the available virtual methods or not, as
|
|
* needed. At minimum @set_format and @handle_frame needs to be overridden.
|
|
*/
|
|
struct _GstBaseAudioEncoderClass {
|
|
GstElementClass parent_class;
|
|
|
|
/*< public >*/
|
|
/* virtual methods for subclasses */
|
|
|
|
gboolean (*start) (GstBaseAudioEncoder *enc);
|
|
|
|
gboolean (*stop) (GstBaseAudioEncoder *enc);
|
|
|
|
gboolean (*set_format) (GstBaseAudioEncoder *enc,
|
|
GstAudioFormatInfo *info);
|
|
|
|
GstFlowReturn (*handle_frame) (GstBaseAudioEncoder *enc,
|
|
GstBuffer *buffer);
|
|
|
|
void (*flush) (GstBaseAudioEncoder *enc);
|
|
|
|
GstFlowReturn (*pre_push) (GstBaseAudioEncoder *enc,
|
|
GstBuffer **buffer);
|
|
|
|
gboolean (*event) (GstBaseAudioEncoder *enc,
|
|
GstEvent *event);
|
|
|
|
GstCaps * (*getcaps) (GstBaseAudioEncoder *enc);
|
|
|
|
/*< private >*/
|
|
gpointer _gst_reserved[GST_PADDING_LARGE];
|
|
};
|
|
|
|
GType gst_base_audio_encoder_get_type (void);
|
|
|
|
GstFlowReturn gst_base_audio_encoder_finish_frame (GstBaseAudioEncoder * enc,
|
|
GstBuffer *buffer, gint samples);
|
|
|
|
GstCaps * gst_base_audio_encoder_proxy_getcaps (GstBaseAudioEncoder * enc,
|
|
GstCaps * caps);
|
|
|
|
|
|
/* context parameters */
|
|
GstAudioFormatInfo * gst_base_audio_encoder_get_info (GstBaseAudioEncoder * enc);
|
|
|
|
gint gst_base_audio_encoder_get_frame_samples (GstBaseAudioEncoder * enc);
|
|
void gst_base_audio_encoder_set_frame_samples (GstBaseAudioEncoder * enc,
|
|
gint num);
|
|
|
|
gint gst_base_audio_encoder_get_frame_max (GstBaseAudioEncoder * enc);
|
|
void gst_base_audio_encoder_set_frame_max (GstBaseAudioEncoder * enc,
|
|
gint num);
|
|
|
|
gint gst_base_audio_encoder_get_lookahead (GstBaseAudioEncoder * enc);
|
|
void gst_base_audio_encoder_set_lookahead (GstBaseAudioEncoder * enc,
|
|
gint num);
|
|
|
|
void gst_base_audio_encoder_get_latency (GstBaseAudioEncoder * enc,
|
|
GstClockTime * min, GstClockTime * max);
|
|
void gst_base_audio_encoder_set_latency (GstBaseAudioEncoder * enc,
|
|
GstClockTime min, GstClockTime max);
|
|
|
|
/* object properties */
|
|
void gst_base_audio_encoder_set_mark_granule (GstBaseAudioEncoder * enc,
|
|
gboolean enabled);
|
|
gboolean gst_base_audio_encoder_get_mark_granule (GstBaseAudioEncoder * enc);
|
|
|
|
void gst_base_audio_encoder_set_perfect_timestamp (GstBaseAudioEncoder * enc,
|
|
gboolean enabled);
|
|
gboolean gst_base_audio_encoder_get_perfect_timestamp (GstBaseAudioEncoder * enc);
|
|
|
|
void gst_base_audio_encoder_set_hard_resync (GstBaseAudioEncoder * enc,
|
|
gboolean enabled);
|
|
gboolean gst_base_audio_encoder_get_hard_resync (GstBaseAudioEncoder * enc);
|
|
|
|
void gst_base_audio_encoder_set_tolerance (GstBaseAudioEncoder * enc,
|
|
gint64 tolerance);
|
|
gint64 gst_base_audio_encoder_get_tolerance (GstBaseAudioEncoder * enc);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __GST_BASE_AUDIO_ENCODER_H__ */
|