7.16. ioctl VIDIOC_ENUM_FRAMEINTERVALS¶

7.16.1. 名稱¶

VIDIOC_ENUM_FRAMEINTERVALS - 列舉幀間隔

int ioctl(int fd, VIDIOC_ENUM_FRAMEINTERVALS, struct v4l2_frmivalenum *argp)

此 ioctl 允許應用程式列舉裝置支援的給定畫素格式和幀大小的所有幀間隔。

支援的畫素格式和幀大小可以透過使用 ioctl VIDIOC_ENUM_FMT 和 ioctl VIDIOC_ENUM_FRAMESIZES 函式來獲得。

返回值和 v4l2_frmivalenum.type 欄位的內容取決於裝置支援的幀間隔型別。以下是針對不同情況的函式語義

離散： 如果給定的索引值（從零開始）有效，則函式返回成功。應用程式應該為每次呼叫將索引加一，直到返回 EINVAL。 v4l2_frmivalenum.type 欄位由驅動程式設定為 V4L2_FRMIVAL_TYPE_DISCRETE。在 union 中，只有 discrete 成員有效。
步進： 如果給定的索引值為零，則函式返回成功；對於任何其他索引值，則返回 EINVAL。 v4l2_frmivalenum.type 欄位由驅動程式設定為 V4L2_FRMIVAL_TYPE_STEPWISE。在 union 中，只有 stepwise 成員有效。
連續： 這是上述步進型別的一種特殊情況。如果給定的索引值為零，則函式返回成功；對於任何其他索引值，則返回 EINVAL。 v4l2_frmivalenum.type 欄位由驅動程式設定為 V4L2_FRMIVAL_TYPE_CONTINUOUS。在 union 中，只有 stepwise 成員有效，並且 step 值設定為 1。

當應用程式使用索引零呼叫函式時，它必須檢查 type 欄位以確定裝置支援的幀間隔列舉型別。僅對於 V4L2_FRMIVAL_TYPE_DISCRETE 型別，增加索引值以接收更多幀間隔才有意義。

注意

返回幀間隔的順序沒有特殊含義。特別是，它沒有說明任何潛在的預設幀間隔。

應用程式可以假設列舉資料在沒有任何應用程式本身互動的情況下不會更改。這意味著如果在執行幀間隔列舉時應用程式不執行任何其他 ioctl 呼叫，則列舉資料是一致的。

注意

幀間隔和幀率： V4L2 API 使用幀間隔而不是幀率。給定幀間隔，可以按如下方式計算幀率

frame_rate = 1 / frame_interval

在下面的結構體中，IN 表示必須由應用程式填充的值，OUT 表示驅動程式填充的值。應用程式應將所有成員清零，除了 IN 欄位。

結構體 v4l2_frmivalenum¶
__u32	`index`	IN：列舉中給定幀間隔的索引。
__u32	`pixel_format`	IN：列舉幀間隔的畫素格式。
__u32	`width`	IN：列舉幀間隔的幀寬度。
__u32	`height`	IN：列舉幀間隔的幀高度。
__u32	`type`	OUT：裝置支援的幀間隔型別。
union {	(anonymous)	OUT：具有給定索引的幀間隔。
結構體 `v4l2_fract`	`discrete`	幀間隔 [s]。
結構體 `v4l2_frmival_stepwise`	`stepwise`
}
__u32	`reserved[2]`	為將來使用保留的空間。驅動程式和應用程式必須將其清零。

成功時返回 0，出錯時返回 -1，並適當設定 errno 變數。通用錯誤程式碼在通用錯誤程式碼章節中描述。