video.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 Linaro Limited.
 * Copyright 2025 NXP
 * Copyright (c) 2025 STMicroelectronics
 * SPDX-FileCopyrightText: Copyright The Zephyr Project Contributors
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_VIDEO_VIDEO_H
#define ZEPHYR_INCLUDE_VIDEO_VIDEO_H

 
#include <stddef.h>
#include <stdint.h>
 
#include <zephyr/device.h>
#include <zephyr/kernel.h>
#include <zephyr/types.h>
#include <zephyr/video/controls.h>
#include <zephyr/video/formats.h>
#include <zephyr/video/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif


int video_enqueue(const struct device *dev, struct video_buffer *buf);

int video_dequeue(const struct device *dev, struct video_buffer **vbuf, k_timeout_t timeout);

struct video_buffer *video_buffer_aligned_alloc(size_t size, size_t align, k_timeout_t timeout);

struct video_buffer *video_buffer_alloc(size_t size, k_timeout_t timeout);

struct video_buffer *video_import_buffer(uint8_t *mem, size_t sz);

int video_buffer_release(struct video_buffer *buf);

int video_transfer_buffer(const struct device *src, const struct device *sink,
                          enum video_buf_type src_type, enum video_buf_type sink_type,
                          k_timeout_t timeout);

int video_set_signal(const struct device *dev, struct k_poll_signal *sig);



int video_set_ctrl(const struct device *dev, struct video_control *control);

int video_get_ctrl(const struct device *dev, struct video_control *control);

int video_query_ctrl(struct video_ctrl_query *cq);

void video_print_ctrl(const struct video_ctrl_query *const cq);

int64_t video_get_csi_link_freq(const struct device *dev, uint8_t bpp, uint8_t lane_nb);



int video_stream_start(const struct device *dev, enum video_buf_type type);

int video_stream_stop(const struct device *dev, enum video_buf_type type);



int video_enum_frmival(const struct device *dev, struct video_frmival_enum *fie);

int video_set_frmival(const struct device *dev, struct video_frmival *frmival);

int video_get_frmival(const struct device *dev, struct video_frmival *frmival);

static inline uint64_t video_frmival_nsec(const struct video_frmival *frmival)
{
        if (frmival == NULL || frmival->denominator == 0) {
                return -EINVAL;
        }
 
        return (uint64_t)NSEC_PER_SEC * frmival->numerator / frmival->denominator;
}

int video_closest_frmival_stepwise(const struct video_frmival_stepwise *stepwise,
                                   const struct video_frmival *desired,
                                   struct video_frmival *match);

int video_closest_frmival(const struct device *dev, struct video_frmival_enum *match);



int video_estimate_fmt_size(struct video_format *fmt);

int video_set_compose_format(const struct device *dev, struct video_format *fmt);

int video_set_format(const struct device *dev, struct video_format *fmt);

int video_get_format(const struct device *dev, struct video_format *fmt);

int video_set_selection(const struct device *dev, struct video_selection *sel);

int video_get_selection(const struct device *dev, struct video_selection *sel);



int video_get_caps(const struct device *dev, struct video_caps *caps);

int video_transform_cap(const struct device *const dev,
                        const struct video_format_cap *const cap,
                        struct video_format_cap *const res_cap,
                        enum video_buf_type type, uint16_t ind);

int video_format_caps_index(const struct video_format_cap *fmts, const struct video_format *fmt,
                            size_t *idx);

 
#ifdef __cplusplus
}
#endif

 
#endif /* ZEPHYR_INCLUDE_VIDEO_VIDEO_H */