mpv/sub/ass_mp.c

/*
 * Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
 *
 * This file is part of MPlayer.
 *
 * MPlayer is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * MPlayer is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with libass; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#include <inttypes.h>
#include <string.h>
#include <stdlib.h>
#include <stdarg.h>
#include <stdbool.h>

#include <ass/ass.h>
#include <ass/ass_types.h>

#include <libavutil/common.h>

#include "config.h"
#include "mp_msg.h"
#include "path.h"
#include "ass_mp.h"
#include "subreader.h"
#include "stream/stream.h"

#ifdef CONFIG_FONTCONFIG
#include <fontconfig/fontconfig.h>
#endif

// libass-related command line options
ASS_Library *ass_library;
float ass_font_scale = 1.;
float ass_line_spacing = 0.;
int ass_top_margin = 0;
int ass_bottom_margin = 0;
int use_embedded_fonts = 1;
char **ass_force_style_list = NULL;
int ass_use_margins = 0;
char *ass_color = NULL;
char *ass_border_color = NULL;
char *ass_styles_file = NULL;
int ass_hinting = ASS_HINTING_LIGHT + 4;       // light hinting for unscaled osd

#ifdef CONFIG_FONTCONFIG
extern int font_fontconfig;
#else
static int font_fontconfig = -1;
#endif
extern char *font_name;
extern char *sub_font_name;
extern float text_font_scale_factor;
extern int subtitle_autoscale;

#ifdef CONFIG_ICONV
extern char *sub_cp;
#else
static char *sub_cp = 0;
#endif

ASS_Track *mp_ass_default_track(ASS_Library *library)
{
    ASS_Track *track = ass_new_track(library);

    track->track_type = TRACK_TYPE_ASS;
    track->Timer = 100.;
    track->PlayResY = 288;
    track->WrapStyle = 0;

    if (ass_styles_file)
        ass_read_styles(track, ass_styles_file, sub_cp);

    if (track->n_styles == 0) {
        track->Kerning = true;
        int sid = ass_alloc_style(track);
        ASS_Style *style = track->styles + sid;
        style->Name = strdup("Default");
        style->FontName = (font_fontconfig >= 0
                           && sub_font_name) ? strdup(sub_font_name)
            : (font_fontconfig >= 0
               && font_name) ? strdup(font_name) : strdup("Sans");
        style->treat_fontname_as_pattern = 1;

        double fs = track->PlayResY * text_font_scale_factor / 100.;
        /* The font size is always proportional to video height only;
         * real -subfont-autoscale behavior is not implemented.
         * Apply a correction that corresponds to about 4:3 aspect ratio
         * video to get a size somewhat closer to what non-libass rendering
         * would produce with the same text_font_scale_factor
         * and subtitle_autoscale.
         */
        if (subtitle_autoscale == 2)
            fs *= 1.3;
        else if (subtitle_autoscale == 3)
            fs *= 1.7;

        uint32_t c1 = 0xFFFFFF00;
        uint32_t c2 = 0x00000000;
        if (ass_color)
            c1 = strtoll(ass_color, NULL, 16);
        if (ass_border_color)
            c2 = strtoll(ass_border_color, NULL, 16);

        style->FontSize = fs;
        style->PrimaryColour = c1;
        style->SecondaryColour = c1;
        style->OutlineColour = c2;
        style->BackColour = 0x00000000;
        style->BorderStyle = 1;
        style->Alignment = 2;
        style->Outline = fs / 16;
        style->MarginL = 10;
        style->MarginR = 10;
        style->MarginV = 5;
        style->ScaleX = 1.;
        style->ScaleY = 1.;
    }

    ass_process_force_style(track);
    return track;
}

static int check_duplicate_plaintext_event(ASS_Track *track)
{
    int i;
    ASS_Event *evt = track->events + track->n_events - 1;

    for (i = 0; i < track->n_events - 1; ++i)   // ignoring last event, it is the one we are comparing with
        if (track->events[i].Start == evt->Start &&
            track->events[i].Duration == evt->Duration &&
            strcmp(track->events[i].Text, evt->Text) == 0)
            return 1;
    return 0;
}

/**
 * \brief Convert subtitle to ASS_Events for the given track
 * \param track track
 * \param sub subtitle to convert
 * \return event id
 * note: assumes that subtitle is _not_ fps-based; caller must manually correct
 *   Start and Duration in other case.
 **/
static int ass_process_subtitle(ASS_Track *track, subtitle *sub)
{
    int eid;
    ASS_Event *event;
    int len = 0, j;
    char *p;
    char *end;

    eid = ass_alloc_event(track);
    event = track->events + eid;

    event->Start = sub->start * 10;
    event->Duration = (sub->end - sub->start) * 10;
    event->Style = 0;

    for (j = 0; j < sub->lines; ++j)
        len += sub->text[j] ? strlen(sub->text[j]) : 0;

    len += 2 * sub->lines;      // '\N', including the one after the last line
    len += 6;                   // {\anX}
    len += 1;                   // '\0'

    event->Text = malloc(len);
    end = event->Text + len;
    p = event->Text;

    if (sub->alignment)
        p += snprintf(p, end - p, "{\\an%d}", sub->alignment);

    for (j = 0; j < sub->lines; ++j)
        p += snprintf(p, end - p, "%s\\N", sub->text[j]);

    if (sub->lines > 0)
        p -= 2;                 // remove last "\N"
    *p = 0;

    if (check_duplicate_plaintext_event(track)) {
        ass_free_event(track, eid);
        track->n_events--;
        return -1;
    }

    mp_msg(MSGT_ASS, MSGL_V,
           "plaintext event at %" PRId64 ", +%" PRId64 ": %s  \n",
           (int64_t) event->Start, (int64_t) event->Duration, event->Text);

    return eid;
}


/**
 * \brief Convert subdata to ASS_Track
 * \param subdata subtitles struct from subreader
 * \param fps video framerate
 * \return newly allocated ASS_Track, filled with subtitles from subdata
 */
ASS_Track *mp_ass_read_subdata(ASS_Library *library, sub_data *subdata,
                               double fps)
{
    ASS_Track *track;
    int i;

    track = mp_ass_default_track(library);
    track->name = subdata->filename ? strdup(subdata->filename) : 0;

    for (i = 0; i < subdata->sub_num; ++i) {
        int eid = ass_process_subtitle(track, subdata->subtitles + i);
        if (eid < 0)
            continue;
        if (!subdata->sub_uses_time) {
            track->events[eid].Start *= 100. / fps;
            track->events[eid].Duration *= 100. / fps;
        }
    }
    return track;
}

ASS_Track *mp_ass_read_stream(ASS_Library *library, const char *fname,
                              char *charset)
{
    int i;
    char *buf = NULL;
    ASS_Track *track;
    size_t sz = 0;
    size_t buf_alloc = 0;
    stream_t *fd;

    fd = open_stream(fname, NULL, NULL);
    if (!fd)
        // Stream code should have printed an error already
        return NULL;
    if (fd->end_pos > STREAM_BUFFER_SIZE)
        /* read entire file if size is known */
        buf_alloc = fd->end_pos;
    else
        buf_alloc = 1000;
    for (;;) {
        if (sz > 100000000) {
            mp_tmsg(MSGT_ASS, MSGL_ERR, "Refusing to load subtitle file "
                    "larger than 100 MB: %s\n", fname);
            sz = 0;
            break;
        }
        buf_alloc = FFMAX(buf_alloc, sz + (sz >> 1));
        buf_alloc = FFMIN(buf_alloc, 100000001);
        buf = realloc(buf, buf_alloc + 1);
        i = stream_read(fd, buf + sz, buf_alloc - sz);
        if (i <= 0)
            break;
        sz += i;
    }
    free_stream(fd);
    if (!sz) {
        free(buf);
        return NULL;
    }
    buf[sz] = 0;
    buf = realloc(buf, sz + 1);
    track = ass_read_memory(library, buf, sz, charset);
    if (track) {
        free(track->name);
        track->name = strdup(fname);
    }
    free(buf);
    return track;
}

void mp_ass_configure(ASS_Renderer *priv, int w, int h, bool unscaled)
{
    int hinting;
    ass_set_frame_size(priv, w, h);
    ass_set_margins(priv, ass_top_margin, ass_bottom_margin, 0, 0);
    ass_set_use_margins(priv, ass_use_margins);
    ass_set_font_scale(priv, ass_font_scale);
    if (!unscaled && (ass_hinting & 4))
        hinting = 0;
    else
        hinting = ass_hinting & 3;
    ass_set_hinting(priv, hinting);
    ass_set_line_spacing(priv, ass_line_spacing);
}

void mp_ass_configure_fonts(ASS_Renderer *priv)
{
    char *dir, *path, *family;
    dir = get_path("fonts");
    if (font_fontconfig < 0 && sub_font_name)
        path = strdup(sub_font_name);
    else if (font_fontconfig < 0 && font_name)
        path = strdup(font_name);
    else
        path = get_path("subfont.ttf");
    if (font_fontconfig >= 0 && sub_font_name)
        family = strdup(sub_font_name);
    else if (font_fontconfig >= 0 && font_name)
        family = strdup(font_name);
    else
        family = 0;

    ass_set_fonts(priv, path, family, font_fontconfig + 1, NULL, 1);

    free(dir);
    free(path);
    free(family);
}

static void message_callback(int level, const char *format, va_list va, void *ctx)
{
    mp_msg(MSGT_ASS, level, "[ass] ");
    mp_msg_va(MSGT_ASS, level, format, va);
    // libass messages lack trailing \n
    mp_msg(MSGT_ASS, level, "\n");
}

ASS_Library *mp_ass_init(void)
{
    ASS_Library *priv;
    char *path = get_path("fonts");
    priv = ass_library_init();
    ass_set_message_cb(priv, message_callback, NULL);
    ass_set_fonts_dir(priv, path);
    ass_set_extract_fonts(priv, use_embedded_fonts);
    ass_set_style_overrides(priv, ass_force_style_list);
    free(path);
    return priv;
}

int ass_force_reload = 0;       // flag set if global ass-related settings were changed

ASS_Image *mp_ass_render_frame(ASS_Renderer *priv, ASS_Track *track,
                               long long now, int *detect_change)
{
    if (ass_force_reload) {
        ass_set_margins(priv, ass_top_margin, ass_bottom_margin, 0, 0);
        ass_set_use_margins(priv, ass_use_margins);
        ass_set_font_scale(priv, ass_font_scale);
        ass_force_reload = 0;
    }
    return ass_render_frame(priv, track, now, detect_change);
}