Developer World
Spresense SDK Library v3.2.0-ebc0364
Data types
Collaboration diagram for Data types:

Classes

struct  v4l2_capability
 
struct  v4l2_rect
 
struct  v4l2_fract
 
struct  v4l2_selection
 
struct  v4l2_standard
 
struct  v4l2_requestbuffers
 parameter of ioctl(VIDIOC_REQBUFS) More...
 
struct  v4l2_timecode
 
struct  v4l2_plane
 
struct  v4l2_buffer
 Parameter of ioctl(VIDIOC_QBUF) and ioctl(VIDIOC_DQBUF).
Currently, support only index, type, bytesused, memory, m.userptr, and length. More...
 
struct  v4l2_fmtdesc
 parameter of ioctl(VIDIOC_ENUM_FMT) More...
 
struct  v4l2_frmsize_discrete
 
struct  v4l2_frmsize_stepwise
 
struct  v4l2_frmsizeenum
 parameter of ioctl(VIDIOC_ENUM_FRAMESIZES) More...
 
struct  v4l2_frmival_stepwise
 
struct  v4l2_frmivalenum
 parameter of ioctl(VIDIOC_ENUM_FRAMEINTERVALS) More...
 
struct  v4l2_pix_format
 
struct  v4l2_format
 parameter of ioctl(VIDIOC_S_FMT) More...
 
struct  v4l2_captureparm
 
struct  v4l2_streamparm
 parameter of ioctl(VIDIOC_S_PARM) More...
 
struct  v4l2_queryctrl
 parameter of ioctl(VIDIOC_QUERYCTRL) More...
 
struct  v4l2_query_ext_ctrl
 parameter of ioctl(VIDIOC_QUERY_EXT_CTRL) More...
 
struct  v4l2_querymenu
 parameter of ioctl(VIDIOC_QUERYMENU) More...
 
struct  v4l2_input
 
struct  v4l2_output
 
struct  v4l2_control
 parameter of ioctl(VIDIOC_G_CTRL / VIDIOC_S_CTRL) More...
 
struct  v4l2_ext_control
 
struct  v4l2_ext_controls
 parameter of ioctl(VIDIOC_G_EXT_CTRLS / VIDIOC_S_EXT_CTRLS) More...
 
struct  v4s_ext_controls_scene
 parameter of ioctl(V4SIOC_S_EXT_CTRLS_SCENE / V4SIOC_G_EXT_CTRLS_SCENE) More...
 
struct  v4s_query_ext_ctrl_scene
 parameter of ioctl(V4SIOC_QUERY_EXT_CTRL_SCENE) More...
 
struct  v4s_querymenu_scene
 parameter of ioctl(V4SIOC_QUERYMENU_SCENE) More...
 

Typedefs

typedef uint64_t v4l2_std_id
 
typedef struct v4l2_requestbuffers v4l2_requestbuffers_t
 
typedef struct v4l2_timecode v4l2_timecode_t
 
typedef struct v4l2_plane v4l2_plane_t
 
typedef struct v4l2_buffer v4l2_buffer_t
 
typedef struct v4l2_pix_format v4l2_pix_format_t
 
typedef struct v4l2_format v4l2_format_t
 

Enumerations

enum  v4l2_capabilities {
  V4L2_CAP_VIDEO_CAPTURE = 0x00000001 , V4L2_CAP_VIDEO_OUTPUT = 0x00000002 , V4L2_CAP_VIDEO_OVERLAY = 0x00000004 , V4L2_CAP_VBI_CAPTURE = 0x00000010 ,
  V4L2_CAP_VBI_OUTPUT = 0x00000020 , V4L2_CAP_SLICED_VBI_CAPTURE = 0x00000040 , V4L2_CAP_SLICED_VBI_OUTPUT = 0x00000080 , V4L2_CAP_RDS_CAPTURE = 0x00000100 ,
  V4L2_CAP_VIDEO_OUTPUT_OVERLAY = 0x00000200 , V4L2_CAP_HW_FREQ_SEEK = 0x00000400 , V4L2_CAP_RDS_OUTPUT = 0x00000800 , V4L2_CAP_VIDEO_CAPTURE_MPLANE = 0x00001000 ,
  V4L2_CAP_VIDEO_OUTPUT_MPLANE = 0x00002000 , V4L2_CAP_VIDEO_M2M_MPLANE = 0x00004000 , V4L2_CAP_VIDEO_M2M = 0x00008000 , V4L2_CAP_TUNER = 0x00010000 ,
  V4L2_CAP_AUDIO = 0x00020000 , V4L2_CAP_RADIO = 0x00040000 , V4L2_CAP_MODULATOR = 0x00080000 , V4L2_CAP_SDR_CAPTURE = 0x00100000 ,
  V4L2_CAP_EXT_PIX_FORMAT = 0x00200000 , V4L2_CAP_SDR_OUTPUT = 0x00400000 , V4L2_CAP_READWRITE = 0x01000000 , V4L2_CAP_ASYNCIO = 0x02000000 ,
  V4L2_CAP_STREAMING = 0x04000000 , V4L2_CAP_TOUCH = 0x10000000 , V4L2_CAP_DEVICE_CAPS = 0x80000000
}
 
enum  v4l2_buf_type {
  V4L2_BUF_TYPE_VIDEO_CAPTURE = 1 , V4L2_BUF_TYPE_VIDEO_OUTPUT = 2 , V4L2_BUF_TYPE_VIDEO_OVERLAY = 3 , V4L2_BUF_TYPE_VBI_CAPTURE = 4 ,
  V4L2_BUF_TYPE_VBI_OUTPUT = 5 , V4L2_BUF_TYPE_SLICED_VBI_CAPTURE = 6 , V4L2_BUF_TYPE_SLICED_VBI_OUTPUT = 7 , V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY = 8 ,
  V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE = 9 , V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE = 10 , V4L2_BUF_TYPE_SDR_CAPTURE = 11 , V4L2_BUF_TYPE_SDR_OUTPUT = 12 ,
  V4L2_BUF_TYPE_META_CAPTURE = 13 , V4L2_BUF_TYPE_PRIVATE = 0x80 , V4L2_BUF_TYPE_STILL_CAPTURE = 0x81
}
 
enum  v4l2_memory { V4L2_MEMORY_MMAP = 1 , V4L2_MEMORY_USERPTR = 2 , V4L2_MEMORY_OVERLAY = 3 , V4L2_MEMORY_DMABUF = 4 }
 
enum  v4l2_field {
  V4L2_FIELD_ANY = 0 , V4L2_FIELD_NONE = 1 , V4L2_FIELD_TOP = 2 , V4L2_FIELD_BOTTOM = 3 ,
  V4L2_FIELD_INTERLACED = 4 , V4L2_FIELD_SEQ_TB = 5 , V4L2_FIELD_SEQ_BT = 6 , V4L2_FIELD_ALTERNATE = 7 ,
  V4L2_FIELD_INTERLACED_TB = 8 , V4L2_FIELD_INTERLACED_BT = 9
}
 
enum  v4l2_buf_mode { V4L2_BUF_MODE_RING = 0 , V4L2_BUF_MODE_FIFO = 1 }
 
enum  v4l2_fmt_flag { V4L2_FMT_FLAG_COMPRESSED = 0x0001 , V4L2_FMT_FLAG_EMULATED = 0x0002 }
 
enum  v4l2_frmsizetypes { V4L2_FRMSIZE_TYPE_DISCRETE = 1 , V4L2_FRMSIZE_TYPE_CONTINUOUS = 2 , V4L2_FRMSIZE_TYPE_STEPWISE = 3 }
 
enum  v4l2_frmivaltypes { V4L2_FRMIVAL_TYPE_DISCRETE = 1 , V4L2_FRMIVAL_TYPE_CONTINUOUS = 2 , V4L2_FRMIVAL_TYPE_STEPWISE = 3 }
 
enum  v4l2_capture_mode { V4L2_MODE_HIGHQUALITY = 0x0001 }
 
enum  v4l2_capture_capability { V4L2_CAP_TIMEPERFRAME = 0x1000 }
 
enum  v4l2_ctrl_type {
  V4L2_CTRL_TYPE_INTEGER = 1 , V4L2_CTRL_TYPE_BOOLEAN = 2 , V4L2_CTRL_TYPE_MENU = 3 , V4L2_CTRL_TYPE_BUTTON = 4 ,
  V4L2_CTRL_TYPE_INTEGER64 = 5 , V4L2_CTRL_TYPE_CTRL_CLASS = 6 , V4L2_CTRL_TYPE_STRING = 7 , V4L2_CTRL_TYPE_BITMASK = 8 ,
  V4L2_CTRL_TYPE_INTEGER_MENU = 9 , V4L2_CTRL_TYPE_U8FIXEDPOINT_Q7 = 10 , V4L2_CTRL_TYPE_U16FIXEDPOINT_Q8 = 11 , V4L2_CTRL_TYPE_INTEGER_TIMES_3 = 12 ,
  V4L2_CTRL_COMPOUND_TYPES = 0x0100 , V4L2_CTRL_TYPE_U8 = 0x0100 , V4L2_CTRL_TYPE_U16 = 0x0101 , V4L2_CTRL_TYPE_U32 = 0x0102
}
 
enum  v4l2_input_type { V4L2_INPUT_TYPE_TUNER = 1 , V4L2_INPUT_TYPE_CAMERA = 2 , V4L2_INPUT_TYPE_TOUCH = 3 }
 
enum  v4l2_input_status {
  V4L2_IN_ST_NO_POWER = 0x00000001 , V4L2_IN_ST_NO_SIGNAL = 0x00000002 , V4L2_IN_ST_NO_COLOR = 0x00000004 , V4L2_IN_ST_HFLIP = 0x00000010 ,
  V4L2_IN_ST_VFLIP = 0x00000020 , V4L2_IN_ST_NO_H_LOCK = 0x00000100 , V4L2_IN_ST_COLOR_KILL = 0x00000200 , V4L2_IN_ST_NO_V_LOCK = 0x00000400 ,
  V4L2_IN_ST_NO_STD_LOCK = 0x00000800 , V4L2_IN_ST_NO_SYNC = 0x00010000 , V4L2_IN_ST_NO_EQU = 0x00020000 , V4L2_IN_ST_NO_CARRIER = 0x00040000 ,
  V4L2_IN_ST_MACROVISION = 0x01000000 , V4L2_IN_ST_NO_ACCESS = 0x02000000 , V4L2_IN_ST_VTR = 0x04000000
}
 
enum  v4l2_input_capabilities { V4L2_IN_CAP_DV_TIMINGS = 0x00000002 , V4L2_IN_CAP_STD = 0x00000004 , V4L2_IN_CAP_NATIVE_SIZE = 0x00000008 }
 
enum  v4l2_input_capabilites_compat { V4L2_IN_CAP_CUSTOM_TIMINGS = V4L2_IN_CAP_DV_TIMINGS }
 
enum  v4l2_output_type { V4L2_OUTPUT_TYPE_MODULATOR = 1 , V4L2_OUTPUT_TYPE_ANALOG = 2 , V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY = 3 }
 
enum  v4l2_output_capabilities { V4L2_OUT_CAP_DV_TIMINGS = 0x00000002 , V4L2_OUT_CAP_STD = 0x00000004 , V4L2_OUT_CAP_NATIVE_SIZE = 0x00000008 }
 
enum  v4l2_output_capabilites_compat { V4L2_OUT_CAP_CUSTOM_TIMINGS = V4L2_OUT_CAP_DV_TIMINGS }
 

Detailed Description

Enumeration Type Documentation

◆ v4l2_buf_type

Buffer type. Currently, support only V4L2_BUF_TYPE_VIDEO_CAPTURE and V4L2_BUF_TYPE_STILL_CAPTURE.

Enumerator
V4L2_BUF_TYPE_VIDEO_CAPTURE 

Single-planar video capture stream

V4L2_BUF_TYPE_VIDEO_OUTPUT 

Single-planar video output stream

V4L2_BUF_TYPE_VIDEO_OVERLAY 

Video overlay

V4L2_BUF_TYPE_VBI_CAPTURE 

Raw VBI capture stream

V4L2_BUF_TYPE_VBI_OUTPUT 

Raw VBI output stream

V4L2_BUF_TYPE_SLICED_VBI_CAPTURE 

Sliced VBI capture stream

V4L2_BUF_TYPE_SLICED_VBI_OUTPUT 

Sliced VBI output stream

V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY 

Video output overlay

V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE 

Multi-planar video capture stream

V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE 

Multi-planar video output stream

V4L2_BUF_TYPE_SDR_CAPTURE 

Software Defined Radio capture stream

V4L2_BUF_TYPE_SDR_OUTPUT 

Software Defined Radio output stream

V4L2_BUF_TYPE_META_CAPTURE 

Metadata capture

V4L2_BUF_TYPE_PRIVATE 

Deprecated, do not use

V4L2_BUF_TYPE_STILL_CAPTURE 

Single-planar still capture stream

◆ v4l2_memory

Memory I/O method. Currently, support only V4L2_MEMORY_USERPTR.

Enumerator
V4L2_MEMORY_MMAP 

Memory mapping I/O

V4L2_MEMORY_USERPTR 

User pointer I/O

V4L2_MEMORY_OVERLAY 

Overlay I/O

V4L2_MEMORY_DMABUF 

DMA shared buffer I/O

◆ v4l2_field

enum v4l2_field

Field order. Currently, support only V4L2_FIELD_ANY

Enumerator
V4L2_FIELD_ANY 

Driver can choose from none,

V4L2_FIELD_NONE 

This device has no fields ...

V4L2_FIELD_TOP 

Top field only

V4L2_FIELD_BOTTOM 

Bottom field only

V4L2_FIELD_INTERLACED 

Both fields interlaced

V4L2_FIELD_SEQ_TB 

Both fields sequential into one

V4L2_FIELD_SEQ_BT 

Same as above + bottom-top order

V4L2_FIELD_ALTERNATE 

Both fields alternating into

V4L2_FIELD_INTERLACED_TB 

Both fields interlaced, top field

V4L2_FIELD_INTERLACED_BT 

Both fields interlaced, top field

◆ v4l2_buf_mode

Buffer mode

Enumerator
V4L2_BUF_MODE_RING 

Ring structure

V4L2_BUF_MODE_FIFO 

FIFO structure

◆ v4l2_frmivaltypes

Type of frame interval enumeration

Enumerator
V4L2_FRMIVAL_TYPE_DISCRETE 

Discrete value

V4L2_FRMIVAL_TYPE_CONTINUOUS 

Continuous value

V4L2_FRMIVAL_TYPE_STEPWISE 

Step value

◆ v4l2_ctrl_type

Control type.

Enumerator
V4L2_CTRL_TYPE_INTEGER 

Integer(32bit)

V4L2_CTRL_TYPE_BOOLEAN 

Boolean

V4L2_CTRL_TYPE_MENU 

Menu

V4L2_CTRL_TYPE_BUTTON 

Button

V4L2_CTRL_TYPE_INTEGER64 

Integer(64bit)

V4L2_CTRL_TYPE_CTRL_CLASS 

Control Class

V4L2_CTRL_TYPE_STRING 

String

V4L2_CTRL_TYPE_BITMASK 

Bitmask

V4L2_CTRL_TYPE_INTEGER_MENU 

Integer menu

V4L2_CTRL_TYPE_U8FIXEDPOINT_Q7 

8bit fixed point number(Q7)

V4L2_CTRL_TYPE_U16FIXEDPOINT_Q8 

16bit fixed point number(Q8)

V4L2_CTRL_TYPE_INTEGER_TIMES_3 

Integer times 3

V4L2_CTRL_COMPOUND_TYPES 

Compound type

V4L2_CTRL_TYPE_U8 

uint8_t array

V4L2_CTRL_TYPE_U16 

uint16_t array

V4L2_CTRL_TYPE_U32 

uint32_t array