v4l2src: Add new property for auto scan device feature
[platform/upstream/gst-plugins-good.git] / sys / v4l2 / gstv4l2object.h
index d4fa9fe..c12ff09 100644 (file)
@@ -1,7 +1,7 @@
 /* GStreamer
  *
  * Copyright (C) 2001-2002 Ronald Bultje <rbultje@ronald.bitfreak.net>
- *               2006 Edgard Lima <edgard.lima@indt.org.br>
+ *               2006 Edgard Lima <edgard.lima@gmail.com>
  *
  * gstv4l2object.h: base class for V4L2 elements
  *
 #ifndef __GST_V4L2_OBJECT_H__
 #define __GST_V4L2_OBJECT_H__
 
-/* 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.
- */
-#include <sys/ioctl.h>
-#include <sys/types.h>
-#ifdef __sun
-#include <sys/videodev2.h>
-#elif defined(__FreeBSD__)
-#include <linux/videodev2.h>
-#else /* linux */
-#include <linux/types.h>
-#define _LINUX_TIME_H
-#define __user
-#include <linux/videodev2.h>
+#include "ext/videodev2.h"
+#ifdef HAVE_LIBV4L2
+#  include <libv4l2.h>
 #endif
 
+#include "v4l2-utils.h"
+
 #include <gst/gst.h>
 #include <gst/base/gstpushsrc.h>
 
 #include <gst/video/video.h>
+#include <unistd.h>
 
 typedef struct _GstV4l2Object GstV4l2Object;
 typedef struct _GstV4l2ObjectClassHelper GstV4l2ObjectClassHelper;
-typedef struct _GstV4l2Xv GstV4l2Xv;
 
 #include <gstv4l2bufferpool.h>
 
 /* size of v4l2 buffer pool in streaming case */
-#define GST_V4L2_MAX_BUFFERS 16
-#define GST_V4L2_MIN_BUFFERS 1
+#define GST_V4L2_MIN_BUFFERS 2
 
 /* max frame width/height */
 #define GST_V4L2_MAX_SIZE (1<<15) /* 2^15 == 32768 */
 
 G_BEGIN_DECLS
 
+#define GST_TYPE_V4L2_IO_MODE (gst_v4l2_io_mode_get_type ())
+GType gst_v4l2_io_mode_get_type (void);
+
 #define GST_V4L2_OBJECT(obj) (GstV4l2Object *)(obj)
 
 typedef enum {
-  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_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
 } GstV4l2IOMode;
 
 typedef gboolean  (*GstV4l2GetInOutFunction)  (GstV4l2Object * v4l2object, gint * input);
 typedef gboolean  (*GstV4l2SetInOutFunction)  (GstV4l2Object * v4l2object, gint input);
 typedef gboolean  (*GstV4l2UpdateFpsFunction) (GstV4l2Object * v4l2object);
 
+/* On Android NDK r18b the ioctl() signature uses 'unsigned' instead of
+ * 'unsigned long' for the 2nd parameter */
+#ifdef __ANDROID__
+typedef unsigned ioctl_req_t;
+#else
+typedef gulong ioctl_req_t;
+#endif
+
 #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)
@@ -97,31 +90,84 @@ typedef gboolean  (*GstV4l2UpdateFpsFunction) (GstV4l2Object * v4l2object);
 #define GST_V4L2_SET_ACTIVE(o)   ((o)->active = TRUE)
 #define GST_V4L2_SET_INACTIVE(o) ((o)->active = FALSE)
 
+/* checks whether the current v4lv4l2object has already been open()'ed or not */
+#define GST_V4L2_CHECK_OPEN(v4l2object)                                \
+  if (!GST_V4L2_IS_OPEN(v4l2object))                           \
+  {                                                            \
+    GST_ELEMENT_ERROR (v4l2object->element, RESOURCE, SETTINGS,        \
+      (_("Device is not open.")), (NULL));                      \
+    return FALSE;                                              \
+  }
+
+/* checks whether the current v4lv4l2object is close()'ed or whether it is still open */
+#define GST_V4L2_CHECK_NOT_OPEN(v4l2object)                    \
+  if (GST_V4L2_IS_OPEN(v4l2object))                            \
+  {                                                            \
+    GST_ELEMENT_ERROR (v4l2object->element, RESOURCE, SETTINGS,        \
+      (_("Device is open.")), (NULL));                          \
+    return FALSE;                                              \
+  }
+
+/* checks whether we're out of capture mode or not */
+#define GST_V4L2_CHECK_NOT_ACTIVE(v4l2object)                  \
+  if (GST_V4L2_IS_ACTIVE(v4l2object))                          \
+  {                                                            \
+    GST_ELEMENT_ERROR (v4l2object->element, RESOURCE, SETTINGS, \
+      (NULL), ("Device is in streaming mode"));                 \
+    return FALSE;                                              \
+  }
+
+
 struct _GstV4l2Object {
   GstElement * element;
+  GstObject * dbg_obj;
 
   enum v4l2_buf_type type;   /* V4L2_BUF_TYPE_VIDEO_CAPTURE, V4L2_BUF_TYPE_VIDEO_OUTPUT */
 
   /* the video device */
   char *videodev;
 
+#ifdef TIZEN_FEATURE_V4L2SRC_AUTO_SCAN_DEVICE_NODE
+  /* auto scan device */
+  gboolean auto_scan_device;
+#endif /* TIZEN_FEATURE_V4L2SRC_AUTO_SCAN_DEVICE_NODE */
+
   /* the video-device's file descriptor */
   gint video_fd;
   GstV4l2IOMode mode;
-  GstPoll * poll;
-  gboolean can_poll_device;
 
   gboolean active;
   gboolean streaming;
 
   /* the current format */
   struct v4l2_fmtdesc *fmtdesc;
+  struct v4l2_format format;
   GstVideoInfo info;
+  GstVideoAlignment align;
+
+  /* Features */
+  gboolean need_video_meta;
+  gboolean has_alpha_component;
 
-  guint32 bytesperline;
-  guint32 sizeimage;
+  /* 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;
+
+  /* We cache the frame duration if known */
   GstClockTime duration;
 
+  /* 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;
+
+  /* This will be set if supported in decide_allocation. It can be used to
+   * calculate the minimum latency. */
+  guint32 min_buffers;
+
   /* wanted mode */
   GstV4l2IOMode req_mode;
 
@@ -130,15 +176,12 @@ struct _GstV4l2Object {
 
   /* 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;
+  /* opened device specific capabilities */
+  guint32 device_caps;
 
   /* lists... */
   GSList *formats;              /* list of available capture formats */
+  GstCaps *probed_caps;
 
   GList *colors;
   GList *norms;
@@ -150,15 +193,34 @@ struct _GstV4l2Object {
   gchar *channel;
   gulong frequency;
   GstStructure *extra_controls;
-
-  /* X-overlay */
-  GstV4l2Xv *xv;
-  gulong xwindow_id;
+  gboolean keep_aspect;
+  GValue *par;
 
   /* funcs */
   GstV4l2GetInOutFunction  get_in_out_func;
   GstV4l2SetInOutFunction  set_in_out_func;
   GstV4l2UpdateFpsFunction update_fps_func;
+
+  /* syscalls */
+  gint (*fd_open) (gint fd, gint v4l2_flags);
+  gint (*close) (gint fd);
+  gint (*dup) (gint fd);
+  gint (*ioctl) (gint fd, ioctl_req_t request, ...);
+  gssize (*read) (gint fd, gpointer buffer, gsize n);
+  gpointer (*mmap) (gpointer start, gsize length, gint prot, gint flags,
+      gint fd,  off_t offset);
+  gint (*munmap) (gpointer _start, gsize length);
+
+  /* Quirks */
+  /* Skips interlacing probes */
+  gboolean never_interlaced;
+  /* 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;
+  /* Avoid any try_fmt probe. This is used by v4l2src to speedup start up time
+   * on slow USB firmwares. When this is set, gst_v4l2_set_format() will modify
+   * the caps to reflect what was negotiated during fixation */
+  gboolean skip_try_fmt_probes;
 };
 
 struct _GstV4l2ObjectClassHelper {
@@ -168,120 +230,113 @@ struct _GstV4l2ObjectClassHelper {
 
 GType gst_v4l2_object_get_type (void);
 
-#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
+#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_OUTPUT_IO_MODE,      \
+    PROP_CAPTURE_IO_MODE,     \
+    PROP_EXTRA_CONTROLS,      \
+    PROP_PIXEL_ASPECT_RATIO,  \
+    PROP_FORCE_ASPECT_RATIO
 
 /* create/destroy */
-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);
+GstV4l2Object*  gst_v4l2_object_new       (GstElement * element,
+                                           GstObject * dbg_obj,
+                                           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);
 
 /* properties */
 
-void     gst_v4l2_object_install_properties_helper (GObjectClass *gobject_class, const char *default_device);
+void         gst_v4l2_object_install_properties_helper (GObjectClass * gobject_class,
+                                                        const char * default_device);
+
+void         gst_v4l2_object_install_m2m_properties_helper (GObjectClass * gobject_class);
 
-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);
+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);
 /* open/close */
-gboolean  gst_v4l2_object_open               (GstV4l2Object *v4l2object);
-gboolean  gst_v4l2_object_close              (GstV4l2Object *v4l2object);
+gboolean     gst_v4l2_object_open            (GstV4l2Object * v4l2object);
+gboolean     gst_v4l2_object_open_shared     (GstV4l2Object * v4l2object, GstV4l2Object * other);
+gboolean     gst_v4l2_object_close           (GstV4l2Object * v4l2object);
 
 /* probing */
-#if 0
-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);
-#endif
 
-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);
-
-gboolean      gst_v4l2_object_set_format (GstV4l2Object *v4l2object, GstCaps * caps);
-
-gboolean      gst_v4l2_object_caps_equal  (GstV4l2Object * v4l2object, GstCaps * caps);
-
-gboolean      gst_v4l2_object_unlock      (GstV4l2Object *v4l2object);
-gboolean      gst_v4l2_object_unlock_stop (GstV4l2Object *v4l2object);
-
-gboolean      gst_v4l2_object_stop        (GstV4l2Object *v4l2object);
-
-
-gboolean      gst_v4l2_object_copy        (GstV4l2Object * v4l2object,
-                                           GstBuffer * dest, GstBuffer *src);
-
-
-#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)                   \
-{                                                                                           \
-  Type_Class *this_class = (Type_Class*) G_OBJECT_GET_CLASS (probe);                        \
-  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)                      \
-{                                                                                           \
-  Type_Class *this_class = (Type_Class*) G_OBJECT_GET_CLASS (probe);                        \
-  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)                       \
-{                                                                                           \
-  Type_Class *this_class = (Type_Class*) G_OBJECT_GET_CLASS (probe);                        \
-  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;                                            \
-}
+GstCaps*     gst_v4l2_object_get_all_caps (void);
+
+GstCaps*     gst_v4l2_object_get_raw_caps (void);
+
+GstCaps*     gst_v4l2_object_get_codec_caps (void);
+
+gint         gst_v4l2_object_extrapolate_stride (const GstVideoFormatInfo * finfo,
+                                                  gint plane, gint stride);
+
+gboolean     gst_v4l2_object_set_format  (GstV4l2Object * v4l2object, GstCaps * caps, GstV4l2Error * error);
+gboolean     gst_v4l2_object_try_format  (GstV4l2Object * v4l2object, GstCaps * caps, GstV4l2Error * error);
+gboolean     gst_v4l2_object_try_import  (GstV4l2Object * v4l2object, GstBuffer * buffer);
+
+gboolean     gst_v4l2_object_caps_equal       (GstV4l2Object * v4l2object, GstCaps * caps);
+gboolean     gst_v4l2_object_caps_is_subset   (GstV4l2Object * v4l2object, GstCaps * caps);
+GstCaps *    gst_v4l2_object_get_current_caps (GstV4l2Object * v4l2object);
+
+gboolean     gst_v4l2_object_unlock      (GstV4l2Object * v4l2object);
+gboolean     gst_v4l2_object_unlock_stop (GstV4l2Object * v4l2object);
+
+gboolean     gst_v4l2_object_stop        (GstV4l2Object * v4l2object);
+
+GstCaps *    gst_v4l2_object_probe_caps  (GstV4l2Object * v4l2object, GstCaps * filter);
+GstCaps *    gst_v4l2_object_get_caps    (GstV4l2Object * v4l2object, GstCaps * filter);
+
+gboolean     gst_v4l2_object_acquire_format (GstV4l2Object * v4l2object, GstVideoInfo * info);
+
+gboolean     gst_v4l2_object_set_crop    (GstV4l2Object * obj);
+
+gboolean     gst_v4l2_object_decide_allocation (GstV4l2Object * v4l2object, GstQuery * query);
+
+gboolean     gst_v4l2_object_propose_allocation (GstV4l2Object * obj, GstQuery * query);
+
+GstStructure * gst_v4l2_object_v4l2fourcc_to_structure (guint32 fourcc);
+
+/* TODO Move to proper namespace */
+/* open/close the device */
+gboolean     gst_v4l2_open           (GstV4l2Object * v4l2object);
+gboolean     gst_v4l2_dup            (GstV4l2Object * v4l2object, GstV4l2Object * other);
+gboolean     gst_v4l2_close          (GstV4l2Object * v4l2object);
+
+/* norm/input/output */
+gboolean     gst_v4l2_get_norm       (GstV4l2Object * v4l2object, v4l2_std_id * norm);
+gboolean     gst_v4l2_set_norm       (GstV4l2Object * v4l2object, v4l2_std_id norm);
+gboolean     gst_v4l2_get_input      (GstV4l2Object * v4l2object, gint * input);
+gboolean     gst_v4l2_set_input      (GstV4l2Object * v4l2object, gint input);
+gboolean     gst_v4l2_get_output     (GstV4l2Object * v4l2object, gint * output);
+gboolean     gst_v4l2_set_output     (GstV4l2Object * v4l2object, gint output);
+
+/* frequency control */
+gboolean     gst_v4l2_get_frequency   (GstV4l2Object * v4l2object, gint tunernum, gulong * frequency);
+gboolean     gst_v4l2_set_frequency   (GstV4l2Object * v4l2object, gint tunernum, gulong frequency);
+gboolean     gst_v4l2_signal_strength (GstV4l2Object * v4l2object, gint tunernum, gulong * signal);
+
+/* attribute control */
+gboolean     gst_v4l2_get_attribute   (GstV4l2Object * v4l2object, int attribute, int * value);
+gboolean     gst_v4l2_set_attribute   (GstV4l2Object * v4l2object, int attribute, const int value);
+gboolean     gst_v4l2_set_controls    (GstV4l2Object * v4l2object, GstStructure * controls);
 
 G_END_DECLS