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->p->b_paused = false;
 369     p_vout->p->i_pause_date = 0;
 370     p_vout->pf_control = NULL;
 371     p_vout->p_window = NULL;
 372     p_vout->p->i_par_num =
 373     p_vout->p->i_par_den = 1;
 374
 375     /* Initialize locks */
 376     vlc_mutex_init( &p_vout->picture_lock );
 377     vlc_mutex_init( &p_vout->change_lock );
 378     vlc_mutex_init( &p_vout->p->vfilter_lock );
 379
 380     /* Mouse coordinates */
 381     var_Create( p_vout, "mouse-x", VLC_VAR_INTEGER );
 382     var_Create( p_vout, "mouse-y", VLC_VAR_INTEGER );
 383     var_Create( p_vout, "mouse-button-down", VLC_VAR_INTEGER );
 384     var_Create( p_vout, "mouse-moved", VLC_VAR_BOOL );
 385     var_Create( p_vout, "mouse-clicked", VLC_VAR_INTEGER );
 386
 387     /* Initialize subpicture unit */
 388     p_vout->p_spu = spu_Create( p_vout );
 389     spu_Attach( p_vout->p_spu, p_parent, true );
 390
 391     /* Attach the new object now so we can use var inheritance below */
 392     vlc_object_attach( p_vout, p_parent );
 393
 394     spu_Init( p_vout->p_spu );
 395
 396     /* Take care of some "interface/control" related initialisations */
 397     vout_IntfInit( p_vout );
 398
 399     /* If the parent is not a VOUT object, that means we are at the start of
 400      * the video output pipe */
 401     if( p_parent->i_object_type != VLC_OBJECT_VOUT )
 402     {
 403         /* Look for the default filter configuration */
 404         p_vout->p->psz_filter_chain =
 405             var_CreateGetStringCommand( p_vout, "vout-filter" );
 406
 407         /* Apply video filter2 objects on the first vout */
 408         p_vout->p->psz_vf2 =
 409             var_CreateGetStringCommand( p_vout, "video-filter" );
 410     }
 411     else
 412     {
 413         /* continue the parent's filter chain */
 414         char *psz_tmp;
 415
 416         /* Ugly hack to jump to our configuration chain */
 417         p_vout->p->psz_filter_chain
 418             = ((vout_thread_t *)p_parent)->p->psz_filter_chain;
 419         p_vout->p->psz_filter_chain
 420             = config_ChainCreate( &psz_tmp, &p_cfg, p_vout->p->psz_filter_chain );
 421         config_ChainDestroy( p_cfg );
 422         free( psz_tmp );
 423
 424         /* Create a video filter2 var ... but don't inherit values */
 425         var_Create( p_vout, "video-filter",
 426                     VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
 427         p_vout->p->psz_vf2 = var_GetString( p_vout, "video-filter" );
 428     }
 429
 430     var_AddCallback( p_vout, "video-filter", VideoFilter2Callback, NULL );
 431     p_vout->p->p_vf2_chain = filter_chain_New( p_vout, "video filter2",
 432         false, video_filter_buffer_allocation_init, NULL, p_vout );
 433
 434     /* Choose the video output module */
 435     if( !p_vout->p->psz_filter_chain || !*p_vout->p->psz_filter_chain )
 436     {
 437         var_Create( p_vout, "vout", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 438         var_Get( p_vout, "vout", &val );
 439         psz_parser = val.psz_string;
 440     }
 441     else
 442     {
 443         psz_parser = strdup( p_vout->p->psz_filter_chain );
 444         p_vout->p->b_title_show = false;
 445     }
 446
 447     /* Create the vout thread */
 448     char* psz_tmp = config_ChainCreate( &psz_name, &p_cfg, psz_parser );
 449     free( psz_parser );
 450     free( psz_tmp );
 451     p_vout->p_cfg = p_cfg;
 452     p_vout->p_module = module_need( p_vout,
 453         ( p_vout->p->psz_filter_chain && *p_vout->p->psz_filter_chain ) ?
 454         "video filter" : "video output", psz_name, p_vout->p->psz_filter_chain && *p_vout->p->psz_filter_chain );
 455     free( psz_name );
 456
 457     if( p_vout->p_module == NULL )
 458     {
 459         msg_Err( p_vout, "no suitable vout module" );
 460         // FIXME it's ugly but that's exactly the function that need to be called.
 461         EndThread( p_vout );
 462         vlc_object_detach( p_vout );
 463         vlc_object_release( p_vout );
 464         return NULL;
 465     }
 466
 467     /* Create a few object variables for interface interaction */
 468     var_Create( p_vout, "deinterlace", VLC_VAR_STRING | VLC_VAR_HASCHOICE );
 469     text.psz_string = _("Deinterlace");
 470     var_Change( p_vout, "deinterlace", VLC_VAR_SETTEXT, &text, NULL );
 471     val.psz_string = (char *)""; text.psz_string = _("Disable");
 472     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 473     val.psz_string = (char *)"discard"; text.psz_string = _("Discard");
 474     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 475     val.psz_string = (char *)"blend"; text.psz_string = _("Blend");
 476     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 477     val.psz_string = (char *)"mean"; text.psz_string = _("Mean");
 478     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 479     val.psz_string = (char *)"bob"; text.psz_string = _("Bob");
 480     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 481     val.psz_string = (char *)"linear"; text.psz_string = _("Linear");
 482     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 483     val.psz_string = (char *)"x"; text.psz_string = (char *)"X";
 484     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 485
 486     if( var_Get( p_vout, "deinterlace-mode", &val ) == VLC_SUCCESS )
 487     {
 488         var_Set( p_vout, "deinterlace", val );
 489         free( val.psz_string );
 490     }
 491     var_AddCallback( p_vout, "deinterlace", DeinterlaceCallback, NULL );
 492
 493     var_Create( p_vout, "vout-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 494     text.psz_string = _("Filters");
 495     var_Change( p_vout, "vout-filter", VLC_VAR_SETTEXT, &text, NULL );
 496     var_AddCallback( p_vout, "vout-filter", FilterCallback, NULL );
 497
 498     /* Calculate delay created by internal caching */
 499     p_input_thread = (input_thread_t *)vlc_object_find( p_vout,
 500                                            VLC_OBJECT_INPUT, FIND_ANYWHERE );
 501     if( p_input_thread )
 502     {
 503         p_vout->p->i_pts_delay = p_input_thread->i_pts_delay;
 504         vlc_object_release( p_input_thread );
 505     }
 506     else
 507     {
 508         p_vout->p->i_pts_delay = DEFAULT_PTS_DELAY;
 509     }
 510
 511     if( vlc_thread_create( p_vout, "video output", RunThread,
 512                            VLC_THREAD_PRIORITY_OUTPUT, true ) )
 513     {
 514         module_unneed( p_vout, p_vout->p_module );
 515         vlc_object_release( p_vout );
 516         return NULL;
 517     }
 518
 519     vlc_object_set_destructor( p_vout, vout_Destructor );
 520
 521     if( p_vout->b_error )
 522     {
 523         msg_Err( p_vout, "video output creation failed" );
 524         vout_CloseAndRelease( p_vout );
 525         return NULL;
 526     }
 527
 528     return p_vout;
 529 }
 530
 531 /*****************************************************************************
 532  * vout_Close: Close a vout created by vout_Create.
 533  *****************************************************************************
 534  * You HAVE to call it on vout created by vout_Create before vlc_object_release.
 535  * You should NEVER call it on vout not obtained through vout_Create
 536  * (like with vout_Request or vlc_object_find.)
 537  * You can use vout_CloseAndRelease() as a convenient method.
 538  *****************************************************************************/
 539 void vout_Close( vout_thread_t *p_vout )
 540 {
 541     assert( p_vout );
 542
 543     vlc_object_kill( p_vout );
 544     vlc_thread_join( p_vout );
 545     module_unneed( p_vout, p_vout->p_module );
 546     p_vout->p_module = NULL;
 547 }
 548
 549 /* */
 550 static void vout_Destructor( vlc_object_t * p_this )
 551 {
 552     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 553
 554     /* Make sure the vout was stopped first */
 555     assert( !p_vout->p_module );
 556
 557     /* Destroy the locks */
 558     vlc_mutex_destroy( &p_vout->picture_lock );
 559     vlc_mutex_destroy( &p_vout->change_lock );
 560     vlc_mutex_destroy( &p_vout->p->vfilter_lock );
 561
 562     free( p_vout->p->psz_filter_chain );
 563
 564     config_ChainDestroy( p_vout->p_cfg );
 565
 566     free( p_vout->p );
 567
 568 #ifndef __APPLE__
 569     vout_thread_t *p_another_vout;
 570
 571     /* This is a dirty hack mostly for Linux, where there is no way to get the
 572      * GUI back if you closed it while playing video. This is solved in
 573      * Mac OS X, where we have this novelty called menubar, that will always
 574      * allow you access to the applications main functionality. They should try
 575      * that on linux sometime. */
 576     p_another_vout = vlc_object_find( p_this->p_libvlc,
 577                                       VLC_OBJECT_VOUT, FIND_ANYWHERE );
 578     if( p_another_vout == NULL )
 579         var_SetBool( p_this->p_libvlc, "intf-show", true );
 580     else
 581         vlc_object_release( p_another_vout );
 582 #endif
 583 }
 584
 585 /* */
 586 void vout_ChangePause( vout_thread_t *p_vout, bool b_paused, mtime_t i_date )
 587 {
 588     vlc_object_lock( p_vout );
 589
 590     assert( (!p_vout->p->b_paused) != (!b_paused) );
 591     if( p_vout->p->b_paused )
 592     {
 593         const mtime_t i_duration = i_date - p_vout->p->i_pause_date;
 594
 595         for( int i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
 596         {
 597             picture_t *p_pic = PP_RENDERPICTURE[i_index];
 598
 599             if( p_pic->i_status == READY_PICTURE )
 600                 p_pic->date += i_duration;
 601         }
 602         // TODO spu
 603     }
 604     p_vout->p->b_paused = b_paused;
 605     p_vout->p->i_pause_date = i_date;
 606
 607     vlc_object_unlock( p_vout );
 608 }
 609
 610 /*****************************************************************************
 611  * InitThread: initialize video output thread
 612  *****************************************************************************
 613  * This function is called from RunThread and performs the second step of the
 614  * initialization. It returns 0 on success. Note that the thread's flag are not
 615  * modified inside this function.
 616  * XXX You have to enter it with change_lock taken.
 617  *****************************************************************************/
 618 static int ChromaCreate( vout_thread_t *p_vout );
 619 static void ChromaDestroy( vout_thread_t *p_vout );
 620
 621 static bool ChromaIsEqual( const picture_heap_t *p_output, const picture_heap_t *p_render )
 622 {
 623      if( !vout_ChromaCmp( p_output->i_chroma, p_render->i_chroma ) )
 624          return false;
 625
 626      if( p_output->i_chroma != FOURCC_RV15 &&
 627          p_output->i_chroma != FOURCC_RV16 &&
 628          p_output->i_chroma != FOURCC_RV24 &&
 629          p_output->i_chroma != FOURCC_RV32 )
 630          return true;
 631
 632      return p_output->i_rmask == p_render->i_rmask &&
 633             p_output->i_gmask == p_render->i_gmask &&
 634             p_output->i_bmask == p_render->i_bmask;
 635 }
 636
 637 static int InitThread( vout_thread_t *p_vout )
 638 {
 639     int i, i_aspect_x, i_aspect_y;
 640
 641 #ifdef STATS
 642     p_vout->c_loops = 0;
 643 #endif
 644
 645     /* Initialize output method, it allocates direct buffers for us */
 646     if( p_vout->pf_init( p_vout ) )
 647         return VLC_EGENERIC;
 648
 649     if( !I_OUTPUTPICTURES )
 650     {
 651         msg_Err( p_vout, "plugin was unable to allocate at least "
 652                          "one direct buffer" );
 653         p_vout->pf_end( p_vout );
 654         return VLC_EGENERIC;
 655     }
 656
 657     if( I_OUTPUTPICTURES > VOUT_MAX_PICTURES )
 658     {
 659         msg_Err( p_vout, "plugin allocated too many direct buffers, "
 660                          "our internal buffers must have overflown." );
 661         p_vout->pf_end( p_vout );
 662         return VLC_EGENERIC;
 663     }
 664
 665     msg_Dbg( p_vout, "got %i direct buffer(s)", I_OUTPUTPICTURES );
 666
 667     AspectRatio( p_vout->fmt_render.i_aspect, &i_aspect_x, &i_aspect_y );
 668
 669     msg_Dbg( p_vout, "picture in %ix%i (%i,%i,%ix%i), "
 670              "chroma %4.4s, ar %i:%i, sar %i:%i",
 671              p_vout->fmt_render.i_width, p_vout->fmt_render.i_height,
 672              p_vout->fmt_render.i_x_offset, p_vout->fmt_render.i_y_offset,
 673              p_vout->fmt_render.i_visible_width,
 674              p_vout->fmt_render.i_visible_height,
 675              (char*)&p_vout->fmt_render.i_chroma,
 676              i_aspect_x, i_aspect_y,
 677              p_vout->fmt_render.i_sar_num, p_vout->fmt_render.i_sar_den );
 678
 679     AspectRatio( p_vout->fmt_in.i_aspect, &i_aspect_x, &i_aspect_y );
 680
 681     msg_Dbg( p_vout, "picture user %ix%i (%i,%i,%ix%i), "
 682              "chroma %4.4s, ar %i:%i, sar %i:%i",
 683              p_vout->fmt_in.i_width, p_vout->fmt_in.i_height,
 684              p_vout->fmt_in.i_x_offset, p_vout->fmt_in.i_y_offset,
 685              p_vout->fmt_in.i_visible_width,
 686              p_vout->fmt_in.i_visible_height,
 687              (char*)&p_vout->fmt_in.i_chroma,
 688              i_aspect_x, i_aspect_y,
 689              p_vout->fmt_in.i_sar_num, p_vout->fmt_in.i_sar_den );
 690
 691     if( !p_vout->fmt_out.i_width || !p_vout->fmt_out.i_height )
 692     {
 693         p_vout->fmt_out.i_width = p_vout->fmt_out.i_visible_width =
 694             p_vout->output.i_width;
 695         p_vout->fmt_out.i_height = p_vout->fmt_out.i_visible_height =
 696             p_vout->output.i_height;
 697         p_vout->fmt_out.i_x_offset =  p_vout->fmt_out.i_y_offset = 0;
 698
 699         p_vout->fmt_out.i_aspect = p_vout->output.i_aspect;
 700         p_vout->fmt_out.i_chroma = p_vout->output.i_chroma;
 701     }
 702     if( !p_vout->fmt_out.i_sar_num || !p_vout->fmt_out.i_sar_num )
 703     {
 704         p_vout->fmt_out.i_sar_num = p_vout->fmt_out.i_aspect *
 705             p_vout->fmt_out.i_height;
 706         p_vout->fmt_out.i_sar_den = VOUT_ASPECT_FACTOR *
 707             p_vout->fmt_out.i_width;
 708     }
 709
 710     vlc_ureduce( &p_vout->fmt_out.i_sar_num, &p_vout->fmt_out.i_sar_den,
 711                  p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den, 0 );
 712
 713     AspectRatio( p_vout->fmt_out.i_aspect, &i_aspect_x, &i_aspect_y );
 714
 715     msg_Dbg( p_vout, "picture out %ix%i (%i,%i,%ix%i), "
 716              "chroma %4.4s, ar %i:%i, sar %i:%i",
 717              p_vout->fmt_out.i_width, p_vout->fmt_out.i_height,
 718              p_vout->fmt_out.i_x_offset, p_vout->fmt_out.i_y_offset,
 719              p_vout->fmt_out.i_visible_width,
 720              p_vout->fmt_out.i_visible_height,
 721              (char*)&p_vout->fmt_out.i_chroma,
 722              i_aspect_x, i_aspect_y,
 723              p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den );
 724
 725     /* FIXME removed the need of both fmt_* and heap infos */
 726     /* Calculate shifts from system-updated masks */
 727     PictureHeapFixRgb( &p_vout->render );
 728     VideoFormatImportRgb( &p_vout->fmt_render, &p_vout->render );
 729
 730     PictureHeapFixRgb( &p_vout->output );
 731     VideoFormatImportRgb( &p_vout->fmt_out, &p_vout->output );
 732
 733     /* Check whether we managed to create direct buffers similar to
 734      * the render buffers, ie same size and chroma */
 735     if( ( p_vout->output.i_width == p_vout->render.i_width )
 736      && ( p_vout->output.i_height == p_vout->render.i_height )
 737      && ( ChromaIsEqual( &p_vout->output, &p_vout->render ) ) )
 738     {
 739         /* Cool ! We have direct buffers, we can ask the decoder to
 740          * directly decode into them ! Map the first render buffers to
 741          * the first direct buffers, but keep the first direct buffer
 742          * for memcpy operations */
 743         p_vout->p->b_direct = true;
 744
 745         for( i = 1; i < VOUT_MAX_PICTURES; i++ )
 746         {
 747             if( p_vout->p_picture[ i ].i_type != DIRECT_PICTURE &&
 748                 I_RENDERPICTURES >= VOUT_MIN_DIRECT_PICTURES - 1 &&
 749                 p_vout->p_picture[ i - 1 ].i_type == DIRECT_PICTURE )
 750             {
 751                 /* We have enough direct buffers so there's no need to
 752                  * try to use system memory buffers. */
 753                 break;
 754             }
 755             PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
 756             I_RENDERPICTURES++;
 757         }
 758
 759         msg_Dbg( p_vout, "direct render, mapping "
 760                  "render pictures 0-%i to system pictures 1-%i",
 761                  VOUT_MAX_PICTURES - 2, VOUT_MAX_PICTURES - 1 );
 762     }
 763     else
 764     {
 765         /* Rats... Something is wrong here, we could not find an output
 766          * plugin able to directly render what we decode. See if we can
 767          * find a chroma plugin to do the conversion */
 768         p_vout->p->b_direct = false;
 769
 770         if( ChromaCreate( p_vout ) )
 771         {
 772             p_vout->pf_end( p_vout );
 773             return VLC_EGENERIC;
 774         }
 775
 776         msg_Dbg( p_vout, "indirect render, mapping "
 777                  "render pictures 0-%i to system pictures %i-%i",
 778                  VOUT_MAX_PICTURES - 1, I_OUTPUTPICTURES,
 779                  I_OUTPUTPICTURES + VOUT_MAX_PICTURES - 1 );
 780
 781         /* Append render buffers after the direct buffers */
 782         for( i = I_OUTPUTPICTURES; i < 2 * VOUT_MAX_PICTURES; i++ )
 783         {
 784             PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
 785             I_RENDERPICTURES++;
 786
 787             /* Check if we have enough render pictures */
 788             if( I_RENDERPICTURES == VOUT_MAX_PICTURES )
 789                 break;
 790         }
 791     }
 792
 793     /* Link pictures back to their heap */
 794     for( i = 0 ; i < I_RENDERPICTURES ; i++ )
 795     {
 796         PP_RENDERPICTURE[ i ]->p_heap = &p_vout->render;
 797     }
 798
 799     for( i = 0 ; i < I_OUTPUTPICTURES ; i++ )
 800     {
 801         PP_OUTPUTPICTURE[ i ]->p_heap = &p_vout->output;
 802     }
 803
 804     return VLC_SUCCESS;
 805 }
 806
 807 /*****************************************************************************
 808  * RunThread: video output thread
 809  *****************************************************************************
 810  * Video output thread. This function does only returns when the thread is
 811  * terminated. It handles the pictures arriving in the video heap and the
 812  * display device events.
 813  *****************************************************************************/
 814 static void* RunThread( vlc_object_t *p_this )
 815 {
 816     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 817     int             i_idle_loops = 0;  /* loops without displaying a picture */
 818
 819     picture_t *     p_last_picture = NULL;                   /* last picture */
 820
 821     subpicture_t *  p_subpic = NULL;                   /* subpicture pointer */
 822
 823     bool            b_drop_late;
 824
 825     int             i_displayed = 0, i_lost = 0;
 826     int canc = vlc_savecancel ();
 827
 828     /*
 829      * Initialize thread
 830      */
 831     vlc_mutex_lock( &p_vout->change_lock );
 832     p_vout->b_error = InitThread( p_vout );
 833
 834     b_drop_late = var_CreateGetBool( p_vout, "drop-late-frames" );
 835
 836     /* signal the creation of the vout */
 837     vlc_thread_ready( p_vout );
 838
 839     if( p_vout->b_error )
 840     {
 841         EndThread( p_vout );
 842         vlc_mutex_unlock( &p_vout->change_lock );
 843         vlc_restorecancel (canc);
 844         return NULL;
 845     }
 846
 847     vlc_object_lock( p_vout );
 848
 849     if( p_vout->p->b_title_show )
 850         DisplayTitleOnOSD( p_vout );
 851
 852     /*
 853      * Main loop - it is not executed if an error occurred during
 854      * initialization
 855      */
 856     while( vlc_object_alive( p_vout ) && !p_vout->b_error )
 857     {
 858         /* Initialize loop variables */
 859         const mtime_t current_date = mdate();
 860         picture_t *p_picture = NULL;
 861         picture_t *p_filtered_picture;
 862         mtime_t display_date = 0;
 863         picture_t *p_directbuffer;
 864         input_thread_t *p_input;
 865         int i_index;
 866
 867 #if 0
 868         p_vout->c_loops++;
 869         if( !(p_vout->c_loops % VOUT_STATS_NB_LOOPS) )
 870         {
 871             msg_Dbg( p_vout, "picture heap: %d/%d",
 872                      I_RENDERPICTURES, p_vout->i_heap_size );
 873         }
 874 #endif
 875
 876         /* Update statistics */
 877         p_input = vlc_object_find( p_vout, VLC_OBJECT_INPUT, FIND_PARENT );
 878         if( p_input )
 879         {
 880             vlc_mutex_lock( &p_input->p->counters.counters_lock );
 881             stats_UpdateInteger( p_vout, p_input->p->counters.p_lost_pictures,
 882                                  i_lost , NULL);
 883             stats_UpdateInteger( p_vout,
 884                                  p_input->p->counters.p_displayed_pictures,
 885                                  i_displayed , NULL);
 886             i_displayed = i_lost = 0;
 887             vlc_mutex_unlock( &p_input->p->counters.counters_lock );
 888             vlc_object_release( p_input );
 889         }
 890
 891         /*
 892          * Find the picture to display (the one with the earliest date).
 893          * This operation does not need lock, since only READY_PICTUREs
 894          * are handled. */
 895         for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
 896         {
 897             picture_t *p_pic = PP_RENDERPICTURE[i_index];
 898
 899             if( p_pic->i_status == READY_PICTURE &&
 900                 ( p_picture == NULL || p_pic->date < display_date ) )
 901             {
 902                 p_picture = p_pic;
 903                 display_date = p_picture->date;
 904             }
 905         }
 906         if( p_vout->p->b_paused && p_last_picture != NULL )
 907             p_picture = p_last_picture;
 908
 909         if( p_picture )
 910         {
 911             /* If we met the last picture, parse again to see whether there is
 912              * a more appropriate one. */
 913             if( p_picture == p_last_picture && !p_vout->p->b_paused )
 914             {
 915                 for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
 916                 {
 917                     picture_t *p_pic = PP_RENDERPICTURE[i_index];
 918
 919                     if( p_pic->i_status == READY_PICTURE &&
 920                         p_pic != p_last_picture &&
 921                         ( p_picture == p_last_picture || p_pic->date < display_date ) )
 922                     {
 923                         p_picture = p_pic;
 924                         display_date = p_picture->date;
 925                     }
 926                 }
 927             }
 928
 929             /* If we found better than the last picture, destroy it */
 930             if( p_last_picture && p_picture != p_last_picture )
 931             {
 932                 DropPicture( p_vout, p_last_picture );
 933                 p_last_picture = NULL;
 934             }
 935
 936             /* Compute FPS rate */
 937             p_vout->p->p_fps_sample[ p_vout->p->c_fps_samples++ % VOUT_FPS_SAMPLES ]
 938                 = display_date;
 939
 940             if( !p_picture->b_force &&
 941                 p_picture != p_last_picture &&
 942                 display_date < current_date + p_vout->p->render_time &&
 943                 b_drop_late )
 944             {
 945                 /* Picture is late: it will be destroyed and the thread
 946                  * will directly choose the next picture */
 947                 DropPicture( p_vout, p_picture );
 948                 i_lost++;
 949                 msg_Warn( p_vout, "late picture skipped (%"PRId64")",
 950                                   current_date - display_date );
 951                 continue;
 952             }
 953
 954             if( display_date >
 955                 current_date + p_vout->p->i_pts_delay + VOUT_BOGUS_DELAY )
 956             {
 957                 /* Picture is waaay too early: it will be destroyed */
 958                 DropPicture( p_vout, p_picture );
 959                 i_lost++;
 960                 msg_Warn( p_vout, "vout warning: early picture skipped "
 961                           "(%"PRId64")", display_date - current_date
 962                           - p_vout->p->i_pts_delay );
 963                 continue;
 964             }
 965
 966             if( display_date > current_date + VOUT_DISPLAY_DELAY )
 967             {
 968                 /* A picture is ready to be rendered, but its rendering date
 969                  * is far from the current one so the thread will perform an
 970                  * empty loop as if no picture were found. The picture state
 971                  * is unchanged */
 972                 p_picture    = NULL;
 973                 display_date = 0;
 974             }
 975             else if( p_picture == p_last_picture )
 976             {
 977                 /* We are asked to repeat the previous picture, but we first
 978                  * wait for a couple of idle loops */
 979                 if( i_idle_loops < 4 )
 980                 {
 981                     p_picture    = NULL;
 982                     display_date = 0;
 983                 }
 984                 else
 985                 {
 986                     /* We set the display date to something high, otherwise
 987                      * we'll have lots of problems with late pictures */
 988                     display_date = current_date + p_vout->p->render_time;
 989                 }
 990             }
 991         }
 992
 993         if( p_picture == NULL )
 994             i_idle_loops++;
 995
 996         p_filtered_picture = NULL;
 997         if( p_picture )
 998             p_filtered_picture = filter_chain_VideoFilter( p_vout->p->p_vf2_chain,
 999                                                            p_picture );
1000
1001         /* FIXME it is a bit ugly that b_snapshot is not locked but I do not
1002          * know which lock to use (here and in the snapshot callback) */
1003         const bool b_snapshot = p_vout->p->b_snapshot;
1004         if( b_snapshot )
1005             p_vout->p->b_snapshot = false;
1006
1007         /*
1008          * Check for subpictures to display
1009          */
1010         bool b_paused = false;
1011         if( display_date > 0 )
1012         {
1013             p_input = vlc_object_find( p_vout, VLC_OBJECT_INPUT, FIND_PARENT );
1014             b_paused = p_input && var_GetInteger( p_input, "state" ) == PAUSE_S;
1015             if( p_input )
1016                 vlc_object_release( p_input );
1017
1018             p_subpic = spu_SortSubpictures( p_vout->p_spu, display_date, b_paused, b_snapshot );
1019         }
1020
1021         /*
1022          * Perform rendering
1023          */
1024         i_displayed++;
1025         p_directbuffer = vout_RenderPicture( p_vout, p_filtered_picture, p_subpic, b_paused );
1026
1027         /*
1028          * Take a snapshot if requested
1029          */
1030         if( p_directbuffer && b_snapshot )
1031             vout_Snapshot( p_vout, p_directbuffer );
1032
1033         /*
1034          * Call the plugin-specific rendering method if there is one
1035          */
1036         if( p_filtered_picture != NULL && p_directbuffer != NULL && p_vout->pf_render )
1037         {
1038             /* Render the direct buffer returned by vout_RenderPicture */
1039             p_vout->pf_render( p_vout, p_directbuffer );
1040         }
1041
1042         /*
1043          * Sleep, wake up
1044          */
1045         if( display_date != 0 && p_directbuffer != NULL )
1046         {
1047             mtime_t current_render_time = mdate() - current_date;
1048             /* if render time is very large we don't include it in the mean */
1049             if( current_render_time < p_vout->p->render_time +
1050                 VOUT_DISPLAY_DELAY )
1051             {
1052                 /* Store render time using a sliding mean weighting to
1053                  * current value in a 3 to 1 ratio*/
1054                 p_vout->p->render_time *= 3;
1055                 p_vout->p->render_time += current_render_time;
1056                 p_vout->p->render_time >>= 2;
1057             }
1058         }
1059
1060         /* Give back change lock */
1061         vlc_mutex_unlock( &p_vout->change_lock );
1062
1063         vlc_object_unlock( p_vout );
1064
1065         /* Sleep a while or until a given date */
1066         if( display_date != 0 )
1067         {
1068             /* If there are filters in the chain, better give them the picture
1069              * in advance */
1070             if( !p_vout->p->psz_filter_chain || !*p_vout->p->psz_filter_chain )
1071             {
1072                 mwait( display_date - VOUT_MWAIT_TOLERANCE );
1073             }
1074         }
1075         else
1076         {
1077             msleep( VOUT_IDLE_SLEEP );
1078         }
1079
1080         /* On awakening, take back lock and send immediately picture
1081          * to display. */
1082         vlc_object_lock( p_vout );
1083         /* Note: vlc_object_alive() could be false here, and we
1084          * could be dead */
1085         vlc_mutex_lock( &p_vout->change_lock );
1086
1087         /*
1088          * Display the previously rendered picture
1089          */
1090         if( p_filtered_picture != NULL && p_directbuffer != NULL )
1091         {
1092             /* Display the direct buffer returned by vout_RenderPicture */
1093             if( p_vout->pf_display )
1094                 p_vout->pf_display( p_vout, p_directbuffer );
1095
1096             /* Tell the vout this was the last picture and that it does not
1097              * need to be forced anymore. */
1098             p_last_picture = p_picture;
1099             p_last_picture->b_force = false;
1100         }
1101
1102         /* Drop the filtered picture if created by video filters */
1103         if( p_filtered_picture != NULL && p_filtered_picture != p_picture )
1104             DropPicture( p_vout, p_filtered_picture );
1105
1106         if( p_picture != NULL )
1107         {
1108             /* Reinitialize idle loop count */
1109             i_idle_loops = 0;
1110         }
1111
1112         /*
1113          * Check events and manage thread
1114          */
1115         if( p_vout->pf_manage && p_vout->pf_manage( p_vout ) )
1116         {
1117             /* A fatal error occurred, and the thread must terminate
1118              * immediately, without displaying anything - setting b_error to 1
1119              * causes the immediate end of the main while() loop. */
1120             // FIXME pf_end
1121             p_vout->b_error = 1;
1122             break;
1123         }
1124
1125         if( p_vout->i_changes & VOUT_SIZE_CHANGE )
1126         {
1127             /* this must only happen when the vout plugin is incapable of
1128              * rescaling the picture itself. In this case we need to destroy
1129              * the current picture buffers and recreate new ones with the right
1130              * dimensions */
1131             int i;
1132
1133             p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
1134
1135             assert( !p_vout->p->b_direct );
1136
1137             ChromaDestroy( p_vout );
1138
1139             vlc_mutex_lock( &p_vout->picture_lock );
1140
1141             p_vout->pf_end( p_vout );
1142
1143             for( i = 0; i < I_OUTPUTPICTURES; i++ )
1144                  p_vout->p_picture[ i ].i_status = FREE_PICTURE;
1145
1146             I_OUTPUTPICTURES = 0;
1147
1148             if( p_vout->pf_init( p_vout ) )
1149             {
1150                 msg_Err( p_vout, "cannot resize display" );
1151                 /* FIXME: pf_end will be called again in EndThread() */
1152                 p_vout->b_error = 1;
1153             }
1154
1155             vlc_mutex_unlock( &p_vout->picture_lock );
1156
1157             /* Need to reinitialise the chroma plugin. Since we might need
1158              * resizing too and it's not sure that we already had it,
1159              * recreate the chroma plugin chain from scratch. */
1160             /* dionoea */
1161             if( ChromaCreate( p_vout ) )
1162             {
1163                 msg_Err( p_vout, "WOW THIS SUCKS BIG TIME!!!!!" );
1164                 p_vout->b_error = 1;
1165             }
1166             if( p_vout->b_error )
1167                 break;
1168         }
1169
1170         if( p_vout->i_changes & VOUT_PICTURE_BUFFERS_CHANGE )
1171         {
1172             /* This happens when the picture buffers need to be recreated.
1173              * This is useful on multimonitor displays for instance.
1174              *
1175              * Warning: This only works when the vout creates only 1 picture
1176              * buffer!! */
1177             p_vout->i_changes &= ~VOUT_PICTURE_BUFFERS_CHANGE;
1178
1179             if( !p_vout->p->b_direct )
1180                 ChromaDestroy( p_vout );
1181
1182             vlc_mutex_lock( &p_vout->picture_lock );
1183
1184             p_vout->pf_end( p_vout );
1185
1186             I_OUTPUTPICTURES = I_RENDERPICTURES = 0;
1187
1188             p_vout->b_error = InitThread( p_vout );
1189             if( p_vout->b_error )
1190                 msg_Err( p_vout, "InitThread after VOUT_PICTURE_BUFFERS_CHANGE failed\n" );
1191
1192             vlc_mutex_unlock( &p_vout->picture_lock );
1193
1194             if( p_vout->b_error )
1195                 break;
1196         }
1197
1198         /* Check for "video filter2" changes */
1199         vlc_mutex_lock( &p_vout->p->vfilter_lock );
1200         if( p_vout->p->psz_vf2 )
1201         {
1202             es_format_t fmt;
1203
1204             es_format_Init( &fmt, VIDEO_ES, p_vout->fmt_render.i_chroma );
1205             fmt.video = p_vout->fmt_render;
1206             filter_chain_Reset( p_vout->p->p_vf2_chain, &fmt, &fmt );
1207
1208             if( filter_chain_AppendFromString( p_vout->p->p_vf2_chain,
1209                                                p_vout->p->psz_vf2 ) < 0 )
1210                 msg_Err( p_vout, "Video filter chain creation failed" );
1211
1212             free( p_vout->p->psz_vf2 );
1213             p_vout->p->psz_vf2 = NULL;
1214         }
1215         vlc_mutex_unlock( &p_vout->p->vfilter_lock );
1216     }
1217
1218     /*
1219      * Error loop - wait until the thread destruction is requested
1220      */
1221     if( p_vout->b_error )
1222         ErrorThread( p_vout );
1223
1224     /* End of thread */
1225     CleanThread( p_vout );
1226     EndThread( p_vout );
1227     vlc_mutex_unlock( &p_vout->change_lock );
1228
1229     vlc_object_unlock( p_vout );
1230     vlc_restorecancel (canc);
1231     return NULL;
1232 }
1233
1234 /*****************************************************************************
1235  * ErrorThread: RunThread() error loop
1236  *****************************************************************************
1237  * This function is called when an error occurred during thread main's loop.
1238  * The thread can still receive feed, but must be ready to terminate as soon
1239  * as possible.
1240  *****************************************************************************/
1241 static void ErrorThread( vout_thread_t *p_vout )
1242 {
1243     /* Wait until a `die' order */
1244     while( vlc_object_alive( p_vout ) )
1245         vlc_object_wait( p_vout );
1246 }
1247
1248 /*****************************************************************************
1249  * CleanThread: clean up after InitThread
1250  *****************************************************************************
1251  * This function is called after a sucessful
1252  * initialization. It frees all resources allocated by InitThread.
1253  * XXX You have to enter it with change_lock taken.
1254  *****************************************************************************/
1255 static void CleanThread( vout_thread_t *p_vout )
1256 {
1257     int     i_index;                                        /* index in heap */
1258
1259     if( !p_vout->p->b_direct )
1260         ChromaDestroy( p_vout );
1261
1262     /* Destroy all remaining pictures */
1263     for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++ )
1264     {
1265         if ( p_vout->p_picture[i_index].i_type == MEMORY_PICTURE )
1266         {
1267             free( p_vout->p_picture[i_index].p_data_orig );
1268         }
1269     }
1270
1271     /* Destroy translation tables */
1272     if( !p_vout->b_error )
1273         p_vout->pf_end( p_vout );
1274 }
1275
1276 /*****************************************************************************
1277  * EndThread: thread destruction
1278  *****************************************************************************
1279  * This function is called when the thread ends.
1280  * It frees all resources not allocated by InitThread.
1281  * XXX You have to enter it with change_lock taken.
1282  *****************************************************************************/
1283 static void EndThread( vout_thread_t *p_vout )
1284 {
1285 #ifdef STATS
1286     {
1287         struct tms cpu_usage;
1288         times( &cpu_usage );
1289
1290         msg_Dbg( p_vout, "cpu usage (user: %d, system: %d)",
1291                  cpu_usage.tms_utime, cpu_usage.tms_stime );
1292     }
1293 #endif
1294
1295     /* FIXME does that function *really* need to be called inside the thread ? */
1296
1297     /* Destroy subpicture unit */
1298     spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), false );
1299     spu_Destroy( p_vout->p_spu );
1300
1301     /* Destroy the video filters2 */
1302     filter_chain_Delete( p_vout->p->p_vf2_chain );
1303 }
1304
1305 /* Thread helpers */
1306 static picture_t *ChromaGetPicture( filter_t *p_filter )
1307 {
1308     picture_t *p_pic = (picture_t *)p_filter->p_owner;
1309     p_filter->p_owner = NULL;
1310     return p_pic;
1311 }
1312
1313 static int ChromaCreate( vout_thread_t *p_vout )
1314 {
1315     static const char typename[] = "chroma";
1316     filter_t *p_chroma;
1317
1318     /* Choose the best module */
1319     p_chroma = p_vout->p->p_chroma =
1320         vlc_custom_create( p_vout, sizeof(filter_t), VLC_OBJECT_GENERIC,
1321                            typename );
1322
1323     vlc_object_attach( p_chroma, p_vout );
1324
1325     /* TODO: Set the fmt_in and fmt_out stuff here */
1326     p_chroma->fmt_in.video = p_vout->fmt_render;
1327     p_chroma->fmt_out.video = p_vout->fmt_out;
1328     VideoFormatImportRgb( &p_chroma->fmt_in.video, &p_vout->render );
1329     VideoFormatImportRgb( &p_chroma->fmt_out.video, &p_vout->output );
1330
1331     p_chroma->p_module = module_need( p_chroma, "video filter2", NULL, 0 );
1332
1333     if( p_chroma->p_module == NULL )
1334     {
1335         msg_Err( p_vout, "no chroma module for %4.4s to %4.4s i=%dx%d o=%dx%d",
1336                  (char*)&p_vout->render.i_chroma,
1337                  (char*)&p_vout->output.i_chroma,
1338                  p_chroma->fmt_in.video.i_width, p_chroma->fmt_in.video.i_height,
1339                  p_chroma->fmt_out.video.i_width, p_chroma->fmt_out.video.i_height
1340                  );
1341
1342         vlc_object_release( p_vout->p->p_chroma );
1343         p_vout->p->p_chroma = NULL;
1344
1345         return VLC_EGENERIC;
1346     }
1347     p_chroma->pf_vout_buffer_new = ChromaGetPicture;
1348     return VLC_SUCCESS;
1349 }
1350
1351 static void ChromaDestroy( vout_thread_t *p_vout )
1352 {
1353     assert( !p_vout->p->b_direct );
1354
1355     if( !p_vout->p->p_chroma )
1356         return;
1357
1358     module_unneed( p_vout->p->p_chroma, p_vout->p->p_chroma->p_module );
1359     vlc_object_release( p_vout->p->p_chroma );
1360     p_vout->p->p_chroma = NULL;
1361 }
1362
1363 static void DropPicture( vout_thread_t *p_vout, picture_t *p_picture )
1364 {
1365     vlc_mutex_lock( &p_vout->picture_lock );
1366     if( p_picture->i_refcount )
1367     {
1368         /* Pretend we displayed the picture, but don't destroy
1369          * it since the decoder might still need it. */
1370         p_picture->i_status = DISPLAYED_PICTURE;
1371     }
1372     else
1373     {
1374         /* Destroy the picture without displaying it */
1375         p_picture->i_status = DESTROYED_PICTURE;
1376         p_vout->i_heap_size--;
1377         picture_CleanupQuant( p_picture );
1378     }
1379     vlc_mutex_unlock( &p_vout->picture_lock );
1380 }
1381
1382
1383
1384 /* following functions are local */
1385
1386 static int ReduceHeight( int i_ratio )
1387 {
1388     int i_dummy = VOUT_ASPECT_FACTOR;
1389     int i_pgcd  = 1;
1390
1391     if( !i_ratio )
1392     {
1393         return i_pgcd;
1394     }
1395
1396     /* VOUT_ASPECT_FACTOR is (2^7 * 3^3 * 5^3), we just check for 2, 3 and 5 */
1397     while( !(i_ratio & 1) && !(i_dummy & 1) )
1398     {
1399         i_ratio >>= 1;
1400         i_dummy >>= 1;
1401         i_pgcd  <<= 1;
1402     }
1403
1404     while( !(i_ratio % 3) && !(i_dummy % 3) )
1405     {
1406         i_ratio /= 3;
1407         i_dummy /= 3;
1408         i_pgcd  *= 3;
1409     }
1410
1411     while( !(i_ratio % 5) && !(i_dummy % 5) )
1412     {
1413         i_ratio /= 5;
1414         i_dummy /= 5;
1415         i_pgcd  *= 5;
1416     }
1417
1418     return i_pgcd;
1419 }
1420
1421 static void AspectRatio( int i_aspect, int *i_aspect_x, int *i_aspect_y )
1422 {
1423     unsigned int i_pgcd = ReduceHeight( i_aspect );
1424     *i_aspect_x = i_aspect / i_pgcd;
1425     *i_aspect_y = VOUT_ASPECT_FACTOR / i_pgcd;
1426 }
1427
1428 /**
1429  * This function copies all RGB informations from a picture_heap_t into
1430  * a video_format_t
1431  */
1432 static void VideoFormatImportRgb( video_format_t *p_fmt, const picture_heap_t *p_heap )
1433 {
1434     p_fmt->i_rmask = p_heap->i_rmask;
1435     p_fmt->i_gmask = p_heap->i_gmask;
1436     p_fmt->i_bmask = p_heap->i_bmask;
1437     p_fmt->i_rrshift = p_heap->i_rrshift;
1438     p_fmt->i_lrshift = p_heap->i_lrshift;
1439     p_fmt->i_rgshift = p_heap->i_rgshift;
1440     p_fmt->i_lgshift = p_heap->i_lgshift;
1441     p_fmt->i_rbshift = p_heap->i_rbshift;
1442     p_fmt->i_lbshift = p_heap->i_lbshift;
1443 }
1444
1445 /**
1446  * This funtion copes all RGB informations from a video_format_t into
1447  * a picture_heap_t
1448  */
1449 static void VideoFormatExportRgb( const video_format_t *p_fmt, picture_heap_t *p_heap )
1450 {
1451     p_heap->i_rmask = p_fmt->i_rmask;
1452     p_heap->i_gmask = p_fmt->i_gmask;
1453     p_heap->i_bmask = p_fmt->i_bmask;
1454     p_heap->i_rrshift = p_fmt->i_rrshift;
1455     p_heap->i_lrshift = p_fmt->i_lrshift;
1456     p_heap->i_rgshift = p_fmt->i_rgshift;
1457     p_heap->i_lgshift = p_fmt->i_lgshift;
1458     p_heap->i_rbshift = p_fmt->i_rbshift;
1459     p_heap->i_lbshift = p_fmt->i_lbshift;
1460 }
1461
1462 /**
1463  * This function computes rgb shifts from masks
1464  */
1465 static void PictureHeapFixRgb( picture_heap_t *p_heap )
1466 {
1467     video_format_t fmt;
1468
1469     /* */
1470     fmt.i_chroma = p_heap->i_chroma;
1471     VideoFormatImportRgb( &fmt, p_heap );
1472
1473     /* */
1474     video_format_FixRgb( &fmt );
1475
1476     VideoFormatExportRgb( &fmt, p_heap );
1477 }
1478
1479 /*****************************************************************************
1480  * object variables callbacks: a bunch of object variables are used by the
1481  * interfaces to interact with the vout.
1482  *****************************************************************************/
1483 static int DeinterlaceCallback( vlc_object_t *p_this, char const *psz_cmd,
1484                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
1485 {
1486     vout_thread_t *p_vout = (vout_thread_t *)p_this;
1487     input_thread_t *p_input;
1488     vlc_value_t val;
1489
1490     char *psz_mode = newval.psz_string;
1491     char *psz_filter, *psz_deinterlace = NULL;
1492     (void)psz_cmd; (void)oldval; (void)p_data;
1493
1494     var_Get( p_vout, "vout-filter", &val );
1495     psz_filter = val.psz_string;
1496     if( psz_filter ) psz_deinterlace = strstr( psz_filter, "deinterlace" );
1497
1498     if( !psz_mode || !*psz_mode )
1499     {
1500         if( psz_deinterlace )
1501         {
1502             char *psz_src = psz_deinterlace + sizeof("deinterlace") - 1;
1503             if( psz_src[0] == ':' ) psz_src++;
1504             memmove( psz_deinterlace, psz_src, strlen(psz_src) + 1 );
1505         }
1506     }
1507     else if( !psz_deinterlace )
1508     {
1509         psz_filter = realloc( psz_filter, strlen( psz_filter ) +
1510                               sizeof(":deinterlace") );
1511         if( psz_filter && *psz_filter ) strcat( psz_filter, ":" );
1512         strcat( psz_filter, "deinterlace" );
1513     }
1514
1515     p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1516                                                  FIND_PARENT );
1517     if( !p_input ) return VLC_EGENERIC;
1518
1519     if( psz_mode && *psz_mode )
1520     {
1521         /* Modify input as well because the vout might have to be restarted */
1522         val.psz_string = psz_mode;
1523         var_Create( p_input, "deinterlace-mode", VLC_VAR_STRING );
1524         var_Set( p_input, "deinterlace-mode", val );
1525     }
1526     vlc_object_release( p_input );
1527
1528     val.b_bool = true;
1529     var_Set( p_vout, "intf-change", val );
1530
1531     val.psz_string = psz_filter;
1532     var_Set( p_vout, "vout-filter", val );
1533     free( psz_filter );
1534
1535     return VLC_SUCCESS;
1536 }
1537
1538 static int FilterCallback( vlc_object_t *p_this, char const *psz_cmd,
1539                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
1540 {
1541     vout_thread_t *p_vout = (vout_thread_t *)p_this;
1542     input_thread_t *p_input;
1543     vlc_value_t val;
1544     (void)psz_cmd; (void)oldval; (void)p_data;
1545
1546     p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1547                                                  FIND_PARENT );
1548     if (!p_input)
1549     {
1550         msg_Err( p_vout, "Input not found" );
1551         return( VLC_EGENERIC );
1552     }
1553
1554     val.b_bool = true;
1555     var_Set( p_vout, "intf-change", val );
1556
1557     /* Modify input as well because the vout might have to be restarted */
1558     val.psz_string = newval.psz_string;
1559     var_Create( p_input, "vout-filter", VLC_VAR_STRING );
1560
1561     var_Set( p_input, "vout-filter", val );
1562
1563     /* Now restart current video stream */
1564     input_Control( p_input, INPUT_RESTART_ES, -VIDEO_ES );
1565     vlc_object_release( p_input );
1566
1567     return VLC_SUCCESS;
1568 }
1569
1570 /*****************************************************************************
1571  * Video Filter2 stuff
1572  *****************************************************************************/
1573 static int VideoFilter2Callback( vlc_object_t *p_this, char const *psz_cmd,
1574                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
1575 {
1576     vout_thread_t *p_vout = (vout_thread_t *)p_this;
1577     (void)psz_cmd; (void)oldval; (void)p_data;
1578
1579     vlc_mutex_lock( &p_vout->p->vfilter_lock );
1580     p_vout->p->psz_vf2 = strdup( newval.psz_string );
1581     vlc_mutex_unlock( &p_vout->p->vfilter_lock );
1582
1583     return VLC_SUCCESS;
1584 }
1585
1586 static void DisplayTitleOnOSD( vout_thread_t *p_vout )
1587 {
1588     input_thread_t *p_input;
1589     mtime_t i_now, i_stop;
1590
1591     if( !config_GetInt( p_vout, "osd" ) ) return;
1592
1593     p_input = (input_thread_t *)vlc_object_find( p_vout,
1594               VLC_OBJECT_INPUT, FIND_ANYWHERE );
1595     if( p_input )
1596     {
1597         i_now = mdate();
1598         i_stop = i_now + (mtime_t)(p_vout->p->i_title_timeout * 1000);
1599         char *psz_nowplaying =
1600             input_item_GetNowPlaying( input_GetItem( p_input ) );
1601         char *psz_artist = input_item_GetArtist( input_GetItem( p_input ) );
1602         char *psz_name = input_item_GetTitle( input_GetItem( p_input ) );
1603         if( EMPTY_STR( psz_name ) )
1604         {
1605             free( psz_name );
1606             psz_name = input_item_GetName( input_GetItem( p_input ) );
1607         }
1608         if( !EMPTY_STR( psz_nowplaying ) )
1609         {
1610             vout_ShowTextAbsolute( p_vout, DEFAULT_CHAN,
1611                                    psz_nowplaying, NULL,
1612                                    p_vout->p->i_title_position,
1613                                    30 + p_vout->fmt_in.i_width
1614                                       - p_vout->fmt_in.i_visible_width
1615                                       - p_vout->fmt_in.i_x_offset,
1616                                    20 + p_vout->fmt_in.i_y_offset,
1617                                    i_now, i_stop );
1618         }
1619         else if( !EMPTY_STR( psz_artist ) )
1620         {
1621             char *psz_string = NULL;
1622             if( asprintf( &psz_string, "%s - %s", psz_name, psz_artist ) != -1 )
1623             {
1624                 vout_ShowTextAbsolute( p_vout, DEFAULT_CHAN,
1625                                        psz_string, NULL,
1626                                        p_vout->p->i_title_position,
1627                                        30 + p_vout->fmt_in.i_width
1628                                           - p_vout->fmt_in.i_visible_width
1629                                           - p_vout->fmt_in.i_x_offset,
1630                                        20 + p_vout->fmt_in.i_y_offset,
1631                                        i_now, i_stop );
1632                 free( psz_string );
1633             }
1634         }
1635         else
1636         {
1637             vout_ShowTextAbsolute( p_vout, DEFAULT_CHAN,
1638                                    psz_name, NULL,
1639                                    p_vout->p->i_title_position,
1640                                    30 + p_vout->fmt_in.i_width
1641                                       - p_vout->fmt_in.i_visible_width
1642                                       - p_vout->fmt_in.i_x_offset,
1643                                    20 + p_vout->fmt_in.i_y_offset,
1644                                    i_now, i_stop );
1645         }
1646         vlc_object_release( p_input );
1647         free( psz_artist );
1648         free( psz_name );
1649         free( psz_nowplaying );
1650     }
1651 }
1652