2 * Copyright (C) <2005> Julien Moutte <julien@moutte.net>
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.
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.
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.
25 #include "xvimagesink.h"
27 /* Debugging category */
28 #include <gst/gstinfo.h>
30 /* Helper functions */
31 #include <gst/video/video.h>
32 #include <gst/video/gstvideometa.h>
33 #include <gst/video/gstvideopool.h>
36 GST_DEBUG_CATEGORY_EXTERN (gst_debug_xvimagepool);
37 #define GST_CAT_DEFAULT gst_debug_xvimagepool
40 struct _GstXvImageBufferPoolPrivate
45 GstVideoAlignment align;
48 gboolean add_metavideo;
49 gboolean need_alignment;
52 static void gst_xvimage_meta_free (GstXvImageMeta * meta, GstBuffer * buffer);
54 /* xvimage metadata */
56 gst_xvimage_meta_api_get_type (void)
58 static volatile GType type;
59 static const gchar *tags[] =
60 { "memory", "size", "colorspace", "orientation", NULL };
62 if (g_once_init_enter (&type)) {
63 GType _type = gst_meta_api_type_register ("GstXvImageMetaAPI", tags);
64 g_once_init_leave (&type, _type);
70 gst_xvimage_meta_get_info (void)
72 static const GstMetaInfo *xvimage_meta_info = NULL;
74 if (xvimage_meta_info == NULL) {
76 gst_meta_register (GST_XVIMAGE_META_API_TYPE, "GstXvImageMeta",
77 sizeof (GstXvImageMeta), (GstMetaInitFunction) NULL,
78 (GstMetaFreeFunction) gst_xvimage_meta_free,
79 (GstMetaTransformFunction) NULL);
81 return xvimage_meta_info;
85 static gboolean error_caught = FALSE;
88 gst_xvimagesink_handle_xerror (Display * display, XErrorEvent * xevent)
92 XGetErrorText (display, xevent->error_code, error_msg, 1024);
93 GST_DEBUG ("xvimagesink triggered an XError. error: %s", error_msg);
98 static GstXvImageMeta *
99 gst_buffer_add_xvimage_meta (GstBuffer * buffer, GstXvImageBufferPool * xvpool)
101 GstXvImageSink *xvimagesink;
102 int (*handler) (Display *, XErrorEvent *);
103 gboolean success = FALSE;
104 GstXContext *xcontext;
105 GstXvImageMeta *meta;
106 gint width, height, im_format, align = 15, offset;
107 GstXvImageBufferPoolPrivate *priv;
110 xvimagesink = xvpool->sink;
111 xcontext = xvimagesink->xcontext;
113 width = priv->padded_width;
114 height = priv->padded_height;
115 im_format = priv->im_format;
118 (GstXvImageMeta *) gst_buffer_add_meta (buffer, GST_XVIMAGE_META_INFO,
121 meta->SHMInfo.shmaddr = ((void *) -1);
122 meta->SHMInfo.shmid = -1;
124 meta->x = priv->align.padding_left;
125 meta->y = priv->align.padding_top;
126 meta->width = priv->info.width;
127 meta->height = priv->info.height;
128 meta->sink = gst_object_ref (xvimagesink);
129 meta->im_format = im_format;
131 GST_DEBUG_OBJECT (xvimagesink, "creating image %p (%dx%d)", buffer,
134 g_mutex_lock (&xvimagesink->x_lock);
136 /* Setting an error handler to catch failure */
137 error_caught = FALSE;
138 handler = XSetErrorHandler (gst_xvimagesink_handle_xerror);
141 if (xcontext->use_xshm) {
144 meta->xvimage = XvShmCreateImage (xcontext->disp,
145 xcontext->xv_port_id, im_format, NULL, width, height, &meta->SHMInfo);
146 if (!meta->xvimage || error_caught) {
147 g_mutex_unlock (&xvimagesink->x_lock);
149 /* Reset error flag */
150 error_caught = FALSE;
153 GST_ELEMENT_WARNING (xvimagesink, RESOURCE, WRITE,
154 ("Failed to create output image buffer of %dx%d pixels",
156 ("could not XShmCreateImage a %dx%d image", width, height));
158 /* Retry without XShm */
159 xvimagesink->xcontext->use_xshm = FALSE;
161 /* Hold X mutex again to try without XShm */
162 g_mutex_lock (&xvimagesink->x_lock);
166 /* we have to use the returned data_size for our shm size */
167 meta->size = meta->xvimage->data_size;
168 GST_LOG_OBJECT (xvimagesink, "XShm image size is %" G_GSIZE_FORMAT,
171 /* calculate the expected size. This is only for sanity checking the
172 * number we get from X. */
174 case GST_MAKE_FOURCC ('I', '4', '2', '0'):
175 case GST_MAKE_FOURCC ('Y', 'V', '1', '2'):
182 pitches[0] = GST_ROUND_UP_4 (width);
183 offsets[1] = offsets[0] + pitches[0] * GST_ROUND_UP_2 (height);
184 pitches[1] = GST_ROUND_UP_8 (width) / 2;
185 offsets[2] = offsets[1] + pitches[1] * GST_ROUND_UP_2 (height) / 2;
186 pitches[2] = GST_ROUND_UP_8 (pitches[0]) / 2;
188 expected_size = offsets[2] + pitches[2] * GST_ROUND_UP_2 (height) / 2;
190 for (plane = 0; plane < meta->xvimage->num_planes; plane++) {
191 GST_DEBUG_OBJECT (xvimagesink,
192 "Plane %u has a expected pitch of %d bytes, " "offset of %d",
193 plane, pitches[plane], offsets[plane]);
197 case GST_MAKE_FOURCC ('Y', 'U', 'Y', '2'):
198 case GST_MAKE_FOURCC ('U', 'Y', 'V', 'Y'):
199 expected_size = height * GST_ROUND_UP_4 (width * 2);
205 if (expected_size != 0 && meta->size != expected_size) {
206 GST_WARNING_OBJECT (xvimagesink,
207 "unexpected XShm image size (got %" G_GSIZE_FORMAT ", expected %d)",
208 meta->size, expected_size);
211 /* Be verbose about our XvImage stride */
215 for (plane = 0; plane < meta->xvimage->num_planes; plane++) {
216 GST_DEBUG_OBJECT (xvimagesink, "Plane %u has a pitch of %d bytes, "
217 "offset of %d", plane, meta->xvimage->pitches[plane],
218 meta->xvimage->offsets[plane]);
222 /* get shared memory */
223 meta->SHMInfo.shmid =
224 shmget (IPC_PRIVATE, meta->size + align, IPC_CREAT | 0777);
225 if (meta->SHMInfo.shmid == -1)
229 meta->SHMInfo.shmaddr = shmat (meta->SHMInfo.shmid, NULL, 0);
230 if (meta->SHMInfo.shmaddr == ((void *) -1))
233 /* now we can set up the image data */
234 meta->xvimage->data = meta->SHMInfo.shmaddr;
235 meta->SHMInfo.readOnly = FALSE;
237 if (XShmAttach (xcontext->disp, &meta->SHMInfo) == 0)
240 XSync (xcontext->disp, FALSE);
242 /* Delete the shared memory segment as soon as we everyone is attached.
243 * This way, it will be deleted as soon as we detach later, and not
244 * leaked if we crash. */
245 shmctl (meta->SHMInfo.shmid, IPC_RMID, NULL);
247 GST_DEBUG_OBJECT (xvimagesink, "XServer ShmAttached to 0x%x, id 0x%lx",
248 meta->SHMInfo.shmid, meta->SHMInfo.shmseg);
251 #endif /* HAVE_XSHM */
253 meta->xvimage = XvCreateImage (xcontext->disp,
254 xcontext->xv_port_id, im_format, NULL, width, height);
255 if (!meta->xvimage || error_caught)
258 /* we have to use the returned data_size for our image size */
259 meta->size = meta->xvimage->data_size;
260 meta->xvimage->data = g_malloc (meta->size + align);
262 XSync (xcontext->disp, FALSE);
265 if ((offset = ((guintptr) meta->xvimage->data & align)))
266 offset = (align + 1) - offset;
268 GST_DEBUG_OBJECT (xvimagesink, "memory %p, align %d, offset %d",
269 meta->xvimage->data, align, offset);
271 /* Reset error handler */
272 error_caught = FALSE;
273 XSetErrorHandler (handler);
275 gst_buffer_append_memory (buffer,
276 gst_memory_new_wrapped (GST_MEMORY_FLAG_NO_SHARE, meta->xvimage->data,
277 meta->size + align, offset, meta->size, NULL, NULL));
279 g_mutex_unlock (&xvimagesink->x_lock);
292 g_mutex_unlock (&xvimagesink->x_lock);
293 /* Reset error handler */
294 error_caught = FALSE;
295 XSetErrorHandler (handler);
297 GST_ELEMENT_ERROR (xvimagesink, RESOURCE, WRITE,
298 ("Failed to create output image buffer of %dx%d pixels",
300 ("could not XvShmCreateImage a %dx%d image", width, height));
306 g_mutex_unlock (&xvimagesink->x_lock);
307 GST_ELEMENT_ERROR (xvimagesink, RESOURCE, WRITE,
308 ("Failed to create output image buffer of %dx%d pixels",
310 ("could not get shared memory of %" G_GSIZE_FORMAT " bytes",
316 g_mutex_unlock (&xvimagesink->x_lock);
317 GST_ELEMENT_ERROR (xvimagesink, RESOURCE, WRITE,
318 ("Failed to create output image buffer of %dx%d pixels",
319 width, height), ("Failed to shmat: %s", g_strerror (errno)));
320 /* Clean up the shared memory segment */
321 shmctl (meta->SHMInfo.shmid, IPC_RMID, NULL);
326 /* Clean up the shared memory segment */
327 shmctl (meta->SHMInfo.shmid, IPC_RMID, NULL);
328 g_mutex_unlock (&xvimagesink->x_lock);
330 GST_ELEMENT_ERROR (xvimagesink, RESOURCE, WRITE,
331 ("Failed to create output image buffer of %dx%d pixels",
332 width, height), ("Failed to XShmAttach"));
339 gst_xvimage_meta_free (GstXvImageMeta * meta, GstBuffer * buffer)
341 GstXvImageSink *xvimagesink;
343 xvimagesink = meta->sink;
345 GST_DEBUG_OBJECT (xvimagesink, "free meta on buffer %p", buffer);
347 /* Hold the object lock to ensure the XContext doesn't disappear */
348 GST_OBJECT_LOCK (xvimagesink);
349 /* We might have some buffers destroyed after changing state to NULL */
350 if (xvimagesink->xcontext == NULL) {
351 GST_DEBUG_OBJECT (xvimagesink, "Destroying XvImage after Xcontext");
353 /* Need to free the shared memory segment even if the x context
354 * was already cleaned up */
355 if (meta->SHMInfo.shmaddr != ((void *) -1)) {
356 shmdt (meta->SHMInfo.shmaddr);
360 XFree (meta->xvimage);
364 g_mutex_lock (&xvimagesink->x_lock);
367 if (xvimagesink->xcontext->use_xshm) {
368 if (meta->SHMInfo.shmaddr != ((void *) -1)) {
369 GST_DEBUG_OBJECT (xvimagesink, "XServer ShmDetaching from 0x%x id 0x%lx",
370 meta->SHMInfo.shmid, meta->SHMInfo.shmseg);
371 XShmDetach (xvimagesink->xcontext->disp, &meta->SHMInfo);
372 XSync (xvimagesink->xcontext->disp, FALSE);
373 shmdt (meta->SHMInfo.shmaddr);
374 meta->SHMInfo.shmaddr = (void *) -1;
377 XFree (meta->xvimage);
379 #endif /* HAVE_XSHM */
382 g_free (meta->xvimage->data);
383 XFree (meta->xvimage);
387 XSync (xvimagesink->xcontext->disp, FALSE);
389 g_mutex_unlock (&xvimagesink->x_lock);
392 GST_OBJECT_UNLOCK (xvimagesink);
394 gst_object_unref (meta->sink);
398 /* This function checks that it is actually really possible to create an image
401 gst_xvimagesink_check_xshm_calls (GstXvImageSink * xvimagesink,
402 GstXContext * xcontext)
405 XShmSegmentInfo SHMInfo;
407 int (*handler) (Display *, XErrorEvent *);
408 gboolean result = FALSE;
409 gboolean did_attach = FALSE;
411 g_return_val_if_fail (xcontext != NULL, FALSE);
413 /* Sync to ensure any older errors are already processed */
414 XSync (xcontext->disp, FALSE);
416 /* Set defaults so we don't free these later unnecessarily */
417 SHMInfo.shmaddr = ((void *) -1);
420 /* Setting an error handler to catch failure */
421 error_caught = FALSE;
422 handler = XSetErrorHandler (gst_xvimagesink_handle_xerror);
424 /* Trying to create a 1x1 picture */
425 GST_DEBUG ("XvShmCreateImage of 1x1");
426 xvimage = XvShmCreateImage (xcontext->disp, xcontext->xv_port_id,
427 xcontext->im_format, NULL, 1, 1, &SHMInfo);
429 /* Might cause an error, sync to ensure it is noticed */
430 XSync (xcontext->disp, FALSE);
431 if (!xvimage || error_caught) {
432 GST_WARNING ("could not XvShmCreateImage a 1x1 image");
435 size = xvimage->data_size;
437 SHMInfo.shmid = shmget (IPC_PRIVATE, size, IPC_CREAT | 0777);
438 if (SHMInfo.shmid == -1) {
439 GST_WARNING ("could not get shared memory of %" G_GSIZE_FORMAT " bytes",
444 SHMInfo.shmaddr = shmat (SHMInfo.shmid, NULL, 0);
445 if (SHMInfo.shmaddr == ((void *) -1)) {
446 GST_WARNING ("Failed to shmat: %s", g_strerror (errno));
447 /* Clean up the shared memory segment */
448 shmctl (SHMInfo.shmid, IPC_RMID, NULL);
452 xvimage->data = SHMInfo.shmaddr;
453 SHMInfo.readOnly = FALSE;
455 if (XShmAttach (xcontext->disp, &SHMInfo) == 0) {
456 GST_WARNING ("Failed to XShmAttach");
457 /* Clean up the shared memory segment */
458 shmctl (SHMInfo.shmid, IPC_RMID, NULL);
462 /* Sync to ensure we see any errors we caused */
463 XSync (xcontext->disp, FALSE);
465 /* Delete the shared memory segment as soon as everyone is attached.
466 * This way, it will be deleted as soon as we detach later, and not
467 * leaked if we crash. */
468 shmctl (SHMInfo.shmid, IPC_RMID, NULL);
471 GST_DEBUG ("XServer ShmAttached to 0x%x, id 0x%lx", SHMInfo.shmid,
475 /* store whether we succeeded in result */
478 GST_WARNING ("MIT-SHM extension check failed at XShmAttach. "
479 "Not using shared memory.");
483 /* Sync to ensure we swallow any errors we caused and reset error_caught */
484 XSync (xcontext->disp, FALSE);
486 error_caught = FALSE;
487 XSetErrorHandler (handler);
490 GST_DEBUG ("XServer ShmDetaching from 0x%x id 0x%lx",
491 SHMInfo.shmid, SHMInfo.shmseg);
492 XShmDetach (xcontext->disp, &SHMInfo);
493 XSync (xcontext->disp, FALSE);
495 if (SHMInfo.shmaddr != ((void *) -1))
496 shmdt (SHMInfo.shmaddr);
501 #endif /* HAVE_XSHM */
504 static void gst_xvimage_buffer_pool_finalize (GObject * object);
506 #define GST_XVIMAGE_BUFFER_POOL_GET_PRIVATE(obj) \
507 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_XVIMAGE_BUFFER_POOL, GstXvImageBufferPoolPrivate))
509 #define gst_xvimage_buffer_pool_parent_class parent_class
510 G_DEFINE_TYPE (GstXvImageBufferPool, gst_xvimage_buffer_pool,
511 GST_TYPE_BUFFER_POOL);
513 static const gchar **
514 xvimage_buffer_pool_get_options (GstBufferPool * pool)
516 static const gchar *options[] = { GST_BUFFER_POOL_OPTION_VIDEO_META,
517 GST_BUFFER_POOL_OPTION_VIDEO_ALIGNMENT, NULL
524 xvimage_buffer_pool_set_config (GstBufferPool * pool, GstStructure * config)
526 GstXvImageBufferPool *xvpool = GST_XVIMAGE_BUFFER_POOL_CAST (pool);
527 GstXvImageBufferPoolPrivate *priv = xvpool->priv;
531 if (!gst_buffer_pool_config_get_params (config, &caps, NULL, NULL, NULL))
537 /* now parse the caps from the config */
538 if (!gst_video_info_from_caps (&info, caps))
541 GST_LOG_OBJECT (pool, "%dx%d, caps %" GST_PTR_FORMAT, info.width, info.height,
544 priv->im_format = gst_xvimagesink_get_format_from_info (xvpool->sink, &info);
545 if (priv->im_format == -1)
549 gst_caps_unref (priv->caps);
550 priv->caps = gst_caps_ref (caps);
552 /* enable metadata based on config of the pool */
553 priv->add_metavideo =
554 gst_buffer_pool_config_has_option (config,
555 GST_BUFFER_POOL_OPTION_VIDEO_META);
557 /* parse extra alignment info */
558 priv->need_alignment = gst_buffer_pool_config_has_option (config,
559 GST_BUFFER_POOL_OPTION_VIDEO_ALIGNMENT);
561 if (priv->need_alignment) {
562 gst_buffer_pool_config_get_video_alignment (config, &priv->align);
564 GST_LOG_OBJECT (pool, "padding %u-%ux%u-%u", priv->align.padding_top,
565 priv->align.padding_left, priv->align.padding_left,
566 priv->align.padding_bottom);
568 /* do padding and alignment */
569 gst_video_info_align (&info, &priv->align);
571 /* we need the video metadata too now */
572 priv->add_metavideo = TRUE;
574 gst_video_alignment_reset (&priv->align);
577 /* add the padding */
579 GST_VIDEO_INFO_WIDTH (&info) + priv->align.padding_left +
580 priv->align.padding_right;
581 priv->padded_height =
582 GST_VIDEO_INFO_HEIGHT (&info) + priv->align.padding_top +
583 priv->align.padding_bottom;
587 return GST_BUFFER_POOL_CLASS (parent_class)->set_config (pool, config);
592 GST_WARNING_OBJECT (pool, "invalid config");
597 GST_WARNING_OBJECT (pool, "no caps in config");
602 GST_WARNING_OBJECT (pool,
603 "failed getting geometry from caps %" GST_PTR_FORMAT, caps);
608 GST_WARNING_OBJECT (xvpool->sink, "failed to get format from caps %"
609 GST_PTR_FORMAT, caps);
610 GST_ELEMENT_ERROR (xvpool->sink, RESOURCE, WRITE,
611 ("Failed to create output image buffer of %dx%d pixels",
612 priv->info.width, priv->info.height),
613 ("Invalid input caps %" GST_PTR_FORMAT, caps));
618 /* This function handles GstXImageBuffer creation depending on XShm availability */
620 xvimage_buffer_pool_alloc (GstBufferPool * pool, GstBuffer ** buffer,
621 GstBufferPoolAcquireParams * params)
623 GstXvImageBufferPool *xvpool = GST_XVIMAGE_BUFFER_POOL_CAST (pool);
624 GstXvImageBufferPoolPrivate *priv = xvpool->priv;
627 GstXvImageMeta *meta;
631 xvimage = gst_buffer_new ();
632 meta = gst_buffer_add_xvimage_meta (xvimage, xvpool);
634 gst_buffer_unref (xvimage);
638 if (priv->add_metavideo) {
639 GST_DEBUG_OBJECT (pool, "adding GstVideoMeta");
640 gst_buffer_add_video_meta_full (xvimage, GST_VIDEO_FRAME_FLAG_NONE,
641 GST_VIDEO_INFO_FORMAT (info), GST_VIDEO_INFO_WIDTH (info),
642 GST_VIDEO_INFO_HEIGHT (info), GST_VIDEO_INFO_N_PLANES (info),
643 info->offset, info->stride);
653 GST_WARNING_OBJECT (pool, "can't create image");
654 return GST_FLOW_ERROR;
659 gst_xvimage_buffer_pool_new (GstXvImageSink * xvimagesink)
661 GstXvImageBufferPool *pool;
663 g_return_val_if_fail (GST_IS_XVIMAGESINK (xvimagesink), NULL);
665 pool = g_object_new (GST_TYPE_XVIMAGE_BUFFER_POOL, NULL);
666 pool->sink = gst_object_ref (xvimagesink);
668 GST_LOG_OBJECT (pool, "new XvImage buffer pool %p", pool);
670 return GST_BUFFER_POOL_CAST (pool);
674 gst_xvimage_buffer_pool_class_init (GstXvImageBufferPoolClass * klass)
676 GObjectClass *gobject_class = (GObjectClass *) klass;
677 GstBufferPoolClass *gstbufferpool_class = (GstBufferPoolClass *) klass;
679 g_type_class_add_private (klass, sizeof (GstXvImageBufferPoolPrivate));
681 gobject_class->finalize = gst_xvimage_buffer_pool_finalize;
683 gstbufferpool_class->get_options = xvimage_buffer_pool_get_options;
684 gstbufferpool_class->set_config = xvimage_buffer_pool_set_config;
685 gstbufferpool_class->alloc_buffer = xvimage_buffer_pool_alloc;
689 gst_xvimage_buffer_pool_init (GstXvImageBufferPool * pool)
691 pool->priv = GST_XVIMAGE_BUFFER_POOL_GET_PRIVATE (pool);
695 gst_xvimage_buffer_pool_finalize (GObject * object)
697 GstXvImageBufferPool *pool = GST_XVIMAGE_BUFFER_POOL_CAST (object);
698 GstXvImageBufferPoolPrivate *priv = pool->priv;
700 GST_LOG_OBJECT (pool, "finalize XvImage buffer pool %p", pool);
703 gst_caps_unref (priv->caps);
704 gst_object_unref (pool->sink);
706 G_OBJECT_CLASS (gst_xvimage_buffer_pool_parent_class)->finalize (object);
709 /* This function tries to get a format matching with a given caps in the
710 supported list of formats we generated in gst_xvimagesink_get_xv_support */
712 gst_xvimagesink_get_format_from_info (GstXvImageSink * xvimagesink,
717 g_return_val_if_fail (GST_IS_XVIMAGESINK (xvimagesink), 0);
719 list = xvimagesink->xcontext->formats_list;
722 GstXvImageFormat *format = list->data;
724 if (format && format->vformat == GST_VIDEO_INFO_FORMAT (info))
725 return format->format;
727 list = g_list_next (list);