1 /* GStreamer
2  *
3  * Copyright (C) 2001-2002 Ronald Bultje <rbultje@ronald.bitfreak.net>
4  *               2006 Edgard Lima <edgard.lima@gmail.com>
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 #include "gstv4l2allocator.h"
36 
37 G_BEGIN_DECLS
38 
39 #define GST_TYPE_V4L2_BUFFER_POOL      (gst_v4l2_buffer_pool_get_type())
40 #define GST_IS_V4L2_BUFFER_POOL(obj)   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_V4L2_BUFFER_POOL))
41 #define GST_V4L2_BUFFER_POOL(obj)      (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_V4L2_BUFFER_POOL, GstV4l2BufferPool))
42 #define GST_V4L2_BUFFER_POOL_CAST(obj) ((GstV4l2BufferPool*)(obj))
43 
44 /* This flow return is used to indicated that the last buffer of a
45  * drain or a resoltuion change has been found. This should normally
46  * only occure for mem-2-mem devices. */
47 #define GST_V4L2_FLOW_LAST_BUFFER GST_FLOW_CUSTOM_SUCCESS
48 
49 /* This flow return is used to indicated that the returned buffer was marked
50  * with the error flag and had no payload. This error should be recovered by
51  * simply waiting for next buffer. */
52 #define GST_V4L2_FLOW_CORRUPTED_BUFFER GST_FLOW_CUSTOM_SUCCESS_1
53 
54 struct _GstV4l2BufferPool
55 {
56   GstBufferPool parent;
57 
58   GstV4l2Object *obj;        /* the v4l2 object */
59   gint video_fd;             /* a dup(2) of the v4l2object's video_fd */
60   GstPoll *poll;             /* a poll for video_fd */
61   GstPollFD pollfd;
62   gboolean can_poll_device;
63 
64   gboolean empty;
65   GCond empty_cond;
66 
67   gboolean orphaned;
68 
69   GstV4l2Allocator *vallocator;
70   GstAllocator *allocator;
71   GstAllocationParams params;
72   GstBufferPool *other_pool;
73   guint size;
74   GstVideoInfo caps_info;   /* Default video information */
75 
76   gboolean add_videometa;    /* set if video meta should be added */
77   gboolean enable_copy_threshold; /* If copy_threshold should be set */
78 
79   guint min_latency;         /* number of buffers we will hold */
80   guint max_latency;         /* number of buffers we can hold */
81   guint num_queued;          /* number of buffers queued in the driver */
82   guint num_allocated;       /* number of buffers allocated */
83   guint copy_threshold;      /* when our pool runs lower, start handing out copies */
84 
85   gboolean streaming;
86   gboolean flushing;
87 
88   GstBuffer *buffers[VIDEO_MAX_FRAME];
89 
90   /* signal handlers */
91   gulong group_released_handler;
92 
93   /* Control to warn only once on buggy feild driver bug */
94   gboolean has_warned_on_buggy_field;
95 };
96 
97 struct _GstV4l2BufferPoolClass
98 {
99   GstBufferPoolClass parent_class;
100 };
101 
102 GType gst_v4l2_buffer_pool_get_type (void);
103 
104 GstBufferPool *     gst_v4l2_buffer_pool_new     (GstV4l2Object *obj, GstCaps *caps);
105 
106 GstFlowReturn       gst_v4l2_buffer_pool_process (GstV4l2BufferPool * bpool, GstBuffer ** buf);
107 
108 void                gst_v4l2_buffer_pool_set_other_pool (GstV4l2BufferPool * pool,
109                                                          GstBufferPool * other_pool);
110 void                gst_v4l2_buffer_pool_copy_at_threshold (GstV4l2BufferPool * pool,
111                                                             gboolean copy);
112 
113 gboolean            gst_v4l2_buffer_pool_flush   (GstBufferPool *pool);
114 
115 gboolean            gst_v4l2_buffer_pool_orphan  (GstBufferPool ** pool);
116 
117 G_END_DECLS
118 
119 #endif /*__GST_V4L2_BUFFER_POOL_H__ */
120