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__
27 #include "ext/videodev2.h"
32 #include "v4l2-utils.h"
35 #include <gst/base/gstpushsrc.h>
37 #include <gst/video/video.h>
40 typedef struct _GstV4l2Object GstV4l2Object;
41 typedef struct _GstV4l2ObjectClassHelper GstV4l2ObjectClassHelper;
43 #include <gstv4l2bufferpool.h>
45 /* size of v4l2 buffer pool in streaming case */
46 #define GST_V4L2_MIN_BUFFERS 2
48 /* max frame width/height */
49 #define GST_V4L2_MAX_SIZE (1<<15) /* 2^15 == 32768 */
53 #define GST_TYPE_V4L2_IO_MODE (gst_v4l2_io_mode_get_type ())
54 GType gst_v4l2_io_mode_get_type (void);
56 #define GST_V4L2_OBJECT(obj) (GstV4l2Object *)(obj)
62 GST_V4L2_IO_USERPTR = 3,
63 GST_V4L2_IO_DMABUF = 4,
64 GST_V4L2_IO_DMABUF_IMPORT = 5
67 typedef gboolean (*GstV4l2GetInOutFunction) (GstV4l2Object * v4l2object, gint * input);
68 typedef gboolean (*GstV4l2SetInOutFunction) (GstV4l2Object * v4l2object, gint input);
69 typedef gboolean (*GstV4l2UpdateFpsFunction) (GstV4l2Object * v4l2object);
71 #define GST_V4L2_WIDTH(o) (GST_VIDEO_INFO_WIDTH (&(o)->info))
72 #define GST_V4L2_HEIGHT(o) (GST_VIDEO_INFO_HEIGHT (&(o)->info))
73 #define GST_V4L2_PIXELFORMAT(o) ((o)->fmtdesc->pixelformat)
74 #define GST_V4L2_FPS_N(o) (GST_VIDEO_INFO_FPS_N (&(o)->info))
75 #define GST_V4L2_FPS_D(o) (GST_VIDEO_INFO_FPS_D (&(o)->info))
77 /* simple check whether the device is open */
78 #define GST_V4L2_IS_OPEN(o) ((o)->video_fd > 0)
80 /* check whether the device is 'active' */
81 #define GST_V4L2_IS_ACTIVE(o) ((o)->active)
82 #define GST_V4L2_SET_ACTIVE(o) ((o)->active = TRUE)
83 #define GST_V4L2_SET_INACTIVE(o) ((o)->active = FALSE)
85 /* checks whether the current v4lv4l2object has already been open()'ed or not */
86 #define GST_V4L2_CHECK_OPEN(v4l2object) \
87 if (!GST_V4L2_IS_OPEN(v4l2object)) \
89 GST_ELEMENT_ERROR (v4l2object->element, RESOURCE, SETTINGS, \
90 (_("Device is not open.")), (NULL)); \
94 /* checks whether the current v4lv4l2object is close()'ed or whether it is still open */
95 #define GST_V4L2_CHECK_NOT_OPEN(v4l2object) \
96 if (GST_V4L2_IS_OPEN(v4l2object)) \
98 GST_ELEMENT_ERROR (v4l2object->element, RESOURCE, SETTINGS, \
99 (_("Device is open.")), (NULL)); \
103 /* checks whether we're out of capture mode or not */
104 #define GST_V4L2_CHECK_NOT_ACTIVE(v4l2object) \
105 if (GST_V4L2_IS_ACTIVE(v4l2object)) \
107 GST_ELEMENT_ERROR (v4l2object->element, RESOURCE, SETTINGS, \
108 (NULL), ("Device is in streaming mode")); \
113 struct _GstV4l2Object {
114 GstElement * element;
117 enum v4l2_buf_type type; /* V4L2_BUF_TYPE_VIDEO_CAPTURE, V4L2_BUF_TYPE_VIDEO_OUTPUT */
119 /* the video device */
122 /* the video-device's file descriptor */
129 /* the current format */
130 struct v4l2_fmtdesc *fmtdesc;
131 struct v4l2_format format;
133 GstVideoAlignment align;
136 gboolean need_video_meta;
137 gboolean has_alpha_component;
139 /* only used if the device supports MPLANE
140 * nb planes is meaning of v4l2 planes
141 * the gstreamer equivalent is gst_buffer_n_memory
145 /* We cache the frame duration if known */
146 GstClockTime duration;
148 /* if the MPLANE device support both contiguous and non contiguous
149 * it allows to select which one we want. But we prefered_non_contiguous
150 * non contiguous mode.
152 gboolean prefered_non_contiguous;
154 /* This will be set if supported in decide_allocation. It can be used to
155 * calculate the minimum latency. */
159 GstV4l2IOMode req_mode;
164 /* the video device's capabilities */
165 struct v4l2_capability vcap;
166 /* opened device specific capabilities */
170 GSList *formats; /* list of available capture formats */
171 GstCaps *probed_caps;
182 GstStructure *extra_controls;
183 gboolean keep_aspect;
187 GstV4l2GetInOutFunction get_in_out_func;
188 GstV4l2SetInOutFunction set_in_out_func;
189 GstV4l2UpdateFpsFunction update_fps_func;
192 gint (*fd_open) (gint fd, gint v4l2_flags);
193 gint (*close) (gint fd);
194 gint (*dup) (gint fd);
195 gint (*ioctl) (gint fd, gulong request, ...);
196 gssize (*read) (gint fd, gpointer buffer, gsize n);
197 gpointer (*mmap) (gpointer start, gsize length, gint prot, gint flags,
198 gint fd, off_t offset);
199 gint (*munmap) (gpointer _start, gsize length);
202 /* Skips interlacing probes */
203 gboolean never_interlaced;
204 /* Allow to skip reading initial format through G_FMT. Some devices
205 * just fails if you don't call S_FMT first. (ex: M2M decoders) */
206 gboolean no_initial_format;
207 /* Avoid any try_fmt probe. This is used by v4l2src to speedup start up time
208 * on slow USB firmwares. When this is set, gst_v4l2_set_format() will modify
209 * the caps to reflect what was negotiated during fixation */
210 gboolean skip_try_fmt_probes;
213 struct _GstV4l2ObjectClassHelper {
218 GType gst_v4l2_object_get_type (void);
220 #define V4L2_STD_OBJECT_PROPS \
231 PROP_OUTPUT_IO_MODE, \
232 PROP_CAPTURE_IO_MODE, \
233 PROP_EXTRA_CONTROLS, \
234 PROP_PIXEL_ASPECT_RATIO, \
235 PROP_FORCE_ASPECT_RATIO
238 GstV4l2Object* gst_v4l2_object_new (GstElement * element,
240 enum v4l2_buf_type type,
241 const char * default_device,
242 GstV4l2GetInOutFunction get_in_out_func,
243 GstV4l2SetInOutFunction set_in_out_func,
244 GstV4l2UpdateFpsFunction update_fps_func);
246 void gst_v4l2_object_destroy (GstV4l2Object * v4l2object);
250 void gst_v4l2_object_install_properties_helper (GObjectClass * gobject_class,
251 const char * default_device);
253 void gst_v4l2_object_install_m2m_properties_helper (GObjectClass * gobject_class);
255 gboolean gst_v4l2_object_set_property_helper (GstV4l2Object * v4l2object,
257 const GValue * value,
259 gboolean gst_v4l2_object_get_property_helper (GstV4l2Object *v4l2object,
260 guint prop_id, GValue * value,
263 gboolean gst_v4l2_object_open (GstV4l2Object * v4l2object);
264 gboolean gst_v4l2_object_open_shared (GstV4l2Object * v4l2object, GstV4l2Object * other);
265 gboolean gst_v4l2_object_close (GstV4l2Object * v4l2object);
269 GstCaps* gst_v4l2_object_get_all_caps (void);
271 GstCaps* gst_v4l2_object_get_raw_caps (void);
273 GstCaps* gst_v4l2_object_get_codec_caps (void);
275 gint gst_v4l2_object_extrapolate_stride (const GstVideoFormatInfo * finfo,
276 gint plane, gint stride);
278 gboolean gst_v4l2_object_set_format (GstV4l2Object * v4l2object, GstCaps * caps, GstV4l2Error * error);
279 gboolean gst_v4l2_object_try_format (GstV4l2Object * v4l2object, GstCaps * caps, GstV4l2Error * error);
281 gboolean gst_v4l2_object_caps_equal (GstV4l2Object * v4l2object, GstCaps * caps);
282 gboolean gst_v4l2_object_caps_is_subset (GstV4l2Object * v4l2object, GstCaps * caps);
283 GstCaps * gst_v4l2_object_get_current_caps (GstV4l2Object * v4l2object);
285 gboolean gst_v4l2_object_unlock (GstV4l2Object * v4l2object);
286 gboolean gst_v4l2_object_unlock_stop (GstV4l2Object * v4l2object);
288 gboolean gst_v4l2_object_stop (GstV4l2Object * v4l2object);
290 GstCaps * gst_v4l2_object_probe_caps (GstV4l2Object * v4l2object, GstCaps * filter);
291 GstCaps * gst_v4l2_object_get_caps (GstV4l2Object * v4l2object, GstCaps * filter);
293 gboolean gst_v4l2_object_acquire_format (GstV4l2Object * v4l2object, GstVideoInfo * info);
295 gboolean gst_v4l2_object_set_crop (GstV4l2Object * obj);
297 gboolean gst_v4l2_object_decide_allocation (GstV4l2Object * v4l2object, GstQuery * query);
299 gboolean gst_v4l2_object_propose_allocation (GstV4l2Object * obj, GstQuery * query);
301 GstStructure * gst_v4l2_object_v4l2fourcc_to_structure (guint32 fourcc);
303 /* TODO Move to proper namespace */
304 /* open/close the device */
305 gboolean gst_v4l2_open (GstV4l2Object * v4l2object);
306 gboolean gst_v4l2_dup (GstV4l2Object * v4l2object, GstV4l2Object * other);
307 gboolean gst_v4l2_close (GstV4l2Object * v4l2object);
309 /* norm/input/output */
310 gboolean gst_v4l2_get_norm (GstV4l2Object * v4l2object, v4l2_std_id * norm);
311 gboolean gst_v4l2_set_norm (GstV4l2Object * v4l2object, v4l2_std_id norm);
312 gboolean gst_v4l2_get_input (GstV4l2Object * v4l2object, gint * input);
313 gboolean gst_v4l2_set_input (GstV4l2Object * v4l2object, gint input);
314 gboolean gst_v4l2_get_output (GstV4l2Object * v4l2object, gint * output);
315 gboolean gst_v4l2_set_output (GstV4l2Object * v4l2object, gint output);
317 /* frequency control */
318 gboolean gst_v4l2_get_frequency (GstV4l2Object * v4l2object, gint tunernum, gulong * frequency);
319 gboolean gst_v4l2_set_frequency (GstV4l2Object * v4l2object, gint tunernum, gulong frequency);
320 gboolean gst_v4l2_signal_strength (GstV4l2Object * v4l2object, gint tunernum, gulong * signal);
322 /* attribute control */
323 gboolean gst_v4l2_get_attribute (GstV4l2Object * v4l2object, int attribute, int * value);
324 gboolean gst_v4l2_set_attribute (GstV4l2Object * v4l2object, int attribute, const int value);
325 gboolean gst_v4l2_set_controls (GstV4l2Object * v4l2object, GstStructure * controls);
329 #endif /* __GST_V4L2_OBJECT_H__ */