gstv4l2object.h 13.2 KB
Newer Older
1 2 3
/* GStreamer
 *
 * Copyright (C) 2001-2002 Ronald Bultje <rbultje@ronald.bitfreak.net>
4 5 6
 *               2006 Edgard Lima <edgard.lima@indt.org.br>
 *
 * gstv4l2object.h: base class for V4L2 elements
7 8 9 10 11 12 13 14 15 16 17 18 19
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
Tim-Philipp Müller's avatar
Tim-Philipp Müller committed
20 21
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA 02110-1301, USA.
22 23
 */

24 25
#ifndef __GST_V4L2_OBJECT_H__
#define __GST_V4L2_OBJECT_H__
26 27 28 29 30 31 32 33 34 35 36 37 38

/* Because of some really cool feature in video4linux1, also known as
 * 'not including sys/types.h and sys/time.h', we had to include it
 * ourselves. In all their intelligence, these people decided to fix
 * this in the next version (video4linux2) in such a cool way that it
 * breaks all compilations of old stuff...
 * The real problem is actually that linux/time.h doesn't use proper
 * macro checks before defining types like struct timeval. The proper
 * fix here is to either fuck the kernel header (which is what we do
 * by defining _LINUX_TIME_H, an innocent little hack) or by fixing it
 * upstream, which I'll consider doing later on. If you get compiler
 * errors here, check your linux/time.h && sys/time.h header setup.
 */
39
#include <sys/ioctl.h>
40
#include <sys/types.h>
41 42 43 44 45
#ifdef __sun
#include <sys/videodev2.h>
#elif defined(__FreeBSD__)
#include <linux/videodev2.h>
#else /* linux */
46 47 48 49
#include <linux/types.h>
#define _LINUX_TIME_H
#define __user
#include <linux/videodev2.h>
50
#endif
51 52 53 54

#include <gst/gst.h>
#include <gst/base/gstpushsrc.h>

Wim Taymans's avatar
Wim Taymans committed
55
#include <gst/video/video.h>
56

57 58 59 60 61
typedef struct _GstV4l2Object GstV4l2Object;
typedef struct _GstV4l2ObjectClassHelper GstV4l2ObjectClassHelper;
typedef struct _GstV4l2Xv GstV4l2Xv;

#include <gstv4l2bufferpool.h>
Rob Clark's avatar
Rob Clark committed
62 63 64 65 66 67 68 69

/* size of v4l2 buffer pool in streaming case */
#define GST_V4L2_MAX_BUFFERS 16
#define GST_V4L2_MIN_BUFFERS 1

/* max frame width/height */
#define GST_V4L2_MAX_SIZE (1<<15) /* 2^15 == 32768 */

70 71
G_BEGIN_DECLS

72 73 74
#define GST_TYPE_V4L2_IO_MODE (gst_v4l2_io_mode_get_type ())
GType gst_v4l2_io_mode_get_type (void);

75
#define GST_V4L2_OBJECT(obj) (GstV4l2Object *)(obj)
Stefan Kost's avatar
Stefan Kost committed
76

Wim Taymans's avatar
Wim Taymans committed
77
typedef enum {
Wim Taymans's avatar
Wim Taymans committed
78
  GST_V4L2_IO_AUTO    = 0,
Wim Taymans's avatar
Wim Taymans committed
79 80
  GST_V4L2_IO_RW      = 1,
  GST_V4L2_IO_MMAP    = 2,
81 82
  GST_V4L2_IO_USERPTR = 3,
  GST_V4L2_IO_DMABUF  = 4
Wim Taymans's avatar
Wim Taymans committed
83
} GstV4l2IOMode;
84

85 86
typedef gboolean  (*GstV4l2GetInOutFunction)  (GstV4l2Object * v4l2object, gint * input);
typedef gboolean  (*GstV4l2SetInOutFunction)  (GstV4l2Object * v4l2object, gint input);
87
typedef gboolean  (*GstV4l2UpdateFpsFunction) (GstV4l2Object * v4l2object);
88

Wim Taymans's avatar
Wim Taymans committed
89 90 91 92 93
#define GST_V4L2_WIDTH(o)        (GST_VIDEO_INFO_WIDTH (&(o)->info))
#define GST_V4L2_HEIGHT(o)       (GST_VIDEO_INFO_HEIGHT (&(o)->info))
#define GST_V4L2_PIXELFORMAT(o)  ((o)->fmtdesc->pixelformat)
#define GST_V4L2_FPS_N(o)        (GST_VIDEO_INFO_FPS_N (&(o)->info))
#define GST_V4L2_FPS_D(o)        (GST_VIDEO_INFO_FPS_D (&(o)->info))
94 95 96 97 98 99 100 101 102

/* simple check whether the device is open */
#define GST_V4L2_IS_OPEN(o)      ((o)->video_fd > 0)

/* check whether the device is 'active' */
#define GST_V4L2_IS_ACTIVE(o)    ((o)->active)
#define GST_V4L2_SET_ACTIVE(o)   ((o)->active = TRUE)
#define GST_V4L2_SET_INACTIVE(o) ((o)->active = FALSE)

103 104 105
struct _GstV4l2Object {
  GstElement * element;

106 107
  enum v4l2_buf_type type;   /* V4L2_BUF_TYPE_VIDEO_CAPTURE, V4L2_BUF_TYPE_VIDEO_OUTPUT */

108 109 110 111 112
  /* the video device */
  char *videodev;

  /* the video-device's file descriptor */
  gint video_fd;
Wim Taymans's avatar
Wim Taymans committed
113
  GstV4l2IOMode mode;
114
  GstPoll * poll;
115
  gboolean can_poll_device;
116

117
  gboolean active;
118
  gboolean streaming;
Rob Clark's avatar
Rob Clark committed
119

120
  /* the current format */
Wim Taymans's avatar
Wim Taymans committed
121 122 123
  struct v4l2_fmtdesc *fmtdesc;
  GstVideoInfo info;

124 125 126 127 128 129 130
  /* only used if the device supports MPLANE
   * nb planes is meaning of v4l2 planes
   * the gstreamer equivalent is gst_buffer_n_memory
   */
  gint n_v4l2_planes;

  guint32 bytesperline[GST_VIDEO_MAX_PLANES];
Wim Taymans's avatar
Wim Taymans committed
131
  guint32 sizeimage;
132
  GstClockTime duration;
133

134 135 136 137 138 139
  /* if the MPLANE device support both contiguous and non contiguous 
   * it allows to select which one we want. But we prefered_non_contiguous
   * non contiguous mode.
   */
  gboolean prefered_non_contiguous;

Wim Taymans's avatar
Wim Taymans committed
140 141 142
  /* wanted mode */
  GstV4l2IOMode req_mode;

143
  /* optional pool */
144
  GstBufferPool *pool;
145

146 147 148 149 150 151 152 153 154 155
  /* the video device's capabilities */
  struct v4l2_capability vcap;

  /* the video device's window properties */
  struct v4l2_window vwin;

  /* some more info about the current input's capabilities */
  struct v4l2_input vinput;

  /* lists... */
Rob Clark's avatar
Rob Clark committed
156
  GSList *formats;              /* list of available capture formats */
157
  GstCaps *probed_caps;
Rob Clark's avatar
Rob Clark committed
158

159
  GList *colors;
160 161
  GList *norms;
  GList *channels;
162
  GData *controls;
163 164

  /* properties */
Rob Clark's avatar
Rob Clark committed
165
  v4l2_std_id tv_norm;
166
  gchar *channel;
167
  gulong frequency;
168
  GstStructure *extra_controls;
169 170
  gboolean keep_aspect;
  GValue *par;
171 172 173 174 175 176

  /* X-overlay */
  GstV4l2Xv *xv;
  gulong xwindow_id;

  /* funcs */
177 178
  GstV4l2GetInOutFunction  get_in_out_func;
  GstV4l2SetInOutFunction  set_in_out_func;
179
  GstV4l2UpdateFpsFunction update_fps_func;
180 181 182 183

  /* Quirks */
  /* Skips interlacing probes */
  gboolean never_interlaced;
184 185 186
  /* Allow to skip reading initial format through G_FMT. Some devices
   * just fails if you don't call S_FMT first. (ex: M2M decoders) */
  gboolean no_initial_format;
187 188 189 190 191 192 193
};

struct _GstV4l2ObjectClassHelper {
  /* probed devices */
  GList *devices;
};

194
GType gst_v4l2_object_get_type (void);
195

196 197 198 199 200 201 202 203 204 205 206 207 208
#define V4L2_STD_OBJECT_PROPS \
    PROP_DEVICE,              \
    PROP_DEVICE_NAME,         \
    PROP_DEVICE_FD,           \
    PROP_FLAGS,               \
    PROP_BRIGHTNESS,          \
    PROP_CONTRAST,            \
    PROP_SATURATION,          \
    PROP_HUE,                 \
    PROP_TV_NORM,             \
    PROP_IO_MODE,             \
    PROP_EXTRA_CONTROLS,      \
    PROP_PIXEL_ASPECT_RATIO,  \
209
    PROP_FORCE_ASPECT_RATIO
210

211
/* create/destroy */
212 213 214 215 216 217 218 219
GstV4l2Object*  gst_v4l2_object_new       (GstElement * element,
                                           enum v4l2_buf_type  type,
                                           const char * default_device,
                                           GstV4l2GetInOutFunction get_in_out_func,
                                           GstV4l2SetInOutFunction set_in_out_func,
                                           GstV4l2UpdateFpsFunction update_fps_func);

void            gst_v4l2_object_destroy   (GstV4l2Object * v4l2object);
220 221

/* properties */
Rob Clark's avatar
Rob Clark committed
222

223 224
void         gst_v4l2_object_install_properties_helper (GObjectClass * gobject_class,
                                                        const char * default_device);
225

226 227 228 229 230 231 232
gboolean     gst_v4l2_object_set_property_helper       (GstV4l2Object * v4l2object,
                                                        guint prop_id,
                                                        const GValue * value,
                                                        GParamSpec * pspec);
gboolean     gst_v4l2_object_get_property_helper       (GstV4l2Object *v4l2object,
                                                        guint prop_id, GValue * value,
                                                        GParamSpec * pspec);
233
/* open/close */
234
gboolean     gst_v4l2_object_open            (GstV4l2Object *v4l2object);
235
gboolean     gst_v4l2_object_open_shared     (GstV4l2Object *v4l2object, GstV4l2Object *other);
236
gboolean     gst_v4l2_object_close           (GstV4l2Object *v4l2object);
237 238

/* probing */
239
#if 0
240 241 242 243 244 245 246 247 248 249 250
const GList* gst_v4l2_probe_get_properties  (GstPropertyProbe * probe);

void         gst_v4l2_probe_probe_property  (GstPropertyProbe * probe, guint prop_id,
                                             const GParamSpec * pspec,
                                             GList ** klass_devices);
gboolean     gst_v4l2_probe_needs_probe     (GstPropertyProbe * probe, guint prop_id,
                                             const GParamSpec * pspec,
                                             GList ** klass_devices);
GValueArray* gst_v4l2_probe_get_values      (GstPropertyProbe * probe, guint prop_id,
                                             const GParamSpec * pspec,
                                             GList ** klass_devices);
251
#endif
252

Rob Clark's avatar
Rob Clark committed
253 254
GstCaps*      gst_v4l2_object_get_all_caps (void);

255 256 257 258
GstCaps*      gst_v4l2_object_get_raw_caps (void);

GstCaps*      gst_v4l2_object_get_codec_caps (void);

Rob Clark's avatar
Rob Clark committed
259 260
GstStructure* gst_v4l2_object_v4l2fourcc_to_structure (guint32 fourcc);

261
gboolean      gst_v4l2_object_set_format  (GstV4l2Object * v4l2object, GstCaps * caps);
Rob Clark's avatar
Rob Clark committed
262

263 264
gboolean      gst_v4l2_object_caps_equal  (GstV4l2Object * v4l2object, GstCaps * caps);

265 266
gboolean      gst_v4l2_object_unlock      (GstV4l2Object * v4l2object);
gboolean      gst_v4l2_object_unlock_stop (GstV4l2Object * v4l2object);
Wim Taymans's avatar
Wim Taymans committed
267

268
gboolean      gst_v4l2_object_stop        (GstV4l2Object * v4l2object);
269 270


Wim Taymans's avatar
Wim Taymans committed
271
gboolean      gst_v4l2_object_copy        (GstV4l2Object * v4l2object,
272
                                           GstBuffer * dest, GstBuffer * src);
Wim Taymans's avatar
Wim Taymans committed
273

274 275 276
GstCaps *     gst_v4l2_object_get_caps    (GstV4l2Object * v4l2object,
                                           GstCaps * filter);

277 278 279 280
gboolean      gst_v4l2_object_setup_format (GstV4l2Object * v4l2object,
                                            GstVideoInfo * info,
                                            GstVideoAlignment * align);

Rob Clark's avatar
Rob Clark committed
281

282

283 284 285 286
#define GST_IMPLEMENT_V4L2_PROBE_METHODS(Type_Class, interface_as_function)                 \
                                                                                            \
static void                                                                                 \
interface_as_function ## _probe_probe_property (GstPropertyProbe * probe,                   \
287
                                                guint prop_id,                              \
288 289
                                                const GParamSpec * pspec)                   \
{                                                                                           \
290
  Type_Class *this_class = (Type_Class*) G_OBJECT_GET_CLASS (probe);                        \
291
  gst_v4l2_probe_probe_property (probe, prop_id, pspec,                                     \
292
                                 &this_class->v4l2_class_devices);                          \
293 294 295 296
}                                                                                           \
                                                                                            \
static gboolean                                                                             \
interface_as_function ## _probe_needs_probe (GstPropertyProbe * probe,                      \
297
                                             guint prop_id,                                 \
298 299
                                             const GParamSpec * pspec)                      \
{                                                                                           \
300
  Type_Class *this_class = (Type_Class*) G_OBJECT_GET_CLASS (probe);                        \
301
  return gst_v4l2_probe_needs_probe (probe, prop_id, pspec,                                 \
302
                                     &this_class->v4l2_class_devices);                      \
303 304 305 306
}                                                                                           \
                                                                                            \
static GValueArray *                                                                        \
interface_as_function ## _probe_get_values (GstPropertyProbe * probe,                       \
307
                                            guint prop_id,                                  \
308 309
                                            const GParamSpec * pspec)                       \
{                                                                                           \
310
  Type_Class *this_class = (Type_Class*) G_OBJECT_GET_CLASS (probe);                        \
311
  return gst_v4l2_probe_get_values (probe, prop_id, pspec,                                  \
312
                                    &this_class->v4l2_class_devices);                       \
313 314
}                                                                                           \
                                                                                            \
315
static void                                                                                 \
316 317 318 319 320
interface_as_function ## _property_probe_interface_init (GstPropertyProbeInterface * iface) \
{                                                                                           \
  iface->get_properties = gst_v4l2_probe_get_properties;                                    \
  iface->probe_property = interface_as_function ## _probe_probe_property;                   \
  iface->needs_probe = interface_as_function ## _probe_needs_probe;                         \
321
  iface->get_values = interface_as_function ## _probe_get_values;                           \
322 323 324 325
}

G_END_DECLS

326
#endif /* __GST_V4L2_OBJECT_H__ */