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
#include "ext/videodev2.h"
28 29 30 31

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

Wim Taymans's avatar
Wim Taymans committed
32
#include <gst/video/video.h>
33

34 35 36 37 38
typedef struct _GstV4l2Object GstV4l2Object;
typedef struct _GstV4l2ObjectClassHelper GstV4l2ObjectClassHelper;
typedef struct _GstV4l2Xv GstV4l2Xv;

#include <gstv4l2bufferpool.h>
Rob Clark's avatar
Rob Clark committed
39 40

/* size of v4l2 buffer pool in streaming case */
41
#define GST_V4L2_MIN_BUFFERS 2
Rob Clark's avatar
Rob Clark committed
42 43 44 45

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

46 47
G_BEGIN_DECLS

48 49 50
#define GST_TYPE_V4L2_IO_MODE (gst_v4l2_io_mode_get_type ())
GType gst_v4l2_io_mode_get_type (void);

51
#define GST_V4L2_OBJECT(obj) (GstV4l2Object *)(obj)
Stefan Kost's avatar
Stefan Kost committed
52

Wim Taymans's avatar
Wim Taymans committed
53
typedef enum {
54 55 56 57 58 59
  GST_V4L2_IO_AUTO          = 0,
  GST_V4L2_IO_RW            = 1,
  GST_V4L2_IO_MMAP          = 2,
  GST_V4L2_IO_USERPTR       = 3,
  GST_V4L2_IO_DMABUF        = 4,
  GST_V4L2_IO_DMABUF_IMPORT = 5
Wim Taymans's avatar
Wim Taymans committed
60
} GstV4l2IOMode;
61

62 63
typedef gboolean  (*GstV4l2GetInOutFunction)  (GstV4l2Object * v4l2object, gint * input);
typedef gboolean  (*GstV4l2SetInOutFunction)  (GstV4l2Object * v4l2object, gint input);
64
typedef gboolean  (*GstV4l2UpdateFpsFunction) (GstV4l2Object * v4l2object);
65

Wim Taymans's avatar
Wim Taymans committed
66 67 68 69 70
#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))
71 72 73 74 75 76 77 78 79

/* 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)

80 81 82
struct _GstV4l2Object {
  GstElement * element;

83 84
  enum v4l2_buf_type type;   /* V4L2_BUF_TYPE_VIDEO_CAPTURE, V4L2_BUF_TYPE_VIDEO_OUTPUT */

85 86 87 88 89
  /* the video device */
  char *videodev;

  /* the video-device's file descriptor */
  gint video_fd;
Wim Taymans's avatar
Wim Taymans committed
90
  GstV4l2IOMode mode;
91

92
  gboolean active;
93
  gboolean streaming;
Rob Clark's avatar
Rob Clark committed
94

95
  /* the current format */
Wim Taymans's avatar
Wim Taymans committed
96
  struct v4l2_fmtdesc *fmtdesc;
97
  struct v4l2_format format;
Wim Taymans's avatar
Wim Taymans committed
98
  GstVideoInfo info;
99 100
  GstVideoAlignment align;

101
  /* Features */
102
  gboolean need_video_meta;
103
  gboolean has_alpha_component;
Wim Taymans's avatar
Wim Taymans committed
104

105 106 107 108 109 110
  /* 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;

111
  /* We cache the frame duration if known */
112
  GstClockTime duration;
113

Nicolas Dufresne's avatar
Nicolas Dufresne committed
114
  /* if the MPLANE device support both contiguous and non contiguous
115 116 117 118 119
   * it allows to select which one we want. But we prefered_non_contiguous
   * non contiguous mode.
   */
  gboolean prefered_non_contiguous;

120
  /* This will be set if supported in decide_allocation. It can be used to
121 122
   * calculate the minimum latency. */
  guint32 min_buffers;
123

124 125 126
  /* This will be set if supported in propose allocation. */
  guint32 min_buffers_for_output;

Wim Taymans's avatar
Wim Taymans committed
127 128 129
  /* wanted mode */
  GstV4l2IOMode req_mode;

130
  /* optional pool */
131
  GstBufferPool *pool;
132

133 134 135 136 137 138 139 140 141 142
  /* 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
143
  GSList *formats;              /* list of available capture formats */
144
  GstCaps *probed_caps;
Rob Clark's avatar
Rob Clark committed
145

146
  GList *colors;
147 148
  GList *norms;
  GList *channels;
149
  GData *controls;
150 151

  /* properties */
Rob Clark's avatar
Rob Clark committed
152
  v4l2_std_id tv_norm;
153
  gchar *channel;
154
  gulong frequency;
155
  GstStructure *extra_controls;
156 157
  gboolean keep_aspect;
  GValue *par;
158 159 160 161 162 163

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

  /* funcs */
164 165
  GstV4l2GetInOutFunction  get_in_out_func;
  GstV4l2SetInOutFunction  set_in_out_func;
166
  GstV4l2UpdateFpsFunction update_fps_func;
167 168 169 170

  /* Quirks */
  /* Skips interlacing probes */
  gboolean never_interlaced;
171 172 173
  /* 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;
174 175 176 177 178 179 180
};

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

181
GType gst_v4l2_object_get_type (void);
182

183 184 185 186 187 188 189 190 191 192 193
#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,             \
194 195
    PROP_OUTPUT_IO_MODE,      \
    PROP_CAPTURE_IO_MODE,     \
196 197
    PROP_EXTRA_CONTROLS,      \
    PROP_PIXEL_ASPECT_RATIO,  \
198
    PROP_FORCE_ASPECT_RATIO
199

200
/* create/destroy */
201 202 203 204 205 206 207 208
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);
209 210

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

212 213
void         gst_v4l2_object_install_properties_helper (GObjectClass * gobject_class,
                                                        const char * default_device);
214

215 216
void         gst_v4l2_object_install_m2m_properties_helper (GObjectClass * gobject_class);

217 218 219 220 221 222 223
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);
224
/* open/close */
225
gboolean     gst_v4l2_object_open            (GstV4l2Object *v4l2object);
226
gboolean     gst_v4l2_object_open_shared     (GstV4l2Object *v4l2object, GstV4l2Object *other);
227
gboolean     gst_v4l2_object_close           (GstV4l2Object *v4l2object);
228 229

/* probing */
230
#if 0
231 232 233 234 235 236 237 238 239 240 241
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);
242
#endif
243

Rob Clark's avatar
Rob Clark committed
244 245
GstCaps*      gst_v4l2_object_get_all_caps (void);

246 247 248 249
GstCaps*      gst_v4l2_object_get_raw_caps (void);

GstCaps*      gst_v4l2_object_get_codec_caps (void);

250 251 252
gint          gst_v4l2_object_extrapolate_stride (const GstVideoFormatInfo * finfo,
                                                  gint plane, gint stride);

253
gboolean      gst_v4l2_object_set_format  (GstV4l2Object * v4l2object, GstCaps * caps);
254
gboolean      gst_v4l2_object_try_format  (GstV4l2Object * v4l2object, GstCaps * caps);
Rob Clark's avatar
Rob Clark committed
255

256 257
gboolean      gst_v4l2_object_caps_equal  (GstV4l2Object * v4l2object, GstCaps * caps);

258 259
gboolean      gst_v4l2_object_unlock      (GstV4l2Object * v4l2object);
gboolean      gst_v4l2_object_unlock_stop (GstV4l2Object * v4l2object);
Wim Taymans's avatar
Wim Taymans committed
260

261
gboolean      gst_v4l2_object_stop        (GstV4l2Object * v4l2object);
262

263 264
GstCaps *     gst_v4l2_object_probe_caps  (GstV4l2Object * v4l2object,
                                           GstCaps * filter);
265 266 267
GstCaps *     gst_v4l2_object_get_caps    (GstV4l2Object * v4l2object,
                                           GstCaps * filter);

268
gboolean      gst_v4l2_object_acquire_format (GstV4l2Object * v4l2object,
269
                                              GstVideoInfo * info);
270 271

gboolean      gst_v4l2_object_set_crop    (GstV4l2Object * obj);
Nicolas Dufresne's avatar
Nicolas Dufresne committed
272

273 274
gboolean      gst_v4l2_object_decide_allocation (GstV4l2Object * v4l2object,
                                                 GstQuery * query);
Rob Clark's avatar
Rob Clark committed
275

276 277 278
gboolean      gst_v4l2_object_propose_allocation (GstV4l2Object * obj,
                                                  GstQuery * query);

279 280
GstStructure * gst_v4l2_object_v4l2fourcc_to_structure (guint32 fourcc);

281

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

G_END_DECLS

325
#endif /* __GST_V4L2_OBJECT_H__ */