gst/autodetect/gstautovideosink.c

   1 /* GStreamer
   2  * (c) 2005 Ronald S. Bultje <rbultje@ronald.bitfreak.net>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /**
  21  * SECTION:element-autovideosink
  22  * @see_also: autoaudiosink, ximagesink, xvimagesink, sdlvideosink
  23  *
  24  * <refsect2>
  25  * <para>
  26  * autovideosink is a video sink that automatically detects an appropriate
  27  * video sink to use.  It does so by scanning the registry for all elements
  28  * that have <quote>Sink</quote> and <quote>Audio</quote> in the class field
  29  * of their element information, and also have a non-zero autoplugging rank.
  30  * </para>
  31  * <title>Example launch line</title>
  32  * <para>
  33  * <programlisting>
  34  * gst-launch -v -m videotestsrc ! autovideosink
  35  * </programlisting>
  36  * </para>
  37  * </refsect2>
  38  */
  39
  40 #ifdef HAVE_CONFIG_H
  41 #include "config.h"
  42 #endif
  43
  44 #include <string.h>
  45
  46 #include "gstautovideosink.h"
  47 #include "gstautodetect.h"
  48
  49 static GstStateChangeReturn
  50 gst_auto_video_sink_change_state (GstElement * element,
  51     GstStateChange transition);
  52
  53 GST_BOILERPLATE (GstAutoVideoSink, gst_auto_video_sink, GstBin, GST_TYPE_BIN);
  54
  55 static const GstElementDetails gst_auto_video_sink_details =
  56 GST_ELEMENT_DETAILS ("Auto video sink",
  57     "Sink/Video",
  58     "Wrapper video sink for automatically detected video sink",
  59     "Ronald Bultje <rbultje@ronald.bitfreak.net>");
  60
  61 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
  62     GST_PAD_SINK,
  63     GST_PAD_ALWAYS,
  64     GST_STATIC_CAPS_ANY);
  65
  66 static void
  67 gst_auto_video_sink_base_init (gpointer klass)
  68 {
  69   GstElementClass *eklass = GST_ELEMENT_CLASS (klass);
  70
  71   gst_element_class_add_pad_template (eklass,
  72       gst_static_pad_template_get (&sink_template));
  73   gst_element_class_set_details (eklass, &gst_auto_video_sink_details);
  74 }
  75
  76 static void
  77 gst_auto_video_sink_class_init (GstAutoVideoSinkClass * klass)
  78 {
  79   GstElementClass *eklass = GST_ELEMENT_CLASS (klass);
  80
  81   eklass->change_state = GST_DEBUG_FUNCPTR (gst_auto_video_sink_change_state);
  82 }
  83
  84 /*
  85  * Hack to make initial linking work; ideally, this'd work even when
  86  * no target has been assigned to the ghostpad yet.
  87  */
  88
  89 static void
  90 gst_auto_video_sink_reset (GstAutoVideoSink * sink)
  91 {
  92   GstPad *targetpad;
  93
  94   /* fakesink placeholder */
  95   if (sink->kid) {
  96     gst_element_set_state (sink->kid, GST_STATE_NULL);
  97     gst_bin_remove (GST_BIN (sink), sink->kid);
  98   }
  99   sink->kid = gst_element_factory_make ("fakesink", "tempsink");
 100   gst_bin_add (GST_BIN (sink), sink->kid);
 101
 102   /* pad */
 103   targetpad = gst_element_get_pad (sink->kid, "sink");
 104   gst_ghost_pad_set_target (GST_GHOST_PAD (sink->pad), targetpad);
 105   gst_object_unref (targetpad);
 106 }
 107
 108 static void
 109 gst_auto_video_sink_init (GstAutoVideoSink * sink,
 110     GstAutoVideoSinkClass * g_class)
 111 {
 112   sink->pad = gst_ghost_pad_new_no_target ("sink", GST_PAD_SINK);
 113   gst_element_add_pad (GST_ELEMENT (sink), sink->pad);
 114
 115   gst_auto_video_sink_reset (sink);
 116
 117   GST_OBJECT_FLAG_SET (sink, GST_ELEMENT_IS_SINK);
 118 }
 119
 120 static gboolean
 121 gst_auto_video_sink_factory_filter (GstPluginFeature * feature, gpointer data)
 122 {
 123   guint rank;
 124   const gchar *klass;
 125
 126   /* we only care about element factories */
 127   if (!GST_IS_ELEMENT_FACTORY (feature))
 128     return FALSE;
 129
 130   /* video sinks */
 131   klass = gst_element_factory_get_klass (GST_ELEMENT_FACTORY (feature));
 132   if (!(strstr (klass, "Sink") && strstr (klass, "Video")))
 133     return FALSE;
 134
 135   /* only select elements with autoplugging rank */
 136   rank = gst_plugin_feature_get_rank (feature);
 137   if (rank < GST_RANK_MARGINAL)
 138     return FALSE;
 139
 140   return TRUE;
 141 }
 142
 143 static gint
 144 gst_auto_video_sink_compare_ranks (GstPluginFeature * f1, GstPluginFeature * f2)
 145 {
 146   gint diff;
 147
 148   diff = gst_plugin_feature_get_rank (f2) - gst_plugin_feature_get_rank (f1);
 149   if (diff != 0)
 150     return diff;
 151   return strcmp (gst_plugin_feature_get_name (f2),
 152       gst_plugin_feature_get_name (f1));
 153 }
 154
 155 static GstElement *
 156 gst_auto_video_sink_find_best (GstAutoVideoSink * sink)
 157 {
 158   GstElement *choice = NULL;
 159   GList *list, *walk;
 160   gchar *child_name = g_strdup_printf ("%s-actual-sink",
 161       GST_OBJECT_NAME (sink));
 162
 163   list = gst_registry_feature_filter (gst_registry_get_default (),
 164       (GstPluginFeatureFilter) gst_auto_video_sink_factory_filter, FALSE, sink);
 165   list = g_list_sort (list, (GCompareFunc) gst_auto_video_sink_compare_ranks);
 166
 167   for (walk = list; walk != NULL; walk = walk->next) {
 168     GstElementFactory *f = GST_ELEMENT_FACTORY (walk->data);
 169     GstElement *el;
 170
 171     GST_DEBUG_OBJECT (sink, "Trying %s", GST_PLUGIN_FEATURE (f)->name);
 172     if ((el = gst_element_factory_create (f, child_name))) {
 173       GstStateChangeReturn ret;
 174
 175       GST_DEBUG_OBJECT (sink, "Changing state to READY");
 176
 177       ret = gst_element_set_state (el, GST_STATE_READY);
 178       if (ret == GST_STATE_CHANGE_SUCCESS) {
 179         GST_DEBUG_OBJECT (sink, "success");
 180         choice = el;
 181         goto done;
 182       }
 183
 184       GST_WARNING_OBJECT (sink, "Couldn't set READY: %d", ret);
 185       ret = gst_element_set_state (el, GST_STATE_NULL);
 186       if (ret != GST_STATE_CHANGE_SUCCESS)
 187         GST_WARNING_OBJECT (sink,
 188             "Couldn't set element to NULL prior to disposal.");
 189
 190       gst_object_unref (el);
 191     }
 192   }
 193
 194 done:
 195   g_free (child_name);
 196   gst_plugin_feature_list_free (list);
 197
 198   return choice;
 199 }
 200
 201 static gboolean
 202 gst_auto_video_sink_detect (GstAutoVideoSink * sink)
 203 {
 204   GstElement *esink;
 205   GstPad *targetpad;
 206
 207   if (sink->kid) {
 208     gst_element_set_state (sink->kid, GST_STATE_NULL);
 209     gst_bin_remove (GST_BIN (sink), sink->kid);
 210     sink->kid = NULL;
 211   }
 212
 213   /* find element */
 214   GST_DEBUG_OBJECT (sink, "Creating new kid");
 215   if (!(esink = gst_auto_video_sink_find_best (sink))) {
 216     GST_ELEMENT_ERROR (sink, LIBRARY, INIT, (NULL),
 217         ("Failed to find a supported video sink"));
 218     return FALSE;
 219   }
 220
 221   sink->kid = esink;
 222   gst_bin_add (GST_BIN (sink), esink);
 223
 224   /* attach ghost pad */
 225   GST_DEBUG_OBJECT (sink, "Re-assigning ghostpad");
 226   targetpad = gst_element_get_pad (sink->kid, "sink");
 227   gst_ghost_pad_set_target (GST_GHOST_PAD (sink->pad), targetpad);
 228   gst_object_unref (targetpad);
 229   GST_DEBUG_OBJECT (sink, "done changing auto video sink");
 230
 231   return TRUE;
 232 }
 233
 234 static GstStateChangeReturn
 235 gst_auto_video_sink_change_state (GstElement * element,
 236     GstStateChange transition)
 237 {
 238   GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
 239   GstAutoVideoSink *sink = GST_AUTO_VIDEO_SINK (element);
 240
 241   switch (transition) {
 242     case GST_STATE_CHANGE_NULL_TO_READY:
 243       if (!gst_auto_video_sink_detect (sink))
 244         return GST_STATE_CHANGE_FAILURE;
 245       break;
 246     default:
 247       break;
 248   }
 249
 250   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 251
 252   switch (transition) {
 253     case GST_STATE_CHANGE_READY_TO_NULL:
 254       gst_auto_video_sink_reset (sink);
 255       break;
 256     default:
 257       break;
 258   }
 259
 260   return ret;
 261 }