video.h File Reference

Public APIs for video. More...

#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>

Go to the source code of this file.

Functions
int	video_enqueue (const struct device *dev, struct video_buffer *buf)
	Pass a video buffer to a video device.
int	video_dequeue (const struct device *dev, struct video_buffer **vbuf, k_timeout_t timeout)
	Get a video buffer from a video device.
struct video_buffer *	video_buffer_aligned_alloc (size_t size, size_t align, k_timeout_t timeout)
	Allocate aligned video buffer.
struct video_buffer *	video_buffer_alloc (size_t size, k_timeout_t timeout)
	Allocate video buffer.
struct video_buffer *	video_import_buffer (uint8_t *mem, size_t sz)
	Import an external memory to the video buffer pool.
int	video_buffer_release (struct video_buffer *buf)
	Release a video buffer.
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)
	Transfer a buffer between 2 video device.
int	video_set_signal (const struct device *dev, struct k_poll_signal *sig)
	Register/Unregister k_poll signal for a video endpoint.
int	video_set_ctrl (const struct device *dev, struct video_control *control)
	Set the value of a control.
int	video_get_ctrl (const struct device *dev, struct video_control *control)
	Get the current value of a control.
int	video_query_ctrl (struct video_ctrl_query *cq)
	Query information about a control.
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_stream_start (const struct device *dev, enum video_buf_type type)
	Start the video device function.
int	video_stream_stop (const struct device *dev, enum video_buf_type type)
	Stop the video device function.
int	video_enum_frmival (const struct device *dev, struct video_frmival_enum *fie)
	List video frame intervals.
int	video_set_frmival (const struct device *dev, struct video_frmival *frmival)
	Set video frame interval.
int	video_get_frmival (const struct device *dev, struct video_frmival *frmival)
	Get video frame interval of a driver.
static uint64_t	video_frmival_nsec (const struct video_frmival *frmival)
	Compute the difference between two frame intervals.
int	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.
int	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.
int	video_estimate_fmt_size (struct video_format *fmt)
	Estimate the size and pitch in bytes of a video_format.
int	video_set_compose_format (const struct device *dev, struct video_format *fmt)
	Set compose rectangle (if applicable) prior to setting format.
int	video_set_format (const struct device *dev, struct video_format *fmt)
	Set video format.
int	video_get_format (const struct device *dev, struct video_format *fmt)
	Get video format of a driver.
int	video_set_selection (const struct device *dev, struct video_selection *sel)
	Set video selection (crop/compose).
int	video_get_selection (const struct device *dev, struct video_selection *sel)
	Get video selection (crop/compose).
int	video_get_caps (const struct device *dev, struct video_caps *caps)
	Get the capabilities of a video endpoint.
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)
	Transform a video format capability from one end to the other end of a m2m video device.
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.

Detailed Description

Public APIs for video.