sys/v4l2/gstv4l2object.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  *
   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., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 #ifndef __GST_V4L2_OBJECT_H__
  25 #define __GST_V4L2_OBJECT_H__
  26
  27 /* Because of some really cool feature in video4linux1, also known as
  28  * 'not including sys/types.h and sys/time.h', we had to include it
  29  * ourselves. In all their intelligence, these people decided to fix
  30  * this in the next version (video4linux2) in such a cool way that it
  31  * breaks all compilations of old stuff...
  32  * The real problem is actually that linux/time.h doesn't use proper
  33  * macro checks before defining types like struct timeval. The proper
  34  * fix here is to either fuck the kernel header (which is what we do
  35  * by defining _LINUX_TIME_H, an innocent little hack) or by fixing it
  36  * upstream, which I'll consider doing later on. If you get compiler
  37  * errors here, check your linux/time.h && sys/time.h header setup.
  38  */
  39 #include <sys/ioctl.h>
  40 #include <sys/types.h>
  41 #ifndef __sun
  42 #include <linux/types.h>
  43 #define _LINUX_TIME_H
  44 #define __user
  45 #include <linux/videodev2.h>
  46 #else
  47 #include <sys/videodev2.h>
  48 #endif
  49
  50 #include <gst/gst.h>
  51 #include <gst/base/gstpushsrc.h>
  52 #include <gst/controller/gstcontroller.h>
  53
  54 #include <gst/video/video.h>
  55 #include <gst/interfaces/propertyprobe.h>
  56
  57 typedef struct _GstV4l2Object GstV4l2Object;
  58 typedef struct _GstV4l2ObjectClassHelper GstV4l2ObjectClassHelper;
  59 typedef struct _GstV4l2Xv GstV4l2Xv;
  60
  61 #include <gstv4l2bufferpool.h>
  62
  63 /* size of v4l2 buffer pool in streaming case */
  64 #define GST_V4L2_MAX_BUFFERS 16
  65 #define GST_V4L2_MIN_BUFFERS 1
  66
  67 /* max frame width/height */
  68 #define GST_V4L2_MAX_SIZE (1<<15) /* 2^15 == 32768 */
  69
  70 G_BEGIN_DECLS
  71
  72 #define GST_V4L2_OBJECT(obj) (GstV4l2Object *)(obj)
  73
  74 typedef enum {
  75   GST_V4L2_IO_AUTO    = 0,
  76   GST_V4L2_IO_RW      = 1,
  77   GST_V4L2_IO_MMAP    = 2,
  78   GST_V4L2_IO_USERPTR = 3
  79 } GstV4l2IOMode;
  80
  81 typedef gboolean  (*GstV4l2GetInOutFunction)  (GstV4l2Object * v4l2object, gint * input);
  82 typedef gboolean  (*GstV4l2SetInOutFunction)  (GstV4l2Object * v4l2object, gint input);
  83 typedef gboolean  (*GstV4l2UpdateFpsFunction) (GstV4l2Object * v4l2object);
  84
  85 #define GST_V4L2_WIDTH(o)        (GST_VIDEO_INFO_WIDTH (&(o)->info))
  86 #define GST_V4L2_HEIGHT(o)       (GST_VIDEO_INFO_HEIGHT (&(o)->info))
  87 #define GST_V4L2_PIXELFORMAT(o)  ((o)->fmtdesc->pixelformat)
  88 #define GST_V4L2_FPS_N(o)        (GST_VIDEO_INFO_FPS_N (&(o)->info))
  89 #define GST_V4L2_FPS_D(o)        (GST_VIDEO_INFO_FPS_D (&(o)->info))
  90
  91 /* simple check whether the device is open */
  92 #define GST_V4L2_IS_OPEN(o)      ((o)->video_fd > 0)
  93
  94 /* check whether the device is 'active' */
  95 #define GST_V4L2_IS_ACTIVE(o)    ((o)->active)
  96 #define GST_V4L2_SET_ACTIVE(o)   ((o)->active = TRUE)
  97 #define GST_V4L2_SET_INACTIVE(o) ((o)->active = FALSE)
  98
  99 struct _GstV4l2Object {
 100   GstElement * element;
 101
 102   enum v4l2_buf_type type;   /* V4L2_BUF_TYPE_VIDEO_CAPTURE, V4L2_BUF_TYPE_VIDEO_OUTPUT */
 103
 104   /* the video device */
 105   char *videodev;
 106
 107   /* the video-device's file descriptor */
 108   gint video_fd;
 109   GstV4l2IOMode mode;
 110   GstPoll * poll;
 111   gboolean can_poll_device;
 112
 113   gboolean active;
 114   gboolean streaming;
 115
 116   /* the current format */
 117   struct v4l2_fmtdesc *fmtdesc;
 118   GstVideoInfo info;
 119
 120   guint32 bytesperline;
 121   guint size;
 122   GstClockTime duration;
 123
 124   /* wanted mode */
 125   GstV4l2IOMode req_mode;
 126
 127   /* optional pool */
 128   guint32 num_buffers;
 129   guint32 min_queued_bufs;
 130   gboolean always_copy;
 131   GstBufferPool *pool;
 132
 133   /* the video device's capabilities */
 134   struct v4l2_capability vcap;
 135
 136   /* the video device's window properties */
 137   struct v4l2_window vwin;
 138
 139   /* some more info about the current input's capabilities */
 140   struct v4l2_input vinput;
 141
 142   /* lists... */
 143   GSList *formats;              /* list of available capture formats */
 144
 145   GList *colors;
 146   GList *norms;
 147   GList *channels;
 148
 149   /* properties */
 150   v4l2_std_id tv_norm;
 151   gchar *channel;
 152   gulong frequency;
 153
 154   /* X-overlay */
 155   GstV4l2Xv *xv;
 156   gulong xwindow_id;
 157
 158   /* funcs */
 159   GstV4l2GetInOutFunction  get_in_out_func;
 160   GstV4l2SetInOutFunction  set_in_out_func;
 161   GstV4l2UpdateFpsFunction update_fps_func;
 162 };
 163
 164 struct _GstV4l2ObjectClassHelper {
 165   /* probed devices */
 166   GList *devices;
 167 };
 168
 169 GType gst_v4l2_object_get_type (void);
 170
 171 #define V4L2_STD_OBJECT_PROPS           \
 172     PROP_DEVICE,                        \
 173     PROP_DEVICE_NAME,                   \
 174     PROP_DEVICE_FD,                     \
 175     PROP_FLAGS,                         \
 176     PROP_BRIGHTNESS,                    \
 177     PROP_CONTRAST,                      \
 178     PROP_SATURATION,                    \
 179     PROP_HUE,                           \
 180     PROP_TV_NORM,                       \
 181     PROP_IO_MODE
 182
 183 /* create/destroy */
 184 GstV4l2Object * gst_v4l2_object_new              (GstElement * element,
 185                                                   enum v4l2_buf_type  type,
 186                                                   const char *default_device,
 187                                                   GstV4l2GetInOutFunction get_in_out_func,
 188                                                   GstV4l2SetInOutFunction set_in_out_func,
 189                                                   GstV4l2UpdateFpsFunction   update_fps_func);
 190 void            gst_v4l2_object_destroy          (GstV4l2Object * v4l2object);
 191
 192 /* properties */
 193
 194 void      gst_v4l2_object_install_properties_helper (GObjectClass *gobject_class, const char *default_device);
 195
 196 gboolean  gst_v4l2_object_set_property_helper       (GstV4l2Object *v4l2object,
 197                                                      guint prop_id, const GValue * value,
 198                                                      GParamSpec * pspec);
 199 gboolean  gst_v4l2_object_get_property_helper       (GstV4l2Object *v4l2object,
 200                                                      guint prop_id, GValue * value,
 201                                                      GParamSpec * pspec);
 202 /* open/close */
 203 gboolean  gst_v4l2_object_open               (GstV4l2Object *v4l2object);
 204 gboolean  gst_v4l2_object_close              (GstV4l2Object *v4l2object);
 205
 206 /* probing */
 207 const GList* gst_v4l2_probe_get_properties  (GstPropertyProbe * probe);
 208
 209 void         gst_v4l2_probe_probe_property  (GstPropertyProbe * probe, guint prop_id,
 210                                              const GParamSpec * pspec,
 211                                              GList ** klass_devices);
 212 gboolean     gst_v4l2_probe_needs_probe     (GstPropertyProbe * probe, guint prop_id,
 213                                              const GParamSpec * pspec,
 214                                              GList ** klass_devices);
 215 GValueArray* gst_v4l2_probe_get_values      (GstPropertyProbe * probe, guint prop_id,
 216                                              const GParamSpec * pspec,
 217                                              GList ** klass_devices);
 218
 219 GstCaps*      gst_v4l2_object_probe_caps_for_format (GstV4l2Object *v4l2object, guint32 pixelformat,
 220                                              const GstStructure * template);
 221
 222 GSList*       gst_v4l2_object_get_format_list  (GstV4l2Object *v4l2object);
 223
 224 GstCaps*      gst_v4l2_object_get_all_caps (void);
 225
 226 GstStructure* gst_v4l2_object_v4l2fourcc_to_structure (guint32 fourcc);
 227
 228 gboolean      gst_v4l2_object_set_format (GstV4l2Object *v4l2object, GstCaps * caps);
 229
 230 gboolean      gst_v4l2_object_unlock      (GstV4l2Object *v4l2object);
 231 gboolean      gst_v4l2_object_unlock_stop (GstV4l2Object *v4l2object);
 232
 233 gboolean      gst_v4l2_object_stop        (GstV4l2Object *v4l2object);
 234
 235
 236 gboolean      gst_v4l2_object_copy        (GstV4l2Object * v4l2object,
 237                                            GstBuffer * dest, GstBuffer *src);
 238
 239
 240 #define GST_IMPLEMENT_V4L2_PROBE_METHODS(Type_Class, interface_as_function)                 \
 241                                                                                             \
 242 static void                                                                                 \
 243 interface_as_function ## _probe_probe_property (GstPropertyProbe * probe,                   \
 244                                                 guint prop_id,                              \
 245                                                 const GParamSpec * pspec)                   \
 246 {                                                                                           \
 247   Type_Class *this_class = (Type_Class*) G_OBJECT_GET_CLASS (probe);                        \
 248   gst_v4l2_probe_probe_property (probe, prop_id, pspec,                                     \
 249                                         &this_class->v4l2_class_devices);                   \
 250 }                                                                                           \
 251                                                                                             \
 252 static gboolean                                                                             \
 253 interface_as_function ## _probe_needs_probe (GstPropertyProbe * probe,                      \
 254                                              guint prop_id,                                 \
 255                                              const GParamSpec * pspec)                      \
 256 {                                                                                           \
 257   Type_Class *this_class = (Type_Class*) G_OBJECT_GET_CLASS (probe);                        \
 258   return gst_v4l2_probe_needs_probe (probe, prop_id, pspec,                                 \
 259                                         &this_class->v4l2_class_devices);                   \
 260 }                                                                                           \
 261                                                                                             \
 262 static GValueArray *                                                                        \
 263 interface_as_function ## _probe_get_values (GstPropertyProbe * probe,                       \
 264                                             guint prop_id,                                  \
 265                                             const GParamSpec * pspec)                       \
 266 {                                                                                           \
 267   Type_Class *this_class = (Type_Class*) G_OBJECT_GET_CLASS (probe);                        \
 268   return gst_v4l2_probe_get_values (probe, prop_id, pspec,                                  \
 269                                     &this_class->v4l2_class_devices);                       \
 270 }                                                                                           \
 271                                                                                             \
 272 static void                                                                                 \
 273 interface_as_function ## _property_probe_interface_init (GstPropertyProbeInterface * iface) \
 274 {                                                                                           \
 275   iface->get_properties = gst_v4l2_probe_get_properties;                                    \
 276   iface->probe_property = interface_as_function ## _probe_probe_property;                   \
 277   iface->needs_probe = interface_as_function ## _probe_needs_probe;                         \
 278   iface->get_values = interface_as_function ## _probe_get_values;                                            \
 279 }
 280
 281 G_END_DECLS
 282
 283 #endif /* __GST_V4L2_OBJECT_H__ */