vout_subpictures.c

/*****************************************************************************
 * vout_subpictures.c : subpicture management functions
 *****************************************************************************
 * Copyright (C) 2000-2007 the VideoLAN team
 * $Id$
 *
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
 *          Samuel Hocevar <sam@zoy.org>
 *          Gildas Bazin <gbazin@videolan.org>
 *
 * This program 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.
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU 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.
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

#include <vlc_common.h>
#include <vlc_vout.h>
#include <vlc_block.h>
#include <vlc_filter.h>
#include <vlc_osd.h>
#include "../libvlc.h"

/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
static void UpdateSPU   ( spu_t *, vlc_object_t * );
static int  CropCallback( vlc_object_t *, char const *,
                          vlc_value_t, vlc_value_t, void * );

static int spu_vaControlDefault( spu_t *, int, va_list );

static subpicture_t *sub_new_buffer( filter_t * );
static void sub_del_buffer( filter_t *, subpicture_t * );
static subpicture_t *spu_new_buffer( filter_t * );
static void spu_del_buffer( filter_t *, subpicture_t * );
static picture_t *spu_new_video_buffer( filter_t * );
static void spu_del_video_buffer( filter_t *, picture_t * );

static int spu_ParseChain( spu_t * );
static int SubFilterCallback( vlc_object_t *, char const *,
                              vlc_value_t, vlc_value_t, void * );

static int sub_filter_allocation_init( filter_t *, void * );
static void sub_filter_allocation_clear( filter_t * );
struct filter_owner_sys_t
{
    spu_t *p_spu;
    int i_channel;
};

enum {
    SCALE_DEFAULT,
    SCALE_TEXT,
    SCALE_SIZE
};

/**
 * Creates the subpicture unit
 *
 * \param p_this the parent object which creates the subpicture unit
 */
spu_t *__spu_Create( vlc_object_t *p_this )
{
    int i_index;
    spu_t *p_spu = vlc_custom_create( p_this, sizeof( spu_t ),
                                      VLC_OBJECT_GENERIC, "subpicture" );

    for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++)
    {
        p_spu->p_subpicture[i_index].i_status = FREE_SUBPICTURE;
    }

    p_spu->p_blend = NULL;
    p_spu->p_text = NULL;
    p_spu->p_scale = NULL;
    p_spu->pf_control = spu_vaControlDefault;

    /* Register the default subpicture channel */
    p_spu->i_channel = 2;

    vlc_mutex_init( &p_spu->subpicture_lock );

    vlc_object_attach( p_spu, p_this );

    p_spu->p_chain = filter_chain_New( p_spu, "sub filter", false,
                                       sub_filter_allocation_init,
                                       sub_filter_allocation_clear,
                                       p_spu );
    return p_spu;
}

/**
 * Initialise the subpicture unit
 *
 * \param p_spu the subpicture unit object
 */
int spu_Init( spu_t *p_spu )
{
    vlc_value_t val;

    /* If the user requested a sub margin, we force the position. */
    var_Create( p_spu, "sub-margin", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
    var_Get( p_spu, "sub-margin", &val );
    p_spu->i_margin = val.i_int;

    var_Create( p_spu, "sub-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
    var_AddCallback( p_spu, "sub-filter", SubFilterCallback, p_spu );

    spu_ParseChain( p_spu );

    return VLC_SUCCESS;
}

int spu_ParseChain( spu_t *p_spu )
{
    char *psz_parser = var_GetString( p_spu, "sub-filter" );
    if( filter_chain_AppendFromString( p_spu->p_chain, psz_parser ) < 0 )
    {
        free( psz_parser );
        return VLC_EGENERIC;
    }

    free( psz_parser );
    return VLC_SUCCESS;
}

/**
 * Destroy the subpicture unit
 *
 * \param p_this the parent object which destroys the subpicture unit
 */
void spu_Destroy( spu_t *p_spu )
{
    int i_index;

    /* Destroy all remaining subpictures */
    for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
    {
        if( p_spu->p_subpicture[i_index].i_status != FREE_SUBPICTURE )
        {
            spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
        }
    }

    if( p_spu->p_blend )
    {
        if( p_spu->p_blend->p_module )
            module_Unneed( p_spu->p_blend, p_spu->p_blend->p_module );

        vlc_object_detach( p_spu->p_blend );
        vlc_object_release( p_spu->p_blend );
    }

    if( p_spu->p_text )
    {
        if( p_spu->p_text->p_module )
            module_Unneed( p_spu->p_text, p_spu->p_text->p_module );

        vlc_object_detach( p_spu->p_text );
        vlc_object_release( p_spu->p_text );
    }

    if( p_spu->p_scale )
    {
        if( p_spu->p_scale->p_module )
            module_Unneed( p_spu->p_scale, p_spu->p_scale->p_module );

        vlc_object_detach( p_spu->p_scale );
        vlc_object_release( p_spu->p_scale );
    }

    filter_chain_Delete( p_spu->p_chain );

    vlc_mutex_destroy( &p_spu->subpicture_lock );
    vlc_object_release( p_spu );
}

/**
 * Attach/Detach the SPU from any input
 *
 * \param p_this the object in which to destroy the subpicture unit
 * \param b_attach to select attach or detach
 */
void spu_Attach( spu_t *p_spu, vlc_object_t *p_this, bool b_attach )
{
    vlc_object_t *p_input;

    p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
    if( !p_input ) return;

    if( b_attach )
    {
        UpdateSPU( p_spu, VLC_OBJECT(p_input) );
        var_AddCallback( p_input, "highlight", CropCallback, p_spu );
        vlc_object_release( p_input );
    }
    else
    {
        /* Delete callback */
        var_DelCallback( p_input, "highlight", CropCallback, p_spu );
        vlc_object_release( p_input );
    }
}

/**
 * Create a subpicture region
 *
 * \param p_this vlc_object_t
 * \param p_fmt the format that this subpicture region should have
 */
static void RegionPictureRelease( picture_t *p_pic )
{
    free( p_pic->p_data_orig );
}
subpicture_region_t *__spu_CreateRegion( vlc_object_t *p_this,
                                         video_format_t *p_fmt )
{
    subpicture_region_t *p_region = malloc( sizeof(subpicture_region_t) );
    if( !p_region ) return NULL;

    memset( p_region, 0, sizeof(subpicture_region_t) );
    p_region->i_alpha = 0xff;
    p_region->p_next = NULL;
    p_region->p_cache = NULL;
    p_region->fmt = *p_fmt;
    p_region->psz_text = NULL;
    p_region->p_style = NULL;

    if( p_fmt->i_chroma == VLC_FOURCC('Y','U','V','P') )
        p_fmt->p_palette = p_region->fmt.p_palette =
            malloc( sizeof(video_palette_t) );
    else p_fmt->p_palette = p_region->fmt.p_palette = NULL;

    p_region->picture.p_data_orig = NULL;

    if( p_fmt->i_chroma == VLC_FOURCC('T','E','X','T') ) return p_region;

    vout_AllocatePicture( p_this, &p_region->picture, p_fmt->i_chroma,
                          p_fmt->i_width, p_fmt->i_height, p_fmt->i_aspect );

    if( !p_region->picture.i_planes )
    {
        free( p_region );
        free( p_fmt->p_palette );
        return NULL;
    }

    p_region->picture.pf_release = RegionPictureRelease;

    return p_region;
}

/**
 * Make a subpicture region from an existing picture_t
 *
 * \param p_this vlc_object_t
 * \param p_fmt the format that this subpicture region should have
 * \param p_pic a pointer to the picture creating the region (not freed)
 */
subpicture_region_t *__spu_MakeRegion( vlc_object_t *p_this,
                                       video_format_t *p_fmt,
                                       picture_t *p_pic )
{
    subpicture_region_t *p_region = malloc( sizeof(subpicture_region_t) );
    (void)p_this;
    if( !p_region ) return NULL;
    memset( p_region, 0, sizeof(subpicture_region_t) );
    p_region->i_alpha = 0xff;
    p_region->p_next = 0;
    p_region->p_cache = 0;
    p_region->fmt = *p_fmt;
    p_region->psz_text = 0;
    p_region->p_style = NULL;

    if( p_fmt->i_chroma == VLC_FOURCC('Y','U','V','P') )
        p_fmt->p_palette = p_region->fmt.p_palette =
            malloc( sizeof(video_palette_t) );
    else p_fmt->p_palette = p_region->fmt.p_palette = NULL;

    memcpy( &p_region->picture, p_pic, sizeof(picture_t) );
    p_region->picture.pf_release = RegionPictureRelease;

    return p_region;
}

/**
 * Destroy a subpicture region
 *
 * \param p_this vlc_object_t
 * \param p_region the subpicture region to destroy
 */
void __spu_DestroyRegion( vlc_object_t *p_this, subpicture_region_t *p_region )
{
    if( !p_region ) return;
    if( p_region->picture.pf_release )
        p_region->picture.pf_release( &p_region->picture );
    free( p_region->fmt.p_palette );
    if( p_region->p_cache ) __spu_DestroyRegion( p_this, p_region->p_cache );

    free( p_region->psz_text );
    free( p_region->psz_html );
    //free( p_region->p_style ); FIXME --fenrir plugin does not allocate the memory for it. I think it might lead to segfault, video renderer can live longer than the decoder
    free( p_region );
}

/**
 * Display a subpicture
 *
 * Remove the reservation flag of a subpicture, which will cause it to be
 * ready for display.
 * \param p_spu the subpicture unit object
 * \param p_subpic the subpicture to display
 */
void spu_DisplaySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
{
    /* Check if status is valid */
    if( p_subpic->i_status != RESERVED_SUBPICTURE )
    {
        msg_Err( p_spu, "subpicture %p has invalid status #%d",
                 p_subpic, p_subpic->i_status );
    }

    /* Remove reservation flag */
    p_subpic->i_status = READY_SUBPICTURE;

    if( p_subpic->i_channel == DEFAULT_CHAN )
    {
        p_subpic->i_channel = 0xFFFF;
        spu_Control( p_spu, SPU_CHANNEL_CLEAR, DEFAULT_CHAN );
        p_subpic->i_channel = DEFAULT_CHAN;
    }
}

/**
 * Allocate a subpicture in the spu heap.
 *
 * This function create a reserved subpicture in the spu heap.
 * A null pointer is returned if the function fails. This method provides an
 * already allocated zone of memory in the spu data fields. It needs locking
 * since several pictures can be created by several producers threads.
 * \param p_spu the subpicture unit in which to create the subpicture
 * \return NULL on error, a reserved subpicture otherwise
 */
subpicture_t *spu_CreateSubpicture( spu_t *p_spu )
{
    int                 i_subpic;                        /* subpicture index */
    subpicture_t *      p_subpic = NULL;            /* first free subpicture */

    /* Get lock */
    vlc_mutex_lock( &p_spu->subpicture_lock );

    /*
     * Look for an empty place
     */
    p_subpic = NULL;
    for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
    {
        if( p_spu->p_subpicture[i_subpic].i_status == FREE_SUBPICTURE )
        {
            /* Subpicture is empty and ready for allocation */
            p_subpic = &p_spu->p_subpicture[i_subpic];
            p_spu->p_subpicture[i_subpic].i_status = RESERVED_SUBPICTURE;
            break;
        }
    }

    /* If no free subpicture could be found */
    if( p_subpic == NULL )
    {
        msg_Err( p_spu, "subpicture heap is full" );
        vlc_mutex_unlock( &p_spu->subpicture_lock );
        return NULL;
    }

    /* Copy subpicture information, set some default values */
    memset( p_subpic, 0, sizeof(subpicture_t) );
    p_subpic->i_status   = RESERVED_SUBPICTURE;
    p_subpic->b_absolute = true;
    p_subpic->b_pausable = false;
    p_subpic->b_fade     = false;
    p_subpic->i_alpha    = 0xFF;
    p_subpic->p_region   = NULL;
    p_subpic->pf_render  = NULL;
    p_subpic->pf_destroy = NULL;
    p_subpic->p_sys      = NULL;
    vlc_mutex_unlock( &p_spu->subpicture_lock );

    p_subpic->pf_create_region = __spu_CreateRegion;
    p_subpic->pf_make_region = __spu_MakeRegion;
    p_subpic->pf_destroy_region = __spu_DestroyRegion;

    return p_subpic;
}

/**
 * Remove a subpicture from the heap
 *
 * This function frees a previously reserved subpicture.
 * It is meant to be used when the construction of a picture aborted.
 * This function does not need locking since reserved subpictures are ignored
 * by the spu.
 */
void spu_DestroySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
{
    /* Get lock */
    vlc_mutex_lock( &p_spu->subpicture_lock );

    /* There can be race conditions so we need to check the status */
    if( p_subpic->i_status == FREE_SUBPICTURE )
    {
        vlc_mutex_unlock( &p_spu->subpicture_lock );
        return;
    }

    /* Check if status is valid */
    if( ( p_subpic->i_status != RESERVED_SUBPICTURE )
           && ( p_subpic->i_status != READY_SUBPICTURE ) )
    {
        msg_Err( p_spu, "subpicture %p has invalid status %d",
                         p_subpic, p_subpic->i_status );
    }

    while( p_subpic->p_region )
    {
        subpicture_region_t *p_region = p_subpic->p_region;
        p_subpic->p_region = p_region->p_next;
        spu_DestroyRegion( p_spu, p_region );
    }

    if( p_subpic->pf_destroy )
    {
        p_subpic->pf_destroy( p_subpic );
    }

    p_subpic->i_status = FREE_SUBPICTURE;

    vlc_mutex_unlock( &p_spu->subpicture_lock );
}

/*****************************************************************************
 * spu_RenderSubpictures: render a subpicture list
 *****************************************************************************
 * This function renders all sub picture units in the list.
 *****************************************************************************/
void spu_RenderSubpictures( spu_t *p_spu, video_format_t *p_fmt,
                            picture_t *p_pic_dst, picture_t *p_pic_src,
                            subpicture_t *p_subpic,
                            int i_scale_width_orig, int i_scale_height_orig )
{
    int i_source_video_width;
    int i_source_video_height;
    subpicture_t *p_subpic_v = p_subpic;

    /* Get lock */
    vlc_mutex_lock( &p_spu->subpicture_lock );

    for( p_subpic_v = p_subpic;
            p_subpic_v != NULL && p_subpic_v->i_status != FREE_SUBPICTURE;
            p_subpic_v = p_subpic_v->p_next )
    {
        if( p_subpic_v->pf_pre_render )
        {
            p_subpic_v->pf_pre_render( p_fmt, p_spu, p_subpic_v, mdate() );
        }
    }

    if( i_scale_width_orig <= 0 )
        i_scale_width_orig = 1;
    if( i_scale_height_orig <= 0 )
        i_scale_height_orig = 1;

    i_source_video_width  = p_fmt->i_width  * 1000 / i_scale_width_orig;
    i_source_video_height = p_fmt->i_height * 1000 / i_scale_height_orig;

    /* Check i_status again to make sure spudec hasn't destroyed the subpic */
    while( ( p_subpic != NULL ) && ( p_subpic->i_status != FREE_SUBPICTURE ) )
    {
        subpicture_region_t *p_region;
        int pi_scale_width[ SCALE_SIZE ];
        int pi_scale_height[ SCALE_SIZE ];
        int pi_subpic_x[ SCALE_SIZE ];
        int k;

        /* If the source video and subtitles stream agree on the size of
         * the video then disregard all further references to the subtitle
         * stream.
         */
        if( ( i_source_video_height == p_subpic->i_original_picture_height ) &&
            ( i_source_video_width  == p_subpic->i_original_picture_width ) )
        {
            p_subpic->i_original_picture_height = 0;
            p_subpic->i_original_picture_width = 0;
        }

        for( k = 0; k < SCALE_SIZE ; k++ )
            pi_subpic_x[ k ] = p_subpic->i_x;

        if( p_subpic->pf_update_regions )
        {
            if ( p_subpic->p_region ) {
                spu_DestroyRegion( p_spu, p_subpic->p_region );
            }
            p_subpic->p_region = p_region = p_subpic->pf_update_regions( p_fmt, p_spu, p_subpic, mdate() );
        }
        else
        {
            p_region = p_subpic->p_region;
        }

        /* Load the blending module */
        if( !p_spu->p_blend && p_region )
        {
            p_spu->p_blend = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
            vlc_object_attach( p_spu->p_blend, p_spu );
            p_spu->p_blend->fmt_out.video.i_x_offset =
                p_spu->p_blend->fmt_out.video.i_y_offset = 0;
            p_spu->p_blend->fmt_out.video.i_aspect = p_fmt->i_aspect;
            p_spu->p_blend->fmt_out.video.i_chroma = p_fmt->i_chroma;

            /* The blend module will be loaded when needed with the real
            * input format */
            memset( &p_spu->p_blend->fmt_in, 0, sizeof(p_spu->p_blend->fmt_in) );
            p_spu->p_blend->p_module = NULL;
        }

        /* Load the text rendering module; it is possible there is a
         * text region somewhere in the subpicture other than the first
         * element in the region list, so just load it anyway as we'll
         * probably want it sooner or later. */
        if( !p_spu->p_text && p_region )
        {
            char *psz_modulename = NULL;

            p_spu->p_text = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
            vlc_object_attach( p_spu->p_text, p_spu );

            p_spu->p_text->fmt_out.video.i_width =
                p_spu->p_text->fmt_out.video.i_visible_width =
                p_fmt->i_width;
            p_spu->p_text->fmt_out.video.i_height =
                p_spu->p_text->fmt_out.video.i_visible_height =
                p_fmt->i_height;

            p_spu->p_text->pf_sub_buffer_new = spu_new_buffer;
            p_spu->p_text->pf_sub_buffer_del = spu_del_buffer;

            psz_modulename = var_CreateGetString( p_spu, "text-renderer" );
            if( psz_modulename && *psz_modulename )
            {
                p_spu->p_text->p_module =
                    module_Need( p_spu->p_text, "text renderer",
                                 psz_modulename, true );
            }
            if( !p_spu->p_text->p_module )
            {
                p_spu->p_text->p_module =
                    module_Need( p_spu->p_text, "text renderer", 0, 0 );
            }
            free( psz_modulename );
        }

        if( p_spu->p_text )
        {
            subpicture_region_t *p_text_region = p_subpic->p_region;

            /* Only overwrite the size fields if the region is still in
             * pre-rendered TEXT format. We have to traverse the subregion
             * list because if more than one subregion is present, the text
             * region isn't guarentteed to be the first in the list, and
             * only text regions use this flag. All of this effort assists
             * with the rescaling of text that has been rendered at native
             * resolution, rather than video resolution.
             */
            while( p_text_region &&
                   ( p_text_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') ) )
            {
                p_text_region = p_text_region->p_next;
            }

            if( p_text_region &&
                ( ( p_text_region->i_align & SUBPICTURE_RENDERED ) == 0 ) )
            {
                if( (p_subpic->i_original_picture_height > 0) &&
                    (p_subpic->i_original_picture_width  > 0) )
                {
                    p_spu->p_text->fmt_out.video.i_width =
                        p_spu->p_text->fmt_out.video.i_visible_width =
                        p_subpic->i_original_picture_width;
                    p_spu->p_text->fmt_out.video.i_height =
                        p_spu->p_text->fmt_out.video.i_visible_height =
                        p_subpic->i_original_picture_height;
                }
                else
                {
                    p_spu->p_text->fmt_out.video.i_width =
                        p_spu->p_text->fmt_out.video.i_visible_width =
                        p_fmt->i_width;
                    p_spu->p_text->fmt_out.video.i_height =
                        p_spu->p_text->fmt_out.video.i_visible_height =
                        p_fmt->i_height;
                }
            }
        }

        pi_scale_width[ SCALE_DEFAULT ]  = i_scale_width_orig;
        pi_scale_height[ SCALE_DEFAULT ] = i_scale_height_orig;

        if( p_spu->p_text )
        {
            pi_scale_width[ SCALE_TEXT ]     = ( p_fmt->i_width * 1000 ) /
                                          p_spu->p_text->fmt_out.video.i_width;
            pi_scale_height[ SCALE_TEXT ]    = ( p_fmt->i_height * 1000 ) /
                                          p_spu->p_text->fmt_out.video.i_height;
        }
        /* If we have an explicit size plane to render to, then turn off
         * the fontsize rescaling.
         */
        if( (p_subpic->i_original_picture_height > 0) &&
            (p_subpic->i_original_picture_width  > 0) )
        {
            i_scale_width_orig  = 1000;
            i_scale_height_orig = 1000;
        }

        for( k = 0; k < SCALE_SIZE ; k++ )
        {
            /* Case of both width and height being specified has been dealt
             * with above by instead rendering to an output pane of the
             * explicit dimensions specified - we don't need to scale it.
             */
            if( (p_subpic->i_original_picture_height > 0) &&
                (p_subpic->i_original_picture_width <= 0) )
            {
                pi_scale_height[ k ] = pi_scale_height[ k ] * i_source_video_height /
                                 p_subpic->i_original_picture_height;
                pi_scale_width[ k ]  = pi_scale_width[ k ]  * i_source_video_height /
                                 p_subpic->i_original_picture_height;
            }
        }

        /* Set default subpicture aspect ratio */
        if( p_region && p_region->fmt.i_aspect &&
            ( !p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den ) )
        {
            p_region->fmt.i_sar_den = p_region->fmt.i_aspect;
            p_region->fmt.i_sar_num = VOUT_ASPECT_FACTOR;
        }
        if( p_region &&
            ( !p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den ) )
        {
            p_region->fmt.i_sar_den = p_fmt->i_sar_den;
            p_region->fmt.i_sar_num = p_fmt->i_sar_num;
        }

        /* Take care of the aspect ratio */
        if( p_region &&
            ( ( p_region->fmt.i_sar_num * p_fmt->i_sar_den ) !=
              ( p_region->fmt.i_sar_den * p_fmt->i_sar_num ) ) )
        {
            for( k = 0; k < SCALE_SIZE ; k++ )
            {
                pi_scale_width[ k ] = pi_scale_width[ k ] *
                    (int64_t)p_region->fmt.i_sar_num * p_fmt->i_sar_den /
                    p_region->fmt.i_sar_den / p_fmt->i_sar_num;
                pi_subpic_x[ k ] = p_subpic->i_x * pi_scale_width[ k ] / 1000;
            }
        }

        /* Load the scaling module */
        if( !p_spu->p_scale &&
           ((((pi_scale_width[ SCALE_TEXT ]    > 0)     || (pi_scale_height[ SCALE_TEXT ]    > 0)) &&
             ((pi_scale_width[ SCALE_TEXT ]    != 1000) || (pi_scale_height[ SCALE_TEXT ]    != 1000))) ||
            (((pi_scale_width[ SCALE_DEFAULT ] > 0)     || (pi_scale_height[ SCALE_DEFAULT ] > 0)) &&
             ((pi_scale_width[ SCALE_DEFAULT ] != 1000) || (pi_scale_height[ SCALE_DEFAULT ] != 1000)))) )
        {
            p_spu->p_scale = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
            vlc_object_attach( p_spu->p_scale, p_spu );
            p_spu->p_scale->fmt_out.video.i_chroma =
                p_spu->p_scale->fmt_in.video.i_chroma =
                    VLC_FOURCC('Y','U','V','P');
            /* FIXME: We'll also be using it for YUVA and RGBA blending ... */

            p_spu->p_scale->fmt_in.video.i_width =
                p_spu->p_scale->fmt_in.video.i_height = 32;
            p_spu->p_scale->fmt_out.video.i_width =
                p_spu->p_scale->fmt_out.video.i_height = 16;

            p_spu->p_scale->pf_vout_buffer_new = spu_new_video_buffer;
            p_spu->p_scale->pf_vout_buffer_del = spu_del_video_buffer;
            p_spu->p_scale->p_module =
                module_Need( p_spu->p_scale, "video filter2", 0, 0 );
        }

        while( p_region )
        {
            video_format_t orig_fmt = p_region->fmt;
            bool b_rerender_text = false;
            int i_fade_alpha = 255;
            int i_x_offset;
            int i_y_offset;
            int i_scale_idx   = SCALE_DEFAULT;
            int i_inv_scale_x = 1000;
            int i_inv_scale_y = 1000;

            if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
            {
                if( p_spu->p_text && p_spu->p_text->p_module )
                {
                    vlc_value_t  val;

                    /* Setup 3 variables which can be used to render
                     * time-dependent text (and effects). The first indicates
                     * the total amount of time the text will be on screen,
                     * the second the amount of time it has already been on
                     * screen (can be a negative value as text is layed out
                     * before it is rendered) and the third is a feedback
                     * variable from the renderer - if the renderer sets it
                     * then this particular text is time-dependent, eg. the
                     * visual progress bar inside the text in karaoke and the
                     * text needs to be rendered multiple times in order for
                     * the effect to work - we therefore need to return the
                     * region to its original state at the end of the loop,
                     * instead of leaving it in YUVA or YUVP.
                     * Any renderer which is unaware of how to render
                     * time-dependent text can happily ignore the variables
                     * and render the text the same as usual - it should at
                     * least show up on screen, but the effect won't change
                     * the text over time.
                     */

                    var_Create( p_spu->p_text, "spu-duration", VLC_VAR_TIME );
                    val.i_time = p_subpic->i_stop - p_subpic->i_start;
                    var_Set( p_spu->p_text, "spu-duration", val );

                    var_Create( p_spu->p_text, "spu-elapsed", VLC_VAR_TIME );
                    val.i_time = mdate() - p_subpic->i_start;
                    var_Set( p_spu->p_text, "spu-elapsed", val );

                    var_Create( p_spu->p_text, "text-rerender", VLC_VAR_BOOL );
                    var_SetBool( p_spu->p_text, "text-rerender", false );

                    var_Create( p_spu->p_text, "scale", VLC_VAR_INTEGER );
                    var_SetInteger( p_spu->p_text, "scale",
                              __MIN(i_scale_width_orig, i_scale_height_orig) );

                    if( p_spu->p_text->pf_render_html && p_region->psz_html )
                    {
                        p_spu->p_text->pf_render_html( p_spu->p_text,
                                                       p_region, p_region );
                    }
                    else if( p_spu->p_text->pf_render_text )
                    {
                        p_spu->p_text->pf_render_text( p_spu->p_text,
                                                       p_region, p_region );
                    }
                    b_rerender_text = var_GetBool( p_spu->p_text, "text-rerender" );

                    var_Destroy( p_spu->p_text, "spu-duration" );
                    var_Destroy( p_spu->p_text, "spu-elapsed" );
                    var_Destroy( p_spu->p_text, "text-rerender" );
                    var_Destroy( p_spu->p_text, "scale" );
                }
                p_region->i_align |= SUBPICTURE_RENDERED;
            }

            if( p_region->i_align & SUBPICTURE_RENDERED )
            {
                i_scale_idx   = SCALE_TEXT;
                i_inv_scale_x = i_scale_width_orig;
                i_inv_scale_y = i_scale_height_orig;
            }

            i_x_offset = (p_region->i_x + pi_subpic_x[ i_scale_idx ]) * i_inv_scale_x / 1000;
            i_y_offset = (p_region->i_y + p_subpic->i_y) * i_inv_scale_y / 1000;

            /* Force palette if requested */
            if( p_spu->b_force_palette &&
                ( VLC_FOURCC('Y','U','V','P') == p_region->fmt.i_chroma ) )
            {
                memcpy( p_region->fmt.p_palette->palette,
                        p_spu->palette, 16 );
            }

            /* Scale SPU if necessary */
            if( p_region->p_cache &&
                ( p_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') ) )
            {
                if( pi_scale_width[ i_scale_idx ] * p_region->fmt.i_width / 1000 !=
                    p_region->p_cache->fmt.i_width ||
                    pi_scale_height[ i_scale_idx ] * p_region->fmt.i_height / 1000 !=
                    p_region->p_cache->fmt.i_height )
                {
                    p_subpic->pf_destroy_region( VLC_OBJECT(p_spu),
                                                 p_region->p_cache );
                    p_region->p_cache = 0;
                }
            }

            if( ( ( pi_scale_width[ i_scale_idx ] != 1000 ) ||
                  ( pi_scale_height[ i_scale_idx ] != 1000 ) ) &&
                ( ( pi_scale_width[ i_scale_idx ] > 0 ) ||
                  ( pi_scale_height[ i_scale_idx ] > 0 ) ) &&
                p_spu->p_scale && !p_region->p_cache &&
                ( p_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') ) )
            {
                picture_t *p_pic;

                p_spu->p_scale->fmt_in.video = p_region->fmt;
                p_spu->p_scale->fmt_out.video = p_region->fmt;

                p_region->p_cache =
                    p_subpic->pf_create_region( VLC_OBJECT(p_spu),
                        &p_spu->p_scale->fmt_out.video );
                if( p_spu->p_scale->fmt_out.video.p_palette )
                    *p_spu->p_scale->fmt_out.video.p_palette =
                        *p_region->fmt.p_palette;
                p_region->p_cache->p_next = p_region->p_next;

                vout_CopyPicture( p_spu, &p_region->p_cache->picture,
                                  &p_region->picture );

                p_spu->p_scale->fmt_out.video.i_width =
                    p_region->fmt.i_width * pi_scale_width[ i_scale_idx ] / 1000;
                p_spu->p_scale->fmt_out.video.i_visible_width =
                    p_region->fmt.i_visible_width * pi_scale_width[ i_scale_idx ] / 1000;
                p_spu->p_scale->fmt_out.video.i_height =
                    p_region->fmt.i_height * pi_scale_height[ i_scale_idx ] / 1000;
                p_spu->p_scale->fmt_out.video.i_visible_height =
                    p_region->fmt.i_visible_height * pi_scale_height[ i_scale_idx ] / 1000;
                p_region->p_cache->fmt = p_spu->p_scale->fmt_out.video;
                p_region->p_cache->i_x = p_region->i_x * pi_scale_width[ i_scale_idx ] / 1000;
                p_region->p_cache->i_y = p_region->i_y * pi_scale_height[ i_scale_idx ] / 1000;
                p_region->p_cache->i_align = p_region->i_align;
                p_region->p_cache->i_alpha = p_region->i_alpha;

                p_pic = p_spu->p_scale->pf_video_filter(
                                 p_spu->p_scale, &p_region->p_cache->picture );
                if( p_pic )
                {
                    picture_t p_pic_tmp = p_region->p_cache->picture;
                    p_region->p_cache->picture = *p_pic;
                    *p_pic = p_pic_tmp;
                    free( p_pic );
                }
            }

            if( ( ( pi_scale_width[ i_scale_idx ] != 1000 ) ||
                  ( pi_scale_height[ i_scale_idx ] != 1000 ) ) &&
                ( ( pi_scale_width[ i_scale_idx ] > 0 ) ||
                  ( pi_scale_height[ i_scale_idx ] > 0 ) ) &&
                p_spu->p_scale && p_region->p_cache &&
                ( p_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') )  )
            {
                p_region = p_region->p_cache;
            }

            if( p_region->i_align & SUBPICTURE_ALIGN_BOTTOM )
            {
                i_y_offset = p_fmt->i_height - p_region->fmt.i_height -
                    (p_subpic->i_y + p_region->i_y) * i_inv_scale_y / 1000;
            }
            else if ( !(p_region->i_align & SUBPICTURE_ALIGN_TOP) )
            {
                i_y_offset = p_fmt->i_height / 2 - p_region->fmt.i_height / 2;
            }

            if( p_region->i_align & SUBPICTURE_ALIGN_RIGHT )
            {
                i_x_offset = p_fmt->i_width - p_region->fmt.i_width -
                    (pi_subpic_x[ i_scale_idx ] + p_region->i_x)
                    * i_inv_scale_x / 1000;
            }
            else if ( !(p_region->i_align & SUBPICTURE_ALIGN_LEFT) )
            {
                i_x_offset = p_fmt->i_width / 2 - p_region->fmt.i_width / 2;
            }

            if( p_subpic->b_absolute )
            {
                i_x_offset = (p_region->i_x +
                    pi_subpic_x[ i_scale_idx ] *
                                     pi_scale_width[ i_scale_idx ] / 1000)
                    * i_inv_scale_x / 1000;
                i_y_offset = (p_region->i_y +
                    p_subpic->i_y * pi_scale_height[ i_scale_idx ] / 1000)
                    * i_inv_scale_y / 1000;

            }

            i_x_offset = __MAX( i_x_offset, 0 );
            i_y_offset = __MAX( i_y_offset, 0 );

            if( ( p_spu->i_margin != 0 ) &&
                ( p_spu->b_force_crop == false ) )
            {
                int i_diff = 0;
                int i_low = (i_y_offset - p_spu->i_margin) * i_inv_scale_y / 1000;
                int i_high = i_low + p_region->fmt.i_height;

                /* crop extra margin to keep within bounds */
                if( i_low < 0 )
                    i_diff = i_low;
                if( i_high > (int)p_fmt->i_height )
                    i_diff = i_high - p_fmt->i_height;
                i_y_offset -= ( p_spu->i_margin * i_inv_scale_y / 1000 + i_diff );
            }

            if( p_subpic->b_fade )
            {
                mtime_t i_fade_start = ( p_subpic->i_stop +
                                         p_subpic->i_start ) / 2;
                mtime_t i_now = mdate();
                if( i_now >= i_fade_start && p_subpic->i_stop > i_fade_start )
                {
                    i_fade_alpha = 255 * ( p_subpic->i_stop - i_now ) /
                                   ( p_subpic->i_stop - i_fade_start );
                }
            }

            if( p_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') )
            {
                if( p_spu->p_blend->fmt_in.video.i_chroma != p_region->fmt.i_chroma )
                {
                    /* The chroma is not the same, we need to reload the blend module
                     * XXX to match the old behaviour just test !p_spu->p_blend->fmt_in.video.i_chroma */
                    if( p_spu->p_blend->p_module )
                        module_Unneed( p_spu->p_blend, p_spu->p_blend->p_module );

                    p_spu->p_blend->fmt_in.video = p_region->fmt;
                    p_spu->p_blend->p_module = module_Need( p_spu->p_blend, "video blending", 0, 0 );
                }
                else
                {
                    p_spu->p_blend->fmt_in.video = p_region->fmt;
                }

                /* Force cropping if requested */
                if( p_spu->b_force_crop )
                {
                    video_format_t *p_fmt = &p_spu->p_blend->fmt_in.video;
                    int i_crop_x = p_spu->i_crop_x * pi_scale_width[ i_scale_idx ] / 1000
                                        * i_inv_scale_x / 1000;
                    int i_crop_y = p_spu->i_crop_y * pi_scale_height[ i_scale_idx ] / 1000
                                        * i_inv_scale_y / 1000;
                    int i_crop_width = p_spu->i_crop_width * pi_scale_width[ i_scale_idx ] / 1000
                                        * i_inv_scale_x / 1000;
                    int i_crop_height = p_spu->i_crop_height * pi_scale_height[ i_scale_idx ] / 1000
                                        * i_inv_scale_y / 1000;

                    /* Find the intersection */
                    if( i_crop_x + i_crop_width <= i_x_offset ||
                        i_x_offset + (int)p_fmt->i_visible_width < i_crop_x ||
                        i_crop_y + i_crop_height <= i_y_offset ||
                        i_y_offset + (int)p_fmt->i_visible_height < i_crop_y )
                    {
                        /* No intersection */
                        p_fmt->i_visible_width = p_fmt->i_visible_height = 0;
                    }
                    else
                    {
                        int i_x, i_y, i_x_end, i_y_end;
                        i_x = __MAX( i_crop_x, i_x_offset );
                        i_y = __MAX( i_crop_y, i_y_offset );
                        i_x_end = __MIN( i_crop_x + i_crop_width,
                                       i_x_offset + (int)p_fmt->i_visible_width );
                        i_y_end = __MIN( i_crop_y + i_crop_height,
                                       i_y_offset + (int)p_fmt->i_visible_height );

                        p_fmt->i_x_offset = i_x - i_x_offset;
                        p_fmt->i_y_offset = i_y - i_y_offset;
                        p_fmt->i_visible_width = i_x_end - i_x;
                        p_fmt->i_visible_height = i_y_end - i_y;

                        i_x_offset = i_x;
                        i_y_offset = i_y;
                    }
                }

                i_x_offset = __MAX( i_x_offset, 0 );
                i_y_offset = __MAX( i_y_offset, 0 );