sys/v4l2/gstv4l2object.h

   1 /* GStreamer
   2  *
   3  * Copyright (C) 2001-2002 Ronald Bultje <rbultje@ronald.bitfreak.net>
   4  *               2006 Edgard Lima <edgard.lima@gmail.com>
   5  *
   6  * gstv4l2object.h: base class for V4L2 elements
   7  *
   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.
  12  *
  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.
  17  *
  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.
  22  */
  23
  24 #ifndef __GST_V4L2_OBJECT_H__
  25 #define __GST_V4L2_OBJECT_H__
  26
  27 #include "ext/videodev2.h"
  28 #ifdef HAVE_LIBV4L2
  29 #  include <libv4l2.h>
  30 #endif
  31
  32 #include "v4l2-utils.h"
  33
  34 #include <gst/gst.h>
  35 #include <gst/base/gstpushsrc.h>
  36
  37 #include <gst/video/video.h>
  38 #include <unistd.h>
  39
  40 typedef struct _GstV4l2Object GstV4l2Object;
  41 typedef struct _GstV4l2ObjectClassHelper GstV4l2ObjectClassHelper;
  42
  43 #include <gstv4l2bufferpool.h>
  44
  45 /* size of v4l2 buffer pool in streaming case */
  46 #define GST_V4L2_MIN_BUFFERS 2
  47
  48 /* max frame width/height */
  49 #define GST_V4L2_MAX_SIZE (1<<15) /* 2^15 == 32768 */
  50
  51 G_BEGIN_DECLS
  52
  53 #define GST_TYPE_V4L2_IO_MODE (gst_v4l2_io_mode_get_type ())
  54 GType gst_v4l2_io_mode_get_type (void);
  55
  56 #define GST_V4L2_OBJECT(obj) (GstV4l2Object *)(obj)
  57
  58 typedef enum {
  59   GST_V4L2_IO_AUTO          = 0,
  60   GST_V4L2_IO_RW            = 1,
  61   GST_V4L2_IO_MMAP          = 2,
  62   GST_V4L2_IO_USERPTR       = 3,
  63   GST_V4L2_IO_DMABUF        = 4,
  64   GST_V4L2_IO_DMABUF_IMPORT = 5
  65 } GstV4l2IOMode;
  66
  67 typedef gboolean  (*GstV4l2GetInOutFunction)  (GstV4l2Object * v4l2object, gint * input);
  68 typedef gboolean  (*GstV4l2SetInOutFunction)  (GstV4l2Object * v4l2object, gint input);
  69 typedef gboolean  (*GstV4l2UpdateFpsFunction) (GstV4l2Object * v4l2object);
  70
  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))
  76
  77 /* simple check whether the device is open */
  78 #define GST_V4L2_IS_OPEN(o)      ((o)->video_fd > 0)
  79
  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)
  84
  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))                            \
  88   {                                                             \
  89     GST_ELEMENT_ERROR (v4l2object->element, RESOURCE, SETTINGS, \
  90       (_("Device is not open.")), (NULL));                      \
  91     return FALSE;                                               \
  92   }
  93
  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))                             \
  97   {                                                             \
  98     GST_ELEMENT_ERROR (v4l2object->element, RESOURCE, SETTINGS, \
  99       (_("Device is open.")), (NULL));                          \
 100     return FALSE;                                               \
 101   }
 102
 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))                           \
 106   {                                                             \
 107     GST_ELEMENT_ERROR (v4l2object->element, RESOURCE, SETTINGS, \
 108       (NULL), ("Device is in streaming mode"));                 \
 109     return FALSE;                                               \
 110   }
 111
 112
 113 struct _GstV4l2Object {
 114   GstElement * element;
 115   GstObject * dbg_obj;
 116
 117   enum v4l2_buf_type type;   /* V4L2_BUF_TYPE_VIDEO_CAPTURE, V4L2_BUF_TYPE_VIDEO_OUTPUT */
 118
 119   /* the video device */
 120   char *videodev;
 121
 122   /* the video-device's file descriptor */
 123   gint video_fd;
 124   GstV4l2IOMode mode;
 125
 126   gboolean active;
 127   gboolean streaming;
 128
 129   /* the current format */
 130   struct v4l2_fmtdesc *fmtdesc;
 131   struct v4l2_format format;
 132   GstVideoInfo info;
 133   GstVideoAlignment align;
 134
 135   /* Features */
 136   gboolean need_video_meta;
 137   gboolean has_alpha_component;
 138
 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
 142    */
 143   gint n_v4l2_planes;
 144
 145   /* We cache the frame duration if known */
 146   GstClockTime duration;
 147
 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.
 151    */
 152   gboolean prefered_non_contiguous;
 153
 154   /* This will be set if supported in decide_allocation. It can be used to
 155    * calculate the minimum latency. */
 156   guint32 min_buffers;
 157
 158   /* wanted mode */
 159   GstV4l2IOMode req_mode;
 160
 161   /* optional pool */
 162   GstBufferPool *pool;
 163
 164   /* the video device's capabilities */
 165   struct v4l2_capability vcap;
 166   /* opened device specific capabilities */
 167   guint32 device_caps;
 168
 169   /* lists... */
 170   GSList *formats;              /* list of available capture formats */
 171   GstCaps *probed_caps;
 172
 173   GList *colors;
 174   GList *norms;
 175   GList *channels;
 176   GData *controls;
 177
 178   /* properties */
 179   v4l2_std_id tv_norm;
 180   gchar *channel;
 181   gulong frequency;
 182   GstStructure *extra_controls;
 183   gboolean keep_aspect;
 184   GValue *par;
 185
 186   /* funcs */
 187   GstV4l2GetInOutFunction  get_in_out_func;
 188   GstV4l2SetInOutFunction  set_in_out_func;
 189   GstV4l2UpdateFpsFunction update_fps_func;
 190
 191   /* syscalls */
 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);
 200
 201   /* Quirks */
 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;
 211 };
 212
 213 struct _GstV4l2ObjectClassHelper {
 214   /* probed devices */
 215   GList *devices;
 216 };
 217
 218 GType gst_v4l2_object_get_type (void);
 219
 220 #define V4L2_STD_OBJECT_PROPS \
 221     PROP_DEVICE,              \
 222     PROP_DEVICE_NAME,         \
 223     PROP_DEVICE_FD,           \
 224     PROP_FLAGS,               \
 225     PROP_BRIGHTNESS,          \
 226     PROP_CONTRAST,            \
 227     PROP_SATURATION,          \
 228     PROP_HUE,                 \
 229     PROP_TV_NORM,             \
 230     PROP_IO_MODE,             \
 231     PROP_OUTPUT_IO_MODE,      \
 232     PROP_CAPTURE_IO_MODE,     \
 233     PROP_EXTRA_CONTROLS,      \
 234     PROP_PIXEL_ASPECT_RATIO,  \
 235     PROP_FORCE_ASPECT_RATIO
 236
 237 /* create/destroy */
 238 GstV4l2Object*  gst_v4l2_object_new       (GstElement * element,
 239                                            GstObject * dbg_obj,
 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);
 245
 246 void         gst_v4l2_object_destroy   (GstV4l2Object * v4l2object);
 247
 248 /* properties */
 249
 250 void         gst_v4l2_object_install_properties_helper (GObjectClass * gobject_class,
 251                                                         const char * default_device);
 252
 253 void         gst_v4l2_object_install_m2m_properties_helper (GObjectClass * gobject_class);
 254
 255 gboolean     gst_v4l2_object_set_property_helper       (GstV4l2Object * v4l2object,
 256                                                         guint prop_id,
 257                                                         const GValue * value,
 258                                                         GParamSpec * pspec);
 259 gboolean     gst_v4l2_object_get_property_helper       (GstV4l2Object *v4l2object,
 260                                                         guint prop_id, GValue * value,
 261                                                         GParamSpec * pspec);
 262 /* open/close */
 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);
 266
 267 /* probing */
 268
 269 GstCaps*     gst_v4l2_object_get_all_caps (void);
 270
 271 GstCaps*     gst_v4l2_object_get_raw_caps (void);
 272
 273 GstCaps*     gst_v4l2_object_get_codec_caps (void);
 274
 275 gint         gst_v4l2_object_extrapolate_stride (const GstVideoFormatInfo * finfo,
 276                                                   gint plane, gint stride);
 277
 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);
 280
 281 gboolean     gst_v4l2_object_caps_equal  (GstV4l2Object * v4l2object, GstCaps * caps);
 282
 283 gboolean     gst_v4l2_object_unlock      (GstV4l2Object * v4l2object);
 284 gboolean     gst_v4l2_object_unlock_stop (GstV4l2Object * v4l2object);
 285
 286 gboolean     gst_v4l2_object_stop        (GstV4l2Object * v4l2object);
 287
 288 GstCaps *    gst_v4l2_object_probe_caps  (GstV4l2Object * v4l2object, GstCaps * filter);
 289 GstCaps *    gst_v4l2_object_get_caps    (GstV4l2Object * v4l2object, GstCaps * filter);
 290
 291 gboolean     gst_v4l2_object_acquire_format (GstV4l2Object * v4l2object, GstVideoInfo * info);
 292
 293 gboolean     gst_v4l2_object_set_crop    (GstV4l2Object * obj);
 294
 295 gboolean     gst_v4l2_object_decide_allocation (GstV4l2Object * v4l2object, GstQuery * query);
 296
 297 gboolean     gst_v4l2_object_propose_allocation (GstV4l2Object * obj, GstQuery * query);
 298
 299 GstStructure * gst_v4l2_object_v4l2fourcc_to_structure (guint32 fourcc);
 300
 301 /* TODO Move to proper namespace */
 302 /* open/close the device */
 303 gboolean     gst_v4l2_open           (GstV4l2Object * v4l2object);
 304 gboolean     gst_v4l2_dup            (GstV4l2Object * v4l2object, GstV4l2Object * other);
 305 gboolean     gst_v4l2_close          (GstV4l2Object * v4l2object);
 306
 307 /* norm/input/output */
 308 gboolean     gst_v4l2_get_norm       (GstV4l2Object * v4l2object, v4l2_std_id * norm);
 309 gboolean     gst_v4l2_set_norm       (GstV4l2Object * v4l2object, v4l2_std_id norm);
 310 gboolean     gst_v4l2_get_input      (GstV4l2Object * v4l2object, gint * input);
 311 gboolean     gst_v4l2_set_input      (GstV4l2Object * v4l2object, gint input);
 312 gboolean     gst_v4l2_get_output     (GstV4l2Object * v4l2object, gint * output);
 313 gboolean     gst_v4l2_set_output     (GstV4l2Object * v4l2object, gint output);
 314
 315 /* frequency control */
 316 gboolean     gst_v4l2_get_frequency   (GstV4l2Object * v4l2object, gint tunernum, gulong * frequency);
 317 gboolean     gst_v4l2_set_frequency   (GstV4l2Object * v4l2object, gint tunernum, gulong frequency);
 318 gboolean     gst_v4l2_signal_strength (GstV4l2Object * v4l2object, gint tunernum, gulong * signal);
 319
 320 /* attribute control */
 321 gboolean     gst_v4l2_get_attribute   (GstV4l2Object * v4l2object, int attribute, int * value);
 322 gboolean     gst_v4l2_set_attribute   (GstV4l2Object * v4l2object, int attribute, const int value);
 323 gboolean     gst_v4l2_set_controls    (GstV4l2Object * v4l2object, GstStructure * controls);
 324
 325 G_END_DECLS
 326
 327 #endif /* __GST_V4L2_OBJECT_H__ */