libass/ass_render.h

   1 /*
   2  * Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
   3  * Copyright (C) 2009 Grigori Goronzy <greg@geekmind.org>
   4  *
   5  * This file is part of libass.
   6  *
   7  * Permission to use, copy, modify, and distribute this software for any
   8  * purpose with or without fee is hereby granted, provided that the above
   9  * copyright notice and this permission notice appear in all copies.
  10  *
  11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  18  */
  19
  20 #ifndef LIBASS_RENDER_H
  21 #define LIBASS_RENDER_H
  22
  23 #include <inttypes.h>
  24 #include <ft2build.h>
  25 #include FT_FREETYPE_H
  26 #include FT_STROKER_H
  27 #include FT_GLYPH_H
  28 #include FT_SYNTHESIS_H
  29
  30 #include "ass.h"
  31 #include "ass_font.h"
  32 #include "ass_bitmap.h"
  33 #include "ass_cache.h"
  34 #include "ass_utils.h"
  35 #include "ass_fontconfig.h"
  36 #include "ass_library.h"
  37 #include "ass_drawing.h"
  38
  39 #define GLYPH_CACHE_MAX 1000
  40 #define BITMAP_CACHE_MAX_SIZE 30 * 1048576
  41
  42 #define PARSED_FADE (1<<0)
  43 #define PARSED_A    (1<<1)
  44
  45 typedef struct {
  46     double xMin;
  47     double xMax;
  48     double yMin;
  49     double yMax;
  50 } DBBox;
  51
  52 typedef struct {
  53     double x;
  54     double y;
  55 } DVector;
  56
  57 typedef struct free_list {
  58     void *object;
  59     struct free_list *next;
  60 } FreeList;
  61
  62 typedef struct {
  63     int frame_width;
  64     int frame_height;
  65     double font_size_coeff;     // font size multiplier
  66     double line_spacing;        // additional line spacing (in frame pixels)
  67     int top_margin;             // height of top margin. Everything except toptitles is shifted down by top_margin.
  68     int bottom_margin;          // height of bottom margin. (frame_height - top_margin - bottom_margin) is original video height.
  69     int left_margin;
  70     int right_margin;
  71     int use_margins;            // 0 - place all subtitles inside original frame
  72     // 1 - use margins for placing toptitles and subtitles
  73     double aspect;              // frame aspect ratio, d_width / d_height.
  74     double storage_aspect;      // pixel ratio of the source image
  75     ASS_Hinting hinting;
  76
  77     char *default_font;
  78     char *default_family;
  79 } ASS_Settings;
  80
  81 // a rendered event
  82 typedef struct {
  83     ASS_Image *imgs;
  84     int top, height, left, width;
  85     int detect_collisions;
  86     int shift_direction;
  87     ASS_Event *event;
  88 } EventImages;
  89
  90 typedef enum {
  91     EF_NONE = 0,
  92     EF_KARAOKE,
  93     EF_KARAOKE_KF,
  94     EF_KARAOKE_KO
  95 } Effect;
  96
  97 // describes a glyph
  98 // GlyphInfo and TextInfo are used for text centering and word-wrapping operations
  99 typedef struct {
 100     unsigned symbol;
 101     unsigned skip;              // skip glyph when layouting text
 102     FT_Outline *outline;
 103     FT_Outline *border;
 104     Bitmap *bm;                 // glyph bitmap
 105     Bitmap *bm_o;               // outline bitmap
 106     Bitmap *bm_s;               // shadow bitmap
 107     FT_BBox bbox;
 108     FT_Vector pos;
 109     char linebreak;             // the first (leading) glyph of some line ?
 110     uint32_t c[4];              // colors
 111     FT_Vector advance;          // 26.6
 112     Effect effect_type;
 113     int effect_timing;          // time duration of current karaoke word
 114     // after process_karaoke_effects: distance in pixels from the glyph origin.
 115     // part of the glyph to the left of it is displayed in a different color.
 116     int effect_skip_timing;     // delay after the end of last karaoke word
 117     int asc, desc;              // font max ascender and descender
 118     int be;                     // blur edges
 119     double blur;                // gaussian blur
 120     double shadow_x;
 121     double shadow_y;
 122     double frx, fry, frz;       // rotation
 123     double fax, fay;            // text shearing
 124
 125     BitmapHashKey hash_key;
 126 } GlyphInfo;
 127
 128 typedef struct {
 129     double asc, desc;
 130 } LineInfo;
 131
 132 typedef struct {
 133     GlyphInfo *glyphs;
 134     int length;
 135     LineInfo *lines;
 136     int n_lines;
 137     double height;
 138     int max_glyphs;
 139     int max_lines;
 140 } TextInfo;
 141
 142 // Renderer state.
 143 // Values like current font face, color, screen position, clipping and so on are stored here.
 144 typedef struct {
 145     ASS_Event *event;
 146     ASS_Style *style;
 147     int parsed_tags;
 148
 149     ASS_Font *font;
 150     char *font_path;
 151     double font_size;
 152     int flags;                  // decoration flags (underline/strike-through)
 153
 154     FT_Stroker stroker;
 155     int alignment;              // alignment overrides go here; if zero, style value will be used
 156     double frx, fry, frz;
 157     double fax, fay;            // text shearing
 158     enum {
 159         EVENT_NORMAL,           // "normal" top-, sub- or mid- title
 160         EVENT_POSITIONED,       // happens after pos(,), margins are ignored
 161         EVENT_HSCROLL,          // "Banner" transition effect, text_width is unlimited
 162         EVENT_VSCROLL           // "Scroll up", "Scroll down" transition effects
 163     } evt_type;
 164     double pos_x, pos_y;        // position
 165     double org_x, org_y;        // origin
 166     char have_origin;           // origin is explicitly defined; if 0, get_base_point() is used
 167     double scale_x, scale_y;
 168     double hspacing;            // distance between letters, in pixels
 169     double border_x;            // outline width
 170     double border_y;
 171     uint32_t c[4];              // colors(Primary, Secondary, so on) in RGBA
 172     int clip_x0, clip_y0, clip_x1, clip_y1;
 173     char clip_mode;             // 1 = iclip
 174     char detect_collisions;
 175     uint32_t fade;              // alpha from \fad
 176     char be;                    // blur edges
 177     double blur;                // gaussian blur
 178     double shadow_x;
 179     double shadow_y;
 180     int drawing_mode;           // not implemented; when != 0 text is discarded, except for style override tags
 181     ASS_Drawing *drawing;       // current drawing
 182     ASS_Drawing *clip_drawing;  // clip vector
 183     int clip_drawing_mode;      // 0 = regular clip, 1 = inverse clip
 184
 185     Effect effect_type;
 186     int effect_timing;
 187     int effect_skip_timing;
 188
 189     enum {
 190         SCROLL_LR,              // left-to-right
 191         SCROLL_RL,
 192         SCROLL_TB,              // top-to-bottom
 193         SCROLL_BT
 194     } scroll_direction;         // for EVENT_HSCROLL, EVENT_VSCROLL
 195     int scroll_shift;
 196
 197     // face properties
 198     char *family;
 199     unsigned bold;
 200     unsigned italic;
 201     int treat_family_as_pattern;
 202     int wrap_style;
 203 } RenderContext;
 204
 205 typedef struct {
 206     Cache *font_cache;
 207     Cache *glyph_cache;
 208     Cache *bitmap_cache;
 209     Cache *composite_cache;
 210     size_t glyph_max;
 211     size_t bitmap_max_size;
 212 } CacheStore;
 213
 214 struct ass_renderer {
 215     ASS_Library *library;
 216     FT_Library ftlibrary;
 217     FCInstance *fontconfig_priv;
 218     ASS_Settings settings;
 219     int render_id;
 220     ASS_SynthPriv *synth_priv;
 221
 222     ASS_Image *images_root;     // rendering result is stored here
 223     ASS_Image *prev_images_root;
 224
 225     EventImages *eimg;          // temporary buffer for sorting rendered events
 226     int eimg_size;              // allocated buffer size
 227
 228     // frame-global data
 229     int width, height;          // screen dimensions
 230     int orig_height;            // frame height ( = screen height - margins )
 231     int orig_width;             // frame width ( = screen width - margins )
 232     int orig_height_nocrop;     // frame height ( = screen height - margins + cropheight)
 233     int orig_width_nocrop;      // frame width ( = screen width - margins + cropwidth)
 234     ASS_Track *track;
 235     long long time;             // frame's timestamp, ms
 236     double font_scale;
 237     double font_scale_x;        // x scale applied to all glyphs to preserve text aspect ratio
 238     double border_scale;
 239
 240     RenderContext state;
 241     TextInfo text_info;
 242     CacheStore cache;
 243
 244     FreeList *free_head;
 245     FreeList *free_tail;
 246 };
 247
 248 typedef struct render_priv {
 249     int top, height, left, width;
 250     int render_id;
 251 } RenderPriv;
 252
 253 typedef struct {
 254     int x0;
 255     int y0;
 256     int x1;
 257     int y1;
 258 } Rect;
 259
 260 typedef struct {
 261     int a, b;                   // top and height
 262     int ha, hb;                 // left and width
 263 } Segment;
 264
 265 void reset_render_context(ASS_Renderer *render_priv);
 266 void ass_free_images(ASS_Image *img);
 267
 268 // XXX: this is actually in ass.c, includes should be fixed later on
 269 void ass_lazy_track_init(ASS_Library *lib, ASS_Track *track);
 270
 271 #endif /* LIBASS_RENDER_H */