gstv4l2object.h 11.4 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 20 21 22 23
 *
 * 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
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

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
#ifndef __sun
42 43 44 45
#include <linux/types.h>
#define _LINUX_TIME_H
#define __user
#include <linux/videodev2.h>
46 47 48
#else
#include <sys/videodev2.h>
#endif
49 50 51

#include <gst/gst.h>
#include <gst/base/gstpushsrc.h>
52
#include <gst/controller/gstcontroller.h>
53

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

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
#define GST_V4L2_OBJECT(obj) (GstV4l2Object *)(obj)
Stefan Kost's avatar
Stefan Kost committed
73

Wim Taymans's avatar
Wim Taymans committed
74 75 76 77 78 79
typedef enum {
  GST_V4L2_IO_NONE    = 0,
  GST_V4L2_IO_RW      = 1,
  GST_V4L2_IO_MMAP    = 2,
  GST_V4L2_IO_USERPTR = 3
} GstV4l2IOMode;
80

81 82
typedef gboolean  (*GstV4l2GetInOutFunction)  (GstV4l2Object * v4l2object, gint * input);
typedef gboolean  (*GstV4l2SetInOutFunction)  (GstV4l2Object * v4l2object, gint input);
83
typedef gboolean  (*GstV4l2UpdateFpsFunction) (GstV4l2Object * v4l2object);
84

Wim Taymans's avatar
Wim Taymans committed
85 86 87 88 89
#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))
90 91 92 93 94 95 96 97 98

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

99 100 101
struct _GstV4l2Object {
  GstElement * element;

102 103
  enum v4l2_buf_type type;   /* V4L2_BUF_TYPE_VIDEO_CAPTURE, V4L2_BUF_TYPE_VIDEO_OUTPUT */

104 105 106 107 108
  /* the video device */
  char *videodev;

  /* the video-device's file descriptor */
  gint video_fd;
Wim Taymans's avatar
Wim Taymans committed
109
  GstV4l2IOMode mode;
110
  GstPoll * poll;
111
  gboolean can_poll_device;
112

113
  gboolean active;
114
  gboolean streaming;
Rob Clark's avatar
Rob Clark committed
115

116
  /* the current format */
Wim Taymans's avatar
Wim Taymans committed
117 118 119
  struct v4l2_fmtdesc *fmtdesc;
  GstVideoInfo info;

120
  guint32 bytesperline;
121
  guint size;
122
  GstClockTime duration;
123

124 125
  /* optional pool */
  guint32 num_buffers;
126
  guint32 min_queued_bufs;
127
  gboolean always_copy;
Wim Taymans's avatar
Wim Taymans committed
128
  GstBufferPool *pool;
129

130 131 132 133 134 135 136 137 138 139
  /* 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
140 141
  GSList *formats;              /* list of available capture formats */

142
  GList *colors;
143 144
  GList *norms;
  GList *channels;
145 146

  /* properties */
Rob Clark's avatar
Rob Clark committed
147
  v4l2_std_id tv_norm;
148
  gchar *channel;
149 150 151 152 153 154 155
  gulong frequency;

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

  /* funcs */
156 157
  GstV4l2GetInOutFunction  get_in_out_func;
  GstV4l2SetInOutFunction  set_in_out_func;
158
  GstV4l2UpdateFpsFunction update_fps_func;
159 160 161 162 163 164 165
};

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

166
GType gst_v4l2_object_get_type (void);
167

168 169 170
#define V4L2_STD_OBJECT_PROPS		\
    PROP_DEVICE,			\
    PROP_DEVICE_NAME,			\
171
    PROP_DEVICE_FD,			\
Rob Clark's avatar
Rob Clark committed
172
    PROP_FLAGS,                         \
173 174 175
    PROP_BRIGHTNESS,			\
    PROP_CONTRAST,			\
    PROP_SATURATION,			\
Rob Clark's avatar
Rob Clark committed
176 177
    PROP_HUE,                           \
    PROP_TV_NORM
178

179 180
/* create/destroy */
GstV4l2Object *	gst_v4l2_object_new 		 (GstElement * element,
181 182
                                                  enum v4l2_buf_type  type,
                                                  const char *default_device,
183
                   				  GstV4l2GetInOutFunction get_in_out_func,
184 185
                   				  GstV4l2SetInOutFunction set_in_out_func,
		   				  GstV4l2UpdateFpsFunction   update_fps_func);
186
void 	        gst_v4l2_object_destroy 	 (GstV4l2Object * v4l2object);
187 188

/* properties */
Rob Clark's avatar
Rob Clark committed
189 190

void 	  gst_v4l2_object_install_properties_helper (GObjectClass *gobject_class, const char *default_device);
191 192 193 194 195 196 197

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);
198 199 200
/* open/close */
gboolean  gst_v4l2_object_open               (GstV4l2Object *v4l2object);
gboolean  gst_v4l2_object_close              (GstV4l2Object *v4l2object);
201 202 203 204 205 206 207 208 209 210 211 212 213

/* probing */
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);
214

Rob Clark's avatar
Rob Clark committed
215 216 217 218 219 220 221 222 223
GstCaps*      gst_v4l2_object_probe_caps_for_format (GstV4l2Object *v4l2object, guint32 pixelformat,
                                             const GstStructure * template);

GSList*       gst_v4l2_object_get_format_list  (GstV4l2Object *v4l2object);

GstCaps*      gst_v4l2_object_get_all_caps (void);

GstStructure* gst_v4l2_object_v4l2fourcc_to_structure (guint32 fourcc);

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

226 227 228 229 230 231 232 233
gboolean      gst_v4l2_object_start       (GstV4l2Object *v4l2object);
gboolean      gst_v4l2_object_stop        (GstV4l2Object *v4l2object);


/* capture returns a filled buffer, output returns an empty buffer */
GstFlowReturn gst_v4l2_object_get_buffer     (GstV4l2Object * v4l2object, GstBuffer ** buf);
/* output the filled buffer */
GstFlowReturn gst_v4l2_object_output_buffer  (GstV4l2Object * v4l2object, GstBuffer * buf);
Rob Clark's avatar
Rob Clark committed
234 235


236 237 238 239 240 241 242
#define GST_IMPLEMENT_V4L2_PROBE_METHODS(Type_Class, interface_as_function)                 \
                                                                                            \
static void                                                                                 \
interface_as_function ## _probe_probe_property (GstPropertyProbe * probe,                   \
			                        guint prop_id,                              \
                                                const GParamSpec * pspec)                   \
{                                                                                           \
243
  Type_Class *this_class = (Type_Class*) G_OBJECT_GET_CLASS (probe);                        \
244 245 246 247 248 249 250 251 252
  gst_v4l2_probe_probe_property (probe, prop_id, pspec,                                     \
                                        &this_class->v4l2_class_devices);	            \
}                                                                                           \
                                                                                            \
static gboolean                                                                             \
interface_as_function ## _probe_needs_probe (GstPropertyProbe * probe,                      \
			                     guint prop_id,                                 \
                                             const GParamSpec * pspec)                      \
{                                                                                           \
253
  Type_Class *this_class = (Type_Class*) G_OBJECT_GET_CLASS (probe);                        \
254 255 256 257 258 259 260 261 262
  return gst_v4l2_probe_needs_probe (probe, prop_id, pspec,                                 \
                                        &this_class->v4l2_class_devices);	            \
}                                                                                           \
                                                                                            \
static GValueArray *                                                                        \
interface_as_function ## _probe_get_values (GstPropertyProbe * probe,                       \
			                    guint prop_id,                                  \
                                            const GParamSpec * pspec)                       \
{                                                                                           \
263
  Type_Class *this_class = (Type_Class*) G_OBJECT_GET_CLASS (probe);                        \
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
  return gst_v4l2_probe_get_values (probe, prop_id, pspec,                                  \
                                    &this_class->v4l2_class_devices);	                    \
}                                                                                           \
                                                                                            \
static void								                    \
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;                         \
  iface->get_values = interface_as_function ## _probe_get_values;                                            \
}

G_END_DECLS

279
#endif /* __GST_V4L2_OBJECT_H__ */