/src/vlc/modules/codec/substext.h

Source
/*****************************************************************************
 * subsdec.c : text subtitle decoder
 *****************************************************************************
 * Copyright © 2011-2015 VLC authors and VideoLAN
 *
 * Authors: Laurent Aimer <fenrir@videolan.org>
 *          Jean-Baptiste Kempf <jb@videolan.org>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/

#include <vlc_strings.h>
#include <vlc_text_style.h>
#include <vlc_subpicture.h>

typedef struct substext_updater_region_t substext_updater_region_t;

enum substext_updater_region_flags_e
{
    UPDT_REGION_ORIGIN_X_IS_RATIO      = 1 << 0,
    UPDT_REGION_ORIGIN_Y_IS_RATIO      = 1 << 1,
    UPDT_REGION_EXTENT_X_IS_RATIO      = 1 << 2,
    UPDT_REGION_EXTENT_Y_IS_RATIO      = 1 << 3,
    UPDT_REGION_IGNORE_BACKGROUND      = 1 << 4,
    UPDT_REGION_USES_GRID_COORDINATES  = 1 << 5,
    UPDT_REGION_FIXED_DONE             = 1 << 31,
};

struct substext_updater_region_t
{
    struct
    {
        float x;
        float y;
    } origin, extent;
    /* store above percentile meanings as modifier flags */
    int flags; /* subpicture_updater_sys_region_flags_e */
    int align; /* alignment of the region itself */
    bool b_absolute;  /**< position is absolute in the movie */
    bool b_in_window; /**< position the region in whole window */
    int inner_align; /* alignment of content inside the region */
    text_style_t *p_region_style;
    text_segment_t *p_segments;
    substext_updater_region_t *p_next;
};

typedef struct
{
    /* a min of one region */
    substext_updater_region_t region;

    /* styling */
    text_style_t *p_default_style; /* decoder (full or partial) defaults */
    float margin_ratio;
    vlc_tick_t i_next_update;
    bool b_blink_even;
} subtext_updater_sys_t;

static inline void SubpictureUpdaterSysRegionClean(substext_updater_region_t *p_updtregion)
{
    text_segment_ChainDelete( p_updtregion->p_segments );
    text_style_Delete( p_updtregion->p_region_style );
}

static inline void SubpictureUpdaterSysRegionInit(substext_updater_region_t *p_updtregion)
{
    memset(p_updtregion, 0, sizeof(*p_updtregion));
    p_updtregion->align = SUBPICTURE_ALIGN_BOTTOM;
    p_updtregion->b_absolute = false;
    p_updtregion->b_in_window = false;
    p_updtregion->inner_align = 0 ; // centered
}

static inline substext_updater_region_t *SubpictureUpdaterSysRegionNew( void )
{
    substext_updater_region_t *p_region = malloc(sizeof(*p_region));
    if(p_region)
        SubpictureUpdaterSysRegionInit(p_region);
    return p_region;
}

static inline void SubpictureUpdaterSysRegionAdd(substext_updater_region_t *p_prev,
                                                 substext_updater_region_t *p_new)
{
    substext_updater_region_t **pp_next = &p_prev->p_next;
    for(; *pp_next; pp_next = &(*pp_next)->p_next);
    *pp_next = p_new;
}

static void SubpictureTextUpdate(subpicture_t *subpic,
                                 const struct vlc_spu_updater_configuration *cfg)
{
    subtext_updater_sys_t *sys = subpic->updater.sys;
    const video_format_t *fmt_src = cfg->video_src;
    const video_format_t *fmt_dst = cfg->video_dst;

    if (fmt_src->i_visible_height == cfg->prev_src->i_visible_height &&
        video_format_IsSimilar(cfg->prev_dst, fmt_dst) &&
        (sys->i_next_update == VLC_TICK_INVALID || sys->i_next_update > cfg->pts))
        return;

    substext_updater_region_t *p_updtregion = &sys->region;

    if (!(p_updtregion->flags & UPDT_REGION_FIXED_DONE) &&
        p_updtregion->b_absolute && !vlc_spu_regions_is_empty(&subpic->regions) &&
        subpic->i_original_picture_width > 0 &&
        subpic->i_original_picture_height > 0)
    {
        subpicture_region_t *p_region =
            vlc_spu_regions_first_or_null(&subpic->regions);
        p_updtregion->flags |= UPDT_REGION_FIXED_DONE;
        p_updtregion->origin.x = p_region->i_x;
        p_updtregion->origin.y = p_region->i_y;
        p_updtregion->extent.x = subpic->i_original_picture_width;
        p_updtregion->extent.y = subpic->i_original_picture_height;
        p_updtregion->flags &= ~(UPDT_REGION_ORIGIN_X_IS_RATIO|UPDT_REGION_ORIGIN_Y_IS_RATIO|
                                 UPDT_REGION_EXTENT_X_IS_RATIO|UPDT_REGION_EXTENT_Y_IS_RATIO);
    }
    vlc_spu_regions_Clear( &subpic->regions );

    assert(fmt_dst->i_sar_num && fmt_dst->i_sar_den);

    vlc_rational_t sar;

    /* NOTE about fmt_dst:
     * fmt_dst area and A/R will change to display once WxH of the
     * display is greater than the source video in direct rendering.
     * This will cause weird sudded region "moves" or "linebreaks" when
     * resizing window, mostly vertically.
     * see changes by 4a49754d943560fe79bc42f107d8ce566ea24898 */

    if( sys->region.flags & UPDT_REGION_USES_GRID_COORDINATES )
    {
        sar.num = 4;
        sar.den = 3;
    }
    else
    {
        sar.num = 1;
        sar.den = 1;
    }

    if ( p_updtregion->b_in_window )
    {
        subpic->i_original_picture_width  = cfg->display_width;
        subpic->i_original_picture_height = cfg->display_height;
    }
    else if( sys->region.flags & UPDT_REGION_USES_GRID_COORDINATES )
    {
        subpic->i_original_picture_width  = fmt_dst->i_visible_height * sar.num / sar.den;
        subpic->i_original_picture_height = fmt_dst->i_visible_height;
    }
    else
    {
        subpic->i_original_picture_width  = fmt_dst->i_width * fmt_dst->i_sar_num / fmt_dst->i_sar_den;
        subpic->i_original_picture_height = fmt_dst->i_height;
    }

    bool b_schedule_blink_update = false;

    video_format_t render_fmt = *fmt_dst;
    if (p_updtregion->b_in_window)
    {
        render_fmt.i_x_offset = render_fmt.i_y_offset = 0;
        render_fmt.i_width  = render_fmt.i_visible_width  = cfg->display_width;
        render_fmt.i_height = render_fmt.i_visible_height = cfg->display_height;
    }

    for( substext_updater_region_t *update_region = &sys->region;
                                    update_region; update_region = update_region->p_next )
    {
        subpicture_region_t *r = subpicture_region_NewText();
        if (!r)
            return;
        vlc_spu_regions_push(&subpic->regions, r);
        r->fmt.i_sar_num = sar.num;
        r->fmt.i_sar_den = sar.den;

        r->p_text = text_segment_Copy( update_region->p_segments );
        r->b_absolute = update_region->b_absolute;
        r->b_in_window = update_region->b_in_window;
        r->i_align = update_region->align;
        r->text_flags |= update_region->inner_align & SUBPICTURE_ALIGN_MASK;
        if (update_region->flags & UPDT_REGION_IGNORE_BACKGROUND)
            r->text_flags |= VLC_SUBPIC_TEXT_FLAG_NO_REGION_BG;
        bool b_gridmode = (update_region->flags & UPDT_REGION_USES_GRID_COORDINATES) != 0;
        if (b_gridmode)
            r->text_flags |= VLC_SUBPIC_TEXT_FLAG_GRID_MODE;

        if (!(update_region->flags & UPDT_REGION_FIXED_DONE))
        {
            const float margin_ratio = sys->margin_ratio;
            const int   margin_h     = margin_ratio * ( b_gridmode ? subpic->i_original_picture_width
                                                                   : render_fmt.i_visible_width );
            const int   margin_v     = margin_ratio * render_fmt.i_visible_height;

            /* subpic invisible margins sizes */
            const int outerright_h = render_fmt.i_width - (render_fmt.i_visible_width + render_fmt.i_x_offset);
            const int outerbottom_v = render_fmt.i_height - (render_fmt.i_visible_height + render_fmt.i_y_offset);
            /* regions usable */
            const int inner_w = render_fmt.i_visible_width - margin_h * 2;
            const int inner_h = render_fmt.i_visible_height - margin_v * 2;

            if (r->i_align & SUBPICTURE_ALIGN_LEFT)
                r->i_x = margin_h + render_fmt.i_x_offset;
            else if (r->i_align & SUBPICTURE_ALIGN_RIGHT)
                r->i_x = margin_h + outerright_h;
            else
                r->i_x = 0;

            if (r->i_align & SUBPICTURE_ALIGN_TOP )
                r->i_y = margin_v + render_fmt.i_y_offset;
            else if (r->i_align & SUBPICTURE_ALIGN_BOTTOM )
                r->i_y = margin_v + outerbottom_v;
            else
                r->i_y = 0;

            if( update_region->flags & UPDT_REGION_ORIGIN_X_IS_RATIO )
                r->i_x += update_region->origin.x * inner_w;
            else
                r->i_x += update_region->origin.x;

            if( update_region->flags & UPDT_REGION_ORIGIN_Y_IS_RATIO )
                r->i_y += update_region->origin.y * inner_h;
            else
                r->i_y += update_region->origin.y;

            if( update_region->flags & UPDT_REGION_EXTENT_X_IS_RATIO )
                r->i_max_width += update_region->extent.x * inner_w;
            else
                r->i_max_width += update_region->extent.x;

            if( update_region->flags & UPDT_REGION_EXTENT_Y_IS_RATIO )
                r->i_max_height += update_region->extent.y * inner_h;
            else
                r->i_max_height += update_region->extent.y;

        } else {
            /* FIXME it doesn't adapt on crop settings changes */
            r->i_x = update_region->origin.x * render_fmt.i_width  / update_region->extent.x;
            r->i_y = update_region->origin.y * render_fmt.i_height / update_region->extent.y;
        }

        /* Add missing default style, if any, to all segments */
        for ( text_segment_t* p_segment = r->p_text; p_segment; p_segment = p_segment->p_next )
        {
            /* Add decoder defaults */
            if( p_segment->style )
                text_style_Merge( p_segment->style, sys->p_default_style, false );
            else
                p_segment->style = text_style_Duplicate( sys->p_default_style );

            if( p_segment->style )
            {
                /* Update all segments font sizes in video source %,
                 * so we can handle HiDPI properly and have consistent rendering limits */
                 if( p_segment->style->i_font_size > 0 && fmt_src->i_visible_height > 0 )
                {
                    p_segment->style->f_font_relsize = 100.0 * p_segment->style->i_font_size / fmt_src->i_visible_height;
                    p_segment->style->i_font_size = 0;
                }

                if( p_segment->style->i_style_flags & (STYLE_BLINK_BACKGROUND|STYLE_BLINK_FOREGROUND) )
                {
                    if( sys->b_blink_even ) /* do nothing at first */
                    {
                        if( p_segment->style->i_style_flags & STYLE_BLINK_BACKGROUND )
                            p_segment->style->i_background_alpha =
                                    (~p_segment->style->i_background_alpha) & 0xFF;
                        if( p_segment->style->i_style_flags & STYLE_BLINK_FOREGROUND )
                            p_segment->style->i_font_alpha =
                                    (~p_segment->style->i_font_alpha) & 0xFF;
                    }
                    b_schedule_blink_update = true;
                }
            }
        }
    }

    if( b_schedule_blink_update &&
        (sys->i_next_update == VLC_TICK_INVALID || sys->i_next_update < cfg->pts) )
    {
        sys->i_next_update = cfg->pts + VLC_TICK_FROM_SEC(1);
        sys->b_blink_even = !sys->b_blink_even;
    }
}
static void SubpictureTextDestroy(subpicture_t *subpic)
{
    subtext_updater_sys_t *sys = subpic->updater.sys;

    SubpictureUpdaterSysRegionClean( &sys->region );
    substext_updater_region_t *p_region = sys->region.p_next;
    while( p_region )
    {
        substext_updater_region_t *p_next = p_region->p_next;
        SubpictureUpdaterSysRegionClean( p_region );
        free( p_region );
        p_region = p_next;
    }
    text_style_Delete( sys->p_default_style );
    free(sys);
}

static inline subpicture_t *decoder_NewSubpictureText(decoder_t *decoder)
{
    subtext_updater_sys_t *sys = calloc(1, sizeof(*sys));

    static const struct vlc_spu_updater_ops spu_ops =
    {
        .update   = SubpictureTextUpdate,
        .destroy  = SubpictureTextDestroy,
    };

    subpicture_updater_t updater = {
        .sys = sys,
        .ops = &spu_ops,
    };

    SubpictureUpdaterSysRegionInit( &sys->region );
    sys->margin_ratio = 0.04f;
    sys->p_default_style = text_style_Create( STYLE_NO_DEFAULTS );
    if(unlikely(!sys->p_default_style))
    {
        free(sys);
        return NULL;
    }
    subpicture_t *subpic = decoder_NewSubpicture(decoder, &updater);
    if (!subpic)
    {
        text_style_Delete(sys->p_default_style);
        free(sys);
        return NULL;
    }
    sys->region.b_absolute = true; sys->region.b_in_window = false;
    sys->i_next_update = VLC_TICK_INVALID;
    return subpic;
}

Coverage Report

Created: 2025-12-31 07:55