mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-09 10:59:39 +00:00
89dfda56e3
The virtual method named `get_caps` in both `GstBaseSrc` and `GstBaseSink` has a `filter` parameter which can be `NULL` (the default implementation in GstBaseSrc already considers the case). Before this commit, there was no gtk-doc annotation representing this fact, which caused the corresponding entry in the GIR file to also miss this fact. This caused bugs in other places, such inducing the Vala compiler to introduce a wrongly assert on `(filter != NULL)` in every implementation of the `get_caps` method implemented in Vala.
339 lines
12 KiB
C
339 lines
12 KiB
C
/* GStreamer
|
|
* Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
|
|
* 2000 Wim Taymans <wtay@chello.be>
|
|
*
|
|
* gstbasesink.h:
|
|
*
|
|
* 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., 51 Franklin St, Fifth Floor,
|
|
* Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef __GST_BASE_SINK_H__
|
|
#define __GST_BASE_SINK_H__
|
|
|
|
#include <gst/gst.h>
|
|
#include <gst/base/base-prelude.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
|
|
#define GST_TYPE_BASE_SINK (gst_base_sink_get_type())
|
|
#define GST_BASE_SINK(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_BASE_SINK,GstBaseSink))
|
|
#define GST_BASE_SINK_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_BASE_SINK,GstBaseSinkClass))
|
|
#define GST_BASE_SINK_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_BASE_SINK, GstBaseSinkClass))
|
|
#define GST_IS_BASE_SINK(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_BASE_SINK))
|
|
#define GST_IS_BASE_SINK_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_BASE_SINK))
|
|
#define GST_BASE_SINK_CAST(obj) ((GstBaseSink *) (obj))
|
|
|
|
/**
|
|
* GST_BASE_SINK_PAD:
|
|
* @obj: base sink instance
|
|
*
|
|
* Gives the pointer to the #GstPad object of the element.
|
|
*/
|
|
#define GST_BASE_SINK_PAD(obj) (GST_BASE_SINK_CAST (obj)->sinkpad)
|
|
|
|
#define GST_BASE_SINK_GET_PREROLL_LOCK(obj) (&GST_BASE_SINK_CAST(obj)->preroll_lock)
|
|
#define GST_BASE_SINK_PREROLL_LOCK(obj) (g_mutex_lock(GST_BASE_SINK_GET_PREROLL_LOCK(obj)))
|
|
#define GST_BASE_SINK_PREROLL_TRYLOCK(obj) (g_mutex_trylock(GST_BASE_SINK_GET_PREROLL_LOCK(obj)))
|
|
#define GST_BASE_SINK_PREROLL_UNLOCK(obj) (g_mutex_unlock(GST_BASE_SINK_GET_PREROLL_LOCK(obj)))
|
|
|
|
#define GST_BASE_SINK_GET_PREROLL_COND(obj) (&GST_BASE_SINK_CAST(obj)->preroll_cond)
|
|
#define GST_BASE_SINK_PREROLL_WAIT(obj) \
|
|
g_cond_wait (GST_BASE_SINK_GET_PREROLL_COND (obj), GST_BASE_SINK_GET_PREROLL_LOCK (obj))
|
|
#define GST_BASE_SINK_PREROLL_WAIT_UNTIL(obj, end_time) \
|
|
g_cond_wait_until (GST_BASE_SINK_GET_PREROLL_COND (obj), GST_BASE_SINK_GET_PREROLL_LOCK (obj), end_time)
|
|
#define GST_BASE_SINK_PREROLL_SIGNAL(obj) g_cond_signal (GST_BASE_SINK_GET_PREROLL_COND (obj));
|
|
#define GST_BASE_SINK_PREROLL_BROADCAST(obj) g_cond_broadcast (GST_BASE_SINK_GET_PREROLL_COND (obj));
|
|
|
|
typedef struct _GstBaseSink GstBaseSink;
|
|
typedef struct _GstBaseSinkClass GstBaseSinkClass;
|
|
typedef struct _GstBaseSinkPrivate GstBaseSinkPrivate;
|
|
|
|
/**
|
|
* GstBaseSink:
|
|
*
|
|
* The opaque #GstBaseSink data structure.
|
|
*/
|
|
struct _GstBaseSink {
|
|
GstElement element;
|
|
|
|
/*< protected >*/
|
|
GstPad *sinkpad;
|
|
GstPadMode pad_mode;
|
|
|
|
/*< protected >*/ /* with LOCK */
|
|
guint64 offset;
|
|
gboolean can_activate_pull;
|
|
gboolean can_activate_push;
|
|
|
|
/*< protected >*/ /* with PREROLL_LOCK */
|
|
GMutex preroll_lock;
|
|
GCond preroll_cond;
|
|
gboolean eos;
|
|
gboolean need_preroll;
|
|
gboolean have_preroll;
|
|
gboolean playing_async;
|
|
|
|
/*< protected >*/ /* with STREAM_LOCK */
|
|
gboolean have_newsegment;
|
|
GstSegment segment;
|
|
|
|
/*< private >*/ /* with LOCK */
|
|
GstClockID clock_id;
|
|
gboolean sync;
|
|
gboolean flushing;
|
|
gboolean running;
|
|
|
|
gint64 max_lateness;
|
|
|
|
/*< private >*/
|
|
GstBaseSinkPrivate *priv;
|
|
|
|
gpointer _gst_reserved[GST_PADDING_LARGE];
|
|
};
|
|
|
|
/**
|
|
* GstBaseSinkClass:
|
|
* @parent_class: Element parent class
|
|
* @get_caps: Called to get sink pad caps from the subclass
|
|
* @set_caps: Notify subclass of changed caps
|
|
* @fixate: Only useful in pull mode. Implement if you have
|
|
* ideas about what should be the default values for the caps you support.
|
|
* @activate_pull: Subclasses should override this when they can provide an
|
|
* alternate method of spawning a thread to drive the pipeline in pull mode.
|
|
* Should start or stop the pulling thread, depending on the value of the
|
|
* "active" argument. Called after actually activating the sink pad in pull
|
|
* mode. The default implementation starts a task on the sink pad.
|
|
* @get_times: Called to get the start and end times for synchronising
|
|
* the passed buffer to the clock
|
|
* @propose_allocation: configure the allocation query
|
|
* @start: Start processing. Ideal for opening resources in the subclass
|
|
* @stop: Stop processing. Subclasses should use this to close resources.
|
|
* @unlock: Unlock any pending access to the resource. Subclasses should
|
|
* unblock any blocked function ASAP and call gst_base_sink_wait_preroll()
|
|
* @unlock_stop: Clear the previous unlock request. Subclasses should clear
|
|
* any state they set during #GstBaseSinkClass.unlock(), and be ready to
|
|
* continue where they left off after gst_base_sink_wait_preroll(),
|
|
* gst_base_sink_wait() or gst_wait_sink_wait_clock() return or
|
|
* #GstBaseSinkClass.render() is called again.
|
|
* @query: perform a #GstQuery on the element.
|
|
* @event: Override this to handle events arriving on the sink pad
|
|
* @wait_event: Override this to implement custom logic to wait for the event
|
|
* time (for events like EOS and GAP). Subclasses should always first
|
|
* chain up to the default implementation.
|
|
* @prepare: Called to prepare the buffer for @render and @preroll. This
|
|
* function is called before synchronisation is performed.
|
|
* @prepare_list: Called to prepare the buffer list for @render_list. This
|
|
* function is called before synchronisation is performed.
|
|
* @preroll: Called to present the preroll buffer if desired.
|
|
* @render: Called when a buffer should be presented or output, at the
|
|
* correct moment if the #GstBaseSink has been set to sync to the clock.
|
|
* @render_list: Same as @render but used with buffer lists instead of
|
|
* buffers.
|
|
*
|
|
* Subclasses can override any of the available virtual methods or not, as
|
|
* needed. At the minimum, the @render method should be overridden to
|
|
* output/present buffers.
|
|
*/
|
|
struct _GstBaseSinkClass {
|
|
GstElementClass parent_class;
|
|
|
|
/**
|
|
* GstBaseSink::get_caps:
|
|
* @filter: (in) (nullable):
|
|
*
|
|
* Called to get sink pad caps from the subclass.
|
|
*/
|
|
GstCaps* (*get_caps) (GstBaseSink *sink, GstCaps *filter);
|
|
/* notify subclass of new caps */
|
|
gboolean (*set_caps) (GstBaseSink *sink, GstCaps *caps);
|
|
|
|
/* fixate sink caps during pull-mode negotiation */
|
|
GstCaps * (*fixate) (GstBaseSink *sink, GstCaps *caps);
|
|
/* start or stop a pulling thread */
|
|
gboolean (*activate_pull)(GstBaseSink *sink, gboolean active);
|
|
|
|
/* get the start and end times for syncing on this buffer */
|
|
void (*get_times) (GstBaseSink *sink, GstBuffer *buffer,
|
|
GstClockTime *start, GstClockTime *end);
|
|
|
|
/* propose allocation parameters for upstream */
|
|
gboolean (*propose_allocation) (GstBaseSink *sink, GstQuery *query);
|
|
|
|
/* start and stop processing, ideal for opening/closing the resource */
|
|
gboolean (*start) (GstBaseSink *sink);
|
|
gboolean (*stop) (GstBaseSink *sink);
|
|
|
|
/* unlock any pending access to the resource. subclasses should unlock
|
|
* any function ASAP. */
|
|
gboolean (*unlock) (GstBaseSink *sink);
|
|
/* Clear a previously indicated unlock request not that unlocking is
|
|
* complete. Sub-classes should clear any command queue or indicator they
|
|
* set during unlock */
|
|
gboolean (*unlock_stop) (GstBaseSink *sink);
|
|
|
|
/* notify subclass of query */
|
|
gboolean (*query) (GstBaseSink *sink, GstQuery *query);
|
|
|
|
/* notify subclass of event */
|
|
gboolean (*event) (GstBaseSink *sink, GstEvent *event);
|
|
/* wait for eos or gap, subclasses should chain up to parent first */
|
|
GstFlowReturn (*wait_event) (GstBaseSink *sink, GstEvent *event);
|
|
|
|
/* notify subclass of buffer or list before doing sync */
|
|
GstFlowReturn (*prepare) (GstBaseSink *sink, GstBuffer *buffer);
|
|
GstFlowReturn (*prepare_list) (GstBaseSink *sink, GstBufferList *buffer_list);
|
|
|
|
/* notify subclass of preroll buffer or real buffer */
|
|
GstFlowReturn (*preroll) (GstBaseSink *sink, GstBuffer *buffer);
|
|
GstFlowReturn (*render) (GstBaseSink *sink, GstBuffer *buffer);
|
|
/* Render a BufferList */
|
|
GstFlowReturn (*render_list) (GstBaseSink *sink, GstBufferList *buffer_list);
|
|
|
|
/*< private >*/
|
|
gpointer _gst_reserved[GST_PADDING_LARGE];
|
|
};
|
|
|
|
GST_BASE_API
|
|
GType gst_base_sink_get_type (void);
|
|
|
|
GST_BASE_API
|
|
GstFlowReturn gst_base_sink_do_preroll (GstBaseSink *sink, GstMiniObject *obj);
|
|
|
|
GST_BASE_API
|
|
GstFlowReturn gst_base_sink_wait_preroll (GstBaseSink *sink);
|
|
|
|
/* synchronizing against the clock */
|
|
|
|
GST_BASE_API
|
|
void gst_base_sink_set_sync (GstBaseSink *sink, gboolean sync);
|
|
|
|
GST_BASE_API
|
|
gboolean gst_base_sink_get_sync (GstBaseSink *sink);
|
|
|
|
/* Drop buffers which are out of segment */
|
|
|
|
GST_BASE_API
|
|
void gst_base_sink_set_drop_out_of_segment (GstBaseSink *sink, gboolean drop_out_of_segment);
|
|
|
|
GST_BASE_API
|
|
gboolean gst_base_sink_get_drop_out_of_segment (GstBaseSink *sink);
|
|
|
|
/* dropping late buffers */
|
|
|
|
GST_BASE_API
|
|
void gst_base_sink_set_max_lateness (GstBaseSink *sink, gint64 max_lateness);
|
|
|
|
GST_BASE_API
|
|
gint64 gst_base_sink_get_max_lateness (GstBaseSink *sink);
|
|
|
|
/* performing QoS */
|
|
|
|
GST_BASE_API
|
|
void gst_base_sink_set_qos_enabled (GstBaseSink *sink, gboolean enabled);
|
|
|
|
GST_BASE_API
|
|
gboolean gst_base_sink_is_qos_enabled (GstBaseSink *sink);
|
|
|
|
/* doing async state changes */
|
|
|
|
GST_BASE_API
|
|
void gst_base_sink_set_async_enabled (GstBaseSink *sink, gboolean enabled);
|
|
|
|
GST_BASE_API
|
|
gboolean gst_base_sink_is_async_enabled (GstBaseSink *sink);
|
|
|
|
/* tuning synchronisation */
|
|
|
|
GST_BASE_API
|
|
void gst_base_sink_set_ts_offset (GstBaseSink *sink, GstClockTimeDiff offset);
|
|
|
|
GST_BASE_API
|
|
GstClockTimeDiff gst_base_sink_get_ts_offset (GstBaseSink *sink);
|
|
|
|
/* last sample */
|
|
|
|
GST_BASE_API
|
|
GstSample * gst_base_sink_get_last_sample (GstBaseSink *sink);
|
|
|
|
GST_BASE_API
|
|
void gst_base_sink_set_last_sample_enabled (GstBaseSink *sink, gboolean enabled);
|
|
|
|
GST_BASE_API
|
|
gboolean gst_base_sink_is_last_sample_enabled (GstBaseSink *sink);
|
|
|
|
/* latency */
|
|
|
|
GST_BASE_API
|
|
gboolean gst_base_sink_query_latency (GstBaseSink *sink, gboolean *live, gboolean *upstream_live,
|
|
GstClockTime *min_latency, GstClockTime *max_latency);
|
|
GST_BASE_API
|
|
GstClockTime gst_base_sink_get_latency (GstBaseSink *sink);
|
|
|
|
/* render delay */
|
|
|
|
GST_BASE_API
|
|
void gst_base_sink_set_render_delay (GstBaseSink *sink, GstClockTime delay);
|
|
|
|
GST_BASE_API
|
|
GstClockTime gst_base_sink_get_render_delay (GstBaseSink *sink);
|
|
|
|
/* blocksize */
|
|
|
|
GST_BASE_API
|
|
void gst_base_sink_set_blocksize (GstBaseSink *sink, guint blocksize);
|
|
|
|
GST_BASE_API
|
|
guint gst_base_sink_get_blocksize (GstBaseSink *sink);
|
|
|
|
/* throttle-time */
|
|
|
|
GST_BASE_API
|
|
void gst_base_sink_set_throttle_time (GstBaseSink *sink, guint64 throttle);
|
|
|
|
GST_BASE_API
|
|
guint64 gst_base_sink_get_throttle_time (GstBaseSink *sink);
|
|
|
|
/* max-bitrate */
|
|
|
|
GST_BASE_API
|
|
void gst_base_sink_set_max_bitrate (GstBaseSink *sink, guint64 max_bitrate);
|
|
|
|
GST_BASE_API
|
|
guint64 gst_base_sink_get_max_bitrate (GstBaseSink *sink);
|
|
|
|
/* processing deadline */
|
|
GST_BASE_API
|
|
void gst_base_sink_set_processing_deadline (GstBaseSink *sink, GstClockTime processing_deadline);
|
|
|
|
GST_BASE_API
|
|
GstClockTime gst_base_sink_get_processing_deadline (GstBaseSink *sink);
|
|
|
|
GST_BASE_API
|
|
GstClockReturn gst_base_sink_wait_clock (GstBaseSink *sink, GstClockTime time,
|
|
GstClockTimeDiff * jitter);
|
|
GST_BASE_API
|
|
GstFlowReturn gst_base_sink_wait (GstBaseSink *sink, GstClockTime time,
|
|
GstClockTimeDiff *jitter);
|
|
|
|
GST_BASE_API
|
|
GstStructure *gst_base_sink_get_stats (GstBaseSink * sink);
|
|
|
|
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstBaseSink, gst_object_unref)
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __GST_BASE_SINK_H__ */
|