3 * Copyright (C) 2001-2002 Ronald Bultje <rbultje@ronald.bitfreak.net>
4 * 2006 Edgard Lima <edgard.lima@gmail.com>
6 * gstv4l2object.h: base class for V4L2 elements
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
21 * Boston, MA 02110-1301, USA.
24 #ifndef __GST_V4L2_OBJECT_H__
25 #define __GST_V4L2_OBJECT_H__
30 # include "ext/videodev2.h"
31 # include <sys/ioctl.h>
32 # include <sys/mman.h>
34 # define v4l2_fd_open(fd, flags) (fd)
35 # define v4l2_close close
37 # define v4l2_ioctl ioctl
38 # define v4l2_read read
39 # define v4l2_mmap mmap
40 # define v4l2_munmap munmap
43 #include "ext/videodev2.h"
44 #include "v4l2-utils.h"
47 #include <gst/base/gstpushsrc.h>
49 #include <gst/video/video.h>
51 typedef struct _GstV4l2Object GstV4l2Object;
52 typedef struct _GstV4l2ObjectClassHelper GstV4l2ObjectClassHelper;
53 typedef struct _GstV4l2Xv GstV4l2Xv;
55 #include <gstv4l2bufferpool.h>
57 /* size of v4l2 buffer pool in streaming case */
58 #define GST_V4L2_MIN_BUFFERS 2
60 /* max frame width/height */
61 #define GST_V4L2_MAX_SIZE (1<<15) /* 2^15 == 32768 */
65 #define GST_TYPE_V4L2_IO_MODE (gst_v4l2_io_mode_get_type ())
66 GType gst_v4l2_io_mode_get_type (void);
68 #define GST_V4L2_OBJECT(obj) (GstV4l2Object *)(obj)
74 GST_V4L2_IO_USERPTR = 3,
75 GST_V4L2_IO_DMABUF = 4,
76 GST_V4L2_IO_DMABUF_IMPORT = 5
79 typedef gboolean (*GstV4l2GetInOutFunction) (GstV4l2Object * v4l2object, gint * input);
80 typedef gboolean (*GstV4l2SetInOutFunction) (GstV4l2Object * v4l2object, gint input);
81 typedef gboolean (*GstV4l2UpdateFpsFunction) (GstV4l2Object * v4l2object);
83 #define GST_V4L2_WIDTH(o) (GST_VIDEO_INFO_WIDTH (&(o)->info))
84 #define GST_V4L2_HEIGHT(o) (GST_VIDEO_INFO_HEIGHT (&(o)->info))
85 #define GST_V4L2_PIXELFORMAT(o) ((o)->fmtdesc->pixelformat)
86 #define GST_V4L2_FPS_N(o) (GST_VIDEO_INFO_FPS_N (&(o)->info))
87 #define GST_V4L2_FPS_D(o) (GST_VIDEO_INFO_FPS_D (&(o)->info))
89 /* simple check whether the device is open */
90 #define GST_V4L2_IS_OPEN(o) ((o)->video_fd > 0)
92 /* check whether the device is 'active' */
93 #define GST_V4L2_IS_ACTIVE(o) ((o)->active)
94 #define GST_V4L2_SET_ACTIVE(o) ((o)->active = TRUE)
95 #define GST_V4L2_SET_INACTIVE(o) ((o)->active = FALSE)
97 /* checks whether the current v4lv4l2object has already been open()'ed or not */
98 #define GST_V4L2_CHECK_OPEN(v4l2object) \
99 if (!GST_V4L2_IS_OPEN(v4l2object)) \
101 GST_ELEMENT_ERROR (v4l2object->element, RESOURCE, SETTINGS, \
102 (_("Device is not open.")), (NULL)); \
106 /* checks whether the current v4lv4l2object is close()'ed or whether it is still open */
107 #define GST_V4L2_CHECK_NOT_OPEN(v4l2object) \
108 if (GST_V4L2_IS_OPEN(v4l2object)) \
110 GST_ELEMENT_ERROR (v4l2object->element, RESOURCE, SETTINGS, \
111 (_("Device is open.")), (NULL)); \
115 /* checks whether we're out of capture mode or not */
116 #define GST_V4L2_CHECK_NOT_ACTIVE(v4l2object) \
117 if (GST_V4L2_IS_ACTIVE(v4l2object)) \
119 GST_ELEMENT_ERROR (v4l2object->element, RESOURCE, SETTINGS, \
120 (NULL), ("Device is in streaming mode")); \
125 struct _GstV4l2Object {
126 GstElement * element;
128 enum v4l2_buf_type type; /* V4L2_BUF_TYPE_VIDEO_CAPTURE, V4L2_BUF_TYPE_VIDEO_OUTPUT */
130 /* the video device */
133 /* the video-device's file descriptor */
140 /* the current format */
141 struct v4l2_fmtdesc *fmtdesc;
142 struct v4l2_format format;
144 GstVideoAlignment align;
147 gboolean need_video_meta;
148 gboolean has_alpha_component;
150 /* only used if the device supports MPLANE
151 * nb planes is meaning of v4l2 planes
152 * the gstreamer equivalent is gst_buffer_n_memory
156 /* We cache the frame duration if known */
157 GstClockTime duration;
159 /* if the MPLANE device support both contiguous and non contiguous
160 * it allows to select which one we want. But we prefered_non_contiguous
161 * non contiguous mode.
163 gboolean prefered_non_contiguous;
165 /* This will be set if supported in decide_allocation. It can be used to
166 * calculate the minimum latency. */
169 /* This will be set if supported in propose allocation. */
170 guint32 min_buffers_for_output;
173 GstV4l2IOMode req_mode;
178 /* the video device's capabilities */
179 struct v4l2_capability vcap;
180 /* opened device specific capabilities */
183 /* the video device's window properties */
184 struct v4l2_window vwin;
186 /* some more info about the current input's capabilities */
187 struct v4l2_input vinput;
190 GSList *formats; /* list of available capture formats */
191 GstCaps *probed_caps;
202 GstStructure *extra_controls;
203 gboolean keep_aspect;
211 GstV4l2GetInOutFunction get_in_out_func;
212 GstV4l2SetInOutFunction set_in_out_func;
213 GstV4l2UpdateFpsFunction update_fps_func;
216 /* Skips interlacing probes */
217 gboolean never_interlaced;
218 /* Allow to skip reading initial format through G_FMT. Some devices
219 * just fails if you don't call S_FMT first. (ex: M2M decoders) */
220 gboolean no_initial_format;
221 /* Avoid any try_fmt probe. This is used by v4l2src to speedup start up time
222 * on slow USB firmwares. When this is set, gst_v4l2_set_format() will modify
223 * the caps to reflect what was negotiated during fixation */
224 gboolean skip_try_fmt_probes;
227 struct _GstV4l2ObjectClassHelper {
232 GType gst_v4l2_object_get_type (void);
234 #define V4L2_STD_OBJECT_PROPS \
245 PROP_OUTPUT_IO_MODE, \
246 PROP_CAPTURE_IO_MODE, \
247 PROP_EXTRA_CONTROLS, \
248 PROP_PIXEL_ASPECT_RATIO, \
249 PROP_FORCE_ASPECT_RATIO
252 GstV4l2Object* gst_v4l2_object_new (GstElement * element,
253 enum v4l2_buf_type type,
254 const char * default_device,
255 GstV4l2GetInOutFunction get_in_out_func,
256 GstV4l2SetInOutFunction set_in_out_func,
257 GstV4l2UpdateFpsFunction update_fps_func);
259 void gst_v4l2_object_destroy (GstV4l2Object * v4l2object);
263 void gst_v4l2_object_install_properties_helper (GObjectClass * gobject_class,
264 const char * default_device);
266 void gst_v4l2_object_install_m2m_properties_helper (GObjectClass * gobject_class);
268 gboolean gst_v4l2_object_set_property_helper (GstV4l2Object * v4l2object,
270 const GValue * value,
272 gboolean gst_v4l2_object_get_property_helper (GstV4l2Object *v4l2object,
273 guint prop_id, GValue * value,
276 gboolean gst_v4l2_object_open (GstV4l2Object * v4l2object);
277 gboolean gst_v4l2_object_open_shared (GstV4l2Object * v4l2object, GstV4l2Object * other);
278 gboolean gst_v4l2_object_close (GstV4l2Object * v4l2object);
282 GstCaps* gst_v4l2_object_get_all_caps (void);
284 GstCaps* gst_v4l2_object_get_raw_caps (void);
286 GstCaps* gst_v4l2_object_get_codec_caps (void);
288 gint gst_v4l2_object_extrapolate_stride (const GstVideoFormatInfo * finfo,
289 gint plane, gint stride);
291 gboolean gst_v4l2_object_set_format (GstV4l2Object * v4l2object, GstCaps * caps, GstV4l2Error * error);
292 gboolean gst_v4l2_object_try_format (GstV4l2Object * v4l2object, GstCaps * caps, GstV4l2Error * error);
294 gboolean gst_v4l2_object_caps_equal (GstV4l2Object * v4l2object, GstCaps * caps);
296 gboolean gst_v4l2_object_unlock (GstV4l2Object * v4l2object);
297 gboolean gst_v4l2_object_unlock_stop (GstV4l2Object * v4l2object);
299 gboolean gst_v4l2_object_stop (GstV4l2Object * v4l2object);
301 GstCaps * gst_v4l2_object_probe_caps (GstV4l2Object * v4l2object, GstCaps * filter);
302 GstCaps * gst_v4l2_object_get_caps (GstV4l2Object * v4l2object, GstCaps * filter);
304 gboolean gst_v4l2_object_acquire_format (GstV4l2Object * v4l2object, GstVideoInfo * info);
306 gboolean gst_v4l2_object_set_crop (GstV4l2Object * obj);
308 gboolean gst_v4l2_object_decide_allocation (GstV4l2Object * v4l2object, GstQuery * query);
310 gboolean gst_v4l2_object_propose_allocation (GstV4l2Object * obj, GstQuery * query);
312 GstStructure * gst_v4l2_object_v4l2fourcc_to_structure (guint32 fourcc);
314 /* TODO Move to proper namespace */
315 /* open/close the device */
316 gboolean gst_v4l2_open (GstV4l2Object * v4l2object);
317 gboolean gst_v4l2_dup (GstV4l2Object * v4l2object, GstV4l2Object * other);
318 gboolean gst_v4l2_close (GstV4l2Object * v4l2object);
320 /* norm/input/output */
321 gboolean gst_v4l2_get_norm (GstV4l2Object * v4l2object, v4l2_std_id * norm);
322 gboolean gst_v4l2_set_norm (GstV4l2Object * v4l2object, v4l2_std_id norm);
323 gboolean gst_v4l2_get_input (GstV4l2Object * v4l2object, gint * input);
324 gboolean gst_v4l2_set_input (GstV4l2Object * v4l2object, gint input);
325 gboolean gst_v4l2_get_output (GstV4l2Object * v4l2object, gint * output);
326 gboolean gst_v4l2_set_output (GstV4l2Object * v4l2object, gint output);
328 /* frequency control */
329 gboolean gst_v4l2_get_frequency (GstV4l2Object * v4l2object, gint tunernum, gulong * frequency);
330 gboolean gst_v4l2_set_frequency (GstV4l2Object * v4l2object, gint tunernum, gulong frequency);
331 gboolean gst_v4l2_signal_strength (GstV4l2Object * v4l2object, gint tunernum, gulong * signal);
333 /* attribute control */
334 gboolean gst_v4l2_get_attribute (GstV4l2Object * v4l2object, int attribute, int * value);
335 gboolean gst_v4l2_set_attribute (GstV4l2Object * v4l2object, int attribute, const int value);
336 gboolean gst_v4l2_set_controls (GstV4l2Object * v4l2object, GstStructure * controls);
340 #endif /* __GST_V4L2_OBJECT_H__ */