sub/ass_mp.c

   1 /*
   2  * Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
   3  *
   4  * This file is part of MPlayer.
   5  *
   6  * MPlayer 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.
  10  *
  11  * MPlayer 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.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with libass; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19  */
  20
  21 #include <inttypes.h>
  22 #include <string.h>
  23 #include <stdlib.h>
  24 #include <stdarg.h>
  25 #include <stdbool.h>
  26
  27 #include <ass/ass.h>
  28 #include <ass/ass_types.h>
  29
  30 #include <libavutil/common.h>
  31
  32 #include "config.h"
  33 #include "mp_msg.h"
  34 #include "path.h"
  35 #include "ass_mp.h"
  36 #include "subreader.h"
  37 #include "stream/stream.h"
  38
  39 #ifdef CONFIG_FONTCONFIG
  40 #include <fontconfig/fontconfig.h>
  41 #endif
  42
  43 // libass-related command line options
  44 ASS_Library *ass_library;
  45 float ass_font_scale = 1.;
  46 float ass_line_spacing = 0.;
  47 int ass_top_margin = 0;
  48 int ass_bottom_margin = 0;
  49 int use_embedded_fonts = 1;
  50 char **ass_force_style_list = NULL;
  51 int ass_use_margins = 0;
  52 char *ass_color = NULL;
  53 char *ass_border_color = NULL;
  54 char *ass_styles_file = NULL;
  55 int ass_hinting = ASS_HINTING_LIGHT + 4;       // light hinting for unscaled osd
  56
  57 #ifdef CONFIG_FONTCONFIG
  58 extern int font_fontconfig;
  59 #else
  60 static int font_fontconfig = -1;
  61 #endif
  62 extern char *font_name;
  63 extern char *sub_font_name;
  64 extern float text_font_scale_factor;
  65 extern int subtitle_autoscale;
  66
  67 #ifdef CONFIG_ICONV
  68 extern char *sub_cp;
  69 #else
  70 static char *sub_cp = 0;
  71 #endif
  72
  73 ASS_Track *mp_ass_default_track(ASS_Library *library)
  74 {
  75     ASS_Track *track = ass_new_track(library);
  76
  77     track->track_type = TRACK_TYPE_ASS;
  78     track->Timer = 100.;
  79     track->PlayResY = 288;
  80     track->WrapStyle = 0;
  81
  82     if (ass_styles_file)
  83         ass_read_styles(track, ass_styles_file, sub_cp);
  84
  85     if (track->n_styles == 0) {
  86         track->Kerning = true;
  87         int sid = ass_alloc_style(track);
  88         ASS_Style *style = track->styles + sid;
  89         style->Name = strdup("Default");
  90         style->FontName = (font_fontconfig >= 0
  91                            && sub_font_name) ? strdup(sub_font_name)
  92             : (font_fontconfig >= 0
  93                && font_name) ? strdup(font_name) : strdup("Sans");
  94         style->treat_fontname_as_pattern = 1;
  95
  96         double fs = track->PlayResY * text_font_scale_factor / 100.;
  97         /* The font size is always proportional to video height only;
  98          * real -subfont-autoscale behavior is not implemented.
  99          * Apply a correction that corresponds to about 4:3 aspect ratio
 100          * video to get a size somewhat closer to what non-libass rendering
 101          * would produce with the same text_font_scale_factor
 102          * and subtitle_autoscale.
 103          */
 104         if (subtitle_autoscale == 2)
 105             fs *= 1.3;
 106         else if (subtitle_autoscale == 3)
 107             fs *= 1.7;
 108
 109         uint32_t c1 = 0xFFFFFF00;
 110         uint32_t c2 = 0x00000000;
 111         if (ass_color)
 112             c1 = strtoll(ass_color, NULL, 16);
 113         if (ass_border_color)
 114             c2 = strtoll(ass_border_color, NULL, 16);
 115
 116         style->FontSize = fs;
 117         style->PrimaryColour = c1;
 118         style->SecondaryColour = c1;
 119         style->OutlineColour = c2;
 120         style->BackColour = 0x00000000;
 121         style->BorderStyle = 1;
 122         style->Alignment = 2;
 123         style->Outline = fs / 16;
 124         style->MarginL = 10;
 125         style->MarginR = 10;
 126         style->MarginV = 5;
 127         style->ScaleX = 1.;
 128         style->ScaleY = 1.;
 129     }
 130
 131     ass_process_force_style(track);
 132     return track;
 133 }
 134
 135 static int check_duplicate_plaintext_event(ASS_Track *track)
 136 {
 137     int i;
 138     ASS_Event *evt = track->events + track->n_events - 1;
 139
 140     for (i = 0; i < track->n_events - 1; ++i)   // ignoring last event, it is the one we are comparing with
 141         if (track->events[i].Start == evt->Start &&
 142             track->events[i].Duration == evt->Duration &&
 143             strcmp(track->events[i].Text, evt->Text) == 0)
 144             return 1;
 145     return 0;
 146 }
 147
 148 /**
 149  * \brief Convert subtitle to ASS_Events for the given track
 150  * \param track track
 151  * \param sub subtitle to convert
 152  * \return event id
 153  * note: assumes that subtitle is _not_ fps-based; caller must manually correct
 154  *   Start and Duration in other case.
 155  **/
 156 static int ass_process_subtitle(ASS_Track *track, subtitle *sub)
 157 {
 158     int eid;
 159     ASS_Event *event;
 160     int len = 0, j;
 161     char *p;
 162     char *end;
 163
 164     eid = ass_alloc_event(track);
 165     event = track->events + eid;
 166
 167     event->Start = sub->start * 10;
 168     event->Duration = (sub->end - sub->start) * 10;
 169     event->Style = 0;
 170
 171     for (j = 0; j < sub->lines; ++j)
 172         len += sub->text[j] ? strlen(sub->text[j]) : 0;
 173
 174     len += 2 * sub->lines;      // '\N', including the one after the last line
 175     len += 6;                   // {\anX}
 176     len += 1;                   // '\0'
 177
 178     event->Text = malloc(len);
 179     end = event->Text + len;
 180     p = event->Text;
 181
 182     if (sub->alignment)
 183         p += snprintf(p, end - p, "{\\an%d}", sub->alignment);
 184
 185     for (j = 0; j < sub->lines; ++j)
 186         p += snprintf(p, end - p, "%s\\N", sub->text[j]);
 187
 188     if (sub->lines > 0)
 189         p -= 2;                 // remove last "\N"
 190     *p = 0;
 191
 192     if (check_duplicate_plaintext_event(track)) {
 193         ass_free_event(track, eid);
 194         track->n_events--;
 195         return -1;
 196     }
 197
 198     mp_msg(MSGT_ASS, MSGL_V,
 199            "plaintext event at %" PRId64 ", +%" PRId64 ": %s  \n",
 200            (int64_t) event->Start, (int64_t) event->Duration, event->Text);
 201
 202     return eid;
 203 }
 204
 205
 206 /**
 207  * \brief Convert subdata to ASS_Track
 208  * \param subdata subtitles struct from subreader
 209  * \param fps video framerate
 210  * \return newly allocated ASS_Track, filled with subtitles from subdata
 211  */
 212 ASS_Track *mp_ass_read_subdata(ASS_Library *library, sub_data *subdata,
 213                                double fps)
 214 {
 215     ASS_Track *track;
 216     int i;
 217
 218     track = mp_ass_default_track(library);
 219     track->name = subdata->filename ? strdup(subdata->filename) : 0;
 220
 221     for (i = 0; i < subdata->sub_num; ++i) {
 222         int eid = ass_process_subtitle(track, subdata->subtitles + i);
 223         if (eid < 0)
 224             continue;
 225         if (!subdata->sub_uses_time) {
 226             track->events[eid].Start *= 100. / fps;
 227             track->events[eid].Duration *= 100. / fps;
 228         }
 229     }
 230     return track;
 231 }
 232
 233 ASS_Track *mp_ass_read_stream(ASS_Library *library, const char *fname,
 234                               char *charset)
 235 {
 236     int i;
 237     char *buf = NULL;
 238     ASS_Track *track;
 239     size_t sz = 0;
 240     size_t buf_alloc = 0;
 241     stream_t *fd;
 242
 243     fd = open_stream(fname, NULL, NULL);
 244     if (!fd)
 245         // Stream code should have printed an error already
 246         return NULL;
 247     if (fd->end_pos > STREAM_BUFFER_SIZE)
 248         /* read entire file if size is known */
 249         buf_alloc = fd->end_pos;
 250     else
 251         buf_alloc = 1000;
 252     for (;;) {
 253         if (sz > 100000000) {
 254             mp_tmsg(MSGT_ASS, MSGL_ERR, "Refusing to load subtitle file "
 255                     "larger than 100 MB: %s\n", fname);
 256             sz = 0;
 257             break;
 258         }
 259         buf_alloc = FFMAX(buf_alloc, sz + (sz >> 1));
 260         buf_alloc = FFMIN(buf_alloc, 100000001);
 261         buf = realloc(buf, buf_alloc + 1);
 262         i = stream_read(fd, buf + sz, buf_alloc - sz);
 263         if (i <= 0)
 264             break;
 265         sz += i;
 266     }
 267     free_stream(fd);
 268     if (!sz) {
 269         free(buf);
 270         return NULL;
 271     }
 272     buf[sz] = 0;
 273     buf = realloc(buf, sz + 1);
 274     track = ass_read_memory(library, buf, sz, charset);
 275     if (track) {
 276         free(track->name);
 277         track->name = strdup(fname);
 278     }
 279     free(buf);
 280     return track;
 281 }
 282
 283 void mp_ass_configure(ASS_Renderer *priv, int w, int h, bool unscaled)
 284 {
 285     int hinting;
 286     ass_set_frame_size(priv, w, h);
 287     ass_set_margins(priv, ass_top_margin, ass_bottom_margin, 0, 0);
 288     ass_set_use_margins(priv, ass_use_margins);
 289     ass_set_font_scale(priv, ass_font_scale);
 290     if (!unscaled && (ass_hinting & 4))
 291         hinting = 0;
 292     else
 293         hinting = ass_hinting & 3;
 294     ass_set_hinting(priv, hinting);
 295     ass_set_line_spacing(priv, ass_line_spacing);
 296 }
 297
 298 void mp_ass_configure_fonts(ASS_Renderer *priv)
 299 {
 300     char *dir, *path, *family;
 301     dir = get_path("fonts");
 302     if (font_fontconfig < 0 && sub_font_name)
 303         path = strdup(sub_font_name);
 304     else if (font_fontconfig < 0 && font_name)
 305         path = strdup(font_name);
 306     else
 307         path = get_path("subfont.ttf");
 308     if (font_fontconfig >= 0 && sub_font_name)
 309         family = strdup(sub_font_name);
 310     else if (font_fontconfig >= 0 && font_name)
 311         family = strdup(font_name);
 312     else
 313         family = 0;
 314
 315     ass_set_fonts(priv, path, family, font_fontconfig + 1, NULL, 1);
 316
 317     free(dir);
 318     free(path);
 319     free(family);
 320 }
 321
 322 static void message_callback(int level, const char *format, va_list va, void *ctx)
 323 {
 324     mp_msg(MSGT_ASS, level, "[ass] ");
 325     mp_msg_va(MSGT_ASS, level, format, va);
 326     // libass messages lack trailing \n
 327     mp_msg(MSGT_ASS, level, "\n");
 328 }
 329
 330 ASS_Library *mp_ass_init(void)
 331 {
 332     ASS_Library *priv;
 333     char *path = get_path("fonts");
 334     priv = ass_library_init();
 335     ass_set_message_cb(priv, message_callback, NULL);
 336     ass_set_fonts_dir(priv, path);
 337     ass_set_extract_fonts(priv, use_embedded_fonts);
 338     ass_set_style_overrides(priv, ass_force_style_list);
 339     free(path);
 340     return priv;
 341 }
 342
 343 int ass_force_reload = 0;       // flag set if global ass-related settings were changed
 344
 345 ASS_Image *mp_ass_render_frame(ASS_Renderer *priv, ASS_Track *track,
 346                                long long now, int *detect_change)
 347 {
 348     if (ass_force_reload) {
 349         ass_set_margins(priv, ass_top_margin, ass_bottom_margin, 0, 0);
 350         ass_set_use_margins(priv, ass_use_margins);
 351         ass_set_font_scale(priv, ass_font_scale);
 352         ass_force_reload = 0;
 353     }
 354     return ass_render_frame(priv, track, now, detect_change);
 355 }