/*
 * SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD
 *
 * SPDX-License-Identifier: Apache-2.0
 */

#pragma once

#include <stdint.h>
#include <sys/time.h>
#include "esp_err.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief UVC format
 */
typedef enum {
    UVC_FORMAT_JPEG,            /*!< JPEG format */
    UVC_FORMAT_H264,            /*!< H264 format */
} uvc_format_t;

/**
 * @brief Frame buffer structure
 */
typedef struct {
    uint8_t *buf;               /*!< Pointer to the frame data */
    size_t len;                 /*!< Length of the buffer in bytes */
    size_t width;               /*!< Width of the image frame in pixels */
    size_t height;              /*!< Height of the image frame in pixels */
    uvc_format_t format;        /*!< Format of the frame data */
    struct timeval timestamp;   /*!< Timestamp since boot of the frame */
} uvc_fb_t;

/**
 * @brief type of callback function when host open the UVC device
 */
typedef esp_err_t (*uvc_input_start_cb_t)(uvc_format_t format, int width, int height, int rate, void *cb_ctx);

/**
 * @brief type of callback function when host request a new frame buffer
 */
typedef uvc_fb_t* (*uvc_input_fb_get_cb_t)(void *cb_ctx);

/**
 * @brief type of callback function when the frame buffer is no longer used
 */
typedef void (*uvc_input_fb_return_cb_t)(uvc_fb_t *fb, void *cb_ctx);

/**
 * @brief type of callback function when host close the UVC device
 */
typedef void (*uvc_input_stop_cb_t)(void *cb_ctx);

/**
 * @brief Configuration for the UVC device
 */
typedef struct {
    uint8_t *uvc_buffer;                   /*!< UVC transfer buffer */
    uint32_t uvc_buffer_size;              /*!< UVC transfer buffer size, should bigger than one frame size */
    uvc_input_start_cb_t start_cb;         /*!< callback function of host open the UVC device with the specific format and resolution */
    uvc_input_fb_get_cb_t fb_get_cb;       /*!< callback function of host request a new frame buffer */
    uvc_input_fb_return_cb_t fb_return_cb; /*!< callback function of the frame buffer is no longer used */
    uvc_input_stop_cb_t stop_cb;           /*!< callback function of host close the UVC device */
    void *cb_ctx;                          /*!< callback context, for user specific usage */
} uvc_device_config_t;

/**
 * @brief Configure the UVC device by uvc device number
 *
 * @param index UVC device index number [0,1]
 * @param config  Configuration for the UVC device
 * @return ESP_OK on success
 *         ESP_ERR_INVALID_ARG if the configuration is invalid
 *         ESP_FAIL if the UVC device could not be initialized
 */
esp_err_t uvc_device_config(int index, uvc_device_config_t *config);

/**
 * @brief Initialize the UVC device, after this function is called, the UVC device will be visible to the host
 *       and the host can open the UVC device with the specific format and resolution.
 *
 * @return ESP_OK on success
 *         ESP_FAIL if the UVC device could not be initialized
 */
esp_err_t uvc_device_init(void);

/**
 * @brief Deinitialize the UVC device
 * @note  This function is not implemented yet because tinyusb does not support deinitialization
 * @return ESP_OK on success
 *         ESP_FAIL if the UVC device could not be deinitialized
 */
//esp_err_t uvc_device_deinit(void);

#ifdef __cplusplus
}
#endif