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
  53 #include <gst/video/video.h>
  54
  55 typedef struct _GstV4l2Object GstV4l2Object;
  56 typedef struct _GstV4l2ObjectClassHelper GstV4l2ObjectClassHelper;
  57 typedef struct _GstV4l2Xv GstV4l2Xv;
  58
  59 #include <gstv4l2bufferpool.h>
  60
  61 /* size of v4l2 buffer pool in streaming case */
  62 #define GST_V4L2_MAX_BUFFERS 16
  63 #define GST_V4L2_MIN_BUFFERS 1
  64
  65 /* max frame width/height */
  66 #define GST_V4L2_MAX_SIZE (1<<15) /* 2^15 == 32768 */
  67
  68 G_BEGIN_DECLS
  69
  70 #define GST_V4L2_OBJECT(obj) (GstV4l2Object *)(obj)
  71
  72 typedef enum {
  73   GST_V4L2_IO_AUTO    = 0,
  74   GST_V4L2_IO_RW      = 1,
  75   GST_V4L2_IO_MMAP    = 2,
  76   GST_V4L2_IO_USERPTR = 3
  77 } GstV4l2IOMode;
  78
  79 typedef gboolean  (*GstV4l2GetInOutFunction)  (GstV4l2Object * v4l2object, gint * input);
  80 typedef gboolean  (*GstV4l2SetInOutFunction)  (GstV4l2Object * v4l2object, gint input);
  81 typedef gboolean  (*GstV4l2UpdateFpsFunction) (GstV4l2Object * v4l2object);
  82
  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))
  88
  89 /* simple check whether the device is open */
  90 #define GST_V4L2_IS_OPEN(o)      ((o)->video_fd > 0)
  91
  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)
  96
  97 struct _GstV4l2Object {
  98   GstElement * element;
  99
 100   enum v4l2_buf_type type;   /* V4L2_BUF_TYPE_VIDEO_CAPTURE, V4L2_BUF_TYPE_VIDEO_OUTPUT */
 101
 102   /* the video device */
 103   char *videodev;
 104
 105   /* the video-device's file descriptor */
 106   gint video_fd;
 107   GstV4l2IOMode mode;
 108   GstPoll * poll;
 109   gboolean can_poll_device;
 110
 111   gboolean active;
 112   gboolean streaming;
 113
 114   /* the current format */
 115   struct v4l2_fmtdesc *fmtdesc;
 116   GstVideoInfo info;
 117
 118   guint32 bytesperline;
 119   guint32 sizeimage;
 120   GstClockTime duration;
 121
 122   /* wanted mode */
 123   GstV4l2IOMode req_mode;
 124
 125   /* optional pool */
 126   gboolean always_copy;
 127   GstBufferPool *pool;
 128
 129   /* the video device's capabilities */
 130   struct v4l2_capability vcap;
 131
 132   /* the video device's window properties */
 133   struct v4l2_window vwin;
 134
 135   /* some more info about the current input's capabilities */
 136   struct v4l2_input vinput;
 137
 138   /* lists... */
 139   GSList *formats;              /* list of available capture formats */
 140
 141   GList *colors;
 142   GList *norms;
 143   GList *channels;
 144
 145   /* properties */
 146   v4l2_std_id tv_norm;
 147   gchar *channel;
 148   gulong frequency;
 149
 150   /* X-overlay */
 151   GstV4l2Xv *xv;
 152   gulong xwindow_id;
 153
 154   /* funcs */
 155   GstV4l2GetInOutFunction  get_in_out_func;
 156   GstV4l2SetInOutFunction  set_in_out_func;
 157   GstV4l2UpdateFpsFunction update_fps_func;
 158 };
 159
 160 struct _GstV4l2ObjectClassHelper {
 161   /* probed devices */
 162   GList *devices;
 163 };
 164
 165 GType gst_v4l2_object_get_type (void);
 166
 167 #define V4L2_STD_OBJECT_PROPS           \
 168     PROP_DEVICE,                        \
 169     PROP_DEVICE_NAME,                   \
 170     PROP_DEVICE_FD,                     \
 171     PROP_FLAGS,                         \
 172     PROP_BRIGHTNESS,                    \
 173     PROP_CONTRAST,                      \
 174     PROP_SATURATION,                    \
 175     PROP_HUE,                           \
 176     PROP_TV_NORM,                       \
 177     PROP_IO_MODE
 178
 179 /* create/destroy */
 180 GstV4l2Object * gst_v4l2_object_new              (GstElement * element,
 181                                                   enum v4l2_buf_type  type,
 182                                                   const char *default_device,
 183                                                   GstV4l2GetInOutFunction get_in_out_func,
 184                                                   GstV4l2SetInOutFunction set_in_out_func,
 185                                                   GstV4l2UpdateFpsFunction   update_fps_func);
 186 void            gst_v4l2_object_destroy          (GstV4l2Object * v4l2object);
 187
 188 /* properties */
 189
 190 void      gst_v4l2_object_install_properties_helper (GObjectClass *gobject_class, const char *default_device);
 191
 192 gboolean  gst_v4l2_object_set_property_helper       (GstV4l2Object *v4l2object,
 193                                                      guint prop_id, const GValue * value,
 194                                                      GParamSpec * pspec);
 195 gboolean  gst_v4l2_object_get_property_helper       (GstV4l2Object *v4l2object,
 196                                                      guint prop_id, GValue * value,
 197                                                      GParamSpec * pspec);
 198 /* open/close */
 199 gboolean  gst_v4l2_object_open               (GstV4l2Object *v4l2object);
 200 gboolean  gst_v4l2_object_close              (GstV4l2Object *v4l2object);
 201
 202 /* probing */
 203 #if 0
 204 const GList* gst_v4l2_probe_get_properties  (GstPropertyProbe * probe);
 205
 206 void         gst_v4l2_probe_probe_property  (GstPropertyProbe * probe, guint prop_id,
 207                                              const GParamSpec * pspec,
 208                                              GList ** klass_devices);
 209 gboolean     gst_v4l2_probe_needs_probe     (GstPropertyProbe * probe, guint prop_id,
 210                                              const GParamSpec * pspec,
 211                                              GList ** klass_devices);
 212 GValueArray* gst_v4l2_probe_get_values      (GstPropertyProbe * probe, guint prop_id,
 213                                              const GParamSpec * pspec,
 214                                              GList ** klass_devices);
 215 #endif
 216
 217 GstCaps*      gst_v4l2_object_probe_caps_for_format (GstV4l2Object *v4l2object, guint32 pixelformat,
 218                                              const GstStructure * template);
 219
 220 GSList*       gst_v4l2_object_get_format_list  (GstV4l2Object *v4l2object);
 221
 222 GstCaps*      gst_v4l2_object_get_all_caps (void);
 223
 224 GstStructure* gst_v4l2_object_v4l2fourcc_to_structure (guint32 fourcc);
 225
 226 gboolean      gst_v4l2_object_set_format (GstV4l2Object *v4l2object, GstCaps * caps);
 227
 228 gboolean      gst_v4l2_object_unlock      (GstV4l2Object *v4l2object);
 229 gboolean      gst_v4l2_object_unlock_stop (GstV4l2Object *v4l2object);
 230
 231 gboolean      gst_v4l2_object_stop        (GstV4l2Object *v4l2object);
 232
 233
 234 gboolean      gst_v4l2_object_copy        (GstV4l2Object * v4l2object,
 235                                            GstBuffer * dest, GstBuffer *src);
 236
 237
 238 #define GST_IMPLEMENT_V4L2_PROBE_METHODS(Type_Class, interface_as_function)                 \
 239                                                                                             \
 240 static void                                                                                 \
 241 interface_as_function ## _probe_probe_property (GstPropertyProbe * probe,                   \
 242                                                 guint prop_id,                              \
 243                                                 const GParamSpec * pspec)                   \
 244 {                                                                                           \
 245   Type_Class *this_class = (Type_Class*) G_OBJECT_GET_CLASS (probe);                        \
 246   gst_v4l2_probe_probe_property (probe, prop_id, pspec,                                     \
 247                                         &this_class->v4l2_class_devices);                   \
 248 }                                                                                           \
 249                                                                                             \
 250 static gboolean                                                                             \
 251 interface_as_function ## _probe_needs_probe (GstPropertyProbe * probe,                      \
 252                                              guint prop_id,                                 \
 253                                              const GParamSpec * pspec)                      \
 254 {                                                                                           \
 255   Type_Class *this_class = (Type_Class*) G_OBJECT_GET_CLASS (probe);                        \
 256   return gst_v4l2_probe_needs_probe (probe, prop_id, pspec,                                 \
 257                                         &this_class->v4l2_class_devices);                   \
 258 }                                                                                           \
 259                                                                                             \
 260 static GValueArray *                                                                        \
 261 interface_as_function ## _probe_get_values (GstPropertyProbe * probe,                       \
 262                                             guint prop_id,                                  \
 263                                             const GParamSpec * pspec)                       \
 264 {                                                                                           \
 265   Type_Class *this_class = (Type_Class*) G_OBJECT_GET_CLASS (probe);                        \
 266   return gst_v4l2_probe_get_values (probe, prop_id, pspec,                                  \
 267                                     &this_class->v4l2_class_devices);                       \
 268 }                                                                                           \
 269                                                                                             \
 270 static void                                                                                 \
 271 interface_as_function ## _property_probe_interface_init (GstPropertyProbeInterface * iface) \
 272 {                                                                                           \
 273   iface->get_properties = gst_v4l2_probe_get_properties;                                    \
 274   iface->probe_property = interface_as_function ## _probe_probe_property;                   \
 275   iface->needs_probe = interface_as_function ## _probe_needs_probe;                         \
 276   iface->get_values = interface_as_function ## _probe_get_values;                                            \
 277 }
 278
 279 G_END_DECLS
 280
 281 #endif /* __GST_V4L2_OBJECT_H__ */