vout_subpictures.c 12 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1 2 3
/*****************************************************************************
 * vout_subpictures.c : subpicture management functions
 *****************************************************************************
Clément Stenac's avatar
Clément Stenac committed
4
 * Copyright (C) 2000-2004 VideoLAN
5
 * $Id$
Sam Hocevar's avatar
 
Sam Hocevar committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
 *
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
 *          Samuel Hocevar <sam@zoy.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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
#include <stdlib.h>                                                /* free() */
#include <stdio.h>                                              /* sprintf() */
#include <string.h>                                            /* strerror() */

32
#include <vlc/vlc.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
33

34
#include "vlc_video.h"
Sam Hocevar's avatar
 
Sam Hocevar committed
35 36
#include "video_output.h"

37 38 39
/**
 * Display a subpicture unit
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
40 41
 * Remove the reservation flag of a subpicture, which will cause it to be
 * ready for display.
42 43 44
 * \param p_vout the video output this subpicture should be displayed on
 * \param p_subpic the subpicture to display
 */
Sam Hocevar's avatar
 
Sam Hocevar committed
45 46
void  vout_DisplaySubPicture( vout_thread_t *p_vout, subpicture_t *p_subpic )
{
Sam Hocevar's avatar
 
Sam Hocevar committed
47
    int         i_margin;
Sam Hocevar's avatar
 
Sam Hocevar committed
48 49 50 51

    /* Check if status is valid */
    if( p_subpic->i_status != RESERVED_SUBPICTURE )
    {
52 53
        msg_Err( p_vout, "subpicture %p has invalid status #%d",
                         p_subpic, p_subpic->i_status );
Sam Hocevar's avatar
 
Sam Hocevar committed
54 55
    }

Sam Hocevar's avatar
 
Sam Hocevar committed
56 57
    /* If the user requested an SPU margin, we force the position after
     * having checked that it was a valid value. */
58
    i_margin = config_GetInt( p_vout, "spumargin" );
Sam Hocevar's avatar
 
Sam Hocevar committed
59 60 61

    if( i_margin >= 0 )
    {
62 63
        if( p_subpic->i_height + (unsigned int)i_margin
                                                 <= p_vout->output.i_height )
Sam Hocevar's avatar
 
Sam Hocevar committed
64 65 66 67 68 69
        {
            p_subpic->i_y = p_vout->output.i_height
                             - i_margin - p_subpic->i_height;
        }
    }

Sam Hocevar's avatar
 
Sam Hocevar committed
70 71 72 73
    /* Remove reservation flag */
    p_subpic->i_status = READY_SUBPICTURE;
}

74 75 76
/**
 * Allocate a subpicture in the video output heap.
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
77 78 79 80
 * This function create a reserved subpicture in the video output 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.
81 82 83 84
 * \param p_vout the vout in which to create the subpicture
 * \param i_type the type of the subpicture
 * \return NULL on error, a reserved subpicture otherwise
 */
85 86
subpicture_t *vout_CreateSubPicture( vout_thread_t *p_vout, int i_channel,
                                     int i_content, int i_type )
Sam Hocevar's avatar
 
Sam Hocevar committed
87 88
{
    int                 i_subpic;                        /* subpicture index */
89
    subpicture_t *      p_subpic = NULL;            /* first free subpicture */
Sam Hocevar's avatar
 
Sam Hocevar committed
90 91 92 93

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

94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
    /*
     * Destroy all subpics which are not in the correct channel and
     * subpics which are in the right channel and have the same content type
     * (only concerns exclusive channels)
     */
    if( i_channel >= BEGIN_EXCLUSIVE_CHAN )
    {
        for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
        {
            p_subpic = &p_vout->p_subpicture[i_subpic];
            if( p_subpic->i_status == FREE_SUBPICTURE
                || ( p_subpic->i_status != RESERVED_SUBPICTURE
                     && p_subpic->i_status != READY_SUBPICTURE ) )
            {
                continue;
            }
            if( ( p_subpic->i_channel != i_channel
                  && p_subpic->i_channel >= BEGIN_EXCLUSIVE_CHAN )
                || ( p_subpic->i_channel == i_channel
                     && p_subpic->i_content == i_content ) )
            {
                if( p_subpic->pf_destroy )
                {
                    p_subpic->pf_destroy( p_subpic );
                }
                p_subpic->i_status = FREE_SUBPICTURE;
            }
        }
    }

Sam Hocevar's avatar
 
Sam Hocevar committed
124 125 126
    /*
     * Look for an empty place
     */
127
    p_subpic = NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
128 129
    for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
    {
130
        if( p_vout->p_subpicture[i_subpic].i_status == FREE_SUBPICTURE )
Sam Hocevar's avatar
 
Sam Hocevar committed
131 132
        {
            /* Subpicture is empty and ready for allocation */
133 134 135
            p_subpic = &p_vout->p_subpicture[i_subpic];
            p_vout->p_subpicture[i_subpic].i_status = RESERVED_SUBPICTURE;
            break;
Sam Hocevar's avatar
 
Sam Hocevar committed
136 137 138
        }
    }

139 140
    /* If no free subpicture could be found */
    if( p_subpic == NULL )
Sam Hocevar's avatar
 
Sam Hocevar committed
141
    {
142
        msg_Err( p_vout, "subpicture heap is full" );
Sam Hocevar's avatar
 
Sam Hocevar committed
143
        vlc_mutex_unlock( &p_vout->subpicture_lock );
144
        return NULL;
Sam Hocevar's avatar
 
Sam Hocevar committed
145
    }
Sam Hocevar's avatar
 
Sam Hocevar committed
146

147
    /* Copy subpicture information, set some default values */
148 149 150
    p_subpic->i_channel = i_channel;
    p_subpic->i_content = i_content;

151 152
    p_subpic->i_type    = i_type;
    p_subpic->i_status  = RESERVED_SUBPICTURE;
Sam Hocevar's avatar
 
Sam Hocevar committed
153

154 155 156 157 158 159 160 161
    p_subpic->i_start   = 0;
    p_subpic->i_stop    = 0;
    p_subpic->b_ephemer = VLC_FALSE;

    p_subpic->i_x       = 0;
    p_subpic->i_y       = 0;
    p_subpic->i_width   = 0;
    p_subpic->i_height  = 0;
Sam Hocevar's avatar
 
Sam Hocevar committed
162 163

    vlc_mutex_unlock( &p_vout->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
164

165
    return p_subpic;
Sam Hocevar's avatar
 
Sam Hocevar committed
166 167
}

168 169 170
/**
 * Remove a subpicture from the heap
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
171 172 173 174
 * 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 output thread.
175
 */
Sam Hocevar's avatar
 
Sam Hocevar committed
176 177
void vout_DestroySubPicture( vout_thread_t *p_vout, subpicture_t *p_subpic )
{
Gildas Bazin's avatar
 
Gildas Bazin committed
178 179 180 181 182 183 184 185 186 187
    /* Get lock */
    vlc_mutex_lock( &p_vout->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_vout->subpicture_lock );
        return;
    }

188 189 190 191 192 193 194 195 196 197 198 199 200 201
    /* Check if status is valid */
    if( ( p_subpic->i_status != RESERVED_SUBPICTURE )
           && ( p_subpic->i_status != READY_SUBPICTURE ) )
    {
        msg_Err( p_vout, "subpicture %p has invalid status %d",
                         p_subpic, p_subpic->i_status );
    }

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

    p_subpic->i_status = FREE_SUBPICTURE;
Gildas Bazin's avatar
 
Gildas Bazin committed
202 203

    vlc_mutex_unlock( &p_vout->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
204 205 206 207 208
}

/*****************************************************************************
 * vout_RenderSubPictures: render a subpicture list
 *****************************************************************************
Sam Hocevar's avatar
 
Sam Hocevar committed
209
 * This function renders all sub picture units in the list.
Sam Hocevar's avatar
 
Sam Hocevar committed
210
 *****************************************************************************/
Sam Hocevar's avatar
 
Sam Hocevar committed
211 212
void vout_RenderSubPictures( vout_thread_t *p_vout, picture_t *p_pic,
                             subpicture_t *p_subpic )
Sam Hocevar's avatar
 
Sam Hocevar committed
213
{
Gildas Bazin's avatar
 
Gildas Bazin committed
214 215 216 217 218
    /* Get lock */
    vlc_mutex_lock( &p_vout->subpicture_lock );

    /* Check i_status again to make sure spudec hasn't destroyed the subpic */
    while( p_subpic != NULL && p_subpic->i_status != FREE_SUBPICTURE )
Sam Hocevar's avatar
 
Sam Hocevar committed
219
    {
Sam Hocevar's avatar
 
Sam Hocevar committed
220
        p_subpic->pf_render( p_vout, p_pic, p_subpic );
Sam Hocevar's avatar
 
Sam Hocevar committed
221 222
        p_subpic = p_subpic->p_next;
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
223 224

    vlc_mutex_unlock( &p_vout->subpicture_lock );
Sam Hocevar's avatar
 
Sam Hocevar committed
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
}

/*****************************************************************************
 * vout_SortSubPictures: find the subpictures to display
 *****************************************************************************
 * This function parses all subpictures and decides which ones need to be
 * displayed. This operation does not need lock, since only READY_SUBPICTURE
 * are handled. If no picture has been selected, display_date will depend on
 * the subpicture.
 * We also check for ephemer DVD subpictures (subpictures that have
 * to be removed if a newer one is available), which makes it a lot
 * more difficult to guess if a subpicture has to be rendered or not.
 *****************************************************************************/
subpicture_t *vout_SortSubPictures( vout_thread_t *p_vout,
                                    mtime_t display_date )
{
    int i_index;
    subpicture_t *p_subpic     = NULL;
    subpicture_t *p_ephemer    = NULL;
    mtime_t       ephemer_date = 0;

    /* We get an easily parsable chained list of subpictures which
     * ends with NULL since p_subpic was initialized to NULL. */
    for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
    {
        if( p_vout->p_subpicture[i_index].i_status == READY_SUBPICTURE )
        {
            /* If it is a DVD subpicture, check its date */
Sam Hocevar's avatar
 
Sam Hocevar committed
253
            if( p_vout->p_subpicture[i_index].i_type == MEMORY_SUBPICTURE )
Sam Hocevar's avatar
 
Sam Hocevar committed
254
            {
255 256
                if( !p_vout->p_subpicture[i_index].b_ephemer
                     && display_date > p_vout->p_subpicture[i_index].i_stop )
Sam Hocevar's avatar
 
Sam Hocevar committed
257 258 259 260 261 262 263
                {
                    /* Too late, destroy the subpic */
                    vout_DestroySubPicture( p_vout,
                                    &p_vout->p_subpicture[i_index] );
                    continue;
                }

264 265
                if( display_date
                     && display_date < p_vout->p_subpicture[i_index].i_start )
Sam Hocevar's avatar
 
Sam Hocevar committed
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
                {
                    /* Too early, come back next monday */
                    continue;
                }

                /* If this is an ephemer subpic, see if it's the
                 * youngest we have */
                if( p_vout->p_subpicture[i_index].b_ephemer )
                {
                    if( p_ephemer == NULL )
                    {
                        p_ephemer = &p_vout->p_subpicture[i_index];
                        continue;
                    }

                    if( p_vout->p_subpicture[i_index].i_start
                                                     < p_ephemer->i_start )
                    {
                        /* Link the previous ephemer subpicture and
                         * replace it with the current one */
                        p_ephemer->p_next = p_subpic;
                        p_subpic = p_ephemer;
                        p_ephemer = &p_vout->p_subpicture[i_index];

                        /* If it's the 2nd youngest subpicture,
                         * register its date */
                        if( !ephemer_date
                              || ephemer_date > p_subpic->i_start )
                        {
                            ephemer_date = p_subpic->i_start;
                        }

                        continue;
                    }
                }

                p_vout->p_subpicture[i_index].p_next = p_subpic;
                p_subpic = &p_vout->p_subpicture[i_index];

305 306
                /* If it's the 2nd youngest subpicture, register its date */
                if( !ephemer_date || ephemer_date > p_subpic->i_start )
Sam Hocevar's avatar
 
Sam Hocevar committed
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
                {
                    ephemer_date = p_subpic->i_start;
                }
            }
            /* If it's not a DVD subpicture, just register it */
            else
            {
                p_vout->p_subpicture[i_index].p_next = p_subpic;
                p_subpic = &p_vout->p_subpicture[i_index];
            }
        }
    }

    /* If we found an ephemer subpicture, check if it has to be
     * displayed */
    if( p_ephemer != NULL )
    {
        if( p_ephemer->i_start < ephemer_date )
        {
            /* Ephemer subpicture has lived too long */
            vout_DestroySubPicture( p_vout, p_ephemer );
        }
        else
        {
            /* Ephemer subpicture can still live a bit */
            p_ephemer->p_next = p_subpic;
            return p_ephemer;
        }
    }

    return p_subpic;
}