sys/v4l2/gstv4l2bufferpool.h

   1 /* GStreamer
   2  *
   3  * Copyright (C) 2001-2002 Ronald Bultje <rbultje@ronald.bitfreak.net>
   4  *               2006 Edgard Lima <edgard.lima@indt.org.br>
   5  *               2009 Texas Instruments, Inc - http://www.ti.com/
   6  *
   7  * gstv4l2bufferpool.h V4L2 buffer pool class
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Library General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2 of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Library General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Library General Public
  20  * License along with this library; if not, write to the
  21  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  22  * Boston, MA 02110-1301, USA.
  23  */
  24
  25 #ifndef __GST_V4L2_BUFFER_POOL_H__
  26 #define __GST_V4L2_BUFFER_POOL_H__
  27
  28 #include <gst/gst.h>
  29
  30 typedef struct _GstV4l2BufferPool GstV4l2BufferPool;
  31 typedef struct _GstV4l2BufferPoolClass GstV4l2BufferPoolClass;
  32 typedef struct _GstV4l2Meta GstV4l2Meta;
  33
  34 #include "gstv4l2object.h"
  35
  36 GST_DEBUG_CATEGORY_EXTERN (v4l2buffer_debug);
  37
  38 G_BEGIN_DECLS
  39
  40
  41 #define GST_TYPE_V4L2_BUFFER_POOL      (gst_v4l2_buffer_pool_get_type())
  42 #define GST_IS_V4L2_BUFFER_POOL(obj)   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_V4L2_BUFFER_POOL))
  43 #define GST_V4L2_BUFFER_POOL(obj)      (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_V4L2_BUFFER_POOL, GstV4l2BufferPool))
  44 #define GST_V4L2_BUFFER_POOL_CAST(obj) ((GstV4l2BufferPool*)(obj))
  45
  46 struct _GstV4l2BufferPool
  47 {
  48   GstBufferPool parent;
  49
  50   GstV4l2Object *obj;        /* the v4l2 object */
  51   gint video_fd;             /* a dup(2) of the v4l2object's video_fd */
  52
  53   GstAllocator *allocator;
  54   GstAllocationParams params;
  55   guint size;
  56   gboolean add_videometa;
  57   gboolean can_alloc;        /* if extra buffers can be allocated */
  58
  59   guint num_buffers;         /* number of buffers we use */
  60   guint num_allocated;       /* number of buffers allocated by the driver */
  61   guint num_queued;          /* number of buffers queued in the driver */
  62   guint copy_threshold;      /* when our pool runs lower, start handing out copies */
  63
  64   gboolean streaming;
  65
  66   GstBuffer **buffers;
  67 };
  68
  69 struct _GstV4l2BufferPoolClass
  70 {
  71   GstBufferPoolClass parent_class;
  72 };
  73
  74 struct _GstV4l2Meta {
  75   GstMeta meta;
  76
  77   /* number of v4l2 planes
  78    * In MPLANE and non MPLANE case it can be one so
  79    * it contains all yuv planes
  80    * In MPLANE mode it can be one per yuv plane.
  81    * For example, 2 for NV12 and 3 for I420
  82    *
  83    * In non MPLANE mode it's always equal to 1
  84    * In MPLANE mode it's equivalent to vbuffer.length
  85    */
  86   guint n_planes;
  87
  88   /* only useful in GST_V4L2_IO_MMAP case.
  89    * it contains address at which the mapping
  90    * was placed for each v4l2 plane */
  91   gpointer mem[GST_VIDEO_MAX_PLANES];
  92
  93   /* plane info for multi-planar buffers */
  94   struct v4l2_plane vplanes[GST_VIDEO_MAX_PLANES];
  95
  96   /* video buffer info */
  97   struct v4l2_buffer vbuffer;
  98 };
  99
 100 GType gst_v4l2_meta_api_get_type (void);
 101 const GstMetaInfo * gst_v4l2_meta_get_info (void);
 102 #define GST_V4L2_META_GET(buf) ((GstV4l2Meta *)gst_buffer_get_meta(buf,gst_v4l2_meta_api_get_type()))
 103 #define GST_V4L2_META_ADD(buf) ((GstV4l2Meta *)gst_buffer_add_meta(buf,gst_v4l2_meta_get_info(),NULL))
 104
 105 GType gst_v4l2_buffer_pool_get_type (void);
 106
 107 GstBufferPool *     gst_v4l2_buffer_pool_new     (GstV4l2Object *obj, GstCaps *caps);
 108
 109 GstFlowReturn       gst_v4l2_buffer_pool_process (GstV4l2BufferPool * bpool, GstBuffer * buf);
 110
 111 gboolean gst_v4l2_buffer_pool_flush (GstV4l2BufferPool * pool);
 112
 113 G_END_DECLS
 114
 115 #endif /*__GST_V4L2_BUFFER_POOL_H__ */