v4l2: small cleanups
[platform/upstream/gst-plugins-good.git] / 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., 59 Temple Place - Suite 330,
22  * Boston, MA 02111-1307, USA.
23  */
24
25 #ifndef __GSTV4L2BUFFER_H__
26 #define __GSTV4L2BUFFER_H__
27
28 #include <gst/gst.h>
29 #include "v4l2_calls.h"
30
31 GST_DEBUG_CATEGORY_EXTERN (v4l2buffer_debug);
32
33 G_BEGIN_DECLS
34
35
36 GType gst_v4l2_buffer_pool_get_type (void);
37 #define GST_TYPE_V4L2_BUFFER_POOL (gst_v4l2_buffer_pool_get_type())
38 #define GST_IS_V4L2_BUFFER_POOL(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_V4L2_BUFFER_POOL))
39 #define GST_V4L2_BUFFER_POOL(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_V4L2_BUFFER_POOL, GstV4l2BufferPool))
40
41 typedef struct _GstV4l2BufferPool GstV4l2BufferPool;
42 typedef struct _GstV4l2BufferPoolClass GstV4l2BufferPoolClass;
43 typedef struct _GstMetaV4l2 GstMetaV4l2;
44
45 #define GST_V4L2_BUFFER_POOL_LOCK(pool)     g_mutex_lock ((pool)->lock)
46 #define GST_V4L2_BUFFER_POOL_UNLOCK(pool)   g_mutex_unlock ((pool)->lock)
47
48 struct _GstV4l2BufferPool
49 {
50   GObject parent;
51
52   GstV4l2Object *obj;       /* the v4l2 object */
53   gboolean requeuebuf;       /* if true, unusued buffers are automatically re-QBUF'd */
54   enum v4l2_buf_type type;   /* V4L2_BUF_TYPE_VIDEO_CAPTURE, V4L2_BUF_TYPE_VIDEO_OUTPUT */
55
56   GMutex *lock;
57   gboolean running;          /* with lock */
58   gint num_live_buffers;     /* number of buffers not with driver */
59   GAsyncQueue* avail_buffers;/* pool of available buffers, not with the driver and which aren't held outside the bufferpool */
60   gint video_fd;             /* a dup(2) of the v4l2object's video_fd */
61   guint buffer_count;
62   GstBuffer **buffers;
63 };
64
65 struct _GstV4l2BufferPoolClass
66 {
67   GObjectClass parent_class;
68 };
69
70 struct _GstMetaV4l2 {
71   GstMeta meta;
72
73   gpointer mem;
74   struct v4l2_buffer vbuffer;
75
76   GstV4l2BufferPool *pool;
77 };
78
79 const GstMetaInfo * gst_meta_v4l2_get_info (void);
80 #define GST_META_V4L2_GET(buf) ((GstMetaV4l2 *)gst_buffer_get_meta(buf,gst_meta_v4l2_get_info()))
81 #define GST_META_V4L2_ADD(buf) ((GstMetaV4l2 *)gst_buffer_add_meta(buf,gst_meta_v4l2_get_info(),NULL))
82
83 GstV4l2BufferPool * gst_v4l2_buffer_pool_new     (GstV4l2Object *obj, gint num_buffers, gboolean requeuebuf);
84 void                gst_v4l2_buffer_pool_destroy (GstV4l2BufferPool * pool);
85
86 GstBuffer *         gst_v4l2_buffer_pool_get     (GstV4l2BufferPool *pool, gboolean blocking);
87 gboolean            gst_v4l2_buffer_pool_qbuf    (GstV4l2BufferPool *pool, GstBuffer *buf);
88 GstBuffer *         gst_v4l2_buffer_pool_dqbuf   (GstV4l2BufferPool *pool);
89
90 gint                gst_v4l2_buffer_pool_available_buffers (GstV4l2BufferPool *pool);
91
92 G_END_DECLS
93
94 #endif /* __GSTV4L2BUFFER_H__ */