Zephyr API Documentation 4.2.0-rc1
A Scalable Open Source RTOS
 4.2.0-rc1
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
video.h
Go to the documentation of this file.
1
7/*
8 * Copyright (c) 2019 Linaro Limited.
9 * Copyright 2025 NXP
10 * Copyright (c) 2025 STMicroelectronics
11 *
12 * SPDX-License-Identifier: Apache-2.0
13 */
14#ifndef ZEPHYR_INCLUDE_VIDEO_H_
15#define ZEPHYR_INCLUDE_VIDEO_H_
16
26#include <zephyr/device.h>
27#include <stddef.h>
28#include <zephyr/kernel.h>
29
30#include <zephyr/types.h>
31
32#ifdef __cplusplus
33extern "C" {
34#endif
35
36/*
37 * Flag used by @ref video_caps structure to indicate endpoint operates on
38 * buffers the size of the video frame
39 */
40#define LINE_COUNT_HEIGHT (-1)
41
42struct video_control;
43
58
83
106
139
148 /* It must be kept as first field of the struct if used for @ref k_fifo APIs. */
171};
172
184
197
212
223 const struct video_format *format;
227 union {
228 struct video_frmival discrete;
229 struct video_frmival_stepwise stepwise;
230 };
231};
232
243
262
279
294
301typedef int (*video_api_format_t)(const struct device *dev, struct video_format *fmt);
302
309typedef int (*video_api_frmival_t)(const struct device *dev, struct video_frmival *frmival);
310
317typedef int (*video_api_enum_frmival_t)(const struct device *dev, struct video_frmival_enum *fie);
318
325typedef int (*video_api_enqueue_t)(const struct device *dev, struct video_buffer *buf);
326
333typedef int (*video_api_dequeue_t)(const struct device *dev, struct video_buffer **buf,
334 k_timeout_t timeout);
335
343typedef int (*video_api_flush_t)(const struct device *dev, bool cancel);
344
357typedef int (*video_api_set_stream_t)(const struct device *dev, bool enable,
358 enum video_buf_type type);
359
367typedef int (*video_api_ctrl_t)(const struct device *dev, uint32_t cid);
368
375typedef int (*video_api_get_caps_t)(const struct device *dev, struct video_caps *caps);
376
383typedef int (*video_api_set_signal_t)(const struct device *dev, struct k_poll_signal *sig);
384
391typedef int (*video_api_selection_t)(const struct device *dev, struct video_selection *sel);
392
412
426static inline int video_set_format(const struct device *dev, struct video_format *fmt)
427{
428 const struct video_driver_api *api;
429
430 __ASSERT_NO_MSG(dev != NULL);
431 __ASSERT_NO_MSG(fmt != NULL);
432
433 api = (const struct video_driver_api *)dev->api;
434 if (api->set_format == NULL) {
435 return -ENOSYS;
436 }
437
438 return api->set_format(dev, fmt);
439}
440
451static inline int video_get_format(const struct device *dev, struct video_format *fmt)
452{
453 const struct video_driver_api *api;
454
455 __ASSERT_NO_MSG(dev != NULL);
456 __ASSERT_NO_MSG(fmt != NULL);
457
458 api = (const struct video_driver_api *)dev->api;
459 if (api->get_format == NULL) {
460 return -ENOSYS;
461 }
462
463 return api->get_format(dev, fmt);
464}
465
482static inline int video_set_frmival(const struct device *dev, struct video_frmival *frmival)
483{
484 const struct video_driver_api *api;
485
486 __ASSERT_NO_MSG(dev != NULL);
487 __ASSERT_NO_MSG(frmival != NULL);
488
489 if (frmival->numerator == 0 || frmival->denominator == 0) {
490 return -EINVAL;
491 }
492
493 api = (const struct video_driver_api *)dev->api;
494 if (api->set_frmival == NULL) {
495 return -ENOSYS;
496 }
497
498 return api->set_frmival(dev, frmival);
499}
500
514static inline int video_get_frmival(const struct device *dev, struct video_frmival *frmival)
515{
516 const struct video_driver_api *api;
517
518 __ASSERT_NO_MSG(dev != NULL);
519 __ASSERT_NO_MSG(frmival != NULL);
520
521 api = (const struct video_driver_api *)dev->api;
522 if (api->get_frmival == NULL) {
523 return -ENOSYS;
524 }
525
526 return api->get_frmival(dev, frmival);
527}
528
546static inline int video_enum_frmival(const struct device *dev, struct video_frmival_enum *fie)
547{
548 const struct video_driver_api *api;
549
550 __ASSERT_NO_MSG(dev != NULL);
551 __ASSERT_NO_MSG(fie != NULL);
552 __ASSERT_NO_MSG(fie->format != NULL);
553
554 api = (const struct video_driver_api *)dev->api;
555 if (api->enum_frmival == NULL) {
556 return -ENOSYS;
557 }
558
559 return api->enum_frmival(dev, fie);
560}
561
575static inline int video_enqueue(const struct device *dev, struct video_buffer *buf)
576{
577 const struct video_driver_api *api = (const struct video_driver_api *)dev->api;
578
579 __ASSERT_NO_MSG(dev != NULL);
580 __ASSERT_NO_MSG(buf != NULL);
581 __ASSERT_NO_MSG(buf->buffer != NULL);
582
583 api = (const struct video_driver_api *)dev->api;
584 if (api->enqueue == NULL) {
585 return -ENOSYS;
586 }
587
588 return api->enqueue(dev, buf);
589}
590
605static inline int video_dequeue(const struct device *dev, struct video_buffer **buf,
606 k_timeout_t timeout)
607{
608 const struct video_driver_api *api;
609
610 __ASSERT_NO_MSG(dev != NULL);
611 __ASSERT_NO_MSG(buf != NULL);
612
613 api = (const struct video_driver_api *)dev->api;
614 if (api->dequeue == NULL) {
615 return -ENOSYS;
616 }
617
618 return api->dequeue(dev, buf, timeout);
619}
620
634static inline int video_flush(const struct device *dev, bool cancel)
635{
636 const struct video_driver_api *api;
637
638 __ASSERT_NO_MSG(dev != NULL);
639
640 api = (const struct video_driver_api *)dev->api;
641 if (api->flush == NULL) {
642 return -ENOSYS;
643 }
644
645 return api->flush(dev, cancel);
646}
647
663static inline int video_stream_start(const struct device *dev, enum video_buf_type type)
664{
665 const struct video_driver_api *api;
666
667 __ASSERT_NO_MSG(dev != NULL);
668
669 api = (const struct video_driver_api *)dev->api;
670 if (api->set_stream == NULL) {
671 return -ENOSYS;
672 }
673
674 return api->set_stream(dev, true, type);
675}
676
689static inline int video_stream_stop(const struct device *dev, enum video_buf_type type)
690{
691 const struct video_driver_api *api;
692 int ret;
693
694 __ASSERT_NO_MSG(dev != NULL);
695
696 api = (const struct video_driver_api *)dev->api;
697 if (api->set_stream == NULL) {
698 return -ENOSYS;
699 }
700
701 ret = api->set_stream(dev, false, type);
702 video_flush(dev, true);
703
704 return ret;
705}
706
715static inline int video_get_caps(const struct device *dev, struct video_caps *caps)
716{
717 const struct video_driver_api *api;
718
719 __ASSERT_NO_MSG(dev != NULL);
720 __ASSERT_NO_MSG(caps != NULL);
721
722 api = (const struct video_driver_api *)dev->api;
723 if (api->get_caps == NULL) {
724 return -ENOSYS;
725 }
726
727 return api->get_caps(dev, caps);
728}
729
744int video_set_ctrl(const struct device *dev, struct video_control *control);
745
760int video_get_ctrl(const struct device *dev, struct video_control *control);
761
762struct video_ctrl_query;
763
783
793void video_print_ctrl(const struct video_ctrl_query *const cq);
794
807static inline int video_set_signal(const struct device *dev, struct k_poll_signal *sig)
808{
809 const struct video_driver_api *api;
810
811 __ASSERT_NO_MSG(dev != NULL);
812 __ASSERT_NO_MSG(sig != NULL);
813
814 api = (const struct video_driver_api *)dev->api;
815 if (api->set_signal == NULL) {
816 return -ENOSYS;
817 }
818
819 return api->set_signal(dev, sig);
820}
821
841static inline int video_set_selection(const struct device *dev, struct video_selection *sel)
842{
843 const struct video_driver_api *api;
844
845 __ASSERT_NO_MSG(dev != NULL);
846 __ASSERT_NO_MSG(sel != NULL);
847
848 api = (const struct video_driver_api *)dev->api;
849 if (api->set_selection == NULL) {
850 return -ENOSYS;
851 }
852
853 return api->set_selection(dev, sel);
854}
855
873static inline int video_get_selection(const struct device *dev, struct video_selection *sel)
874{
875 const struct video_driver_api *api;
876
877 __ASSERT_NO_MSG(dev != NULL);
878 __ASSERT_NO_MSG(sel != NULL);
879
880 api = (const struct video_driver_api *)dev->api;
881 if (api->get_selection == NULL) {
882 return -ENOSYS;
883 }
884
885 return api->get_selection(dev, sel);
886}
887
897struct video_buffer *video_buffer_aligned_alloc(size_t size, size_t align, k_timeout_t timeout);
898
908
915
926int video_format_caps_index(const struct video_format_cap *fmts, const struct video_format *fmt,
927 size_t *idx);
928
936static inline uint64_t video_frmival_nsec(const struct video_frmival *frmival)
937{
938 __ASSERT_NO_MSG(frmival != NULL);
939 __ASSERT_NO_MSG(frmival->denominator != 0);
940
941 return (uint64_t)NSEC_PER_SEC * frmival->numerator / frmival->denominator;
942}
943
952 const struct video_frmival *desired,
953 struct video_frmival *match);
954
972void video_closest_frmival(const struct device *dev, struct video_frmival_enum *match);
973
989int64_t video_get_csi_link_freq(const struct device *dev, uint8_t bpp, uint8_t lane_nb);
990
1002#define VIDEO_FOURCC(a, b, c, d) \
1003 ((uint32_t)(a) | ((uint32_t)(b) << 8) | ((uint32_t)(c) << 16) | ((uint32_t)(d) << 24))
1004
1014#define VIDEO_FOURCC_FROM_STR(str) VIDEO_FOURCC((str)[0], (str)[1], (str)[2], (str)[3])
1015
1025#define VIDEO_FOURCC_TO_STR(fourcc) \
1026 ((char[]){ \
1027 (char)((fourcc) & 0xFF), \
1028 (char)(((fourcc) >> 8) & 0xFF), \
1029 (char)(((fourcc) >> 16) & 0xFF), \
1030 (char)(((fourcc) >> 24) & 0xFF), \
1031 '\0' \
1032 })
1033
1055#define VIDEO_PIX_FMT_SBGGR8 VIDEO_FOURCC('B', 'A', '8', '1')
1056
1064#define VIDEO_PIX_FMT_SGBRG8 VIDEO_FOURCC('G', 'B', 'R', 'G')
1065
1073#define VIDEO_PIX_FMT_SGRBG8 VIDEO_FOURCC('G', 'R', 'B', 'G')
1074
1082#define VIDEO_PIX_FMT_SRGGB8 VIDEO_FOURCC('R', 'G', 'G', 'B')
1083
1091#define VIDEO_PIX_FMT_SBGGR10P VIDEO_FOURCC('p', 'B', 'A', 'A')
1092
1100#define VIDEO_PIX_FMT_SGBRG10P VIDEO_FOURCC('p', 'G', 'A', 'A')
1101
1109#define VIDEO_PIX_FMT_SGRBG10P VIDEO_FOURCC('p', 'g', 'A', 'A')
1110
1118#define VIDEO_PIX_FMT_SRGGB10P VIDEO_FOURCC('p', 'R', 'A', 'A')
1119
1127#define VIDEO_PIX_FMT_SBGGR12P VIDEO_FOURCC('p', 'B', 'C', 'C')
1128
1136#define VIDEO_PIX_FMT_SGBRG12P VIDEO_FOURCC('p', 'G', 'C', 'C')
1137
1145#define VIDEO_PIX_FMT_SGRBG12P VIDEO_FOURCC('p', 'g', 'C', 'C')
1146
1154#define VIDEO_PIX_FMT_SRGGB12P VIDEO_FOURCC('p', 'R', 'C', 'C')
1155
1163#define VIDEO_PIX_FMT_SBGGR14P VIDEO_FOURCC('p', 'B', 'E', 'E')
1164
1172#define VIDEO_PIX_FMT_SGBRG14P VIDEO_FOURCC('p', 'G', 'E', 'E')
1173
1181#define VIDEO_PIX_FMT_SGRBG14P VIDEO_FOURCC('p', 'g', 'E', 'E')
1182
1190#define VIDEO_PIX_FMT_SRGGB14P VIDEO_FOURCC('p', 'R', 'E', 'E')
1191
1198#define VIDEO_PIX_FMT_SBGGR10 VIDEO_FOURCC('B', 'G', '1', '0')
1199
1206#define VIDEO_PIX_FMT_SGBRG10 VIDEO_FOURCC('G', 'B', '1', '0')
1207
1214#define VIDEO_PIX_FMT_SGRBG10 VIDEO_FOURCC('B', 'A', '1', '0')
1215
1222#define VIDEO_PIX_FMT_SRGGB10 VIDEO_FOURCC('R', 'G', '1', '0')
1223
1230#define VIDEO_PIX_FMT_SBGGR12 VIDEO_FOURCC('B', 'G', '1', '2')
1231
1238#define VIDEO_PIX_FMT_SGBRG12 VIDEO_FOURCC('G', 'B', '1', '2')
1239
1246#define VIDEO_PIX_FMT_SGRBG12 VIDEO_FOURCC('B', 'A', '1', '2')
1247
1254#define VIDEO_PIX_FMT_SRGGB12 VIDEO_FOURCC('R', 'G', '1', '2')
1255
1262#define VIDEO_PIX_FMT_SBGGR14 VIDEO_FOURCC('B', 'G', '1', '4')
1263
1270#define VIDEO_PIX_FMT_SGBRG14 VIDEO_FOURCC('G', 'B', '1', '4')
1271
1278#define VIDEO_PIX_FMT_SGRBG14 VIDEO_FOURCC('G', 'R', '1', '4')
1279
1286#define VIDEO_PIX_FMT_SRGGB14 VIDEO_FOURCC('R', 'G', '1', '4')
1287
1294#define VIDEO_PIX_FMT_SBGGR16 VIDEO_FOURCC('B', 'Y', 'R', '2')
1295
1302#define VIDEO_PIX_FMT_SGBRG16 VIDEO_FOURCC('G', 'B', '1', '6')
1303
1310#define VIDEO_PIX_FMT_SGRBG16 VIDEO_FOURCC('G', 'R', '1', '6')
1311
1318#define VIDEO_PIX_FMT_SRGGB16 VIDEO_FOURCC('R', 'G', '1', '6')
1319
1345#define VIDEO_PIX_FMT_GREY VIDEO_FOURCC('G', 'R', 'E', 'Y')
1346
1353#define VIDEO_PIX_FMT_Y10P VIDEO_FOURCC('Y', '1', '0', 'P')
1354
1362#define VIDEO_PIX_FMT_Y12P VIDEO_FOURCC('Y', '1', '2', 'P')
1363
1371#define VIDEO_PIX_FMT_Y14P VIDEO_FOURCC('Y', '1', '4', 'P')
1372
1381#define VIDEO_PIX_FMT_Y10 VIDEO_FOURCC('Y', '1', '0', ' ')
1382
1391#define VIDEO_PIX_FMT_Y12 VIDEO_FOURCC('Y', '1', '2', ' ')
1392
1401#define VIDEO_PIX_FMT_Y14 VIDEO_FOURCC('Y', '1', '4', ' ')
1402
1411#define VIDEO_PIX_FMT_Y16 VIDEO_FOURCC('Y', '1', '6', ' ')
1412
1432#define VIDEO_PIX_FMT_RGB565X VIDEO_FOURCC('R', 'G', 'B', 'R')
1433
1443#define VIDEO_PIX_FMT_RGB565 VIDEO_FOURCC('R', 'G', 'B', 'P')
1444
1452#define VIDEO_PIX_FMT_BGR24 VIDEO_FOURCC('B', 'G', 'R', '3')
1453
1461#define VIDEO_PIX_FMT_RGB24 VIDEO_FOURCC('R', 'G', 'B', '3')
1462
1469#define VIDEO_PIX_FMT_ARGB32 VIDEO_FOURCC('B', 'A', '2', '4')
1470
1477#define VIDEO_PIX_FMT_ABGR32 VIDEO_FOURCC('A', 'R', '2', '4')
1478
1485#define VIDEO_PIX_FMT_RGBA32 VIDEO_FOURCC('A', 'B', '2', '4')
1486
1493#define VIDEO_PIX_FMT_BGRA32 VIDEO_FOURCC('R', 'A', '2', '4')
1494
1502#define VIDEO_PIX_FMT_XRGB32 VIDEO_FOURCC('B', 'X', '2', '4')
1503
1522#define VIDEO_PIX_FMT_YUYV VIDEO_FOURCC('Y', 'U', 'Y', 'V')
1523
1529#define VIDEO_PIX_FMT_YVYU VIDEO_FOURCC('Y', 'V', 'Y', 'U')
1530
1536#define VIDEO_PIX_FMT_VYUY VIDEO_FOURCC('V', 'Y', 'U', 'Y')
1537
1543#define VIDEO_PIX_FMT_UYVY VIDEO_FOURCC('U', 'Y', 'V', 'Y')
1544
1552#define VIDEO_PIX_FMT_XYUV32 VIDEO_FOURCC('X', 'Y', 'U', 'V')
1553
1566#define VIDEO_PIX_FMT_JPEG VIDEO_FOURCC('J', 'P', 'E', 'G')
1567
1580static inline unsigned int video_bits_per_pixel(uint32_t pixfmt)
1581{
1582 switch (pixfmt) {
1587 case VIDEO_PIX_FMT_GREY:
1588 return 8;
1593 case VIDEO_PIX_FMT_Y10P:
1594 return 10;
1599 case VIDEO_PIX_FMT_Y12P:
1600 return 12;
1605 case VIDEO_PIX_FMT_Y14P:
1606 return 14;
1608 case VIDEO_PIX_FMT_YUYV:
1609 case VIDEO_PIX_FMT_YVYU:
1610 case VIDEO_PIX_FMT_UYVY:
1611 case VIDEO_PIX_FMT_VYUY:
1628 case VIDEO_PIX_FMT_Y10:
1629 case VIDEO_PIX_FMT_Y12:
1630 case VIDEO_PIX_FMT_Y14:
1631 case VIDEO_PIX_FMT_Y16:
1632 return 16;
1635 return 24;
1642 return 32;
1643 default:
1644 /* Variable number of bits per pixel or unknown format */
1645 return 0;
1646 }
1647}
1648
1658#define VIDEO_MIPI_CSI2_DT_NULL 0x10
1659#define VIDEO_MIPI_CSI2_DT_BLANKING 0x11
1660#define VIDEO_MIPI_CSI2_DT_EMBEDDED_8 0x12
1661#define VIDEO_MIPI_CSI2_DT_YUV420_8 0x18
1662#define VIDEO_MIPI_CSI2_DT_YUV420_10 0x19
1663#define VIDEO_MIPI_CSI2_DT_YUV420_CSPS_8 0x1c
1664#define VIDEO_MIPI_CSI2_DT_YUV420_CSPS_10 0x1d
1665#define VIDEO_MIPI_CSI2_DT_YUV422_8 0x1e
1666#define VIDEO_MIPI_CSI2_DT_YUV422_10 0x1f
1667#define VIDEO_MIPI_CSI2_DT_RGB444 0x20
1668#define VIDEO_MIPI_CSI2_DT_RGB555 0x21
1669#define VIDEO_MIPI_CSI2_DT_RGB565 0x22
1670#define VIDEO_MIPI_CSI2_DT_RGB666 0x23
1671#define VIDEO_MIPI_CSI2_DT_RGB888 0x24
1672#define VIDEO_MIPI_CSI2_DT_RAW6 0x28
1673#define VIDEO_MIPI_CSI2_DT_RAW7 0x29
1674#define VIDEO_MIPI_CSI2_DT_RAW8 0x2a
1675#define VIDEO_MIPI_CSI2_DT_RAW10 0x2b
1676#define VIDEO_MIPI_CSI2_DT_RAW12 0x2c
1677#define VIDEO_MIPI_CSI2_DT_RAW14 0x2d
1678
1679/* User-defined Data-Type range from 0x30 to 0x37 */
1680#define VIDEO_MIPI_CSI2_DT_USER(n) (0x30 + (n))
1681
1686#ifdef __cplusplus
1687}
1688#endif
1689
1694#endif /* ZEPHYR_INCLUDE_VIDEO_H_ */
#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_enum_frmival_t)(const struct device *dev, struct video_frmival_enum *fie)
List all supported frame intervals of a given format.
Definition video.h:317
int(* video_api_get_caps_t)(const struct device *dev, struct video_caps *caps)
Get capabilities of a video endpoint.
Definition video.h:375
video_signal_result
video_event enum
Definition video.h:238
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:841
void video_print_ctrl(const struct video_ctrl_query *const cq)
Print all the information of a control.
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.
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:333
static int video_dequeue(const struct device *dev, struct video_buffer **buf, k_timeout_t timeout)
Dequeue a video buffer.
Definition video.h:605
int(* video_api_ctrl_t)(const struct device *dev, uint32_t cid)
Set/Get a video control value.
Definition video.h:367
video_frmival_type
video_frmival_type enum
Definition video.h:178
static uint64_t video_frmival_nsec(const struct video_frmival *frmival)
Compute the difference between two frame intervals.
Definition video.h:936
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:546
static int video_stream_start(const struct device *dev, enum video_buf_type type)
Start the video device function.
Definition video.h:663
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:715
static int video_get_selection(const struct device *dev, struct video_selection *sel)
Get video selection (crop/compose).
Definition video.h:873
int(* video_api_format_t)(const struct device *dev, struct video_format *fmt)
Function pointer type for video_set/get_format()
Definition video.h:301
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:343
static int video_flush(const struct device *dev, bool cancel)
Flush endpoint buffers.
Definition video.h:634
static int video_stream_stop(const struct device *dev, enum video_buf_type type)
Stop the video device function.
Definition video.h:689
int(* video_api_selection_t)(const struct device *dev, struct video_selection *sel)
Get/Set video selection (crop / compose)
Definition video.h:391
static int video_set_format(const struct device *dev, struct video_format *fmt)
Set video format.
Definition video.h:426
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:807
static int video_set_frmival(const struct device *dev, struct video_frmival *frmival)
Set video frame interval.
Definition video.h:482
static int video_enqueue(const struct device *dev, struct video_buffer *buf)
Enqueue a video buffer.
Definition video.h:575
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:357
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.
video_buf_type
video_buf_type enum
Definition video.h:52
static int video_get_format(const struct device *dev, struct video_format *fmt)
Get video format.
Definition video.h:451
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:383
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.
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:325
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:514
int(* video_api_frmival_t)(const struct device *dev, struct video_frmival *frmival)
Function pointer type for video_set/get_frmival()
Definition video.h:309
@ VIDEO_BUF_ABORTED
Definition video.h:240
@ VIDEO_BUF_DONE
Definition video.h:239
@ VIDEO_BUF_ERROR
Definition video.h:241
@ VIDEO_FRMIVAL_TYPE_DISCRETE
discrete frame interval type
Definition video.h:180
@ VIDEO_FRMIVAL_TYPE_STEPWISE
stepwise frame interval type
Definition video.h:182
@ VIDEO_BUF_TYPE_INPUT
input buffer type
Definition video.h:54
@ VIDEO_BUF_TYPE_OUTPUT
output buffer type
Definition video.h:56
@ VIDEO_SEL_TGT_COMPOSE_BOUND
Compose bound (aka the maximum compose achievable)
Definition video.h:260
@ VIDEO_SEL_TGT_COMPOSE
Current compose setting.
Definition video.h:258
@ VIDEO_SEL_TGT_NATIVE_SIZE
Native size of the input frame.
Definition video.h:256
@ VIDEO_SEL_TGT_CROP
Current crop setting.
Definition video.h:252
@ VIDEO_SEL_TGT_CROP_BOUND
Crop bound (aka the maximum crop achievable)
Definition video.h:254
#define VIDEO_PIX_FMT_SGRBG10
Definition video.h:1214
#define VIDEO_PIX_FMT_XYUV32
The first byte is empty (X) for each pixel.
Definition video.h:1552
#define VIDEO_PIX_FMT_SGRBG12P
Definition video.h:1145
#define VIDEO_PIX_FMT_RGB24
24 bit RGB format with 8 bit per component
Definition video.h:1461
#define VIDEO_PIX_FMT_Y10
Little endian, with the 6 most significant bits set to Zero.
Definition video.h:1381
#define VIDEO_PIX_FMT_SBGGR10
Definition video.h:1198
#define VIDEO_PIX_FMT_Y12
Little endian, with the 4 most significant bits set to Zero.
Definition video.h:1391
#define VIDEO_PIX_FMT_SGRBG8
Definition video.h:1073
#define VIDEO_PIX_FMT_SRGGB10
Definition video.h:1222
#define VIDEO_PIX_FMT_Y12P
Definition video.h:1362
#define VIDEO_PIX_FMT_YVYU
Definition video.h:1529
#define VIDEO_PIX_FMT_SRGGB12P
Definition video.h:1154
#define VIDEO_PIX_FMT_SBGGR10P
Definition video.h:1091
#define VIDEO_PIX_FMT_SBGGR14
Definition video.h:1262
#define VIDEO_PIX_FMT_SGRBG16
Definition video.h:1310
#define VIDEO_PIX_FMT_SRGGB16
Definition video.h:1318
#define VIDEO_PIX_FMT_Y10P
Definition video.h:1353
#define VIDEO_PIX_FMT_BGRA32
Definition video.h:1493
#define VIDEO_PIX_FMT_ARGB32
Definition video.h:1469
#define VIDEO_PIX_FMT_SRGGB10P
Definition video.h:1118
#define VIDEO_PIX_FMT_VYUY
Definition video.h:1536
#define VIDEO_PIX_FMT_SRGGB14P
Definition video.h:1190
#define VIDEO_PIX_FMT_SGBRG14
Definition video.h:1270
#define VIDEO_PIX_FMT_SRGGB12
Definition video.h:1254
#define VIDEO_PIX_FMT_Y14
Little endian, with the 2 most significant bits set to Zero.
Definition video.h:1401
#define VIDEO_PIX_FMT_SGBRG16
Definition video.h:1302
#define VIDEO_PIX_FMT_SGBRG14P
Definition video.h:1172
#define VIDEO_PIX_FMT_XRGB32
The first byte is empty (X) for each pixel.
Definition video.h:1502
#define VIDEO_PIX_FMT_SGBRG10
Definition video.h:1206
#define VIDEO_PIX_FMT_RGBA32
Definition video.h:1485
#define VIDEO_PIX_FMT_SGRBG10P
Definition video.h:1109
#define VIDEO_PIX_FMT_SBGGR12
Definition video.h:1230
#define VIDEO_PIX_FMT_GREY
Same as Y8 (8-bit luma-only) following the standard FOURCC naming, or L8 in some graphics libraries.
Definition video.h:1345
#define VIDEO_PIX_FMT_SGBRG12
Definition video.h:1238
#define VIDEO_PIX_FMT_Y16
Little endian.
Definition video.h:1411
#define VIDEO_PIX_FMT_SRGGB14
Definition video.h:1286
#define VIDEO_PIX_FMT_SGBRG8
Definition video.h:1064
#define VIDEO_PIX_FMT_SBGGR12P
Definition video.h:1127
#define VIDEO_PIX_FMT_SBGGR8
Definition video.h:1055
static unsigned int video_bits_per_pixel(uint32_t pixfmt)
Get number of bits per pixel of a pixel format.
Definition video.h:1580
#define VIDEO_PIX_FMT_SRGGB8
Definition video.h:1082
#define VIDEO_PIX_FMT_SBGGR14P
Definition video.h:1163
#define VIDEO_PIX_FMT_YUYV
There is either a missing channel per pixel, U or V.
Definition video.h:1522
#define VIDEO_PIX_FMT_SGBRG10P
Definition video.h:1100
#define VIDEO_PIX_FMT_Y14P
Definition video.h:1371
#define VIDEO_PIX_FMT_UYVY
Definition video.h:1543
#define VIDEO_PIX_FMT_SGRBG14P
Definition video.h:1181
#define VIDEO_PIX_FMT_SBGGR16
Definition video.h:1294
#define VIDEO_PIX_FMT_SGBRG12P
Definition video.h:1136
#define VIDEO_PIX_FMT_RGB565
5 red bits [15:11], 6 green bits [10:5], 5 blue bits [4:0].
Definition video.h:1443
#define VIDEO_PIX_FMT_SGRBG12
Definition video.h:1246
#define VIDEO_PIX_FMT_BGR24
24 bit RGB format with 8 bit per component
Definition video.h:1452
#define VIDEO_PIX_FMT_SGRBG14
Definition video.h:1278
#define VIDEO_PIX_FMT_ABGR32
Definition video.h:1477
#define NULL
Definition iar_missing_defs.h:20
Public kernel APIs.
__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
Definition kernel.h:6122
Kernel timeout type.
Definition clock.h:65
Video buffer structure.
Definition video.h:146
uint32_t bytesused
number of bytes occupied by the valid data in the buffer.
Definition video.h:159
uint32_t size
size of the buffer in bytes.
Definition video.h:157
enum video_buf_type type
type of the buffer
Definition video.h:151
uint8_t * buffer
pointer to the start of the buffer.
Definition video.h:153
void * driver_data
Pointer to driver specific data.
Definition video.h:149
uint16_t line_offset
Line offset within frame this buffer represents, from the beginning of the frame.
Definition video.h:170
uint8_t index
index of the buffer, optionally set by the application
Definition video.h:155
uint32_t timestamp
time reference in milliseconds at which the last data byte was actually received for input endpoints ...
Definition video.h:164
Video format capabilities.
Definition video.h:113
uint8_t min_vbuf_count
minimal count of video buffers to enqueue before being able to start the stream.
Definition video.h:121
enum video_buf_type type
type of the buffer
Definition video.h:115
int16_t min_line_count
Denotes minimum line count of a video buffer that this endpoint can fill or process.
Definition video.h:130
int16_t max_line_count
Denotes maximum line count of a video buffer that this endpoint can fill or process.
Definition video.h:137
const struct video_format_cap * format_caps
list of video format capabilities (zero terminated).
Definition video.h:117
Video control structure.
Definition video-controls.h:410
Definition video-controls.h:457
const struct device * dev
device being queried, application needs to set this field
Definition video-controls.h:459
Definition video.h:393
video_api_format_t set_format
Definition video.h:395
video_api_ctrl_t set_ctrl
Definition video.h:403
video_api_enqueue_t enqueue
Definition video.h:400
video_api_set_signal_t set_signal
Definition video.h:405
video_api_enum_frmival_t enum_frmival
Definition video.h:408
video_api_get_caps_t get_caps
Definition video.h:398
video_api_selection_t get_selection
Definition video.h:410
video_api_selection_t set_selection
Definition video.h:409
video_api_format_t get_format
Definition video.h:396
video_api_flush_t flush
Definition video.h:402
video_api_dequeue_t dequeue
Definition video.h:401
video_api_frmival_t get_frmival
Definition video.h:407
video_api_frmival_t set_frmival
Definition video.h:406
video_api_set_stream_t set_stream
Definition video.h:397
video_api_ctrl_t get_volatile_ctrl
Definition video.h:404
Video format capability.
Definition video.h:90
uint16_t height_step
height step size in pixels.
Definition video.h:104
uint32_t width_min
minimum supported frame width in pixels.
Definition video.h:94
uint32_t width_max
maximum supported frame width in pixels.
Definition video.h:96
uint16_t width_step
width step size in pixels.
Definition video.h:102
uint32_t height_max
maximum supported frame height in pixels.
Definition video.h:100
uint32_t height_min
minimum supported frame height in pixels.
Definition video.h:98
uint32_t pixelformat
FourCC pixel format value (Video pixel formats).
Definition video.h:92
Video format structure.
Definition video.h:65
uint32_t height
frame height in pixels.
Definition video.h:73
enum video_buf_type type
type of the buffer
Definition video.h:67
uint32_t width
frame width in pixels.
Definition video.h:71
uint32_t pitch
line stride.
Definition video.h:81
uint32_t pixelformat
FourCC pixel format value (Video pixel formats)
Definition video.h:69
Video frame interval enumeration structure.
Definition video.h:219
uint32_t index
frame interval index during enumeration
Definition video.h:221
const struct video_format * format
video format for which the query is made
Definition video.h:223
enum video_frmival_type type
frame interval type the device supports
Definition video.h:225
Video frame interval stepwise structure.
Definition video.h:204
struct video_frmival min
minimum frame interval in seconds
Definition video.h:206
struct video_frmival max
maximum frame interval in seconds
Definition video.h:208
struct video_frmival step
frame interval step size in seconds
Definition video.h:210
Video frame interval structure.
Definition video.h:191
uint32_t numerator
numerator of the frame interval
Definition video.h:193
uint32_t denominator
denominator of the frame interval
Definition video.h:195
Description of a rectangle area.
Definition video.h:269
uint32_t width
width of selection rectangle
Definition video.h:275
uint32_t height
height of selection rectangle
Definition video.h:277
uint32_t top
top offset of selection rectangle
Definition video.h:273
uint32_t left
left offset of selection rectangle
Definition video.h:271
Video selection target enum.
Video selection (crop / compose) structure.
Definition video.h:286
struct video_rect rect
selection target rectangle
Definition video.h:292
enum video_buf_type type
buffer type, allow to select for device having both input and output
Definition video.h:288
enum video_selection_target target
selection target enum
Definition video.h:290