gstreamer/gst-libs/gst/video/gstvideosink.c
Thibault Saunier 099ac9faf2 docs: Convert gtkdoc comments to markdown
Modernizing the documentation, making it simpler to read an
modify and allowing us to possibly switch to hotdoc in the
future.
2017-03-10 18:19:17 -03:00

269 lines
7.8 KiB
C

/* GStreamer video sink base class
* Copyright (C) <2003> Julien Moutte <julien@moutte.net>
* Copyright (C) <2009> Tim-Philipp Müller <tim centricular net>
*
* 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.
*/
/**
* SECTION:gstvideosink
* @title: GstVideoSink
* @short_description: Base class for video sinks
*
* Provides useful functions and a base class for video sinks.
*
* GstVideoSink will configure the default base sink to drop frames that
* arrive later than 20ms as this is considered the default threshold for
* observing out-of-sync frames.
*
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "gstvideosink.h"
G_DEFINE_TYPE (GstVideoSink, gst_video_sink, GST_TYPE_BASE_SINK);
enum
{
PROP_SHOW_PREROLL_FRAME = 1
};
#define DEFAULT_SHOW_PREROLL_FRAME TRUE
struct _GstVideoSinkPrivate
{
gboolean show_preroll_frame; /* ATOMIC */
};
#ifndef GST_DISABLE_GST_DEBUG
#define GST_CAT_DEFAULT gst_video_sink_ensure_debug_category()
static GstDebugCategory *
gst_video_sink_ensure_debug_category (void)
{
static gsize cat_gonce = 0;
if (g_once_init_enter (&cat_gonce)) {
GstDebugCategory *cat = NULL;
GST_DEBUG_CATEGORY_INIT (cat, "videosink", 0, "GstVideoSink");
g_once_init_leave (&cat_gonce, (gsize) cat);
}
return (GstDebugCategory *) cat_gonce;
}
#endif /* GST_DISABLE_GST_DEBUG */
static GstBaseSinkClass *parent_class = NULL;
static void gst_video_sink_set_property (GObject * object, guint prop_id,
const GValue * value, GParamSpec * pspec);
static void gst_video_sink_get_property (GObject * object, guint prop_id,
GValue * value, GParamSpec * pspec);
static GstFlowReturn gst_video_sink_show_preroll_frame (GstBaseSink * bsink,
GstBuffer * buf);
static GstFlowReturn gst_video_sink_show_frame (GstBaseSink * bsink,
GstBuffer * buf);
/**
* gst_video_sink_center_rect:
* @src: the #GstVideoRectangle describing the source area
* @dst: the #GstVideoRectangle describing the destination area
* @result: a pointer to a #GstVideoRectangle which will receive the result area
* @scaling: a #gboolean indicating if scaling should be applied or not
*
* Takes @src rectangle and position it at the center of @dst rectangle with or
* without @scaling. It handles clipping if the @src rectangle is bigger than
* the @dst one and @scaling is set to FALSE.
*/
void
gst_video_sink_center_rect (GstVideoRectangle src, GstVideoRectangle dst,
GstVideoRectangle * result, gboolean scaling)
{
g_return_if_fail (result != NULL);
if (!scaling) {
result->w = MIN (src.w, dst.w);
result->h = MIN (src.h, dst.h);
result->x = dst.x + (dst.w - result->w) / 2;
result->y = dst.y + (dst.h - result->h) / 2;
} else {
gdouble src_ratio, dst_ratio;
src_ratio = (gdouble) src.w / src.h;
dst_ratio = (gdouble) dst.w / dst.h;
if (src_ratio > dst_ratio) {
result->w = dst.w;
result->h = dst.w / src_ratio;
result->x = dst.x;
result->y = dst.y + (dst.h - result->h) / 2;
} else if (src_ratio < dst_ratio) {
result->w = dst.h * src_ratio;
result->h = dst.h;
result->x = dst.x + (dst.w - result->w) / 2;
result->y = dst.y;
} else {
result->x = dst.x;
result->y = dst.y;
result->w = dst.w;
result->h = dst.h;
}
}
GST_DEBUG ("source is %dx%d dest is %dx%d, result is %dx%d with x,y %dx%d",
src.w, src.h, dst.w, dst.h, result->w, result->h, result->x, result->y);
}
/* Initing stuff */
static void
gst_video_sink_init (GstVideoSink * videosink)
{
videosink->width = 0;
videosink->height = 0;
/* 20ms is more than enough, 80-130ms is noticable */
gst_base_sink_set_max_lateness (GST_BASE_SINK (videosink), 20 * GST_MSECOND);
gst_base_sink_set_qos_enabled (GST_BASE_SINK (videosink), TRUE);
videosink->priv = G_TYPE_INSTANCE_GET_PRIVATE (videosink,
GST_TYPE_VIDEO_SINK, GstVideoSinkPrivate);
}
static void
gst_video_sink_class_init (GstVideoSinkClass * klass)
{
GstBaseSinkClass *basesink_class = (GstBaseSinkClass *) klass;
GObjectClass *gobject_class = (GObjectClass *) klass;
parent_class = g_type_class_peek_parent (klass);
gobject_class->set_property = gst_video_sink_set_property;
gobject_class->get_property = gst_video_sink_get_property;
/**
* GstVideoSink:show-preroll-frame:
*
* Whether to show video frames during preroll. If set to #FALSE, video
* frames will only be rendered in PLAYING state.
*/
g_object_class_install_property (gobject_class, PROP_SHOW_PREROLL_FRAME,
g_param_spec_boolean ("show-preroll-frame", "Show preroll frame",
"Whether to render video frames during preroll",
DEFAULT_SHOW_PREROLL_FRAME,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
basesink_class->render = GST_DEBUG_FUNCPTR (gst_video_sink_show_frame);
basesink_class->preroll =
GST_DEBUG_FUNCPTR (gst_video_sink_show_preroll_frame);
g_type_class_add_private (klass, sizeof (GstVideoSinkPrivate));
}
static GstFlowReturn
gst_video_sink_show_preroll_frame (GstBaseSink * bsink, GstBuffer * buf)
{
GstVideoSinkClass *klass;
GstVideoSink *vsink;
gboolean do_show;
vsink = GST_VIDEO_SINK_CAST (bsink);
klass = GST_VIDEO_SINK_GET_CLASS (vsink);
do_show = g_atomic_int_get (&vsink->priv->show_preroll_frame);
if (G_UNLIKELY (!do_show)) {
GST_DEBUG_OBJECT (bsink, "not rendering frame with ts=%" GST_TIME_FORMAT
", preroll rendering disabled",
GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)));
}
if (klass->show_frame == NULL || !do_show) {
if (parent_class->preroll != NULL)
return parent_class->preroll (bsink, buf);
else
return GST_FLOW_OK;
}
GST_LOG_OBJECT (bsink, "rendering frame, ts=%" GST_TIME_FORMAT,
GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)));
return klass->show_frame (GST_VIDEO_SINK_CAST (bsink), buf);
}
static GstFlowReturn
gst_video_sink_show_frame (GstBaseSink * bsink, GstBuffer * buf)
{
GstVideoSinkClass *klass;
klass = GST_VIDEO_SINK_GET_CLASS (bsink);
if (klass->show_frame == NULL) {
if (parent_class->render != NULL)
return parent_class->render (bsink, buf);
else
return GST_FLOW_OK;
}
GST_LOG_OBJECT (bsink, "rendering frame, ts=%" GST_TIME_FORMAT,
GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)));
return klass->show_frame (GST_VIDEO_SINK_CAST (bsink), buf);
}
static void
gst_video_sink_set_property (GObject * object, guint prop_id,
const GValue * value, GParamSpec * pspec)
{
GstVideoSink *vsink;
vsink = GST_VIDEO_SINK (object);
switch (prop_id) {
case PROP_SHOW_PREROLL_FRAME:
g_atomic_int_set (&vsink->priv->show_preroll_frame,
g_value_get_boolean (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
gst_video_sink_get_property (GObject * object, guint prop_id,
GValue * value, GParamSpec * pspec)
{
GstVideoSink *vsink;
vsink = GST_VIDEO_SINK (object);
switch (prop_id) {
case PROP_SHOW_PREROLL_FRAME:
g_value_set_boolean (value,
g_atomic_int_get (&vsink->priv->show_preroll_frame));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}