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-2004 VideoLAN
   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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  27  *****************************************************************************/
  28
  29 /*****************************************************************************
  30  * Preamble
  31  *****************************************************************************/
  32 #include <stdlib.h>                                                /* free() */
  33
  34 #include <vlc/vlc.h>
  35
  36 #ifdef HAVE_SYS_TIMES_H
  37 #   include <sys/times.h>
  38 #endif
  39
  40 #include "vlc_video.h"
  41 #include "video_output.h"
  42 #include "vlc_spu.h"
  43 #include <vlc/input.h>                 /* for input_thread_t and i_pts_delay */
  44 #include "vlc_playlist.h"
  45
  46 #if defined( SYS_DARWIN )
  47 #include "darwin_specific.h"
  48 #endif
  49
  50 /*****************************************************************************
  51  * Local prototypes
  52  *****************************************************************************/
  53 static int      InitThread        ( vout_thread_t * );
  54 static void     RunThread         ( vout_thread_t * );
  55 static void     ErrorThread       ( vout_thread_t * );
  56 static void     EndThread         ( vout_thread_t * );
  57 static void     DestroyThread     ( vout_thread_t * );
  58
  59 static void     AspectRatio       ( int, int *, int * );
  60 static int      BinaryLog         ( uint32_t );
  61 static void     MaskToShift       ( int *, int *, uint32_t );
  62 static void     InitWindowSize    ( vout_thread_t *, int *, int * );
  63
  64 /* Object variables callbacks */
  65 static int DeinterlaceCallback( vlc_object_t *, char const *,
  66                                 vlc_value_t, vlc_value_t, void * );
  67 static int FilterCallback( vlc_object_t *, char const *,
  68                            vlc_value_t, vlc_value_t, void * );
  69
  70 /* From vout_intf.c */
  71 int vout_Snapshot( vout_thread_t *, picture_t * );
  72
  73 /*****************************************************************************
  74  * vout_Request: find a video output thread, create one, or destroy one.
  75  *****************************************************************************
  76  * This function looks for a video output thread matching the current
  77  * properties. If not found, it spawns a new one.
  78  *****************************************************************************/
  79 vout_thread_t *__vout_Request( vlc_object_t *p_this, vout_thread_t *p_vout,
  80                                video_format_t *p_fmt )
  81 {
  82     if( !p_fmt )
  83     {
  84         /* Reattach video output to input before bailing out */
  85         if( p_vout )
  86         {
  87             vlc_object_t *p_playlist;
  88
  89             p_playlist = vlc_object_find( p_this, VLC_OBJECT_PLAYLIST,
  90                                           FIND_ANYWHERE );
  91
  92             if( p_playlist )
  93             {
  94                 spu_Attach( p_vout->p_spu, p_this, VLC_FALSE );
  95                 vlc_object_detach( p_vout );
  96                 vlc_object_attach( p_vout, p_playlist );
  97
  98                 vlc_object_release( p_playlist );
  99             }
 100             else
 101             {
 102                 msg_Dbg( p_this, "cannot find playlist, destroying vout" );
 103                 vlc_object_detach( p_vout );
 104                 vout_Destroy( p_vout );
 105             }
 106         }
 107         return NULL;
 108     }
 109
 110     /* If a video output was provided, lock it, otherwise look for one. */
 111     if( p_vout )
 112     {
 113         vlc_object_yield( p_vout );
 114     }
 115     else
 116     {
 117         p_vout = vlc_object_find( p_this, VLC_OBJECT_VOUT, FIND_CHILD );
 118
 119         if( !p_vout )
 120         {
 121             playlist_t *p_playlist;
 122
 123             p_playlist = vlc_object_find( p_this,
 124                                           VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
 125             if( p_playlist )
 126             {
 127                 vlc_mutex_lock( &p_playlist->gc_lock );
 128                 p_vout = vlc_object_find( p_playlist,
 129                                           VLC_OBJECT_VOUT, FIND_CHILD );
 130                 /* only first children of p_input for unused vout */
 131                 if( p_vout && p_vout->p_parent != p_playlist )
 132                 {
 133                     vlc_object_release( p_vout );
 134                     p_vout = NULL;
 135                 }
 136                 vlc_mutex_unlock( &p_playlist->gc_lock );
 137                 vlc_object_release( p_playlist );
 138             }
 139         }
 140     }
 141
 142     /* If we now have a video output, check it has the right properties */
 143     if( p_vout )
 144     {
 145         char *psz_filter_chain;
 146         vlc_value_t val;
 147
 148         /* We don't directly check for the "vout-filter" variable for obvious
 149          * performance reasons. */
 150         if( p_vout->b_filter_change )
 151         {
 152             var_Get( p_vout, "vout-filter", &val );
 153             psz_filter_chain = val.psz_string;
 154
 155             if( psz_filter_chain && !*psz_filter_chain )
 156             {
 157                 free( psz_filter_chain );
 158                 psz_filter_chain = NULL;
 159             }
 160             if( p_vout->psz_filter_chain && !*p_vout->psz_filter_chain )
 161             {
 162                 free( p_vout->psz_filter_chain );
 163                 p_vout->psz_filter_chain = NULL;
 164             }
 165
 166             if( !psz_filter_chain && !p_vout->psz_filter_chain )
 167             {
 168                 p_vout->b_filter_change = VLC_FALSE;
 169             }
 170
 171             if( psz_filter_chain ) free( psz_filter_chain );
 172         }
 173
 174         if( ( p_vout->fmt_render.i_width != p_fmt->i_width ) ||
 175             ( p_vout->fmt_render.i_height != p_fmt->i_height ) ||
 176             ( p_vout->fmt_render.i_chroma != p_fmt->i_chroma ) ||
 177             ( p_vout->fmt_render.i_aspect != p_fmt->i_aspect
 178                     && !p_vout->b_override_aspect ) ||
 179             p_vout->b_filter_change )
 180         {
 181             /* We are not interested in this format, close this vout */
 182             vlc_object_detach( p_vout );
 183             vlc_object_release( p_vout );
 184             vout_Destroy( p_vout );
 185             p_vout = NULL;
 186         }
 187         else
 188         {
 189             /* This video output is cool! Hijack it. */
 190             vlc_object_detach( p_vout );
 191             spu_Attach( p_vout->p_spu, p_this, VLC_TRUE );
 192             vlc_object_attach( p_vout, p_this );
 193             vlc_object_release( p_vout );
 194         }
 195     }
 196
 197     if( !p_vout )
 198     {
 199         msg_Dbg( p_this, "no usable vout present, spawning one" );
 200
 201         p_vout = vout_Create( p_this, p_fmt );
 202     }
 203
 204     return p_vout;
 205 }
 206
 207 /*****************************************************************************
 208  * vout_Create: creates a new video output thread
 209  *****************************************************************************
 210  * This function creates a new video output thread, and returns a pointer
 211  * to its description. On error, it returns NULL.
 212  *****************************************************************************/
 213 vout_thread_t * __vout_Create( vlc_object_t *p_parent, video_format_t *p_fmt )
 214 {
 215     vout_thread_t  * p_vout;                            /* thread descriptor */
 216     input_thread_t * p_input_thread;
 217     int              i_index;                               /* loop variable */
 218     char           * psz_plugin;
 219     vlc_value_t      val, text;
 220
 221     unsigned int i_width = p_fmt->i_width;
 222     unsigned int i_height = p_fmt->i_height;
 223     vlc_fourcc_t i_chroma = p_fmt->i_chroma;
 224     unsigned int i_aspect = p_fmt->i_aspect;
 225
 226     /* Allocate descriptor */
 227     p_vout = vlc_object_create( p_parent, VLC_OBJECT_VOUT );
 228     if( p_vout == NULL )
 229     {
 230         msg_Err( p_parent, "out of memory" );
 231         return NULL;
 232     }
 233
 234     /* Initialize pictures - translation tables and functions
 235      * will be initialized later in InitThread */
 236     for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++)
 237     {
 238         p_vout->p_picture[i_index].pf_lock = NULL;
 239         p_vout->p_picture[i_index].pf_unlock = NULL;
 240         p_vout->p_picture[i_index].i_status = FREE_PICTURE;
 241         p_vout->p_picture[i_index].i_type   = EMPTY_PICTURE;
 242         p_vout->p_picture[i_index].b_slow   = 0;
 243     }
 244
 245     /* No images in the heap */
 246     p_vout->i_heap_size = 0;
 247
 248     /* Initialize the rendering heap */
 249     I_RENDERPICTURES = 0;
 250     p_vout->fmt_render        = *p_fmt;   /* FIXME palette */
 251     p_vout->fmt_in            = *p_fmt;   /* FIXME palette */
 252     p_vout->render.i_width    = i_width;
 253     p_vout->render.i_height   = i_height;
 254     p_vout->render.i_chroma   = i_chroma;
 255     p_vout->render.i_aspect   = i_aspect;
 256
 257     p_vout->render.i_rmask    = 0;
 258     p_vout->render.i_gmask    = 0;
 259     p_vout->render.i_bmask    = 0;
 260
 261     p_vout->render.i_last_used_pic = -1;
 262     p_vout->render.b_allow_modify_pics = 1;
 263
 264     /* Zero the output heap */
 265     I_OUTPUTPICTURES = 0;
 266     p_vout->output.i_width    = 0;
 267     p_vout->output.i_height   = 0;
 268     p_vout->output.i_chroma   = 0;
 269     p_vout->output.i_aspect   = 0;
 270
 271     p_vout->output.i_rmask    = 0;
 272     p_vout->output.i_gmask    = 0;
 273     p_vout->output.i_bmask    = 0;
 274
 275     /* Initialize misc stuff */
 276     p_vout->i_changes    = 0;
 277     p_vout->f_gamma      = 0;
 278     p_vout->b_grayscale  = 0;
 279     p_vout->b_info       = 0;
 280     p_vout->b_interface  = 0;
 281     p_vout->b_scale      = 1;
 282     p_vout->b_fullscreen = 0;
 283     p_vout->i_alignment  = 0;
 284     p_vout->render_time  = 10;
 285     p_vout->c_fps_samples = 0;
 286     p_vout->b_filter_change = 0;
 287     p_vout->pf_control = 0;
 288     p_vout->p_parent_intf = 0;
 289
 290     /* Initialize locks */
 291     vlc_mutex_init( p_vout, &p_vout->picture_lock );
 292     vlc_mutex_init( p_vout, &p_vout->change_lock );
 293
 294     /* Mouse coordinates */
 295     var_Create( p_vout, "mouse-x", VLC_VAR_INTEGER );
 296     var_Create( p_vout, "mouse-y", VLC_VAR_INTEGER );
 297     var_Create( p_vout, "mouse-button-down", VLC_VAR_INTEGER );
 298     var_Create( p_vout, "mouse-moved", VLC_VAR_BOOL );
 299     var_Create( p_vout, "mouse-clicked", VLC_VAR_INTEGER );
 300
 301     /* Initialize subpicture unit */
 302     p_vout->p_spu = spu_Create( p_vout );
 303     spu_Attach( p_vout->p_spu, p_parent, VLC_TRUE );
 304
 305     /* Attach the new object now so we can use var inheritance below */
 306     vlc_object_attach( p_vout, p_parent );
 307
 308     spu_Init( p_vout->p_spu );
 309
 310     /* Take care of some "interface/control" related initialisations */
 311     vout_IntfInit( p_vout );
 312
 313     p_vout->b_override_aspect = VLC_FALSE;
 314
 315     /* If the parent is not a VOUT object, that means we are at the start of
 316      * the video output pipe */
 317     if( p_parent->i_object_type != VLC_OBJECT_VOUT )
 318     {
 319         var_Get( p_vout, "aspect-ratio", &val );
 320
 321         /* Check whether the user tried to override aspect ratio */
 322         if( val.psz_string )
 323         {
 324             unsigned int i_new_aspect = i_aspect;
 325             char *psz_parser = strchr( val.psz_string, ':' );
 326
 327             if( psz_parser )
 328             {
 329                 *psz_parser++ = '\0';
 330                 i_new_aspect = atoi( val.psz_string ) * VOUT_ASPECT_FACTOR
 331                                                       / atoi( psz_parser );
 332             }
 333             else
 334             {
 335                 i_new_aspect = VOUT_ASPECT_FACTOR
 336                                        * atof( val.psz_string );
 337             }
 338
 339             free( val.psz_string );
 340
 341             if( i_new_aspect && i_new_aspect != i_aspect )
 342             {
 343                 int i_aspect_x, i_aspect_y;
 344
 345                 AspectRatio( i_new_aspect, &i_aspect_x, &i_aspect_y );
 346
 347                 msg_Dbg( p_vout, "overriding source aspect ratio to %i:%i",
 348                          i_aspect_x, i_aspect_y );
 349
 350                 p_vout->render.i_aspect = i_new_aspect;
 351
 352                 p_vout->b_override_aspect = VLC_TRUE;
 353             }
 354         }
 355
 356         /* Look for the default filter configuration */
 357         var_Create( p_vout, "vout-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 358         var_Get( p_vout, "vout-filter", &val );
 359         p_vout->psz_filter_chain = val.psz_string;
 360
 361         if( p_vout->psz_filter_chain && *p_vout->psz_filter_chain &&
 362             strchr( p_vout->psz_filter_chain, ',' ) &&
 363             !strchr( p_vout->psz_filter_chain, ':') )
 364         {
 365             msg_Info( p_vout, "Warning: you are using a deprecated syntax for "
 366                              "vout-filter." );
 367             msg_Info( p_vout, "You must now use ':' as separator instead of "
 368                              "','." );
 369         }
 370     }
 371     else
 372     {
 373         /* continue the parent's filter chain */
 374         char *psz_end;
 375
 376         psz_end = strchr( ((vout_thread_t *)p_parent)->psz_filter_chain, ':' );
 377         if( !psz_end ) psz_end = strchr(
 378                         ((vout_thread_t *)p_parent)->psz_filter_chain, ',' );
 379         if( psz_end && *(psz_end+1) )
 380             p_vout->psz_filter_chain = strdup( psz_end+1 );
 381         else p_vout->psz_filter_chain = NULL;
 382     }
 383
 384     /* Choose the video output module */
 385     if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
 386     {
 387         var_Create( p_vout, "vout", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 388         var_Get( p_vout, "vout", &val );
 389         psz_plugin = val.psz_string;
 390     }
 391     else
 392     {
 393         /* the filter chain is a string list of filters separated by double
 394          * colons */
 395         char *psz_end;
 396
 397         psz_end = strchr( p_vout->psz_filter_chain, ':' );
 398         if( !psz_end ) psz_end = strchr( p_vout->psz_filter_chain, ',' );
 399         if( psz_end )
 400             psz_plugin = strndup( p_vout->psz_filter_chain,
 401                                   psz_end - p_vout->psz_filter_chain );
 402         else psz_plugin = strdup( p_vout->psz_filter_chain );
 403     }
 404
 405     /* Initialize the dimensions of the video window */
 406     InitWindowSize( p_vout, &p_vout->i_window_width,
 407                     &p_vout->i_window_height );
 408
 409     /* Create the vout thread */
 410     p_vout->p_module = module_Need( p_vout,
 411         ( p_vout->psz_filter_chain && *p_vout->psz_filter_chain ) ?
 412         "video filter" : "video output", psz_plugin, 0 );
 413
 414     if( psz_plugin ) free( psz_plugin );
 415     if( p_vout->p_module == NULL )
 416     {
 417         msg_Err( p_vout, "no suitable vout module" );
 418         vlc_object_detach( p_vout );
 419         vlc_object_destroy( p_vout );
 420         return NULL;
 421     }
 422
 423     /* Create a few object variables for interface interaction */
 424     var_Create( p_vout, "deinterlace", VLC_VAR_STRING | VLC_VAR_HASCHOICE );
 425     text.psz_string = _("Deinterlace");
 426     var_Change( p_vout, "deinterlace", VLC_VAR_SETTEXT, &text, NULL );
 427     val.psz_string = ""; text.psz_string = _("Disable");
 428     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 429     val.psz_string = "discard"; text.psz_string = _("Discard");
 430     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 431     val.psz_string = "blend"; text.psz_string = _("Blend");
 432     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 433     val.psz_string = "mean"; text.psz_string = _("Mean");
 434     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 435     val.psz_string = "bob"; text.psz_string = _("Bob");
 436     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 437     val.psz_string = "linear"; text.psz_string = _("Linear");
 438     var_Change( p_vout, "deinterlace", VLC_VAR_ADDCHOICE, &val, &text );
 439     if( var_Get( p_vout, "deinterlace-mode", &val ) == VLC_SUCCESS )
 440     {
 441         var_Set( p_vout, "deinterlace", val );
 442         if( val.psz_string ) free( val.psz_string );
 443     }
 444     var_AddCallback( p_vout, "deinterlace", DeinterlaceCallback, NULL );
 445
 446
 447     var_Create( p_vout, "vout-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 448     text.psz_string = _("Filters");
 449     var_Change( p_vout, "vout-filter", VLC_VAR_SETTEXT, &text, NULL );
 450     var_AddCallback( p_vout, "vout-filter", FilterCallback, NULL );
 451
 452     /* Calculate delay created by internal caching */
 453     p_input_thread = (input_thread_t *)vlc_object_find( p_vout,
 454                                            VLC_OBJECT_INPUT, FIND_ANYWHERE );
 455     if( p_input_thread )
 456     {
 457         p_vout->i_pts_delay = p_input_thread->i_pts_delay;
 458         vlc_object_release( p_input_thread );
 459     }
 460     else
 461     {
 462         p_vout->i_pts_delay = DEFAULT_PTS_DELAY;
 463     }
 464
 465     if( vlc_thread_create( p_vout, "video output", RunThread,
 466                            VLC_THREAD_PRIORITY_OUTPUT, VLC_TRUE ) )
 467     {
 468         msg_Err( p_vout, "out of memory" );
 469         module_Unneed( p_vout, p_vout->p_module );
 470         vlc_object_detach( p_vout );
 471         vlc_object_destroy( p_vout );
 472         return NULL;
 473     }
 474
 475     if( p_vout->b_error )
 476     {
 477         msg_Err( p_vout, "video output creation failed" );
 478
 479         /* Make sure the thread is destroyed */
 480         p_vout->b_die = VLC_TRUE;
 481
 482         vlc_thread_join( p_vout );
 483
 484         vlc_object_detach( p_vout );
 485         vlc_object_destroy( p_vout );
 486         return NULL;
 487     }
 488
 489     return p_vout;
 490 }
 491
 492 /*****************************************************************************
 493  * vout_Destroy: destroys a previously created video output
 494  *****************************************************************************
 495  * Destroy a terminated thread.
 496  * The function will request a destruction of the specified thread. If pi_error
 497  * is NULL, it will return once the thread is destroyed. Else, it will be
 498  * update using one of the THREAD_* constants.
 499  *****************************************************************************/
 500 void vout_Destroy( vout_thread_t *p_vout )
 501 {
 502     vlc_object_t *p_playlist;
 503
 504     /* Request thread destruction */
 505     p_vout->b_die = VLC_TRUE;
 506     vlc_thread_join( p_vout );
 507
 508     var_Destroy( p_vout, "intf-change" );
 509
 510     p_playlist = vlc_object_find( p_vout, VLC_OBJECT_PLAYLIST,
 511                                   FIND_ANYWHERE );
 512
 513     if( p_vout->psz_filter_chain ) free( p_vout->psz_filter_chain );
 514
 515     /* Free structure */
 516     vlc_object_destroy( p_vout );
 517
 518     /* If it was the last vout, tell the interface to show up */
 519     if( p_playlist != NULL )
 520     {
 521         vout_thread_t *p_another_vout = vlc_object_find( p_playlist,
 522                                             VLC_OBJECT_VOUT, FIND_ANYWHERE );
 523         if( p_another_vout == NULL )
 524         {
 525             vlc_value_t val;
 526             val.b_bool = VLC_TRUE;
 527             var_Set( p_playlist, "intf-show", val );
 528         }
 529         else
 530         {
 531             vlc_object_release( p_another_vout );
 532         }
 533         vlc_object_release( p_playlist );
 534     }
 535 }
 536
 537 /*****************************************************************************
 538  * InitThread: initialize video output thread
 539  *****************************************************************************
 540  * This function is called from RunThread and performs the second step of the
 541  * initialization. It returns 0 on success. Note that the thread's flag are not
 542  * modified inside this function.
 543  *****************************************************************************/
 544 static int InitThread( vout_thread_t *p_vout )
 545 {
 546     int i, i_aspect_x, i_aspect_y;
 547
 548     vlc_mutex_lock( &p_vout->change_lock );
 549
 550 #ifdef STATS
 551     p_vout->c_loops = 0;
 552 #endif
 553
 554     /* Initialize output method, it allocates direct buffers for us */
 555     if( p_vout->pf_init( p_vout ) )
 556     {
 557         vlc_mutex_unlock( &p_vout->change_lock );
 558         return VLC_EGENERIC;
 559     }
 560
 561     if( !I_OUTPUTPICTURES )
 562     {
 563         msg_Err( p_vout, "plugin was unable to allocate at least "
 564                          "one direct buffer" );
 565         p_vout->pf_end( p_vout );
 566         vlc_mutex_unlock( &p_vout->change_lock );
 567         return VLC_EGENERIC;
 568     }
 569
 570     if( I_OUTPUTPICTURES > VOUT_MAX_PICTURES )
 571     {
 572         msg_Err( p_vout, "plugin allocated too many direct buffers, "
 573                          "our internal buffers must have overflown." );
 574         p_vout->pf_end( p_vout );
 575         vlc_mutex_unlock( &p_vout->change_lock );
 576         return VLC_EGENERIC;
 577     }
 578
 579     msg_Dbg( p_vout, "got %i direct buffer(s)", I_OUTPUTPICTURES );
 580
 581     AspectRatio( p_vout->fmt_render.i_aspect, &i_aspect_x, &i_aspect_y );
 582
 583     msg_Dbg( p_vout, "picture in %ix%i (%i,%i,%ix%i), "
 584              "chroma %4.4s, ar %i:%i, sar %i:%i",
 585              p_vout->fmt_render.i_width, p_vout->fmt_render.i_height,
 586              p_vout->fmt_render.i_x_offset, p_vout->fmt_render.i_y_offset,
 587              p_vout->fmt_render.i_visible_width,
 588              p_vout->fmt_render.i_visible_height,
 589              (char*)&p_vout->fmt_render.i_chroma,
 590              i_aspect_x, i_aspect_y,
 591              p_vout->fmt_render.i_sar_num, p_vout->fmt_render.i_sar_den );
 592
 593     AspectRatio( p_vout->fmt_in.i_aspect, &i_aspect_x, &i_aspect_y );
 594
 595     msg_Dbg( p_vout, "picture user %ix%i (%i,%i,%ix%i), "
 596              "chroma %4.4s, ar %i:%i, sar %i:%i",
 597              p_vout->fmt_in.i_width, p_vout->fmt_in.i_height,
 598              p_vout->fmt_in.i_x_offset, p_vout->fmt_in.i_y_offset,
 599              p_vout->fmt_in.i_visible_width,
 600              p_vout->fmt_in.i_visible_height,
 601              (char*)&p_vout->fmt_in.i_chroma,
 602              i_aspect_x, i_aspect_y,
 603              p_vout->fmt_in.i_sar_num, p_vout->fmt_in.i_sar_den );
 604
 605     if( !p_vout->fmt_out.i_width || !p_vout->fmt_out.i_height )
 606     {
 607         p_vout->fmt_out.i_width = p_vout->fmt_out.i_visible_width =
 608             p_vout->output.i_width;
 609         p_vout->fmt_out.i_height = p_vout->fmt_out.i_visible_height =
 610             p_vout->output.i_height;
 611         p_vout->fmt_out.i_x_offset =  p_vout->fmt_out.i_y_offset = 0;
 612
 613         p_vout->fmt_out.i_aspect = p_vout->output.i_aspect;
 614         p_vout->fmt_out.i_chroma = p_vout->output.i_chroma;
 615     }
 616     if( !p_vout->fmt_out.i_sar_num || !p_vout->fmt_out.i_sar_num )
 617     {
 618         p_vout->fmt_out.i_sar_num = p_vout->fmt_out.i_aspect *
 619             p_vout->fmt_out.i_height;
 620         p_vout->fmt_out.i_sar_den = VOUT_ASPECT_FACTOR *
 621             p_vout->fmt_out.i_width;
 622     }
 623
 624     vlc_reduce( &p_vout->fmt_out.i_sar_num, &p_vout->fmt_out.i_sar_den,
 625                 p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den, 0 );
 626
 627     AspectRatio( p_vout->fmt_out.i_aspect, &i_aspect_x, &i_aspect_y );
 628
 629     msg_Dbg( p_vout, "picture out %ix%i, chroma %4.4s, ar %i:%i, sar %i:%i",
 630              p_vout->output.i_width, p_vout->output.i_height,
 631              (char*)&p_vout->output.i_chroma,
 632              i_aspect_x, i_aspect_y,
 633              p_vout->fmt_out.i_sar_num, p_vout->fmt_out.i_sar_den );
 634
 635     /* Calculate shifts from system-updated masks */
 636     MaskToShift( &p_vout->output.i_lrshift, &p_vout->output.i_rrshift,
 637                  p_vout->output.i_rmask );
 638     MaskToShift( &p_vout->output.i_lgshift, &p_vout->output.i_rgshift,
 639                  p_vout->output.i_gmask );
 640     MaskToShift( &p_vout->output.i_lbshift, &p_vout->output.i_rbshift,
 641                  p_vout->output.i_bmask );
 642
 643     /* Check whether we managed to create direct buffers similar to
 644      * the render buffers, ie same size and chroma */
 645     if( ( p_vout->output.i_width == p_vout->render.i_width )
 646      && ( p_vout->output.i_height == p_vout->render.i_height )
 647      && ( vout_ChromaCmp( p_vout->output.i_chroma, p_vout->render.i_chroma ) ) )
 648     {
 649         /* Cool ! We have direct buffers, we can ask the decoder to
 650          * directly decode into them ! Map the first render buffers to
 651          * the first direct buffers, but keep the first direct buffer
 652          * for memcpy operations */
 653         p_vout->b_direct = 1;
 654
 655         for( i = 1; i < VOUT_MAX_PICTURES; i++ )
 656         {
 657             if( p_vout->p_picture[ i ].i_type != DIRECT_PICTURE &&
 658                 I_RENDERPICTURES >= VOUT_MIN_DIRECT_PICTURES - 1 &&
 659                 p_vout->p_picture[ i - 1 ].i_type == DIRECT_PICTURE )
 660             {
 661                 /* We have enough direct buffers so there's no need to
 662                  * try to use system memory buffers. */
 663                 break;
 664             }
 665             PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
 666             I_RENDERPICTURES++;
 667         }
 668
 669         msg_Dbg( p_vout, "direct render, mapping "
 670                  "render pictures 0-%i to system pictures 1-%i",
 671                  VOUT_MAX_PICTURES - 2, VOUT_MAX_PICTURES - 1 );
 672     }
 673     else
 674     {
 675         /* Rats... Something is wrong here, we could not find an output
 676          * plugin able to directly render what we decode. See if we can
 677          * find a chroma plugin to do the conversion */
 678         p_vout->b_direct = 0;
 679
 680         /* Choose the best module */
 681         p_vout->chroma.p_module = module_Need( p_vout, "chroma", NULL, 0 );
 682
 683         if( p_vout->chroma.p_module == NULL )
 684         {
 685             msg_Err( p_vout, "no chroma module for %4.4s to %4.4s",
 686                      (char*)&p_vout->render.i_chroma,
 687                      (char*)&p_vout->output.i_chroma );
 688             p_vout->pf_end( p_vout );
 689             vlc_mutex_unlock( &p_vout->change_lock );
 690             return VLC_EGENERIC;
 691         }
 692
 693         msg_Dbg( p_vout, "indirect render, mapping "
 694                  "render pictures 0-%i to system pictures %i-%i",
 695                  VOUT_MAX_PICTURES - 1, I_OUTPUTPICTURES,
 696                  I_OUTPUTPICTURES + VOUT_MAX_PICTURES - 1 );
 697
 698         /* Append render buffers after the direct buffers */
 699         for( i = I_OUTPUTPICTURES; i < 2 * VOUT_MAX_PICTURES; i++ )
 700         {
 701             PP_RENDERPICTURE[ I_RENDERPICTURES ] = &p_vout->p_picture[ i ];
 702             I_RENDERPICTURES++;
 703
 704             /* Check if we have enough render pictures */
 705             if( I_RENDERPICTURES == VOUT_MAX_PICTURES )
 706                 break;
 707         }
 708     }
 709
 710     /* Link pictures back to their heap */
 711     for( i = 0 ; i < I_RENDERPICTURES ; i++ )
 712     {
 713         PP_RENDERPICTURE[ i ]->p_heap = &p_vout->render;
 714     }
 715
 716     for( i = 0 ; i < I_OUTPUTPICTURES ; i++ )
 717     {
 718         PP_OUTPUTPICTURE[ i ]->p_heap = &p_vout->output;
 719     }
 720
 721 /* XXX XXX mark thread ready */
 722     return VLC_SUCCESS;
 723 }
 724
 725 /*****************************************************************************
 726  * RunThread: video output thread
 727  *****************************************************************************
 728  * Video output thread. This function does only returns when the thread is
 729  * terminated. It handles the pictures arriving in the video heap and the
 730  * display device events.
 731  *****************************************************************************/
 732 static void RunThread( vout_thread_t *p_vout)
 733 {
 734     int             i_index;                                /* index in heap */
 735     int             i_idle_loops = 0;  /* loops without displaying a picture */
 736     mtime_t         current_date;                            /* current date */
 737     mtime_t         display_date;                            /* display date */
 738
 739     picture_t *     p_picture;                            /* picture pointer */
 740     picture_t *     p_last_picture = NULL;                   /* last picture */
 741     picture_t *     p_directbuffer;              /* direct buffer to display */
 742
 743     subpicture_t *  p_subpic;                          /* subpicture pointer */
 744
 745     /*
 746      * Initialize thread
 747      */
 748     p_vout->b_error = InitThread( p_vout );
 749
 750     /* signal the creation of the vout */
 751     vlc_thread_ready( p_vout );
 752
 753     if( p_vout->b_error )
 754     {
 755         /* Destroy thread structures allocated by Create and InitThread */
 756         DestroyThread( p_vout );
 757         return;
 758     }
 759
 760     /*
 761      * Main loop - it is not executed if an error occurred during
 762      * initialization
 763      */
 764     while( (!p_vout->b_die) && (!p_vout->b_error) )
 765     {
 766         /* Initialize loop variables */
 767         p_picture = NULL;
 768         display_date = 0;
 769         current_date = mdate();
 770
 771 #if 0
 772         p_vout->c_loops++;
 773         if( !(p_vout->c_loops % VOUT_STATS_NB_LOOPS) )
 774         {
 775             msg_Dbg( p_vout, "picture heap: %d/%d",
 776                      I_RENDERPICTURES, p_vout->i_heap_size );
 777         }
 778 #endif
 779
 780         /*
 781          * Find the picture to display (the one with the earliest date).
 782          * This operation does not need lock, since only READY_PICTUREs
 783          * are handled. */
 784         for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
 785         {
 786             if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
 787                 && ( (p_picture == NULL) ||
 788                      (PP_RENDERPICTURE[i_index]->date < display_date) ) )
 789             {
 790                 p_picture = PP_RENDERPICTURE[i_index];
 791                 display_date = p_picture->date;
 792             }
 793         }
 794
 795         if( p_picture )
 796         {
 797             /* If we met the last picture, parse again to see whether there is
 798              * a more appropriate one. */
 799             if( p_picture == p_last_picture )
 800             {
 801                 for( i_index = 0; i_index < I_RENDERPICTURES; i_index++ )
 802                 {
 803                     if( (PP_RENDERPICTURE[i_index]->i_status == READY_PICTURE)
 804                         && (PP_RENDERPICTURE[i_index] != p_last_picture)
 805                         && ((p_picture == p_last_picture) ||
 806                             (PP_RENDERPICTURE[i_index]->date < display_date)) )
 807                     {
 808                         p_picture = PP_RENDERPICTURE[i_index];
 809                         display_date = p_picture->date;
 810                     }
 811                 }
 812             }
 813
 814             /* If we found better than the last picture, destroy it */
 815             if( p_last_picture && p_picture != p_last_picture )
 816             {
 817                 vlc_mutex_lock( &p_vout->picture_lock );
 818                 if( p_last_picture->i_refcount )
 819                 {
 820                     p_last_picture->i_status = DISPLAYED_PICTURE;
 821                 }
 822                 else
 823                 {
 824                     p_last_picture->i_status = DESTROYED_PICTURE;
 825                     p_vout->i_heap_size--;
 826                 }
 827                 vlc_mutex_unlock( &p_vout->picture_lock );
 828                 p_last_picture = NULL;
 829             }
 830
 831             /* Compute FPS rate */
 832             p_vout->p_fps_sample[ p_vout->c_fps_samples++ % VOUT_FPS_SAMPLES ]
 833                 = display_date;
 834
 835             if( !p_picture->b_force &&
 836                 p_picture != p_last_picture &&
 837                 display_date < current_date + p_vout->render_time )
 838             {
 839                 /* Picture is late: it will be destroyed and the thread
 840                  * will directly choose the next picture */
 841                 vlc_mutex_lock( &p_vout->picture_lock );
 842                 if( p_picture->i_refcount )
 843                 {
 844                     /* Pretend we displayed the picture, but don't destroy
 845                      * it since the decoder might still need it. */
 846                     p_picture->i_status = DISPLAYED_PICTURE;
 847                 }
 848                 else
 849                 {
 850                     /* Destroy the picture without displaying it */
 851                     p_picture->i_status = DESTROYED_PICTURE;
 852                     p_vout->i_heap_size--;
 853                 }
 854                 msg_Warn( p_vout, "late picture skipped ("I64Fd")",
 855                                   current_date - display_date );
 856                 vlc_mutex_unlock( &p_vout->picture_lock );
 857
 858                 continue;
 859             }
 860
 861             if( display_date >
 862                 current_date + p_vout->i_pts_delay + VOUT_BOGUS_DELAY )
 863             {
 864                 /* Picture is waaay too early: it will be destroyed */
 865                 vlc_mutex_lock( &p_vout->picture_lock );
 866                 if( p_picture->i_refcount )
 867                 {
 868                     /* Pretend we displayed the picture, but don't destroy
 869                      * it since the decoder might still need it. */
 870                     p_picture->i_status = DISPLAYED_PICTURE;
 871                 }
 872                 else
 873                 {
 874                     /* Destroy the picture without displaying it */
 875                     p_picture->i_status = DESTROYED_PICTURE;
 876                     p_vout->i_heap_size--;
 877                 }
 878                 msg_Warn( p_vout, "vout warning: early picture skipped "
 879                           "("I64Fd")", display_date - current_date
 880                           - p_vout->i_pts_delay );
 881                 vlc_mutex_unlock( &p_vout->picture_lock );
 882
 883                 continue;
 884             }
 885
 886             if( display_date > current_date + VOUT_DISPLAY_DELAY )
 887             {
 888                 /* A picture is ready to be rendered, but its rendering date
 889                  * is far from the current one so the thread will perform an
 890                  * empty loop as if no picture were found. The picture state
 891                  * is unchanged */
 892                 p_picture    = NULL;
 893                 display_date = 0;
 894             }
 895             else if( p_picture == p_last_picture )
 896             {
 897                 /* We are asked to repeat the previous picture, but we first
 898                  * wait for a couple of idle loops */
 899                 if( i_idle_loops < 4 )
 900                 {
 901                     p_picture    = NULL;
 902                     display_date = 0;
 903                 }
 904                 else
 905                 {
 906                     /* We set the display date to something high, otherwise
 907                      * we'll have lots of problems with late pictures */
 908                     display_date = current_date + p_vout->render_time;
 909                 }
 910             }
 911         }
 912
 913         if( p_picture == NULL )
 914         {
 915             i_idle_loops++;
 916         }
 917
 918         if( p_picture && p_vout->b_snapshot )
 919         {
 920             p_vout->b_snapshot = VLC_FALSE;
 921             vout_Snapshot( p_vout, p_picture );
 922         }
 923
 924         /*
 925          * Check for subpictures to display
 926          */
 927         p_subpic = spu_SortSubpictures( p_vout->p_spu, display_date );
 928
 929         /*
 930          * Perform rendering
 931          */
 932         p_directbuffer = vout_RenderPicture( p_vout, p_picture, p_subpic );
 933
 934         /*
 935          * Call the plugin-specific rendering method if there is one
 936          */
 937         if( p_picture != NULL && p_directbuffer != NULL && p_vout->pf_render )
 938         {
 939             /* Render the direct buffer returned by vout_RenderPicture */
 940             p_vout->pf_render( p_vout, p_directbuffer );
 941         }
 942
 943         /*
 944          * Sleep, wake up
 945          */
 946         if( display_date != 0 && p_directbuffer != NULL )
 947         {
 948             mtime_t current_render_time = mdate() - current_date;
 949             /* if render time is very large we don't include it in the mean */
 950             if( current_render_time < p_vout->render_time +
 951                 VOUT_DISPLAY_DELAY )
 952             {
 953                 /* Store render time using a sliding mean weighting to
 954                  * current value in a 3 to 1 ratio*/
 955                 p_vout->render_time *= 3;
 956                 p_vout->render_time += current_render_time;
 957                 p_vout->render_time >>= 2;
 958             }
 959         }
 960
 961         /* Give back change lock */
 962         vlc_mutex_unlock( &p_vout->change_lock );
 963
 964         /* Sleep a while or until a given date */
 965         if( display_date != 0 )
 966         {
 967             /* If there are filters in the chain, better give them the picture
 968              * in advance */
 969             if( !p_vout->psz_filter_chain || !*p_vout->psz_filter_chain )
 970             {
 971                 mwait( display_date - VOUT_MWAIT_TOLERANCE );
 972             }
 973         }
 974         else
 975         {
 976             msleep( VOUT_IDLE_SLEEP );
 977         }
 978
 979         /* On awakening, take back lock and send immediately picture
 980          * to display. */
 981         vlc_mutex_lock( &p_vout->change_lock );
 982
 983         /*
 984          * Display the previously rendered picture
 985          */
 986         if( p_picture != NULL && p_directbuffer != NULL )
 987         {
 988             /* Display the direct buffer returned by vout_RenderPicture */
 989             if( p_vout->pf_display )
 990             {
 991                 p_vout->pf_display( p_vout, p_directbuffer );
 992             }
 993
 994             /* Tell the vout this was the last picture and that it does not
 995              * need to be forced anymore. */
 996             p_last_picture = p_picture;
 997             p_last_picture->b_force = 0;
 998         }
 999
1000         if( p_picture != NULL )
1001         {
1002             /* Reinitialize idle loop count */
1003             i_idle_loops = 0;
1004         }
1005
1006         /*
1007          * Check events and manage thread
1008          */
1009         if( p_vout->pf_manage && p_vout->pf_manage( p_vout ) )
1010         {
1011             /* A fatal error occurred, and the thread must terminate
1012              * immediately, without displaying anything - setting b_error to 1
1013              * causes the immediate end of the main while() loop. */
1014             p_vout->b_error = 1;
1015         }
1016
1017         if( p_vout->i_changes & VOUT_SIZE_CHANGE )
1018         {
1019             /* this must only happen when the vout plugin is incapable of
1020              * rescaling the picture itself. In this case we need to destroy
1021              * the current picture buffers and recreate new ones with the right
1022              * dimensions */
1023             int i;
1024
1025             p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
1026
1027             p_vout->pf_end( p_vout );
1028             for( i = 0; i < I_OUTPUTPICTURES; i++ )
1029                  p_vout->p_picture[ i ].i_status = FREE_PICTURE;
1030
1031             I_OUTPUTPICTURES = 0;
1032             if( p_vout->pf_init( p_vout ) )
1033             {
1034                 msg_Err( p_vout, "cannot resize display" );
1035                 /* FIXME: pf_end will be called again in EndThread() */
1036                 p_vout->b_error = 1;
1037             }
1038
1039             /* Need to reinitialise the chroma plugin */
1040             if( p_vout->chroma.p_module )
1041             {
1042                 if( p_vout->chroma.p_module->pf_deactivate )
1043                     p_vout->chroma.p_module->pf_deactivate( VLC_OBJECT(p_vout) );
1044                 p_vout->chroma.p_module->pf_activate( VLC_OBJECT(p_vout) );
1045             }
1046         }
1047
1048         if( p_vout->i_changes & VOUT_PICTURE_BUFFERS_CHANGE )
1049         {
1050             /* This happens when the picture buffers need to be recreated.
1051              * This is useful on multimonitor displays for instance.
1052              *
1053              * Warning: This only works when the vout creates only 1 picture
1054              * buffer!! */
1055             p_vout->i_changes &= ~VOUT_PICTURE_BUFFERS_CHANGE;
1056
1057             if( !p_vout->b_direct )
1058             {
1059                 module_Unneed( p_vout, p_vout->chroma.p_module );
1060             }
1061
1062             vlc_mutex_lock( &p_vout->picture_lock );
1063
1064             p_vout->pf_end( p_vout );
1065
1066             I_OUTPUTPICTURES = I_RENDERPICTURES = 0;
1067
1068             p_vout->b_error = InitThread( p_vout );
1069
1070             vlc_mutex_unlock( &p_vout->picture_lock );
1071         }
1072     }
1073
1074     /*
1075      * Error loop - wait until the thread destruction is requested
1076      */
1077     if( p_vout->b_error )
1078     {
1079         ErrorThread( p_vout );
1080     }
1081
1082     /* End of thread */
1083     EndThread( p_vout );
1084
1085     /* Destroy thread structures allocated by CreateThread */
1086     DestroyThread( p_vout );
1087 }
1088
1089 /*****************************************************************************
1090  * ErrorThread: RunThread() error loop
1091  *****************************************************************************
1092  * This function is called when an error occurred during thread main's loop.
1093  * The thread can still receive feed, but must be ready to terminate as soon
1094  * as possible.
1095  *****************************************************************************/
1096 static void ErrorThread( vout_thread_t *p_vout )
1097 {
1098     /* Wait until a `die' order */
1099     while( !p_vout->b_die )
1100     {
1101         /* Sleep a while */
1102         msleep( VOUT_IDLE_SLEEP );
1103     }
1104 }
1105
1106 /*****************************************************************************
1107  * EndThread: thread destruction
1108  *****************************************************************************
1109  * This function is called when the thread ends after a sucessful
1110  * initialization. It frees all resources allocated by InitThread.
1111  *****************************************************************************/
1112 static void EndThread( vout_thread_t *p_vout )
1113 {
1114     int     i_index;                                        /* index in heap */
1115
1116 #ifdef STATS
1117     {
1118         struct tms cpu_usage;
1119         times( &cpu_usage );
1120
1121         msg_Dbg( p_vout, "cpu usage (user: %d, system: %d)",
1122                  cpu_usage.tms_utime, cpu_usage.tms_stime );
1123     }
1124 #endif
1125
1126     if( !p_vout->b_direct )
1127     {
1128         module_Unneed( p_vout, p_vout->chroma.p_module );
1129     }
1130
1131     /* Destroy all remaining pictures */
1132     for( i_index = 0; i_index < 2 * VOUT_MAX_PICTURES + 1; i_index++ )
1133     {
1134         if ( p_vout->p_picture[i_index].i_type == MEMORY_PICTURE )
1135         {
1136             free( p_vout->p_picture[i_index].p_data_orig );
1137         }
1138     }
1139
1140     /* Destroy subpicture unit */
1141     spu_Attach( p_vout->p_spu, VLC_OBJECT(p_vout), VLC_FALSE );
1142     spu_Destroy( p_vout->p_spu );
1143
1144     /* Destroy translation tables */
1145     p_vout->pf_end( p_vout );
1146
1147     /* Release the change lock */
1148     vlc_mutex_unlock( &p_vout->change_lock );
1149 }
1150
1151 /*****************************************************************************
1152  * DestroyThread: thread destruction
1153  *****************************************************************************
1154  * This function is called when the thread ends. It frees all ressources
1155  * allocated by CreateThread. Status is available at this stage.
1156  *****************************************************************************/
1157 static void DestroyThread( vout_thread_t *p_vout )
1158 {
1159     /* Destroy the locks */
1160     vlc_mutex_destroy( &p_vout->picture_lock );
1161     vlc_mutex_destroy( &p_vout->change_lock );
1162
1163     /* Release the module */
1164     if( p_vout && p_vout->p_module )
1165     {
1166         module_Unneed( p_vout, p_vout->p_module );
1167     }
1168 }
1169
1170 /* following functions are local */
1171
1172 static int ReduceHeight( int i_ratio )
1173 {
1174     int i_dummy = VOUT_ASPECT_FACTOR;
1175     int i_pgcd  = 1;
1176
1177     if( !i_ratio )
1178     {
1179         return i_pgcd;
1180     }
1181
1182     /* VOUT_ASPECT_FACTOR is (2^7 * 3^3 * 5^3), we just check for 2, 3 and 5 */
1183     while( !(i_ratio & 1) && !(i_dummy & 1) )
1184     {
1185         i_ratio >>= 1;
1186         i_dummy >>= 1;
1187         i_pgcd  <<= 1;
1188     }
1189
1190     while( !(i_ratio % 3) && !(i_dummy % 3) )
1191     {
1192         i_ratio /= 3;
1193         i_dummy /= 3;
1194         i_pgcd  *= 3;
1195     }
1196
1197     while( !(i_ratio % 5) && !(i_dummy % 5) )
1198     {
1199         i_ratio /= 5;
1200         i_dummy /= 5;
1201         i_pgcd  *= 5;
1202     }
1203
1204     return i_pgcd;
1205 }
1206
1207 static void AspectRatio( int i_aspect, int *i_aspect_x, int *i_aspect_y )
1208 {
1209     unsigned int i_pgcd = ReduceHeight( i_aspect );
1210     *i_aspect_x = i_aspect / i_pgcd;
1211     *i_aspect_y = VOUT_ASPECT_FACTOR / i_pgcd;
1212 }
1213
1214 /*****************************************************************************
1215  * BinaryLog: computes the base 2 log of a binary value
1216  *****************************************************************************
1217  * This functions is used by MaskToShift, to get a bit index from a binary
1218  * value.
1219  *****************************************************************************/
1220 static int BinaryLog( uint32_t i )
1221 {
1222     int i_log = 0;
1223
1224     if( i == 0 ) return -31337;
1225
1226     if( i & 0xffff0000 ) i_log += 16;
1227     if( i & 0xff00ff00 ) i_log += 8;
1228     if( i & 0xf0f0f0f0 ) i_log += 4;
1229     if( i & 0xcccccccc ) i_log += 2;
1230     if( i & 0xaaaaaaaa ) i_log += 1;
1231
1232     return i_log;
1233 }
1234
1235 /*****************************************************************************
1236  * MaskToShift: transform a color mask into right and left shifts
1237  *****************************************************************************
1238  * This function is used for obtaining color shifts from masks.
1239  *****************************************************************************/
1240 static void MaskToShift( int *pi_left, int *pi_right, uint32_t i_mask )
1241 {
1242     uint32_t i_low, i_high;            /* lower hand higher bits of the mask */
1243
1244     if( !i_mask )
1245     {
1246         *pi_left = *pi_right = 0;
1247         return;
1248     }
1249
1250     /* Get bits */
1251     i_low =  i_mask & (- (int32_t)i_mask);          /* lower bit of the mask */
1252     i_high = i_mask + i_low;                       /* higher bit of the mask */
1253
1254     /* Transform bits into an index */
1255     i_low =  BinaryLog (i_low);
1256     i_high = BinaryLog (i_high);
1257
1258     /* Update pointers and return */
1259     *pi_left =   i_low;
1260     *pi_right = (8 - i_high + i_low);
1261 }
1262
1263 /*****************************************************************************
1264  * InitWindowSize: find the initial dimensions the video window should have.
1265  *****************************************************************************
1266  * This function will check the "width", "height" and "zoom" config options and
1267  * will calculate the size that the video window should have.
1268  *****************************************************************************/
1269 static void InitWindowSize( vout_thread_t *p_vout, int *pi_width,
1270                             int *pi_height )
1271 {
1272     vlc_value_t val;
1273     int i_width, i_height;
1274     uint64_t ll_zoom;
1275
1276 #define FP_FACTOR 1000                             /* our fixed point factor */
1277
1278     var_Get( p_vout, "align", &val );
1279     p_vout->i_alignment = val.i_int;
1280
1281     var_Get( p_vout, "width", &val );
1282     i_width = val.i_int;
1283     var_Get( p_vout, "height", &val );
1284     i_height = val.i_int;
1285     var_Get( p_vout, "zoom", &val );
1286     ll_zoom = (uint64_t)( FP_FACTOR * val.f_float );
1287
1288     if( i_width > 0 && i_height > 0)
1289     {
1290         *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
1291         *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
1292         return;
1293     }
1294     else if( i_width > 0 )
1295     {
1296         *pi_width = (int)( i_width * ll_zoom / FP_FACTOR );
1297         *pi_height = (int)( i_width * ll_zoom * VOUT_ASPECT_FACTOR /
1298                             p_vout->render.i_aspect / FP_FACTOR );
1299         return;
1300     }
1301     else if( i_height > 0 )
1302     {
1303         *pi_height = (int)( i_height * ll_zoom / FP_FACTOR );
1304         *pi_width = (int)( i_height * ll_zoom * p_vout->render.i_aspect /
1305                            VOUT_ASPECT_FACTOR / FP_FACTOR );
1306         return;
1307     }
1308
1309     if( p_vout->render.i_height * p_vout->render.i_aspect
1310         >= p_vout->render.i_width * VOUT_ASPECT_FACTOR )
1311     {
1312         *pi_width = (int)( p_vout->render.i_height * ll_zoom
1313           * p_vout->render.i_aspect / VOUT_ASPECT_FACTOR / FP_FACTOR );
1314         *pi_height = (int)( p_vout->render.i_height * ll_zoom / FP_FACTOR );
1315     }
1316     else
1317     {
1318         *pi_width = (int)( p_vout->render.i_width * ll_zoom / FP_FACTOR );
1319         *pi_height = (int)( p_vout->render.i_width * ll_zoom
1320           * VOUT_ASPECT_FACTOR / p_vout->render.i_aspect / FP_FACTOR );
1321     }
1322
1323 #undef FP_FACTOR
1324 }
1325
1326 /*****************************************************************************
1327  * vout_VarCallback: generic callback for intf variables
1328  *****************************************************************************/
1329 int vout_VarCallback( vlc_object_t * p_this, const char * psz_variable,
1330                       vlc_value_t old_value, vlc_value_t new_value,
1331                       void * unused )
1332 {
1333     vout_thread_t * p_vout = (vout_thread_t *)p_this;
1334     vlc_value_t val;
1335     val.b_bool = VLC_TRUE;
1336     var_Set( p_vout, "intf-change", val );
1337     return VLC_SUCCESS;
1338 }
1339
1340 /*****************************************************************************
1341  * Helper thread for object variables callbacks.
1342  * Only used to avoid deadlocks when using the video embedded mode.
1343  *****************************************************************************/
1344 typedef struct suxor_thread_t
1345 {
1346     VLC_COMMON_MEMBERS
1347     input_thread_t *p_input;
1348
1349 } suxor_thread_t;
1350
1351 static void SuxorRestartVideoES( suxor_thread_t *p_this )
1352 {
1353     vlc_value_t val;
1354
1355     vlc_thread_ready( p_this );
1356
1357     /* Now restart current video stream */
1358     var_Get( p_this->p_input, "video-es", &val );
1359     if( val.i_int >= 0 )
1360     {
1361         vlc_value_t val_es;
1362         val_es.i_int = -VIDEO_ES;
1363         var_Set( p_this->p_input, "video-es", val_es );
1364         var_Set( p_this->p_input, "video-es", val );
1365     }
1366
1367     vlc_object_release( p_this->p_input );
1368
1369 #ifdef WIN32
1370     CloseHandle( p_this->thread_id );
1371 #endif
1372
1373     vlc_object_destroy( p_this );
1374 }
1375
1376 /*****************************************************************************
1377  * object variables callbacks: a bunch of object variables are used by the
1378  * interfaces to interact with the vout.
1379  *****************************************************************************/
1380 static int DeinterlaceCallback( vlc_object_t *p_this, char const *psz_cmd,
1381                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
1382 {
1383     vout_thread_t *p_vout = (vout_thread_t *)p_this;
1384     input_thread_t *p_input;
1385     vlc_value_t val;
1386
1387     char *psz_mode = newval.psz_string;
1388     char *psz_filter, *psz_deinterlace = NULL;
1389
1390     var_Get( p_vout, "vout-filter", &val );
1391     psz_filter = val.psz_string;
1392     if( psz_filter ) psz_deinterlace = strstr( psz_filter, "deinterlace" );
1393
1394     if( !psz_mode || !*psz_mode )
1395     {
1396         if( psz_deinterlace )
1397         {
1398             char *psz_src = psz_deinterlace + sizeof("deinterlace") - 1;
1399             if( psz_src[0] == ':' ) psz_src++;
1400             memmove( psz_deinterlace, psz_src, strlen(psz_src) + 1 );
1401         }
1402     }
1403     else if( !psz_deinterlace )
1404     {
1405         psz_filter = realloc( psz_filter, strlen( psz_filter ) +
1406                               sizeof(":deinterlace") );
1407         if( psz_filter && *psz_filter ) strcat( psz_filter, ":" );
1408         strcat( psz_filter, "deinterlace" );
1409     }
1410
1411     p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1412                                                  FIND_PARENT );
1413     if( !p_input ) return VLC_EGENERIC;
1414
1415     if( psz_mode && *psz_mode )
1416     {
1417         /* Modify input as well because the vout might have to be restarted */
1418         val.psz_string = psz_mode;
1419         var_Create( p_input, "deinterlace-mode", VLC_VAR_STRING );
1420         var_Set( p_input, "deinterlace-mode", val );
1421     }
1422     vlc_object_release( p_input );
1423
1424     val.b_bool = VLC_TRUE;
1425     var_Set( p_vout, "intf-change", val );
1426
1427     val.psz_string = psz_filter;
1428     var_Set( p_vout, "vout-filter", val );
1429     if( psz_filter ) free( psz_filter );
1430
1431     return VLC_SUCCESS;
1432 }
1433
1434 static int FilterCallback( vlc_object_t *p_this, char const *psz_cmd,
1435                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
1436 {
1437     vout_thread_t *p_vout = (vout_thread_t *)p_this;
1438     input_thread_t *p_input;
1439     vlc_value_t val;
1440
1441     p_input = (input_thread_t *)vlc_object_find( p_this, VLC_OBJECT_INPUT,
1442                                                  FIND_PARENT );
1443     if (!p_input)
1444     {
1445         msg_Err( p_vout, "Input not found" );
1446         return( VLC_EGENERIC );
1447     }
1448
1449     val.b_bool = VLC_TRUE;
1450     var_Set( p_vout, "intf-change", val );
1451
1452     /* Modify input as well because the vout might have to be restarted */
1453     val.psz_string = newval.psz_string;
1454     var_Create( p_input, "vout-filter", VLC_VAR_STRING );
1455
1456     var_Set( p_input, "vout-filter", val );
1457
1458     /* Now restart current video stream */
1459     var_Get( p_input, "video-es", &val );
1460     if( val.i_int >= 0 )
1461     {
1462         suxor_thread_t *p_suxor =
1463             vlc_object_create( p_vout, sizeof(suxor_thread_t) );
1464         p_suxor->p_input = p_input;
1465         p_vout->b_filter_change = VLC_TRUE;
1466         vlc_object_yield( p_input );
1467         vlc_thread_create( p_suxor, "suxor", SuxorRestartVideoES,
1468                            VLC_THREAD_PRIORITY_LOW, VLC_FALSE );
1469     }
1470
1471     vlc_object_release( p_input );
1472
1473     return VLC_SUCCESS;
1474 }