4 * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
6 * Contact: Sangchul Lee <sc11.lee@samsung.com>
8 * This library is free software; you can redistribute it and/or modify it under
9 * the terms of the GNU Lesser General Public License as published by the
10 * Free Software Foundation; either version 2.1 of the License, or (at your option)
13 * This library is distributed in the hope that it will be useful, but WITHOUT ANY
14 * WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
16 * License for more details.
18 * You should have received a copy of the GNU Lesser General Public License
19 * along with this library; if not, write to the Free Software Foundation, Inc., 51
20 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 * SECTION:element-evasimagesink
26 * Gstreamer Evas Video Sink - draw video on the given Evas Image Object
33 #include <sys/types.h>
35 #include <gst/video/video.h>
36 #include <gst/video/gstvideosink.h>
41 #include "gstevasimagesink.h"
43 #define CAP_WIDTH "width"
44 #define CAP_HEIGHT "height"
46 GST_DEBUG_CATEGORY_STATIC (gst_evas_image_sink_debug);
47 #define GST_CAT_DEFAULT gst_evas_image_sink_debug
60 PROP_EVAS_OBJECT_SHOW,
64 #define GL_X11_ENGINE "gl_x11"
66 GMutex *instance_lock;
67 guint instance_lock_count;
69 static inline gboolean
70 is_evas_image_object (Evas_Object *obj)
76 type = evas_object_type_get (obj);
80 if (strcmp (type, "image") == 0) {
86 /* the capabilities of the inputs.
90 static GstStaticPadTemplate sink_factory = GST_STATIC_PAD_TEMPLATE ("sink",
93 GST_STATIC_CAPS (GST_VIDEO_CAPS_BGRx));
95 GST_BOILERPLATE (GstEvasImageSink, gst_evas_image_sink, GstVideoSink, GST_TYPE_VIDEO_SINK);
97 static void gst_evas_image_sink_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
98 static void gst_evas_image_sink_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec);
99 static gboolean gst_evas_image_sink_set_caps (GstBaseSink *base_sink, GstCaps *caps);
100 static GstFlowReturn gst_evas_image_sink_show_frame (GstVideoSink *video_sink, GstBuffer *buf);
101 static gboolean gst_evas_image_sink_event (GstBaseSink *sink, GstEvent *event);
102 static GstStateChangeReturn gst_evas_image_sink_change_state (GstElement *element, GstStateChange transition);
103 static void evas_image_sink_cb_del_eo (void *data, Evas *e, Evas_Object *obj, void *event_info);
104 static void evas_image_sink_cb_resize_event (void *data, Evas *e, Evas_Object *obj, void *event_info);
107 gst_evas_image_sink_base_init (gpointer gclass)
109 GstElementClass *element_class = GST_ELEMENT_CLASS (gclass);
111 gst_element_class_set_details_simple (element_class,
114 "Video sink element for evas image object",
115 "Wonguk Jeong <wonguk.jeong@samsung.com>");
117 gst_element_class_add_pad_template (element_class,
118 gst_static_pad_template_get (&sink_factory));
122 gst_evas_image_sink_class_init (GstEvasImageSinkClass *klass)
124 GObjectClass *gobject_class;
125 GstBaseSinkClass *gstbasesink_class;
126 GstVideoSinkClass *gstvideosink_class;
127 GstElementClass *gstelement_class;
129 gobject_class = (GObjectClass *) klass;
130 gstbasesink_class = GST_BASE_SINK_CLASS (klass);
131 gstvideosink_class = GST_VIDEO_SINK_CLASS (klass);
132 gstelement_class = (GstElementClass *) klass;
134 gobject_class->set_property = gst_evas_image_sink_set_property;
135 gobject_class->get_property = gst_evas_image_sink_get_property;
137 g_object_class_install_property (gobject_class, PROP_EVAS_OBJECT,
138 g_param_spec_pointer ("evas-object", "Destination Evas Object", "Destination evas image object", G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
139 g_object_class_install_property (gobject_class, PROP_EVAS_OBJECT_SHOW,
140 g_param_spec_boolean ("visible", "Show Evas Object", "When disabled, evas object does not show", TRUE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
142 gstvideosink_class->show_frame = GST_DEBUG_FUNCPTR (gst_evas_image_sink_show_frame);
143 gstbasesink_class->set_caps = GST_DEBUG_FUNCPTR (gst_evas_image_sink_set_caps);
144 gstbasesink_class->event = GST_DEBUG_FUNCPTR (gst_evas_image_sink_event);
145 gstelement_class->change_state = GST_DEBUG_FUNCPTR(gst_evas_image_sink_change_state);
149 gst_evas_image_sink_fini (gpointer data, GObject *obj)
153 GstEvasImageSink *esink = GST_EVASIMAGESINK (obj);
158 gst_buffer_unref (esink->oldbuf);
161 g_mutex_lock (instance_lock);
162 instance_lock_count--;
163 g_mutex_unlock (instance_lock);
164 if (instance_lock_count == 0) {
165 g_mutex_free (instance_lock);
166 instance_lock = NULL;
171 evas_image_sink_cb_pipe (void *data, void *buffer, unsigned int nbyte)
174 GstEvasImageSink *esink = data;
177 if (!data || !buffer) {
180 if (nbyte != sizeof (GstBuffer *)) {
186 if (GST_STATE(esink) < GST_STATE_PAUSED) {
187 GST_WARNING ("WRONG-STATE(%d) for rendering, skip this frame", GST_STATE(esink));
191 memcpy (&buf, buffer, sizeof (GstBuffer *));
193 GST_ERROR ("There is no buffer");
196 if (esink->present_data_addr == -1) {
197 /* if present_data_addr is -1, we don't use this member variable */
198 } else if (esink->present_data_addr != GST_BUFFER_DATA (buf)) {
199 GST_WARNING ("skip rendering this buffer, present_data_addr:%x, GST_BUFFER_DATA(buf):%x", esink->present_data_addr,GST_BUFFER_DATA(buf));
203 MMTA_ACUM_ITEM_BEGIN("eavsimagesink _cb_pipe total", FALSE);
205 if ( !esink->is_evas_object_size_set && esink->w > 0 && esink->h > 0) {
206 evas_object_image_size_set (esink->eo, esink->w, esink->h);
207 GST_DEBUG("evas_object_image_size_set(), width(%d),height(%d)",esink->w,esink->h);
208 esink->is_evas_object_size_set = TRUE;
210 if (esink->gl_zerocopy) {
211 img_data = evas_object_image_data_get (esink->eo, EINA_TRUE);
212 if (!img_data || !GST_BUFFER_DATA(buf)) {
213 GST_WARNING ("Cannot get image data from evas object or cannot get gstbuffer data");
214 evas_object_image_data_set(esink->eo, img_data);
216 GST_DEBUG ("img_data(%x), GST_BUFFER_DATA(buf):%x, esink->w(%d),esink->h(%d)",img_data,GST_BUFFER_DATA(buf),esink->w,esink->h);
217 __ta__("evasimagesink memcpy in _cb_pipe", memcpy (img_data, GST_BUFFER_DATA (buf), esink->w * esink->h * COLOR_DEPTH););
218 evas_object_image_pixels_dirty_set (esink->eo, 1);
219 evas_object_image_data_set(esink->eo, img_data);
221 gst_buffer_unref (buf);
223 GST_DEBUG ("GST_BUFFER_DATA(buf):%x",GST_BUFFER_DATA(buf));
224 evas_object_image_data_set (esink->eo, GST_BUFFER_DATA (buf));
225 evas_object_image_pixels_dirty_set (esink->eo, 1);
227 gst_buffer_unref(esink->oldbuf);
232 MMTA_ACUM_ITEM_END("eavsimagesink _cb_pipe total", FALSE);
236 gst_evas_image_sink_init (GstEvasImageSink *esink, GstEvasImageSinkClass *gclass)
242 esink->object_show = FALSE;
243 esink->gl_zerocopy = FALSE;
244 esink->is_evas_object_size_set = FALSE;
245 esink->present_data_addr = -1;
248 instance_lock = g_mutex_new();
250 g_mutex_lock (instance_lock);
251 instance_lock_count++;
252 g_mutex_unlock (instance_lock);
254 g_object_weak_ref (G_OBJECT (esink), gst_evas_image_sink_fini, NULL);
258 evas_image_sink_cb_del_eo (void *data, Evas *e, Evas_Object *obj, void *event_info)
260 GstEvasImageSink *esink = data;
265 evas_object_event_callback_del (esink->eo, EVAS_CALLBACK_RESIZE, evas_image_sink_cb_resize_event);
267 gst_buffer_unref (esink->oldbuf);
268 esink->oldbuf = NULL;
274 evas_image_sink_cb_resize_event (void *data, Evas *e, Evas_Object *obj, void *event_info)
278 GstEvasImageSink *esink = data;
283 evas_object_geometry_get(esink->eo, NULL, NULL, &w, &h);
285 GST_WARNING ("evas object size (w:%d,h:%d) was not set",w,h);
287 evas_object_image_fill_set(esink->eo, 0, 0, w, h);
288 GST_DEBUG ("evas object fill set (w:%d,h:%d)",w,h);
293 evas_image_sink_get_size_from_caps (GstCaps *caps, int *w, int *h)
299 if (!caps || !w || !h) {
302 s = gst_caps_get_structure (caps, 0);
307 r = gst_structure_get_int (s, CAP_WIDTH, &width);
312 r = gst_structure_get_int (s, CAP_HEIGHT, &height);
323 is_zerocopy_supported (Evas *e)
325 Eina_List *engines, *l;
334 engines = evas_render_method_list ();
339 cur_id = evas_output_method_get (e);
341 EINA_LIST_FOREACH (engines, l, name) {
342 id = evas_render_method_lookup (name);
343 if (name && id == cur_id) {
344 if (!strcmp (name, GL_X11_ENGINE)) {
354 evas_image_sink_event_parse_data (GstEvasImageSink *esink, GstEvent *event)
356 const GstStructure *st;
357 guint st_data_addr = 0;
358 gint st_data_width = 0;
359 gint st_data_height = 0;
361 g_return_val_if_fail (event != NULL, FALSE);
362 g_return_val_if_fail (esink != NULL, FALSE);
364 if (GST_EVENT_TYPE (event) != GST_EVENT_CUSTOM_DOWNSTREAM_OOB) {
365 GST_WARNING ("it's not a custom downstream oob event");
368 st = gst_event_get_structure (event);
369 if (st == NULL || !gst_structure_has_name (st, "GstStructureForCustomEvent")) {
370 GST_WARNING ("structure in a given event is not proper");
373 if (!gst_structure_get_uint (st, "data-addr", &st_data_addr)) {
374 GST_WARNING ("parsing data-addr failed");
377 esink->present_data_addr = st_data_addr;
383 gst_evas_image_sink_event (GstBaseSink *sink, GstEvent *event)
385 GstEvasImageSink *esink = GST_EVASIMAGESINK (sink);
389 switch (GST_EVENT_TYPE (event)) {
390 case GST_EVENT_FLUSH_START:
391 GST_DEBUG ("GST_EVENT_FLUSH_START");
393 case GST_EVENT_FLUSH_STOP:
394 GST_DEBUG ("GST_EVENT_FLUSH_STOP");
397 GST_DEBUG ("GST_EVENT_EOS");
399 case GST_EVENT_CUSTOM_DOWNSTREAM_OOB:
400 if(!evas_image_sink_event_parse_data(esink, event)) {
401 GST_DEBUG ("GST_EVENT_CUSTOM_DOWNSTREAM_OOB, present_data_addr:%x",esink->present_data_addr);
403 GST_ERROR ("evas_image_sink_event_parse_data() failed");
409 if (GST_BASE_SINK_CLASS (parent_class)->event) {
410 return GST_BASE_SINK_CLASS (parent_class)->event (sink, event);
416 static GstStateChangeReturn
417 gst_evas_image_sink_change_state (GstElement *element, GstStateChange transition)
419 GstStateChangeReturn ret_state = GST_STATE_CHANGE_SUCCESS;
420 GstEvasImageSink *esink = NULL;
421 esink = GST_EVASIMAGESINK(element);
425 GST_ERROR("can not get evasimagesink from element");
427 switch (transition) {
428 case GST_STATE_CHANGE_NULL_TO_READY:
429 GST_INFO ("*** STATE_CHANGE_NULL_TO_READY ***");
431 case GST_STATE_CHANGE_READY_TO_PAUSED:
432 GST_INFO ("*** STATE_CHANGE_READY_TO_PAUSED ***");
434 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
435 GST_INFO ("*** STATE_CHANGE_PAUSED_TO_PLAYING ***");
441 ret_state = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
443 switch (transition) {
444 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
445 GST_INFO ("*** STATE_CHANGE_PLAYING_TO_PAUSED ***");
447 case GST_STATE_CHANGE_PAUSED_TO_READY:
448 GST_INFO ("*** STATE_CHANGE_PAUSED_TO_READY ***");
450 case GST_STATE_CHANGE_READY_TO_NULL:
451 GST_INFO ("*** STATE_CHANGE_READY_TO_NULL ***");
452 evas_object_event_callback_del(esink->eo, EVAS_CALLBACK_DEL, evas_image_sink_cb_del_eo);
453 evas_object_event_callback_del(esink->eo, EVAS_CALLBACK_RESIZE, evas_image_sink_cb_resize_event);
455 ecore_pipe_del (esink->epipe);
467 gst_evas_image_sink_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
469 GstEvasImageSink *esink = GST_EVASIMAGESINK (object);
472 g_mutex_lock (instance_lock);
475 case PROP_EVAS_OBJECT:
476 eo = g_value_get_pointer (value);
477 if (is_evas_image_object (eo)) {
478 if (eo != esink->eo) {
479 /* delete evas object callbacks registrated on a former evas image object */
480 evas_object_event_callback_del (esink->eo, EVAS_CALLBACK_DEL, evas_image_sink_cb_del_eo);
481 evas_object_event_callback_del (esink->eo, EVAS_CALLBACK_RESIZE, evas_image_sink_cb_resize_event);
485 /* add evas object callbacks on a new evas image object */
486 evas_object_event_callback_add (esink->eo, EVAS_CALLBACK_DEL, evas_image_sink_cb_del_eo, esink);
487 evas_object_event_callback_add (esink->eo, EVAS_CALLBACK_RESIZE, evas_image_sink_cb_resize_event, esink);
489 esink->gl_zerocopy = is_zerocopy_supported (evas_object_evas_get (eo));
490 if (esink->gl_zerocopy) {
491 evas_object_image_content_hint_set (esink->eo, EVAS_IMAGE_CONTENT_HINT_DYNAMIC);
492 GST_DEBUG("Enable gl zerocopy");
494 GST_DEBUG("Evas Image Object(%x) is set",esink->eo);
495 evas_object_show(esink->eo);
496 esink->object_show = TRUE;
499 GST_ERROR ("Cannot set evas-object property: value is not an evas image object");
503 case PROP_EVAS_OBJECT_SHOW:
504 esink->object_show = g_value_get_boolean (value);
505 if( !is_evas_image_object(esink->eo) ) {
506 GST_WARNING ("Cannot apply visible(show-object) property: cannot get an evas object\n");
509 if(!esink->object_show) {
510 evas_object_hide(esink->eo);
511 GST_INFO ("object hide..");
513 evas_object_show(esink->eo);
514 GST_INFO ("object show..");
519 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
523 g_mutex_unlock (instance_lock);
527 gst_evas_image_sink_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
529 GstEvasImageSink *esink = GST_EVASIMAGESINK (object);
532 case PROP_EVAS_OBJECT:
533 g_value_set_pointer (value, esink->eo);
535 case PROP_EVAS_OBJECT_SHOW:
536 g_value_set_boolean (value, esink->object_show);
539 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
545 gst_evas_image_sink_set_caps (GstBaseSink *base_sink, GstCaps *caps)
549 GstEvasImageSink *esink = GST_EVASIMAGESINK (base_sink);
551 esink->is_evas_object_size_set = FALSE;
552 r = evas_image_sink_get_size_from_caps (caps, &w, &h);
556 GST_DEBUG ("set size w(%d), h(%d)", w, h);
562 gst_evas_image_sink_show_frame (GstVideoSink *video_sink, GstBuffer *buf)
564 GstEvasImageSink *esink = GST_EVASIMAGESINK (video_sink);
567 g_mutex_lock (instance_lock);
568 if (esink->present_data_addr == -1) {
569 /* if present_data_addr is -1, we don't use this member variable */
570 } else if (esink->present_data_addr != GST_BUFFER_DATA (buf)) {
571 GST_WARNING ("skip rendering this buffer, present_data_addr:%x, GST_BUFFER_DATA(buf):%x", esink->present_data_addr,GST_BUFFER_DATA(buf));
572 g_mutex_unlock (instance_lock);
576 esink->epipe = ecore_pipe_add (evas_image_sink_cb_pipe, esink);
578 GST_ERROR ("ecore-pipe create failed");
579 return GST_FLOW_ERROR;
582 if (esink->object_show) {
583 gst_buffer_ref (buf);
584 __ta__("evasimagesink ecore_pipe_write", r = ecore_pipe_write (esink->epipe, &buf, sizeof (GstBuffer *)););
585 if (r == EINA_FALSE) {
586 gst_buffer_unref (buf);
588 GST_DEBUG ("after ecore_pipe_write()");
590 GST_DEBUG ("skip ecore_pipe_write()");
592 g_mutex_unlock (instance_lock);
597 evas_image_sink_init (GstPlugin *evasimagesink)
599 GST_DEBUG_CATEGORY_INIT (gst_evas_image_sink_debug, "evasimagesink", 0, "Evas image object based videosink");
601 return gst_element_register (evasimagesink, "evasimagesink", GST_RANK_NONE, GST_TYPE_EVASIMAGESINK);
605 #define PACKAGE "gstevasimagesink-plugin-package"
612 "Evas image object based videosink",
613 evas_image_sink_init,
616 "Samsung Electronics Co",
617 "http://www.samsung.com/"