Adding upstream version 0.37.0.upstream/0.37.0

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 247 insertions, 0 deletions

diff --git a/sub/osd.h b/sub/osd.h
new file mode 100644
index 0000000..39a88ea
--- /dev/null
+++ b/sub/osd.h
@@ -0,0 +1,247 @@
+/*
+ * This file is part of mpv.
+ *
+ * mpv is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * mpv is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with mpv.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef MPLAYER_SUB_H
+#define MPLAYER_SUB_H
+
+#include <stddef.h>
+#include <stdbool.h>
+#include <stdint.h>
+
+#include "options/m_option.h"
+
+// NOTE: VOs must support at least SUBBITMAP_BGRA.
+enum sub_bitmap_format {
+    SUBBITMAP_EMPTY = 0,// no bitmaps; always has num_parts==0
+    SUBBITMAP_LIBASS,   // A8, with a per-surface blend color (libass.color)
+    SUBBITMAP_BGRA,     // IMGFMT_BGRA (MSB=A, LSB=B), scaled, premultiplied alpha
+
+    SUBBITMAP_COUNT
+};
+
+struct sub_bitmap {
+    void *bitmap;
+    int stride;
+    // Note: not clipped, going outside the screen area is allowed
+    //       (except for SUBBITMAP_LIBASS, which is always clipped)
+    int w, h;
+    int x, y;
+    int dw, dh;
+
+    // If the containing struct sub_bitmaps has the packed field set, then this
+    // is the position within the source. (Strictly speaking this is redundant
+    // with the bitmap pointer.)
+    int src_x, src_y;
+
+    struct {
+        uint32_t color;
+    } libass;
+};
+
+struct sub_bitmaps {
+    // For VO cache state (limited by MAX_OSD_PARTS)
+    int render_index;
+
+    enum sub_bitmap_format format;
+
+    struct sub_bitmap *parts;
+    int num_parts;
+
+    // Packed representation of the bitmap data. If non-NULL, then the
+    // parts[].bitmap pointer points into the image data here (and stride will
+    // correspond to packed->stride[0]).
+    //  SUBBITMAP_BGRA: IMGFMT_BGRA (exact match)
+    //  SUBBITMAP_LIBASS: IMGFMT_Y8 (not the same, but compatible layout)
+    // Other formats have this set to NULL.
+    struct mp_image *packed;
+
+    // Bounding box for the packed image. All parts will be within the bounding
+    // box. (The origin of the box is at (0,0).)
+    int packed_w, packed_h;
+
+    int change_id;  // Incremented on each change (0 is never used)
+};
+
+struct sub_bitmap_list {
+    // Combined change_id - of any of the existing items change (even if they
+    // e.g. go away and are removed from items[]), this is incremented.
+    int64_t change_id;
+
+    // Bounding box for rendering. It's notable that SUBBITMAP_LIBASS images are
+    // always within these bounds, while SUBBITMAP_BGRA is not necessarily.
+    int w, h;
+
+    // Sorted by sub_bitmaps.render_index. Unused parts are not in the array,
+    // and you cannot index items[] with render_index.
+    struct sub_bitmaps **items;
+    int num_items;
+};
+
+struct sub_bitmap_copy_cache;
+struct sub_bitmaps *sub_bitmaps_copy(struct sub_bitmap_copy_cache **cache,
+                                     struct sub_bitmaps *in);
+
+struct mp_osd_res {
+    int w, h; // screen dimensions, including black borders
+    int mt, mb, ml, mr; // borders (top, bottom, left, right)
+    double display_par;
+};
+
+bool osd_res_equals(struct mp_osd_res a, struct mp_osd_res b);
+
+// 0 <= sub_bitmaps.render_index < MAX_OSD_PARTS
+#define MAX_OSD_PARTS 5
+
+// Start of OSD symbols in osd_font.pfb
+#define OSD_CODEPOINTS 0xE000
+
+// OSD symbols. osd_font.pfb has them starting from codepoint OSD_CODEPOINTS.
+// Symbols with a value >= 32 are normal unicode codepoints.
+enum mp_osd_font_codepoints {
+    OSD_PLAY = 0x01,
+    OSD_PAUSE = 0x02,
+    OSD_STOP = 0x03,
+    OSD_REW = 0x04,
+    OSD_FFW = 0x05,
+    OSD_CLOCK = 0x06,
+    OSD_CONTRAST = 0x07,
+    OSD_SATURATION = 0x08,
+    OSD_VOLUME = 0x09,
+    OSD_BRIGHTNESS = 0x0A,
+    OSD_HUE = 0x0B,
+    OSD_BALANCE = 0x0C,
+    OSD_PANSCAN = 0x50,
+
+    OSD_PB_START = 0x10,
+    OSD_PB_0 = 0x11,
+    OSD_PB_END = 0x12,
+    OSD_PB_1 = 0x13,
+};
+
+
+// Never valid UTF-8, so we expect it's free for use.
+// Specially interpreted by osd_libass.c, in order to allow/escape ASS tags.
+#define OSD_ASS_0 "\xFD"
+#define OSD_ASS_1 "\xFE"
+
+struct osd_style_opts {
+    char *font;
+    float font_size;
+    struct m_color color;
+    struct m_color border_color;
+    struct m_color shadow_color;
+    struct m_color back_color;
+    float border_size;
+    float shadow_offset;
+    float spacing;
+    int margin_x;
+    int margin_y;
+    int align_x;
+    int align_y;
+    float blur;
+    bool bold;
+    bool italic;
+    int justify;
+    int font_provider;
+    char *fonts_dir;
+};
+
+extern const struct m_sub_options osd_style_conf;
+extern const struct m_sub_options sub_style_conf;
+
+struct osd_state;
+struct osd_object;
+struct mpv_global;
+struct dec_sub;
+
+struct osd_state *osd_create(struct mpv_global *global);
+void osd_changed(struct osd_state *osd);
+void osd_free(struct osd_state *osd);
+
+bool osd_query_and_reset_want_redraw(struct osd_state *osd);
+
+void osd_set_text(struct osd_state *osd, const char *text);
+void osd_set_sub(struct osd_state *osd, int index, struct dec_sub *dec_sub);
+
+bool osd_get_render_subs_in_filter(struct osd_state *osd);
+void osd_set_render_subs_in_filter(struct osd_state *osd, bool s);
+void osd_set_force_video_pts(struct osd_state *osd, double video_pts);
+double osd_get_force_video_pts(struct osd_state *osd);
+
+struct osd_progbar_state {
+    int type;           // <0: disabled, 1-255: symbol, else: no symbol
+    float value;        // range 0.0-1.0
+    float *stops;       // used for chapter indicators (0.0-1.0 each)
+    int num_stops;
+};
+void osd_set_progbar(struct osd_state *osd, struct osd_progbar_state *s);
+
+void osd_set_external2(struct osd_state *osd, struct sub_bitmaps *imgs);
+
+enum mp_osd_draw_flags {
+    OSD_DRAW_SUB_FILTER = (1 << 0),
+    OSD_DRAW_SUB_ONLY   = (1 << 1),
+    OSD_DRAW_OSD_ONLY   = (1 << 2),
+};
+
+void osd_draw(struct osd_state *osd, struct mp_osd_res res,
+              double video_pts, int draw_flags,
+              const bool formats[SUBBITMAP_COUNT],
+              void (*cb)(void *ctx, struct sub_bitmaps *imgs), void *cb_ctx);
+
+struct sub_bitmap_list *osd_render(struct osd_state *osd, struct mp_osd_res res,
+                                   double video_pts, int draw_flags,
+                                   const bool formats[SUBBITMAP_COUNT]);
+
+struct mp_image;
+void osd_draw_on_image(struct osd_state *osd, struct mp_osd_res res,
+                       double video_pts, int draw_flags, struct mp_image *dest);
+
+struct mp_image_pool;
+void osd_draw_on_image_p(struct osd_state *osd, struct mp_osd_res res,
+                         double video_pts, int draw_flags,
+                         struct mp_image_pool *pool, struct mp_image *dest);
+
+void osd_resize(struct osd_state *osd, struct mp_osd_res res);
+
+struct mp_image_params;
+struct mp_osd_res osd_res_from_image_params(const struct mp_image_params *p);
+
+struct mp_osd_res osd_get_vo_res(struct osd_state *osd);
+
+void osd_rescale_bitmaps(struct sub_bitmaps *imgs, int frame_w, int frame_h,
+                         struct mp_osd_res res, double compensate_par);
+
+struct osd_external_ass {
+    void *owner; // unique pointer (NULL is also allowed)
+    int64_t id;
+    int format;
+    char *data;
+    int res_x, res_y;
+    int z;
+    bool hidden;
+
+    double *out_rc; // hack to pass boundary rect, [x0, y0, x1, y1]
+};
+
+// defined in osd_libass.c and osd_dummy.c
+void osd_set_external(struct osd_state *osd, struct osd_external_ass *ov);
+void osd_set_external_remove_owner(struct osd_state *osd, void *owner);
+void osd_get_text_size(struct osd_state *osd, int *out_screen_h, int *out_font_h);
+void osd_get_function_sym(char *buffer, size_t buffer_size, int osd_function);
+
+#endif /* MPLAYER_SUB_H */