Disable currently unused bitmap run code
[libass.git] / libass / ass_render.c
blob6a5c9adba79762b3dc426a9a746afc514985ffa0
1 /*
2 * Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
4 * This file is part of libass.
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19 #include "config.h"
21 #include <assert.h>
22 #include <math.h>
24 #include "ass_render.h"
25 #include "ass_parse.h"
26 #include "ass_shaper.h"
28 #define MAX_GLYPHS_INITIAL 1024
29 #define MAX_LINES_INITIAL 64
30 #define SUBPIXEL_MASK 63
31 #define SUBPIXEL_ACCURACY 7
33 ASS_Renderer *ass_renderer_init(ASS_Library *library)
35 int error;
36 FT_Library ft;
37 ASS_Renderer *priv = 0;
38 int vmajor, vminor, vpatch;
40 error = FT_Init_FreeType(&ft);
41 if (error) {
42 ass_msg(library, MSGL_FATAL, "%s failed", "FT_Init_FreeType");
43 goto ass_init_exit;
46 FT_Library_Version(ft, &vmajor, &vminor, &vpatch);
47 ass_msg(library, MSGL_V, "FreeType library version: %d.%d.%d",
48 vmajor, vminor, vpatch);
49 ass_msg(library, MSGL_V, "FreeType headers version: %d.%d.%d",
50 FREETYPE_MAJOR, FREETYPE_MINOR, FREETYPE_PATCH);
52 priv = calloc(1, sizeof(ASS_Renderer));
53 if (!priv) {
54 FT_Done_FreeType(ft);
55 goto ass_init_exit;
58 priv->synth_priv = ass_synth_init(BLUR_MAX_RADIUS);
60 priv->library = library;
61 priv->ftlibrary = ft;
62 // images_root and related stuff is zero-filled in calloc
64 priv->cache.font_cache = ass_font_cache_create();
65 priv->cache.bitmap_cache = ass_bitmap_cache_create();
66 priv->cache.composite_cache = ass_composite_cache_create();
67 priv->cache.outline_cache = ass_outline_cache_create();
68 priv->cache.glyph_max = GLYPH_CACHE_MAX;
69 priv->cache.bitmap_max_size = BITMAP_CACHE_MAX_SIZE;
71 priv->text_info.max_glyphs = MAX_GLYPHS_INITIAL;
72 priv->text_info.max_lines = MAX_LINES_INITIAL;
73 priv->text_info.glyphs = calloc(MAX_GLYPHS_INITIAL, sizeof(GlyphInfo));
74 priv->text_info.lines = calloc(MAX_LINES_INITIAL, sizeof(LineInfo));
76 priv->settings.font_size_coeff = 1.;
78 priv->shaper = ass_shaper_new(0);
79 ass_shaper_info(library);
81 ass_init_exit:
82 if (priv)
83 ass_msg(library, MSGL_V, "Init");
84 else
85 ass_msg(library, MSGL_ERR, "Init failed");
87 return priv;
90 static void free_list_clear(ASS_Renderer *render_priv)
92 if (render_priv->free_head) {
93 FreeList *item = render_priv->free_head;
94 while(item) {
95 FreeList *oi = item;
96 free(item->object);
97 item = item->next;
98 free(oi);
100 render_priv->free_head = NULL;
104 void ass_renderer_done(ASS_Renderer *render_priv)
106 ass_cache_done(render_priv->cache.font_cache);
107 ass_cache_done(render_priv->cache.bitmap_cache);
108 ass_cache_done(render_priv->cache.composite_cache);
109 ass_cache_done(render_priv->cache.outline_cache);
111 ass_free_images(render_priv->images_root);
112 ass_free_images(render_priv->prev_images_root);
114 if (render_priv->state.stroker) {
115 FT_Stroker_Done(render_priv->state.stroker);
116 render_priv->state.stroker = 0;
118 if (render_priv->ftlibrary)
119 FT_Done_FreeType(render_priv->ftlibrary);
120 if (render_priv->fontconfig_priv)
121 fontconfig_done(render_priv->fontconfig_priv);
122 if (render_priv->synth_priv)
123 ass_synth_done(render_priv->synth_priv);
124 ass_shaper_free(render_priv->shaper);
125 free(render_priv->eimg);
126 free(render_priv->text_info.glyphs);
127 free(render_priv->text_info.lines);
129 free(render_priv->settings.default_font);
130 free(render_priv->settings.default_family);
132 free_list_clear(render_priv);
133 free(render_priv);
137 * \brief Create a new ASS_Image
138 * Parameters are the same as ASS_Image fields.
140 static ASS_Image *my_draw_bitmap(unsigned char *bitmap, int bitmap_w,
141 int bitmap_h, int stride, int dst_x,
142 int dst_y, uint32_t color)
144 ASS_Image *img = malloc(sizeof(ASS_Image));
146 if (img) {
147 img->w = bitmap_w;
148 img->h = bitmap_h;
149 img->stride = stride;
150 img->bitmap = bitmap;
151 img->color = color;
152 img->dst_x = dst_x;
153 img->dst_y = dst_y;
156 return img;
160 * \brief Mapping between script and screen coordinates
162 static double x2scr(ASS_Renderer *render_priv, double x)
164 return x * render_priv->orig_width_nocrop / render_priv->font_scale_x /
165 render_priv->track->PlayResX +
166 FFMAX(render_priv->settings.left_margin, 0);
168 static double x2scr_pos(ASS_Renderer *render_priv, double x)
170 return x * render_priv->orig_width / render_priv->font_scale_x / render_priv->track->PlayResX +
171 render_priv->settings.left_margin;
173 static double x2scr_scaled(ASS_Renderer *render_priv, double x)
175 return x * render_priv->orig_width_nocrop /
176 render_priv->track->PlayResX +
177 FFMAX(render_priv->settings.left_margin, 0);
179 static double x2scr_pos_scaled(ASS_Renderer *render_priv, double x)
181 return x * render_priv->orig_width / render_priv->track->PlayResX +
182 render_priv->settings.left_margin;
185 * \brief Mapping between script and screen coordinates
187 static double y2scr(ASS_Renderer *render_priv, double y)
189 return y * render_priv->orig_height_nocrop /
190 render_priv->track->PlayResY +
191 FFMAX(render_priv->settings.top_margin, 0);
193 static double y2scr_pos(ASS_Renderer *render_priv, double y)
195 return y * render_priv->orig_height / render_priv->track->PlayResY +
196 render_priv->settings.top_margin;
199 // the same for toptitles
200 static double y2scr_top(ASS_Renderer *render_priv, double y)
202 if (render_priv->settings.use_margins)
203 return y * render_priv->orig_height_nocrop /
204 render_priv->track->PlayResY;
205 else
206 return y * render_priv->orig_height_nocrop /
207 render_priv->track->PlayResY +
208 FFMAX(render_priv->settings.top_margin, 0);
210 // the same for subtitles
211 static double y2scr_sub(ASS_Renderer *render_priv, double y)
213 if (render_priv->settings.use_margins)
214 return y * render_priv->orig_height_nocrop /
215 render_priv->track->PlayResY +
216 FFMAX(render_priv->settings.top_margin, 0)
217 + FFMAX(render_priv->settings.bottom_margin, 0);
218 else
219 return y * render_priv->orig_height_nocrop /
220 render_priv->track->PlayResY +
221 FFMAX(render_priv->settings.top_margin, 0);
225 * \brief Convert bitmap glyphs into ASS_Image list with inverse clipping
227 * Inverse clipping with the following strategy:
228 * - find rectangle from (x0, y0) to (cx0, y1)
229 * - find rectangle from (cx0, y0) to (cx1, cy0)
230 * - find rectangle from (cx0, cy1) to (cx1, y1)
231 * - find rectangle from (cx1, y0) to (x1, y1)
232 * These rectangles can be invalid and in this case are discarded.
233 * Afterwards, they are clipped against the screen coordinates.
234 * In an additional pass, the rectangles need to be split up left/right for
235 * karaoke effects. This can result in a lot of bitmaps (6 to be exact).
237 static ASS_Image **render_glyph_i(ASS_Renderer *render_priv,
238 Bitmap *bm, int dst_x, int dst_y,
239 uint32_t color, uint32_t color2, int brk,
240 ASS_Image **tail)
242 int i, j, x0, y0, x1, y1, cx0, cy0, cx1, cy1, sx, sy, zx, zy;
243 Rect r[4];
244 ASS_Image *img;
246 dst_x += bm->left;
247 dst_y += bm->top;
249 // we still need to clip against screen boundaries
250 zx = x2scr_pos_scaled(render_priv, 0);
251 zy = y2scr_pos(render_priv, 0);
252 sx = x2scr_pos_scaled(render_priv, render_priv->track->PlayResX);
253 sy = y2scr_pos(render_priv, render_priv->track->PlayResY);
255 x0 = 0;
256 y0 = 0;
257 x1 = bm->w;
258 y1 = bm->h;
259 cx0 = render_priv->state.clip_x0 - dst_x;
260 cy0 = render_priv->state.clip_y0 - dst_y;
261 cx1 = render_priv->state.clip_x1 - dst_x;
262 cy1 = render_priv->state.clip_y1 - dst_y;
264 // calculate rectangles and discard invalid ones while we're at it.
265 i = 0;
266 r[i].x0 = x0;
267 r[i].y0 = y0;
268 r[i].x1 = (cx0 > x1) ? x1 : cx0;
269 r[i].y1 = y1;
270 if (r[i].x1 > r[i].x0 && r[i].y1 > r[i].y0) i++;
271 r[i].x0 = (cx0 < 0) ? x0 : cx0;
272 r[i].y0 = y0;
273 r[i].x1 = (cx1 > x1) ? x1 : cx1;
274 r[i].y1 = (cy0 > y1) ? y1 : cy0;
275 if (r[i].x1 > r[i].x0 && r[i].y1 > r[i].y0) i++;
276 r[i].x0 = (cx0 < 0) ? x0 : cx0;
277 r[i].y0 = (cy1 < 0) ? y0 : cy1;
278 r[i].x1 = (cx1 > x1) ? x1 : cx1;
279 r[i].y1 = y1;
280 if (r[i].x1 > r[i].x0 && r[i].y1 > r[i].y0) i++;
281 r[i].x0 = (cx1 < 0) ? x0 : cx1;
282 r[i].y0 = y0;
283 r[i].x1 = x1;
284 r[i].y1 = y1;
285 if (r[i].x1 > r[i].x0 && r[i].y1 > r[i].y0) i++;
287 // clip each rectangle to screen coordinates
288 for (j = 0; j < i; j++) {
289 r[j].x0 = (r[j].x0 + dst_x < zx) ? zx - dst_x : r[j].x0;
290 r[j].y0 = (r[j].y0 + dst_y < zy) ? zy - dst_y : r[j].y0;
291 r[j].x1 = (r[j].x1 + dst_x > sx) ? sx - dst_x : r[j].x1;
292 r[j].y1 = (r[j].y1 + dst_y > sy) ? sy - dst_y : r[j].y1;
295 // draw the rectangles
296 for (j = 0; j < i; j++) {
297 int lbrk = brk;
298 // kick out rectangles that are invalid now
299 if (r[j].x1 <= r[j].x0 || r[j].y1 <= r[j].y0)
300 continue;
301 // split up into left and right for karaoke, if needed
302 if (lbrk > r[j].x0) {
303 if (lbrk > r[j].x1) lbrk = r[j].x1;
304 img = my_draw_bitmap(bm->buffer + r[j].y0 * bm->stride + r[j].x0,
305 lbrk - r[j].x0, r[j].y1 - r[j].y0,
306 bm->stride, dst_x + r[j].x0, dst_y + r[j].y0, color);
307 if (!img) break;
308 *tail = img;
309 tail = &img->next;
311 if (lbrk < r[j].x1) {
312 if (lbrk < r[j].x0) lbrk = r[j].x0;
313 img = my_draw_bitmap(bm->buffer + r[j].y0 * bm->stride + lbrk,
314 r[j].x1 - lbrk, r[j].y1 - r[j].y0,
315 bm->stride, dst_x + lbrk, dst_y + r[j].y0, color2);
316 if (!img) break;
317 *tail = img;
318 tail = &img->next;
322 return tail;
326 * \brief convert bitmap glyph into ASS_Image struct(s)
327 * \param bit freetype bitmap glyph, FT_PIXEL_MODE_GRAY
328 * \param dst_x bitmap x coordinate in video frame
329 * \param dst_y bitmap y coordinate in video frame
330 * \param color first color, RGBA
331 * \param color2 second color, RGBA
332 * \param brk x coordinate relative to glyph origin, color is used to the left of brk, color2 - to the right
333 * \param tail pointer to the last image's next field, head of the generated list should be stored here
334 * \return pointer to the new list tail
335 * Performs clipping. Uses my_draw_bitmap for actual bitmap convertion.
337 static ASS_Image **
338 render_glyph(ASS_Renderer *render_priv, Bitmap *bm, int dst_x, int dst_y,
339 uint32_t color, uint32_t color2, int brk, ASS_Image **tail)
341 // Inverse clipping in use?
342 if (render_priv->state.clip_mode)
343 return render_glyph_i(render_priv, bm, dst_x, dst_y, color, color2,
344 brk, tail);
346 // brk is relative to dst_x
347 // color = color left of brk
348 // color2 = color right of brk
349 int b_x0, b_y0, b_x1, b_y1; // visible part of the bitmap
350 int clip_x0, clip_y0, clip_x1, clip_y1;
351 int tmp;
352 ASS_Image *img;
354 dst_x += bm->left;
355 dst_y += bm->top;
356 brk -= bm->left;
358 // clipping
359 clip_x0 = FFMINMAX(render_priv->state.clip_x0, 0, render_priv->width);
360 clip_y0 = FFMINMAX(render_priv->state.clip_y0, 0, render_priv->height);
361 clip_x1 = FFMINMAX(render_priv->state.clip_x1, 0, render_priv->width);
362 clip_y1 = FFMINMAX(render_priv->state.clip_y1, 0, render_priv->height);
363 b_x0 = 0;
364 b_y0 = 0;
365 b_x1 = bm->w;
366 b_y1 = bm->h;
368 tmp = dst_x - clip_x0;
369 if (tmp < 0) {
370 ass_msg(render_priv->library, MSGL_DBG2, "clip left");
371 b_x0 = -tmp;
373 tmp = dst_y - clip_y0;
374 if (tmp < 0) {
375 ass_msg(render_priv->library, MSGL_DBG2, "clip top");
376 b_y0 = -tmp;
378 tmp = clip_x1 - dst_x - bm->w;
379 if (tmp < 0) {
380 ass_msg(render_priv->library, MSGL_DBG2, "clip right");
381 b_x1 = bm->w + tmp;
383 tmp = clip_y1 - dst_y - bm->h;
384 if (tmp < 0) {
385 ass_msg(render_priv->library, MSGL_DBG2, "clip bottom");
386 b_y1 = bm->h + tmp;
389 if ((b_y0 >= b_y1) || (b_x0 >= b_x1))
390 return tail;
392 if (brk > b_x0) { // draw left part
393 if (brk > b_x1)
394 brk = b_x1;
395 img = my_draw_bitmap(bm->buffer + bm->stride * b_y0 + b_x0,
396 brk - b_x0, b_y1 - b_y0, bm->stride,
397 dst_x + b_x0, dst_y + b_y0, color);
398 if (!img) return tail;
399 *tail = img;
400 tail = &img->next;
402 if (brk < b_x1) { // draw right part
403 if (brk < b_x0)
404 brk = b_x0;
405 img = my_draw_bitmap(bm->buffer + bm->stride * b_y0 + brk,
406 b_x1 - brk, b_y1 - b_y0, bm->stride,
407 dst_x + brk, dst_y + b_y0, color2);
408 if (!img) return tail;
409 *tail = img;
410 tail = &img->next;
412 return tail;
416 * \brief Replace the bitmap buffer in ASS_Image with a copy
417 * \param img ASS_Image to operate on
418 * \return pointer to old bitmap buffer
420 static unsigned char *clone_bitmap_buffer(ASS_Image *img)
422 unsigned char *old_bitmap = img->bitmap;
423 int size = img->stride * (img->h - 1) + img->w;
424 img->bitmap = malloc(size);
425 memcpy(img->bitmap, old_bitmap, size);
426 return old_bitmap;
430 * \brief Calculate overlapping area of two consecutive bitmaps and in case they
431 * overlap, blend them together
432 * Mainly useful for translucent glyphs and especially borders, to avoid the
433 * luminance adding up where they overlap (which looks ugly)
435 static void
436 render_overlap(ASS_Renderer *render_priv, ASS_Image **last_tail,
437 ASS_Image **tail)
439 int left, top, bottom, right;
440 int old_left, old_top, w, h, cur_left, cur_top;
441 int x, y, opos, cpos;
442 char m;
443 CompositeHashKey hk;
444 CompositeHashValue *hv;
445 CompositeHashValue chv;
446 int ax = (*last_tail)->dst_x;
447 int ay = (*last_tail)->dst_y;
448 int aw = (*last_tail)->w;
449 int as = (*last_tail)->stride;
450 int ah = (*last_tail)->h;
451 int bx = (*tail)->dst_x;
452 int by = (*tail)->dst_y;
453 int bw = (*tail)->w;
454 int bs = (*tail)->stride;
455 int bh = (*tail)->h;
456 unsigned char *a;
457 unsigned char *b;
459 if ((*last_tail)->bitmap == (*tail)->bitmap)
460 return;
462 if ((*last_tail)->color != (*tail)->color)
463 return;
465 // Calculate overlap coordinates
466 left = (ax > bx) ? ax : bx;
467 top = (ay > by) ? ay : by;
468 right = ((ax + aw) < (bx + bw)) ? (ax + aw) : (bx + bw);
469 bottom = ((ay + ah) < (by + bh)) ? (ay + ah) : (by + bh);
470 if ((right <= left) || (bottom <= top))
471 return;
472 old_left = left - ax;
473 old_top = top - ay;
474 w = right - left;
475 h = bottom - top;
476 cur_left = left - bx;
477 cur_top = top - by;
479 // Query cache
480 hk.a = (*last_tail)->bitmap;
481 hk.b = (*tail)->bitmap;
482 hk.aw = aw;
483 hk.ah = ah;
484 hk.bw = bw;
485 hk.bh = bh;
486 hk.ax = ax;
487 hk.ay = ay;
488 hk.bx = bx;
489 hk.by = by;
490 hk.as = as;
491 hk.bs = bs;
492 hv = ass_cache_get(render_priv->cache.composite_cache, &hk);
493 if (hv) {
494 (*last_tail)->bitmap = hv->a;
495 (*tail)->bitmap = hv->b;
496 return;
498 // Allocate new bitmaps and copy over data
499 a = clone_bitmap_buffer(*last_tail);
500 b = clone_bitmap_buffer(*tail);
502 // Blend overlapping area
503 for (y = 0; y < h; y++)
504 for (x = 0; x < w; x++) {
505 opos = (old_top + y) * (as) + (old_left + x);
506 cpos = (cur_top + y) * (bs) + (cur_left + x);
507 m = FFMIN(a[opos] + b[cpos], 0xff);
508 (*last_tail)->bitmap[opos] = 0;
509 (*tail)->bitmap[cpos] = m;
512 // Insert bitmaps into the cache
513 chv.a = (*last_tail)->bitmap;
514 chv.b = (*tail)->bitmap;
515 ass_cache_put(render_priv->cache.composite_cache, &hk, &chv);
518 static void free_list_add(ASS_Renderer *render_priv, void *object)
520 if (!render_priv->free_head) {
521 render_priv->free_head = calloc(1, sizeof(FreeList));
522 render_priv->free_head->object = object;
523 render_priv->free_tail = render_priv->free_head;
524 } else {
525 FreeList *l = calloc(1, sizeof(FreeList));
526 l->object = object;
527 render_priv->free_tail->next = l;
528 render_priv->free_tail = render_priv->free_tail->next;
533 * Iterate through a list of bitmaps and blend with clip vector, if
534 * applicable. The blended bitmaps are added to a free list which is freed
535 * at the start of a new frame.
537 static void blend_vector_clip(ASS_Renderer *render_priv,
538 ASS_Image *head)
540 FT_Outline *outline;
541 Bitmap *clip_bm = NULL;
542 ASS_Image *cur;
543 ASS_Drawing *drawing = render_priv->state.clip_drawing;
544 BitmapHashKey key;
545 BitmapHashValue *val;
546 int error;
548 if (!drawing)
549 return;
551 // Try to get mask from cache
552 memset(&key, 0, sizeof(key));
553 key.type = BITMAP_CLIP;
554 key.u.clip.text = strdup(drawing->text);
555 val = ass_cache_get(render_priv->cache.bitmap_cache, &key);
557 if (val) {
558 clip_bm = val->bm;
559 } else {
560 BitmapHashValue v;
562 // Not found in cache, parse and rasterize it
563 outline = ass_drawing_parse(drawing, 1);
564 if (!outline) {
565 ass_msg(render_priv->library, MSGL_WARN,
566 "Clip vector parsing failed. Skipping.");
567 goto blend_vector_error;
570 // We need to translate the clip according to screen borders
571 if (render_priv->settings.left_margin != 0 ||
572 render_priv->settings.top_margin != 0) {
573 FT_Vector trans = {
574 .x = int_to_d6(render_priv->settings.left_margin),
575 .y = -int_to_d6(render_priv->settings.top_margin),
577 FT_Outline_Translate(outline, trans.x, trans.y);
580 ass_msg(render_priv->library, MSGL_DBG2,
581 "Parsed vector clip: scales (%f, %f) string [%s]\n",
582 drawing->scale_x, drawing->scale_y, drawing->text);
584 clip_bm = outline_to_bitmap(render_priv->library,
585 render_priv->ftlibrary, outline, 0);
586 if (clip_bm == NULL) {
587 ass_msg(render_priv->library, MSGL_WARN,
588 "Clip vector rasterization failed: %d. Skipping.", error);
591 // Add to cache
592 memset(&v, 0, sizeof(v));
593 v.bm = clip_bm;
594 ass_cache_put(render_priv->cache.bitmap_cache, &key, &v);
596 blend_vector_error:
598 if (!clip_bm) goto blend_vector_exit;
600 // Iterate through bitmaps and blend/clip them
601 for (cur = head; cur; cur = cur->next) {
602 int left, top, right, bottom, apos, bpos, y, x, w, h;
603 int ax, ay, aw, ah, as;
604 int bx, by, bw, bh, bs;
605 int aleft, atop, bleft, btop;
606 unsigned char *abuffer, *bbuffer, *nbuffer;
608 abuffer = cur->bitmap;
609 bbuffer = clip_bm->buffer;
610 ax = cur->dst_x;
611 ay = cur->dst_y;
612 aw = cur->w;
613 ah = cur->h;
614 as = cur->stride;
615 bx = clip_bm->left;
616 by = clip_bm->top;
617 bw = clip_bm->w;
618 bh = clip_bm->h;
619 bs = clip_bm->stride;
621 // Calculate overlap coordinates
622 left = (ax > bx) ? ax : bx;
623 top = (ay > by) ? ay : by;
624 right = ((ax + aw) < (bx + bw)) ? (ax + aw) : (bx + bw);
625 bottom = ((ay + ah) < (by + bh)) ? (ay + ah) : (by + bh);
626 aleft = left - ax;
627 atop = top - ay;
628 w = right - left;
629 h = bottom - top;
630 bleft = left - bx;
631 btop = top - by;
633 if (render_priv->state.clip_drawing_mode) {
634 // Inverse clip
635 if (ax + aw < bx || ay + ah < by || ax > bx + bw ||
636 ay > by + bh) {
637 continue;
640 // Allocate new buffer and add to free list
641 nbuffer = malloc(as * ah);
642 if (!nbuffer) goto blend_vector_exit;
643 free_list_add(render_priv, nbuffer);
645 // Blend together
646 memcpy(nbuffer, abuffer, as * (ah - 1) + aw);
647 for (y = 0; y < h; y++)
648 for (x = 0; x < w; x++) {
649 apos = (atop + y) * as + aleft + x;
650 bpos = (btop + y) * bs + bleft + x;
651 nbuffer[apos] = FFMAX(0, abuffer[apos] - bbuffer[bpos]);
653 } else {
654 // Regular clip
655 if (ax + aw < bx || ay + ah < by || ax > bx + bw ||
656 ay > by + bh) {
657 cur->w = cur->h = 0;
658 continue;
661 // Allocate new buffer and add to free list
662 nbuffer = calloc(as, ah);
663 if (!nbuffer) goto blend_vector_exit;
664 free_list_add(render_priv, nbuffer);
666 // Blend together
667 for (y = 0; y < h; y++)
668 for (x = 0; x < w; x++) {
669 apos = (atop + y) * as + aleft + x;
670 bpos = (btop + y) * bs + bleft + x;
671 nbuffer[apos] = (abuffer[apos] * bbuffer[bpos] + 255) >> 8;
674 cur->bitmap = nbuffer;
677 blend_vector_exit:
678 ass_drawing_free(render_priv->state.clip_drawing);
679 render_priv->state.clip_drawing = 0;
683 * \brief Convert TextInfo struct to ASS_Image list
684 * Splits glyphs in halves when needed (for \kf karaoke).
686 static ASS_Image *render_text(ASS_Renderer *render_priv, int dst_x, int dst_y)
688 int pen_x, pen_y;
689 int i;
690 Bitmap *bm;
691 ASS_Image *head;
692 ASS_Image **tail = &head;
693 ASS_Image **last_tail = 0;
694 ASS_Image **here_tail = 0;
695 TextInfo *text_info = &render_priv->text_info;
697 for (i = 0; i < text_info->length; ++i) {
698 GlyphInfo *info = text_info->glyphs + i;
699 if ((info->symbol == 0) || (info->symbol == '\n') || !info->bm_s
700 || (info->shadow_x == 0 && info->shadow_y == 0) || info->skip)
701 continue;
703 while (info) {
704 if (!info->bm_s) {
705 info = info->next;
706 continue;
709 pen_x =
710 dst_x + (info->pos.x >> 6) +
711 (int) (info->shadow_x * render_priv->border_scale);
712 pen_y =
713 dst_y + (info->pos.y >> 6) +
714 (int) (info->shadow_y * render_priv->border_scale);
715 bm = info->bm_s;
717 here_tail = tail;
718 tail =
719 render_glyph(render_priv, bm, pen_x, pen_y, info->c[3], 0,
720 1000000, tail);
722 if (last_tail && tail != here_tail && ((info->c[3] & 0xff) > 0))
723 render_overlap(render_priv, last_tail, here_tail);
724 last_tail = here_tail;
726 info = info->next;
730 last_tail = 0;
731 for (i = 0; i < text_info->length; ++i) {
732 GlyphInfo *info = text_info->glyphs + i;
733 if ((info->symbol == 0) || (info->symbol == '\n') || !info->bm_o
734 || info->skip)
735 continue;
737 while (info) {
738 if (!info->bm_o) {
739 info = info->next;
740 continue;
743 pen_x = dst_x + (info->pos.x >> 6);
744 pen_y = dst_y + (info->pos.y >> 6);
745 bm = info->bm_o;
747 if ((info->effect_type == EF_KARAOKE_KO)
748 && (info->effect_timing <= (info->bbox.xMax >> 6))) {
749 // do nothing
750 } else {
751 here_tail = tail;
752 tail =
753 render_glyph(render_priv, bm, pen_x, pen_y, info->c[2],
754 0, 1000000, tail);
755 if (last_tail && tail != here_tail && ((info->c[2] & 0xff) > 0))
756 render_overlap(render_priv, last_tail, here_tail);
758 last_tail = here_tail;
760 info = info->next;
764 for (i = 0; i < text_info->length; ++i) {
765 GlyphInfo *info = text_info->glyphs + i;
766 if ((info->symbol == 0) || (info->symbol == '\n') || !info->bm
767 || info->skip)
768 continue;
770 while (info) {
771 if (!info->bm) {
772 info = info->next;
773 continue;
776 pen_x = dst_x + (info->pos.x >> 6);
777 pen_y = dst_y + (info->pos.y >> 6);
778 bm = info->bm;
780 if ((info->effect_type == EF_KARAOKE)
781 || (info->effect_type == EF_KARAOKE_KO)) {
782 if (info->effect_timing > (info->bbox.xMax >> 6))
783 tail =
784 render_glyph(render_priv, bm, pen_x, pen_y,
785 info->c[0], 0, 1000000, tail);
786 else
787 tail =
788 render_glyph(render_priv, bm, pen_x, pen_y,
789 info->c[1], 0, 1000000, tail);
790 } else if (info->effect_type == EF_KARAOKE_KF) {
791 tail =
792 render_glyph(render_priv, bm, pen_x, pen_y, info->c[0],
793 info->c[1], info->effect_timing, tail);
794 } else
795 tail =
796 render_glyph(render_priv, bm, pen_x, pen_y, info->c[0],
797 0, 1000000, tail);
798 info = info->next;
802 *tail = 0;
803 blend_vector_clip(render_priv, head);
805 return head;
808 static void compute_string_bbox(TextInfo *text, DBBox *bbox)
810 int i;
812 if (text->length > 0) {
813 bbox->xMin = 32000;
814 bbox->xMax = -32000;
815 bbox->yMin = -1 * text->lines[0].asc + d6_to_double(text->glyphs[0].pos.y);
816 bbox->yMax = text->height - text->lines[0].asc +
817 d6_to_double(text->glyphs[0].pos.y);
819 for (i = 0; i < text->length; ++i) {
820 GlyphInfo *info = text->glyphs + i;
821 if (info->skip) continue;
822 while (info) {
823 double s = d6_to_double(info->pos.x);
824 double e = s + d6_to_double(info->advance.x);
825 bbox->xMin = FFMIN(bbox->xMin, s);
826 bbox->xMax = FFMAX(bbox->xMax, e);
827 info = info->next;
830 } else
831 bbox->xMin = bbox->xMax = bbox->yMin = bbox->yMax = 0.;
835 * \brief Compute the size of the target bitmap for a run of outlines.
836 * \param run first outline of the run
837 * \param len run length
838 * \param w returns target width, in pixels
839 * \param h returns target height, in pixels
841 static void compute_run_size(GlyphInfo *run, size_t len, int *w, int *h)
843 int i;
844 FT_BBox bbox;
845 bbox.xMin = bbox.yMin = INT_MAX;
846 bbox.xMax = bbox.yMax = INT_MIN;
848 for (i = 0; i < len; i++) {
849 GlyphInfo *info = run + i;
850 if (info->skip || info->symbol == 0 || info->symbol == '\n')
851 continue;
852 bbox.xMin = FFMIN(bbox.xMin, info->pos.x + info->bbox.xMin);
853 bbox.yMin = FFMIN(bbox.yMin, info->pos.y + info->bbox.yMin);
854 bbox.xMax = FFMAX(bbox.xMax, info->pos.x + info->bbox.xMax);
855 bbox.yMax = FFMAX(bbox.yMax, info->pos.y + info->bbox.yMax);
857 bbox.xMin &= ~63;
858 bbox.yMin &= ~63;
859 bbox.xMax = (bbox.xMax + 63) & ~63;
860 bbox.yMax = (bbox.yMax + 63) & ~63;
861 *w = (bbox.xMax - bbox.xMin) >> 6;
862 *h = (bbox.yMax - bbox.yMin) >> 6;
866 * \brief partially reset render_context to style values
867 * Works like {\r}: resets some style overrides
869 void reset_render_context(ASS_Renderer *render_priv)
871 render_priv->state.c[0] = render_priv->state.style->PrimaryColour;
872 render_priv->state.c[1] = render_priv->state.style->SecondaryColour;
873 render_priv->state.c[2] = render_priv->state.style->OutlineColour;
874 render_priv->state.c[3] = render_priv->state.style->BackColour;
875 render_priv->state.flags =
876 (render_priv->state.style->Underline ? DECO_UNDERLINE : 0) |
877 (render_priv->state.style->StrikeOut ? DECO_STRIKETHROUGH : 0);
878 render_priv->state.font_size = render_priv->state.style->FontSize;
880 free(render_priv->state.family);
881 render_priv->state.family = NULL;
882 render_priv->state.family = strdup(render_priv->state.style->FontName);
883 render_priv->state.treat_family_as_pattern =
884 render_priv->state.style->treat_fontname_as_pattern;
885 render_priv->state.bold = render_priv->state.style->Bold;
886 render_priv->state.italic = render_priv->state.style->Italic;
887 update_font(render_priv);
889 change_border(render_priv, -1., -1.);
890 render_priv->state.scale_x = render_priv->state.style->ScaleX;
891 render_priv->state.scale_y = render_priv->state.style->ScaleY;
892 render_priv->state.hspacing = render_priv->state.style->Spacing;
893 render_priv->state.be = 0;
894 render_priv->state.blur = 0.0;
895 render_priv->state.shadow_x = render_priv->state.style->Shadow;
896 render_priv->state.shadow_y = render_priv->state.style->Shadow;
897 render_priv->state.frx = render_priv->state.fry = 0.;
898 render_priv->state.frz = M_PI * render_priv->state.style->Angle / 180.;
899 render_priv->state.fax = render_priv->state.fay = 0.;
900 render_priv->state.wrap_style = render_priv->track->WrapStyle;
904 * \brief Start new event. Reset render_priv->state.
906 static void
907 init_render_context(ASS_Renderer *render_priv, ASS_Event *event)
909 render_priv->state.event = event;
910 render_priv->state.style = render_priv->track->styles + event->Style;
911 render_priv->state.parsed_tags = 0;
913 reset_render_context(render_priv);
915 render_priv->state.evt_type = EVENT_NORMAL;
916 render_priv->state.alignment = render_priv->state.style->Alignment;
917 render_priv->state.pos_x = 0;
918 render_priv->state.pos_y = 0;
919 render_priv->state.org_x = 0;
920 render_priv->state.org_y = 0;
921 render_priv->state.have_origin = 0;
922 render_priv->state.clip_x0 = 0;
923 render_priv->state.clip_y0 = 0;
924 render_priv->state.clip_x1 = render_priv->track->PlayResX;
925 render_priv->state.clip_y1 = render_priv->track->PlayResY;
926 render_priv->state.clip_mode = 0;
927 render_priv->state.detect_collisions = 1;
928 render_priv->state.fade = 0;
929 render_priv->state.drawing_mode = 0;
930 render_priv->state.effect_type = EF_NONE;
931 render_priv->state.effect_timing = 0;
932 render_priv->state.effect_skip_timing = 0;
933 render_priv->state.bm_run_id = 0;
934 ass_drawing_free(render_priv->state.drawing);
935 render_priv->state.drawing = ass_drawing_new(render_priv->library,
936 render_priv->ftlibrary);
938 apply_transition_effects(render_priv, event);
941 static void free_render_context(ASS_Renderer *render_priv)
943 free(render_priv->state.family);
944 ass_drawing_free(render_priv->state.drawing);
946 render_priv->state.family = NULL;
947 render_priv->state.drawing = NULL;
951 * Replace the outline of a glyph by a contour which makes up a simple
952 * opaque rectangle.
954 static void draw_opaque_box(ASS_Renderer *render_priv, uint32_t ch,
955 FT_Outline *ol, FT_Vector advance, int sx, int sy)
957 int asc = 0, desc = 0;
958 int i;
959 int adv = advance.x;
960 double scale_y = render_priv->state.scale_y;
961 double scale_x = render_priv->state.scale_x;
963 // to avoid gaps
964 sx = FFMAX(64, sx);
965 sy = FFMAX(64, sy);
967 if (ch == -1) {
968 asc = render_priv->state.drawing->asc;
969 desc = render_priv->state.drawing->desc;
970 } else {
971 ass_font_get_asc_desc(render_priv->state.font, ch, &asc, &desc);
972 asc *= scale_y;
973 desc *= scale_y;
976 // Emulate the WTFish behavior of VSFilter, i.e. double-scale
977 // the sizes of the opaque box.
978 adv += double_to_d6(render_priv->state.hspacing * render_priv->font_scale
979 * scale_x);
980 adv *= scale_x;
981 sx *= scale_x;
982 sy *= scale_y;
983 desc *= scale_y;
984 desc += asc * (scale_y - 1.0);
986 FT_Vector points[4] = {
987 { .x = -sx, .y = asc + sy },
988 { .x = adv + sx, .y = asc + sy },
989 { .x = adv + sx, .y = -desc - sy },
990 { .x = -sx, .y = -desc - sy },
993 FT_Outline_Done(render_priv->ftlibrary, ol);
994 FT_Outline_New(render_priv->ftlibrary, 4, 1, ol);
996 ol->n_points = ol->n_contours = 0;
997 for (i = 0; i < 4; i++) {
998 ol->points[ol->n_points] = points[i];
999 ol->tags[ol->n_points++] = 1;
1001 ol->contours[ol->n_contours++] = ol->n_points - 1;
1005 * Stroke an outline glyph in x/y direction. Applies various fixups to get
1006 * around limitations of the FreeType stroker.
1008 static void stroke_outline(ASS_Renderer *render_priv, FT_Outline *outline,
1009 int sx, int sy)
1011 if (sx <= 0 && sy <= 0)
1012 return;
1014 fix_freetype_stroker(outline, sx, sy);
1016 // Borders are equal; use the regular stroker
1017 if (sx == sy && render_priv->state.stroker) {
1018 int error;
1019 unsigned n_points, n_contours;
1021 FT_StrokerBorder border = FT_Outline_GetOutsideBorder(outline);
1022 error = FT_Stroker_ParseOutline(render_priv->state.stroker, outline, 0);
1023 if (error) {
1024 ass_msg(render_priv->library, MSGL_WARN,
1025 "FT_Stroker_ParseOutline failed, error: %d", error);
1027 error = FT_Stroker_GetBorderCounts(render_priv->state.stroker, border,
1028 &n_points, &n_contours);
1029 if (error) {
1030 ass_msg(render_priv->library, MSGL_WARN,
1031 "FT_Stroker_GetBorderCounts failed, error: %d", error);
1033 FT_Outline_Done(render_priv->ftlibrary, outline);
1034 FT_Outline_New(render_priv->ftlibrary, n_points, n_contours, outline);
1035 outline->n_points = outline->n_contours = 0;
1036 FT_Stroker_ExportBorder(render_priv->state.stroker, border, outline);
1038 // "Stroke" with the outline emboldener in two passes.
1039 // The outlines look uglier, but the emboldening never adds any points
1040 } else {
1041 int i;
1042 FT_Outline nol;
1044 FT_Outline_New(render_priv->ftlibrary, outline->n_points,
1045 outline->n_contours, &nol);
1046 FT_Outline_Copy(outline, &nol);
1048 FT_Outline_Embolden(outline, sx * 2);
1049 FT_Outline_Translate(outline, -sx, -sx);
1050 FT_Outline_Embolden(&nol, sy * 2);
1051 FT_Outline_Translate(&nol, -sy, -sy);
1053 for (i = 0; i < outline->n_points; i++)
1054 outline->points[i].y = nol.points[i].y;
1056 FT_Outline_Done(render_priv->ftlibrary, &nol);
1061 * \brief Prepare glyph hash
1063 static void
1064 fill_glyph_hash(ASS_Renderer *priv, OutlineHashKey *outline_key,
1065 GlyphInfo *info)
1067 if (info->drawing) {
1068 DrawingHashKey *key = &outline_key->u.drawing;
1069 outline_key->type = OUTLINE_DRAWING;
1070 key->scale_x = double_to_d16(info->scale_x);
1071 key->scale_y = double_to_d16(info->scale_y);
1072 key->outline.x = double_to_d16(info->border_x);
1073 key->outline.y = double_to_d16(info->border_y);
1074 key->border_style = priv->state.style->BorderStyle;
1075 key->hash = info->drawing->hash;
1076 key->text = strdup(info->drawing->text);
1077 key->pbo = info->drawing->pbo;
1078 key->scale = info->drawing->scale;
1079 } else {
1080 GlyphHashKey *key = &outline_key->u.glyph;
1081 outline_key->type = OUTLINE_GLYPH;
1082 key->font = info->font;
1083 key->size = info->font_size;
1084 key->face_index = info->face_index;
1085 key->glyph_index = info->glyph_index;
1086 key->bold = info->bold;
1087 key->italic = info->italic;
1088 key->scale_x = double_to_d16(info->scale_x);
1089 key->scale_y = double_to_d16(info->scale_y);
1090 key->outline.x = double_to_d16(info->border_x);
1091 key->outline.y = double_to_d16(info->border_y);
1092 key->flags = info->flags;
1093 key->border_style = priv->state.style->BorderStyle;
1098 * \brief Get normal and outline (border) glyphs
1099 * \param info out: struct filled with extracted data
1100 * Tries to get both glyphs from cache.
1101 * If they can't be found, gets a glyph from font face, generates outline with FT_Stroker,
1102 * and add them to cache.
1103 * The glyphs are returned in info->glyph and info->outline_glyph
1105 static void
1106 get_outline_glyph(ASS_Renderer *render_priv, GlyphInfo *info)
1108 OutlineHashValue *val;
1109 OutlineHashKey key;
1111 memset(&info->hash_key, 0, sizeof(key));
1113 fill_glyph_hash(render_priv, &key, info);
1114 val = ass_cache_get(render_priv->cache.outline_cache, &key);
1115 if (val) {
1116 info->hash_key.u.outline.outline = val;
1117 info->outline = val->outline;
1118 info->border = val->border;
1119 info->bbox = val->bbox_scaled;
1120 if (info->drawing) {
1121 info->cluster_advance.x = info->advance.x = val->advance.x;
1122 info->cluster_advance.y = info->advance.y = val->advance.y;
1124 info->asc = val->asc;
1125 info->desc = val->desc;
1126 } else {
1127 OutlineHashValue v;
1128 if (info->drawing) {
1129 ASS_Drawing *drawing = info->drawing;
1130 ass_drawing_hash(drawing);
1131 if(!ass_drawing_parse(drawing, 0))
1132 return;
1133 outline_copy(render_priv->ftlibrary, &drawing->outline,
1134 &info->outline);
1135 info->cluster_advance.x = info->advance.x = drawing->advance.x;
1136 info->cluster_advance.y = info->advance.y = drawing->advance.y;
1137 info->asc = drawing->asc;
1138 info->desc = drawing->desc;
1139 ass_drawing_free(drawing);
1140 } else {
1141 double size_scaled = ensure_font_size(render_priv,
1142 info->font_size * render_priv->font_scale);
1143 ass_font_set_size(info->font, size_scaled);
1144 ass_font_set_transform(info->font, info->scale_x,
1145 info->scale_y, NULL);
1146 // symbol might have been changed. re-get it.
1147 //if (info->face_index < 0)
1148 // ass_font_get_index(render_priv->fontconfig_priv, info->font,
1149 // info->symbol, &info->face_index, &info->glyph_index);
1150 FT_Glyph glyph =
1151 ass_font_get_glyph(render_priv->fontconfig_priv, info->font,
1152 info->symbol, info->face_index, info->glyph_index,
1153 render_priv->settings.hinting, info->flags);
1154 if (glyph != NULL) {
1155 outline_copy(render_priv->ftlibrary,
1156 &((FT_OutlineGlyph)glyph)->outline, &info->outline);
1157 //info->advance.x = d16_to_d6(glyph->advance.x);
1158 //info->advance.y = d16_to_d6(glyph->advance.y);
1159 FT_Done_Glyph(glyph);
1160 ass_font_get_asc_desc(info->font, info->symbol,
1161 &info->asc, &info->desc);
1162 info->asc *= info->scale_y;
1163 info->desc *= info->scale_y;
1166 if (!info->outline)
1167 return;
1169 FT_Outline_Get_CBox(info->outline, &info->bbox);
1171 if (render_priv->state.style->BorderStyle == 3 &&
1172 (info->border_x > 0|| info->border_y > 0)) {
1173 outline_copy(render_priv->ftlibrary, info->outline, &info->border);
1174 draw_opaque_box(render_priv, info->symbol, info->border,
1175 info->advance,
1176 double_to_d6(info->border_x *
1177 render_priv->border_scale),
1178 double_to_d6(info->border_y *
1179 render_priv->border_scale));
1180 } else if ((info->border_x > 0 || info->border_y > 0)
1181 && double_to_d6(info->scale_x) && double_to_d6(info->scale_y)) {
1183 outline_copy(render_priv->ftlibrary, info->outline, &info->border);
1184 stroke_outline(render_priv, info->border,
1185 double_to_d6(info->border_x * render_priv->border_scale),
1186 double_to_d6(info->border_y * render_priv->border_scale));
1189 memset(&v, 0, sizeof(v));
1190 v.lib = render_priv->ftlibrary;
1191 v.outline = info->outline;
1192 v.border = info->border;
1193 v.advance = info->cluster_advance;
1194 v.bbox_scaled = info->bbox;
1195 v.asc = info->asc;
1196 v.desc = info->desc;
1197 info->hash_key.u.outline.outline =
1198 ass_cache_put(render_priv->cache.outline_cache, &key, &v);
1203 * \brief Apply transformation to outline points of a glyph
1204 * Applies rotations given by frx, fry and frz and projects the points back
1205 * onto the screen plane.
1207 static void
1208 transform_3d_points(FT_Vector shift, FT_Outline *outline, double frx, double fry,
1209 double frz, double fax, double fay, double scale,
1210 int yshift)
1212 double sx = sin(frx);
1213 double sy = sin(fry);
1214 double sz = sin(frz);
1215 double cx = cos(frx);
1216 double cy = cos(fry);
1217 double cz = cos(frz);
1218 FT_Vector *p = outline->points;
1219 double x, y, z, xx, yy, zz;
1220 int i, dist;
1222 dist = 20000 * scale;
1223 for (i = 0; i < outline->n_points; i++) {
1224 x = (double) p[i].x + shift.x + (fax * (yshift - p[i].y));
1225 y = (double) p[i].y + shift.y + (-fay * p[i].x);
1226 z = 0.;
1228 xx = x * cz + y * sz;
1229 yy = -(x * sz - y * cz);
1230 zz = z;
1232 x = xx;
1233 y = yy * cx + zz * sx;
1234 z = yy * sx - zz * cx;
1236 xx = x * cy + z * sy;
1237 yy = y;
1238 zz = x * sy - z * cy;
1240 zz = FFMAX(zz, 1000 - dist);
1242 x = (xx * dist) / (zz + dist);
1243 y = (yy * dist) / (zz + dist);
1244 p[i].x = x - shift.x + 0.5;
1245 p[i].y = y - shift.y + 0.5;
1250 * \brief Apply 3d transformation to several objects
1251 * \param shift FreeType vector
1252 * \param glyph FreeType glyph
1253 * \param glyph2 FreeType glyph
1254 * \param frx x-axis rotation angle
1255 * \param fry y-axis rotation angle
1256 * \param frz z-axis rotation angle
1257 * Rotates both glyphs by frx, fry and frz. Shift vector is added before rotation and subtracted after it.
1259 static void
1260 transform_3d(FT_Vector shift, FT_Outline *outline, FT_Outline *border,
1261 double frx, double fry, double frz, double fax, double fay,
1262 double scale, int yshift)
1264 frx = -frx;
1265 frz = -frz;
1266 if (frx != 0. || fry != 0. || frz != 0. || fax != 0. || fay != 0.) {
1267 if (outline)
1268 transform_3d_points(shift, outline, frx, fry, frz,
1269 fax, fay, scale, yshift);
1271 if (border)
1272 transform_3d_points(shift, border, frx, fry, frz,
1273 fax, fay, scale, yshift);
1278 * \brief Get bitmaps for a glyph
1279 * \param info glyph info
1280 * Tries to get glyph bitmaps from bitmap cache.
1281 * If they can't be found, they are generated by rotating and rendering the glyph.
1282 * After that, bitmaps are added to the cache.
1283 * They are returned in info->bm (glyph), info->bm_o (outline) and info->bm_s (shadow).
1285 static void
1286 get_bitmap_glyph(ASS_Renderer *render_priv, GlyphInfo *info)
1288 BitmapHashValue *val;
1289 OutlineBitmapHashKey *key = &info->hash_key.u.outline;
1291 val = ass_cache_get(render_priv->cache.bitmap_cache, &info->hash_key);
1293 if (val) {
1294 info->bm = val->bm;
1295 info->bm_o = val->bm_o;
1296 info->bm_s = val->bm_s;
1297 } else {
1298 FT_Vector shift;
1299 BitmapHashValue hash_val;
1300 int error;
1301 double fax_scaled, fay_scaled;
1302 info->bm = info->bm_o = info->bm_s = 0;
1303 if (info->outline && info->symbol != '\n' && info->symbol != 0
1304 && !info->skip) {
1305 FT_Outline *outline, *border;
1306 double scale_x = render_priv->font_scale_x;
1308 outline_copy(render_priv->ftlibrary, info->outline, &outline);
1309 outline_copy(render_priv->ftlibrary, info->border, &border);
1310 // calculating rotation shift vector (from rotation origin to the glyph basepoint)
1311 shift.x = key->shift_x;
1312 shift.y = key->shift_y;
1313 fax_scaled = info->fax *
1314 render_priv->state.scale_x;
1315 fay_scaled = info->fay * render_priv->state.scale_y;
1316 // apply rotation
1317 transform_3d(shift, outline, border,
1318 info->frx, info->fry, info->frz, fax_scaled,
1319 fay_scaled, render_priv->font_scale, info->asc);
1321 // PAR correction scaling
1322 FT_Matrix m = { double_to_d16(scale_x), 0,
1323 0, double_to_d16(1.0) };
1325 // subpixel shift
1326 if (outline) {
1327 if (scale_x != 1.0)
1328 FT_Outline_Transform(outline, &m);
1329 FT_Outline_Translate(outline, key->advance.x, -key->advance.y);
1331 if (border) {
1332 if (scale_x != 1.0)
1333 FT_Outline_Transform(border, &m);
1334 FT_Outline_Translate(border, key->advance.x, -key->advance.y);
1336 // render glyph
1337 error = outline_to_bitmap3(render_priv->library,
1338 render_priv->synth_priv,
1339 render_priv->ftlibrary,
1340 outline, border,
1341 &info->bm, &info->bm_o,
1342 &info->bm_s, info->be,
1343 info->blur * render_priv->border_scale,
1344 key->shadow_offset,
1345 render_priv->state.style->BorderStyle);
1346 if (error)
1347 info->symbol = 0;
1349 // add bitmaps to cache
1350 hash_val.bm_o = info->bm_o;
1351 hash_val.bm = info->bm;
1352 hash_val.bm_s = info->bm_s;
1353 ass_cache_put(render_priv->cache.bitmap_cache, &info->hash_key,
1354 &hash_val);
1356 outline_free(render_priv->ftlibrary, outline);
1357 outline_free(render_priv->ftlibrary, border);
1361 // VSFilter compatibility: invisible fill and no border?
1362 // In this case no shadow is supposed to be rendered.
1363 if (!info->border && (info->c[0] & 0xFF) == 0xFF)
1364 info->bm_s = 0;
1368 * This function goes through text_info and calculates text parameters.
1369 * The following text_info fields are filled:
1370 * height
1371 * lines[].height
1372 * lines[].asc
1373 * lines[].desc
1375 static void measure_text(ASS_Renderer *render_priv)
1377 TextInfo *text_info = &render_priv->text_info;
1378 int cur_line = 0;
1379 double max_asc = 0., max_desc = 0.;
1380 GlyphInfo *last = NULL;
1381 int i;
1382 int empty_line = 1;
1383 text_info->height = 0.;
1384 for (i = 0; i < text_info->length + 1; ++i) {
1385 if ((i == text_info->length) || text_info->glyphs[i].linebreak) {
1386 if (empty_line && cur_line > 0 && last && i < text_info->length) {
1387 max_asc = d6_to_double(last->asc) / 2.0;
1388 max_desc = d6_to_double(last->desc) / 2.0;
1390 text_info->lines[cur_line].asc = max_asc;
1391 text_info->lines[cur_line].desc = max_desc;
1392 text_info->height += max_asc + max_desc;
1393 cur_line++;
1394 max_asc = max_desc = 0.;
1395 empty_line = 1;
1396 } else
1397 empty_line = 0;
1398 if (i < text_info->length) {
1399 GlyphInfo *cur = text_info->glyphs + i;
1400 if (d6_to_double(cur->asc) > max_asc)
1401 max_asc = d6_to_double(cur->asc);
1402 if (d6_to_double(cur->desc) > max_desc)
1403 max_desc = d6_to_double(cur->desc);
1404 if (cur->symbol != '\n' && cur->symbol != 0)
1405 last = cur;
1408 text_info->height +=
1409 (text_info->n_lines -
1410 1) * render_priv->settings.line_spacing;
1414 * Mark extra whitespace for later removal.
1416 #define IS_WHITESPACE(x) ((x->symbol == ' ' || x->symbol == '\n') \
1417 && !x->linebreak)
1418 static void trim_whitespace(ASS_Renderer *render_priv)
1420 int i, j;
1421 GlyphInfo *cur;
1422 TextInfo *ti = &render_priv->text_info;
1424 // Mark trailing spaces
1425 i = ti->length - 1;
1426 cur = ti->glyphs + i;
1427 while (i && IS_WHITESPACE(cur)) {
1428 cur->skip++;
1429 cur = ti->glyphs + --i;
1432 // Mark leading whitespace
1433 i = 0;
1434 cur = ti->glyphs;
1435 while (i < ti->length && IS_WHITESPACE(cur)) {
1436 cur->skip++;
1437 cur = ti->glyphs + ++i;
1440 // Mark all extraneous whitespace inbetween
1441 for (i = 0; i < ti->length; ++i) {
1442 cur = ti->glyphs + i;
1443 if (cur->linebreak) {
1444 // Mark whitespace before
1445 j = i - 1;
1446 cur = ti->glyphs + j;
1447 while (j && IS_WHITESPACE(cur)) {
1448 cur->skip++;
1449 cur = ti->glyphs + --j;
1451 // A break itself can contain a whitespace, too
1452 cur = ti->glyphs + i;
1453 if (cur->symbol == ' ') {
1454 cur->skip++;
1455 // Mark whitespace after
1456 j = i + 1;
1457 cur = ti->glyphs + j;
1458 while (j < ti->length && IS_WHITESPACE(cur)) {
1459 cur->skip++;
1460 cur = ti->glyphs + ++j;
1462 i = j - 1;
1467 #undef IS_WHITESPACE
1470 * \brief rearrange text between lines
1471 * \param max_text_width maximal text line width in pixels
1472 * The algo is similar to the one in libvo/sub.c:
1473 * 1. Place text, wrapping it when current line is full
1474 * 2. Try moving words from the end of a line to the beginning of the next one while it reduces
1475 * the difference in lengths between this two lines.
1476 * The result may not be optimal, but usually is good enough.
1478 * FIXME: implement style 0 and 3 correctly
1480 static void
1481 wrap_lines_smart(ASS_Renderer *render_priv, double max_text_width)
1483 int i;
1484 GlyphInfo *cur, *s1, *e1, *s2, *s3, *w;
1485 int last_space;
1486 int break_type;
1487 int exit;
1488 double pen_shift_x;
1489 double pen_shift_y;
1490 int cur_line;
1491 int run_offset;
1492 TextInfo *text_info = &render_priv->text_info;
1494 last_space = -1;
1495 text_info->n_lines = 1;
1496 break_type = 0;
1497 s1 = text_info->glyphs; // current line start
1498 for (i = 0; i < text_info->length; ++i) {
1499 int break_at = -1;
1500 double s_offset, len;
1501 cur = text_info->glyphs + i;
1502 s_offset = d6_to_double(s1->bbox.xMin + s1->pos.x);
1503 len = d6_to_double(cur->bbox.xMax + cur->pos.x) - s_offset;
1505 if (cur->symbol == '\n') {
1506 break_type = 2;
1507 break_at = i;
1508 ass_msg(render_priv->library, MSGL_DBG2,
1509 "forced line break at %d", break_at);
1510 } else if (cur->symbol == ' ') {
1511 last_space = i;
1512 } else if (len >= max_text_width
1513 && (render_priv->state.wrap_style != 2)) {
1514 break_type = 1;
1515 break_at = last_space;
1516 if (break_at >= 0)
1517 ass_msg(render_priv->library, MSGL_DBG2, "line break at %d",
1518 break_at);
1521 if (break_at != -1) {
1522 // need to use one more line
1523 // marking break_at+1 as start of a new line
1524 int lead = break_at + 1; // the first symbol of the new line
1525 if (text_info->n_lines >= text_info->max_lines) {
1526 // Raise maximum number of lines
1527 text_info->max_lines *= 2;
1528 text_info->lines = realloc(text_info->lines,
1529 sizeof(LineInfo) *
1530 text_info->max_lines);
1532 if (lead < text_info->length)
1533 text_info->glyphs[lead].linebreak = break_type;
1534 last_space = -1;
1535 s1 = text_info->glyphs + lead;
1536 s_offset = d6_to_double(s1->bbox.xMin + s1->pos.x);
1537 text_info->n_lines++;
1540 #define DIFF(x,y) (((x) < (y)) ? (y - x) : (x - y))
1541 exit = 0;
1542 while (!exit && render_priv->state.wrap_style != 1) {
1543 exit = 1;
1544 w = s3 = text_info->glyphs;
1545 s1 = s2 = 0;
1546 for (i = 0; i <= text_info->length; ++i) {
1547 cur = text_info->glyphs + i;
1548 if ((i == text_info->length) || cur->linebreak) {
1549 s1 = s2;
1550 s2 = s3;
1551 s3 = cur;
1552 if (s1 && (s2->linebreak == 1)) { // have at least 2 lines, and linebreak is 'soft'
1553 double l1, l2, l1_new, l2_new;
1555 w = s2;
1556 do {
1557 --w;
1558 } while ((w > s1) && (w->symbol == ' '));
1559 while ((w > s1) && (w->symbol != ' ')) {
1560 --w;
1562 e1 = w;
1563 while ((e1 > s1) && (e1->symbol == ' ')) {
1564 --e1;
1566 if (w->symbol == ' ')
1567 ++w;
1569 l1 = d6_to_double(((s2 - 1)->bbox.xMax + (s2 - 1)->pos.x) -
1570 (s1->bbox.xMin + s1->pos.x));
1571 l2 = d6_to_double(((s3 - 1)->bbox.xMax + (s3 - 1)->pos.x) -
1572 (s2->bbox.xMin + s2->pos.x));
1573 l1_new = d6_to_double(
1574 (e1->bbox.xMax + e1->pos.x) -
1575 (s1->bbox.xMin + s1->pos.x));
1576 l2_new = d6_to_double(
1577 ((s3 - 1)->bbox.xMax + (s3 - 1)->pos.x) -
1578 (w->bbox.xMin + w->pos.x));
1580 if (DIFF(l1_new, l2_new) < DIFF(l1, l2)) {
1581 w->linebreak = 1;
1582 s2->linebreak = 0;
1583 exit = 0;
1587 if (i == text_info->length)
1588 break;
1592 assert(text_info->n_lines >= 1);
1593 #undef DIFF
1595 measure_text(render_priv);
1596 trim_whitespace(render_priv);
1598 pen_shift_x = 0.;
1599 pen_shift_y = 0.;
1600 cur_line = 1;
1601 run_offset = 0;
1603 i = 0;
1604 cur = text_info->glyphs + i;
1605 while (i < text_info->length && cur->skip)
1606 cur = text_info->glyphs + ++i;
1607 pen_shift_x = d6_to_double(-cur->pos.x);
1609 for (i = 0; i < text_info->length; ++i) {
1610 cur = text_info->glyphs + i;
1611 if (cur->linebreak) {
1612 while (i < text_info->length && cur->skip && cur->symbol != '\n')
1613 cur = text_info->glyphs + ++i;
1614 double height =
1615 text_info->lines[cur_line - 1].desc +
1616 text_info->lines[cur_line].asc;
1617 text_info->lines[cur_line - 1].len = i -
1618 text_info->lines[cur_line - 1].offset;
1619 text_info->lines[cur_line].offset = i;
1620 cur_line++;
1621 run_offset++;
1622 pen_shift_x = d6_to_double(-cur->pos.x);
1623 pen_shift_y += height + render_priv->settings.line_spacing;
1624 ass_msg(render_priv->library, MSGL_DBG2,
1625 "shifting from %d to %d by (%f, %f)", i,
1626 text_info->length - 1, pen_shift_x, pen_shift_y);
1628 cur->bm_run_id += run_offset;
1629 cur->pos.x += double_to_d6(pen_shift_x);
1630 cur->pos.y += double_to_d6(pen_shift_y);
1632 text_info->lines[cur_line - 1].len =
1633 text_info->length - text_info->lines[cur_line - 1].offset;
1635 #if 0
1636 // print line info
1637 for (i = 0; i < text_info->n_lines; i++) {
1638 printf("line %d offset %d length %d\n", i, text_info->lines[i].offset,
1639 text_info->lines[i].len);
1641 #endif
1645 * \brief Calculate base point for positioning and rotation
1646 * \param bbox text bbox
1647 * \param alignment alignment
1648 * \param bx, by out: base point coordinates
1650 static void get_base_point(DBBox *bbox, int alignment, double *bx, double *by)
1652 const int halign = alignment & 3;
1653 const int valign = alignment & 12;
1654 if (bx)
1655 switch (halign) {
1656 case HALIGN_LEFT:
1657 *bx = bbox->xMin;
1658 break;
1659 case HALIGN_CENTER:
1660 *bx = (bbox->xMax + bbox->xMin) / 2.0;
1661 break;
1662 case HALIGN_RIGHT:
1663 *bx = bbox->xMax;
1664 break;
1666 if (by)
1667 switch (valign) {
1668 case VALIGN_TOP:
1669 *by = bbox->yMin;
1670 break;
1671 case VALIGN_CENTER:
1672 *by = (bbox->yMax + bbox->yMin) / 2.0;
1673 break;
1674 case VALIGN_SUB:
1675 *by = bbox->yMax;
1676 break;
1681 * Prepare bitmap hash key of a glyph
1683 static void
1684 fill_bitmap_hash(ASS_Renderer *priv, GlyphInfo *info,
1685 OutlineBitmapHashKey *hash_key)
1687 hash_key->frx = rot_key(info->frx);
1688 hash_key->fry = rot_key(info->fry);
1689 hash_key->frz = rot_key(info->frz);
1690 hash_key->fax = double_to_d16(info->fax);
1691 hash_key->fay = double_to_d16(info->fay);
1692 hash_key->be = info->be;
1693 hash_key->blur = info->blur;
1694 hash_key->shadow_offset.x = double_to_d6(
1695 info->shadow_x * priv->border_scale -
1696 (int) (info->shadow_x * priv->border_scale));
1697 hash_key->shadow_offset.y = double_to_d6(
1698 info->shadow_y * priv->border_scale -
1699 (int) (info->shadow_y * priv->border_scale));
1703 * \brief Main ass rendering function, glues everything together
1704 * \param event event to render
1705 * \param event_images struct containing resulting images, will also be initialized
1706 * Process event, appending resulting ASS_Image's to images_root.
1708 static int
1709 ass_render_event(ASS_Renderer *render_priv, ASS_Event *event,
1710 EventImages *event_images)
1712 char *p;
1713 FT_UInt previous;
1714 FT_UInt num_glyphs;
1715 FT_Vector pen;
1716 unsigned code;
1717 DBBox bbox;
1718 int i, j;
1719 int MarginL, MarginR, MarginV;
1720 int last_break;
1721 int alignment, halign, valign;
1722 double device_x = 0;
1723 double device_y = 0;
1724 TextInfo *text_info = &render_priv->text_info;
1725 GlyphInfo *glyphs = render_priv->text_info.glyphs;
1726 ASS_Drawing *drawing;
1728 if (event->Style >= render_priv->track->n_styles) {
1729 ass_msg(render_priv->library, MSGL_WARN, "No style found");
1730 return 1;
1732 if (!event->Text) {
1733 ass_msg(render_priv->library, MSGL_WARN, "Empty event");
1734 return 1;
1737 init_render_context(render_priv, event);
1739 drawing = render_priv->state.drawing;
1740 text_info->length = 0;
1741 num_glyphs = 0;
1742 p = event->Text;
1744 // Event parsing.
1745 while (1) {
1746 // get next char, executing style override
1747 // this affects render_context
1748 do {
1749 code = get_next_char(render_priv, &p);
1750 if (render_priv->state.drawing_mode && code)
1751 ass_drawing_add_char(drawing, (char) code);
1752 } while (code && render_priv->state.drawing_mode); // skip everything in drawing mode
1754 if (text_info->length >= text_info->max_glyphs) {
1755 // Raise maximum number of glyphs
1756 text_info->max_glyphs *= 2;
1757 text_info->glyphs = glyphs =
1758 realloc(text_info->glyphs,
1759 sizeof(GlyphInfo) * text_info->max_glyphs);
1762 // Clear current GlyphInfo
1763 memset(&glyphs[text_info->length], 0, sizeof(GlyphInfo));
1765 // Parse drawing
1766 if (drawing->i) {
1767 drawing->scale_x = render_priv->state.scale_x *
1768 render_priv->font_scale;
1769 drawing->scale_y = render_priv->state.scale_y *
1770 render_priv->font_scale;
1771 p--;
1772 code = 0xfffc; // object replacement character
1773 glyphs[text_info->length].drawing = drawing;
1776 // face could have been changed in get_next_char
1777 if (!render_priv->state.font) {
1778 free_render_context(render_priv);
1779 return 1;
1782 if (code == 0)
1783 break;
1785 // Fill glyph information
1786 glyphs[text_info->length].symbol = code;
1787 glyphs[text_info->length].font = render_priv->state.font;
1788 for (i = 0; i < 4; ++i) {
1789 uint32_t clr = render_priv->state.c[i];
1790 change_alpha(&clr,
1791 mult_alpha(_a(clr), render_priv->state.fade), 1.);
1792 glyphs[text_info->length].c[i] = clr;
1794 glyphs[text_info->length].effect_type = render_priv->state.effect_type;
1795 glyphs[text_info->length].effect_timing =
1796 render_priv->state.effect_timing;
1797 glyphs[text_info->length].effect_skip_timing =
1798 render_priv->state.effect_skip_timing;
1799 glyphs[text_info->length].font_size = render_priv->state.font_size;
1800 glyphs[text_info->length].be = render_priv->state.be;
1801 glyphs[text_info->length].blur = render_priv->state.blur;
1802 glyphs[text_info->length].shadow_x = render_priv->state.shadow_x;
1803 glyphs[text_info->length].shadow_y = render_priv->state.shadow_y;
1804 glyphs[text_info->length].scale_x= render_priv->state.scale_x;
1805 glyphs[text_info->length].scale_y = render_priv->state.scale_y;
1806 glyphs[text_info->length].border_x= render_priv->state.border_x;
1807 glyphs[text_info->length].border_y = render_priv->state.border_y;
1808 glyphs[text_info->length].bold = render_priv->state.bold;
1809 glyphs[text_info->length].italic = render_priv->state.italic;
1810 glyphs[text_info->length].flags = render_priv->state.flags;
1811 glyphs[text_info->length].frx = render_priv->state.frx;
1812 glyphs[text_info->length].fry = render_priv->state.fry;
1813 glyphs[text_info->length].frz = render_priv->state.frz;
1814 glyphs[text_info->length].fax = render_priv->state.fax;
1815 glyphs[text_info->length].fay = render_priv->state.fay;
1816 glyphs[text_info->length].bm_run_id = render_priv->state.bm_run_id;
1818 if (glyphs[text_info->length].drawing) {
1819 drawing = render_priv->state.drawing =
1820 ass_drawing_new(render_priv->library, render_priv->ftlibrary);
1823 text_info->length++;
1825 render_priv->state.effect_type = EF_NONE;
1826 render_priv->state.effect_timing = 0;
1827 render_priv->state.effect_skip_timing = 0;
1831 if (text_info->length == 0) {
1832 // no valid symbols in the event; this can be smth like {comment}
1833 free_render_context(render_priv);
1834 return 1;
1837 // Find shape runs and shape text
1838 ass_shaper_find_runs(render_priv->shaper, render_priv, glyphs,
1839 text_info->length);
1840 ass_shaper_shape(render_priv->shaper, text_info);
1842 // Retrieve glyphs
1843 for (i = 0; i < text_info->length; i++) {
1844 GlyphInfo *info = glyphs + i;
1845 while (info) {
1846 get_outline_glyph(render_priv, info);
1847 info = info->next;
1849 info = glyphs + i;
1851 // add horizontal letter spacing
1852 info->cluster_advance.x += double_to_d6(render_priv->state.hspacing *
1853 render_priv->font_scale * info->scale_x);
1855 // add displacement for vertical shearing
1856 info->cluster_advance.y += (info->fay * info->scale_y) * info->cluster_advance.x;
1859 // Preliminary layout (for line wrapping)
1860 previous = 0;
1861 pen.x = 0;
1862 pen.y = 0;
1863 for (i = 0; i < text_info->length; i++) {
1864 GlyphInfo *info = glyphs + i;
1865 FT_Vector cluster_pen = pen;
1866 while (info) {
1868 #if 0
1869 // Add additional space after italic to non-italic style changes
1870 if (i && glyphs[i - 1].italic && !info->italic) {
1871 int back = i - 1;
1872 GlyphInfo *og = &glyphs[back];
1873 while (back && og->bbox.xMax - og->bbox.xMin == 0
1874 && og->italic)
1875 og = &glyphs[--back];
1876 if (og->bbox.xMax > og->advance.x) {
1877 // The FreeType oblique slants by 6/16
1878 pen.x += og->bbox.yMax * 0.375;
1881 #endif
1883 info->pos.x = cluster_pen.x;
1884 info->pos.y = cluster_pen.y;
1886 cluster_pen.x += info->advance.x;
1887 cluster_pen.y += info->advance.y;
1889 // fill bitmap hash
1890 info->hash_key.type = BITMAP_OUTLINE;
1891 fill_bitmap_hash(render_priv, info, &info->hash_key.u.outline);
1893 info = info->next;
1895 info = glyphs + i;
1896 pen.x += info->cluster_advance.x;
1897 pen.y += info->cluster_advance.y;
1898 previous = info->symbol;
1902 // depends on glyph x coordinates being monotonous, so it should be done before line wrap
1903 process_karaoke_effects(render_priv);
1905 // alignments
1906 alignment = render_priv->state.alignment;
1907 halign = alignment & 3;
1908 valign = alignment & 12;
1910 MarginL =
1911 (event->MarginL) ? event->MarginL : render_priv->state.style->MarginL;
1912 MarginR =
1913 (event->MarginR) ? event->MarginR : render_priv->state.style->MarginR;
1914 MarginV =
1915 (event->MarginV) ? event->MarginV : render_priv->state.style->MarginV;
1917 // calculate max length of a line
1918 double max_text_width =
1919 x2scr(render_priv, render_priv->track->PlayResX - MarginR) -
1920 x2scr(render_priv, MarginL);
1922 // wrap lines
1923 if (render_priv->state.evt_type != EVENT_HSCROLL) {
1924 // rearrange text in several lines
1925 wrap_lines_smart(render_priv, max_text_width);
1926 } else {
1927 // no breaking or wrapping, everything in a single line
1928 text_info->lines[0].offset = 0;
1929 text_info->lines[0].len = text_info->length;
1930 text_info->n_lines = 1;
1931 measure_text(render_priv);
1934 // Reorder text into visual order
1935 FriBidiStrIndex *cmap = ass_shaper_reorder(render_priv->shaper, text_info);
1937 // Reposition according to the map
1938 pen.x = 0;
1939 pen.y = 0;
1940 int lineno = 1;
1941 for (i = 0; i < text_info->length; i++) {
1942 GlyphInfo *info = glyphs + cmap[i];
1943 if (glyphs[i].linebreak) {
1944 pen.x = 0;
1945 pen.y += double_to_d6(text_info->lines[lineno-1].desc);
1946 pen.y += double_to_d6(text_info->lines[lineno].asc);
1947 pen.y += double_to_d6(render_priv->settings.line_spacing);
1948 lineno++;
1950 if (info->skip) continue;
1951 FT_Vector cluster_pen = pen;
1952 while (info) {
1953 info->pos.x = info->offset.x + cluster_pen.x;
1954 info->pos.y = info->offset.y + cluster_pen.y;
1955 cluster_pen.x += info->advance.x;
1956 cluster_pen.y += info->advance.y;
1957 info = info->next;
1959 info = glyphs + cmap[i];
1960 pen.x += info->cluster_advance.x;
1961 pen.y += info->cluster_advance.y;
1964 // align lines
1965 if (render_priv->state.evt_type != EVENT_HSCROLL) {
1966 last_break = -1;
1967 double width = 0;
1968 for (i = 0; i <= text_info->length; ++i) { // (text_info->length + 1) is the end of the last line
1969 if ((i == text_info->length) || glyphs[i].linebreak) {
1970 // remove letter spacing (which is included in cluster_advance)
1971 if (i > 0)
1972 width -= render_priv->state.hspacing * render_priv->font_scale *
1973 glyphs[i-1].scale_x;
1974 double shift = 0;
1975 if (halign == HALIGN_LEFT) { // left aligned, no action
1976 shift = 0;
1977 } else if (halign == HALIGN_RIGHT) { // right aligned
1978 shift = max_text_width - width;
1979 } else if (halign == HALIGN_CENTER) { // centered
1980 shift = (max_text_width - width) / 2.0;
1982 for (j = last_break + 1; j < i; ++j) {
1983 GlyphInfo *info = glyphs + j;
1984 while (info) {
1985 info->pos.x += double_to_d6(shift);
1986 info = info->next;
1989 last_break = i - 1;
1990 width = 0;
1992 if (i < text_info->length && !glyphs[i].skip &&
1993 glyphs[i].symbol != '\n' && glyphs[i].symbol != 0) {
1994 width += d6_to_double(glyphs[i].cluster_advance.x);
1999 // determing text bounding box
2000 compute_string_bbox(text_info, &bbox);
2002 // determine device coordinates for text
2004 // x coordinate for everything except positioned events
2005 if (render_priv->state.evt_type == EVENT_NORMAL ||
2006 render_priv->state.evt_type == EVENT_VSCROLL) {
2007 device_x = x2scr(render_priv, MarginL);
2008 } else if (render_priv->state.evt_type == EVENT_HSCROLL) {
2009 if (render_priv->state.scroll_direction == SCROLL_RL)
2010 device_x =
2011 x2scr(render_priv,
2012 render_priv->track->PlayResX -
2013 render_priv->state.scroll_shift);
2014 else if (render_priv->state.scroll_direction == SCROLL_LR)
2015 device_x =
2016 x2scr(render_priv,
2017 render_priv->state.scroll_shift) - (bbox.xMax -
2018 bbox.xMin);
2021 // y coordinate for everything except positioned events
2022 if (render_priv->state.evt_type == EVENT_NORMAL ||
2023 render_priv->state.evt_type == EVENT_HSCROLL) {
2024 if (valign == VALIGN_TOP) { // toptitle
2025 device_y =
2026 y2scr_top(render_priv,
2027 MarginV) + text_info->lines[0].asc;
2028 } else if (valign == VALIGN_CENTER) { // midtitle
2029 double scr_y =
2030 y2scr(render_priv, render_priv->track->PlayResY / 2.0);
2031 device_y = scr_y - (bbox.yMax + bbox.yMin) / 2.0;
2032 } else { // subtitle
2033 double scr_y;
2034 if (valign != VALIGN_SUB)
2035 ass_msg(render_priv->library, MSGL_V,
2036 "Invalid valign, assuming 0 (subtitle)");
2037 scr_y =
2038 y2scr_sub(render_priv,
2039 render_priv->track->PlayResY - MarginV);
2040 device_y = scr_y;
2041 device_y -= text_info->height;
2042 device_y += text_info->lines[0].asc;
2044 } else if (render_priv->state.evt_type == EVENT_VSCROLL) {
2045 if (render_priv->state.scroll_direction == SCROLL_TB)
2046 device_y =
2047 y2scr(render_priv,
2048 render_priv->state.clip_y0 +
2049 render_priv->state.scroll_shift) - (bbox.yMax -
2050 bbox.yMin);
2051 else if (render_priv->state.scroll_direction == SCROLL_BT)
2052 device_y =
2053 y2scr(render_priv,
2054 render_priv->state.clip_y1 -
2055 render_priv->state.scroll_shift);
2058 // positioned events are totally different
2059 if (render_priv->state.evt_type == EVENT_POSITIONED) {
2060 double base_x = 0;
2061 double base_y = 0;
2062 ass_msg(render_priv->library, MSGL_DBG2, "positioned event at %f, %f",
2063 render_priv->state.pos_x, render_priv->state.pos_y);
2064 get_base_point(&bbox, alignment, &base_x, &base_y);
2065 device_x =
2066 x2scr_pos(render_priv, render_priv->state.pos_x) - base_x;
2067 device_y =
2068 y2scr_pos(render_priv, render_priv->state.pos_y) - base_y;
2071 // fix clip coordinates (they depend on alignment)
2072 if (render_priv->state.evt_type == EVENT_NORMAL ||
2073 render_priv->state.evt_type == EVENT_HSCROLL ||
2074 render_priv->state.evt_type == EVENT_VSCROLL) {
2075 render_priv->state.clip_x0 =
2076 x2scr_scaled(render_priv, render_priv->state.clip_x0);
2077 render_priv->state.clip_x1 =
2078 x2scr_scaled(render_priv, render_priv->state.clip_x1);
2079 if (valign == VALIGN_TOP) {
2080 render_priv->state.clip_y0 =
2081 y2scr_top(render_priv, render_priv->state.clip_y0);
2082 render_priv->state.clip_y1 =
2083 y2scr_top(render_priv, render_priv->state.clip_y1);
2084 } else if (valign == VALIGN_CENTER) {
2085 render_priv->state.clip_y0 =
2086 y2scr(render_priv, render_priv->state.clip_y0);
2087 render_priv->state.clip_y1 =
2088 y2scr(render_priv, render_priv->state.clip_y1);
2089 } else if (valign == VALIGN_SUB) {
2090 render_priv->state.clip_y0 =
2091 y2scr_sub(render_priv, render_priv->state.clip_y0);
2092 render_priv->state.clip_y1 =
2093 y2scr_sub(render_priv, render_priv->state.clip_y1);
2095 } else if (render_priv->state.evt_type == EVENT_POSITIONED) {
2096 render_priv->state.clip_x0 =
2097 x2scr_pos_scaled(render_priv, render_priv->state.clip_x0);
2098 render_priv->state.clip_x1 =
2099 x2scr_pos_scaled(render_priv, render_priv->state.clip_x1);
2100 render_priv->state.clip_y0 =
2101 y2scr_pos(render_priv, render_priv->state.clip_y0);
2102 render_priv->state.clip_y1 =
2103 y2scr_pos(render_priv, render_priv->state.clip_y1);
2106 // calculate rotation parameters
2108 DVector center;
2110 if (render_priv->state.have_origin) {
2111 center.x = x2scr(render_priv, render_priv->state.org_x);
2112 center.y = y2scr(render_priv, render_priv->state.org_y);
2113 } else {
2114 double bx = 0., by = 0.;
2115 get_base_point(&bbox, alignment, &bx, &by);
2116 center.x = device_x + bx;
2117 center.y = device_y + by;
2120 for (i = 0; i < text_info->length; ++i) {
2121 GlyphInfo *info = glyphs + i;
2122 while (info) {
2123 OutlineBitmapHashKey *key = &info->hash_key.u.outline;
2125 if (key->frx || key->fry || key->frz || key->fax || key->fay) {
2126 key->shift_x = info->pos.x + double_to_d6(device_x - center.x);
2127 key->shift_y = -(info->pos.y + double_to_d6(device_y - center.y));
2128 } else {
2129 key->shift_x = 0;
2130 key->shift_y = 0;
2132 info = info->next;
2137 // convert glyphs to bitmaps
2138 device_x *= render_priv->font_scale_x;
2139 for (i = 0; i < text_info->length; ++i) {
2140 GlyphInfo *info = glyphs + i;
2141 while (info) {
2142 OutlineBitmapHashKey *key = &info->hash_key.u.outline;
2143 info->pos.x *= render_priv->font_scale_x;
2144 key->advance.x =
2145 double_to_d6(device_x - (int) device_x +
2146 d6_to_double(info->pos.x & SUBPIXEL_MASK)) & ~SUBPIXEL_ACCURACY;
2147 key->advance.y =
2148 double_to_d6(device_y - (int) device_y +
2149 d6_to_double(info->pos.y & SUBPIXEL_MASK)) & ~SUBPIXEL_ACCURACY;
2150 get_bitmap_glyph(render_priv, info);
2151 info = info->next;
2155 #if 0
2156 // Compute runs and their bboxes
2157 // XXX: currently does nothing visible/functional
2158 for (i = 0; i < text_info->length; i++) {
2159 GlyphInfo *g = glyphs + i;
2160 OutlineBitmapHashKey *key = &g->hash_key.u.outline;
2161 int w, h;
2163 // skip non-visual glyphs
2164 if (g->skip || g->symbol == '\n' || g->symbol == 0)
2165 continue;
2167 // Determine run length and compute run bbox
2168 int run_len = 0;
2169 int cur_run = g->bm_run_id;
2170 while (g->bm_run_id == cur_run && (i + run_len) < text_info->length) {
2171 g++;
2172 run_len++;
2174 g = glyphs + i;
2175 compute_run_size(g, run_len, &w, &h);
2176 //printf("run_id %d len %d size %d %d\n", g->bm_run_id, run_len, w, h);
2178 i += run_len - 1;
2180 #endif
2182 memset(event_images, 0, sizeof(*event_images));
2183 event_images->top = device_y - text_info->lines[0].asc;
2184 event_images->height = text_info->height;
2185 event_images->left =
2186 (device_x + bbox.xMin * render_priv->font_scale_x) + 0.5;
2187 event_images->width =
2188 (bbox.xMax - bbox.xMin) * render_priv->font_scale_x + 0.5;
2189 event_images->detect_collisions = render_priv->state.detect_collisions;
2190 event_images->shift_direction = (valign == VALIGN_TOP) ? 1 : -1;
2191 event_images->event = event;
2192 event_images->imgs = render_text(render_priv, (int) device_x, (int) device_y);
2194 ass_shaper_cleanup(render_priv->shaper, text_info);
2195 free_render_context(render_priv);
2197 return 0;
2201 * \brief deallocate image list
2202 * \param img list pointer
2204 void ass_free_images(ASS_Image *img)
2206 while (img) {
2207 ASS_Image *next = img->next;
2208 free(img);
2209 img = next;
2214 * \brief Check cache limits and reset cache if they are exceeded
2216 static void check_cache_limits(ASS_Renderer *priv, CacheStore *cache)
2218 if (ass_cache_empty(cache->bitmap_cache, cache->bitmap_max_size)) {
2219 ass_cache_empty(cache->composite_cache, 0);
2220 ass_free_images(priv->prev_images_root);
2221 priv->prev_images_root = 0;
2223 if (ass_cache_empty(cache->outline_cache, cache->glyph_max)) {
2224 ass_cache_empty(cache->bitmap_cache, 0);
2225 ass_cache_empty(cache->composite_cache, 0);
2226 ass_free_images(priv->prev_images_root);
2227 priv->prev_images_root = 0;
2232 * \brief Start a new frame
2234 static int
2235 ass_start_frame(ASS_Renderer *render_priv, ASS_Track *track,
2236 long long now)
2238 ASS_Settings *settings_priv = &render_priv->settings;
2240 if (!render_priv->settings.frame_width
2241 && !render_priv->settings.frame_height)
2242 return 1; // library not initialized
2244 if (render_priv->library != track->library)
2245 return 1;
2247 if (!render_priv->fontconfig_priv)
2248 return 1;
2250 free_list_clear(render_priv);
2252 if (track->n_events == 0)
2253 return 1; // nothing to do
2255 render_priv->track = track;
2256 render_priv->time = now;
2258 ass_lazy_track_init(render_priv->library, render_priv->track);
2260 render_priv->font_scale = settings_priv->font_size_coeff *
2261 render_priv->orig_height / render_priv->track->PlayResY;
2262 if (render_priv->track->ScaledBorderAndShadow)
2263 render_priv->border_scale =
2264 ((double) render_priv->orig_height) /
2265 render_priv->track->PlayResY;
2266 else
2267 render_priv->border_scale = 1.;
2269 ass_shaper_set_kerning(render_priv->shaper, track->Kerning);
2271 // PAR correction
2272 render_priv->font_scale_x = render_priv->settings.aspect /
2273 render_priv->settings.storage_aspect;
2275 render_priv->prev_images_root = render_priv->images_root;
2276 render_priv->images_root = 0;
2278 check_cache_limits(render_priv, &render_priv->cache);
2280 return 0;
2283 static int cmp_event_layer(const void *p1, const void *p2)
2285 ASS_Event *e1 = ((EventImages *) p1)->event;
2286 ASS_Event *e2 = ((EventImages *) p2)->event;
2287 if (e1->Layer < e2->Layer)
2288 return -1;
2289 if (e1->Layer > e2->Layer)
2290 return 1;
2291 if (e1->ReadOrder < e2->ReadOrder)
2292 return -1;
2293 if (e1->ReadOrder > e2->ReadOrder)
2294 return 1;
2295 return 0;
2298 static ASS_RenderPriv *get_render_priv(ASS_Renderer *render_priv,
2299 ASS_Event *event)
2301 if (!event->render_priv)
2302 event->render_priv = calloc(1, sizeof(ASS_RenderPriv));
2303 if (render_priv->render_id != event->render_priv->render_id) {
2304 memset(event->render_priv, 0, sizeof(ASS_RenderPriv));
2305 event->render_priv->render_id = render_priv->render_id;
2308 return event->render_priv;
2311 static int overlap(Segment *s1, Segment *s2)
2313 if (s1->a >= s2->b || s2->a >= s1->b ||
2314 s1->ha >= s2->hb || s2->ha >= s1->hb)
2315 return 0;
2316 return 1;
2319 static int cmp_segment(const void *p1, const void *p2)
2321 return ((Segment *) p1)->a - ((Segment *) p2)->a;
2324 static void
2325 shift_event(ASS_Renderer *render_priv, EventImages *ei, int shift)
2327 ASS_Image *cur = ei->imgs;
2328 while (cur) {
2329 cur->dst_y += shift;
2330 // clip top and bottom
2331 if (cur->dst_y < 0) {
2332 int clip = -cur->dst_y;
2333 cur->h -= clip;
2334 cur->bitmap += clip * cur->stride;
2335 cur->dst_y = 0;
2337 if (cur->dst_y + cur->h >= render_priv->height) {
2338 int clip = cur->dst_y + cur->h - render_priv->height;
2339 cur->h -= clip;
2341 if (cur->h <= 0) {
2342 cur->h = 0;
2343 cur->dst_y = 0;
2345 cur = cur->next;
2347 ei->top += shift;
2350 // dir: 1 - move down
2351 // -1 - move up
2352 static int fit_segment(Segment *s, Segment *fixed, int *cnt, int dir)
2354 int i;
2355 int shift = 0;
2357 if (dir == 1) // move down
2358 for (i = 0; i < *cnt; ++i) {
2359 if (s->b + shift <= fixed[i].a || s->a + shift >= fixed[i].b ||
2360 s->hb <= fixed[i].ha || s->ha >= fixed[i].hb)
2361 continue;
2362 shift = fixed[i].b - s->a;
2363 } else // dir == -1, move up
2364 for (i = *cnt - 1; i >= 0; --i) {
2365 if (s->b + shift <= fixed[i].a || s->a + shift >= fixed[i].b ||
2366 s->hb <= fixed[i].ha || s->ha >= fixed[i].hb)
2367 continue;
2368 shift = fixed[i].a - s->b;
2371 fixed[*cnt].a = s->a + shift;
2372 fixed[*cnt].b = s->b + shift;
2373 fixed[*cnt].ha = s->ha;
2374 fixed[*cnt].hb = s->hb;
2375 (*cnt)++;
2376 qsort(fixed, *cnt, sizeof(Segment), cmp_segment);
2378 return shift;
2381 static void
2382 fix_collisions(ASS_Renderer *render_priv, EventImages *imgs, int cnt)
2384 Segment *used = malloc(cnt * sizeof(*used));
2385 int cnt_used = 0;
2386 int i, j;
2388 // fill used[] with fixed events
2389 for (i = 0; i < cnt; ++i) {
2390 ASS_RenderPriv *priv;
2391 if (!imgs[i].detect_collisions)
2392 continue;
2393 priv = get_render_priv(render_priv, imgs[i].event);
2394 if (priv->height > 0) { // it's a fixed event
2395 Segment s;
2396 s.a = priv->top;
2397 s.b = priv->top + priv->height;
2398 s.ha = priv->left;
2399 s.hb = priv->left + priv->width;
2400 if (priv->height != imgs[i].height) { // no, it's not
2401 ass_msg(render_priv->library, MSGL_WARN,
2402 "Event height has changed");
2403 priv->top = 0;
2404 priv->height = 0;
2405 priv->left = 0;
2406 priv->width = 0;
2408 for (j = 0; j < cnt_used; ++j)
2409 if (overlap(&s, used + j)) { // no, it's not
2410 priv->top = 0;
2411 priv->height = 0;
2412 priv->left = 0;
2413 priv->width = 0;
2415 if (priv->height > 0) { // still a fixed event
2416 used[cnt_used].a = priv->top;
2417 used[cnt_used].b = priv->top + priv->height;
2418 used[cnt_used].ha = priv->left;
2419 used[cnt_used].hb = priv->left + priv->width;
2420 cnt_used++;
2421 shift_event(render_priv, imgs + i, priv->top - imgs[i].top);
2425 qsort(used, cnt_used, sizeof(Segment), cmp_segment);
2427 // try to fit other events in free spaces
2428 for (i = 0; i < cnt; ++i) {
2429 ASS_RenderPriv *priv;
2430 if (!imgs[i].detect_collisions)
2431 continue;
2432 priv = get_render_priv(render_priv, imgs[i].event);
2433 if (priv->height == 0) { // not a fixed event
2434 int shift;
2435 Segment s;
2436 s.a = imgs[i].top;
2437 s.b = imgs[i].top + imgs[i].height;
2438 s.ha = imgs[i].left;
2439 s.hb = imgs[i].left + imgs[i].width;
2440 shift = fit_segment(&s, used, &cnt_used, imgs[i].shift_direction);
2441 if (shift)
2442 shift_event(render_priv, imgs + i, shift);
2443 // make it fixed
2444 priv->top = imgs[i].top;
2445 priv->height = imgs[i].height;
2446 priv->left = imgs[i].left;
2447 priv->width = imgs[i].width;
2452 free(used);
2456 * \brief compare two images
2457 * \param i1 first image
2458 * \param i2 second image
2459 * \return 0 if identical, 1 if different positions, 2 if different content
2461 static int ass_image_compare(ASS_Image *i1, ASS_Image *i2)
2463 if (i1->w != i2->w)
2464 return 2;
2465 if (i1->h != i2->h)
2466 return 2;
2467 if (i1->stride != i2->stride)
2468 return 2;
2469 if (i1->color != i2->color)
2470 return 2;
2471 if (i1->bitmap != i2->bitmap)
2472 return 2;
2473 if (i1->dst_x != i2->dst_x)
2474 return 1;
2475 if (i1->dst_y != i2->dst_y)
2476 return 1;
2477 return 0;
2481 * \brief compare current and previous image list
2482 * \param priv library handle
2483 * \return 0 if identical, 1 if different positions, 2 if different content
2485 static int ass_detect_change(ASS_Renderer *priv)
2487 ASS_Image *img, *img2;
2488 int diff;
2490 img = priv->prev_images_root;
2491 img2 = priv->images_root;
2492 diff = 0;
2493 while (img && diff < 2) {
2494 ASS_Image *next, *next2;
2495 next = img->next;
2496 if (img2) {
2497 int d = ass_image_compare(img, img2);
2498 if (d > diff)
2499 diff = d;
2500 next2 = img2->next;
2501 } else {
2502 // previous list is shorter
2503 diff = 2;
2504 break;
2506 img = next;
2507 img2 = next2;
2510 // is the previous list longer?
2511 if (img2)
2512 diff = 2;
2514 return diff;
2518 * \brief render a frame
2519 * \param priv library handle
2520 * \param track track
2521 * \param now current video timestamp (ms)
2522 * \param detect_change a value describing how the new images differ from the previous ones will be written here:
2523 * 0 if identical, 1 if different positions, 2 if different content.
2524 * Can be NULL, in that case no detection is performed.
2526 ASS_Image *ass_render_frame(ASS_Renderer *priv, ASS_Track *track,
2527 long long now, int *detect_change)
2529 int i, cnt, rc;
2530 EventImages *last;
2531 ASS_Image **tail;
2533 // init frame
2534 rc = ass_start_frame(priv, track, now);
2535 if (rc != 0)
2536 return 0;
2538 // render events separately
2539 cnt = 0;
2540 for (i = 0; i < track->n_events; ++i) {
2541 ASS_Event *event = track->events + i;
2542 if ((event->Start <= now)
2543 && (now < (event->Start + event->Duration))) {
2544 if (cnt >= priv->eimg_size) {
2545 priv->eimg_size += 100;
2546 priv->eimg =
2547 realloc(priv->eimg,
2548 priv->eimg_size * sizeof(EventImages));
2550 rc = ass_render_event(priv, event, priv->eimg + cnt);
2551 if (!rc)
2552 ++cnt;
2556 // sort by layer
2557 qsort(priv->eimg, cnt, sizeof(EventImages), cmp_event_layer);
2559 // call fix_collisions for each group of events with the same layer
2560 last = priv->eimg;
2561 for (i = 1; i < cnt; ++i)
2562 if (last->event->Layer != priv->eimg[i].event->Layer) {
2563 fix_collisions(priv, last, priv->eimg + i - last);
2564 last = priv->eimg + i;
2566 if (cnt > 0)
2567 fix_collisions(priv, last, priv->eimg + cnt - last);
2569 // concat lists
2570 tail = &priv->images_root;
2571 for (i = 0; i < cnt; ++i) {
2572 ASS_Image *cur = priv->eimg[i].imgs;
2573 while (cur) {
2574 *tail = cur;
2575 tail = &cur->next;
2576 cur = cur->next;
2580 if (detect_change)
2581 *detect_change = ass_detect_change(priv);
2583 // free the previous image list
2584 ass_free_images(priv->prev_images_root);
2585 priv->prev_images_root = 0;
2587 return priv->images_root;