mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-03 15:06:34 +00:00
344 lines
12 KiB
C
344 lines
12 KiB
C
/* GStreamer
|
|
* Copyright (C) 2008 David Schleef <ds@schleef.org>
|
|
* 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>
|
|
* Copyright (C) 2012 Collabora Ltd.
|
|
* Author : Edward Hervey <edward@collabora.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_VIDEO_DECODER_H_
|
|
#define _GST_VIDEO_DECODER_H_
|
|
|
|
#include <gst/base/gstadapter.h>
|
|
#include <gst/video/video.h>
|
|
#include <gst/video/gstvideoutils.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
#define GST_TYPE_VIDEO_DECODER \
|
|
(gst_video_decoder_get_type())
|
|
#define GST_VIDEO_DECODER(obj) \
|
|
(G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_VIDEO_DECODER,GstVideoDecoder))
|
|
#define GST_VIDEO_DECODER_CLASS(klass) \
|
|
(G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_VIDEO_DECODER,GstVideoDecoderClass))
|
|
#define GST_VIDEO_DECODER_GET_CLASS(obj) \
|
|
(G_TYPE_INSTANCE_GET_CLASS((obj),GST_TYPE_VIDEO_DECODER,GstVideoDecoderClass))
|
|
#define GST_IS_VIDEO_DECODER(obj) \
|
|
(G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_VIDEO_DECODER))
|
|
#define GST_IS_VIDEO_DECODER_CLASS(obj) \
|
|
(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_VIDEO_DECODER))
|
|
|
|
/**
|
|
* GST_VIDEO_DECODER_SINK_NAME:
|
|
*
|
|
* The name of the templates for the sink pad.
|
|
*/
|
|
#define GST_VIDEO_DECODER_SINK_NAME "sink"
|
|
/**
|
|
* GST_VIDEO_DECODER_SRC_NAME:
|
|
*
|
|
* The name of the templates for the source pad.
|
|
*/
|
|
#define GST_VIDEO_DECODER_SRC_NAME "src"
|
|
|
|
/**
|
|
* GST_VIDEO_DECODER_SRC_PAD:
|
|
* @obj: a #GstVideoDecoder
|
|
*
|
|
* Gives the pointer to the source #GstPad object of the element.
|
|
*/
|
|
#define GST_VIDEO_DECODER_SRC_PAD(obj) (((GstVideoDecoder *) (obj))->srcpad)
|
|
|
|
/**
|
|
* GST_VIDEO_DECODER_SINK_PAD:
|
|
* @obj: a #GstVideoDecoder
|
|
*
|
|
* Gives the pointer to the sink #GstPad object of the element.
|
|
*/
|
|
#define GST_VIDEO_DECODER_SINK_PAD(obj) (((GstVideoDecoder *) (obj))->sinkpad)
|
|
/**
|
|
* GST_VIDEO_DECODER_FLOW_NEED_DATA:
|
|
*
|
|
* Returned while parsing to indicate more data is needed.
|
|
**/
|
|
#define GST_VIDEO_DECODER_FLOW_NEED_DATA GST_FLOW_CUSTOM_SUCCESS
|
|
|
|
/**
|
|
* GST_VIDEO_DECODER_INPUT_SEGMENT:
|
|
* @obj: base decoder instance
|
|
*
|
|
* Gives the segment of the element.
|
|
*/
|
|
#define GST_VIDEO_DECODER_INPUT_SEGMENT(obj) (GST_VIDEO_DECODER_CAST (obj)->input_segment)
|
|
|
|
/**
|
|
* GST_VIDEO_DECODER_OUTPUT_SEGMENT:
|
|
* @obj: base decoder instance
|
|
*
|
|
* Gives the segment of the element.
|
|
*/
|
|
#define GST_VIDEO_DECODER_OUTPUT_SEGMENT(obj) (GST_VIDEO_DECODER_CAST (obj)->output_segment)
|
|
|
|
/**
|
|
* GST_VIDEO_DECODER_STREAM_LOCK:
|
|
* @decoder: video decoder instance
|
|
*
|
|
* Obtain a lock to protect the decoder function from concurrent access.
|
|
*/
|
|
#define GST_VIDEO_DECODER_STREAM_LOCK(decoder) g_rec_mutex_lock (&GST_VIDEO_DECODER (decoder)->stream_lock)
|
|
|
|
/**
|
|
* GST_VIDEO_DECODER_STREAM_UNLOCK:
|
|
* @decoder: video decoder instance
|
|
*
|
|
* Release the lock that protects the decoder function from concurrent access.
|
|
*/
|
|
#define GST_VIDEO_DECODER_STREAM_UNLOCK(decoder) g_rec_mutex_unlock (&GST_VIDEO_DECODER (decoder)->stream_lock)
|
|
|
|
typedef struct _GstVideoDecoder GstVideoDecoder;
|
|
typedef struct _GstVideoDecoderClass GstVideoDecoderClass;
|
|
typedef struct _GstVideoDecoderPrivate GstVideoDecoderPrivate;
|
|
|
|
|
|
/* do not use this one, use macro below */
|
|
GstFlowReturn _gst_video_decoder_error (GstVideoDecoder *dec, gint weight,
|
|
GQuark domain, gint code,
|
|
gchar *txt, gchar *debug,
|
|
const gchar *file, const gchar *function,
|
|
gint line);
|
|
|
|
/**
|
|
* GST_VIDEO_DECODER_ERROR:
|
|
* @el: the base video decoder element that generates the error
|
|
* @weight: element defined weight of the error, added to error count
|
|
* @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #gstreamer-GstGError)
|
|
* @code: error code defined for that domain (see #gstreamer-GstGError)
|
|
* @text: the message to display (format string and args enclosed in
|
|
* parentheses)
|
|
* @debug: debugging information for the message (format string and args
|
|
* enclosed in parentheses)
|
|
* @ret: variable to receive return value
|
|
*
|
|
* Utility function that video decoder elements can use in case they encountered
|
|
* a data processing error that may be fatal for the current "data unit" but
|
|
* need not prevent subsequent decoding. Such errors are counted and if there
|
|
* are too many, as configured in the context's max_errors, the pipeline will
|
|
* post an error message and the application will be requested to stop further
|
|
* media processing. Otherwise, it is considered a "glitch" and only a warning
|
|
* is logged. In either case, @ret is set to the proper value to
|
|
* return to upstream/caller (indicating either GST_FLOW_ERROR or GST_FLOW_OK).
|
|
*/
|
|
#define GST_VIDEO_DECODER_ERROR(el, w, domain, code, text, debug, ret) \
|
|
G_STMT_START { \
|
|
gchar *__txt = _gst_element_error_printf text; \
|
|
gchar *__dbg = _gst_element_error_printf debug; \
|
|
GstVideoDecoder *dec = GST_VIDEO_DECODER (el); \
|
|
ret = _gst_video_decoder_error (dec, w, GST_ ## domain ## _ERROR, \
|
|
GST_ ## domain ## _ERROR_ ## code, __txt, __dbg, __FILE__, \
|
|
GST_FUNCTION, __LINE__); \
|
|
} G_STMT_END
|
|
|
|
/**
|
|
* GST_VIDEO_DECODER_MAX_ERRORS:
|
|
*
|
|
* Default maximum number of errors tolerated before signaling error.
|
|
*/
|
|
#define GST_VIDEO_DECODER_MAX_ERRORS 10
|
|
|
|
|
|
/**
|
|
* GstVideoDecoder:
|
|
*
|
|
* The opaque #GstVideoDecoder data structure.
|
|
*/
|
|
struct _GstVideoDecoder
|
|
{
|
|
/*< private >*/
|
|
GstElement element;
|
|
|
|
/*< protected >*/
|
|
GstPad *sinkpad;
|
|
GstPad *srcpad;
|
|
|
|
/* protects all data processing, i.e. is locked
|
|
* in the chain function, finish_frame and when
|
|
* processing serialized events */
|
|
GRecMutex stream_lock;
|
|
|
|
/* MT-protected (with STREAM_LOCK) */
|
|
GstSegment input_segment;
|
|
GstSegment output_segment;
|
|
|
|
GstVideoDecoderPrivate *priv;
|
|
|
|
/* FIXME before moving to base */
|
|
void *padding[GST_PADDING_LARGE];
|
|
};
|
|
|
|
/**
|
|
* GstVideoDecoderClass:
|
|
* @open: Optional.
|
|
* Called when the element changes to GST_STATE_READY.
|
|
* Allows opening external resources.
|
|
* @close: Optional.
|
|
* Called when the element changes to GST_STATE_NULL.
|
|
* Allows closing external resources.
|
|
* @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 (caps).
|
|
* @parse: Required for non-packetized input.
|
|
* Allows chopping incoming data into manageable units (frames)
|
|
* for subsequent decoding.
|
|
* @reset: Optional.
|
|
* Allows subclass (decoder) to perform post-seek semantics reset.
|
|
* @handle_frame: Provides input data frame to subclass.
|
|
* @finish: Optional.
|
|
* Called to request subclass to dispatch any pending remaining
|
|
* data (e.g. at EOS).
|
|
* @sink_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).
|
|
* @src_event: Optional.
|
|
* Event handler on the source pad. This function should return
|
|
* TRUE if the event was handled and should be discarded
|
|
* (i.e. not unref'ed).
|
|
* @decide_allocation: Optional.
|
|
* Setup the allocation parameters for allocating output
|
|
* buffers. The passed in query contains the result of the
|
|
* downstream allocation query.
|
|
* @propose_allocation: Optional.
|
|
* Propose buffer allocation parameters for upstream elements.
|
|
*
|
|
* Subclasses can override any of the available virtual methods or not, as
|
|
* needed. At minimum @handle_frame needs to be overridden, and @set_format
|
|
* and likely as well. If non-packetized input is supported or expected,
|
|
* @parse needs to be overridden as well.
|
|
*/
|
|
struct _GstVideoDecoderClass
|
|
{
|
|
/*< private >*/
|
|
GstElementClass element_class;
|
|
|
|
/*< public >*/
|
|
gboolean (*open) (GstVideoDecoder *decoder);
|
|
|
|
gboolean (*close) (GstVideoDecoder *decoder);
|
|
|
|
gboolean (*start) (GstVideoDecoder *decoder);
|
|
|
|
gboolean (*stop) (GstVideoDecoder *decoder);
|
|
|
|
GstFlowReturn (*parse) (GstVideoDecoder *decoder,
|
|
GstVideoCodecFrame *frame,
|
|
GstAdapter *adapter,
|
|
gboolean at_eos);
|
|
|
|
gboolean (*set_format) (GstVideoDecoder *decoder,
|
|
GstVideoCodecState * state);
|
|
|
|
gboolean (*reset) (GstVideoDecoder *decoder,
|
|
gboolean hard);
|
|
|
|
GstFlowReturn (*finish) (GstVideoDecoder *decoder);
|
|
|
|
GstFlowReturn (*handle_frame) (GstVideoDecoder *decoder,
|
|
GstVideoCodecFrame *frame);
|
|
|
|
gboolean (*sink_event) (GstVideoDecoder *decoder,
|
|
GstEvent *event);
|
|
|
|
gboolean (*src_event) (GstVideoDecoder *decoder,
|
|
GstEvent *event);
|
|
|
|
gboolean (*decide_allocation) (GstVideoDecoder *decoder, GstQuery *query);
|
|
|
|
gboolean (*propose_allocation) (GstVideoDecoder *decoder, GstQuery * query);
|
|
|
|
/*< private >*/
|
|
/* FIXME before moving to base */
|
|
void *padding[GST_PADDING_LARGE];
|
|
};
|
|
|
|
GType gst_video_decoder_get_type (void);
|
|
|
|
/* Context parameters */
|
|
void gst_video_decoder_set_packetized (GstVideoDecoder * decoder,
|
|
gboolean packetized);
|
|
|
|
gboolean gst_video_decoder_get_packetized (GstVideoDecoder * decoder);
|
|
|
|
void gst_video_decoder_set_estimate_rate (GstVideoDecoder * dec,
|
|
gboolean enabled);
|
|
|
|
gint gst_video_decoder_get_estimate_rate (GstVideoDecoder * dec);
|
|
|
|
void gst_video_decoder_set_max_errors (GstVideoDecoder * dec,
|
|
gint num);
|
|
|
|
gint gst_video_decoder_get_max_errors (GstVideoDecoder * dec);
|
|
|
|
void gst_video_decoder_set_latency (GstVideoDecoder *decoder,
|
|
GstClockTime min_latency,
|
|
GstClockTime max_latency);
|
|
void gst_video_decoder_get_latency (GstVideoDecoder *decoder,
|
|
GstClockTime *min_latency,
|
|
GstClockTime *max_latency);
|
|
|
|
|
|
/* Object methods */
|
|
|
|
GstVideoCodecFrame *gst_video_decoder_get_frame (GstVideoDecoder *decoder,
|
|
int frame_number);
|
|
|
|
GstVideoCodecFrame *gst_video_decoder_get_oldest_frame (GstVideoDecoder *decoder);
|
|
|
|
/* Parsing related methods */
|
|
void gst_video_decoder_add_to_frame (GstVideoDecoder *decoder,
|
|
int n_bytes);
|
|
GstFlowReturn gst_video_decoder_have_frame (GstVideoDecoder *decoder);
|
|
|
|
GstBuffer *gst_video_decoder_alloc_output_buffer (GstVideoDecoder * decoder);
|
|
|
|
GstFlowReturn gst_video_decoder_alloc_output_frame (GstVideoDecoder *decoder,
|
|
GstVideoCodecFrame *frame);
|
|
|
|
GstVideoCodecState *gst_video_decoder_set_output_state (GstVideoDecoder *decoder,
|
|
GstVideoFormat fmt, guint width, guint height,
|
|
GstVideoCodecState *reference);
|
|
|
|
GstVideoCodecState *gst_video_decoder_get_output_state (GstVideoDecoder *decoder);
|
|
|
|
GstClockTimeDiff gst_video_decoder_get_max_decode_time (GstVideoDecoder *decoder,
|
|
GstVideoCodecFrame *frame);
|
|
|
|
GstFlowReturn gst_video_decoder_finish_frame (GstVideoDecoder *decoder,
|
|
GstVideoCodecFrame *frame);
|
|
|
|
GstFlowReturn gst_video_decoder_drop_frame (GstVideoDecoder *dec,
|
|
GstVideoCodecFrame *frame);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif
|
|
|