axoverlay.h

Go to the documentation of this file.

#ifndef AXOVERLAY_H
#define AXOVERLAY_H

#include <glib.h>

#ifdef __cplusplus
extern "C" {
#endif

enum axoverlay_error_code {
  AXOVERLAY_ERROR_INVALID_VALUE = 1000, 
  AXOVERLAY_ERROR_INTERNAL = 2000, 
  AXOVERLAY_ERROR_UNEXPECTED = 3000, 
  AXOVERLAY_ERROR_GENERIC = 4000, 
  AXOVERLAY_ERROR_INVALID_ARGUMENT = 5000, 
  AXOVERLAY_ERROR_SERVICE_UNAVAILABLE = 6000, 
  AXOVERLAY_ERROR_BACKEND = 7000 
};

enum axoverlay_colorspace {
  AXOVERLAY_COLORSPACE_ARGB32, 
  AXOVERLAY_COLORSPACE_4BIT_PALETTE, 
  AXOVERLAY_COLORSPACE_1BIT_PALETTE, 
  AXOVERLAY_COLORSPACE_UNDEFINED  
};

enum axoverlay_position_type {
  AXOVERLAY_TOP_LEFT, 
  AXOVERLAY_TOP_RIGHT, 
  AXOVERLAY_BOTTOM_LEFT, 
  AXOVERLAY_BOTTOM_RIGHT, 
  AXOVERLAY_CUSTOM_NORMALIZED, 
  AXOVERLAY_CUSTOM_SOURCE 
};

enum axoverlay_backend_type {
  AXOVERLAY_CAIRO_IMAGE_BACKEND = 1, 
  AXOVERLAY_OPENGLES_BACKEND = 2, 
  AXOVERLAY_OPEN_BACKEND = 3, 
};

enum axoverlay_anchor_point {
  AXOVERLAY_ANCHOR_TOP_LEFT, 
  AXOVERLAY_ANCHOR_CENTER  
};

#define AXOVERLAY_QUAD_CAMERA_ID 0

#define AXOVERLAY_DEFAULT_CAMERA_ID 1

#define AXOVERLAY_Z_PRIO_LOW 0

#define AXOVERLAY_Z_PRIO_MEDIUM 1000

#define AXOVERLAY_Z_PRIO_HIGH 2000

#define AXOVERLAY_Z_PRIO_VERY_HIGH 3000

enum axoverlay_stream_type {
  AXOVERLAY_STREAM_JPEG,
  AXOVERLAY_STREAM_H264,
  AXOVERLAY_STREAM_H265,
  AXOVERLAY_STREAM_YCBCR,
  AXOVERLAY_STREAM_VOUT,
  AXOVERLAY_STREAM_OTHER
};

struct axoverlay_stream_data {
  gint id; 
  gint camera; 
  gint width; 
  gint height;  
  gint rotation; 
  gboolean is_mirrored; 
  enum axoverlay_stream_type type;
};

struct axoverlay_overlay_data {
  enum axoverlay_anchor_point anchor_point; 
  enum axoverlay_position_type postype; 
  gfloat x;  
  gfloat y;  
  gint width; 
  gint height; 
  gint z_priority; 
  enum axoverlay_colorspace colorspace; 
  gboolean scale_to_stream; 
};

struct axoverlay_palette_color {
    guchar red; 
    guchar green; 
    guchar blue; 
    guchar alpha; 
    gboolean pixelate; 
};

typedef gboolean (*axoverlay_stream_select_function)(gint camera, gint width,
                                            gint height, gint rotation,
                                            gboolean is_mirrored,
                                            enum axoverlay_stream_type type);

typedef void (*axoverlay_adjustment_function)(gint id,
                                        struct axoverlay_stream_data *stream,
                                        enum axoverlay_position_type *postype,
                                        gfloat *overlay_x, gfloat *overlay_y,
                                        gint *overlay_width,
                                        gint *overlay_height,
                                        gpointer user_data);

typedef void (*axoverlay_render_function)(gpointer rendering_context, gint id,
                                struct axoverlay_stream_data *stream,
                                enum axoverlay_position_type postype,
                                gfloat overlay_x, gfloat overlay_y,
                                gint overlay_width, gint overlay_height,
                                gpointer user_data);

struct axoverlay_settings {
  axoverlay_render_function render_callback; 
  axoverlay_adjustment_function adjustment_callback; 
  axoverlay_stream_select_function select_callback; 
  enum axoverlay_backend_type backend; 
};

void axoverlay_init_axoverlay_settings(struct axoverlay_settings
                                      *axoverlay_settings);

void axoverlay_init(struct axoverlay_settings *axoverlay_settings,
                    GError **error);

void axoverlay_cleanup(void);

void axoverlay_reload_streams(GError **error);

void axoverlay_redraw(GError **error);

void axoverlay_init_overlay_data(struct axoverlay_overlay_data *data);

gint axoverlay_create_overlay(struct axoverlay_overlay_data *data,
                              gpointer user_data, GError **error);

void axoverlay_destroy_overlay(gint id, GError **error);

void axoverlay_set_overlay_position(gint id,
                                    enum axoverlay_position_type postype,
                                    gfloat x, gfloat y, GError **error);

void axoverlay_set_overlay_size(gint id, gint width, gint height,
                                GError **error);

gint axoverlay_get_max_resolution_width(gint camera, GError **error);

gint axoverlay_get_max_resolution_height(gint camera, GError **error);

gboolean axoverlay_is_backend_supported(enum axoverlay_backend_type backend);

gint axoverlay_get_number_of_palette_colors(GError **error);

void axoverlay_get_palette_color(gint index,
                                 struct axoverlay_palette_color *color,
                                 GError **error);

void axoverlay_set_palette_color(gint index,
                                 struct axoverlay_palette_color *color,
                                 GError **error);

#ifdef __cplusplus
}
#endif

#endif