drivers: Add video API

This generic video API can be used to capture/output video frames.

Once a video buffer is enqueued to a video device endpoint, device owns
the buffer and can process to capture (camera), output (disk, display),
convert (hw encoder)... User can then call dequeue to retrieve
the processed buffer (video driver ensure cache coherency).

Once dequeued, video buffer is owned by user (e.g. for frame
processing, display buffer update, write to media, etc...).

For each video-buffer, user needs allocate the associated frame buffer
via video_buffer_alloc. Buffer format is defined by video device
endpoint configuration. Video device can be controlled (e.g. contrast,
brightness, flip...) via controls.

Signed-off-by: Loic Poulain <loic.poulain@linaro.org>
This commit is contained in:
Loic Poulain 2019-07-01 14:24:25 +02:00 committed by Maureen Helm
parent f974cb0ae1
commit 32169886ca
4 changed files with 686 additions and 0 deletions

View file

@ -24,3 +24,4 @@ Peripherals
spi.rst
uart.rst
watchdog.rst
video.rst

View file

@ -0,0 +1,60 @@
.. _video:
Video
#####
The video driver API offers a generic interface to video devices.
Basic Operation
***************
Video Device
============
A video device is the abstraction of a hardware or software video function,
which can produce, process, consume or transform video data. The video API is
designed to offer flexible way to create, handle and combine various video
devices.
Endpoint
========
Each video device can have one or more endpoints. Output endpoints configure
video output function and generate data. Input endpoints configure video input
function and consume data.
Video Buffer
============
A video buffer provides the transport mechanism for the data. There is no
particular requirement on the content. The requirement for the content is
defined by the endpoint format. A video buffer can be queued to a device
endpoint for filling (input ep) or consuming (output ep) operation, once
the operation is achieved, buffer can be dequeued for post-processing,
release or reuse.
Controls
========
A video control is accessed and identified by a CID (control identifier). It
represents a video control property. Different devices will have different
controls available which can be generic, related to a device class or vendor
specific. The set/get control functions provide a generic scalable interface
to handle and create controls.
Configuration Options
*********************
Related configuration options:
* :option:`CONFIG_VIDEO`
API Reference
*************
.. doxygengroup:: video_interface
:project: Zephyr
.. doxygengroup:: video_controls
:project: Zephyr

View file

@ -0,0 +1,59 @@
/**
* @file
*
* @brief Public APIs for Video.
*/
/*
* Copyright (c) 2019 Linaro Limited.
*
* SPDX-License-Identifier: Apache-2.0
*/
#ifndef ZEPHYR_INCLUDE_VIDEO_CONTROLS_H_
#define ZEPHYR_INCLUDE_VIDEO_CONTROLS_H_
/**
* @brief Video controls
* @defgroup video_controls Video Controls
* @ingroup io_interfaces
* @{
*/
#include <device.h>
#include <stddef.h>
#include <zephyr.h>
#include <zephyr/types.h>
#ifdef __cplusplus
extern "C" {
#endif
/* Control classes */
#define VIDEO_CTRL_CLASS_GENERIC 0x00000000 /* Generic class controls */
#define VIDEO_CTRL_CLASS_CAMERA 0x00010000 /* Camera class controls */
#define VIDEO_CTRL_CLASS_MPEG 0x00020000 /* MPEG-compression controls */
#define VIDEO_CTRL_CLASS_JPEG 0x00030000 /* JPEG-compression controls */
#define VIDEO_CTRL_CLASS_VENDOR 0xFFFF0000 /* Vendor-specific class controls */
/* Generic class control IDs */
#define VIDEO_CID_HFLIP (VIDEO_CTRL_CLASS_GENERIC + 0) /* Mirror the picture horizontally */
#define VIDEO_CID_VFLIP (VIDEO_CTRL_CLASS_GENERIC + 1) /* Mirror the picture vertically */
/* Camera class control IDs */
#define VIDEO_CID_CAMERA_EXPOSURE (VIDEO_CTRL_CLASS_CAMERA + 0)
#define VIDEO_CID_CAMERA_GAIN (VIDEO_CTRL_CLASS_CAMERA + 1)
#define VIDEO_CID_CAMERA_ZOOM (VIDEO_CTRL_CLASS_CAMERA + 2)
#ifdef __cplusplus
}
#endif
/* Controls */
/**
* @}
*/
#endif /* ZEPHYR_INCLUDE_VIDEO_H_ */

566
include/drivers/video.h Normal file
View file

@ -0,0 +1,566 @@
/**
* @file
*
* @brief Public APIs for Video.
*/
/*
* Copyright (c) 2019 Linaro Limited.
*
* SPDX-License-Identifier: Apache-2.0
*/
#ifndef ZEPHYR_INCLUDE_VIDEO_H_
#define ZEPHYR_INCLUDE_VIDEO_H_
/**
* @brief Video Interface
* @defgroup video_interface Video Interface
* @ingroup io_interfaces
* @{
*/
#include <device.h>
#include <stddef.h>
#include <zephyr.h>
#include <zephyr/types.h>
#include <drivers/video-controls.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief video format structure
*
* Used to configure frame format.
*
* @param pixelformat is the fourcc pixel format value.
* @param width is the frame width in pixels.
* @param height is the frame height in pixels.
* @param pitch is the line stride, the number of bytes that needs to be added
* to the address in the first pixel of a row in order to go to the address
* of the first pixel of the next row (>=width).
*/
struct video_format {
u32_t pixelformat;
u32_t width;
u32_t height;
u32_t pitch;
};
/**
* @brief video format capability
*
* Used to describe a video endpoint format capability.
*
* @param pixelformat is a list of suported pixel formats (0 terminated).
* @param width_min is the minimum supported frame width.
* @param width_max is the maximum supported frame width.
* @param height_min is the minimum supported frame width.
* @param height_max is the maximum supported frame width.
* @param width_step is the width step size.
* @param height_step is the height step size.
*/
struct video_format_cap {
u32_t pixelformat;
u32_t width_min;
u32_t width_max;
u32_t height_min;
u32_t height_max;
u16_t width_step;
u16_t height_step;
};
/**
* @brief video capabilities
*
* Used to describe video endpoint capabilities.
*
* @param format_caps is a list of video format capabilities (zero terminated).
* @param min_vbuf_count is the minimal count of video buffers to enqueue
* before being able to start the stream.
*/
struct video_caps {
const struct video_format_cap *format_caps;
u8_t min_vbuf_count;
};
/**
* @brief video buffer structure
*
* Represent a video frame.
*
* @param driver_data is a pointer to driver specific data.
* @param buffer is a pointer to the start of the buffer.
* @param size is the size in bytes of the buffer.
* @param bytesused is the number of bytes occupied by the valid data in
* the buffer.
* @param timestamp is a time reference in milliseconds at which the last data
* byte was actually received for input endpoints or to be consumed for
* output endpoints.
*/
struct video_buffer {
void *driver_data;
u8_t *buffer;
u32_t size;
u32_t bytesused;
u32_t timestamp;
};
/**
* @brief video_endpoint_id enum
* Identify the video device endpoint.
*/
enum video_endpoint_id {
VIDEO_EP_NONE,
VIDEO_EP_ANY,
VIDEO_EP_IN,
VIDEO_EP_OUT,
};
/**
* @brief video_event enum
* Identify video event.
*/
enum video_signal_result {
VIDEO_BUF_DONE,
VIDEO_BUF_ABORTED,
VIDEO_BUF_ERROR,
};
/**
* @typedef video_api_set_format_t
* @brief Set video format
* See video_set_format() for argument descriptions.
*/
typedef int (*video_api_set_format_t)(struct device *dev,
enum video_endpoint_id ep,
struct video_format *fmt);
/**
* @typedef video_api_get_format_t
* @brief get current video format
* See video_get_format() for argument descriptions.
*/
typedef int (*video_api_get_format_t)(struct device *dev,
enum video_endpoint_id ep,
struct video_format *fmt);
/**
* @typedef video_api_enqueue_t
* @brief Enqueue a buffer in the drivers incoming queue.
* See video_enqueue() for argument descriptions.
*/
typedef int (*video_api_enqueue_t)(struct device *dev,
enum video_endpoint_id ep,
struct video_buffer *buf);
/**
* @typedef video_api_dequeue_t
* @brief Dequeue a buffer from the drivers outgoing queue.
* See video_dequeue() for argument descriptions.
*/
typedef int (*video_api_dequeue_t)(struct device *dev,
enum video_endpoint_id ep,
struct video_buffer **buf, u32_t timeout);
/**
* @typedef video_api_flush_t
* @brief Flush endpoint buffers, buffer are moved from incoming queue to
* outgoing queue.
* See video_flush() for argument descriptions.
*/
typedef int (*video_api_flush_t)(struct device *dev,
enum video_endpoint_id ep,
bool cancel);
/**
* @typedef video_api_stream_start_t
* @brief Start the capture or output process.
* See video_stream_start() for argument descriptions.
*/
typedef int (*video_api_stream_start_t)(struct device *dev);
/**
* @typedef video_api_stream_stop_t
* @brief Stop the capture or output process.
* See video_stream_stop() for argument descriptions.
*/
typedef int (*video_api_stream_stop_t)(struct device *dev);
/**
* @typedef video_api_set_ctrl_t
* @brief set a video control value.
* See video_set_ctrl() for argument descriptions.
*/
typedef int (*video_api_set_ctrl_t)(struct device *dev, unsigned int cid,
void *value);
/**
* @typedef video_api_get_ctrl_t
* @brief get a video control value.
* See video_get_ctrl() for argument descriptions.
*/
typedef int (*video_api_get_ctrl_t)(struct device *dev, unsigned int cid,
void *value);
/**
* @typedef video_api_get_caps_t
* @brief Get capabilities of a video endpoint.
* See video_get_caps() for argument descriptions.
*/
typedef int (*video_api_get_caps_t)(struct device *dev,
enum video_endpoint_id ep,
struct video_caps *caps);
/**
* @typedef video_api_set_signal_t
* @brief Register/Unregister poll signal for buffer events.
* See video_set_signal() for argument descriptions.
*/
typedef int (*video_api_set_signal_t)(struct device *dev,
enum video_endpoint_id ep,
struct k_poll_signal *signal);
struct video_driver_api {
/* mandatory callbacks */
video_api_set_format_t set_format;
video_api_get_format_t get_format;
video_api_stream_start_t stream_start;
video_api_stream_stop_t stream_stop;
video_api_get_caps_t get_caps;
/* optional callbacks */
video_api_enqueue_t enqueue;
video_api_dequeue_t dequeue;
video_api_flush_t flush;
video_api_set_ctrl_t set_ctrl;
video_api_set_ctrl_t get_ctrl;
video_api_set_signal_t set_signal;
};
/**
* @brief Set video format.
*
* Configure video device with a specific format.
*
* @param dev Pointer to the device structure for the driver instance.
* @param ep Endpoint ID.
* @param fmt Pointer to a video format struct.
*
* @retval 0 Is successful.
* @retval -EINVAL If parameters are invalid.
* @retval -ENOTSUP If format is not supported.
* @retval -EIO General input / output error.
*/
static inline int video_set_format(struct device *dev,
enum video_endpoint_id ep,
struct video_format *fmt)
{
const struct video_driver_api *api =
(const struct video_driver_api *)dev->driver_api;
__ASSERT(api->set_format, "set_format must be implemented by driver");
return api->set_format(dev, ep, fmt);
}
/**
* @brief Get video format.
*
* Get video device current video format.
*
* @param dev Pointer to the device structure for the driver instance.
* @param ep Endpoint ID.
* @param fmt Pointer to video format struct.
*
* @retval pointer to video format
*/
static inline int video_get_format(struct device *dev,
enum video_endpoint_id ep,
struct video_format *fmt)
{
const struct video_driver_api *api =
(const struct video_driver_api *)dev->driver_api;
__ASSERT(api->get_format, "get_format must be implemented by driver");
return api->get_format(dev, ep, fmt);
}
/**
* @brief Enqueue a video buffer.
*
* Enqueue an empty (capturing) or filled (output) video buffer in the drivers
* endpoint incoming queue.
*
* @param dev Pointer to the device structure for the driver instance.
* @param ep Endpoint ID.
* @param buf Pointer to the video buffer.
*
* @retval 0 Is successful.
* @retval -EINVAL If parameters are invalid.
* @retval -EIO General input / output error.
*/
static inline int video_enqueue(struct device *dev, enum video_endpoint_id ep,
struct video_buffer *buf)
{
const struct video_driver_api *api =
(const struct video_driver_api *)dev->driver_api;
if (api->enqueue == NULL) {
return -ENOTSUP;
}
return api->enqueue(dev, ep, buf);
}
/**
* @brief Dequeue a video buffer.
*
* Dequeue a filled (capturing) or displayed (output) buffer from the drivers
* enpoint outgoing queue.
*
* @param dev Pointer to the device structure for the driver instance.
* @param ep Endpoint ID.
* @param buf Pointer a video buffer pointer.
* @param timeout Timeout in milliseconds.
*
* @retval 0 Is successful.
* @retval -EINVAL If parameters are invalid.
* @retval -EIO General input / output error.
*/
static inline int video_dequeue(struct device *dev, enum video_endpoint_id ep,
struct video_buffer **buf,
u32_t timeout)
{
const struct video_driver_api *api =
(const struct video_driver_api *)dev->driver_api;
if (api->dequeue == NULL) {
return -ENOTSUP;
}
return api->dequeue(dev, ep, buf, timeout);
}
/**
* @brief Flush endpoint buffers.
*
* A call to flush finishes when all endpoint buffers have been moved from
* incoming queue to outgoing queue. Either because canceled or fully processed
* through the video function.
*
* @param dev Pointer to the device structure for the driver instance.
* @param ep Endpoint ID.
* @param cancel If true, cancel buffer processing instead of waiting for
* completion.
*
* @retval 0 Is successful, -ERRNO code otherwise.
*/
static inline int video_flush(struct device *dev, enum video_endpoint_id ep,
bool cancel)
{
const struct video_driver_api *api =
(const struct video_driver_api *)dev->driver_api;
if (api->flush == NULL) {
return -ENOTSUP;
}
return api->flush(dev, ep, cancel);
}
/**
* @brief Start the video device function.
*
* video_stream_start is called to enter streaming state (capture, output...).
* The driver may receive buffers with video_enqueue() before video_stream_start
* is called. If driver/device needs a minimum number of buffers before being
* able to start streaming, then driver set the min_vbuf_count to the related
* endpoint capabilities.
*
* @retval 0 Is successful.
* @retval -EIO General input / output error.
*/
static inline int video_stream_start(struct device *dev)
{
const struct video_driver_api *api =
(const struct video_driver_api *)dev->driver_api;
__ASSERT(api->stream_start,
"stream_start must be implemented by driver");
return api->stream_start(dev);
}
/**
* @brief Stop the video device function.
*
* On video_stream_stop, driver must stop any transactions or wait until they
* finish.
*
* @retval 0 Is successful.
* @retval -EIO General input / output error.
*/
static inline int video_stream_stop(struct device *dev)
{
const struct video_driver_api *api =
(const struct video_driver_api *)dev->driver_api;
int ret;
__ASSERT(api->stream_stop,
"stream_stop must be implemented by driver");
ret = api->stream_stop(dev);
video_flush(dev, VIDEO_EP_ANY, true);
return ret;
}
/**
* @brief Get the capabilities of a video endpoint.
*
* @param dev Pointer to the device structure for the driver instance.
* @param ep Endpoint ID.
* @param caps Pointer to the video_caps struct to fill.
*
* @retval 0 Is successful, -ERRNO code otherwise.
*/
static inline int video_get_caps(struct device *dev,
enum video_endpoint_id ep,
struct video_caps *caps)
{
const struct video_driver_api *api =
(const struct video_driver_api *)dev->driver_api;
__ASSERT(api->get_caps, "get_caps must be implemented by driver");
return api->get_caps(dev, ep, caps);
}
/**
* @brief Set the value of a control.
*
* This set the value of a video control, value type depends on control ID, and
* must be interpreted accordingly.
*
* @param dev Pointer to the device structure for the driver instance.
* @param cid Control ID.
* @param value Pointer to the control value.
*
* @retval 0 Is successful.
* @retval -EINVAL If parameters are invalid.
* @retval -ENOTSUP If format is not supported.
* @retval -EIO General input / output error.
*/
static inline int video_set_ctrl(struct device *dev, unsigned int cid,
void *value)
{
const struct video_driver_api *api =
(const struct video_driver_api *)dev->driver_api;
if (api->set_ctrl == NULL) {
return -ENOTSUP;
}
return api->set_ctrl(dev, cid, value);
}
/**
* @brief Get the current value of a control.
*
* This retrieve the value of a video control, value type depends on control ID,
* and must be interpreted accordingly.
*
* @param dev Pointer to the device structure for the driver instance.
* @param cid Control ID.
* @param value Pointer to the control value.
*
* @retval 0 Is successful.
* @retval -EINVAL If parameters are invalid.
* @retval -ENOTSUP If format is not supported.
* @retval -EIO General input / output error.
*/
static inline int video_get_ctrl(struct device *dev, unsigned int cid,
void *value)
{
const struct video_driver_api *api =
(const struct video_driver_api *)dev->driver_api;
if (api->get_ctrl == NULL) {
return -ENOTSUP;
}
return api->get_ctrl(dev, cid, value);
}
/**
* @brief Register/Unregister k_poll signal for a video endpoint.
*
* Register a poll signal to the endpoint, which will be signaled on frame
* completion (done, aborted, error). Registering a NULL poll signal
* unregisters any previously registered signal.
*
* @param dev Pointer to the device structure for the driver instance.
* @param ep Endpoint ID.
* @param signal Pointer to k_poll_signal
*
* @retval 0 Is successful, -ERRNO code otherwise.
*/
static inline int video_set_signal(struct device *dev,
enum video_endpoint_id ep,
struct k_poll_signal *signal)
{
const struct video_driver_api *api =
(const struct video_driver_api *)dev->driver_api;
if (api->set_signal == NULL) {
return -ENOTSUP;
}
return api->set_signal(dev, ep, signal);
}
/**
* @brief Allocate video buffer.
*
* @param size Size of the video buffer.
*
* @retval pointer to allocated video buffer
*/
struct video_buffer *video_buffer_alloc(size_t size);
/**
* @brief Release a video buffer.
*
* @param buf Pointer to the video buffer to release.
*/
void video_buffer_release(struct video_buffer *buf);
/* fourcc - four-character-code */
#define video_fourcc(a, b, c, d)\
((u32_t)(a) | ((u32_t)(b) << 8) | ((u32_t)(c) << 16) | ((u32_t)(d) << 24))
/* Raw bayer formats */
#define VIDEO_PIX_FMT_BGGR8 video_fourcc('B', 'G', 'G', 'R') /* 8 BGBG.. GRGR.. */
#define VIDEO_PIX_FMT_GBRG8 video_fourcc('G', 'B', 'R', 'G') /* 8 GBGB.. RGRG.. */
#define VIDEO_PIX_FMT_GRBG8 video_fourcc('G', 'R', 'B', 'G') /* 8 GRGR.. BGBG.. */
#define VIDEO_PIX_FMT_RGGB8 video_fourcc('R', 'G', 'G', 'B') /* 8 RGRG.. GBGB.. */
/* RGB formats */
#define VIDEO_PIX_FMT_RGB565 video_fourcc('R', 'G', 'B', 'P') /* 16 RGB-5-6-5 */
#ifdef __cplusplus
}
#endif
/**
* @}
*/
#endif /* ZEPHYR_INCLUDE_VIDEO_H_ */