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