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., 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 /* 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 #ifdef __sun
  42 #include <sys/videodev2.h>
  43 #elif defined(__FreeBSD__)
  44 #include <linux/videodev2.h>
  45 #else /* linux */
  46 #include <linux/types.h>
  47 #define _LINUX_TIME_H
  48 #define __user
  49 #include <linux/videodev2.h>
  50 #endif
  51
  52 #include <gst/gst.h>
  53 #include <gst/base/gstpushsrc.h>
  54
  55 #include <gst/video/video.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   GST_V4L2_IO_DMABUF  = 4
  80 } GstV4l2IOMode;
  81
  82 typedef gboolean  (*GstV4l2GetInOutFunction)  (GstV4l2Object * v4l2object, gint * input);
  83 typedef gboolean  (*GstV4l2SetInOutFunction)  (GstV4l2Object * v4l2object, gint input);
  84 typedef gboolean  (*GstV4l2UpdateFpsFunction) (GstV4l2Object * v4l2object);
  85
  86 #define GST_V4L2_WIDTH(o)        (GST_VIDEO_INFO_WIDTH (&(o)->info))
  87 #define GST_V4L2_HEIGHT(o)       (GST_VIDEO_INFO_HEIGHT (&(o)->info))
  88 #define GST_V4L2_PIXELFORMAT(o)  ((o)->fmtdesc->pixelformat)
  89 #define GST_V4L2_FPS_N(o)        (GST_VIDEO_INFO_FPS_N (&(o)->info))
  90 #define GST_V4L2_FPS_D(o)        (GST_VIDEO_INFO_FPS_D (&(o)->info))
  91
  92 /* simple check whether the device is open */
  93 #define GST_V4L2_IS_OPEN(o)      ((o)->video_fd > 0)
  94
  95 /* check whether the device is 'active' */
  96 #define GST_V4L2_IS_ACTIVE(o)    ((o)->active)
  97 #define GST_V4L2_SET_ACTIVE(o)   ((o)->active = TRUE)
  98 #define GST_V4L2_SET_INACTIVE(o) ((o)->active = FALSE)
  99
 100 struct _GstV4l2Object {
 101   GstElement * element;
 102
 103   enum v4l2_buf_type type;   /* V4L2_BUF_TYPE_VIDEO_CAPTURE, V4L2_BUF_TYPE_VIDEO_OUTPUT */
 104
 105   /* the video device */
 106   char *videodev;
 107
 108   /* the video-device's file descriptor */
 109   gint video_fd;
 110   GstV4l2IOMode mode;
 111   GstPoll * poll;
 112   gboolean can_poll_device;
 113
 114   gboolean active;
 115   gboolean streaming;
 116
 117   /* the current format */
 118   struct v4l2_fmtdesc *fmtdesc;
 119   GstVideoInfo info;
 120
 121   /* only used if the device supports MPLANE
 122    * nb planes is meaning of v4l2 planes
 123    * the gstreamer equivalent is gst_buffer_n_memory
 124    */
 125   gint n_v4l2_planes;
 126
 127   guint32 bytesperline[GST_VIDEO_MAX_PLANES];
 128   guint32 sizeimage;
 129   GstClockTime duration;
 130
 131   /* if the MPLANE device support both contiguous and non contiguous
 132    * it allows to select which one we want. But we prefered_non_contiguous
 133    * non contiguous mode.
 134    */
 135   gboolean prefered_non_contiguous;
 136
 137   /* wanted mode */
 138   GstV4l2IOMode req_mode;
 139
 140   /* optional pool */
 141   GstBufferPool *pool;
 142
 143   /* the video device's capabilities */
 144   struct v4l2_capability vcap;
 145
 146   /* the video device's window properties */
 147   struct v4l2_window vwin;
 148
 149   /* some more info about the current input's capabilities */
 150   struct v4l2_input vinput;
 151
 152   /* lists... */
 153   GSList *formats;              /* list of available capture formats */
 154   GstCaps *probed_caps;
 155
 156   GList *colors;
 157   GList *norms;
 158   GList *channels;
 159   GData *controls;
 160
 161   /* properties */
 162   v4l2_std_id tv_norm;
 163   gchar *channel;
 164   gulong frequency;
 165   GstStructure *extra_controls;
 166   gboolean keep_aspect;
 167   GValue *par;
 168
 169   /* X-overlay */
 170   GstV4l2Xv *xv;
 171   gulong xwindow_id;
 172
 173   /* funcs */
 174   GstV4l2GetInOutFunction  get_in_out_func;
 175   GstV4l2SetInOutFunction  set_in_out_func;
 176   GstV4l2UpdateFpsFunction update_fps_func;
 177 };
 178
 179 struct _GstV4l2ObjectClassHelper {
 180   /* probed devices */
 181   GList *devices;
 182 };
 183
 184 GType gst_v4l2_object_get_type (void);
 185
 186 #define V4L2_STD_OBJECT_PROPS \
 187     PROP_DEVICE,              \
 188     PROP_DEVICE_NAME,         \
 189     PROP_DEVICE_FD,           \
 190     PROP_FLAGS,               \
 191     PROP_BRIGHTNESS,          \
 192     PROP_CONTRAST,            \
 193     PROP_SATURATION,          \
 194     PROP_HUE,                 \
 195     PROP_TV_NORM,             \
 196     PROP_IO_MODE,             \
 197     PROP_EXTRA_CONTROLS,      \
 198     PROP_PIXEL_ASPECT_RATIO,  \
 199     PROP_FORCE_ASPECT_RATIO
 200
 201 /* create/destroy */
 202 GstV4l2Object*  gst_v4l2_object_new       (GstElement * element,
 203                                            enum v4l2_buf_type  type,
 204                                            const char * default_device,
 205                                            GstV4l2GetInOutFunction get_in_out_func,
 206                                            GstV4l2SetInOutFunction set_in_out_func,
 207                                            GstV4l2UpdateFpsFunction update_fps_func);
 208
 209 void            gst_v4l2_object_destroy   (GstV4l2Object * v4l2object);
 210
 211 /* properties */
 212
 213 void         gst_v4l2_object_install_properties_helper (GObjectClass * gobject_class,
 214                                                         const char * default_device);
 215
 216 gboolean     gst_v4l2_object_set_property_helper       (GstV4l2Object * v4l2object,
 217                                                         guint prop_id,
 218                                                         const GValue * value,
 219                                                         GParamSpec * pspec);
 220 gboolean     gst_v4l2_object_get_property_helper       (GstV4l2Object *v4l2object,
 221                                                         guint prop_id, GValue * value,
 222                                                         GParamSpec * pspec);
 223 /* open/close */
 224 gboolean     gst_v4l2_object_open            (GstV4l2Object *v4l2object);
 225 gboolean     gst_v4l2_object_close           (GstV4l2Object *v4l2object);
 226
 227 /* probing */
 228 #if 0
 229 const GList* gst_v4l2_probe_get_properties  (GstPropertyProbe * probe);
 230
 231 void         gst_v4l2_probe_probe_property  (GstPropertyProbe * probe, guint prop_id,
 232                                              const GParamSpec * pspec,
 233                                              GList ** klass_devices);
 234 gboolean     gst_v4l2_probe_needs_probe     (GstPropertyProbe * probe, guint prop_id,
 235                                              const GParamSpec * pspec,
 236                                              GList ** klass_devices);
 237 GValueArray* gst_v4l2_probe_get_values      (GstPropertyProbe * probe, guint prop_id,
 238                                              const GParamSpec * pspec,
 239                                              GList ** klass_devices);
 240 #endif
 241
 242 GstCaps*      gst_v4l2_object_get_all_caps (void);
 243
 244 GstCaps*      gst_v4l2_object_get_raw_caps (void);
 245
 246 GstCaps*      gst_v4l2_object_get_codec_caps (void);
 247
 248 GstStructure* gst_v4l2_object_v4l2fourcc_to_structure (guint32 fourcc);
 249
 250 gboolean      gst_v4l2_object_set_format  (GstV4l2Object * v4l2object, GstCaps * caps);
 251
 252 gboolean      gst_v4l2_object_caps_equal  (GstV4l2Object * v4l2object, GstCaps * caps);
 253
 254 gboolean      gst_v4l2_object_unlock      (GstV4l2Object * v4l2object);
 255 gboolean      gst_v4l2_object_unlock_stop (GstV4l2Object * v4l2object);
 256
 257 gboolean      gst_v4l2_object_stop        (GstV4l2Object * v4l2object);
 258
 259
 260 gboolean      gst_v4l2_object_copy        (GstV4l2Object * v4l2object,
 261                                            GstBuffer * dest, GstBuffer * src);
 262
 263 GstCaps *     gst_v4l2_object_get_caps    (GstV4l2Object * v4l2object,
 264                                            GstCaps * filter);
 265
 266
 267 #define GST_IMPLEMENT_V4L2_PROBE_METHODS(Type_Class, interface_as_function)                 \
 268                                                                                             \
 269 static void                                                                                 \
 270 interface_as_function ## _probe_probe_property (GstPropertyProbe * probe,                   \
 271                                                 guint prop_id,                              \
 272                                                 const GParamSpec * pspec)                   \
 273 {                                                                                           \
 274   Type_Class *this_class = (Type_Class*) G_OBJECT_GET_CLASS (probe);                        \
 275   gst_v4l2_probe_probe_property (probe, prop_id, pspec,                                     \
 276                                  &this_class->v4l2_class_devices);                          \
 277 }                                                                                           \
 278                                                                                             \
 279 static gboolean                                                                             \
 280 interface_as_function ## _probe_needs_probe (GstPropertyProbe * probe,                      \
 281                                              guint prop_id,                                 \
 282                                              const GParamSpec * pspec)                      \
 283 {                                                                                           \
 284   Type_Class *this_class = (Type_Class*) G_OBJECT_GET_CLASS (probe);                        \
 285   return gst_v4l2_probe_needs_probe (probe, prop_id, pspec,                                 \
 286                                      &this_class->v4l2_class_devices);                      \
 287 }                                                                                           \
 288                                                                                             \
 289 static GValueArray *                                                                        \
 290 interface_as_function ## _probe_get_values (GstPropertyProbe * probe,                       \
 291                                             guint prop_id,                                  \
 292                                             const GParamSpec * pspec)                       \
 293 {                                                                                           \
 294   Type_Class *this_class = (Type_Class*) G_OBJECT_GET_CLASS (probe);                        \
 295   return gst_v4l2_probe_get_values (probe, prop_id, pspec,                                  \
 296                                     &this_class->v4l2_class_devices);                       \
 297 }                                                                                           \
 298                                                                                             \
 299 static void                                                                                 \
 300 interface_as_function ## _property_probe_interface_init (GstPropertyProbeInterface * iface) \
 301 {                                                                                           \
 302   iface->get_properties = gst_v4l2_probe_get_properties;                                    \
 303   iface->probe_property = interface_as_function ## _probe_probe_property;                   \
 304   iface->needs_probe = interface_as_function ## _probe_needs_probe;                         \
 305   iface->get_values = interface_as_function ## _probe_get_values;                           \
 306 }
 307
 308 G_END_DECLS
 309
 310 #endif /* __GST_V4L2_OBJECT_H__ */