ext/gtk/gstgtkbasesink.c

   1 /*
   2  * GStreamer
   3  * Copyright (C) 2015 Matthew Waters <matthew@centricular.com>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  18  * Boston, MA 02110-1301, USA.
  19  */
  20
  21 /**
  22  * SECTION:gtkgstsink
  23  * @title: GstGtkBaseSink
  24  *
  25  */
  26
  27 #ifdef HAVE_CONFIG_H
  28 #include "config.h"
  29 #endif
  30
  31 #include "gstgtkbasesink.h"
  32 #include "gstgtkutils.h"
  33
  34 GST_DEBUG_CATEGORY (gst_debug_gtk_base_sink);
  35 #define GST_CAT_DEFAULT gst_debug_gtk_base_sink
  36
  37 #define DEFAULT_FORCE_ASPECT_RATIO  TRUE
  38 #define DEFAULT_PAR_N               0
  39 #define DEFAULT_PAR_D               1
  40 #define DEFAULT_IGNORE_ALPHA        TRUE
  41
  42 static void gst_gtk_base_sink_finalize (GObject * object);
  43 static void gst_gtk_base_sink_set_property (GObject * object, guint prop_id,
  44     const GValue * value, GParamSpec * param_spec);
  45 static void gst_gtk_base_sink_get_property (GObject * object, guint prop_id,
  46     GValue * value, GParamSpec * param_spec);
  47
  48 static gboolean gst_gtk_base_sink_start (GstBaseSink * bsink);
  49 static gboolean gst_gtk_base_sink_stop (GstBaseSink * bsink);
  50
  51 static GstStateChangeReturn
  52 gst_gtk_base_sink_change_state (GstElement * element,
  53     GstStateChange transition);
  54
  55 static void gst_gtk_base_sink_get_times (GstBaseSink * bsink, GstBuffer * buf,
  56     GstClockTime * start, GstClockTime * end);
  57 static gboolean gst_gtk_base_sink_set_caps (GstBaseSink * bsink,
  58     GstCaps * caps);
  59 static GstFlowReturn gst_gtk_base_sink_show_frame (GstVideoSink * bsink,
  60     GstBuffer * buf);
  61
  62 static void
  63 gst_gtk_base_sink_navigation_interface_init (GstNavigationInterface * iface);
  64
  65 enum
  66 {
  67   PROP_0,
  68   PROP_WIDGET,
  69   PROP_FORCE_ASPECT_RATIO,
  70   PROP_PIXEL_ASPECT_RATIO,
  71   PROP_IGNORE_ALPHA,
  72 };
  73
  74 #define gst_gtk_base_sink_parent_class parent_class
  75 G_DEFINE_ABSTRACT_TYPE_WITH_CODE (GstGtkBaseSink, gst_gtk_base_sink,
  76     GST_TYPE_VIDEO_SINK,
  77     G_IMPLEMENT_INTERFACE (GST_TYPE_NAVIGATION,
  78         gst_gtk_base_sink_navigation_interface_init);
  79     GST_DEBUG_CATEGORY_INIT (gst_debug_gtk_base_sink,
  80         "gtkbasesink", 0, "Gtk Video Sink base class"));
  81
  82
  83 static void
  84 gst_gtk_base_sink_class_init (GstGtkBaseSinkClass * klass)
  85 {
  86   GObjectClass *gobject_class;
  87   GstElementClass *gstelement_class;
  88   GstBaseSinkClass *gstbasesink_class;
  89   GstVideoSinkClass *gstvideosink_class;
  90
  91   gobject_class = (GObjectClass *) klass;
  92   gstelement_class = (GstElementClass *) klass;
  93   gstbasesink_class = (GstBaseSinkClass *) klass;
  94   gstvideosink_class = (GstVideoSinkClass *) klass;
  95
  96   gobject_class->set_property = gst_gtk_base_sink_set_property;
  97   gobject_class->get_property = gst_gtk_base_sink_get_property;
  98
  99   g_object_class_install_property (gobject_class, PROP_WIDGET,
 100       g_param_spec_object ("widget", "Gtk Widget",
 101           "The GtkWidget to place in the widget hierarchy "
 102           "(must only be get from the GTK main thread)",
 103           GTK_TYPE_WIDGET, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 104
 105   g_object_class_install_property (gobject_class, PROP_FORCE_ASPECT_RATIO,
 106       g_param_spec_boolean ("force-aspect-ratio",
 107           "Force aspect ratio",
 108           "When enabled, scaling will respect original aspect ratio",
 109           DEFAULT_FORCE_ASPECT_RATIO,
 110           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 111
 112   g_object_class_install_property (gobject_class, PROP_PIXEL_ASPECT_RATIO,
 113       gst_param_spec_fraction ("pixel-aspect-ratio", "Pixel Aspect Ratio",
 114           "The pixel aspect ratio of the device", DEFAULT_PAR_N, DEFAULT_PAR_D,
 115           G_MAXINT, 1, 1, 1, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 116
 117   g_object_class_install_property (gobject_class, PROP_IGNORE_ALPHA,
 118       g_param_spec_boolean ("ignore-alpha", "Ignore Alpha",
 119           "When enabled, alpha will be ignored and converted to black",
 120           DEFAULT_IGNORE_ALPHA, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 121
 122   gobject_class->finalize = gst_gtk_base_sink_finalize;
 123
 124   gstelement_class->change_state = gst_gtk_base_sink_change_state;
 125   gstbasesink_class->set_caps = gst_gtk_base_sink_set_caps;
 126   gstbasesink_class->get_times = gst_gtk_base_sink_get_times;
 127   gstbasesink_class->start = gst_gtk_base_sink_start;
 128   gstbasesink_class->stop = gst_gtk_base_sink_stop;
 129
 130   gstvideosink_class->show_frame = gst_gtk_base_sink_show_frame;
 131 }
 132
 133 static void
 134 gst_gtk_base_sink_init (GstGtkBaseSink * gtk_sink)
 135 {
 136   gtk_sink->force_aspect_ratio = DEFAULT_FORCE_ASPECT_RATIO;
 137   gtk_sink->par_n = DEFAULT_PAR_N;
 138   gtk_sink->par_d = DEFAULT_PAR_D;
 139   gtk_sink->ignore_alpha = DEFAULT_IGNORE_ALPHA;
 140 }
 141
 142 static void
 143 gst_gtk_base_sink_finalize (GObject * object)
 144 {
 145   GstGtkBaseSink *gtk_sink = GST_GTK_BASE_SINK (object);
 146
 147   GST_OBJECT_LOCK (gtk_sink);
 148   if (gtk_sink->window && gtk_sink->window_destroy_id)
 149     g_signal_handler_disconnect (gtk_sink->window, gtk_sink->window_destroy_id);
 150   if (gtk_sink->widget && gtk_sink->widget_destroy_id)
 151     g_signal_handler_disconnect (gtk_sink->widget, gtk_sink->widget_destroy_id);
 152
 153   g_clear_object (&gtk_sink->widget);
 154   GST_OBJECT_UNLOCK (gtk_sink);
 155
 156   G_OBJECT_CLASS (parent_class)->finalize (object);
 157 }
 158
 159 static void
 160 widget_destroy_cb (GtkWidget * widget, GstGtkBaseSink * gtk_sink)
 161 {
 162   GST_OBJECT_LOCK (gtk_sink);
 163   g_clear_object (&gtk_sink->widget);
 164   GST_OBJECT_UNLOCK (gtk_sink);
 165 }
 166
 167 static void
 168 window_destroy_cb (GtkWidget * widget, GstGtkBaseSink * gtk_sink)
 169 {
 170   GST_OBJECT_LOCK (gtk_sink);
 171   gtk_sink->window = NULL;
 172   GST_OBJECT_UNLOCK (gtk_sink);
 173 }
 174
 175 static GtkGstBaseWidget *
 176 gst_gtk_base_sink_get_widget (GstGtkBaseSink * gtk_sink)
 177 {
 178   if (gtk_sink->widget != NULL)
 179     return gtk_sink->widget;
 180
 181   /* Ensure GTK is initialized, this has no side effect if it was already
 182    * initialized. Also, we do that lazily, so the application can be first */
 183   if (!gtk_init_check (NULL, NULL)) {
 184     GST_ERROR_OBJECT (gtk_sink, "Could not ensure GTK initialization.");
 185     return NULL;
 186   }
 187
 188   g_assert (GST_GTK_BASE_SINK_GET_CLASS (gtk_sink)->create_widget);
 189   gtk_sink->widget = (GtkGstBaseWidget *)
 190       GST_GTK_BASE_SINK_GET_CLASS (gtk_sink)->create_widget ();
 191
 192   gtk_sink->bind_aspect_ratio =
 193       g_object_bind_property (gtk_sink, "force-aspect-ratio", gtk_sink->widget,
 194       "force-aspect-ratio", G_BINDING_BIDIRECTIONAL | G_BINDING_SYNC_CREATE);
 195   gtk_sink->bind_pixel_aspect_ratio =
 196       g_object_bind_property (gtk_sink, "pixel-aspect-ratio", gtk_sink->widget,
 197       "pixel-aspect-ratio", G_BINDING_BIDIRECTIONAL | G_BINDING_SYNC_CREATE);
 198   gtk_sink->bind_ignore_alpha =
 199       g_object_bind_property (gtk_sink, "ignore-alpha", gtk_sink->widget,
 200       "ignore-alpha", G_BINDING_BIDIRECTIONAL | G_BINDING_SYNC_CREATE);
 201
 202   /* Take the floating ref, other wise the destruction of the container will
 203    * make this widget disapear possibly before we are done. */
 204   gst_object_ref_sink (gtk_sink->widget);
 205   gtk_sink->widget_destroy_id = g_signal_connect (gtk_sink->widget, "destroy",
 206       G_CALLBACK (widget_destroy_cb), gtk_sink);
 207
 208   /* back pointer */
 209   gtk_gst_base_widget_set_element (GTK_GST_BASE_WIDGET (gtk_sink->widget),
 210       GST_ELEMENT (gtk_sink));
 211
 212   return gtk_sink->widget;
 213 }
 214
 215 static void
 216 gst_gtk_base_sink_get_property (GObject * object, guint prop_id,
 217     GValue * value, GParamSpec * pspec)
 218 {
 219   GstGtkBaseSink *gtk_sink = GST_GTK_BASE_SINK (object);
 220
 221   switch (prop_id) {
 222     case PROP_WIDGET:
 223     {
 224       GObject *widget = NULL;
 225
 226       GST_OBJECT_LOCK (gtk_sink);
 227       if (gtk_sink->widget != NULL)
 228         widget = G_OBJECT (gtk_sink->widget);
 229       GST_OBJECT_UNLOCK (gtk_sink);
 230
 231       if (!widget)
 232         widget =
 233             gst_gtk_invoke_on_main ((GThreadFunc) gst_gtk_base_sink_get_widget,
 234             gtk_sink);
 235
 236       g_value_set_object (value, widget);
 237       break;
 238     }
 239     case PROP_FORCE_ASPECT_RATIO:
 240       g_value_set_boolean (value, gtk_sink->force_aspect_ratio);
 241       break;
 242     case PROP_PIXEL_ASPECT_RATIO:
 243       gst_value_set_fraction (value, gtk_sink->par_n, gtk_sink->par_d);
 244       break;
 245     case PROP_IGNORE_ALPHA:
 246       g_value_set_boolean (value, gtk_sink->ignore_alpha);
 247       break;
 248     default:
 249       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 250       break;
 251   }
 252 }
 253
 254 static void
 255 gst_gtk_base_sink_set_property (GObject * object, guint prop_id,
 256     const GValue * value, GParamSpec * pspec)
 257 {
 258   GstGtkBaseSink *gtk_sink = GST_GTK_BASE_SINK (object);
 259
 260   switch (prop_id) {
 261     case PROP_FORCE_ASPECT_RATIO:
 262       gtk_sink->force_aspect_ratio = g_value_get_boolean (value);
 263       break;
 264     case PROP_PIXEL_ASPECT_RATIO:
 265       gtk_sink->par_n = gst_value_get_fraction_numerator (value);
 266       gtk_sink->par_d = gst_value_get_fraction_denominator (value);
 267       break;
 268     case PROP_IGNORE_ALPHA:
 269       gtk_sink->ignore_alpha = g_value_get_boolean (value);
 270       break;
 271     default:
 272       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 273       break;
 274   }
 275 }
 276
 277 static void
 278 gst_gtk_base_sink_navigation_send_event (GstNavigation * navigation,
 279     GstStructure * structure)
 280 {
 281   GstGtkBaseSink *sink = GST_GTK_BASE_SINK (navigation);
 282   GstEvent *event;
 283   GstPad *pad;
 284
 285   event = gst_event_new_navigation (structure);
 286   pad = gst_pad_get_peer (GST_VIDEO_SINK_PAD (sink));
 287
 288   GST_TRACE_OBJECT (sink, "navigation event %" GST_PTR_FORMAT, structure);
 289
 290   if (GST_IS_PAD (pad) && GST_IS_EVENT (event)) {
 291     if (!gst_pad_send_event (pad, gst_event_ref (event))) {
 292       /* If upstream didn't handle the event we'll post a message with it
 293        * for the application in case it wants to do something with it */
 294       gst_element_post_message (GST_ELEMENT_CAST (sink),
 295           gst_navigation_message_new_event (GST_OBJECT_CAST (sink), event));
 296     }
 297     gst_event_unref (event);
 298     gst_object_unref (pad);
 299   }
 300 }
 301
 302 static void
 303 gst_gtk_base_sink_navigation_interface_init (GstNavigationInterface * iface)
 304 {
 305   iface->send_event = gst_gtk_base_sink_navigation_send_event;
 306 }
 307
 308 static gboolean
 309 gst_gtk_base_sink_start_on_main (GstBaseSink * bsink)
 310 {
 311   GstGtkBaseSink *gst_sink = GST_GTK_BASE_SINK (bsink);
 312   GstGtkBaseSinkClass *klass = GST_GTK_BASE_SINK_GET_CLASS (bsink);
 313   GtkWidget *toplevel;
 314
 315   if (gst_gtk_base_sink_get_widget (gst_sink) == NULL)
 316     return FALSE;
 317
 318   /* After this point, gtk_sink->widget will always be set */
 319
 320   toplevel = gtk_widget_get_toplevel (GTK_WIDGET (gst_sink->widget));
 321   if (!gtk_widget_is_toplevel (toplevel)) {
 322     /* sanity check */
 323     g_assert (klass->window_title);
 324
 325     /* User did not add widget its own UI, let's popup a new GtkWindow to
 326      * make gst-launch-1.0 work. */
 327     gst_sink->window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
 328     gtk_window_set_default_size (GTK_WINDOW (gst_sink->window), 640, 480);
 329     gtk_window_set_title (GTK_WINDOW (gst_sink->window), klass->window_title);
 330     gtk_container_add (GTK_CONTAINER (gst_sink->window), toplevel);
 331     gst_sink->window_destroy_id = g_signal_connect (gst_sink->window, "destroy",
 332         G_CALLBACK (window_destroy_cb), gst_sink);
 333   }
 334
 335   return TRUE;
 336 }
 337
 338 static gboolean
 339 gst_gtk_base_sink_start (GstBaseSink * bsink)
 340 {
 341   return ! !gst_gtk_invoke_on_main ((GThreadFunc)
 342       gst_gtk_base_sink_start_on_main, bsink);
 343 }
 344
 345 static gboolean
 346 gst_gtk_base_sink_stop_on_main (GstBaseSink * bsink)
 347 {
 348   GstGtkBaseSink *gst_sink = GST_GTK_BASE_SINK (bsink);
 349
 350   if (gst_sink->window) {
 351     gtk_widget_destroy (gst_sink->window);
 352     gst_sink->window = NULL;
 353     gst_sink->widget = NULL;
 354   }
 355
 356   return TRUE;
 357 }
 358
 359 static gboolean
 360 gst_gtk_base_sink_stop (GstBaseSink * bsink)
 361 {
 362   GstGtkBaseSink *gst_sink = GST_GTK_BASE_SINK (bsink);
 363
 364   if (gst_sink->window)
 365     return ! !gst_gtk_invoke_on_main ((GThreadFunc)
 366         gst_gtk_base_sink_stop_on_main, bsink);
 367
 368   return TRUE;
 369 }
 370
 371 static void
 372 gst_gtk_widget_show_all_and_unref (GtkWidget * widget)
 373 {
 374   gtk_widget_show_all (widget);
 375   g_object_unref (widget);
 376 }
 377
 378 static GstStateChangeReturn
 379 gst_gtk_base_sink_change_state (GstElement * element, GstStateChange transition)
 380 {
 381   GstGtkBaseSink *gtk_sink = GST_GTK_BASE_SINK (element);
 382   GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
 383
 384   GST_DEBUG_OBJECT (element, "changing state: %s => %s",
 385       gst_element_state_get_name (GST_STATE_TRANSITION_CURRENT (transition)),
 386       gst_element_state_get_name (GST_STATE_TRANSITION_NEXT (transition)));
 387
 388   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 389   if (ret == GST_STATE_CHANGE_FAILURE)
 390     return ret;
 391
 392   switch (transition) {
 393     case GST_STATE_CHANGE_READY_TO_PAUSED:
 394     {
 395       GtkWindow *window = NULL;
 396
 397       GST_OBJECT_LOCK (gtk_sink);
 398       if (gtk_sink->window)
 399         window = g_object_ref (GTK_WINDOW (gtk_sink->window));
 400       GST_OBJECT_UNLOCK (gtk_sink);
 401
 402       if (window)
 403         gst_gtk_invoke_on_main ((GThreadFunc) gst_gtk_widget_show_all_and_unref,
 404             window);
 405
 406       break;
 407     }
 408     case GST_STATE_CHANGE_PAUSED_TO_READY:
 409       GST_OBJECT_LOCK (gtk_sink);
 410       if (gtk_sink->widget)
 411         gtk_gst_base_widget_set_buffer (gtk_sink->widget, NULL);
 412       GST_OBJECT_UNLOCK (gtk_sink);
 413       break;
 414     default:
 415       break;
 416   }
 417
 418   return ret;
 419 }
 420
 421 static void
 422 gst_gtk_base_sink_get_times (GstBaseSink * bsink, GstBuffer * buf,
 423     GstClockTime * start, GstClockTime * end)
 424 {
 425   GstGtkBaseSink *gtk_sink;
 426
 427   gtk_sink = GST_GTK_BASE_SINK (bsink);
 428
 429   if (GST_BUFFER_TIMESTAMP_IS_VALID (buf)) {
 430     *start = GST_BUFFER_TIMESTAMP (buf);
 431     if (GST_BUFFER_DURATION_IS_VALID (buf))
 432       *end = *start + GST_BUFFER_DURATION (buf);
 433     else {
 434       if (GST_VIDEO_INFO_FPS_N (&gtk_sink->v_info) > 0) {
 435         *end = *start +
 436             gst_util_uint64_scale_int (GST_SECOND,
 437             GST_VIDEO_INFO_FPS_D (&gtk_sink->v_info),
 438             GST_VIDEO_INFO_FPS_N (&gtk_sink->v_info));
 439       }
 440     }
 441   }
 442 }
 443
 444 gboolean
 445 gst_gtk_base_sink_set_caps (GstBaseSink * bsink, GstCaps * caps)
 446 {
 447   GstGtkBaseSink *gtk_sink = GST_GTK_BASE_SINK (bsink);
 448
 449   GST_DEBUG ("set caps with %" GST_PTR_FORMAT, caps);
 450
 451   if (!gst_video_info_from_caps (&gtk_sink->v_info, caps))
 452     return FALSE;
 453
 454   GST_OBJECT_LOCK (gtk_sink);
 455
 456   if (gtk_sink->widget == NULL) {
 457     GST_OBJECT_UNLOCK (gtk_sink);
 458     GST_ELEMENT_ERROR (gtk_sink, RESOURCE, NOT_FOUND,
 459         ("%s", "Output widget was destroyed"), (NULL));
 460     return FALSE;
 461   }
 462
 463   if (!gtk_gst_base_widget_set_format (gtk_sink->widget, &gtk_sink->v_info)) {
 464     GST_OBJECT_UNLOCK (gtk_sink);
 465     return FALSE;
 466   }
 467   GST_OBJECT_UNLOCK (gtk_sink);
 468
 469   return TRUE;
 470 }
 471
 472 static GstFlowReturn
 473 gst_gtk_base_sink_show_frame (GstVideoSink * vsink, GstBuffer * buf)
 474 {
 475   GstGtkBaseSink *gtk_sink;
 476
 477   GST_TRACE ("rendering buffer:%p", buf);
 478
 479   gtk_sink = GST_GTK_BASE_SINK (vsink);
 480
 481   GST_OBJECT_LOCK (vsink);
 482
 483   if (gtk_sink->widget == NULL) {
 484     GST_OBJECT_UNLOCK (gtk_sink);
 485     GST_ELEMENT_ERROR (gtk_sink, RESOURCE, NOT_FOUND,
 486         ("%s", "Output widget was destroyed"), (NULL));
 487     return GST_FLOW_ERROR;
 488   }
 489
 490   gtk_gst_base_widget_set_buffer (gtk_sink->widget, buf);
 491
 492   GST_OBJECT_UNLOCK (gtk_sink);
 493
 494   return GST_FLOW_OK;
 495 }