v4l2編程接口——使用ioctl

時間 2019-11-12

標籤 v4l2 編程接口使用 ioctl 简体版

原文原文鏈接

在應用程序獲取視頻數據的流程中，都是經過 ioctl 命令與驅動程序進行交互，常見的 ioctl 命令有：緩存

[cpp] view plain copy ide

VIDIOC_QUERYCAP /* 獲取設備支持的操做 */ 函數
VIDIOC_G_FMT /* 獲取設置支持的視頻格式 */ spa
VIDIOC_S_FMT /* 設置捕獲視頻的格式 */ .net
VIDIOC_REQBUFS /* 向驅動提出申請內存的請求 */ code
VIDIOC_QUERYBUF /* 向驅動查詢申請到的內存 */ orm
VIDIOC_QBUF /* 將空閒的內存加入可捕獲視頻的隊列 */ 視頻
VIDIOC_DQBUF /* 將已經捕獲好視頻的內存拉出已捕獲視頻的隊列 */ blog
VIDIOC_STREAMON /* 打開視頻流 */ 隊列
VIDIOC_STREAMOFF /* 關閉視頻流 */
VIDIOC_QUERYCTRL /* 查詢驅動是否支持該命令 */
VIDIOC_G_CTRL /* 獲取當前命令值 */
VIDIOC_S_CTRL /* 設置新的命令值 */
VIDIOC_G_TUNER /* 獲取調諧器信息 */
VIDIOC_S_TUNER /* 設置調諧器信息 */
VIDIOC_G_FREQUENCY /* 獲取調諧器頻率 */
VIDIOC_S_FREQUENCY /* 設置調諧器頻率 */

一、struct v4l2_capability 與 VIDIOC_QUERYCAP
VIDIOC_QUERYCAP 命令經過結構 v4l2_capability 獲取設備支持的操做模式：

[cpp] view plain copy

struct v4l2_capability {
__u8 driver[16]; /* i.e. "bttv" */
__u8 card[32]; /* i.e. "Hauppauge WinTV" */
__u8 bus_info[32]; /* "PCI:" + pci_name(pci_dev) */
__u32 version; /* should use KERNEL_VERSION() */
__u32 capabilities; /* Device capabilities */
__u32 reserved[4];
};

其中域 capabilities 表明設備支持的操做模式，常見的值有 V4L2_CAP_VIDEO_CAPTURE | V4L2_CAP_STREAMING 表示是一個視頻捕捉設備而且具備數據流控制模式；另外 driver 域須要和 struct video_device 中的 name 匹配。
二、struct v4l2_format 與 VIDIOC_G_FMT、VIDIOC_S_FMT、VIDIOC_TRY_FMT

一般用 VIDIOC_S_FMT 命令經過結構 v4l2_format 初始化捕獲視頻的格式，若是要改變格式則用 VIDIOC_TRY_FMT 命令：

[cpp] view plain copy

struct v4l2_format {
enum v4l2_buf_type type;
union {
struct v4l2_pix_format pix; /* V4L2_BUF_TYPE_VIDEO_CAPTURE */
struct v4l2_window win; /* V4L2_BUF_TYPE_VIDEO_OVERLAY */
struct v4l2_vbi_format vbi; /* V4L2_BUF_TYPE_VBI_CAPTURE */
struct v4l2_sliced_vbi_format sliced; /* V4L2_BUF_TYPE_SLICED_VBI_CAPTURE */
__u8 raw_data[200]; /* user-defined */
} fmt;
};
其中
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_PRIVATE = 0x80,
};
struct v4l2_pix_format {
__u32 width;
__u32 height;
__u32 pixelformat;
enum v4l2_field field;
__u32 bytesperline; /* for padding, zero if unused */
__u32 sizeimage;
enum v4l2_colorspace colorspace;
__u32 priv; /* private data, depends on pixelformat */
};

常見的捕獲模式爲 V4L2_BUF_TYPE_VIDEO_CAPTURE 即視頻捕捉模式，在此模式下 fmt 聯合體採用域 v4l2_pix_format：其中 width 爲視頻的寬、height 爲視頻的高、pixelformat 爲視頻數據格式（常見的值有 V4L2_PIX_FMT_YUV422P | V4L2_PIX_FMT_RGB565）、bytesperline 爲一行圖像佔用的字節數、sizeimage 則爲圖像佔用的總字節數、colorspace 指定設備的顏色空間。
三、struct v4l2_requestbuffers 與 VIDIOC_REQBUFS

VIDIOC_REQBUFS 命令經過結構 v4l2_requestbuffers 請求驅動申請一片連續的內存用於緩存視頻信息：

[cpp] view plain copy

struct v4l2_requestbuffers {
__u32 count;
enum v4l2_buf_type type;
enum v4l2_memory memory;
__u32 reserved[2];
};
其中
enum v4l2_memory {
V4L2_MEMORY_MMAP = 1,
V4L2_MEMORY_USERPTR = 2,
V4L2_MEMORY_OVERLAY = 3,
};

count 指定根據圖像佔用空間大小申請的緩存區個數，type 爲視頻捕獲模式，memory 爲內存區的使用方式。

四、struct v4l2_buffer與 VIDIOC_QUERYBUF

VIDIOC_QUERYBUF 命令經過結構 v4l2_buffer 查詢驅動申請的內存區信息：

[cpp] view plain copy

struct v4l2_buffer {
__u32 index;
enum v4l2_buf_type type;
__u32 bytesused;
__u32 flags;
enum v4l2_field field;
struct timeval timestamp;
struct v4l2_timecode timecode;
__u32 sequence;
/* memory location */
enum v4l2_memory memory;
union {
__u32 offset;
unsigned long userptr;
} m;
__u32 length;
__u32 input;
__u32 reserved;
};

index 爲緩存編號，type 爲視頻捕獲模式，bytesused 爲緩存已使用空間大小，flags 爲緩存當前狀態（常見值有 V4L2_BUF_FLAG_MAPPED | V4L2_BUF_FLAG_QUEUED | V4L2_BUF_FLAG_DONE，分別表明當前緩存已經映射、緩存能夠採集數據、緩存能夠提取數據），timestamp 爲時間戳，sequence爲緩存序號，memory 爲緩存使用方式，offset 爲當前緩存與內存區起始地址的偏移，length 爲緩存大小，reserved 通常用於傳遞物理地址值。
另外 VIDIOC_QBUF 和 VIDIOC_DQBUF 命令都採用結構 v4l2_buffer 與驅動通訊：VIDIOC_QBUF 命令向驅動傳遞應用程序已經處理完的緩存，即將緩存加入空閒可捕獲視頻的隊列，傳遞的主要參數爲 index；VIDIOC_DQBUF 命令向驅動獲取已經存放有視頻數據的緩存，v4l2_buffer 的各個域幾乎都會被更新，但主要的參數也是 index，應用程序會根據 index 肯定可用數據的起始地址和範圍。

五、enum v4l2_buf_type 與 VIDIOC_STREAMON、VIDIOC_STREAMOFF

這兩個命令使用的只是一個整形數據，即 v4l2_buf_type，通常只要指定其值爲 V4L2_BUF_TYPE_VIDEO_CAPTURE 便可。

六、struct v4l2_queryctrl 與 VIDIOC_QUERYCTRL

VIDIOC_QUERYCTRL 命令經過結構 v4l2_queryctrl 查詢驅動是否支持該 id 表明的命令，並返回該命令的各類參數：

[cpp] view plain copy

struct v4l2_queryctrl {
__u32 id; /* 命令編號 */
enum v4l2_ctrl_type type; /* 命令值的類型 */
__u8 name[32]; /* 命令名稱*/
__s32 minimum; /* 最小的命令值 */
__s32 maximum; /* 最大的命令值 */
__s32 step; /* 命令值變化的步長 */
__s32 default_value; /* 默認的命令值 */
__u32 flags; /* 命令的標誌 */
__u32 reserved[2]; /* 命令值的位圖表示 */
};
其中
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,
};
命令的標誌取值以下：
/* Control flags */
#define V4L2_CTRL_FLAG_DISABLED 0x0001
#define V4L2_CTRL_FLAG_GRABBED 0x0002
#define V4L2_CTRL_FLAG_READ_ONLY 0x0004
#define V4L2_CTRL_FLAG_UPDATE 0x0008
#define V4L2_CTRL_FLAG_INACTIVE 0x0010
#define V4L2_CTRL_FLAG_SLIDER 0x0020
#define V4L2_CTRL_FLAG_WRITE_ONLY 0x0040
/* Query flag, to be ORed with the control ID */
#define V4L2_CTRL_FLAG_NEXT_CTRL 0x80000000

id 是命令的編號，常見的命令有兩種：一種以 V4L2_CID_BASE 爲起始值，是公用命令；一種以 V4L2_CID_PRIVATE_BASE 爲起始值，是私有命令。在通常的應用中命令值可見以下：

[cpp] view plain copy

V4L2_CID_CONTRAST (V4L2_CID_BASE+1) /* 對比度調節 */
V4L2_CID_SATURATION (V4L2_CID_BASE+2) /* 飽和度調節 */
V4L2_CID_AUDIO_VOLUME (V4L2_CID_BASE+5) /* 音量調節 */
V4L2_CID_AUDIO_MUTE (V4L2_CID_BASE+9) /* 靜音設置 */
V4L2_CID_DO_WHITE_BALANCE (V4L2_CID_BASE+13) /* 白平衡調節 */
V4L2_CID_GAMMA (V4L2_CID_BASE+16) /* 伽馬值調節 */
V4L2_CID_EXPOSURE (V4L2_CID_BASE+17) /* 曝光度調節 */
V4L2_CID_PRIVATE_ATXX_FLASH (V4L2_CID_PRIVATE_BASE + 2) /* 閃光燈控制 */
V4L2_CID_PRIVATE_ATXX_FRAME (V4L2_CID_PRIVATE_BASE + 12) /* 幀率調節 */

type 爲命令值的類型（總共有7中類型的值），name 是命令的名稱，reserved 則是命令值的位圖表示，驅動會將全部的命令值都以 bit 的形式寫到 64 位的域中，上層應用查詢時能夠根據位圖判斷命令支持的值。

七、struct v4l2_control 與 VIDIOC_G_CTRL、VIDIOC_S_CTRL

VIDIOC_S_CTRL 或 VIDIOC_G_CTRL 命令經過結構 v4l2_control 設置或者獲取 id 命令的值：

[cpp] view plain copy

struct v4l2_control {
__u32 id;
__s32 value;
};

這個結構只有 2 個域，id 是命令編號，value 則是命令的值。

八、struct v4l2_tuner 與 VIDIOC_G_TUNER、VIDIOC_S_TUNER

VIDIOC_S_TUNER 或 VIDIOC_G_TUNER 命令經過結構 v4l2_tuner 設置調諧器的信息：

[cpp] view plain copy

struct v4l2_tuner {
__u32 index; /* 調諧器編號，由應用程序設置 */
__u8 name[32]; /* 調諧器名稱 */
enum v4l2_tuner_type type; /* 調諧器類型 */
__u32 capability; /* 調諧器支持的操做 */
__u32 rangelow; /* 最低頻率值，單位爲62.5Hz或者62.5KHz */
__u32 rangehigh; /* 最高頻率值 */
__u32 rxsubchans; /* 接收的音頻信號類型 */
__u32 audmode; /* 當前音頻播放形式 */
__s32 signal; /* 信號強度 */
__s32 afc; /* 自動頻率控制 */
__u32 reserved[4]; /* 保留備用 */
};
其中
enum v4l2_tuner_type {
V4L2_TUNER_RADIO = 1, /* 調頻收音機 */
V4L2_TUNER_ANALOG_TV = 2, /* 模擬電視高頻頭 */
V4L2_TUNER_DIGITAL_TV = 3, /* 數字電視高頻頭 */
};

其中域 type 有三種類型；capability 域通常爲 V4L2_TUNER_CAP_LOW，代表頻率調節的步長是62.5Hz，若是沒有這個標誌位則步長爲62.5KHz；rangelow 與 rangehigh 是調諧器能夠調頻率的最高值和最低值，但都以步長爲單位表示；rxsubchans 表示調諧器接收的音頻信號類型，常見值有 V4L2_TUNER_SUB_MONO | V4L2_TUNER_SUB_STEREO 即單聲道與立體聲；audmode 表示以何種方式播放聲音，常見值有 V4L2_TUNER_MODE_MONO | V4L2_TUNER_MODE_STEREO，即以單聲道仍是立體聲的方式播放；signal 爲當前信號強度，通常取值範圍爲 0 - 65535。
九、struct v4l2_frequency 與 VIDIOC_G_FREQUENCY、VIDIOC_S_FREQUENCY

VIDIOC_S_FREQUENCY 或 VIDIOC_G_FREQUENCY 命令經過結構 v4l2_frequency 設置或獲取當前頻率值：

[cpp] view plain copy

struct v4l2_frequency {
__u32 tuner; /* 調諧器編號 */
enum v4l2_tuner_type type; /* 調諧器類型 */
__u32 frequency; /* 調諧器頻率 */
__u32 reserved[8];
};

注意：frequency 的值是以62.5Hz 或者 62.5KHZ 爲單位的。

附：_IO、_IOR、_IOW、_IOWR 宏的使用說明

驅動程序中 ioctl 函數傳遞的變量 cmd 是應用程序向驅動程序請求處理的命令。cmd 除了用於區別不一樣命令的數值，還可包含有助於處理的幾種信息。cmd 的大小爲 32 bit，共分 4 個域：

bit29 ~ bit31： 3bit 爲「讀寫」區，做用是區分是讀命令仍是寫命令。
bit16 ~ bit28：13bit 爲 "數據大小" 區，表示 ioctl 中的 arg 變量傳遞的數據大小；有時候爲 14bit 即將 bit29 覆蓋。
bit8 ~ bit15： 8bit 爲「魔數"(也稱爲"幻數")區，這個值用以與其它設備驅動程序的 ioctl 命令進行區別。
bit0 ~ bit7： 8bit 爲 "序號" 區，是區分命令的命令順序序號。

魔數（magic number）
魔數範圍爲 0~255 。一般，用英文字符 'A' ~ 'Z' 或者 'a' ~ 'z' 來表示。設備驅動程序從傳遞進來的命令獲取魔數，而後與自身處理的魔數想比較，若是相同則處理，不一樣則不處理。魔數是拒絕誤使用的初步輔助參數。設備驅動程序能夠經過宏 _IOC_TYPE (cmd) 來獲取魔數。不一樣的設備驅動程序最好設置不一樣的魔數，但並非要求絕對，也是可使用其餘設備驅動程序已用過的魔數。

基數（序號）
基數用於區別各類命令。一般，從 0開始遞增，相同設備驅動程序上能夠重複使用該值。例如，讀和寫命令中使用了相同的基數，設備驅動程序也能分辨出來，緣由在於設備驅動程序區分命令時使用 switch ，且直接使用命令變量 cmd 值。建立命令的宏生成的值由多個域組合而成，因此即便是相同的基數，也會判斷爲不一樣的命令。設備驅動程序想要從命令中獲取該基數，就使用宏 _IOC_NR (cmd)。

下面咱們看一下上述宏在內核中的原型：

[cpp] view plain copy