video_frame.h

Go to the documentation of this file.

#ifndef VIDEO_FRAME_H
#define VIDEO_FRAME_H

#ifndef _WIN32
#include <unistd.h>
#endif

#include "base.h"
#include "config.h"

OTC_BEGIN_DECL

#define OTC_VIDEO_FRAME_METADATA_MAX_SIZE 32

typedef struct otc_video_frame otc_video_frame;

enum otc_video_frame_format {
  OTC_VIDEO_FRAME_FORMAT_UNKNOWN =
      0, 
  OTC_VIDEO_FRAME_FORMAT_YUV420P =
      1, 
  OTC_VIDEO_FRAME_FORMAT_NV12 = 2, 
  OTC_VIDEO_FRAME_FORMAT_NV21 = 3, 
  OTC_VIDEO_FRAME_FORMAT_YUY2 = 4, 
  OTC_VIDEO_FRAME_FORMAT_UYVY = 5, 
  OTC_VIDEO_FRAME_FORMAT_ARGB32 =
      6, 
  OTC_VIDEO_FRAME_FORMAT_BGRA32 =
      7, 
  OTC_VIDEO_FRAME_FORMAT_RGB24 = 8, 
  OTC_VIDEO_FRAME_FORMAT_ABGR32 =
      9, 
  OTC_VIDEO_FRAME_FORMAT_MJPEG =
      10, 
  OTC_VIDEO_FRAME_FORMAT_RGBA32 =
      11,                     
  OTC_VIDEO_FRAME_FORMAT_MAX, 
  // Add any new enum value before this one.
  OTC_VIDEO_FRAME_FORMAT_COMPRESSED =
      255 
};

enum otc_video_frame_plane {
  OTC_VIDEO_FRAME_PLANE_Y = 0, 
  OTC_VIDEO_FRAME_PLANE_U = 1, 
  OTC_VIDEO_FRAME_PLANE_V = 2, 
  OTC_VIDEO_FRAME_PLANE_PACKED =
      0, 
  OTC_VIDEO_FRAME_PLANE_UV_INTERLEAVED =
      1, 
  OTC_VIDEO_FRAME_PLANE_VU_INTERLEAVED =
      1, 
};

struct otc_video_frame_planar_memory_callbacks {
  const uint8_t* (*get_plane)(void* user_data,
                              enum otc_video_frame_plane plane);

  int (*get_plane_stride)(void* user_data, enum otc_video_frame_plane plane);

  void (*release)(void* user_data);

  void* user_data;

  void* reserved;
};

typedef void (*otc_video_frame_memory_release_callback)(const uint8_t* buffer,
                                                        void* arg);

typedef void (*video_transform_callback)(void* user_data,
                                         struct otc_video_frame* frame);

OTC_DECL(void*)
otc_video_frame_get_native_handle(const otc_video_frame* frame);

OTC_DECL(otc_video_frame*)
otc_video_frame_new(enum otc_video_frame_format format,
                    int width,
                    int height,
                    const uint8_t* buffer);

OTC_DECL(otc_status) otc_video_frame_delete(otc_video_frame* frame);

OTC_DECL(otc_video_frame*)
otc_video_frame_new_I420(int width,
                         int height,
                         const uint8_t* y_plane,
                         int y_stride,
                         const uint8_t* u_plane,
                         int u_stride,
                         const uint8_t* v_plane,
                         int v_stride);

OTC_DECL(otc_video_frame*)
otc_video_frame_new_MJPEG(int width,
                          int height,
                          const uint8_t* buffer,
                          size_t size);

OTC_DECL(otc_video_frame*)
otc_video_frame_new_compressed(int width,
                               int height,
                               const uint8_t* buffer,
                               size_t size);

OTC_DECL(otc_video_frame*)
otc_video_frame_new_from_planes(enum otc_video_frame_format format,
                                int width,
                                int height,
                                const uint8_t** planes,
                                int* strides);

OTC_DECL(otc_video_frame*)
otc_video_frame_new_I420_from_planes_with_format(
    enum otc_video_frame_format input_format,
    int width,
    int height,
    const uint8_t** planes,
    int* strides);

OTC_DECL(otc_video_frame*)
otc_video_frame_new_contiguous_memory_wrapper(
    enum otc_video_frame_format format,
    int width,
    int height,
    otc_bool is_shallow_copyable,
    const uint8_t* buffer,
    size_t size,
    otc_video_frame_memory_release_callback callback,
    void* arg);

OTC_DECL(otc_video_frame*)
otc_video_frame_new_planar_memory_wrapper(
    enum otc_video_frame_format format,
    int width,
    int height,
    otc_bool is_shallow_copyable,
    struct otc_video_frame_planar_memory_callbacks* callbacks);

OTC_DECL(otc_video_frame*)
otc_video_frame_new_I420_wrapper(int width,
                                 int height,
                                 const uint8_t* y_plane,
                                 int y_stride,
                                 const uint8_t* u_plane,
                                 int u_stride,
                                 const uint8_t* v_plane,
                                 int v_stride);

OTC_DECL(otc_video_frame*)
otc_video_frame_new_NV21_wrapper(int width,
                                 int height,
                                 const uint8_t* y_plane,
                                 int y_stride,
                                 const uint8_t* uv_plane,
                                 int uv_stride);

OTC_DECL(otc_video_frame*)
otc_video_frame_new_NV12_wrapper(int width,
                                 int height,
                                 const uint8_t* y_plane,
                                 int y_stride,
                                 const uint8_t* uv_plane,
                                 int uv_stride);

OTC_DECL(const uint8_t*)
otc_video_frame_get_buffer(const otc_video_frame* frame);

OTC_DECL(size_t) otc_video_frame_get_buffer_size(const otc_video_frame* frame);

OTC_DECL(int64_t) otc_video_frame_get_timestamp(const otc_video_frame* frame);

OTC_DECL(void)
otc_video_frame_set_timestamp(otc_video_frame* frame, int64_t timestamp);

OTC_DECL(int) otc_video_frame_get_width(const otc_video_frame* frame);

OTC_DECL(int) otc_video_frame_get_height(const otc_video_frame* frame);

OTC_DECL(size_t)
otc_video_frame_get_number_of_planes(const otc_video_frame* frame);

OTC_DECL(enum otc_video_frame_format)
otc_video_frame_get_format(const otc_video_frame* frame);

OTC_DECL(void)
otc_video_frame_set_format(otc_video_frame* frame,
                           enum otc_video_frame_format format);

OTC_DECL(const uint8_t*)
otc_video_frame_get_plane_binary_data(const otc_video_frame* frame,
                                      enum otc_video_frame_plane plane);

OTC_DECL(size_t)
otc_video_frame_get_plane_size(const otc_video_frame* frame,
                               enum otc_video_frame_plane plane);

OTC_DECL(int)
otc_video_frame_get_plane_stride(const otc_video_frame* frame,
                                 enum otc_video_frame_plane plane);

OTC_DECL(int)
otc_video_frame_get_plane_width(const otc_video_frame* frame,
                                enum otc_video_frame_plane plane);

OTC_DECL(int)
otc_video_frame_get_plane_height(const otc_video_frame* frame,
                                 enum otc_video_frame_plane plane);

OTC_DECL(otc_video_frame*) otc_video_frame_copy(const otc_video_frame* frame);

OTC_DECL(otc_video_frame*)
otc_video_frame_mutable_copy(const otc_video_frame* frame);

OTC_DECL(otc_video_frame*)
otc_video_frame_convert(enum otc_video_frame_format format,
                        const otc_video_frame* frame);

OTC_DECL(otc_status)
otc_video_frame_convert_inplace(enum otc_video_frame_format format,
                                uint8_t** planes,
                                const int* strides,
                                const otc_video_frame* input_frame);

OTC_DECL(otc_bool) otc_video_frame_is_packed(const otc_video_frame* frame);

OTC_DECL(otc_bool) otc_video_frame_is_contiguous(const otc_video_frame* frame);

OTC_DECL(otc_status)
otc_video_frame_set_metadata(otc_video_frame* frame,
                             const uint8_t* data,
                             size_t size);

OTC_DECL(const uint8_t*)
otc_video_frame_get_metadata(const otc_video_frame* frame, size_t* size);

OTC_END_DECL

#endif  // VIDEO_FRAME_H