gstreamer/gst-libs/gst/video/gstvideopool.h
Wim Taymans 8ebd13ee5e videopool: only do alignment when videometa is enabled
We require the videometa activated before we can implement the alignment of
buffers. Users of the bufferpool should do this manually based on the results of
the allocation query.
2012-03-08 13:03:22 +01:00

109 lines
3.7 KiB
C

/* GStreamer
* Copyright (C) <2011> Wim Taymans <wim.taymans@gmail.com>
*
* 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.
*/
#ifndef __GST_VIDEO_POOL_H__
#define __GST_VIDEO_POOL_H__
#include <gst/gst.h>
#include <gst/video/video.h>
G_BEGIN_DECLS
/**
* GST_BUFFER_POOL_OPTION_VIDEO_META:
*
* An option that can be activated on bufferpool to request video metadata
* on buffers from the pool.
*/
#define GST_BUFFER_POOL_OPTION_VIDEO_META "GstBufferPoolOptionVideoMeta"
/**
* GST_BUFFER_POOL_OPTION_VIDEO_ALIGNMENT:
*
* A bufferpool option to enable extra padding. When a bufferpool supports this
* option, gst_buffer_pool_config_set_video_alignment() can be called.
*
* When this option is enabled on the bufferpool,
* #GST_BUFFER_POOL_OPTION_VIDEO_META should also be enabled.
*/
#define GST_BUFFER_POOL_OPTION_VIDEO_ALIGNMENT "GstBufferPoolOptionVideoAlignment"
typedef struct _GstVideoAlignment GstVideoAlignment;
/**
* GstVideoAlignment:
* @padding_left: extra pixels on the left side
* @padding_right: extra pixels on the right side
* @padding_top: extra pixels on the top
* @padding_bottom: extra pixels on the bottom
* @stride_align: array with extra alignment requirements for the strides
*
* Extra alignment paramters for the memory of video buffers. This
* structure is usually used to configure the bufferpool if it supports the
* #GST_BUFFER_POOL_OPTION_VIDEO_ALIGNMENT.
*/
struct _GstVideoAlignment
{
guint padding_top;
guint padding_bottom;
guint padding_left;
guint padding_right;
guint stride_align[GST_VIDEO_MAX_PLANES];
};
void gst_video_alignment_reset (GstVideoAlignment *align);
/* setting a bufferpool config */
void gst_buffer_pool_config_set_video_alignment (GstStructure *config, GstVideoAlignment *align);
gboolean gst_buffer_pool_config_get_video_alignment (GstStructure *config, GstVideoAlignment *align);
/* video bufferpool */
typedef struct _GstVideoBufferPool GstVideoBufferPool;
typedef struct _GstVideoBufferPoolClass GstVideoBufferPoolClass;
typedef struct _GstVideoBufferPoolPrivate GstVideoBufferPoolPrivate;
#define GST_TYPE_VIDEO_BUFFER_POOL (gst_video_buffer_pool_get_type())
#define GST_IS_VIDEO_BUFFER_POOL(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_VIDEO_BUFFER_POOL))
#define GST_VIDEO_BUFFER_POOL(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_VIDEO_BUFFER_POOL, GstVideoBufferPool))
#define GST_VIDEO_BUFFER_POOL_CAST(obj) ((GstVideoBufferPool*)(obj))
struct _GstVideoBufferPool
{
GstBufferPool bufferpool;
GstVideoBufferPoolPrivate *priv;
};
struct _GstVideoBufferPoolClass
{
GstBufferPoolClass parent_class;
};
GType gst_video_buffer_pool_get_type (void);
GstBufferPool * gst_video_buffer_pool_new (void);
GstAllocator * gst_video_buffer_pool_get_allocator (GstVideoBufferPool *pool);
void gst_video_buffer_pool_set_allocator (GstVideoBufferPool *pool,
GstAllocator *allocator);
G_END_DECLS
#endif /* __GST_VIDEO_POOL_H__ */