videodiff: fill in FIXME metadata and docs with description

https://bugzilla.gnome.org/show_bug.cgi?id=765989
This commit is contained in:
Tim-Philipp Müller 2016-05-05 10:40:37 +01:00
parent 5498e97a11
commit b346be1c52
2 changed files with 8 additions and 21 deletions

View file

@ -1,5 +1,5 @@
/* GStreamer
* Copyright (C) 2013 FIXME <fixme@example.com>
* Copyright (C) 2013 David Schleef <ds@schleef.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
@ -19,14 +19,14 @@
/**
* SECTION:element-gstvideodiff
*
* The videodiff element does FIXME stuff.
* The videodiff element highlights the difference between a frame and its
* previous on the luma plane.
*
* <refsect2>
* <title>Example launch line</title>
* |[
* gst-launch-1.0 -v fakesrc ! videodiff ! FIXME ! fakesink
* gst-launch-1.0 -v videotestsrc pattern=ball ! videodiff ! videoconvert ! autovideosink
* ]|
* FIXME Describe what the pipeline does.
* </refsect2>
*/
@ -47,24 +47,13 @@ GST_DEBUG_CATEGORY_STATIC (gst_video_diff_debug_category);
static GstFlowReturn gst_video_diff_transform_frame (GstVideoFilter * filter,
GstVideoFrame * inframe, GstVideoFrame * outframe);
enum
{
PROP_0
};
/* pad templates */
/* FIXME: add/remove formats you can handle */
#define VIDEO_SRC_CAPS \
GST_VIDEO_CAPS_MAKE("{ I420, Y444, Y42B, UYVY, RGBA }")
/* FIXME: add/remove formats you can handle */
#define VIDEO_SINK_CAPS \
GST_VIDEO_CAPS_MAKE("{ I420, Y444, Y42B, UYVY, RGBA }")
/* class initialization */
G_DEFINE_TYPE_WITH_CODE (GstVideoDiff, gst_video_diff, GST_TYPE_VIDEO_FILTER,
GST_DEBUG_CATEGORY_INIT (gst_video_diff_debug_category, "videodiff", 0,
"debug category for videodiff element"));
@ -74,8 +63,6 @@ gst_video_diff_class_init (GstVideoDiffClass * klass)
{
GstVideoFilterClass *video_filter_class = GST_VIDEO_FILTER_CLASS (klass);
/* Setting up pads and setting metadata should be moved to
base_class_init if you intend to subclass this class. */
gst_element_class_add_pad_template (GST_ELEMENT_CLASS (klass),
gst_pad_template_new ("src", GST_PAD_SRC, GST_PAD_ALWAYS,
gst_caps_from_string (VIDEO_SRC_CAPS)));
@ -84,12 +71,12 @@ gst_video_diff_class_init (GstVideoDiffClass * klass)
gst_caps_from_string (VIDEO_SINK_CAPS)));
gst_element_class_set_static_metadata (GST_ELEMENT_CLASS (klass),
"FIXME Long name", "Generic", "FIXME Description",
"FIXME <fixme@example.com>");
"Video Diff", "Video/Filter",
"Visualize differences between adjacent video frames",
"David Schleef <ds@schleef.org>");
video_filter_class->transform_frame =
GST_DEBUG_FUNCPTR (gst_video_diff_transform_frame);
}
static void

View file

@ -1,5 +1,5 @@
/* GStreamer
* Copyright (C) 2013 FIXME <fixme@example.com>
* Copyright (C) 2013 David Schleef <ds@schleef.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public