sys/v4l2/v4l2_calls.h

   1 /* GStreamer
   2  *
   3  * Copyright (C) 2002 Ronald Bultje <rbultje@ronald.bitfreak.net>
   4  *               2006 Edgard Lima <edgard.lima@indt.org.br>
   5  *
   6  * v4l2_calls.h - generic V4L2 calls handling
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  21  * Boston, MA 02110-1301, USA.
  22  */
  23
  24 #ifndef __V4L2_CALLS_H__
  25 #define __V4L2_CALLS_H__
  26
  27 #include "gstv4l2object.h"
  28
  29 #ifdef HAVE_LIBV4L2
  30 #  include <libv4l2.h>
  31 #else
  32 #  include <sys/ioctl.h>
  33 #  include <linux/videodev2.h>
  34 #  define v4l2_fd_open(fd, flags) (fd)
  35 #  define v4l2_close    close
  36 #  define v4l2_dup      dup
  37 #  define v4l2_ioctl    ioctl
  38 #  define v4l2_read     read
  39 #  define v4l2_mmap     mmap
  40 #  define v4l2_munmap   munmap
  41 #endif
  42
  43 #define GST_V4L2_IS_OVERLAY(v4l2object) \
  44   (v4l2object->vcap.capabilities & V4L2_CAP_VIDEO_OVERLAY)
  45
  46 /* checks whether the current v4lv4l2object has already been open()'ed or not */
  47 #define GST_V4L2_CHECK_OPEN(v4l2object)                         \
  48   if (!GST_V4L2_IS_OPEN(v4l2object))                            \
  49   {                                                             \
  50     GST_ELEMENT_ERROR (v4l2object->element, RESOURCE, SETTINGS, \
  51       (_("Device is not open.")), (NULL));                      \
  52     return FALSE;                                               \
  53   }
  54
  55 /* checks whether the current v4lv4l2object is close()'ed or whether it is still open */
  56 #define GST_V4L2_CHECK_NOT_OPEN(v4l2object)                     \
  57   if (GST_V4L2_IS_OPEN(v4l2object))                             \
  58   {                                                             \
  59     GST_ELEMENT_ERROR (v4l2object->element, RESOURCE, SETTINGS, \
  60       (_("Device is open.")), (NULL));                          \
  61     return FALSE;                                               \
  62   }
  63
  64 /* checks whether the current v4lv4l2object does video overlay */
  65 #define GST_V4L2_CHECK_OVERLAY(v4l2object)                      \
  66   if (!GST_V4L2_IS_OVERLAY(v4l2object))                         \
  67   {                                                             \
  68     GST_ELEMENT_ERROR (v4l2object->element, RESOURCE, SETTINGS, \
  69       (NULL), ("Device cannot handle overlay"));                \
  70     return FALSE;                                               \
  71   }
  72
  73 /* checks whether we're in capture mode or not */
  74 #define GST_V4L2_CHECK_ACTIVE(v4l2object)                       \
  75   if (!GST_V4L2_IS_ACTIVE(v4l2object))                          \
  76   {                                                             \
  77     GST_ELEMENT_ERROR (v4l2object->element, RESOURCE, SETTINGS, \
  78       (NULL), ("Device is not in streaming mode"));             \
  79     return FALSE;                                               \
  80   }
  81
  82 /* checks whether we're out of capture mode or not */
  83 #define GST_V4L2_CHECK_NOT_ACTIVE(v4l2object)                   \
  84   if (GST_V4L2_IS_ACTIVE(v4l2object))                           \
  85   {                                                             \
  86     GST_ELEMENT_ERROR (v4l2object->element, RESOURCE, SETTINGS, \
  87       (NULL), ("Device is in streaming mode"));                 \
  88     return FALSE;                                               \
  89   }
  90
  91
  92 /* open/close the device */
  93 gboolean        gst_v4l2_open                   (GstV4l2Object *v4l2object);
  94 gboolean        gst_v4l2_close                  (GstV4l2Object *v4l2object);
  95
  96 /* norm/input/output */
  97 gboolean        gst_v4l2_get_norm               (GstV4l2Object *v4l2object,
  98                                                  v4l2_std_id    *norm);
  99 gboolean        gst_v4l2_set_norm               (GstV4l2Object *v4l2object,
 100                                                  v4l2_std_id     norm);
 101 gboolean        gst_v4l2_get_input              (GstV4l2Object * v4l2object,
 102                                                  gint * input);
 103 gboolean        gst_v4l2_set_input              (GstV4l2Object * v4l2object,
 104                                                  gint input);
 105 gboolean        gst_v4l2_get_output             (GstV4l2Object *v4l2object,
 106                                                  gint           *output);
 107 gboolean        gst_v4l2_set_output             (GstV4l2Object *v4l2object,
 108                                                  gint            output);
 109
 110 /* frequency control */
 111 gboolean        gst_v4l2_get_frequency          (GstV4l2Object *v4l2object,
 112                                                  gint            tunernum,
 113                                                  gulong         *frequency);
 114 gboolean        gst_v4l2_set_frequency          (GstV4l2Object *v4l2object,
 115                                                  gint            tunernum,
 116                                                  gulong          frequency);
 117 gboolean        gst_v4l2_signal_strength        (GstV4l2Object *v4l2object,
 118                                                  gint            tunernum,
 119                                                  gulong         *signal);
 120
 121 /* attribute control */
 122 gboolean        gst_v4l2_get_attribute          (GstV4l2Object *v4l2object,
 123                                                  int             attribute,
 124                                                  int            *value);
 125 gboolean        gst_v4l2_set_attribute          (GstV4l2Object *v4l2object,
 126                                                  int             attribute,
 127                                                  const int       value);
 128
 129 gboolean        gst_v4l2_set_controls           (GstV4l2Object * v4l2object,
 130                                                  GstStructure * controls);
 131
 132 gboolean        gst_v4l2_get_capabilities       (GstV4l2Object * v4l2object);
 133
 134
 135 #define LOG_CAPS(obj, caps) GST_DEBUG_OBJECT (obj, "%s: %" GST_PTR_FORMAT, #caps, caps)
 136
 137 #endif /* __V4L2_CALLS_H__ */