mpv/video/out/opengl/hwdec.h

#ifndef MPGL_HWDEC_H_
#define MPGL_HWDEC_H_

#include "common.h"
#include "video/hwdec.h"

struct gl_hwdec {
    const struct gl_hwdec_driver *driver;
    struct mp_log *log;
    struct mpv_global *global;
    GL *gl;
    struct mp_hwdec_devices *devs;
    // GLSL extensions required to sample textures from this.
    const char **glsl_extensions;
    // For free use by hwdec driver
    void *priv;
    // For working around the vdpau vs. vaapi mess.
    bool probing;
    // Used in overlay mode only.
    float overlay_colorkey[4];
};

struct gl_hwdec_plane {
    GLuint gl_texture;
    GLenum gl_target;
    // Like struct gl_format.format (GL_RED etc.). Currently to detect
    // GL_LUMINANCE_ALPHA and integer formats - can be left to 0 otherwise.
    GLenum gl_format;
    int tex_w, tex_h; // allocated texture size
};

struct gl_hwdec_frame {
    struct gl_hwdec_plane planes[4];
    bool vdpau_fields;
    char swizzle[5]; // optional component swizzle (4 components if set)
};

struct gl_hwdec_driver {
    // Name of the interop backend. This is used for informational purposes only.
    const char *name;
    // Used to explicitly request a specific API.
    enum hwdec_type api;
    // The hardware surface IMGFMT_ that must be passed to map_image later.
    // If the test_format callback is set, this field is ignored!
    int imgfmt;
    // Create the hwdec device. It must add it to hw->devs, if applicable.
    int (*create)(struct gl_hwdec *hw);
    // Prepare for rendering video. (E.g. create textures.)
    // Called on initialization, and every time the video size changes.
    // *params must be set to the format the hw textures return.
    int (*reinit)(struct gl_hwdec *hw, struct mp_image_params *params);
    // Return textures that contain a copy or reference of the given hw_image.
    // The textures mirror the format returned by the reinit params argument.
    // The textures must remain valid until unmap is called.
    // hw_image remains referenced by the caller until unmap is called.
    int (*map_frame)(struct gl_hwdec *hw, struct mp_image *hw_image,
                     struct gl_hwdec_frame *out_frame);
    // Must be idempotent.
    void (*unmap)(struct gl_hwdec *hw);

    void (*destroy)(struct gl_hwdec *hw);

    // Optional callback for checking input format support.
    bool (*test_format)(struct gl_hwdec *hw, int imgfmt);

    // The following functions provide an alternative API. Each gl_hwdec_driver
    // must have either map_frame or overlay_frame set (not both or none), and
    // if overlay_frame is set, it operates in overlay mode. In this mode,
    // OSD etc. is rendered via OpenGL, but the video is rendered as a separate
    // layer below it.
    // Non-overlay mode is strictly preferred, so try not to use overlay mode.

    // Set the given frame as overlay, replacing the previous one.
    // hw_image==NULL is passed to clear the overlay.
    int (*overlay_frame)(struct gl_hwdec *hw, struct mp_image *hw_image);

    // Move overlay position within the "window".
    void (*overlay_adjust)(struct gl_hwdec *hw, int w, int h,
                           struct mp_rect *src, struct mp_rect *dst);
};

struct gl_hwdec *gl_hwdec_load_api(struct mp_log *log, GL *gl,
                                   struct mpv_global *g,
                                   struct mp_hwdec_devices *devs,
                                   enum hwdec_type api);

struct gl_hwdec *gl_hwdec_load(struct mp_log *log, GL *gl,
                               struct mpv_global *g,
                               struct mp_hwdec_devices *devs,
                               const char *name);

int gl_hwdec_validate_opt(struct mp_log *log, const m_option_t *opt,
                          struct bstr name, struct bstr param);

void gl_hwdec_uninit(struct gl_hwdec *hwdec);

bool gl_hwdec_test_format(struct gl_hwdec *hwdec, int imgfmt);

#endif