1 // -*- c-basic-offset: 8; indent-tabs-mode: t -*-
2 // vim:ts=8:sw=8:noet:ai:
4 Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
27 #include FT_FREETYPE_H
30 #include FT_SYNTHESIS_H
35 #include "ass_bitmap.h"
36 #include "ass_cache.h"
37 #include "ass_utils.h"
38 #include "ass_fontconfig.h"
39 #include "ass_library.h"
42 #define MAX_GLYPHS 1000
45 static int last_render_id = 0;
47 typedef struct ass_settings_s {
50 double font_size_coeff; // font size multiplier
51 double line_spacing; // additional line spacing (in frame pixels)
52 int top_margin; // height of top margin. Everything except toptitles is shifted down by top_margin.
53 int bottom_margin; // height of bottom margin. (frame_height - top_margin - bottom_margin) is original video height.
56 int use_margins; // 0 - place all subtitles inside original frame
57 // 1 - use margins for placing toptitles and subtitles
58 double aspect; // frame aspect ratio, d_width / d_height.
64 struct ass_renderer_s {
65 ass_library_t* library;
67 fc_instance_t* fontconfig_priv;
68 ass_settings_t settings;
70 ass_synth_priv_t* synth_priv;
72 ass_image_t* images_root; // rendering result is stored here
75 typedef enum {EF_NONE = 0, EF_KARAOKE, EF_KARAOKE_KF, EF_KARAOKE_KO} effect_t;
78 // glyph_info_t and text_info_t are used for text centering and word-wrapping operations
79 typedef struct glyph_info_s {
82 FT_Glyph outline_glyph;
83 bitmap_t* bm; // glyph bitmap
84 bitmap_t* bm_o; // outline bitmap
85 bitmap_t* bm_s; // shadow bitmap
88 char linebreak; // the first (leading) glyph of some line ?
89 uint32_t c[4]; // colors
90 FT_Vector advance; // 26.6
92 int effect_timing; // time duration of current karaoke word
93 // after process_karaoke_effects: distance in pixels from the glyph origin.
94 // part of the glyph to the left of it is displayed in a different color.
95 int effect_skip_timing; // delay after the end of last karaoke word
96 int asc, desc; // font max ascender and descender
100 double frz; // z-axis rotation
102 glyph_hash_key_t hash_key;
105 typedef struct line_info_s {
109 typedef struct text_info_s {
110 glyph_info_t* glyphs;
112 line_info_t lines[MAX_LINES];
119 // Values like current font face, color, screen position, clipping and so on are stored here.
120 typedef struct render_context_s {
129 int alignment; // alignment overrides go here; if zero, style value will be used
131 enum { EVENT_NORMAL, // "normal" top-, sub- or mid- title
132 EVENT_POSITIONED, // happens after pos(,), margins are ignored
133 EVENT_HSCROLL, // "Banner" transition effect, text_width is unlimited
134 EVENT_VSCROLL // "Scroll up", "Scroll down" transition effects
136 int pos_x, pos_y; // position
137 int org_x, org_y; // origin
138 double scale_x, scale_y;
139 int hspacing; // distance between letters, in pixels
140 double border; // outline width
141 uint32_t c[4]; // colors(Primary, Secondary, so on) in RGBA
142 int clip_x0, clip_y0, clip_x1, clip_y1;
143 char detect_collisions;
144 uint32_t fade; // alpha from \fad
145 char be; // blur edges
148 effect_t effect_type;
150 int effect_skip_timing;
152 enum { SCROLL_LR, // left-to-right
154 SCROLL_TB, // top-to-bottom
156 } scroll_direction; // for EVENT_HSCROLL, EVENT_VSCROLL
167 typedef struct frame_context_s {
168 ass_renderer_t* ass_priv;
169 int width, height; // screen dimensions
170 int orig_height; // frame height ( = screen height - margins )
171 int orig_width; // frame width ( = screen width - margins )
173 long long time; // frame's timestamp, ms
175 double font_scale_x; // x scale applied to all glyphs to preserve text aspect ratio
179 static ass_renderer_t* ass_renderer;
180 static ass_settings_t* global_settings;
181 static text_info_t text_info;
182 static render_context_t render_context;
183 static frame_context_t frame_context;
186 typedef struct event_images_s {
189 int detect_collisions;
194 struct render_priv_s {
199 static void ass_lazy_track_init(void)
201 ass_track_t* track = frame_context.track;
202 if (track->PlayResX && track->PlayResY)
204 if (!track->PlayResX && !track->PlayResY) {
205 mp_msg(MSGT_ASS, MSGL_WARN, MSGTR_LIBASS_NeitherPlayResXNorPlayResYDefined);
206 track->PlayResX = 384;
207 track->PlayResY = 288;
209 double orig_aspect = (global_settings->aspect * frame_context.height * frame_context.orig_width) /
210 frame_context.orig_height / frame_context.width;
211 if (!track->PlayResY) {
212 track->PlayResY = track->PlayResX / orig_aspect + .5;
213 mp_msg(MSGT_ASS, MSGL_WARN, MSGTR_LIBASS_PlayResYUndefinedSettingY, track->PlayResY);
214 } else if (!track->PlayResX) {
215 track->PlayResX = track->PlayResY * orig_aspect + .5;
216 mp_msg(MSGT_ASS, MSGL_WARN, MSGTR_LIBASS_PlayResXUndefinedSettingX, track->PlayResX);
221 ass_renderer_t* ass_renderer_init(ass_library_t* library)
225 ass_renderer_t* priv = 0;
227 memset(&render_context, 0, sizeof(render_context));
228 memset(&frame_context, 0, sizeof(frame_context));
229 memset(&text_info, 0, sizeof(text_info));
231 error = FT_Init_FreeType( &ft );
233 mp_msg(MSGT_ASS, MSGL_FATAL, MSGTR_LIBASS_FT_Init_FreeTypeFailed);
237 priv = calloc(1, sizeof(ass_renderer_t));
239 FT_Done_FreeType(ft);
243 priv->synth_priv = ass_synth_init();
245 priv->library = library;
246 priv->ftlibrary = ft;
247 // images_root and related stuff is zero-filled in calloc
249 ass_font_cache_init();
250 ass_glyph_cache_init();
252 text_info.glyphs = calloc(MAX_GLYPHS, sizeof(glyph_info_t));
255 if (priv) mp_msg(MSGT_ASS, MSGL_INFO, MSGTR_LIBASS_Init);
256 else mp_msg(MSGT_ASS, MSGL_ERR, MSGTR_LIBASS_InitFailed);
261 void ass_renderer_done(ass_renderer_t* priv)
263 ass_font_cache_done();
264 ass_glyph_cache_done();
265 if (render_context.stroker) {
266 FT_Stroker_Done(render_context.stroker);
267 render_context.stroker = 0;
269 if (priv && priv->ftlibrary) FT_Done_FreeType(priv->ftlibrary);
270 if (priv && priv->fontconfig_priv) fontconfig_done(priv->fontconfig_priv);
271 if (priv && priv->synth_priv) ass_synth_done(priv->synth_priv);
272 if (priv) free(priv);
273 if (text_info.glyphs) free(text_info.glyphs);
277 * \brief Create a new ass_image_t
278 * Parameters are the same as ass_image_t fields.
280 static ass_image_t* my_draw_bitmap(unsigned char* bitmap, int bitmap_w, int bitmap_h, int stride, int dst_x, int dst_y, uint32_t color)
282 ass_image_t* img = calloc(1, sizeof(ass_image_t));
286 img->stride = stride;
287 img->bitmap = bitmap;
296 * \brief convert bitmap glyph into ass_image_t struct(s)
297 * \param bit freetype bitmap glyph, FT_PIXEL_MODE_GRAY
298 * \param dst_x bitmap x coordinate in video frame
299 * \param dst_y bitmap y coordinate in video frame
300 * \param color first color, RGBA
301 * \param color2 second color, RGBA
302 * \param brk x coordinate relative to glyph origin, color is used to the left of brk, color2 - to the right
303 * \param tail pointer to the last image's next field, head of the generated list should be stored here
304 * \return pointer to the new list tail
305 * Performs clipping. Uses my_draw_bitmap for actual bitmap convertion.
307 static ass_image_t** render_glyph(bitmap_t* bm, int dst_x, int dst_y, uint32_t color, uint32_t color2, int brk, ass_image_t** tail)
309 // brk is relative to dst_x
310 // color = color left of brk
311 // color2 = color right of brk
312 int b_x0, b_y0, b_x1, b_y1; // visible part of the bitmap
313 int clip_x0, clip_y0, clip_x1, clip_y1;
322 clip_x0 = render_context.clip_x0;
323 clip_y0 = render_context.clip_y0;
324 clip_x1 = render_context.clip_x1;
325 clip_y1 = render_context.clip_y1;
331 tmp = dst_x - clip_x0;
333 mp_msg(MSGT_ASS, MSGL_DBG2, "clip left\n");
336 tmp = dst_y - clip_y0;
338 mp_msg(MSGT_ASS, MSGL_DBG2, "clip top\n");
341 tmp = clip_x1 - dst_x - bm->w;
343 mp_msg(MSGT_ASS, MSGL_DBG2, "clip right\n");
346 tmp = clip_y1 - dst_y - bm->h;
348 mp_msg(MSGT_ASS, MSGL_DBG2, "clip bottom\n");
352 if ((b_y0 >= b_y1) || (b_x0 >= b_x1))
355 if (brk > b_x0) { // draw left part
356 if (brk > b_x1) brk = b_x1;
357 img = my_draw_bitmap(bm->buffer + bm->w * b_y0 + b_x0,
358 brk - b_x0, b_y1 - b_y0, bm->w,
359 dst_x + b_x0, dst_y + b_y0, color);
363 if (brk < b_x1) { // draw right part
364 if (brk < b_x0) brk = b_x0;
365 img = my_draw_bitmap(bm->buffer + bm->w * b_y0 + brk,
366 b_x1 - brk, b_y1 - b_y0, bm->w,
367 dst_x + brk, dst_y + b_y0, color2);
375 * \brief Render text_info_t struct into ass_images_t list
376 * Rasterize glyphs and put them in glyph cache.
378 static ass_image_t* render_text(text_info_t* text_info, int dst_x, int dst_y)
383 glyph_hash_val_t hash_val;
385 ass_image_t** tail = &head;
387 for (i = 0; i < text_info->length; ++i) {
388 if (text_info->glyphs[i].glyph) {
389 if ((text_info->glyphs[i].symbol == '\n') || (text_info->glyphs[i].symbol == 0))
391 error = glyph_to_bitmap(ass_renderer->synth_priv,
392 text_info->glyphs[i].glyph, text_info->glyphs[i].outline_glyph,
393 &text_info->glyphs[i].bm, &text_info->glyphs[i].bm_o,
394 &text_info->glyphs[i].bm_s, text_info->glyphs[i].be);
396 text_info->glyphs[i].symbol = 0;
397 FT_Done_Glyph(text_info->glyphs[i].glyph);
398 if (text_info->glyphs[i].outline_glyph)
399 FT_Done_Glyph(text_info->glyphs[i].outline_glyph);
402 hash_val.bbox_scaled = text_info->glyphs[i].bbox;
403 hash_val.bm_o = text_info->glyphs[i].bm_o;
404 hash_val.bm = text_info->glyphs[i].bm;
405 hash_val.bm_s = text_info->glyphs[i].bm_s;
406 hash_val.advance.x = text_info->glyphs[i].advance.x;
407 hash_val.advance.y = text_info->glyphs[i].advance.y;
408 cache_add_glyph(&(text_info->glyphs[i].hash_key), &hash_val);
413 for (i = 0; i < text_info->length; ++i) {
414 glyph_info_t* info = text_info->glyphs + i;
415 if ((info->symbol == 0) || (info->symbol == '\n') || !info->bm_s || (info->shadow == 0))
418 pen_x = dst_x + info->pos.x + info->shadow;
419 pen_y = dst_y + info->pos.y + info->shadow;
422 tail = render_glyph(bm, pen_x, pen_y, info->c[3], 0, 1000000, tail);
425 for (i = 0; i < text_info->length; ++i) {
426 glyph_info_t* info = text_info->glyphs + i;
427 if ((info->symbol == 0) || (info->symbol == '\n') || !info->bm_o)
430 pen_x = dst_x + info->pos.x;
431 pen_y = dst_y + info->pos.y;
434 if ((info->effect_type == EF_KARAOKE_KO) && (info->effect_timing <= info->bbox.xMax)) {
437 tail = render_glyph(bm, pen_x, pen_y, info->c[2], 0, 1000000, tail);
439 for (i = 0; i < text_info->length; ++i) {
440 glyph_info_t* info = text_info->glyphs + i;
441 if ((info->symbol == 0) || (info->symbol == '\n') || !info->bm)
444 pen_x = dst_x + info->pos.x;
445 pen_y = dst_y + info->pos.y;
448 if ((info->effect_type == EF_KARAOKE) || (info->effect_type == EF_KARAOKE_KO)) {
449 if (info->effect_timing > info->bbox.xMax)
450 tail = render_glyph(bm, pen_x, pen_y, info->c[0], 0, 1000000, tail);
452 tail = render_glyph(bm, pen_x, pen_y, info->c[1], 0, 1000000, tail);
453 } else if (info->effect_type == EF_KARAOKE_KF) {
454 tail = render_glyph(bm, pen_x, pen_y, info->c[0], info->c[1], info->effect_timing, tail);
456 tail = render_glyph(bm, pen_x, pen_y, info->c[0], 0, 1000000, tail);
464 * \brief Mapping between script and screen coordinates
466 static int x2scr(int x) {
467 return x*frame_context.orig_width / frame_context.track->PlayResX + global_settings->left_margin;
470 * \brief Mapping between script and screen coordinates
472 static int y2scr(int y) {
473 return y * frame_context.orig_height / frame_context.track->PlayResY + global_settings->top_margin;
475 // the same for toptitles
476 static int y2scr_top(int y) {
477 if (global_settings->use_margins)
478 return y * frame_context.orig_height / frame_context.track->PlayResY;
480 return y * frame_context.orig_height / frame_context.track->PlayResY + global_settings->top_margin;
482 // the same for subtitles
483 static int y2scr_sub(int y) {
484 if (global_settings->use_margins)
485 return y * frame_context.orig_height / frame_context.track->PlayResY +
486 global_settings->top_margin + global_settings->bottom_margin;
488 return y * frame_context.orig_height / frame_context.track->PlayResY + global_settings->top_margin;
491 static void compute_string_bbox( text_info_t* info, FT_BBox *abbox ) {
495 if (text_info.length > 0) {
498 bbox.yMin = - (text_info.lines[0].asc >> 6) + text_info.glyphs[0].pos.y;
499 bbox.yMax = ((text_info.height - text_info.lines[0].asc) >> 6) + text_info.glyphs[0].pos.y;
501 for (i = 0; i < text_info.length; ++i) {
502 int s = text_info.glyphs[i].pos.x;
503 int e = s + (text_info.glyphs[i].advance.x >> 6);
504 bbox.xMin = FFMIN(bbox.xMin, s);
505 bbox.xMax = FFMAX(bbox.xMax, e);
508 bbox.xMin = bbox.xMax = bbox.yMin = bbox.yMax = 0;
510 /* return string bbox */
516 * \brief Check if starting part of (*p) matches sample. If true, shift p to the first symbol after the matching part.
518 static inline int mystrcmp(char** p, const char* sample) {
519 int len = strlen(sample);
520 if (strncmp(*p, sample, len) == 0) {
527 double ass_internal_font_size_coeff = 0.8;
529 static void change_font_size(int sz)
531 double size = sz * frame_context.font_scale;
535 else if (size > frame_context.height * 2)
536 size = frame_context.height * 2;
538 ass_font_set_size(render_context.font, size);
540 render_context.font_size = sz;
544 * \brief Change current font, using setting from render_context.
546 static void update_font(void)
549 ass_renderer_t* priv = frame_context.ass_priv;
550 ass_font_desc_t desc;
551 desc.family = strdup(render_context.family);
553 val = render_context.bold;
554 // 0 = normal, 1 = bold, >1 = exact weight
555 if (val == 0) val = 80; // normal
556 else if (val == 1) val = 200; // bold
559 val = render_context.italic;
560 if (val == 0) val = 0; // normal
561 else if (val == 1) val = 110; //italic
564 render_context.font = ass_new_font(priv->ftlibrary, priv->fontconfig_priv, &desc);
566 if (render_context.font)
567 change_font_size(render_context.font_size);
571 * \brief Change border width
572 * negative value resets border to style value
574 static void change_border(double border)
577 if (!render_context.font) return;
580 if (render_context.style->BorderStyle == 1) {
581 if (render_context.style->Outline == 0 && render_context.style->Shadow > 0)
584 border = render_context.style->Outline;
588 render_context.border = border;
590 b = 64 * border * frame_context.border_scale;
592 if (!render_context.stroker) {
594 #if (FREETYPE_MAJOR > 2) || ((FREETYPE_MAJOR == 2) && (FREETYPE_MINOR > 1))
595 error = FT_Stroker_New( ass_renderer->ftlibrary, &render_context.stroker );
597 error = FT_Stroker_New( render_context.font->face->memory, &render_context.stroker );
600 mp_msg(MSGT_ASS, MSGL_V, "failed to get stroker\n");
601 render_context.stroker = 0;
604 if (render_context.stroker)
605 FT_Stroker_Set( render_context.stroker, b,
606 FT_STROKER_LINECAP_ROUND,
607 FT_STROKER_LINEJOIN_ROUND,
610 FT_Stroker_Done(render_context.stroker);
611 render_context.stroker = 0;
615 #define _r(c) ((c)>>24)
616 #define _g(c) (((c)>>16)&0xFF)
617 #define _b(c) (((c)>>8)&0xFF)
618 #define _a(c) ((c)&0xFF)
621 * \brief Calculate a weighted average of two colors
622 * calculates c1*(1-a) + c2*a, but separately for each component except alpha
624 static void change_color(uint32_t* var, uint32_t new, double pwr)
626 (*var)= ((uint32_t)(_r(*var) * (1 - pwr) + _r(new) * pwr) << 24) +
627 ((uint32_t)(_g(*var) * (1 - pwr) + _g(new) * pwr) << 16) +
628 ((uint32_t)(_b(*var) * (1 - pwr) + _b(new) * pwr) << 8) +
632 // like change_color, but for alpha component only
633 static void change_alpha(uint32_t* var, uint32_t new, double pwr)
635 *var = (_r(*var) << 24) + (_g(*var) << 16) + (_b(*var) << 8) + (_a(*var) * (1 - pwr) + _a(new) * pwr);
639 * \brief Multiply two alpha values
640 * \param a first value
641 * \param b second value
642 * \return result of multiplication
643 * Parameters and result are limited by 0xFF.
645 static uint32_t mult_alpha(uint32_t a, uint32_t b)
647 return 0xFF - (0xFF - a) * (0xFF - b) / 0xFF;
651 * \brief Calculate alpha value by piecewise linear function
652 * Used for \fad, \fade implementation.
654 static unsigned interpolate_alpha(long long now,
655 long long t1, long long t2, long long t3, long long t4,
656 unsigned a1, unsigned a2, unsigned a3)
662 } else if (now >= t4) {
664 } else if (now < t2) { // and > t1
665 cf = ((double)(now - t1)) / (t2 - t1);
666 a = a1 * (1 - cf) + a2 * cf;
667 } else if (now > t3) {
668 cf = ((double)(now - t3)) / (t4 - t3);
669 a = a2 * (1 - cf) + a3 * cf;
670 } else { // t2 <= now <= t3
677 static void reset_render_context();
680 * \brief Parse style override tag.
681 * \param p string to parse
682 * \param pwr multiplier for some tag effects (comes from \t tags)
684 static char* parse_tag(char* p, double pwr) {
685 #define skip_all(x) if (*p == (x)) ++p; else { \
686 while ((*p != (x)) && (*p != '}') && (*p != 0)) {++p;} }
687 #define skip(x) if (*p == (x)) ++p; else { return p; }
690 if ((*p == '}') || (*p == 0))
693 if (mystrcmp(&p, "fsc")) {
697 if (mystrtod(&p, &val)) {
699 render_context.scale_x = (val - 1.) * pwr + 1.;
701 render_context.scale_x = render_context.style->ScaleX;
702 } else if (tp == 'y') {
703 if (mystrtod(&p, &val)) {
705 render_context.scale_y = (val - 1.) * pwr + 1.;
707 render_context.scale_y = render_context.style->ScaleY;
709 } else if (mystrcmp(&p, "fsp")) {
711 if (mystrtoi(&p, 10, &val))
712 render_context.hspacing = val * pwr;
714 render_context.hspacing = 0;
715 } else if (mystrcmp(&p, "fs")) {
717 if (mystrtoi(&p, 10, &val))
718 val = render_context.font_size * ( 1 - pwr ) + val * pwr;
720 val = render_context.style->FontSize;
721 if (render_context.font)
722 change_font_size(val);
723 } else if (mystrcmp(&p, "bord")) {
725 if (mystrtod(&p, &val))
726 val = render_context.border * ( 1 - pwr ) + val * pwr;
728 val = -1.; // reset to default
730 } else if (mystrcmp(&p, "move")) {
732 long long t1, t2, delta_t, t;
736 x1 = strtol(p, &p, 10);
738 y1 = strtol(p, &p, 10);
740 x2 = strtol(p, &p, 10);
742 y2 = strtol(p, &p, 10);
745 t1 = strtoll(p, &p, 10);
747 t2 = strtoll(p, &p, 10);
748 mp_msg(MSGT_ASS, MSGL_DBG2, "movement6: (%d, %d) -> (%d, %d), (%" PRId64 " .. %" PRId64 ")\n",
749 x1, y1, x2, y2, (int64_t)t1, (int64_t)t2);
752 t2 = render_context.event->Duration;
753 mp_msg(MSGT_ASS, MSGL_DBG2, "movement: (%d, %d) -> (%d, %d)\n", x1, y1, x2, y2);
757 t = frame_context.time - render_context.event->Start;
762 else k = ((double)(t - t1)) / delta_t;
763 x = k * (x2 - x1) + x1;
764 y = k * (y2 - y1) + y1;
765 render_context.pos_x = x;
766 render_context.pos_y = y;
767 render_context.detect_collisions = 0;
768 render_context.evt_type = EVENT_POSITIONED;
769 } else if (mystrcmp(&p, "frx") || mystrcmp(&p, "fry")) {
772 mp_msg(MSGT_ASS, MSGL_V, "frx/fry unimplemented \n");
773 } else if (mystrcmp(&p, "frz") || mystrcmp(&p, "fr")) {
777 mp_msg(MSGT_ASS, MSGL_DBG2, "setting rotation to %.2f\n", val * pwr);
778 angle = M_PI * val / 180;
779 render_context.rotation = angle * pwr;
780 } else if (mystrcmp(&p, "fn")) {
784 family = malloc(p - start + 1);
785 strncpy(family, start, p - start);
786 family[p - start] = '\0';
787 if (render_context.family)
788 free(render_context.family);
789 render_context.family = family;
791 } else if (mystrcmp(&p, "alpha")) {
794 if (strtocolor(&p, &val)) {
795 unsigned char a = val >> 24;
796 for (i = 0; i < 4; ++i)
797 change_alpha(&render_context.c[i], a, pwr);
799 change_alpha(&render_context.c[0], render_context.style->PrimaryColour, pwr);
800 change_alpha(&render_context.c[1], render_context.style->SecondaryColour, pwr);
801 change_alpha(&render_context.c[2], render_context.style->OutlineColour, pwr);
802 change_alpha(&render_context.c[3], render_context.style->BackColour, pwr);
805 } else if (mystrcmp(&p, "an")) {
806 int val = strtol(p, &p, 10);
807 int v = (val - 1) / 3; // 0, 1 or 2 for vertical alignment
808 mp_msg(MSGT_ASS, MSGL_DBG2, "an %d\n", val);
809 if (v != 0) v = 3 - v;
810 val = ((val - 1) % 3) + 1; // horizontal alignment
812 mp_msg(MSGT_ASS, MSGL_DBG2, "align %d\n", val);
813 render_context.alignment = val;
814 } else if (mystrcmp(&p, "a")) {
815 int val = strtol(p, &p, 10);
816 render_context.alignment = val;
817 } else if (mystrcmp(&p, "pos")) {
820 v1 = strtol(p, &p, 10);
822 v2 = strtol(p, &p, 10);
824 mp_msg(MSGT_ASS, MSGL_DBG2, "pos(%d, %d)\n", v1, v2);
825 render_context.evt_type = EVENT_POSITIONED;
826 render_context.detect_collisions = 0;
827 render_context.pos_x = v1;
828 render_context.pos_y = v2;
829 } else if (mystrcmp(&p, "fad")) {
831 long long t1, t2, t3, t4;
832 if (*p == 'e') ++p; // either \fad or \fade
834 a1 = strtol(p, &p, 10);
836 a2 = strtol(p, &p, 10);
838 // 2-argument version (\fad, according to specs)
839 // a1 and a2 are fade-in and fade-out durations
841 t4 = render_context.event->Duration;
848 // 6-argument version (\fade)
849 // a1 and a2 (and a3) are opacity values
851 a3 = strtol(p, &p, 10);
853 t1 = strtoll(p, &p, 10);
855 t2 = strtoll(p, &p, 10);
857 t3 = strtoll(p, &p, 10);
859 t4 = strtoll(p, &p, 10);
862 render_context.fade = interpolate_alpha(frame_context.time - render_context.event->Start, t1, t2, t3, t4, a1, a2, a3);
863 } else if (mystrcmp(&p, "org")) {
866 v1 = strtol(p, &p, 10);
868 v2 = strtol(p, &p, 10);
870 mp_msg(MSGT_ASS, MSGL_DBG2, "org(%d, %d)\n", v1, v2);
871 // render_context.evt_type = EVENT_POSITIONED;
872 render_context.org_x = v1;
873 render_context.org_y = v2;
874 } else if (mystrcmp(&p, "t")) {
879 long long t1, t2, t, delta_t;
882 for (cnt = 0; cnt < 3; ++cnt) {
885 v[cnt] = strtod(p, &p);
889 v1 = v[0]; v2 = v[1]; v3 = v[2];
890 } else if (cnt == 2) {
891 v1 = v[0]; v2 = v[1]; v3 = 1.;
892 } else if (cnt == 1) {
893 v1 = 0; v2 = render_context.event->Duration; v3 = v[0];
895 v1 = 0; v2 = render_context.event->Duration; v3 = 1.;
897 render_context.detect_collisions = 0;
903 t = frame_context.time - render_context.event->Start; // FIXME: move to render_context
908 else k = pow(((double)(t - t1)) / delta_t, v3);
910 p = parse_tag(p, k); // maybe k*pwr ? no, specs forbid nested \t's
911 skip_all(')'); // FIXME: better skip(')'), but much more tags support required
912 } else if (mystrcmp(&p, "clip")) {
916 res &= mystrtoi(&p, 10, &x0);
918 res &= mystrtoi(&p, 10, &y0);
920 res &= mystrtoi(&p, 10, &x1);
922 res &= mystrtoi(&p, 10, &y1);
925 render_context.clip_x0 = render_context.clip_x0 * (1-pwr) + x0 * pwr;
926 render_context.clip_x1 = render_context.clip_x1 * (1-pwr) + x1 * pwr;
927 render_context.clip_y0 = render_context.clip_y0 * (1-pwr) + y0 * pwr;
928 render_context.clip_y1 = render_context.clip_y1 * (1-pwr) + y1 * pwr;
930 render_context.clip_x0 = 0;
931 render_context.clip_y0 = 0;
932 render_context.clip_x1 = frame_context.track->PlayResX;
933 render_context.clip_y1 = frame_context.track->PlayResY;
935 } else if (mystrcmp(&p, "c")) {
937 if (!strtocolor(&p, &val))
938 val = render_context.style->PrimaryColour;
939 mp_msg(MSGT_ASS, MSGL_DBG2, "color: %X\n", val);
940 change_color(&render_context.c[0], val, pwr);
941 } else if ((*p >= '1') && (*p <= '4') && (++p) && (mystrcmp(&p, "c") || mystrcmp(&p, "a"))) {
946 assert((n >= '1') && (n <= '4'));
947 if (!strtocolor(&p, &val))
949 case '1': val = render_context.style->PrimaryColour; break;
950 case '2': val = render_context.style->SecondaryColour; break;
951 case '3': val = render_context.style->OutlineColour; break;
952 case '4': val = render_context.style->BackColour; break;
953 default : val = 0; break; // impossible due to assert; avoid compilation warning
956 case 'c': change_color(render_context.c + cidx, val, pwr); break;
957 case 'a': change_alpha(render_context.c + cidx, val >> 24, pwr); break;
958 default: mp_msg(MSGT_ASS, MSGL_WARN, MSGTR_LIBASS_BadCommand, n, cmd); break;
960 mp_msg(MSGT_ASS, MSGL_DBG2, "single c/a at %f: %c%c = %X \n", pwr, n, cmd, render_context.c[cidx]);
961 } else if (mystrcmp(&p, "r")) {
962 reset_render_context();
963 } else if (mystrcmp(&p, "be")) {
965 if (mystrtoi(&p, 10, &val))
966 render_context.be = val ? 1 : 0;
968 render_context.be = 0;
969 } else if (mystrcmp(&p, "b")) {
971 if (mystrtoi(&p, 10, &b))
972 render_context.bold = b;
974 render_context.bold = - render_context.style->Bold;
976 } else if (mystrcmp(&p, "i")) {
978 if (mystrtoi(&p, 10, &i))
979 render_context.italic = i;
981 render_context.italic = - render_context.style->Italic;
983 } else if (mystrcmp(&p, "kf") || mystrcmp(&p, "K")) {
984 int val = strtol(p, &p, 10);
985 render_context.effect_type = EF_KARAOKE_KF;
986 if (render_context.effect_timing)
987 render_context.effect_skip_timing += render_context.effect_timing;
988 render_context.effect_timing = val * 10;
989 } else if (mystrcmp(&p, "ko")) {
990 int val = strtol(p, &p, 10);
991 render_context.effect_type = EF_KARAOKE_KO;
992 if (render_context.effect_timing)
993 render_context.effect_skip_timing += render_context.effect_timing;
994 render_context.effect_timing = val * 10;
995 } else if (mystrcmp(&p, "k")) {
996 int val = strtol(p, &p, 10);
997 render_context.effect_type = EF_KARAOKE;
998 if (render_context.effect_timing)
999 render_context.effect_skip_timing += render_context.effect_timing;
1000 render_context.effect_timing = val * 10;
1001 } else if (mystrcmp(&p, "shad")) {
1003 if (mystrtoi(&p, 10, &val))
1004 render_context.shadow = val;
1006 render_context.shadow = render_context.style->Shadow;
1016 * \brief Get next ucs4 char from string, parsing and executing style overrides
1017 * \param str string pointer
1018 * \return ucs4 code of the next char
1019 * On return str points to the unparsed part of the string
1021 static unsigned get_next_char(char** str)
1025 if (*p == '{') { // '\0' goes here
1028 p = parse_tag(p, 1.);
1029 if (*p == '}') { // end of tag
1036 } else if (*p != '\\')
1037 mp_msg(MSGT_ASS, MSGL_V, "Unable to parse: \"%s\" \n", p);
1048 if ((*(p+1) == 'N') || ((*(p+1) == 'n') && (frame_context.track->WrapStyle == 2))) {
1052 } else if (*(p+1) == 'n') {
1058 chr = utf8_get_char(&p);
1063 static void apply_transition_effects(ass_event_t* event)
1067 char* p = event->Effect;
1069 if (!p || !*p) return;
1072 while (cnt < 4 && (p = strchr(p, ';'))) {
1073 v[cnt++] = atoi(++p);
1076 if (strncmp(event->Effect, "Banner;", 7) == 0) {
1079 mp_msg(MSGT_ASS, MSGL_V, "Error parsing effect: %s \n", event->Effect);
1082 if (cnt >= 2 && v[1] == 0) // right-to-left
1083 render_context.scroll_direction = SCROLL_RL;
1084 else // left-to-right
1085 render_context.scroll_direction = SCROLL_LR;
1088 if (delay == 0) delay = 1; // ?
1089 render_context.scroll_shift = (frame_context.time - render_context.event->Start) / delay;
1090 render_context.evt_type = EVENT_HSCROLL;
1094 if (strncmp(event->Effect, "Scroll up;", 10) == 0) {
1095 render_context.scroll_direction = SCROLL_BT;
1096 } else if (strncmp(event->Effect, "Scroll down;", 12) == 0) {
1097 render_context.scroll_direction = SCROLL_TB;
1099 mp_msg(MSGT_ASS, MSGL_V, "Unknown transition effect: %s \n", event->Effect);
1102 // parse scroll up/down parameters
1107 mp_msg(MSGT_ASS, MSGL_V, "Error parsing effect: %s \n", event->Effect);
1111 if (delay == 0) delay = 1; // ?
1112 render_context.scroll_shift = (frame_context.time - render_context.event->Start) / delay;
1114 y0 = v[0]; y1 = v[1];
1116 y0 = v[1]; y1 = v[0];
1119 y1 = frame_context.track->PlayResY; // y0=y1=0 means fullscreen scrolling
1120 render_context.clip_y0 = y0;
1121 render_context.clip_y1 = y1;
1122 render_context.evt_type = EVENT_VSCROLL;
1123 render_context.detect_collisions = 0;
1129 * \brief partially reset render_context to style values
1130 * Works like {\r}: resets some style overrides
1132 static void reset_render_context(void)
1134 render_context.c[0] = render_context.style->PrimaryColour;
1135 render_context.c[1] = render_context.style->SecondaryColour;
1136 render_context.c[2] = render_context.style->OutlineColour;
1137 render_context.c[3] = render_context.style->BackColour;
1138 render_context.font_size = render_context.style->FontSize;
1140 if (render_context.family)
1141 free(render_context.family);
1142 render_context.family = strdup(render_context.style->FontName);
1143 render_context.bold = - render_context.style->Bold;
1144 render_context.italic = - render_context.style->Italic;
1148 render_context.scale_x = render_context.style->ScaleX;
1149 render_context.scale_y = render_context.style->ScaleY;
1150 render_context.hspacing = 0; // FIXME
1151 render_context.be = 0;
1152 render_context.shadow = render_context.style->Shadow;
1154 // FIXME: does not reset unsupported attributes.
1158 * \brief Start new event. Reset render_context.
1160 static void init_render_context(ass_event_t* event)
1162 render_context.event = event;
1163 render_context.style = frame_context.track->styles + event->Style;
1165 reset_render_context();
1167 render_context.evt_type = EVENT_NORMAL;
1168 render_context.alignment = 0;
1169 render_context.rotation = M_PI * render_context.style->Angle / 180.;
1170 render_context.pos_x = 0;
1171 render_context.pos_y = 0;
1172 render_context.org_x = 0;
1173 render_context.org_y = 0;
1174 render_context.clip_x0 = 0;
1175 render_context.clip_y0 = 0;
1176 render_context.clip_x1 = frame_context.track->PlayResX;
1177 render_context.clip_y1 = frame_context.track->PlayResY;
1178 render_context.detect_collisions = 1;
1179 render_context.fade = 0;
1180 render_context.effect_type = EF_NONE;
1181 render_context.effect_timing = 0;
1182 render_context.effect_skip_timing = 0;
1184 apply_transition_effects(event);
1187 static void free_render_context(void)
1192 * \brief Get normal and outline glyphs from cache (if possible) or font face
1193 * \param index face glyph index
1194 * \param symbol ucs4 char
1195 * \param info out: struct filled with extracted data
1196 * \param advance advance vector of the extracted glyph
1197 * \return 0 on success
1199 static int get_glyph(int index, int symbol, glyph_info_t* info, FT_Vector* advance)
1202 glyph_hash_val_t* val;
1203 glyph_hash_key_t* key = &(info->hash_key);
1205 key->face = render_context.font->face;
1206 key->size = render_context.font_size;
1208 key->outline = (render_context.border * 0xFFFF); // convert to 16.16
1209 key->scale_x = (render_context.scale_x * 0xFFFF);
1210 key->scale_y = (render_context.scale_y * 0xFFFF);
1211 key->angle = (render_context.rotation * 0xFFFF);
1212 key->advance = *advance;
1213 key->bold = render_context.bold;
1214 key->italic = render_context.italic;
1215 key->be = render_context.be;
1217 val = cache_find_glyph(key);
1221 info->glyph = info->outline_glyph = 0;
1223 info->bm_o = val->bm_o;
1224 info->bm_s = val->bm_s;
1225 info->bbox = val->bbox_scaled;
1226 info->advance.x = val->advance.x;
1227 info->advance.y = val->advance.y;
1232 // not found, get a new outline glyph from face
1233 // mp_msg(MSGT_ASS, MSGL_INFO, "miss, index = %d, symbol = %c, adv = (%d, %d)\n", index, symbol, advance->x, advance->y);
1235 info->glyph = ass_font_get_glyph(frame_context.ass_priv->fontconfig_priv, render_context.font, symbol);
1239 info->advance.x = info->glyph->advance.x >> 10;
1240 info->advance.y = info->glyph->advance.y >> 10;
1242 if (render_context.stroker) {
1243 info->outline_glyph = info->glyph;
1244 error = FT_Glyph_Stroke( &(info->outline_glyph), render_context.stroker, 0 ); // don't destroy original
1246 mp_msg(MSGT_ASS, MSGL_WARN, MSGTR_LIBASS_FT_Glyph_Stroke_Error, error);
1249 info->outline_glyph = 0;
1252 info->bm = info->bm_o = info->bm_s = 0;
1258 * This function goes through text_info and calculates text parameters.
1259 * The following text_info fields are filled:
1266 static void measure_text()
1268 int cur_line = 0, max_asc = 0, max_desc = 0;
1270 text_info.height = 0;
1271 for (i = 0; i < text_info.length + 1; ++i) {
1272 if ((i == text_info.length) || text_info.glyphs[i].linebreak) {
1273 text_info.lines[cur_line].asc = max_asc;
1274 text_info.lines[cur_line].desc = max_desc;
1275 text_info.height += max_asc + max_desc;
1277 max_asc = max_desc = 0;
1279 if (i < text_info.length) {
1280 glyph_info_t* cur = text_info.glyphs + i;
1281 if (cur->asc > max_asc)
1282 max_asc = cur->asc * render_context.scale_y;
1283 if (cur->desc > max_desc)
1284 max_desc = cur->desc * render_context.scale_y;
1290 * \brief rearrange text between lines
1291 * \param max_text_width maximal text line width in pixels
1292 * The algo is similar to the one in libvo/sub.c:
1293 * 1. Place text, wrapping it when current line is full
1294 * 2. Try moving words from the end of a line to the beginning of the next one while it reduces
1295 * the difference in lengths between this two lines.
1296 * The result may not be optimal, but usually is good enough.
1298 static void wrap_lines_smart(int max_text_width)
1301 glyph_info_t *cur, *s1, *e1, *s2, *s3, *w;
1310 text_info.n_lines = 1;
1312 s1 = text_info.glyphs; // current line start
1313 for (i = 0; i < text_info.length; ++i) {
1314 int break_at, s_offset, len;
1315 cur = text_info.glyphs + i;
1317 s_offset = s1->bbox.xMin + s1->pos.x;
1318 len = (cur->bbox.xMax + cur->pos.x) - s_offset;
1320 if (cur->symbol == '\n') {
1323 mp_msg(MSGT_ASS, MSGL_DBG2, "forced line break at %d\n", break_at);
1326 if (len >= max_text_width) {
1328 break_at = last_space;
1333 mp_msg(MSGT_ASS, MSGL_DBG2, "overfill at %d\n", i);
1334 mp_msg(MSGT_ASS, MSGL_DBG2, "line break at %d\n", break_at);
1337 if (break_at != -1) {
1338 // need to use one more line
1339 // marking break_at+1 as start of a new line
1340 int lead = break_at + 1; // the first symbol of the new line
1341 if (text_info.n_lines >= MAX_LINES) {
1343 // no more linebreaks
1344 for (j = lead; j < text_info.length; ++j)
1345 text_info.glyphs[j].linebreak = 0;
1348 if (lead < text_info.length)
1349 text_info.glyphs[lead].linebreak = break_type;
1351 s1 = text_info.glyphs + lead;
1352 s_offset = s1->bbox.xMin + s1->pos.x;
1353 text_info.n_lines ++;
1356 if (cur->symbol == ' ')
1359 #define DIFF(x,y) (((x) < (y)) ? (y - x) : (x - y))
1363 w = s3 = text_info.glyphs;
1365 for (i = 0; i <= text_info.length; ++i) {
1366 cur = text_info.glyphs + i;
1367 if ((i == text_info.length) || cur->linebreak) {
1371 if (s1 && (s2->linebreak == 1)) { // have at least 2 lines, and linebreak is 'soft'
1372 int l1, l2, l1_new, l2_new;
1375 do { --w; } while ((w > s1) && (w->symbol == ' '));
1376 while ((w > s1) && (w->symbol != ' ')) { --w; }
1378 while ((e1 > s1) && (e1->symbol == ' ')) { --e1; }
1379 if (w->symbol == ' ') ++w;
1381 l1 = ((s2-1)->bbox.xMax + (s2-1)->pos.x) - (s1->bbox.xMin + s1->pos.x);
1382 l2 = ((s3-1)->bbox.xMax + (s3-1)->pos.x) - (s2->bbox.xMin + s2->pos.x);
1383 l1_new = (e1->bbox.xMax + e1->pos.x) - (s1->bbox.xMin + s1->pos.x);
1384 l2_new = ((s3-1)->bbox.xMax + (s3-1)->pos.x) - (w->bbox.xMin + w->pos.x);
1386 if (DIFF(l1_new, l2_new) < DIFF(l1, l2)) {
1393 if (i == text_info.length)
1398 assert(text_info.n_lines >= 1);
1406 for (i = 0; i < text_info.length; ++i) {
1407 cur = text_info.glyphs + i;
1408 if (cur->linebreak) {
1409 int height = text_info.lines[cur_line - 1].desc + text_info.lines[cur_line].asc;
1411 pen_shift_x = - cur->pos.x;
1412 pen_shift_y += (height >> 6) + global_settings->line_spacing;
1413 mp_msg(MSGT_ASS, MSGL_DBG2, "shifting from %d to %d by (%d, %d)\n", i, text_info.length - 1, pen_shift_x, pen_shift_y);
1415 cur->pos.x += pen_shift_x;
1416 cur->pos.y += pen_shift_y;
1421 * \brief determine karaoke effects
1422 * Karaoke effects cannot be calculated during parse stage (get_next_char()),
1423 * so they are done in a separate step.
1424 * Parse stage: when karaoke style override is found, its parameters are stored in the next glyph's
1425 * (the first glyph of the karaoke word)'s effect_type and effect_timing.
1427 * 1. sets effect_type for all glyphs in the word (_karaoke_ word)
1428 * 2. sets effect_timing for all glyphs to x coordinate of the border line between the left and right karaoke parts
1429 * (left part is filled with PrimaryColour, right one - with SecondaryColour).
1431 static void process_karaoke_effects(void)
1433 glyph_info_t *cur, *cur2;
1434 glyph_info_t *s1, *e1; // start and end of the current word
1435 glyph_info_t *s2; // start of the next word
1437 int timing; // current timing
1438 int tm_start, tm_end; // timings at start and end of the current word
1444 tm_current = frame_context.time - render_context.event->Start;
1447 for (i = 0; i <= text_info.length; ++i) {
1448 cur = text_info.glyphs + i;
1449 if ((i == text_info.length) || (cur->effect_type != EF_NONE)) {
1454 tm_start = timing + s1->effect_skip_timing;
1455 tm_end = tm_start + s1->effect_timing;
1459 for (cur2 = s1; cur2 <= e1; ++cur2) {
1460 x_start = FFMIN(x_start, cur2->bbox.xMin + cur2->pos.x);
1461 x_end = FFMAX(x_end, cur2->bbox.xMax + cur2->pos.x);
1464 dt = (tm_current - tm_start);
1465 if ((s1->effect_type == EF_KARAOKE) || (s1->effect_type == EF_KARAOKE_KO)) {
1470 } else if (s1->effect_type == EF_KARAOKE_KF) {
1471 dt /= (tm_end - tm_start);
1472 x = x_start + (x_end - x_start) * dt;
1474 mp_msg(MSGT_ASS, MSGL_ERR, MSGTR_LIBASS_UnknownEffectType_InternalError);
1478 for (cur2 = s1; cur2 <= e1; ++cur2) {
1479 cur2->effect_type = s1->effect_type;
1480 cur2->effect_timing = x - cur2->pos.x;
1487 static int get_face_ascender(FT_Face face)
1489 int v = face->size->metrics.ascender;
1490 int v2 = FT_MulFix(face->bbox.yMax, face->size->metrics.y_scale);
1497 static int get_face_descender(FT_Face face)
1499 int v = - face->size->metrics.descender;
1500 int v2 = - FT_MulFix(face->bbox.yMin, face->size->metrics.y_scale);
1508 * \brief Calculate base point for positioning and rotation
1509 * \param bbox text bbox
1510 * \param alignment alignment
1511 * \param bx, by out: base point coordinates
1513 static void get_base_point(FT_BBox bbox, int alignment, int* bx, int* by)
1515 const int halign = alignment & 3;
1516 const int valign = alignment & 12;
1523 *bx = (bbox.xMax + bbox.xMin) / 2;
1535 *by = (bbox.yMax + bbox.yMin) / 2;
1544 * \brief Main ass rendering function, glues everything together
1545 * \param event event to render
1546 * Process event, appending resulting ass_image_t's to images_root.
1548 static int ass_render_event(ass_event_t* event, event_images_t* event_images)
1551 FT_UInt glyph_index;
1552 FT_Bool use_kerning;
1561 int MarginL, MarginR, MarginV;
1563 int alignment, halign, valign;
1564 int device_x = 0, device_y = 0;
1566 if (event->Style >= frame_context.track->n_styles) {
1567 mp_msg(MSGT_ASS, MSGL_WARN, MSGTR_LIBASS_NoStyleFound);
1571 mp_msg(MSGT_ASS, MSGL_WARN, MSGTR_LIBASS_EmptyEvent);
1575 init_render_context(event);
1577 text_info.length = 0;
1585 // get next char, executing style override
1586 // this affects render_context
1587 code = get_next_char(&p);
1589 // face could have been changed in get_next_char
1590 if (!render_context.font) {
1591 free_render_context();
1598 use_kerning = FT_HAS_KERNING(render_context.font->face);
1600 if (text_info.length >= MAX_GLYPHS) {
1601 mp_msg(MSGT_ASS, MSGL_WARN, MSGTR_LIBASS_MAX_GLYPHS_Reached,
1602 (int)(event - frame_context.track->events), event->Start, event->Duration, event->Text);
1606 glyph_index = FT_Get_Char_Index( render_context.font->face, code);
1608 if ( use_kerning && previous && glyph_index ) {
1610 FT_Get_Kerning( render_context.font->face, previous, glyph_index, FT_KERNING_DEFAULT, &delta );
1611 pen.x += delta.x * render_context.scale_x;
1612 pen.y += delta.y * render_context.scale_y;
1615 shift.x = pen.x & 63;
1616 shift.y = pen.y & 63;
1620 matrix.xx = (FT_Fixed)( render_context.scale_x * frame_context.font_scale_x * 0x10000L );
1621 matrix.xy = (FT_Fixed)( 0 * 0x10000L );
1622 matrix.yx = (FT_Fixed)( 0 * 0x10000L );
1623 matrix.yy = (FT_Fixed)( render_context.scale_y * 0x10000L );
1625 ass_font_set_transform(render_context.font, &matrix, &shift );
1628 error = get_glyph(glyph_index, code, text_info.glyphs + text_info.length, &shift);
1634 text_info.glyphs[text_info.length].pos.x = pen.x >> 6;
1635 text_info.glyphs[text_info.length].pos.y = pen.y >> 6;
1637 pen.x += text_info.glyphs[text_info.length].advance.x;
1638 pen.x += render_context.hspacing;
1639 pen.y += text_info.glyphs[text_info.length].advance.y;
1641 // if it's an outline glyph, we still need to fill the bbox
1642 if (text_info.glyphs[text_info.length].glyph) {
1643 FT_Glyph_Get_CBox( text_info.glyphs[text_info.length].glyph, FT_GLYPH_BBOX_PIXELS, &(text_info.glyphs[text_info.length].bbox) );
1647 previous = glyph_index;
1649 text_info.glyphs[text_info.length].symbol = code;
1650 text_info.glyphs[text_info.length].linebreak = 0;
1651 for (i = 0; i < 4; ++i) {
1652 uint32_t clr = render_context.c[i];
1653 change_alpha(&clr, mult_alpha(_a(clr), render_context.fade), 1.);
1654 text_info.glyphs[text_info.length].c[i] = clr;
1656 text_info.glyphs[text_info.length].effect_type = render_context.effect_type;
1657 text_info.glyphs[text_info.length].effect_timing = render_context.effect_timing;
1658 text_info.glyphs[text_info.length].effect_skip_timing = render_context.effect_skip_timing;
1659 text_info.glyphs[text_info.length].asc = get_face_ascender(render_context.font->face);
1660 text_info.glyphs[text_info.length].desc = get_face_descender(render_context.font->face);
1661 text_info.glyphs[text_info.length].be = render_context.be;
1662 text_info.glyphs[text_info.length].shadow = render_context.shadow;
1663 text_info.glyphs[text_info.length].frz = render_context.rotation;
1667 render_context.effect_type = EF_NONE;
1668 render_context.effect_timing = 0;
1669 render_context.effect_skip_timing = 0;
1672 if (text_info.length == 0) {
1673 // no valid symbols in the event; this can be smth like {comment}
1674 free_render_context();
1678 // depends on glyph x coordinates being monotonous, so it should be done before line wrap
1679 process_karaoke_effects();
1682 alignment = render_context.alignment;
1684 alignment = render_context.style->Alignment;
1685 halign = alignment & 3;
1686 valign = alignment & 12;
1688 MarginL = (event->MarginL) ? event->MarginL : render_context.style->MarginL;
1689 MarginR = (event->MarginR) ? event->MarginR : render_context.style->MarginR;
1690 MarginV = (event->MarginV) ? event->MarginV : render_context.style->MarginV;
1692 if (render_context.evt_type != EVENT_HSCROLL) {
1695 // calculate max length of a line
1696 max_text_width = x2scr(frame_context.track->PlayResX - MarginR) - x2scr(MarginL);
1698 // rearrange text in several lines
1699 wrap_lines_smart(max_text_width);
1703 for (i = 1; i < text_info.length + 1; ++i) { // (text_info.length + 1) is the end of the last line
1704 if ((i == text_info.length) || text_info.glyphs[i].linebreak) {
1706 glyph_info_t* first_glyph = text_info.glyphs + last_break + 1;
1707 glyph_info_t* last_glyph = text_info.glyphs + i - 1;
1709 while ((last_glyph > first_glyph) && ((last_glyph->symbol == '\n') || (last_glyph->symbol == 0)))
1712 width = last_glyph->pos.x + last_glyph->bbox.xMax - first_glyph->pos.x - first_glyph->bbox.xMin;
1713 shift = - first_glyph->bbox.xMin; // now text line starts exactly at 0 (left margin)
1714 if (halign == HALIGN_LEFT) { // left aligned, no action
1715 } else if (halign == HALIGN_RIGHT) { // right aligned
1716 shift = max_text_width - width;
1717 } else if (halign == HALIGN_CENTER) { // centered
1718 shift = (max_text_width - width) / 2;
1720 for (j = last_break + 1; j < i; ++j) {
1721 text_info.glyphs[j].pos.x += shift;
1726 } else { // render_context.evt_type == EVENT_HSCROLL
1730 // determing text bounding box
1731 compute_string_bbox(&text_info, &bbox);
1733 // determine device coordinates for text
1735 // x coordinate for everything except positioned events
1736 if (render_context.evt_type == EVENT_NORMAL ||
1737 render_context.evt_type == EVENT_VSCROLL) {
1738 device_x = x2scr(MarginL);
1739 } else if (render_context.evt_type == EVENT_HSCROLL) {
1740 if (render_context.scroll_direction == SCROLL_RL)
1741 device_x = x2scr(frame_context.track->PlayResX - render_context.scroll_shift);
1742 else if (render_context.scroll_direction == SCROLL_LR)
1743 device_x = x2scr(render_context.scroll_shift) - (bbox.xMax - bbox.xMin);
1746 // y coordinate for everything except positioned events
1747 if (render_context.evt_type == EVENT_NORMAL ||
1748 render_context.evt_type == EVENT_HSCROLL) {
1749 if (valign == VALIGN_TOP) { // toptitle
1750 device_y = y2scr_top(MarginV) + (text_info.lines[0].asc >> 6);
1751 } else if (valign == VALIGN_CENTER) { // midtitle
1752 int scr_y = y2scr(frame_context.track->PlayResY / 2);
1753 device_y = scr_y - (bbox.yMax - bbox.yMin) / 2;
1754 } else { // subtitle
1756 if (valign != VALIGN_SUB)
1757 mp_msg(MSGT_ASS, MSGL_V, "Invalid valign, supposing 0 (subtitle)\n");
1758 scr_y = y2scr_sub(frame_context.track->PlayResY - MarginV);
1760 device_y -= (text_info.height >> 6);
1761 device_y += (text_info.lines[0].asc >> 6);
1763 } else if (render_context.evt_type == EVENT_VSCROLL) {
1764 if (render_context.scroll_direction == SCROLL_TB)
1765 device_y = y2scr(render_context.clip_y0 + render_context.scroll_shift) - (bbox.yMax - bbox.yMin);
1766 else if (render_context.scroll_direction == SCROLL_BT)
1767 device_y = y2scr(render_context.clip_y1 - render_context.scroll_shift);
1770 // positioned events are totally different
1771 if (render_context.evt_type == EVENT_POSITIONED) {
1774 mp_msg(MSGT_ASS, MSGL_DBG2, "positioned event at %d, %d\n", render_context.pos_x, render_context.pos_y);
1775 get_base_point(bbox, alignment, &base_x, &base_y);
1776 device_x = x2scr(render_context.pos_x) - base_x;
1777 device_y = y2scr(render_context.pos_y) - base_y;
1780 // fix clip coordinates (they depend on alignment)
1781 render_context.clip_x0 = x2scr(render_context.clip_x0);
1782 render_context.clip_x1 = x2scr(render_context.clip_x1);
1783 if (render_context.evt_type == EVENT_NORMAL ||
1784 render_context.evt_type == EVENT_HSCROLL ||
1785 render_context.evt_type == EVENT_VSCROLL) {
1786 if (valign == VALIGN_TOP) {
1787 render_context.clip_y0 = y2scr_top(render_context.clip_y0);
1788 render_context.clip_y1 = y2scr_top(render_context.clip_y1);
1789 } else if (valign == VALIGN_CENTER) {
1790 render_context.clip_y0 = y2scr(render_context.clip_y0);
1791 render_context.clip_y1 = y2scr(render_context.clip_y1);
1792 } else if (valign == VALIGN_SUB) {
1793 render_context.clip_y0 = y2scr_sub(render_context.clip_y0);
1794 render_context.clip_y1 = y2scr_sub(render_context.clip_y1);
1796 } else if (render_context.evt_type == EVENT_POSITIONED) {
1797 render_context.clip_y0 = y2scr(render_context.clip_y0);
1798 render_context.clip_y1 = y2scr(render_context.clip_y1);
1801 // rotate glyphs if needed
1805 FT_Matrix matrix_rotate;
1807 if (((render_context.org_x != 0) || (render_context.org_y != 0)) && (render_context.evt_type == EVENT_POSITIONED)) {
1808 center.x = render_context.org_x;
1809 center.y = render_context.org_y;
1812 get_base_point(bbox, alignment, &bx, &by);
1813 center.x = device_x + bx;
1814 center.y = device_y + by;
1817 for (i = 0; i < text_info.length; ++i) {
1819 FT_Vector start_old;
1820 glyph_info_t* info = text_info.glyphs + i;
1822 if (info->frz < 0.00001 && info->frz > -0.00001)
1825 if (info->frz != angle) {
1827 matrix_rotate.xx = (FT_Fixed)( cos( angle ) * 0x10000L );
1828 matrix_rotate.xy = (FT_Fixed)( -sin( angle ) * 0x10000L );
1829 matrix_rotate.yx = (FT_Fixed)( sin( angle ) * 0x10000L );
1830 matrix_rotate.yy = (FT_Fixed)( cos( angle ) * 0x10000L );
1833 // calculating shift vector
1834 // shift = (position - center)*M - (position - center)
1835 start.x = (info->pos.x + device_x - center.x) << 6;
1836 start.y = - (info->pos.y + device_y - center.y) << 6;
1837 start_old.x = start.x;
1838 start_old.y = start.y;
1840 FT_Vector_Transform(&start, &matrix_rotate);
1842 start.x -= start_old.x;
1843 start.y -= start_old.y;
1845 info->pos.x += start.x >> 6;
1846 info->pos.y -= start.y >> 6;
1849 FT_Glyph_Transform( info->glyph, &matrix_rotate, 0 );
1850 if (info->outline_glyph)
1851 FT_Glyph_Transform( info->outline_glyph, &matrix_rotate, 0 );
1855 event_images->top = device_y - (text_info.lines[0].asc >> 6);
1856 event_images->height = text_info.height >> 6;
1857 event_images->detect_collisions = render_context.detect_collisions;
1858 event_images->shift_direction = (valign == VALIGN_TOP) ? 1 : -1;
1859 event_images->event = event;
1860 event_images->imgs = render_text(&text_info, device_x, device_y);
1862 free_render_context();
1867 static void ass_reconfigure(ass_renderer_t* priv)
1869 priv->render_id = ++last_render_id;
1870 ass_glyph_cache_reset();
1873 void ass_set_frame_size(ass_renderer_t* priv, int w, int h)
1875 if (priv->settings.frame_width != w || priv->settings.frame_height != h) {
1876 priv->settings.frame_width = w;
1877 priv->settings.frame_height = h;
1878 if (priv->settings.aspect == 0.)
1879 priv->settings.aspect = ((double)w) / h;
1880 ass_reconfigure(priv);
1884 void ass_set_margins(ass_renderer_t* priv, int t, int b, int l, int r)
1886 if (priv->settings.left_margin != l ||
1887 priv->settings.right_margin != r ||
1888 priv->settings.top_margin != t ||
1889 priv->settings.bottom_margin != b) {
1890 priv->settings.left_margin = l;
1891 priv->settings.right_margin = r;
1892 priv->settings.top_margin = t;
1893 priv->settings.bottom_margin = b;
1894 ass_reconfigure(priv);
1898 void ass_set_use_margins(ass_renderer_t* priv, int use)
1900 priv->settings.use_margins = use;
1903 void ass_set_aspect_ratio(ass_renderer_t* priv, double ar)
1905 if (priv->settings.aspect != ar) {
1906 priv->settings.aspect = ar;
1907 ass_reconfigure(priv);
1911 void ass_set_font_scale(ass_renderer_t* priv, double font_scale)
1913 if (priv->settings.font_size_coeff != font_scale) {
1914 priv->settings.font_size_coeff = font_scale;
1915 ass_reconfigure(priv);
1919 int ass_set_fonts(ass_renderer_t* priv, const char* default_font, const char* default_family)
1921 if (priv->settings.default_font)
1922 free(priv->settings.default_font);
1923 if (priv->settings.default_family)
1924 free(priv->settings.default_family);
1926 priv->settings.default_font = default_font ? strdup(default_font) : 0;
1927 priv->settings.default_family = default_family ? strdup(default_family) : 0;
1929 if (priv->fontconfig_priv)
1930 fontconfig_done(priv->fontconfig_priv);
1931 priv->fontconfig_priv = fontconfig_init(priv->library->fonts_dir, default_family, default_font);
1933 return !!priv->fontconfig_priv;
1937 * \brief Start a new frame
1939 static int ass_start_frame(ass_renderer_t *priv, ass_track_t* track, long long now)
1943 ass_renderer = priv;
1944 global_settings = &priv->settings;
1946 if (!priv->settings.frame_width && !priv->settings.frame_height)
1947 return 1; // library not initialized
1949 frame_context.ass_priv = priv;
1950 frame_context.width = global_settings->frame_width;
1951 frame_context.height = global_settings->frame_height;
1952 frame_context.orig_width = global_settings->frame_width - global_settings->left_margin - global_settings->right_margin;
1953 frame_context.orig_height = global_settings->frame_height - global_settings->top_margin - global_settings->bottom_margin;
1954 frame_context.track = track;
1955 frame_context.time = now;
1957 ass_lazy_track_init();
1959 frame_context.font_scale = global_settings->font_size_coeff * ass_internal_font_size_coeff *
1960 frame_context.orig_height / frame_context.track->PlayResY;
1961 frame_context.border_scale = ((double)frame_context.orig_height) / frame_context.track->PlayResY;
1963 if (frame_context.orig_width * track->PlayResY == frame_context.orig_height * track->PlayResX)
1964 frame_context.font_scale_x = 1.;
1966 frame_context.font_scale_x = ((double)(frame_context.orig_width * track->PlayResY)) / (frame_context.orig_height * track->PlayResX);
1968 img = priv->images_root;
1970 ass_image_t* next = img->next;
1974 priv->images_root = 0;
1979 static int cmp_event_layer(const void* p1, const void* p2)
1981 ass_event_t* e1 = ((event_images_t*)p1)->event;
1982 ass_event_t* e2 = ((event_images_t*)p2)->event;
1983 if (e1->Layer < e2->Layer)
1985 if (e1->Layer > e2->Layer)
1987 if (e1->Start < e2->Start)
1989 if (e1->Start > e2->Start)
1991 if (e1->ReadOrder < e2->ReadOrder)
1993 if (e1->ReadOrder > e2->ReadOrder)
1998 #define MAX_EVENTS 100
2000 static render_priv_t* get_render_priv(ass_event_t* event)
2002 if (!event->render_priv)
2003 event->render_priv = calloc(1, sizeof(render_priv_t));
2004 // FIXME: check render_id
2005 if (ass_renderer->render_id != event->render_priv->render_id) {
2006 memset(event->render_priv, 0, sizeof(render_priv_t));
2007 event->render_priv->render_id = ass_renderer->render_id;
2009 return event->render_priv;
2012 typedef struct segment_s {
2013 int a, b; // top and height
2016 static int overlap(segment_t* s1, segment_t* s2)
2018 if (s1->a >= s2->b || s2->a >= s1->b)
2023 static int cmp_segment(const void* p1, const void* p2)
2025 return ((segment_t*)p1)->a - ((segment_t*)p2)->a;
2028 static void shift_event(event_images_t* ei, int shift)
2030 ass_image_t* cur = ei->imgs;
2032 cur->dst_y += shift;
2033 // clip top and bottom
2034 if (cur->dst_y < 0) {
2035 int clip = - cur->dst_y;
2037 cur->bitmap += clip * cur->stride;
2040 if (cur->dst_y + cur->h >= frame_context.height) {
2041 int clip = cur->dst_y + cur->h - frame_context.height;
2053 // dir: 1 - move down
2055 static int fit_segment(segment_t* s, segment_t* fixed, int* cnt, int dir)
2060 if (dir == 1) // move down
2061 for (i = 0; i < *cnt; ++i) {
2062 if (s->b + shift <= fixed[i].a || s->a + shift >= fixed[i].b)
2064 shift = fixed[i].b - s->a;
2066 else // dir == -1, move up
2067 for (i = *cnt-1; i >= 0; --i) {
2068 if (s->b + shift <= fixed[i].a || s->a + shift >= fixed[i].b)
2070 shift = fixed[i].a - s->b;
2073 fixed[*cnt].a = s->a + shift;
2074 fixed[*cnt].b = s->b + shift;
2076 qsort(fixed, *cnt, sizeof(segment_t), cmp_segment);
2081 static void fix_collisions(event_images_t* imgs, int cnt)
2083 segment_t used[MAX_EVENTS];
2087 // fill used[] with fixed events
2088 for (i = 0; i < cnt; ++i) {
2089 render_priv_t* priv;
2090 if (!imgs[i].detect_collisions) continue;
2091 priv = get_render_priv(imgs[i].event);
2092 if (priv->height > 0) { // it's a fixed event
2095 s.b = priv->top + priv->height;
2096 if (priv->height != imgs[i].height) { // no, it's not
2097 mp_msg(MSGT_ASS, MSGL_WARN, MSGTR_LIBASS_EventHeightHasChanged);
2101 for (j = 0; j < cnt_used; ++j)
2102 if (overlap(&s, used + j)) { // no, it's not
2106 if (priv->height > 0) { // still a fixed event
2107 used[cnt_used].a = priv->top;
2108 used[cnt_used].b = priv->top + priv->height;
2110 shift_event(imgs + i, priv->top - imgs[i].top);
2114 qsort(used, cnt_used, sizeof(segment_t), cmp_segment);
2116 // try to fit other events in free spaces
2117 for (i = 0; i < cnt; ++i) {
2118 render_priv_t* priv;
2119 if (!imgs[i].detect_collisions) continue;
2120 priv = get_render_priv(imgs[i].event);
2121 if (priv->height == 0) { // not a fixed event
2125 s.b = imgs[i].top + imgs[i].height;
2126 shift = fit_segment(&s, used, &cnt_used, imgs[i].shift_direction);
2127 if (shift) shift_event(imgs + i, shift);
2129 priv->top = imgs[i].top;
2130 priv->height = imgs[i].height;
2137 * \brief render a frame
2138 * \param priv library handle
2139 * \param track track
2140 * \param now current video timestamp (ms)
2142 ass_image_t* ass_render_frame(ass_renderer_t *priv, ass_track_t* track, long long now)
2145 event_images_t eimg[MAX_EVENTS];
2146 event_images_t* last;
2150 rc = ass_start_frame(priv, track, now);
2154 // render events separately
2156 for (i = 0; i < track->n_events; ++i) {
2157 ass_event_t* event = track->events + i;
2158 if ( (event->Start <= now) && (now < (event->Start + event->Duration)) ) {
2159 if (cnt < MAX_EVENTS) {
2160 rc = ass_render_event(event, eimg + cnt);
2163 mp_msg(MSGT_ASS, MSGL_WARN, MSGTR_LIBASS_TooManySimultaneousEvents);
2170 qsort(eimg, cnt, sizeof(event_images_t), cmp_event_layer);
2172 // call fix_collisions for each group of events with the same layer
2174 for (i = 1; i < cnt; ++i)
2175 if (last->event->Layer != eimg[i].event->Layer) {
2176 fix_collisions(last, eimg + i - last);
2180 fix_collisions(last, eimg + cnt - last);
2183 tail = &ass_renderer->images_root;
2184 for (i = 0; i < cnt; ++i) {
2185 ass_image_t* cur = eimg[i].imgs;
2193 return ass_renderer->images_root;