gstv4l2object.h 12.7 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
  GstPoll * poll;
92
  gboolean can_poll_device;
93

94
  gboolean active;
95
  gboolean streaming;
Rob Clark's avatar
Rob Clark committed
96

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

103
  /* Features */
104 105
  gboolean need_video_meta;
  gboolean need_crop_meta;
106
  gboolean has_alpha_component;
Wim Taymans's avatar
Wim Taymans committed
107

108 109 110 111 112 113 114
  /* 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
115
  guint32 sizeimage;
116
  GstClockTime duration;
117

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

124 125 126 127
  /* This will be set if supported in decide_allocation. It can be used to
   * calculate the minimum latency of a m2m decoder. */
  guint32 min_buffers_for_capture;

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

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

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

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

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

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

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

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

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

182
GType gst_v4l2_object_get_type (void);
183

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

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

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

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

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

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

Rob Clark's avatar
Rob Clark committed
241 242
GstCaps*      gst_v4l2_object_get_all_caps (void);

243 244 245 246
GstCaps*      gst_v4l2_object_get_raw_caps (void);

GstCaps*      gst_v4l2_object_get_codec_caps (void);

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

249 250
gboolean      gst_v4l2_object_caps_equal  (GstV4l2Object * v4l2object, GstCaps * caps);

251 252
gboolean      gst_v4l2_object_unlock      (GstV4l2Object * v4l2object);
gboolean      gst_v4l2_object_unlock_stop (GstV4l2Object * v4l2object);
Wim Taymans's avatar
Wim Taymans committed
253

254
gboolean      gst_v4l2_object_stop        (GstV4l2Object * v4l2object);
255

256 257 258
GstCaps *     gst_v4l2_object_get_caps    (GstV4l2Object * v4l2object,
                                           GstCaps * filter);

259
gboolean      gst_v4l2_object_acquire_format (GstV4l2Object * v4l2object,
260
                                              GstVideoInfo * info);
261 262

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

264 265
gboolean      gst_v4l2_object_decide_allocation (GstV4l2Object * v4l2object,
                                                 GstQuery * query);
Rob Clark's avatar
Rob Clark committed
266

267 268 269
gboolean      gst_v4l2_object_propose_allocation (GstV4l2Object * obj,
                                                  GstQuery * query);

270 271
GstStructure * gst_v4l2_object_v4l2fourcc_to_structure (guint32 fourcc);

272

273 274 275 276
#define GST_IMPLEMENT_V4L2_PROBE_METHODS(Type_Class, interface_as_function)                 \
                                                                                            \
static void                                                                                 \
interface_as_function ## _probe_probe_property (GstPropertyProbe * probe,                   \
277
                                                guint prop_id,                              \
278 279
                                                const GParamSpec * pspec)                   \
{                                                                                           \
280
  Type_Class *this_class = (Type_Class*) G_OBJECT_GET_CLASS (probe);                        \
281
  gst_v4l2_probe_probe_property (probe, prop_id, pspec,                                     \
282
                                 &this_class->v4l2_class_devices);                          \
283 284 285 286
}                                                                                           \
                                                                                            \
static gboolean                                                                             \
interface_as_function ## _probe_needs_probe (GstPropertyProbe * probe,                      \
287
                                             guint prop_id,                                 \
288 289
                                             const GParamSpec * pspec)                      \
{                                                                                           \
290
  Type_Class *this_class = (Type_Class*) G_OBJECT_GET_CLASS (probe);                        \
291
  return gst_v4l2_probe_needs_probe (probe, prop_id, pspec,                                 \
292
                                     &this_class->v4l2_class_devices);                      \
293 294 295 296
}                                                                                           \
                                                                                            \
static GValueArray *                                                                        \
interface_as_function ## _probe_get_values (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_get_values (probe, prop_id, pspec,                                  \
302
                                    &this_class->v4l2_class_devices);                       \
303 304
}                                                                                           \
                                                                                            \
305
static void                                                                                 \
306 307 308 309 310
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;                         \
311
  iface->get_values = interface_as_function ## _probe_get_values;                           \
312 313 314 315
}

G_END_DECLS

316
#endif /* __GST_V4L2_OBJECT_H__ */