gstreamer/sys/xvimage/xvimagepool.c
2011-05-11 19:12:42 +02:00

642 lines
18 KiB
C

/* GStreamer
* Copyright (C) <2005> Julien Moutte <julien@moutte.net>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
/* Object header */
#include "xvimagesink.h"
/* Debugging category */
#include <gst/gstinfo.h>
GST_DEBUG_CATEGORY_EXTERN (gst_debug_xvimagepool);
#define GST_CAT_DEFAULT gst_debug_xvimagepool
static void gst_meta_xvimage_free (GstMetaXvImage * meta, GstBuffer * buffer);
/* xvimage metadata */
const GstMetaInfo *
gst_meta_xvimage_get_info (void)
{
static const GstMetaInfo *meta_xvimage_info = NULL;
if (meta_xvimage_info == NULL) {
meta_xvimage_info = gst_meta_register ("GstMetaXvImage", "GstMetaXvImage",
sizeof (GstMetaXvImage),
(GstMetaInitFunction) NULL,
(GstMetaFreeFunction) gst_meta_xvimage_free,
(GstMetaCopyFunction) NULL, (GstMetaTransformFunction) NULL);
}
return meta_xvimage_info;
}
/* X11 stuff */
static gboolean error_caught = FALSE;
static int
gst_xvimagesink_handle_xerror (Display * display, XErrorEvent * xevent)
{
char error_msg[1024];
XGetErrorText (display, xevent->error_code, error_msg, 1024);
GST_DEBUG ("xvimagesink triggered an XError. error: %s", error_msg);
error_caught = TRUE;
return 0;
}
GstMetaXvImage *
gst_buffer_add_meta_xvimage (GstBuffer * buffer, GstXvImageSink * xvimagesink,
gint width, gint height, gint im_format)
{
int (*handler) (Display *, XErrorEvent *);
gboolean success = FALSE;
GstXContext *xcontext;
GstMetaXvImage *meta;
xcontext = xvimagesink->xcontext;
meta =
(GstMetaXvImage *) gst_buffer_add_meta (buffer, GST_META_INFO_XVIMAGE,
NULL);
#ifdef HAVE_XSHM
meta->SHMInfo.shmaddr = ((void *) -1);
meta->SHMInfo.shmid = -1;
#endif
meta->width = width;
meta->height = height;
meta->sink = gst_object_ref (xvimagesink);
meta->im_format = im_format;
GST_DEBUG_OBJECT (xvimagesink, "creating image %p (%dx%d)", buffer,
meta->width, meta->height);
g_mutex_lock (xvimagesink->x_lock);
/* Setting an error handler to catch failure */
error_caught = FALSE;
handler = XSetErrorHandler (gst_xvimagesink_handle_xerror);
#ifdef HAVE_XSHM
if (xcontext->use_xshm) {
int expected_size;
meta->xvimage = XvShmCreateImage (xcontext->disp,
xcontext->xv_port_id,
meta->im_format, NULL, meta->width, meta->height, &meta->SHMInfo);
if (!meta->xvimage || error_caught)
goto create_failed;
/* we have to use the returned data_size for our shm size */
meta->size = meta->xvimage->data_size;
GST_LOG_OBJECT (xvimagesink, "XShm image size is %" G_GSIZE_FORMAT,
meta->size);
/* calculate the expected size. This is only for sanity checking the
* number we get from X. */
switch (meta->im_format) {
case GST_MAKE_FOURCC ('I', '4', '2', '0'):
case GST_MAKE_FOURCC ('Y', 'V', '1', '2'):
{
gint pitches[3];
gint offsets[3];
guint plane;
offsets[0] = 0;
pitches[0] = GST_ROUND_UP_4 (meta->width);
offsets[1] = offsets[0] + pitches[0] * GST_ROUND_UP_2 (meta->height);
pitches[1] = GST_ROUND_UP_8 (meta->width) / 2;
offsets[2] =
offsets[1] + pitches[1] * GST_ROUND_UP_2 (meta->height) / 2;
pitches[2] = GST_ROUND_UP_8 (pitches[0]) / 2;
expected_size =
offsets[2] + pitches[2] * GST_ROUND_UP_2 (meta->height) / 2;
for (plane = 0; plane < meta->xvimage->num_planes; plane++) {
GST_DEBUG_OBJECT (xvimagesink,
"Plane %u has a expected pitch of %d bytes, " "offset of %d",
plane, pitches[plane], offsets[plane]);
}
break;
}
case GST_MAKE_FOURCC ('Y', 'U', 'Y', '2'):
case GST_MAKE_FOURCC ('U', 'Y', 'V', 'Y'):
expected_size = meta->height * GST_ROUND_UP_4 (meta->width * 2);
break;
default:
expected_size = 0;
break;
}
if (expected_size != 0 && meta->size != expected_size) {
GST_WARNING_OBJECT (xvimagesink,
"unexpected XShm image size (got %" G_GSIZE_FORMAT ", expected %d)",
meta->size, expected_size);
}
/* Be verbose about our XvImage stride */
{
guint plane;
for (plane = 0; plane < meta->xvimage->num_planes; plane++) {
GST_DEBUG_OBJECT (xvimagesink, "Plane %u has a pitch of %d bytes, "
"offset of %d", plane, meta->xvimage->pitches[plane],
meta->xvimage->offsets[plane]);
}
}
/* get shared memory */
meta->SHMInfo.shmid = shmget (IPC_PRIVATE, meta->size, IPC_CREAT | 0777);
if (meta->SHMInfo.shmid == -1)
goto shmget_failed;
/* attach */
meta->SHMInfo.shmaddr = shmat (meta->SHMInfo.shmid, NULL, 0);
if (meta->SHMInfo.shmaddr == ((void *) -1))
goto shmat_failed;
/* now we can set up the image data */
meta->xvimage->data = meta->SHMInfo.shmaddr;
meta->SHMInfo.readOnly = FALSE;
if (XShmAttach (xcontext->disp, &meta->SHMInfo) == 0)
goto xattach_failed;
XSync (xcontext->disp, FALSE);
/* Delete the shared memory segment as soon as we everyone is attached.
* This way, it will be deleted as soon as we detach later, and not
* leaked if we crash. */
shmctl (meta->SHMInfo.shmid, IPC_RMID, NULL);
GST_DEBUG_OBJECT (xvimagesink, "XServer ShmAttached to 0x%x, id 0x%lx",
meta->SHMInfo.shmid, meta->SHMInfo.shmseg);
} else
#endif /* HAVE_XSHM */
{
meta->xvimage = XvCreateImage (xcontext->disp,
xcontext->xv_port_id, meta->im_format, NULL, meta->width, meta->height);
if (!meta->xvimage || error_caught)
goto create_failed;
/* we have to use the returned data_size for our image size */
meta->size = meta->xvimage->data_size;
meta->xvimage->data = g_malloc (meta->size);
XSync (xcontext->disp, FALSE);
}
/* Reset error handler */
error_caught = FALSE;
XSetErrorHandler (handler);
gst_buffer_take_memory (buffer,
gst_memory_new_wrapped (GST_MEMORY_FLAG_NO_SHARE, meta->xvimage->data,
NULL, meta->size, 0, meta->size));
g_mutex_unlock (xvimagesink->x_lock);
success = TRUE;
beach:
if (!success)
meta = NULL;
return meta;
/* ERRORS */
create_failed:
{
g_mutex_unlock (xvimagesink->x_lock);
/* Reset error handler */
error_caught = FALSE;
XSetErrorHandler (handler);
/* Push an error */
GST_ELEMENT_ERROR (xvimagesink, RESOURCE, WRITE,
("Failed to create output image buffer of %dx%d pixels",
meta->width, meta->height),
("could not XvShmCreateImage a %dx%d image", meta->width,
meta->height));
goto beach;
}
shmget_failed:
{
g_mutex_unlock (xvimagesink->x_lock);
GST_ELEMENT_ERROR (xvimagesink, RESOURCE, WRITE,
("Failed to create output image buffer of %dx%d pixels",
meta->width, meta->height),
("could not get shared memory of %" G_GSIZE_FORMAT " bytes",
meta->size));
goto beach;
}
shmat_failed:
{
g_mutex_unlock (xvimagesink->x_lock);
GST_ELEMENT_ERROR (xvimagesink, RESOURCE, WRITE,
("Failed to create output image buffer of %dx%d pixels",
meta->width, meta->height),
("Failed to shmat: %s", g_strerror (errno)));
/* Clean up the shared memory segment */
shmctl (meta->SHMInfo.shmid, IPC_RMID, NULL);
goto beach;
}
xattach_failed:
{
/* Clean up the shared memory segment */
shmctl (meta->SHMInfo.shmid, IPC_RMID, NULL);
g_mutex_unlock (xvimagesink->x_lock);
GST_ELEMENT_ERROR (xvimagesink, RESOURCE, WRITE,
("Failed to create output image buffer of %dx%d pixels",
meta->width, meta->height), ("Failed to XShmAttach"));
goto beach;
}
}
static void
gst_meta_xvimage_free (GstMetaXvImage * meta, GstBuffer * buffer)
{
GstXvImageSink *xvimagesink;
xvimagesink = meta->sink;
GST_DEBUG_OBJECT (xvimagesink, "free meta on buffer %p", buffer);
/* Hold the object lock to ensure the XContext doesn't disappear */
GST_OBJECT_LOCK (xvimagesink);
/* We might have some buffers destroyed after changing state to NULL */
if (xvimagesink->xcontext == NULL) {
GST_DEBUG_OBJECT (xvimagesink, "Destroying XvImage after Xcontext");
#ifdef HAVE_XSHM
/* Need to free the shared memory segment even if the x context
* was already cleaned up */
if (meta->SHMInfo.shmaddr != ((void *) -1)) {
shmdt (meta->SHMInfo.shmaddr);
}
#endif
goto beach;
}
g_mutex_lock (xvimagesink->x_lock);
#ifdef HAVE_XSHM
if (xvimagesink->xcontext->use_xshm) {
if (meta->SHMInfo.shmaddr != ((void *) -1)) {
GST_DEBUG_OBJECT (xvimagesink, "XServer ShmDetaching from 0x%x id 0x%lx",
meta->SHMInfo.shmid, meta->SHMInfo.shmseg);
XShmDetach (xvimagesink->xcontext->disp, &meta->SHMInfo);
XSync (xvimagesink->xcontext->disp, FALSE);
shmdt (meta->SHMInfo.shmaddr);
meta->SHMInfo.shmaddr = (void *) -1;
}
if (meta->xvimage)
XFree (meta->xvimage);
} else
#endif /* HAVE_XSHM */
{
if (meta->xvimage) {
g_free (meta->xvimage->data);
XFree (meta->xvimage);
}
}
XSync (xvimagesink->xcontext->disp, FALSE);
g_mutex_unlock (xvimagesink->x_lock);
beach:
GST_OBJECT_UNLOCK (xvimagesink);
gst_object_unref (meta->sink);
}
GstBuffer *
gst_xvimage_buffer_new (GstXvImageSink * xvimagesink, gint width, gint height,
gint im_format)
{
GstBuffer *buffer;
GstMetaXvImage *meta;
buffer = gst_buffer_new ();
meta =
gst_buffer_add_meta_xvimage (buffer, xvimagesink, width, height,
im_format);
if (meta == NULL) {
gst_buffer_unref (buffer);
buffer = NULL;
}
return buffer;
}
#ifdef HAVE_XSHM
/* This function checks that it is actually really possible to create an image
using XShm */
gboolean
gst_xvimagesink_check_xshm_calls (GstXvImageSink * xvimagesink,
GstXContext * xcontext)
{
XvImage *xvimage;
XShmSegmentInfo SHMInfo;
size_t size;
int (*handler) (Display *, XErrorEvent *);
gboolean result = FALSE;
gboolean did_attach = FALSE;
g_return_val_if_fail (xcontext != NULL, FALSE);
/* Sync to ensure any older errors are already processed */
XSync (xcontext->disp, FALSE);
/* Set defaults so we don't free these later unnecessarily */
SHMInfo.shmaddr = ((void *) -1);
SHMInfo.shmid = -1;
/* Setting an error handler to catch failure */
error_caught = FALSE;
handler = XSetErrorHandler (gst_xvimagesink_handle_xerror);
/* Trying to create a 1x1 picture */
GST_DEBUG ("XvShmCreateImage of 1x1");
xvimage = XvShmCreateImage (xcontext->disp, xcontext->xv_port_id,
xcontext->im_format, NULL, 1, 1, &SHMInfo);
/* Might cause an error, sync to ensure it is noticed */
XSync (xcontext->disp, FALSE);
if (!xvimage || error_caught) {
GST_WARNING ("could not XvShmCreateImage a 1x1 image");
goto beach;
}
size = xvimage->data_size;
SHMInfo.shmid = shmget (IPC_PRIVATE, size, IPC_CREAT | 0777);
if (SHMInfo.shmid == -1) {
GST_WARNING ("could not get shared memory of %" G_GSIZE_FORMAT " bytes",
size);
goto beach;
}
SHMInfo.shmaddr = shmat (SHMInfo.shmid, NULL, 0);
if (SHMInfo.shmaddr == ((void *) -1)) {
GST_WARNING ("Failed to shmat: %s", g_strerror (errno));
/* Clean up the shared memory segment */
shmctl (SHMInfo.shmid, IPC_RMID, NULL);
goto beach;
}
xvimage->data = SHMInfo.shmaddr;
SHMInfo.readOnly = FALSE;
if (XShmAttach (xcontext->disp, &SHMInfo) == 0) {
GST_WARNING ("Failed to XShmAttach");
/* Clean up the shared memory segment */
shmctl (SHMInfo.shmid, IPC_RMID, NULL);
goto beach;
}
/* Sync to ensure we see any errors we caused */
XSync (xcontext->disp, FALSE);
/* Delete the shared memory segment as soon as everyone is attached.
* This way, it will be deleted as soon as we detach later, and not
* leaked if we crash. */
shmctl (SHMInfo.shmid, IPC_RMID, NULL);
if (!error_caught) {
GST_DEBUG ("XServer ShmAttached to 0x%x, id 0x%lx", SHMInfo.shmid,
SHMInfo.shmseg);
did_attach = TRUE;
/* store whether we succeeded in result */
result = TRUE;
} else {
GST_WARNING ("MIT-SHM extension check failed at XShmAttach. "
"Not using shared memory.");
}
beach:
/* Sync to ensure we swallow any errors we caused and reset error_caught */
XSync (xcontext->disp, FALSE);
error_caught = FALSE;
XSetErrorHandler (handler);
if (did_attach) {
GST_DEBUG ("XServer ShmDetaching from 0x%x id 0x%lx",
SHMInfo.shmid, SHMInfo.shmseg);
XShmDetach (xcontext->disp, &SHMInfo);
XSync (xcontext->disp, FALSE);
}
if (SHMInfo.shmaddr != ((void *) -1))
shmdt (SHMInfo.shmaddr);
if (xvimage)
XFree (xvimage);
return result;
}
#endif /* HAVE_XSHM */
/* bufferpool */
static void gst_xvimage_buffer_pool_finalize (GObject * object);
#define GST_XVIMAGE_BUFFER_POOL_GET_PRIVATE(obj) \
(G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_XVIMAGE_BUFFER_POOL, GstXvImageBufferPoolPrivate))
struct _GstXvImageBufferPoolPrivate
{
GstCaps *caps;
gint width, height;
gint im_format;
};
G_DEFINE_TYPE (GstXvImageBufferPool, gst_xvimage_buffer_pool,
GST_TYPE_BUFFER_POOL);
static gboolean
xvimage_buffer_pool_set_config (GstBufferPool * pool, GstStructure * config)
{
GstXvImageBufferPool *xvpool = GST_XVIMAGE_BUFFER_POOL_CAST (pool);
GstXvImageBufferPoolPrivate *priv = xvpool->priv;
GstStructure *structure;
gint width, height;
const GstCaps *caps;
if (!gst_buffer_pool_config_get (config, &caps, NULL, NULL, NULL, NULL,
NULL, NULL))
goto wrong_config;
if (caps == NULL)
goto no_caps;
/* now parse the caps from the config */
structure = gst_caps_get_structure (caps, 0);
if (!gst_structure_get_int (structure, "width", &width) ||
!gst_structure_get_int (structure, "height", &height))
goto wrong_caps;
GST_LOG_OBJECT (pool, "%dx%d, caps %" GST_PTR_FORMAT, width, height, caps);
/* keep track of the width and height and caps */
if (priv->caps)
gst_caps_unref (priv->caps);
priv->caps = gst_caps_copy (caps);
priv->width = width;
priv->height = height;
priv->im_format =
gst_xvimagesink_get_format_from_caps (xvpool->sink, (GstCaps *) caps);
if (priv->im_format == -1) {
GST_WARNING_OBJECT (xvpool->sink, "failed to get format from caps %"
GST_PTR_FORMAT, caps);
GST_ELEMENT_ERROR (xvpool->sink, RESOURCE, WRITE,
("Failed to create output image buffer of %dx%d pixels",
priv->width, priv->height), ("Invalid input caps"));
goto wrong_config;
}
return TRUE;
/* ERRORS */
wrong_config:
{
GST_WARNING_OBJECT (pool, "invalid config");
return FALSE;
}
no_caps:
{
GST_WARNING_OBJECT (pool, "no caps in config");
return FALSE;
}
wrong_caps:
{
GST_WARNING_OBJECT (pool,
"failed getting geometry from caps %" GST_PTR_FORMAT, caps);
return FALSE;
}
}
/* This function handles GstXImageBuffer creation depending on XShm availability */
static GstFlowReturn
xvimage_buffer_pool_alloc (GstBufferPool * pool, GstBuffer ** buffer,
GstBufferPoolParams * params)
{
GstXvImageBufferPool *xvpool = GST_XVIMAGE_BUFFER_POOL_CAST (pool);
GstXvImageBufferPoolPrivate *priv = xvpool->priv;
GstBuffer *xvimage;
xvimage =
gst_xvimage_buffer_new (xvpool->sink, priv->width, priv->height,
priv->im_format);
if (xvimage == NULL)
goto no_buffer;
*buffer = xvimage;
return GST_FLOW_OK;
/* ERROR */
no_buffer:
{
GST_WARNING_OBJECT (pool, "can't create image");
return GST_FLOW_ERROR;
}
}
static void
xvimage_buffer_pool_free (GstBufferPool * pool, GstBuffer * buffer)
{
gst_buffer_unref (buffer);
}
GstBufferPool *
gst_xvimage_buffer_pool_new (GstXvImageSink * xvimagesink)
{
GstXvImageBufferPool *pool;
g_return_val_if_fail (GST_IS_XVIMAGESINK (xvimagesink), NULL);
pool = g_object_new (GST_TYPE_XVIMAGE_BUFFER_POOL, NULL);
pool->sink = gst_object_ref (xvimagesink);
GST_LOG_OBJECT (pool, "new XvImage buffer pool %p", pool);
return GST_BUFFER_POOL_CAST (pool);
}
static void
gst_xvimage_buffer_pool_class_init (GstXvImageBufferPoolClass * klass)
{
GObjectClass *gobject_class = (GObjectClass *) klass;
GstBufferPoolClass *gstbufferpool_class = (GstBufferPoolClass *) klass;
g_type_class_add_private (klass, sizeof (GstXvImageBufferPoolPrivate));
gobject_class->finalize = gst_xvimage_buffer_pool_finalize;
gstbufferpool_class->set_config = xvimage_buffer_pool_set_config;
gstbufferpool_class->alloc_buffer = xvimage_buffer_pool_alloc;
gstbufferpool_class->free_buffer = xvimage_buffer_pool_free;
}
static void
gst_xvimage_buffer_pool_init (GstXvImageBufferPool * pool)
{
pool->priv = GST_XVIMAGE_BUFFER_POOL_GET_PRIVATE (pool);
}
static void
gst_xvimage_buffer_pool_finalize (GObject * object)
{
GstXvImageBufferPool *pool = GST_XVIMAGE_BUFFER_POOL_CAST (object);
GstXvImageBufferPoolPrivate *priv = pool->priv;
GST_LOG_OBJECT (pool, "finalize XvImage buffer pool %p", pool);
if (priv->caps)
gst_caps_unref (priv->caps);
gst_object_unref (pool->sink);
G_OBJECT_CLASS (gst_xvimage_buffer_pool_parent_class)->finalize (object);
}
/* This function tries to get a format matching with a given caps in the
supported list of formats we generated in gst_xvimagesink_get_xv_support */
gint
gst_xvimagesink_get_format_from_caps (GstXvImageSink * xvimagesink,
GstCaps * caps)
{
GList *list = NULL;
g_return_val_if_fail (GST_IS_XVIMAGESINK (xvimagesink), 0);
list = xvimagesink->xcontext->formats_list;
while (list) {
GstXvImageFormat *format = list->data;
if (format) {
if (gst_caps_can_intersect (caps, format->caps)) {
return format->format;
}
}
list = g_list_next (list);
}
return -1;
}