gstreamer/gst/videomaxrate/videomaxrate.c

330 lines
9.9 KiB
C

/*
* GStreamer - limit video rate
*
* Copyright 2008 Barracuda Networks, Inc.
*
* Copyright 2009 Nokia Corporation
* Copyright 2009 Collabora Ltd,
* @contact: Olivier Crete <olivier.crete@collabora.co.uk>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA
*
*/
/**
* SECTION:element-videomaxrate
* @see_also: videorate
*
* This object will drop buffers that go beyond a certain buffer rate
* (ie frame rate). It should work with any kind of data where each buffer
* is independent. This currently means raw video frames and still image
* formats.
*
* The framerate is computed using a moving average. The period over which this
* average is computed is configurable using the "average-period" property.
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "videomaxrate.h"
static GstStaticPadTemplate gst_video_max_rate_src_template =
GST_STATIC_PAD_TEMPLATE ("src",
GST_PAD_SRC,
GST_PAD_ALWAYS,
GST_STATIC_CAPS ("video/x-raw-yuv; video/x-raw-rgb; video/x-raw-gray;"
"image/jpeg; image/png")
);
static GstStaticPadTemplate gst_video_max_rate_sink_template =
GST_STATIC_PAD_TEMPLATE ("sink",
GST_PAD_SINK,
GST_PAD_ALWAYS,
GST_STATIC_CAPS ("video/x-raw-yuv; video/x-raw-rgb; video/x-raw-gray;"
"image/jpeg; image/png")
);
static void gst_video_max_rate_set_property (GObject * object, guint prop_id,
const GValue * value, GParamSpec * pspec);
static void gst_video_max_rate_get_property (GObject * object, guint prop_id,
GValue * value, GParamSpec * pspec);
static gboolean gst_video_max_rate_start (GstBaseTransform * trans);
static gboolean gst_video_max_rate_sink_event (GstBaseTransform * trans,
GstEvent * event);
static GstCaps *gst_video_max_rate_transform_caps (GstBaseTransform * trans,
GstPadDirection direction, GstCaps * caps);
static gboolean gst_video_max_rate_set_caps (GstBaseTransform * trans,
GstCaps * incaps, GstCaps * outcaps);
static GstFlowReturn gst_video_max_rate_transform_ip (GstBaseTransform * trans,
GstBuffer * buf);
static void gst_video_max_rate_fixate_caps (GstBaseTransform * trans,
GstPadDirection direction, GstCaps * caps, GstCaps * othercaps);
GST_BOILERPLATE (GstVideoMaxRate, gst_video_max_rate, GstBaseTransform,
GST_TYPE_BASE_TRANSFORM);
#define DEFAULT_AVERAGE_PERIOD GST_SECOND
enum
{
PROP_0,
PROP_AVERAGE_PERIOD
};
static void
gst_video_max_rate_base_init (gpointer gclass)
{
GstElementClass *element_class = GST_ELEMENT_CLASS (gclass);
gst_element_class_set_details_simple (element_class,
"Video maximum rate adjuster",
"Filter/Effect/Video",
"Drops extra frames", "Justin Karneges <justin@affinix.com>");
gst_element_class_add_static_pad_template (element_class,
&gst_video_max_rate_sink_template);
gst_element_class_add_static_pad_template (element_class,
&gst_video_max_rate_src_template);
}
static void
gst_video_max_rate_class_init (GstVideoMaxRateClass * klass)
{
GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
GstBaseTransformClass *base_class = GST_BASE_TRANSFORM_CLASS (klass);
gobject_class->set_property = gst_video_max_rate_set_property;
gobject_class->get_property = gst_video_max_rate_get_property;
base_class->transform_caps =
GST_DEBUG_FUNCPTR (gst_video_max_rate_transform_caps);
base_class->set_caps = GST_DEBUG_FUNCPTR (gst_video_max_rate_set_caps);
base_class->transform_ip =
GST_DEBUG_FUNCPTR (gst_video_max_rate_transform_ip);
base_class->event = GST_DEBUG_FUNCPTR (gst_video_max_rate_sink_event);
base_class->start = GST_DEBUG_FUNCPTR (gst_video_max_rate_start);
base_class->fixate_caps = GST_DEBUG_FUNCPTR (gst_video_max_rate_fixate_caps);
g_object_class_install_property (gobject_class, PROP_AVERAGE_PERIOD,
g_param_spec_uint64 ("average-period", "Period over which to average",
"Period over which to average the framerate (in ns)",
1, G_MAXINT64, DEFAULT_AVERAGE_PERIOD,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
}
static void
gst_video_max_rate_reset (GstVideoMaxRate * videomaxrate)
{
videomaxrate->last_ts = GST_CLOCK_TIME_NONE;
videomaxrate->average = 0;
}
static void
gst_video_max_rate_init (GstVideoMaxRate * videomaxrate,
GstVideoMaxRateClass * gclass)
{
gst_video_max_rate_reset (videomaxrate);
videomaxrate->wanted_diff = 0;
videomaxrate->average_period = DEFAULT_AVERAGE_PERIOD;
gst_base_transform_set_gap_aware (GST_BASE_TRANSFORM (videomaxrate), TRUE);
gst_base_transform_set_in_place (GST_BASE_TRANSFORM (videomaxrate), TRUE);
}
static void
gst_video_max_rate_set_property (GObject * object, guint prop_id,
const GValue * value, GParamSpec * pspec)
{
GstVideoMaxRate *videomaxrate = GST_VIDEO_MAX_RATE (object);
switch (prop_id) {
case PROP_AVERAGE_PERIOD:
videomaxrate->average_period = g_value_get_uint64 (value);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
gst_video_max_rate_get_property (GObject * object, guint prop_id,
GValue * value, GParamSpec * pspec)
{
GstVideoMaxRate *videomaxrate = GST_VIDEO_MAX_RATE (object);
switch (prop_id) {
case PROP_AVERAGE_PERIOD:
g_value_set_uint64 (value, videomaxrate->average_period);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static gboolean
gst_video_max_rate_start (GstBaseTransform * trans)
{
GstVideoMaxRate *videomaxrate = GST_VIDEO_MAX_RATE (trans);
gst_video_max_rate_reset (videomaxrate);
return TRUE;
}
gboolean
gst_video_max_rate_sink_event (GstBaseTransform * trans, GstEvent * event)
{
GstVideoMaxRate *videomaxrate = GST_VIDEO_MAX_RATE (trans);
switch (GST_EVENT_TYPE (event)) {
case GST_EVENT_NEWSEGMENT:
case GST_EVENT_FLUSH_STOP:
gst_video_max_rate_reset (videomaxrate);
break;
default:
break;
}
return TRUE;
}
GstCaps *
gst_video_max_rate_transform_caps (GstBaseTransform * trans,
GstPadDirection direction, GstCaps * caps)
{
GstCaps *ret;
GstStructure *s;
/* this function is always called with a simple caps */
g_return_val_if_fail (GST_CAPS_IS_SIMPLE (caps), NULL);
ret = gst_caps_copy (caps);
s = gst_structure_copy (gst_caps_get_structure (caps, 0));
/* set the framerate as a range */
gst_structure_set (s, "framerate", GST_TYPE_FRACTION_RANGE, 0, 1,
G_MAXINT, 1, NULL);
gst_caps_merge_structure (ret, s);
return ret;
}
static void
gst_video_max_rate_fixate_caps (GstBaseTransform * trans,
GstPadDirection direction, GstCaps * caps, GstCaps * othercaps)
{
GstStructure *s;
gint nom, denom;
s = gst_caps_get_structure (caps, 0);
if (G_UNLIKELY (!gst_structure_get_fraction (s, "framerate", &nom, &denom)))
return;
s = gst_caps_get_structure (othercaps, 0);
gst_structure_fixate_field_nearest_fraction (s, "framerate", nom, denom);
}
gboolean
gst_video_max_rate_set_caps (GstBaseTransform * trans, GstCaps * incaps,
GstCaps * outcaps)
{
GstVideoMaxRate *videomaxrate = GST_VIDEO_MAX_RATE (trans);
GstStructure *cs;
gint numerator, denominator;
// keep track of the outbound framerate
cs = gst_caps_get_structure (outcaps, 0);
if (!gst_structure_get_fraction (cs, "framerate", &numerator, &denominator))
return FALSE;
if (numerator)
videomaxrate->wanted_diff = gst_util_uint64_scale_int (GST_SECOND,
denominator, numerator);
else
videomaxrate->wanted_diff = 0;
gst_video_max_rate_reset (videomaxrate);
return TRUE;
}
GstFlowReturn
gst_video_max_rate_transform_ip (GstBaseTransform * trans, GstBuffer * buf)
{
GstVideoMaxRate *videomaxrate = GST_VIDEO_MAX_RATE (trans);
GstClockTime ts = GST_BUFFER_TIMESTAMP (buf);
if (!GST_BUFFER_TIMESTAMP_IS_VALID (buf) || videomaxrate->wanted_diff == 0)
return GST_FLOW_OK;
/* drop frames if they exceed our output rate */
if (GST_CLOCK_TIME_IS_VALID (videomaxrate->last_ts)) {
GstClockTimeDiff diff = ts - videomaxrate->last_ts;
/* Drop buffer if its early compared to the desired frame rate and
* the current average is higher than the desired average
*/
if (diff < videomaxrate->wanted_diff &&
videomaxrate->average < videomaxrate->wanted_diff)
return GST_BASE_TRANSFORM_FLOW_DROPPED;
/* Update average */
if (videomaxrate->average) {
GstClockTimeDiff wanted_diff;
if (G_LIKELY (videomaxrate->average_period > videomaxrate->wanted_diff))
wanted_diff = videomaxrate->wanted_diff;
else
wanted_diff = videomaxrate->average_period * 10;
videomaxrate->average =
gst_util_uint64_scale_round (videomaxrate->average,
videomaxrate->average_period - wanted_diff,
videomaxrate->average_period) +
gst_util_uint64_scale_round (diff, wanted_diff,
videomaxrate->average_period);
} else {
videomaxrate->average = diff;
}
}
videomaxrate->last_ts = ts;
return GST_FLOW_OK;
}
static gboolean
plugin_init (GstPlugin * plugin)
{
return gst_element_register (plugin, "videomaxrate", GST_RANK_NONE,
GST_TYPE_VIDEO_MAX_RATE);
}
GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
GST_VERSION_MINOR,
"videomaxrate",
"Drop extra frames",
plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)