git.sesse.net Git - vlc/blob - src/video_output/video_output.c

   1 /*****************************************************************************
   2  * video_output.c : video output thread
   3  *
   4  * This module describes the programming interface for video output threads.
   5  * It includes functions allowing to open a new thread, send pictures to a
   6  * thread, and destroy a previously oppened video output thread.
   7  *****************************************************************************
   8  * Copyright (C) 2000-2007 the VideoLAN team
   9  * $Id$
  10  *
  11  * Authors: Vincent Seguin <seguin@via.ecp.fr>
  12  *          Gildas Bazin <gbazin@videolan.org>
  13  *
  14  * This program is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 2 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with this program; if not, write to the Free Software
  26  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  27  *****************************************************************************/
  28
  29 /*****************************************************************************
  30  * Preamble
  31  *****************************************************************************/
  32 #ifdef HAVE_CONFIG_H
  33 # include "config.h"
  34 #endif
  35
  36 #include <vlc_common.h>
  37
  38 #include <stdlib.h>                                                /* free() */
  39 #include <string.h>
  40
  41
  42 #ifdef HAVE_SYS_TIMES_H
  43 #   include <sys/times.h>
  44 #endif
  45
  46 #include <vlc_vout.h>
  47
  48 #include <vlc_filter.h>
  49 #include <vlc_osd.h>
  50 #include <assert.h>
  51
  52 #if defined( __APPLE__ )
  53 /* Include darwin_specific.h here if needed */
  54 #endif
  55
  56 /** FIXME This is quite ugly but needed while we don't have counters
  57  * helpers */
  58 #include "input/input_internal.h"
  59
  60 #include "modules/modules.h"
  61 #include "vout_pictures.h"
  62 #include "vout_internal.h"
  63
  64 /*****************************************************************************
  65  * Local prototypes
  66  *****************************************************************************/
  67 static int      InitThread        ( vout_thread_t * );
  68 static void*    RunThread         ( vlc_object_t *  );
  69 static void     ErrorThread       ( vout_thread_t * );
  70 static void     CleanThread       ( vout_thread_t * );
  71 static void     EndThread         ( vout_thread_t * );
  72
  73 static void     AspectRatio       ( int, int *, int * );
  74
  75 static void VideoFormatImportRgb( video_format_t *, const picture_heap_t * );
  76 static void PictureHeapFixRgb( picture_heap_t * );
  77
  78 static void     vout_Destructor   ( vlc_object_t * p_this );
  79
  80 /* Object variables callbacks */
  81 static int DeinterlaceCallback( vlc_object_t *, char const *,
  82                                 vlc_value_t, vlc_value_t, void * );
  83 static int FilterCallback( vlc_object_t *, char const *,
  84                            vlc_value_t, vlc_value_t, void * );
  85 static int VideoFilter2Callback( vlc_object_t *, char const *,
  86                                  vlc_value_t, vlc_value_t, void * );
  87
  88 /* From vout_intf.c */
  89 int vout_Snapshot( vout_thread_t *, picture_t * );
  90
  91 /* Display media title in OSD */
  92 static void DisplayTitleOnOSD( vout_thread_t *p_vout );
  93
  94 /* */
  95 static void DropPicture( vout_thread_t *p_vout, picture_t *p_picture );
  96
  97 /*****************************************************************************
  98  * Video Filter2 functions
  99  *****************************************************************************/
 100 static picture_t *video_new_buffer_filter( filter_t *p_filter )
 101 {
 102     vout_thread_t *p_vout = (vout_thread_t*)p_filter->p_owner;
 103     picture_t *p_picture = vout_CreatePicture( p_vout, 0, 0, 0 );
 104
 105     p_picture->i_status = READY_PICTURE;
 106
 107     return p_picture;
 108 }
 109
 110 static void video_del_buffer_filter( filter_t *p_filter, picture_t *p_pic )
 111 {
 112     vout_thread_t *p_vout = (vout_thread_t*)p_filter->p_owner;
 113
 114     DropPicture( p_vout, p_pic );
 115 }
 116
 117 static int video_filter_buffer_allocation_init( filter_t *p_filter, void *p_data )
 118 {
 119     p_filter->pf_vout_buffer_new = video_new_buffer_filter;
 120     p_filter->pf_vout_buffer_del = video_del_buffer_filter;
 121     p_filter->p_owner = p_data; /* p_vout */
 122     return VLC_SUCCESS;
 123 }
 124
 125 /*****************************************************************************
 126  * vout_Request: find a video output thread, create one, or destroy one.
 127  *****************************************************************************
 128  * This function looks for a video output thread matching the current
 129  * properties. If not found, it spawns a new one.
 130  *****************************************************************************/
 131 vout_thread_t *__vout_Request( vlc_object_t *p_this, vout_thread_t *p_vout,
 132                                video_format_t *p_fmt )
 133 {
 134     const bool b_vout_provided = p_vout != NULL;
 135     if( !p_fmt )
 136     {
 137         /* Video output is no longer used.
 138          * TODO: support for reusing video outputs with proper _thread-safe_
 139          * reference handling. */
 140         if( p_vout )
 141             vout_CloseAndRelease( p_vout );
 142         return NULL;
 143     }
 144
 145     /* If a video output was provided, lock it, otherwise look for one. */
 146     if( p_vout )
 147     {
 148         vlc_object_hold( p_vout );
 149     }
 150
 151     /* TODO: find a suitable unused video output */
 152
 153     /* If we now have a video output, check it has the right properties */
 154     if( p_vout )
 155     {
 156         char *psz_filter_chain;
 157         vlc_value_t val;
 158
 159         vlc_mutex_lock( &p_vout->change_lock );
 160
 161         /* We don't directly check for the "vout-filter" variable for obvious
 162          * performance reasons. */
 163         if( p_vout->p->b_filter_change )
 164         {
 165             var_Get( p_vout, "vout-filter", &val );
 166             psz_filter_chain = val.psz_string;
 167
 168             if( psz_filter_chain && !*psz_filter_chain )
 169             {
 170                 free( psz_filter_chain );
 171                 psz_filter_chain = NULL;
 172             }
 173             if( p_vout->p->psz_filter_chain && !*p_vout->p->psz_filter_chain )
 174             {
 175                 free( p_vout->p->psz_filter_chain );
 176                 p_vout->p->psz_filter_chain = NULL;
 177             }
 178
 179             if( !psz_filter_chain && !p_vout->p->psz_filter_chain )
 180             {
 181                 p_vout->p->b_filter_change = false;
 182             }
 183
 184             free( psz_filter_chain );
 185         }
 186
 187         if( p_vout->fmt_render.i_chroma != p_fmt->i_chroma ||
 188             p_vout->fmt_render.i_width != p_fmt->i_width ||
 189             p_vout->fmt_render.i_height != p_fmt->i_height ||
 190             p_vout->p->b_filter_change )
 191         {
 192             vlc_mutex_unlock( &p_vout->change_lock );
 193
 194             /* We are not interested in this format, close this vout */
 195             vout_CloseAndRelease( p_vout );
 196             vlc_object_release( p_vout );
 197             p_vout = NULL;
 198         }
 199         else
 200         {
 201             /* This video output is cool! Hijack it. */
 202             if( p_vout->fmt_render.i_aspect != p_fmt->i_aspect )
 203             {
 204                 /* Correct aspect ratio on change
 205                  * FIXME factorize this code with other aspect ration related code */
 206                 unsigned int i_sar_num;
 207                 unsigned int i_sar_den;
 208                 unsigned int i_aspect;
 209
 210                 i_aspect = p_fmt->i_aspect;
 211                 vlc_ureduce( &i_sar_num, &i_sar_den,
 212                              p_fmt->i_sar_num, p_fmt->i_sar_den, 50000 );
 213 #if 0
 214                 /* What's that, it does not seems to be used correcly everywhere
 215                  * beside the previous p_vout->fmt_render.i_aspect != p_fmt->i_aspect
 216                  * should be fixed to use it too then */
 217                 if( p_vout->i_par_num > 0 && p_vout->i_par_den > 0 )
 218                 {
 219                     i_sar_num *= p_vout->i_par_den;
 220                     i_sar_den *= p_vout->i_par_num;
 221                     i_aspect = i_aspect * p_vout->i_par_den / p_vout->i_par_num;
 222                 }
 223 #endif
 224
 225                 if( i_sar_num > 0 && i_sar_den > 0 && i_aspect > 0 )
 226                 {
 227                     p_vout->fmt_in.i_sar_num = i_sar_num;
 228                     p_vout->fmt_in.i_sar_den = i_sar_den;
 229                     p_vout->fmt_in.i_aspect  = i_aspect;
 230
 231                     p_vout->fmt_render.i_sar_num = i_sar_num;
 232                     p_vout->fmt_render.i_sar_den = i_sar_den;
 233                     p_vout->fmt_render.i_aspect  = i_aspect;
 234
 235                     p_vout->render.i_aspect   = i_aspect;
 236
 237                     p_vout->i_changes |= VOUT_ASPECT_CHANGE;
 238
 239                 }
 240             }
 241             vlc_mutex_unlock( &p_vout->change_lock );
 242
 243             vlc_object_release( p_vout );
 244         }
 245
 246         if( p_vout )
 247         {
 248             msg_Dbg( p_this, "reusing provided vout" );
 249
 250             spu_Attach( p_vout->p_spu, p_this, true );
 251
 252             vlc_object_detach( p_vout );
 253             vlc_object_attach( p_vout, p_this );
 254
 255             /* Display title if we are not using the vout given to vout_Request.
 256              * XXX for now b_vout_provided is always true at this stage */
 257             if( p_vout->p->b_title_show && !b_vout_provided )
 258                 DisplayTitleOnOSD( p_vout );
 259         }
 260     }
 261
 262     if( !p_vout )
 263     {
 264         msg_Dbg( p_this, "no usable vout present, spawning one" );
 265
 266         p_vout = vout_Create( p_this, p_fmt );
 267     }
 268
 269     return p_vout;
 270 }
 271
 272 /*****************************************************************************
 273  * vout_Create: creates a new video output thread
 274  *****************************************************************************
 275  * This function creates a new video output thread, and returns a pointer
 276  * to its description. On error, it returns NULL.
 277  *****************************************************************************/
 278 vout_thread_t * __vout_Create( vlc_object_t *p_parent, video_format_t *p_fmt )
 279 {
 280     vout_thread_t  * p_vout;                            /* thread descriptor */
 281     input_thread_t * p_input_thread;
 282     int              i_index;                               /* loop variable */
 283     vlc_value_t      val, text;
 284
 285     unsigned int i_width = p_fmt->i_width;
 286     unsigned int i_height = p_fmt->i_height;
 287     vlc_fourcc_t i_chroma = p_fmt->i_chroma;
 288     unsigned int i_aspect = p_fmt->i_aspect;
 289
 290     config_chain_t *p_cfg;
 291     char *psz_parser;
 292     char *psz_name;
 293
 294     if( i_width <= 0 || i_height <= 0 || i_aspect <= 0 )
 295         return NULL;
 296
 297     vlc_ureduce( &p_fmt->i_sar_num, &p_fmt->i_sar_den,
 298                  p_fmt->i_sar_num, p_fmt->i_sar_den, 50000 );
 299     if( p_fmt->i_sar_num <= 0 || p_fmt->i_sar_den <= 0 )
 300         return NULL;
 301
 302     /* Allocate descriptor */
 303     static const char typename[] = "video output";
 304     p_vout = vlc_custom_create( p_parent, sizeof( *p_vout ), VLC_OBJECT_VOUT,
 305                                 typename );
 306     if( p_vout == NULL )
 307         return NULL;
 308
 309     /* */
 310     p_vout->p = calloc( 1, sizeof(p_vout->p) );
 311     if( !p_vout->p )
 312     {
 313         vlc_object_release( p_vout );
 314         return NULL;
 315     }
 316
 317     /* Initialize pictures - translation tables and functions
 318      * will be initialized later in InitThread */
 319     for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++)
 320     {
 321         p_vout->p_picture[i_index].pf_lock = NULL;
 322         p_vout->p_picture[i_index].pf_unlock = NULL;
 323         p_vout->p_picture[i_index].i_status = FREE_PICTURE;
 324         p_vout->p_picture[i_index].i_type   = EMPTY_PICTURE;
 325         p_vout->p_picture[i_index].b_slow   = 0;
 326     }
 327
 328     /* No images in the heap */
 329     p_vout->i_heap_size = 0;
 330
 331     /* Initialize the rendering heap */
 332     I_RENDERPICTURES = 0;
 333
 334     p_vout->fmt_render        = *p_fmt;   /* FIXME palette */
 335     p_vout->fmt_in            = *p_fmt;   /* FIXME palette */
 336
 337     p_vout->render.i_width    = i_width;
 338     p_vout->render.i_height   = i_height;
 339     p_vout->render.i_chroma   = i_chroma;
 340     p_vout->render.i_aspect   = i_aspect;
 341
 342     p_vout->render.i_rmask    = p_fmt->i_rmask;
 343     p_vout->render.i_gmask    = p_fmt->i_gmask;
 344     p_vout->render.i_bmask    = p_fmt->i_bmask;
 345
 346     p_vout->render.i_last_used_pic = -1;
 347     p_vout->render.b_allow_modify_pics = 1;
 348
 349     /* Zero the output heap */
 350     I_OUTPUTPICTURES = 0;
 351     p_vout->output.i_width    = 0;
 352     p_vout->output.i_height   = 0;
 353     p_vout->output.i_chroma   = 0;
 354     p_vout->output.i_aspect   = 0;
 355
 356     p_vout->output.i_rmask    = 0;
 357     p_vout->output.i_gmask    = 0;
 358     p_vout->output.i_bmask    = 0;
 359
 360     /* Initialize misc stuff */
 361     p_vout->i_changes    = 0;
 362     p_vout->b_scale      = 1;
 363     p_vout->b_fullscreen = 0;
 364     p_vout->i_alignment  = 0;
 365     p_vout->p->render_time  = 10;
 366     p_vout->p->c_fps_samples = 0;
 367     p_vout->p->b_filter_change = 0;
 368     p_vout->pf_control = NULL;
 369     p_vout->p_window = NULL;
 370     p_vout->p->i_par_num =
 371     p_vout->p->i_par_den = 1;
 372
 373     /* Initialize locks */
 374     vlc_mutex_init( &p_vout->picture_lock );
 375     vlc_mutex_init( &p_vout->change_lock );
 376     vlc_mutex_init( &p_vout->p->vfilter_lock );
 377
 378     /* Mouse coordinates */
 379     var_Create( p_vout, "mouse-x", VLC_VAR_INTEGER );
 380     var_Create( p_vout, "mouse-y", VLC_VAR_INTEGER );
 381     var_Create( p_vout, "mouse-button-down", VLC_VAR_INTEGER );
 382     var_Create( p_vout, "mouse-moved", VLC_VAR_BOOL );
 383     var_Create( p_vout, "mouse-clicked", VLC_VAR_INTEGER );
 384
 385     /* Initialize subpicture unit */
 386     p_vout->p_spu = spu_Create( p_vout );
 387     spu_Attach( p_vout->p_spu, p_parent, true );
 388
 389     /* Attach the new object now so we can use var inheritance below */
 390     vlc_object_attach( p_vout, p_parent );
 391
 392     spu_Init( p_vout->p_spu );
 393
 394     /* Take care of some "interface/control" related initialisations */
 395     vout_IntfInit( p_vout );
 396
 397     /* If the parent is not a VOUT object, that means we are at the start of
 398      * the video output pipe */
 399     if( p_parent->i_object_type != VLC_OBJECT_VOUT )
 400     {
 401         /* Look for the default filter configuration */
 402         p_vout->p->psz_filter_chain =
 403             var_CreateGetStringCommand( p_vout, "vout-filter" );
 404
 405         /* Apply video filter2 objects on the first vout */
 406         p_vout->p->psz_vf2 =
 407             var_CreateGetStringCommand( p_vout, "video-filter" );
 408     }
 409     else
 410     {
 411         /* continue the parent's filter chain */
 412         char *psz_tmp;
 413
 414         /* Ugly hack to jump to our configuration chain */
 415         p_vout->p->psz_filter_chain
 416             = ((vout_thread_t *)p_parent)->p->psz_filter_chain;
 417         p_vout->p->psz_filter_chain
 418             = config_ChainCreate( &psz_tmp, &p_cfg, p_vout->p->psz_filter_chain );
 419         config_ChainDestroy( p_cfg );
 420         free( psz_tmp );
 421
 422         /* Create a video filter2 var ... but don't inherit values */
 423         var_Create( p_vout, "video-filter",
 424                     VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
 425         p_vout->p->psz_vf2 = var_GetString( p_vout, "video-filter" );
 426     }
 427
 428     var_AddCallback( p_vout, "video-filter", VideoFilter2Callback, NULL );
 429     p_vout->p->p_vf2_chain = filter_chain_New( p_vout, "video filter2",
 430         false, video_filter_buffer_allocation_init, NULL, p_vout );
 431
 432     /* Choose the video output module */
 433     if( !p_vout->p->psz_filter_chain || !*p_vout->p->psz_filter_chain )
 434     {
 435         var_Create( p_vout, "vout", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 436         var_Get( p_vout, "vout", &val );
 437         psz_parser = val.psz_string;
 438     }
 439     else
 440     {
 441         psz_parser = strdup( p_vout->p->psz_filter_chain );
 442         p_vout->p->b_title_show = false;
 443     }
 444
 445     /* Create the vout thread */
 446     char* psz_tmp = config_ChainCreate( &psz_name, &p_cfg, psz_parser );
 447     free( psz_parser );
 448     free( psz_tmp );
 449     p_vout->p_cfg = p_cfg;
 450     p_vout->p_module = module_need( p_vout,
 451         ( p_vout->p->psz_filter_chain && *p_vout->p->psz_filter_chain ) ?
 452         "video filter" : "video output", psz_name, p_vout->p->psz_filter_chain && *p_vout->p->psz_filter_chain );
 453     free( psz_name );
 454
 455     if( p_vout->p_module == NULL )
 456     {
 457         msg_Err( p_vout, "no suitable vout module" );
 458         // FIXME it's ugly but that's exactly the function that need to be called.
 459         EndThread( p_vout );
 460         vlc_object_detach( p_vout );
 461         vlc_object_release( p_vout );
 462         return NULL;
 463     }
 464
 465     /* Create a few object variables for interface interaction */
 466     var_Create( p_vout, "deinterlace", VLC_VAR_STRING | VLC_VAR_HASCHOICE );
 467     text.psz_string = _("Deinterlace");
 468     var_Change( p_vout, "deinterlace", VLC_VAR_SETTEXT, &text, NULL );
 469     val.psz_string = (char *)""; text.psz_string = _("Disable");
 470     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 471     val.psz_string = (char *)"discard"; text.psz_string = _("Discard");
 472     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 473     val.psz_string = (char *)"blend"; text.psz_string = _("Blend");
 474     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 475     val.psz_string = (char *)"mean"; text.psz_string = _("Mean");
 476     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 477     val.psz_string = (char *)"bob"; text.psz_string = _("Bob");
 478     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 479     val.psz_string = (char *)"linear"; text.psz_string = _("Linear");
 480     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 481     val.psz_string = (char *)"x"; text.psz_string = (char *)"X";
 482     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 483
 484     if( var_Get( p_vout, "deinterlace-mode", &val ) == VLC_SUCCESS )
 485     {
 486         var_Set( p_vout, "deinterlace", val );
 487         free( val.psz_string );
 488     }
 489     var_AddCallback( p_vout, "deinterlace", DeinterlaceCallback, NULL );
 490
 491     var_Create( p_vout, "vout-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 492     text.psz_string = _("Filters");
 493     var_Change( p_vout, "vout-filter", VLC_VAR_SETTEXT, &text, NULL );
 494     var_AddCallback( p_vout, "vout-filter", FilterCallback, NULL );
 495
 496     /* Calculate delay created by internal caching */
 497     p_input_thread = (input_thread_t *)vlc_object_find( p_vout,
 498                                            VLC_OBJECT_INPUT, FIND_ANYWHERE );
 499     if( p_input_thread )
 500     {
 501         p_vout->p->i_pts_delay = p_input_thread->i_pts_delay;
 502         vlc_object_release( p_input_thread );
 503     }
 504     else
 505     {
 506         p_vout->p->i_pts_delay = DEFAULT_PTS_DELAY;
 507     }
 508
 509     if( vlc_thread_create( p_vout, "video output", RunThread,
 510                            VLC_THREAD_PRIORITY_OUTPUT, true ) )
 511     {
 512         module_unneed( p_vout, p_vout->p_module );
 513         vlc_object_release( p_vout );
 514         return NULL;
 515     }
 516
 517     vlc_object_set_destructor( p_vout, vout_Destructor );
 518
 519     if( p_vout->b_error )
 520     {
 521         msg_Err( p_vout, "video output creation failed" );
 522         vout_CloseAndRelease( p_vout );
 523         return NULL;
 524     }
 525
 526     return p_vout;
 527 }
 528
 529 /*****************************************************************************
 530  * vout_Close: Close a vout created by vout_Create.
 531  *****************************************************************************
 532  * You HAVE to call it on vout created by vout_Create before vlc_object_release.
 533  * You should NEVER call it on vout not obtained through vout_Create
 534  * (like with vout_Request or vlc_object_find.)
 535  * You can use vout_CloseAndRelease() as a convenient method.
 536  *****************************************************************************/
 537 void vout_Close( vout_thread_t *p_vout )
 538 {
 539     assert( p_vout );
 540
 541     vlc_object_kill( p_vout );
 542     vlc_thread_join( p_vout );
 543     module_unneed( p_vout, p_vout->p_module );
 544     p_vout->p_module = NULL;
 545 }
 546
 547 /* */
 548 static void vout_Destructor( vlc_object_t * p_this )
 549 {
 550     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 551
 552     /* Make sure the vout was stopped first */
 553     assert( !p_vout->p_module );
 554
 555     /* Destroy the locks */
 556     vlc_mutex_destroy( &p_vout->picture_lock );
 557     vlc_mutex_destroy( &p_vout->change_lock );
 558     vlc_mutex_destroy( &p_vout->p->vfilter_lock );
 559
 560     free( p_vout->p->psz_filter_chain );
 561
 562     config_ChainDestroy( p_vout->p_cfg );
 563
 564     free( p_vout->p );
 565
 566 #ifndef __APPLE__
 567     vout_thread_t *p_another_vout;
 568
 569     /* This is a dirty hack mostly for Linux, where there is no way to get the
 570      * GUI back if you closed it while playing video. This is solved in
 571      * Mac OS X, where we have this novelty called menubar, that will always
 572      * allow you access to the applications main functionality. They should try
 573      * that on linux sometime. */
 574     p_another_vout = vlc_object_find( p_this->p_libvlc,
 575                                       VLC_OBJECT_VOUT, FIND_ANYWHERE );
 576     if( p_another_vout == NULL )
 577         var_SetBool( p_this->p_libvlc, "intf-show", true );
 578     else
 579         vlc_object_release( p_another_vout );
 580 #endif
 581 }
 582
 583 /*****************************************************************************
 584  * InitThread: initialize video output thread
 585  *****************************************************************************
 586  * This function is called from RunThread and performs the second step of the
 587  * initialization. It returns 0 on success. Note that the thread's flag are not
 588  * modified inside this function.
 589  * XXX You have to enter it with change_lock taken.
 590  *****************************************************************************/
 591 static int ChromaCreate( vout_thread_t *p_vout );
 592 static void ChromaDestroy( vout_thread_t *p_vout );
 593
 594 static bool ChromaIsEqual( const picture_heap_t *p_output, const picture_heap_t *p_render )
 595 {
 596      if( !vout_ChromaCmp( p_output->i_chroma, p_render->i_chroma ) )
 597          return false;
 598
 599      if( p_output->i_chroma != FOURCC_RV15 &&
 600          p_output->i_chroma != FOURCC_RV16 &&
 601          p_output->i_chroma != FOURCC_RV24 &&
 602          p_output->i_chroma != FOURCC_RV32 )
 603          return true;
 604
 605      return p_output->i_rmask == p_render->i_rmask &&
 606             p_output->i_gmask == p_render->i_gmask &&
 607             p_output->i_bmask == p_render->i_bmask;
 608 }
 609
 610 static int InitThread( vout_thread_t *p_vout )
 611 {
 612     int i, i_aspect_x, i_aspect_y;
 613
 614 #ifdef STATS
 615     p_vout->c_loops = 0;
 616 #endif
 617
 618     /* Initialize output method, it allocates direct buffers for us */
 619     if( p_vout->pf_init( p_vout ) )
 620         return VLC_EGENERIC;
 621
 622     if( !I_OUTPUTPICTURES )
 623     {
 624         msg_Err( p_vout, "plugin was unable to allocate at least "
 625                          "one direct buffer" );
 626         p_vout->pf_end( p_vout );
 627         return VLC_EGENERIC;
 628     }
 629
 630     if( I_OUTPUTPICTURES > VOUT_MAX_PICTURES )
 631     {
 632         msg_Err( p_vout, "plugin allocated too many direct buffers, "
 633                          "our internal buffers must have overflown." );
 634         p_vout->pf_end( p_vout );
 635         return VLC_EGENERIC;
 636     }
 637
 638     msg_Dbg( p_vout, "got %i direct buffer(s)", I_OUTPUTPICTURES );
 639
 640     AspectRatio( p_vout->fmt_render.i_aspect, &i_aspect_x, &i_aspect_y );
 641
 642     msg_Dbg( p_vout, "picture in %ix%i (%i,%i,%ix%i), "
 643              "chroma %4.4s, ar %i:%i, sar %i:%i",
 644              p_vout->fmt_render.i_width, p_vout->fmt_render.i_height,
 645              p_vout->fmt_render.i_x_offset, p_vout->fmt_render.i_y_offset,
 646              p_vout->fmt_render.i_visible_width,
 647              p_vout->fmt_render.i_visible_height,
 648              (char*)&p_vout->fmt_render.i_chroma,
 649              i_aspect_x, i_aspect_y,
 650              p_vout->fmt_render.i_sar_num, p_vout->fmt_render.i_sar_den );
 651
 652     AspectRatio( p_vout->fmt_in.i_aspect, &i_aspect_x, &i_aspect_y );
 653
 654     msg_Dbg( p_vout, "picture user %ix%i (%i,%i,%ix%i), "
 655              "chroma %4.4s, ar %i:%i, sar %i:%i",
 656              p_vout->fmt_in.i_width, p_vout->fmt_in.i_height,
 657              p_vout->fmt_in.i_x_offset, p_vout->fmt_in.i_y_offset,
 658              p_vout->fmt_in.i_visible_width,
 659              p_vout->fmt_in.i_visible_height,
 660              (char*)&p_vout->fmt_in.i_chroma,
 661              i_aspect_x, i_aspect_y,
 662              p_vout->fmt_in.i_sar_num, p_vout->fmt_in.i_sar_den );
 663
 664     if( !p_vout->fmt_out.i_width || !p_vout->fmt_out.i_height )
 665     {
 666         p_vout->fmt_out.i_width = p_vout->fmt_out.i_visible_width =
 667             p_vout->output.i_width;
 668         p_vout->fmt_out.i_height = p_vout->fmt_out.i_visible_height =
 669             p_vout->output.i_height;
 670         p_vout->fmt_out.i_x_offset =  p_vout->fmt_out.i_y_offset = 0;
 671
 672         p_vout->fmt_out.i_aspect = p_vout->output.i_aspect;
 673         p_vout->fmt_out.i_chroma = p_vout->output.i_chroma;
 674     }
 675     if( !p_vout->fmt_out.i_sar_num || !p_vout->fmt_out.i_sar_num )
 676     {
 677         p_vout->fmt_out.i_sar_num = p_vout->fmt_out.i_aspect *
 678             p_vout->fmt_out.i_height;
 679         p_vout->fmt_out.i_sar_den = VOUT_ASPECT_FACTOR *
 680             p_vout->fmt_out.i_width;
 681     }
 682
 683     vlc_ureduce( &p_vout->fmt_out.i_sar_num, &p_vout->fmt_out.i_sar_den,
 684                  p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den, 0 );
 685
 686     AspectRatio( p_vout->fmt_out.i_aspect, &i_aspect_x, &i_aspect_y );
 687
 688     msg_Dbg( p_vout, "picture out %ix%i (%i,%i,%ix%i), "
 689              "chroma %4.4s, ar %i:%i, sar %i:%i",
 690              p_vout->fmt_out.i_width, p_vout->fmt_out.i_height,
 691              p_vout->fmt_out.i_x_offset, p_vout->fmt_out.i_y_offset,
 692              p_vout->fmt_out.i_visible_width,
 693              p_vout->fmt_out.i_visible_height,
 694              (char*)&p_vout->fmt_out.i_chroma,
 695              i_aspect_x, i_aspect_y,
 696              p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den );
 697
 698     /* FIXME removed the need of both fmt_* and heap infos */
 699     /* Calculate shifts from system-updated masks */
 700     PictureHeapFixRgb( &p_vout->render );
 701     VideoFormatImportRgb( &p_vout->fmt_render, &p_vout->render );
 702
 703     PictureHeapFixRgb( &p_vout->output );
 704     VideoFormatImportRgb( &p_vout->fmt_out, &p_vout->output );
 705
 706     /* Check whether we managed to create direct buffers similar to
 707      * the render buffers, ie same size and chroma */
 708     if( ( p_vout->output.i_width == p_vout->render.i_width )
 709      && ( p_vout->output.i_height == p_vout->render.i_height )
 710      && ( ChromaIsEqual( &p_vout->output, &p_vout->render ) ) )
 711     {
 712         /* Cool ! We have direct buffers, we can ask the decoder to
 713          * directly decode into them ! Map the first render buffers to
 714          * the first direct buffers, but keep the first direct buffer
 715          * for memcpy operations */
 716         p_vout->p->b_direct = true;
 717
 718         for( i = 1; i < VOUT_MAX_PICTURES; i++ )
 719         {
 720             if( p_vout->p_picture[ i ].i_type != DIRECT_PICTURE &&
 721                 I_RENDERPICTURES >= VOUT_MIN_DIRECT_PICTURES - 1 &&
 722                 p_vout->p_picture[ i - 1 ].i_type == DIRECT_PICTURE )
 723             {
 724                 /* We have enough direct buffers so there's no need to
 725                  * try to use system memory buffers. */
 726                 break;
 727             }
 728             PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
 729             I_RENDERPICTURES++;
 730         }
 731
 732         msg_Dbg( p_vout, "direct render, mapping "
 733                  "render pictures 0-%i to system pictures 1-%i",
 734                  VOUT_MAX_PICTURES - 2, VOUT_MAX_PICTURES - 1 );
 735     }
 736     else
 737     {
 738         /* Rats... Something is wrong here, we could not find an output
 739          * plugin able to directly render what we decode. See if we can
 740          * find a chroma plugin to do the conversion */
 741         p_vout->p->b_direct = false;
 742
 743         if( ChromaCreate( p_vout ) )
 744         {
 745             p_vout->pf_end( p_vout );
 746             return VLC_EGENERIC;
 747         }
 748
 749         msg_Dbg( p_vout, "indirect render, mapping "
 750                  "render pictures 0-%i to system pictures %i-%i",
 751                  VOUT_MAX_PICTURES - 1, I_OUTPUTPICTURES,
 752                  I_OUTPUTPICTURES + VOUT_MAX_PICTURES - 1 );
 753
 754         /* Append render buffers after the direct buffers */
 755         for( i = I_OUTPUTPICTURES; i < 2 * VOUT_MAX_PICTURES; i++ )
 756         {
 757             PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
 758             I_RENDERPICTURES++;
 759
 760             /* Check if we have enough render pictures */
 761             if( I_RENDERPICTURES == VOUT_MAX_PICTURES )
 762                 break;
 763         }
 764     }
 765
 766     /* Link pictures back to their heap */
 767     for( i = 0 ; i < I_RENDERPICTURES ; i++ )
 768     {
 769         PP_RENDERPICTURE[ i ]->p_heap = &p_vout->render;
 770     }
 771
 772     for( i = 0 ; i < I_OUTPUTPICTURES ; i++ )
 773     {
 774         PP_OUTPUTPICTURE[ i ]->p_heap = &p_vout->output;
 775     }
 776
 777     return VLC_SUCCESS;
 778 }
 779
 780 /*****************************************************************************
 781  * RunThread: video output thread
 782  *****************************************************************************
 783  * Video output thread. This function does only returns when the thread is
 784  * terminated. It handles the pictures arriving in the video heap and the
 785  * display device events.
 786  *****************************************************************************/
 787 static void* RunThread( vlc_object_t *p_this )
 788 {
 789     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 790     int             i_idle_loops = 0;  /* loops without displaying a picture */
 791
 792     picture_t *     p_last_picture = NULL;                   /* last picture */
 793
 794     subpicture_t *  p_subpic = NULL;                   /* subpicture pointer */
 795
 796     bool            b_drop_late;
 797
 798     int             i_displayed = 0, i_lost = 0;
 799     int canc = vlc_savecancel ();
 800
 801     /*
 802      * Initialize thread
 803      */
 804     vlc_mutex_lock( &p_vout->change_lock );
 805     p_vout->b_error = InitThread( p_vout );
 806
 807     b_drop_late = var_CreateGetBool( p_vout, "drop-late-frames" );
 808
 809     /* signal the creation of the vout */
 810     vlc_thread_ready( p_vout );
 811
 812     if( p_vout->b_error )
 813     {
 814         EndThread( p_vout );
 815         vlc_mutex_unlock( &p_vout->change_lock );
 816         vlc_restorecancel (canc);
 817         return NULL;
 818     }
 819
 820     vlc_object_lock( p_vout );
 821
 822     if( p_vout->p->b_title_show )
 823         DisplayTitleOnOSD( p_vout );
 824
 825     /*
 826      * Main loop - it is not executed if an error occurred during
 827      * initialization
 828      */
 829     while( vlc_object_alive( p_vout ) && !p_vout->b_error )
 830     {
 831         /* Initialize loop variables */
 832         const mtime_t current_date = mdate();
 833         picture_t *p_picture = NULL;
 834         picture_t *p_filtered_picture;
 835         mtime_t display_date = 0;
 836         picture_t *p_directbuffer;
 837         input_thread_t *p_input;
 838         int i_index;
 839
 840 #if 0
 841         p_vout->c_loops++;
 842         if( !(p_vout->c_loops % VOUT_STATS_NB_LOOPS) )
 843         {
 844             msg_Dbg( p_vout, "picture heap: %d/%d",
 845                      I_RENDERPICTURES, p_vout->i_heap_size );
 846         }
 847 #endif
 848
 849         /* Update statistics */
 850         p_input = vlc_object_find( p_vout, VLC_OBJECT_INPUT, FIND_PARENT );
 851         if( p_input )
 852         {
 853             vlc_mutex_lock( &p_input->p->counters.counters_lock );
 854             stats_UpdateInteger( p_vout, p_input->p->counters.p_lost_pictures,
 855                                  i_lost , NULL);
 856             stats_UpdateInteger( p_vout,
 857                                  p_input->p->counters.p_displayed_pictures,
 858                                  i_displayed , NULL);
 859             i_displayed = i_lost = 0;
 860             vlc_mutex_unlock( &p_input->p->counters.counters_lock );
 861             vlc_object_release( p_input );
 862         }
 863
 864         /*
 865          * Find the picture to display (the one with the earliest date).
 866          * This operation does not need lock, since only READY_PICTUREs
 867          * are handled. */
 868         for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
 869         {
 870             picture_t *p_pic = PP_RENDERPICTURE[i_index];
 871
 872             if( p_pic->i_status == READY_PICTURE &&
 873                 ( p_picture == NULL || p_pic->date < display_date ) )
 874             {
 875                 p_picture = p_pic;
 876                 display_date = p_picture->date;
 877             }
 878         }
 879
 880         if( p_picture )
 881         {
 882             /* If we met the last picture, parse again to see whether there is
 883              * a more appropriate one. */
 884             if( p_picture == p_last_picture )
 885             {
 886                 for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
 887                 {
 888                     picture_t *p_pic = PP_RENDERPICTURE[i_index];
 889
 890                     if( p_pic->i_status == READY_PICTURE &&
 891                         p_pic != p_last_picture &&
 892                         ( p_picture == p_last_picture || p_pic->date < display_date ) )
 893                     {
 894                         p_picture = p_pic;
 895                         display_date = p_picture->date;
 896                     }
 897                 }
 898             }
 899
 900             /* If we found better than the last picture, destroy it */
 901             if( p_last_picture && p_picture != p_last_picture )
 902             {
 903                 DropPicture( p_vout, p_last_picture );
 904                 p_last_picture = NULL;
 905             }
 906
 907             /* Compute FPS rate */
 908             p_vout->p->p_fps_sample[ p_vout->p->c_fps_samples++ % VOUT_FPS_SAMPLES ]
 909                 = display_date;
 910
 911             if( !p_picture->b_force &&
 912                 p_picture != p_last_picture &&
 913                 display_date < current_date + p_vout->p->render_time &&
 914                 b_drop_late )
 915             {
 916                 /* Picture is late: it will be destroyed and the thread
 917                  * will directly choose the next picture */
 918                 DropPicture( p_vout, p_picture );
 919                 i_lost++;
 920                 msg_Warn( p_vout, "late picture skipped (%"PRId64")",
 921                                   current_date - display_date );
 922                 continue;
 923             }
 924
 925             if( display_date >
 926                 current_date + p_vout->p->i_pts_delay + VOUT_BOGUS_DELAY )
 927             {
 928                 /* Picture is waaay too early: it will be destroyed */
 929                 DropPicture( p_vout, p_picture );
 930                 i_lost++;
 931                 msg_Warn( p_vout, "vout warning: early picture skipped "
 932                           "(%"PRId64")", display_date - current_date
 933                           - p_vout->p->i_pts_delay );
 934                 continue;
 935             }
 936
 937             if( display_date > current_date + VOUT_DISPLAY_DELAY )
 938             {
 939                 /* A picture is ready to be rendered, but its rendering date
 940                  * is far from the current one so the thread will perform an
 941                  * empty loop as if no picture were found. The picture state
 942                  * is unchanged */
 943                 p_picture    = NULL;
 944                 display_date = 0;
 945             }
 946             else if( p_picture == p_last_picture )
 947             {
 948                 /* We are asked to repeat the previous picture, but we first
 949                  * wait for a couple of idle loops */
 950                 if( i_idle_loops < 4 )
 951                 {
 952                     p_picture    = NULL;
 953                     display_date = 0;
 954                 }
 955                 else
 956                 {
 957                     /* We set the display date to something high, otherwise
 958                      * we'll have lots of problems with late pictures */
 959                     display_date = current_date + p_vout->p->render_time;
 960                 }
 961             }
 962         }
 963
 964         if( p_picture == NULL )
 965             i_idle_loops++;
 966
 967         p_filtered_picture = NULL;
 968         if( p_picture )
 969             p_filtered_picture = filter_chain_VideoFilter( p_vout->p->p_vf2_chain,
 970                                                            p_picture );
 971
 972         /* FIXME it is a bit ugly that b_snapshot is not locked but I do not
 973          * know which lock to use (here and in the snapshot callback) */
 974         const bool b_snapshot = p_vout->p->b_snapshot;
 975         if( b_snapshot )
 976             p_vout->p->b_snapshot = false;
 977
 978         /*
 979          * Check for subpictures to display
 980          */
 981         bool b_paused = false;
 982         if( display_date > 0 )
 983         {
 984             p_input = vlc_object_find( p_vout, VLC_OBJECT_INPUT, FIND_PARENT );
 985             b_paused = p_input && var_GetInteger( p_input, "state" ) == PAUSE_S;
 986             if( p_input )
 987                 vlc_object_release( p_input );
 988
 989             p_subpic = spu_SortSubpictures( p_vout->p_spu, display_date, b_paused, b_snapshot );
 990         }
 991
 992         /*
 993          * Perform rendering
 994          */
 995         i_displayed++;
 996         p_directbuffer = vout_RenderPicture( p_vout, p_filtered_picture, p_subpic, b_paused );
 997
 998         /*
 999          * Take a snapshot if requested
1000          */
1001         if( p_directbuffer && b_snapshot )
1002             vout_Snapshot( p_vout, p_directbuffer );
1003
1004         /*
1005          * Call the plugin-specific rendering method if there is one
1006          */
1007         if( p_filtered_picture != NULL && p_directbuffer != NULL && p_vout->pf_render )
1008         {
1009             /* Render the direct buffer returned by vout_RenderPicture */
1010             p_vout->pf_render( p_vout, p_directbuffer );
1011         }
1012
1013         /*
1014          * Sleep, wake up
1015          */
1016         if( display_date != 0 && p_directbuffer != NULL )
1017         {
1018             mtime_t current_render_time = mdate() - current_date;
1019             /* if render time is very large we don't include it in the mean */
1020             if( current_render_time < p_vout->p->render_time +
1021                 VOUT_DISPLAY_DELAY )
1022             {
1023                 /* Store render time using a sliding mean weighting to
1024                  * current value in a 3 to 1 ratio*/
1025                 p_vout->p->render_time *= 3;
1026                 p_vout->p->render_time += current_render_time;
1027                 p_vout->p->render_time >>= 2;
1028             }
1029         }
1030
1031         /* Give back change lock */
1032         vlc_mutex_unlock( &p_vout->change_lock );
1033
1034         vlc_object_unlock( p_vout );
1035
1036         /* Sleep a while or until a given date */
1037         if( display_date != 0 )
1038         {
1039             /* If there are filters in the chain, better give them the picture
1040              * in advance */
1041             if( !p_vout->p->psz_filter_chain || !*p_vout->p->psz_filter_chain )
1042             {
1043                 mwait( display_date - VOUT_MWAIT_TOLERANCE );
1044             }
1045         }
1046         else
1047         {
1048             msleep( VOUT_IDLE_SLEEP );
1049         }
1050
1051         /* On awakening, take back lock and send immediately picture
1052          * to display. */
1053         vlc_object_lock( p_vout );
1054         /* Note: vlc_object_alive() could be false here, and we
1055          * could be dead */
1056         vlc_mutex_lock( &p_vout->change_lock );
1057
1058         /*
1059          * Display the previously rendered picture
1060          */
1061         if( p_filtered_picture != NULL && p_directbuffer != NULL )
1062         {
1063             /* Display the direct buffer returned by vout_RenderPicture */
1064             if( p_vout->pf_display )
1065                 p_vout->pf_display( p_vout, p_directbuffer );
1066
1067             /* Tell the vout this was the last picture and that it does not
1068              * need to be forced anymore. */
1069             p_last_picture = p_picture;
1070             p_last_picture->b_force = false;
1071         }
1072
1073         /* Drop the filtered picture if created by video filters */
1074         if( p_filtered_picture != NULL && p_filtered_picture != p_picture )
1075             DropPicture( p_vout, p_filtered_picture );
1076
1077         if( p_picture != NULL )
1078         {
1079             /* Reinitialize idle loop count */
1080             i_idle_loops = 0;
1081         }
1082
1083         /*
1084          * Check events and manage thread
1085          */
1086         if( p_vout->pf_manage && p_vout->pf_manage( p_vout ) )
1087         {
1088             /* A fatal error occurred, and the thread must terminate
1089              * immediately, without displaying anything - setting b_error to 1
1090              * causes the immediate end of the main while() loop. */
1091             // FIXME pf_end
1092             p_vout->b_error = 1;
1093             break;
1094         }
1095
1096         if( p_vout->i_changes & VOUT_SIZE_CHANGE )
1097         {
1098             /* this must only happen when the vout plugin is incapable of
1099              * rescaling the picture itself. In this case we need to destroy
1100              * the current picture buffers and recreate new ones with the right
1101              * dimensions */
1102             int i;
1103
1104             p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
1105
1106             assert( !p_vout->p->b_direct );
1107
1108             ChromaDestroy( p_vout );
1109
1110             vlc_mutex_lock( &p_vout->picture_lock );
1111
1112             p_vout->pf_end( p_vout );
1113
1114             for( i = 0; i < I_OUTPUTPICTURES; i++ )
1115                  p_vout->p_picture[ i ].i_status = FREE_PICTURE;
1116
1117             I_OUTPUTPICTURES = 0;
1118
1119             if( p_vout->pf_init( p_vout ) )
1120             {
1121                 msg_Err( p_vout, "cannot resize display" );
1122                 /* FIXME: pf_end will be called again in EndThread() */
1123                 p_vout->b_error = 1;
1124             }
1125
1126             vlc_mutex_unlock( &p_vout->picture_lock );
1127
1128             /* Need to reinitialise the chroma plugin. Since we might need
1129              * resizing too and it's not sure that we already had it,
1130              * recreate the chroma plugin chain from scratch. */
1131             /* dionoea */
1132             if( ChromaCreate( p_vout ) )
1133             {
1134                 msg_Err( p_vout, "WOW THIS SUCKS BIG TIME!!!!!" );
1135                 p_vout->b_error = 1;
1136             }
1137             if( p_vout->b_error )
1138                 break;
1139         }
1140
1141         if( p_vout->i_changes & VOUT_PICTURE_BUFFERS_CHANGE )
1142         {
1143             /* This happens when the picture buffers need to be recreated.
1144              * This is useful on multimonitor displays for instance.
1145              *
1146              * Warning: This only works when the vout creates only 1 picture
1147              * buffer!! */
1148             p_vout->i_changes &= ~VOUT_PICTURE_BUFFERS_CHANGE;
1149
1150             if( !p_vout->p->b_direct )
1151                 ChromaDestroy( p_vout );
1152
1153             vlc_mutex_lock( &p_vout->picture_lock );
1154
1155             p_vout->pf_end( p_vout );
1156
1157             I_OUTPUTPICTURES = I_RENDERPICTURES = 0;
1158
1159             p_vout->b_error = InitThread( p_vout );
1160             if( p_vout->b_error )
1161                 msg_Err( p_vout, "InitThread after VOUT_PICTURE_BUFFERS_CHANGE failed\n" );
1162
1163             vlc_mutex_unlock( &p_vout->picture_lock );
1164
1165             if( p_vout->b_error )
1166                 break;
1167         }
1168
1169         /* Check for "video filter2" changes */
1170         vlc_mutex_lock( &p_vout->p->vfilter_lock );
1171         if( p_vout->p->psz_vf2 )
1172         {
1173             es_format_t fmt;
1174
1175             es_format_Init( &fmt, VIDEO_ES, p_vout->fmt_render.i_chroma );
1176             fmt.video = p_vout->fmt_render;
1177             filter_chain_Reset( p_vout->p->p_vf2_chain, &fmt, &fmt );
1178
1179             if( filter_chain_AppendFromString( p_vout->p->p_vf2_chain,
1180                                                p_vout->p->psz_vf2 ) < 0 )
1181                 msg_Err( p_vout, "Video filter chain creation failed" );
1182
1183             free( p_vout->p->psz_vf2 );
1184             p_vout->p->psz_vf2 = NULL;
1185         }
1186         vlc_mutex_unlock( &p_vout->p->vfilter_lock );
1187     }
1188
1189     /*
1190      * Error loop - wait until the thread destruction is requested
1191      */
1192     if( p_vout->b_error )
1193         ErrorThread( p_vout );
1194
1195     /* End of thread */
1196     CleanThread( p_vout );
1197     EndThread( p_vout );
1198     vlc_mutex_unlock( &p_vout->change_lock );
1199
1200     vlc_object_unlock( p_vout );
1201     vlc_restorecancel (canc);
1202     return NULL;
1203 }
1204
1205 /*****************************************************************************
1206  * ErrorThread: RunThread() error loop
1207  *****************************************************************************
1208  * This function is called when an error occurred during thread main's loop.
1209  * The thread can still receive feed, but must be ready to terminate as soon
1210  * as possible.
1211  *****************************************************************************/
1212 static void ErrorThread( vout_thread_t *p_vout )
1213 {
1214     /* Wait until a `die' order */
1215     while( vlc_object_alive( p_vout ) )
1216         vlc_object_wait( p_vout );
1217 }
1218
1219 /*****************************************************************************
1220  * CleanThread: clean up after InitThread
1221  *****************************************************************************
1222  * This function is called after a sucessful
1223  * initialization. It frees all resources allocated by InitThread.
1224  * XXX You have to enter it with change_lock taken.
1225  *****************************************************************************/
1226 static void CleanThread( vout_thread_t *p_vout )
1227 {
1228     int     i_index;                                        /* index in heap */
1229
1230     if( !p_vout->p->b_direct )
1231         ChromaDestroy( p_vout );
1232
1233     /* Destroy all remaining pictures */
1234     for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++ )
1235     {
1236         if ( p_vout->p_picture[i_index].i_type == MEMORY_PICTURE )
1237         {
1238             free( p_vout->p_picture[i_index].p_data_orig );
1239         }
1240     }
1241
1242     /* Destroy translation tables */
1243     if( !p_vout->b_error )
1244         p_vout->pf_end( p_vout );
1245 }
1246
1247 /*****************************************************************************
1248  * EndThread: thread destruction
1249  *****************************************************************************
1250  * This function is called when the thread ends.
1251  * It frees all resources not allocated by InitThread.
1252  * XXX You have to enter it with change_lock taken.
1253  *****************************************************************************/
1254 static void EndThread( vout_thread_t *p_vout )
1255 {
1256 #ifdef STATS
1257     {
1258         struct tms cpu_usage;
1259         times( &cpu_usage );
1260
1261         msg_Dbg( p_vout, "cpu usage (user: %d, system: %d)",
1262                  cpu_usage.tms_utime, cpu_usage.tms_stime );
1263     }
1264 #endif
1265
1266     /* FIXME does that function *really* need to be called inside the thread ? */
1267
1268     /* Destroy subpicture unit */
1269     spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), false );
1270     spu_Destroy( p_vout->p_spu );
1271
1272     /* Destroy the video filters2 */
1273     filter_chain_Delete( p_vout->p->p_vf2_chain );
1274 }
1275
1276 /* Thread helpers */
1277 static picture_t *ChromaGetPicture( filter_t *p_filter )
1278 {
1279     picture_t *p_pic = (picture_t *)p_filter->p_owner;
1280     p_filter->p_owner = NULL;
1281     return p_pic;
1282 }
1283
1284 static int ChromaCreate( vout_thread_t *p_vout )
1285 {
1286     static const char typename[] = "chroma";
1287     filter_t *p_chroma;
1288
1289     /* Choose the best module */
1290     p_chroma = p_vout->p->p_chroma =
1291         vlc_custom_create( p_vout, sizeof(filter_t), VLC_OBJECT_GENERIC,
1292                            typename );
1293
1294     vlc_object_attach( p_chroma, p_vout );
1295
1296     /* TODO: Set the fmt_in and fmt_out stuff here */
1297     p_chroma->fmt_in.video = p_vout->fmt_render;
1298     p_chroma->fmt_out.video = p_vout->fmt_out;
1299     VideoFormatImportRgb( &p_chroma->fmt_in.video, &p_vout->render );
1300     VideoFormatImportRgb( &p_chroma->fmt_out.video, &p_vout->output );
1301
1302     p_chroma->p_module = module_need( p_chroma, "video filter2", NULL, 0 );
1303
1304     if( p_chroma->p_module == NULL )
1305     {
1306         msg_Err( p_vout, "no chroma module for %4.4s to %4.4s i=%dx%d o=%dx%d",
1307                  (char*)&p_vout->render.i_chroma,
1308                  (char*)&p_vout->output.i_chroma,
1309                  p_chroma->fmt_in.video.i_width, p_chroma->fmt_in.video.i_height,
1310                  p_chroma->fmt_out.video.i_width, p_chroma->fmt_out.video.i_height
1311                  );
1312
1313         vlc_object_release( p_vout->p->p_chroma );
1314         p_vout->p->p_chroma = NULL;
1315
1316         return VLC_EGENERIC;
1317     }
1318     p_chroma->pf_vout_buffer_new = ChromaGetPicture;
1319     return VLC_SUCCESS;
1320 }
1321
1322 static void ChromaDestroy( vout_thread_t *p_vout )
1323 {
1324     assert( !p_vout->p->b_direct );
1325
1326     if( !p_vout->p->p_chroma )
1327         return;
1328
1329     module_unneed( p_vout->p->p_chroma, p_vout->p->p_chroma->p_module );
1330     vlc_object_release( p_vout->p->p_chroma );
1331     p_vout->p->p_chroma = NULL;
1332 }
1333
1334 static void DropPicture( vout_thread_t *p_vout, picture_t *p_picture )
1335 {
1336     vlc_mutex_lock( &p_vout->picture_lock );
1337     if( p_picture->i_refcount )
1338     {
1339         /* Pretend we displayed the picture, but don't destroy
1340          * it since the decoder might still need it. */
1341         p_picture->i_status = DISPLAYED_PICTURE;
1342     }
1343     else
1344     {
1345         /* Destroy the picture without displaying it */
1346         p_picture->i_status = DESTROYED_PICTURE;
1347         p_vout->i_heap_size--;
1348         picture_CleanupQuant( p_picture );
1349     }
1350     vlc_mutex_unlock( &p_vout->picture_lock );
1351 }
1352
1353
1354
1355 /* following functions are local */
1356
1357 static int ReduceHeight( int i_ratio )
1358 {
1359     int i_dummy = VOUT_ASPECT_FACTOR;
1360     int i_pgcd  = 1;
1361
1362     if( !i_ratio )
1363     {
1364         return i_pgcd;
1365     }
1366
1367     /* VOUT_ASPECT_FACTOR is (2^7 * 3^3 * 5^3), we just check for 2, 3 and 5 */
1368     while( !(i_ratio & 1) && !(i_dummy & 1) )
1369     {
1370         i_ratio >>= 1;
1371         i_dummy >>= 1;
1372         i_pgcd  <<= 1;
1373     }
1374
1375     while( !(i_ratio % 3) && !(i_dummy % 3) )
1376     {
1377         i_ratio /= 3;
1378         i_dummy /= 3;
1379         i_pgcd  *= 3;
1380     }
1381
1382     while( !(i_ratio % 5) && !(i_dummy % 5) )
1383     {
1384         i_ratio /= 5;
1385         i_dummy /= 5;
1386         i_pgcd  *= 5;
1387     }
1388
1389     return i_pgcd;
1390 }
1391
1392 static void AspectRatio( int i_aspect, int *i_aspect_x, int *i_aspect_y )
1393 {
1394     unsigned int i_pgcd = ReduceHeight( i_aspect );
1395     *i_aspect_x = i_aspect / i_pgcd;
1396     *i_aspect_y = VOUT_ASPECT_FACTOR / i_pgcd;
1397 }
1398
1399 /**
1400  * This function copies all RGB informations from a picture_heap_t into
1401  * a video_format_t
1402  */
1403 static void VideoFormatImportRgb( video_format_t *p_fmt, const picture_heap_t *p_heap )
1404 {
1405     p_fmt->i_rmask = p_heap->i_rmask;
1406     p_fmt->i_gmask = p_heap->i_gmask;
1407     p_fmt->i_bmask = p_heap->i_bmask;
1408     p_fmt->i_rrshift = p_heap->i_rrshift;
1409     p_fmt->i_lrshift = p_heap->i_lrshift;
1410     p_fmt->i_rgshift = p_heap->i_rgshift;
1411     p_fmt->i_lgshift = p_heap->i_lgshift;
1412     p_fmt->i_rbshift = p_heap->i_rbshift;
1413     p_fmt->i_lbshift = p_heap->i_lbshift;
1414 }
1415
1416 /**
1417  * This funtion copes all RGB informations from a video_format_t into
1418  * a picture_heap_t
1419  */
1420 static void VideoFormatExportRgb( const video_format_t *p_fmt, picture_heap_t *p_heap )
1421 {
1422     p_heap->i_rmask = p_fmt->i_rmask;
1423     p_heap->i_gmask = p_fmt->i_gmask;
1424     p_heap->i_bmask = p_fmt->i_bmask;
1425     p_heap->i_rrshift = p_fmt->i_rrshift;
1426     p_heap->i_lrshift = p_fmt->i_lrshift;
1427     p_heap->i_rgshift = p_fmt->i_rgshift;
1428     p_heap->i_lgshift = p_fmt->i_lgshift;
1429     p_heap->i_rbshift = p_fmt->i_rbshift;
1430     p_heap->i_lbshift = p_fmt->i_lbshift;
1431 }
1432
1433 /**
1434  * This function computes rgb shifts from masks
1435  */
1436 static void PictureHeapFixRgb( picture_heap_t *p_heap )
1437 {
1438     video_format_t fmt;
1439
1440     /* */
1441     fmt.i_chroma = p_heap->i_chroma;
1442     VideoFormatImportRgb( &fmt, p_heap );
1443
1444     /* */
1445     video_format_FixRgb( &fmt );
1446
1447     VideoFormatExportRgb( &fmt, p_heap );
1448 }
1449
1450 /*****************************************************************************
1451  * object variables callbacks: a bunch of object variables are used by the
1452  * interfaces to interact with the vout.
1453  *****************************************************************************/
1454 static int DeinterlaceCallback( vlc_object_t *p_this, char const *psz_cmd,
1455                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
1456 {
1457     vout_thread_t *p_vout = (vout_thread_t *)p_this;
1458     input_thread_t *p_input;
1459     vlc_value_t val;
1460
1461     char *psz_mode = newval.psz_string;
1462     char *psz_filter, *psz_deinterlace = NULL;
1463     (void)psz_cmd; (void)oldval; (void)p_data;
1464
1465     var_Get( p_vout, "vout-filter", &val );
1466     psz_filter = val.psz_string;
1467     if( psz_filter ) psz_deinterlace = strstr( psz_filter, "deinterlace" );
1468
1469     if( !psz_mode || !*psz_mode )
1470     {
1471         if( psz_deinterlace )
1472         {
1473             char *psz_src = psz_deinterlace + sizeof("deinterlace") - 1;
1474             if( psz_src[0] == ':' ) psz_src++;
1475             memmove( psz_deinterlace, psz_src, strlen(psz_src) + 1 );
1476         }
1477     }
1478     else if( !psz_deinterlace )
1479     {
1480         psz_filter = realloc( psz_filter, strlen( psz_filter ) +
1481                               sizeof(":deinterlace") );
1482         if( psz_filter && *psz_filter ) strcat( psz_filter, ":" );
1483         strcat( psz_filter, "deinterlace" );
1484     }
1485
1486     p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1487                                                  FIND_PARENT );
1488     if( !p_input ) return VLC_EGENERIC;
1489
1490     if( psz_mode && *psz_mode )
1491     {
1492         /* Modify input as well because the vout might have to be restarted */
1493         val.psz_string = psz_mode;
1494         var_Create( p_input, "deinterlace-mode", VLC_VAR_STRING );
1495         var_Set( p_input, "deinterlace-mode", val );
1496     }
1497     vlc_object_release( p_input );
1498
1499     val.b_bool = true;
1500     var_Set( p_vout, "intf-change", val );
1501
1502     val.psz_string = psz_filter;
1503     var_Set( p_vout, "vout-filter", val );
1504     free( psz_filter );
1505
1506     return VLC_SUCCESS;
1507 }
1508
1509 static int FilterCallback( vlc_object_t *p_this, char const *psz_cmd,
1510                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
1511 {
1512     vout_thread_t *p_vout = (vout_thread_t *)p_this;
1513     input_thread_t *p_input;
1514     vlc_value_t val;
1515     (void)psz_cmd; (void)oldval; (void)p_data;
1516
1517     p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1518                                                  FIND_PARENT );
1519     if (!p_input)
1520     {
1521         msg_Err( p_vout, "Input not found" );
1522         return( VLC_EGENERIC );
1523     }
1524
1525     val.b_bool = true;
1526     var_Set( p_vout, "intf-change", val );
1527
1528     /* Modify input as well because the vout might have to be restarted */
1529     val.psz_string = newval.psz_string;
1530     var_Create( p_input, "vout-filter", VLC_VAR_STRING );
1531
1532     var_Set( p_input, "vout-filter", val );
1533
1534     /* Now restart current video stream */
1535     input_Control( p_input, INPUT_RESTART_ES, -VIDEO_ES );
1536     vlc_object_release( p_input );
1537
1538     return VLC_SUCCESS;
1539 }
1540
1541 /*****************************************************************************
1542  * Video Filter2 stuff
1543  *****************************************************************************/
1544 static int VideoFilter2Callback( vlc_object_t *p_this, char const *psz_cmd,
1545                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
1546 {
1547     vout_thread_t *p_vout = (vout_thread_t *)p_this;
1548     (void)psz_cmd; (void)oldval; (void)p_data;
1549
1550     vlc_mutex_lock( &p_vout->p->vfilter_lock );
1551     p_vout->p->psz_vf2 = strdup( newval.psz_string );
1552     vlc_mutex_unlock( &p_vout->p->vfilter_lock );
1553
1554     return VLC_SUCCESS;
1555 }
1556
1557 static void DisplayTitleOnOSD( vout_thread_t *p_vout )
1558 {
1559     input_thread_t *p_input;
1560     mtime_t i_now, i_stop;
1561
1562     if( !config_GetInt( p_vout, "osd" ) ) return;
1563
1564     p_input = (input_thread_t *)vlc_object_find( p_vout,
1565               VLC_OBJECT_INPUT, FIND_ANYWHERE );
1566     if( p_input )
1567     {
1568         i_now = mdate();
1569         i_stop = i_now + (mtime_t)(p_vout->p->i_title_timeout * 1000);
1570         char *psz_nowplaying =
1571             input_item_GetNowPlaying( input_GetItem( p_input ) );
1572         char *psz_artist = input_item_GetArtist( input_GetItem( p_input ) );
1573         char *psz_name = input_item_GetTitle( input_GetItem( p_input ) );
1574         if( EMPTY_STR( psz_name ) )
1575         {
1576             free( psz_name );
1577             psz_name = input_item_GetName( input_GetItem( p_input ) );
1578         }
1579         if( !EMPTY_STR( psz_nowplaying ) )
1580         {
1581             vout_ShowTextAbsolute( p_vout, DEFAULT_CHAN,
1582                                    psz_nowplaying, NULL,
1583                                    p_vout->p->i_title_position,
1584                                    30 + p_vout->fmt_in.i_width
1585                                       - p_vout->fmt_in.i_visible_width
1586                                       - p_vout->fmt_in.i_x_offset,
1587                                    20 + p_vout->fmt_in.i_y_offset,
1588                                    i_now, i_stop );
1589         }
1590         else if( !EMPTY_STR( psz_artist ) )
1591         {
1592             char *psz_string = NULL;
1593             if( asprintf( &psz_string, "%s - %s", psz_name, psz_artist ) != -1 )
1594             {
1595                 vout_ShowTextAbsolute( p_vout, DEFAULT_CHAN,
1596                                        psz_string, NULL,
1597                                        p_vout->p->i_title_position,
1598                                        30 + p_vout->fmt_in.i_width
1599                                           - p_vout->fmt_in.i_visible_width
1600                                           - p_vout->fmt_in.i_x_offset,
1601                                        20 + p_vout->fmt_in.i_y_offset,
1602                                        i_now, i_stop );
1603                 free( psz_string );
1604             }
1605         }
1606         else
1607         {
1608             vout_ShowTextAbsolute( p_vout, DEFAULT_CHAN,
1609                                    psz_name, NULL,
1610                                    p_vout->p->i_title_position,
1611                                    30 + p_vout->fmt_in.i_width
1612                                       - p_vout->fmt_in.i_visible_width
1613                                       - p_vout->fmt_in.i_x_offset,
1614                                    20 + p_vout->fmt_in.i_y_offset,
1615                                    i_now, i_stop );
1616         }
1617         vlc_object_release( p_input );
1618         free( psz_artist );
1619         free( psz_name );
1620         free( psz_nowplaying );
1621     }
1622 }
1623