15#ifndef ZEPHYR_INCLUDE_VIDEO_H_
16#define ZEPHYR_INCLUDE_VIDEO_H_
41#define LINE_COUNT_HEIGHT (-1)
419 __ASSERT_NO_MSG(dev !=
NULL);
420 __ASSERT_NO_MSG(fmt !=
NULL);
444 __ASSERT_NO_MSG(dev !=
NULL);
445 __ASSERT_NO_MSG(fmt !=
NULL);
475 __ASSERT_NO_MSG(dev !=
NULL);
476 __ASSERT_NO_MSG(frmival !=
NULL);
507 __ASSERT_NO_MSG(dev !=
NULL);
508 __ASSERT_NO_MSG(frmival !=
NULL);
539 __ASSERT_NO_MSG(dev !=
NULL);
540 __ASSERT_NO_MSG(fie !=
NULL);
568 __ASSERT_NO_MSG(dev !=
NULL);
569 __ASSERT_NO_MSG(buf !=
NULL);
599 __ASSERT_NO_MSG(dev !=
NULL);
600 __ASSERT_NO_MSG(buf !=
NULL);
607 return api->
dequeue(dev, buf, timeout);
627 __ASSERT_NO_MSG(dev !=
NULL);
634 return api->
flush(dev, cancel);
656 __ASSERT_NO_MSG(dev !=
NULL);
683 __ASSERT_NO_MSG(dev !=
NULL);
708 __ASSERT_NO_MSG(dev !=
NULL);
709 __ASSERT_NO_MSG(caps !=
NULL);
800 __ASSERT_NO_MSG(dev !=
NULL);
801 __ASSERT_NO_MSG(sig !=
NULL);
834 __ASSERT_NO_MSG(dev !=
NULL);
835 __ASSERT_NO_MSG(sel !=
NULL);
866 __ASSERT_NO_MSG(dev !=
NULL);
867 __ASSERT_NO_MSG(sel !=
NULL);
927 __ASSERT_NO_MSG(frmival !=
NULL);
991#define VIDEO_FOURCC(a, b, c, d) \
992 ((uint32_t)(a) | ((uint32_t)(b) << 8) | ((uint32_t)(c) << 16) | ((uint32_t)(d) << 24))
1003#define VIDEO_FOURCC_FROM_STR(str) VIDEO_FOURCC((str)[0], (str)[1], (str)[2], (str)[3])
1014#define VIDEO_FOURCC_TO_STR(fourcc) \
1016 (char)((fourcc) & 0xFF), \
1017 (char)(((fourcc) >> 8) & 0xFF), \
1018 (char)(((fourcc) >> 16) & 0xFF), \
1019 (char)(((fourcc) >> 24) & 0xFF), \
1044#define VIDEO_PIX_FMT_SBGGR8 VIDEO_FOURCC('B', 'A', '8', '1')
1053#define VIDEO_PIX_FMT_SGBRG8 VIDEO_FOURCC('G', 'B', 'R', 'G')
1062#define VIDEO_PIX_FMT_SGRBG8 VIDEO_FOURCC('G', 'R', 'B', 'G')
1071#define VIDEO_PIX_FMT_SRGGB8 VIDEO_FOURCC('R', 'G', 'G', 'B')
1080#define VIDEO_PIX_FMT_SBGGR10P VIDEO_FOURCC('p', 'B', 'A', 'A')
1089#define VIDEO_PIX_FMT_SGBRG10P VIDEO_FOURCC('p', 'G', 'A', 'A')
1098#define VIDEO_PIX_FMT_SGRBG10P VIDEO_FOURCC('p', 'g', 'A', 'A')
1107#define VIDEO_PIX_FMT_SRGGB10P VIDEO_FOURCC('p', 'R', 'A', 'A')
1116#define VIDEO_PIX_FMT_SBGGR12P VIDEO_FOURCC('p', 'B', 'C', 'C')
1125#define VIDEO_PIX_FMT_SGBRG12P VIDEO_FOURCC('p', 'G', 'C', 'C')
1134#define VIDEO_PIX_FMT_SGRBG12P VIDEO_FOURCC('p', 'g', 'C', 'C')
1143#define VIDEO_PIX_FMT_SRGGB12P VIDEO_FOURCC('p', 'R', 'C', 'C')
1152#define VIDEO_PIX_FMT_SBGGR14P VIDEO_FOURCC('p', 'B', 'E', 'E')
1161#define VIDEO_PIX_FMT_SGBRG14P VIDEO_FOURCC('p', 'G', 'E', 'E')
1170#define VIDEO_PIX_FMT_SGRBG14P VIDEO_FOURCC('p', 'g', 'E', 'E')
1179#define VIDEO_PIX_FMT_SRGGB14P VIDEO_FOURCC('p', 'R', 'E', 'E')
1187#define VIDEO_PIX_FMT_SBGGR10 VIDEO_FOURCC('B', 'G', '1', '0')
1195#define VIDEO_PIX_FMT_SGBRG10 VIDEO_FOURCC('G', 'B', '1', '0')
1203#define VIDEO_PIX_FMT_SGRBG10 VIDEO_FOURCC('B', 'A', '1', '0')
1211#define VIDEO_PIX_FMT_SRGGB10 VIDEO_FOURCC('R', 'G', '1', '0')
1219#define VIDEO_PIX_FMT_SBGGR12 VIDEO_FOURCC('B', 'G', '1', '2')
1227#define VIDEO_PIX_FMT_SGBRG12 VIDEO_FOURCC('G', 'B', '1', '2')
1235#define VIDEO_PIX_FMT_SGRBG12 VIDEO_FOURCC('B', 'A', '1', '2')
1243#define VIDEO_PIX_FMT_SRGGB12 VIDEO_FOURCC('R', 'G', '1', '2')
1251#define VIDEO_PIX_FMT_SBGGR14 VIDEO_FOURCC('B', 'G', '1', '4')
1259#define VIDEO_PIX_FMT_SGBRG14 VIDEO_FOURCC('G', 'B', '1', '4')
1267#define VIDEO_PIX_FMT_SGRBG14 VIDEO_FOURCC('G', 'R', '1', '4')
1275#define VIDEO_PIX_FMT_SRGGB14 VIDEO_FOURCC('R', 'G', '1', '4')
1283#define VIDEO_PIX_FMT_SBGGR16 VIDEO_FOURCC('B', 'Y', 'R', '2')
1291#define VIDEO_PIX_FMT_SGBRG16 VIDEO_FOURCC('G', 'B', '1', '6')
1299#define VIDEO_PIX_FMT_SGRBG16 VIDEO_FOURCC('G', 'R', '1', '6')
1307#define VIDEO_PIX_FMT_SRGGB16 VIDEO_FOURCC('R', 'G', '1', '6')
1334#define VIDEO_PIX_FMT_GREY VIDEO_FOURCC('G', 'R', 'E', 'Y')
1342#define VIDEO_PIX_FMT_Y10P VIDEO_FOURCC('Y', '1', '0', 'P')
1351#define VIDEO_PIX_FMT_Y12P VIDEO_FOURCC('Y', '1', '2', 'P')
1360#define VIDEO_PIX_FMT_Y14P VIDEO_FOURCC('Y', '1', '4', 'P')
1370#define VIDEO_PIX_FMT_Y10 VIDEO_FOURCC('Y', '1', '0', ' ')
1380#define VIDEO_PIX_FMT_Y12 VIDEO_FOURCC('Y', '1', '2', ' ')
1390#define VIDEO_PIX_FMT_Y14 VIDEO_FOURCC('Y', '1', '4', ' ')
1400#define VIDEO_PIX_FMT_Y16 VIDEO_FOURCC('Y', '1', '6', ' ')
1421#define VIDEO_PIX_FMT_RGB565X VIDEO_FOURCC('R', 'G', 'B', 'R')
1432#define VIDEO_PIX_FMT_RGB565 VIDEO_FOURCC('R', 'G', 'B', 'P')
1441#define VIDEO_PIX_FMT_BGR24 VIDEO_FOURCC('B', 'G', 'R', '3')
1450#define VIDEO_PIX_FMT_RGB24 VIDEO_FOURCC('R', 'G', 'B', '3')
1458#define VIDEO_PIX_FMT_ARGB32 VIDEO_FOURCC('B', 'A', '2', '4')
1466#define VIDEO_PIX_FMT_ABGR32 VIDEO_FOURCC('A', 'R', '2', '4')
1474#define VIDEO_PIX_FMT_RGBA32 VIDEO_FOURCC('A', 'B', '2', '4')
1482#define VIDEO_PIX_FMT_BGRA32 VIDEO_FOURCC('R', 'A', '2', '4')
1491#define VIDEO_PIX_FMT_XRGB32 VIDEO_FOURCC('B', 'X', '2', '4')
1511#define VIDEO_PIX_FMT_YUYV VIDEO_FOURCC('Y', 'U', 'Y', 'V')
1518#define VIDEO_PIX_FMT_YVYU VIDEO_FOURCC('Y', 'V', 'Y', 'U')
1525#define VIDEO_PIX_FMT_VYUY VIDEO_FOURCC('V', 'Y', 'U', 'Y')
1532#define VIDEO_PIX_FMT_UYVY VIDEO_FOURCC('U', 'Y', 'V', 'Y')
1541#define VIDEO_PIX_FMT_XYUV32 VIDEO_FOURCC('X', 'Y', 'U', 'V')
1568#define VIDEO_PIX_FMT_NV12 VIDEO_FOURCC('N', 'V', '1', '2')
1592#define VIDEO_PIX_FMT_NV21 VIDEO_FOURCC('N', 'V', '2', '1')
1618#define VIDEO_PIX_FMT_NV16 VIDEO_FOURCC('N', 'V', '1', '6')
1645#define VIDEO_PIX_FMT_NV61 VIDEO_FOURCC('N', 'V', '6', '1')
1671#define VIDEO_PIX_FMT_NV24 VIDEO_FOURCC('N', 'V', '2', '4')
1697#define VIDEO_PIX_FMT_NV42 VIDEO_FOURCC('N', 'V', '4', '2')
1726#define VIDEO_PIX_FMT_YUV420 VIDEO_FOURCC('Y', 'U', '1', '2')
1755#define VIDEO_PIX_FMT_YVU420 VIDEO_FOURCC('Y', 'V', '1', '2')
1769#define VIDEO_PIX_FMT_JPEG VIDEO_FOURCC('J', 'P', 'E', 'G')
1876#define VIDEO_MIPI_CSI2_DT_NULL 0x10
1878#define VIDEO_MIPI_CSI2_DT_BLANKING 0x11
1880#define VIDEO_MIPI_CSI2_DT_EMBEDDED_8 0x12
1882#define VIDEO_MIPI_CSI2_DT_YUV420_8 0x18
1884#define VIDEO_MIPI_CSI2_DT_YUV420_10 0x19
1886#define VIDEO_MIPI_CSI2_DT_YUV420_CSPS_8 0x1c
1888#define VIDEO_MIPI_CSI2_DT_YUV420_CSPS_10 0x1d
1890#define VIDEO_MIPI_CSI2_DT_YUV422_8 0x1e
1892#define VIDEO_MIPI_CSI2_DT_YUV422_10 0x1f
1894#define VIDEO_MIPI_CSI2_DT_RGB444 0x20
1896#define VIDEO_MIPI_CSI2_DT_RGB555 0x21
1898#define VIDEO_MIPI_CSI2_DT_RGB565 0x22
1900#define VIDEO_MIPI_CSI2_DT_RGB666 0x23
1902#define VIDEO_MIPI_CSI2_DT_RGB888 0x24
1904#define VIDEO_MIPI_CSI2_DT_RAW6 0x28
1906#define VIDEO_MIPI_CSI2_DT_RAW7 0x29
1908#define VIDEO_MIPI_CSI2_DT_RAW8 0x2a
1910#define VIDEO_MIPI_CSI2_DT_RAW10 0x2b
1912#define VIDEO_MIPI_CSI2_DT_RAW12 0x2c
1914#define VIDEO_MIPI_CSI2_DT_RAW14 0x2d
1927#define VIDEO_MIPI_CSI2_DT_USER(n) (0x30 + (n))
#define NSEC_PER_SEC
number of nanoseconds per second
Definition clock.h:113
#define EINVAL
Invalid argument.
Definition errno.h:60
#define ENOSYS
Function not implemented.
Definition errno.h:82
int(* video_api_selection_t)(const struct device *dev, struct video_selection *sel)
Get/Set video selection (crop / compose)
Definition video.h:380
video_signal_result
Video signal result.
Definition video.h:230
struct video_buffer * video_buffer_aligned_alloc(size_t size, size_t align, k_timeout_t timeout)
Allocate aligned video buffer.
int video_set_ctrl(const struct device *dev, struct video_control *control)
Set the value of a control.
static int video_set_selection(const struct device *dev, struct video_selection *sel)
Set video selection (crop/compose).
Definition video.h:830
int(* video_api_enqueue_t)(const struct device *dev, struct video_buffer *buf)
Enqueue a buffer in the driver’s incoming queue.
Definition video.h:314
int(* video_api_set_stream_t)(const struct device *dev, bool enable, enum video_buf_type type)
Start or stop streaming on the video device.
Definition video.h:346
void video_print_ctrl(const struct video_ctrl_query *const cq)
Print all the information of a control.
int(* video_api_get_caps_t)(const struct device *dev, struct video_caps *caps)
Get capabilities of a video endpoint.
Definition video.h:364
int64_t video_get_csi_link_freq(const struct device *dev, uint8_t bpp, uint8_t lane_nb)
Return the link-frequency advertised by a device.
static int video_dequeue(const struct device *dev, struct video_buffer **buf, k_timeout_t timeout)
Dequeue a video buffer.
Definition video.h:594
int(* video_api_dequeue_t)(const struct device *dev, struct video_buffer **buf, k_timeout_t timeout)
Dequeue a buffer from the driver’s outgoing queue.
Definition video.h:322
video_frmival_type
Supported frame interval type of a video device.
Definition video.h:173
static uint64_t video_frmival_nsec(const struct video_frmival *frmival)
Compute the difference between two frame intervals.
Definition video.h:925
int video_get_ctrl(const struct device *dev, struct video_control *control)
Get the current value of a control.
static int video_enum_frmival(const struct device *dev, struct video_frmival_enum *fie)
List video frame intervals.
Definition video.h:535
static int video_stream_start(const struct device *dev, enum video_buf_type type)
Start the video device function.
Definition video.h:652
int(* video_api_frmival_t)(const struct device *dev, struct video_frmival *frmival)
Function pointer type for video_set/get_frmival()
Definition video.h:298
int video_query_ctrl(struct video_ctrl_query *cq)
Query information about a control.
static int video_get_caps(const struct device *dev, struct video_caps *caps)
Get the capabilities of a video endpoint.
Definition video.h:704
static int video_get_selection(const struct device *dev, struct video_selection *sel)
Get video selection (crop/compose).
Definition video.h:862
int(* video_api_enum_frmival_t)(const struct device *dev, struct video_frmival_enum *fie)
List all supported frame intervals of a given format.
Definition video.h:306
int(* video_api_ctrl_t)(const struct device *dev, uint32_t cid)
Set/Get a video control value.
Definition video.h:356
static int video_flush(const struct device *dev, bool cancel)
Flush endpoint buffers.
Definition video.h:623
static int video_stream_stop(const struct device *dev, enum video_buf_type type)
Stop the video device function.
Definition video.h:678
int(* video_api_flush_t)(const struct device *dev, bool cancel)
Flush endpoint buffers, buffer are moved from incoming queue to outgoing queue.
Definition video.h:332
static int video_set_format(const struct device *dev, struct video_format *fmt)
Set video format.
Definition video.h:415
static int video_set_signal(const struct device *dev, struct k_poll_signal *sig)
Register/Unregister k_poll signal for a video endpoint.
Definition video.h:796
static int video_set_frmival(const struct device *dev, struct video_frmival *frmival)
Set video frame interval.
Definition video.h:471
static int video_enqueue(const struct device *dev, struct video_buffer *buf)
Enqueue a video buffer.
Definition video.h:564
void video_closest_frmival_stepwise(const struct video_frmival_stepwise *stepwise, const struct video_frmival *desired, struct video_frmival *match)
Find the closest match to a frame interval value within a stepwise frame interval.
void video_buffer_release(struct video_buffer *buf)
Release a video buffer.
int(* video_api_set_signal_t)(const struct device *dev, struct k_poll_signal *sig)
Register/Unregister poll signal for buffer events.
Definition video.h:372
video_buf_type
video_buf_type enum
Definition video.h:53
static int video_get_format(const struct device *dev, struct video_format *fmt)
Get video format.
Definition video.h:440
int video_format_caps_index(const struct video_format_cap *fmts, const struct video_format *fmt, size_t *idx)
Search for a format that matches in a list of capabilities.
video_selection_target
Video selection target.
Definition video.h:241
int(* video_api_format_t)(const struct device *dev, struct video_format *fmt)
Function pointer type for video_set/get_format()
Definition video.h:290
struct video_buffer * video_buffer_alloc(size_t size, k_timeout_t timeout)
Allocate video buffer.
void video_closest_frmival(const struct device *dev, struct video_frmival_enum *match)
Find the closest match to a frame interval value within a video device.
static int video_get_frmival(const struct device *dev, struct video_frmival *frmival)
Get video frame interval.
Definition video.h:503
@ VIDEO_BUF_ABORTED
Buffer is aborted.
Definition video.h:232
@ VIDEO_BUF_DONE
Buffer is done.
Definition video.h:231
@ VIDEO_BUF_ERROR
Buffer is in error.
Definition video.h:233
@ VIDEO_FRMIVAL_TYPE_DISCRETE
discrete frame interval type
Definition video.h:175
@ VIDEO_FRMIVAL_TYPE_STEPWISE
stepwise frame interval type
Definition video.h:177
@ VIDEO_BUF_TYPE_INPUT
input buffer type
Definition video.h:55
@ VIDEO_BUF_TYPE_OUTPUT
output buffer type
Definition video.h:57
@ VIDEO_SEL_TGT_COMPOSE_BOUND
Compose bound (aka the maximum compose achievable)
Definition video.h:251
@ VIDEO_SEL_TGT_COMPOSE
Current compose setting.
Definition video.h:249
@ VIDEO_SEL_TGT_NATIVE_SIZE
Native size of the input frame.
Definition video.h:247
@ VIDEO_SEL_TGT_CROP
Current crop setting.
Definition video.h:243
@ VIDEO_SEL_TGT_CROP_BOUND
Crop bound (aka the maximum crop achievable)
Definition video.h:245
#define NULL
Definition iar_missing_defs.h:20
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__UINT64_TYPE__ uint64_t
Definition stdint.h:91
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
__INT64_TYPE__ int64_t
Definition stdint.h:75
__INT16_TYPE__ int16_t
Definition stdint.h:73
Runtime device structure (in ROM) per driver instance.
Definition device.h:510
const void * api
Address of the API structure exposed by the device instance.
Definition device.h:516
Kernel timeout type.
Definition clock.h:65
Video buffer structure.
Definition video.h:143
uint32_t bytesused
number of bytes occupied by the valid data in the buffer.
Definition video.h:156
uint32_t size
size of the buffer in bytes.
Definition video.h:154
enum video_buf_type type
type of the buffer
Definition video.h:148
uint8_t * buffer
pointer to the start of the buffer.
Definition video.h:150
void * driver_data
Pointer to driver specific data.
Definition video.h:146
uint16_t line_offset
Line offset within frame this buffer represents, from the beginning of the frame.
Definition video.h:167
uint8_t index
index of the buffer, optionally set by the application
Definition video.h:152
uint32_t timestamp
time reference in milliseconds at which the last data byte was actually received for input endpoints ...
Definition video.h:161
Video format capabilities.
Definition video.h:111
uint8_t min_vbuf_count
minimal count of video buffers to enqueue before being able to start the stream.
Definition video.h:119
enum video_buf_type type
type of the buffer
Definition video.h:113
int16_t min_line_count
Denotes minimum line count of a video buffer that this endpoint can fill or process.
Definition video.h:128
int16_t max_line_count
Denotes maximum line count of a video buffer that this endpoint can fill or process.
Definition video.h:135
const struct video_format_cap * format_caps
list of video format capabilities (zero terminated).
Definition video.h:115
Video control structure.
Definition video-controls.h:428
Definition video-controls.h:475
const struct device * dev
device being queried, application needs to set this field
Definition video-controls.h:477
video_api_format_t set_format
Definition video.h:384
video_api_ctrl_t set_ctrl
Definition video.h:392
video_api_enqueue_t enqueue
Definition video.h:389
video_api_set_signal_t set_signal
Definition video.h:394
video_api_enum_frmival_t enum_frmival
Definition video.h:397
video_api_get_caps_t get_caps
Definition video.h:387
video_api_selection_t get_selection
Definition video.h:399
video_api_selection_t set_selection
Definition video.h:398
video_api_format_t get_format
Definition video.h:385
video_api_flush_t flush
Definition video.h:391
video_api_dequeue_t dequeue
Definition video.h:390
video_api_frmival_t get_frmival
Definition video.h:396
video_api_frmival_t set_frmival
Definition video.h:395
video_api_set_stream_t set_stream
Definition video.h:386
video_api_ctrl_t get_volatile_ctrl
Definition video.h:393
Video frame interval enumeration structure.
Definition video.h:211
uint32_t index
frame interval index during enumeration
Definition video.h:213
const struct video_format * format
video format for which the query is made
Definition video.h:215
enum video_frmival_type type
frame interval type the device supports
Definition video.h:217
Video frame interval stepwise structure.
Definition video.h:197
struct video_frmival min
minimum frame interval in seconds
Definition video.h:199
struct video_frmival max
maximum frame interval in seconds
Definition video.h:201
struct video_frmival step
frame interval step size in seconds
Definition video.h:203
Video frame interval structure.
Definition video.h:185
uint32_t numerator
numerator of the frame interval
Definition video.h:187
uint32_t denominator
denominator of the frame interval
Definition video.h:189
Description of a rectangle area.
Definition video.h:259
uint32_t width
width of selection rectangle
Definition video.h:265
uint32_t height
height of selection rectangle
Definition video.h:267
uint32_t top
top offset of selection rectangle
Definition video.h:263
uint32_t left
left offset of selection rectangle
Definition video.h:261
Video selection (crop / compose) structure.
Definition video.h:275
struct video_rect rect
selection target rectangle
Definition video.h:281
enum video_buf_type type
buffer type, allow to select for device having both input and output
Definition video.h:277
enum video_selection_target target
selection target enum
Definition video.h:279