videodiff: fill in FIXME metadata and docs with description
authorTim-Philipp Müller <tim@centricular.com>
Thu, 5 May 2016 09:40:37 +0000 (10:40 +0100)
committerTim-Philipp Müller <tim@centricular.com>
Thu, 5 May 2016 09:40:37 +0000 (10:40 +0100)
https://bugzilla.gnome.org/show_bug.cgi?id=765989

gst/videofilters/gstvideodiff.c
gst/videofilters/gstvideodiff.h

index 6f5b35e6f98e7653a6533fb012732ff565f7f305..2021e3d2050583d3e9595d5386b202dc7dc7ddda 100644 (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
 /**
  * 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
index c91844a84f3008189889968a554df7dfd6250c13..8d76d70e134cf51d6f5cf35f3fbe1c5beb101350 100644 (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