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

   1 /*****************************************************************************
   2  * video_output.c : video output thread
   3  * This module describes the programming interface for video output threads.
   4  * It includes functions allowing to open a new thread, send pictures to a
   5  * thread, and destroy a previously oppened video output thread.
   6  *****************************************************************************
   7  * Copyright (C) 2000 VideoLAN
   8  *
   9  * Authors:
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  24  *****************************************************************************/
  25
  26 /*****************************************************************************
  27  * Preamble
  28  *****************************************************************************/
  29 #include "defs.h"
  30
  31 #include <errno.h>                                                 /* ENOMEM */
  32 #include <stdlib.h>                                                /* free() */
  33 #include <stdio.h>                                              /* sprintf() */
  34 #include <string.h>                                            /* strerror() */
  35
  36 #ifdef STATS
  37 #   include <sys/times.h>
  38 #endif
  39
  40 #include "config.h"
  41 #include "common.h"
  42 #include "threads.h"
  43 #include "mtime.h"
  44 #include "modules.h"
  45
  46 #include "video.h"
  47 #include "video_output.h"
  48 #include "video_text.h"
  49 #include "video_spu.h"
  50 #include "video_yuv.h"
  51
  52 #include "intf_msg.h"
  53
  54 #include "main.h"
  55
  56 /*****************************************************************************
  57  * Local prototypes
  58  *****************************************************************************/
  59 static int      BinaryLog         ( u32 i );
  60 static void     MaskToShift       ( int *pi_left, int *pi_right, u32 i_mask );
  61 static int      InitThread        ( vout_thread_t *p_vout );
  62 static void     RunThread         ( vout_thread_t *p_vout );
  63 static void     ErrorThread       ( vout_thread_t *p_vout );
  64 static void     EndThread         ( vout_thread_t *p_vout );
  65 static void     DestroyThread     ( vout_thread_t *p_vout, int i_status );
  66 static void     Print             ( vout_thread_t *p_vout, int i_x, int i_y,
  67                                     int i_h_align, int i_v_align,
  68                                     unsigned char *psz_text );
  69 static void     SetBufferArea     ( vout_thread_t *p_vout, int i_x, int i_y,
  70                                     int i_w, int i_h );
  71 static void     SetBufferPicture  ( vout_thread_t *p_vout, picture_t *p_pic );
  72 static void     RenderPicture     ( vout_thread_t *p_vout, picture_t *p_pic );
  73 static void     RenderPictureInfo ( vout_thread_t *p_vout, picture_t *p_pic );
  74 static void     RenderSubPicture  ( vout_thread_t *p_vout,
  75                                     subpicture_t *p_subpic );
  76 static void     RenderInterface   ( vout_thread_t *p_vout );
  77 static int      RenderIdle        ( vout_thread_t *p_vout );
  78 static int      RenderSplash      ( vout_thread_t *p_vout );
  79 static void     RenderInfo        ( vout_thread_t *p_vout );
  80 static int      Manage            ( vout_thread_t *p_vout );
  81 static int      Align             ( vout_thread_t *p_vout, int *pi_x,
  82                                     int *pi_y, int i_width, int i_height,
  83                                     int i_h_align, int i_v_align );
  84 static void     SetPalette        ( p_vout_thread_t p_vout, u16 *red,
  85                                     u16 *green, u16 *blue, u16 *transp );
  86
  87 /*****************************************************************************
  88  * vout_CreateThread: creates a new video output thread
  89  *****************************************************************************
  90  * This function creates a new video output thread, and returns a pointer
  91  * to its description. On error, it returns NULL.
  92  * If pi_status is NULL, then the function will block until the thread is ready.
  93  * If not, it will be updated using one of the THREAD_* constants.
  94  *****************************************************************************/
  95 vout_thread_t * vout_CreateThread   ( int *pi_status )
  96 {
  97     vout_thread_t * p_vout;                             /* thread descriptor */
  98     int             i_status;                               /* thread status */
  99     int             i_index;               /* index for array initialization */
 100
 101     /* Allocate descriptor */
 102     p_vout = (vout_thread_t *) malloc( sizeof(vout_thread_t) );
 103     if( p_vout == NULL )
 104     {
 105         intf_ErrMsg( "vout error: vout thread creation returned %s",
 106                      strerror(ENOMEM) );
 107         return( NULL );
 108     }
 109
 110     /* Choose the best module */
 111     p_vout->p_module = module_Need( p_main->p_bank,
 112                                     MODULE_CAPABILITY_VOUT, NULL );
 113
 114     if( p_vout->p_module == NULL )
 115     {
 116         intf_ErrMsg( "vout error: no suitable vout module" );
 117         free( p_vout );
 118         return( NULL );
 119     }
 120
 121 #define f p_vout->p_module->p_functions->vout.functions.vout
 122     p_vout->pf_create     = f.pf_create;
 123     p_vout->pf_init       = f.pf_init;
 124     p_vout->pf_end        = f.pf_end;
 125     p_vout->pf_destroy    = f.pf_destroy;
 126     p_vout->pf_manage     = f.pf_manage;
 127     p_vout->pf_display    = f.pf_display;
 128     p_vout->pf_setpalette = f.pf_setpalette;
 129 #undef f
 130
 131     if( p_vout->pf_setpalette == NULL )
 132     {
 133         p_vout->pf_setpalette = SetPalette;
 134     }
 135
 136     /* Initialize thread properties - thread id and locks will be initialized
 137      * later */
 138     p_vout->b_die               = 0;
 139     p_vout->b_error             = 0;
 140     p_vout->b_active            = 0;
 141     p_vout->pi_status           = (pi_status != NULL) ? pi_status : &i_status;
 142     *p_vout->pi_status          = THREAD_CREATE;
 143
 144     /* Initialize some fields used by the system-dependant method - these
 145      * fields will probably be modified by the method, and are only
 146      * preferences */
 147     p_vout->i_changes             = 0;
 148     p_vout->i_width               = main_GetIntVariable( VOUT_WIDTH_VAR,
 149                                                          VOUT_WIDTH_DEFAULT );
 150     p_vout->i_height              = main_GetIntVariable( VOUT_HEIGHT_VAR,
 151                                                          VOUT_HEIGHT_DEFAULT );
 152     p_vout->i_bytes_per_line      = p_vout->i_width * 2;
 153     p_vout->i_screen_depth        = 15;
 154     p_vout->i_bytes_per_pixel     = 2;
 155     p_vout->f_gamma               = VOUT_GAMMA;
 156     p_vout->b_need_render         = 1;
 157
 158     p_vout->b_grayscale           = main_GetIntVariable( VOUT_GRAYSCALE_VAR,
 159                                                      VOUT_GRAYSCALE_DEFAULT );
 160     p_vout->b_info                = 0;
 161     p_vout->b_interface           = 0;
 162     p_vout->b_scale               = 1;
 163
 164     intf_WarnMsg( 1, "wished configuration: %dx%d, %d/%d bpp (%d Bpl)",
 165                   p_vout->i_width, p_vout->i_height, p_vout->i_screen_depth,
 166                   p_vout->i_bytes_per_pixel * 8, p_vout->i_bytes_per_line );
 167
 168     /* Initialize idle screen */
 169     p_vout->last_display_date   = 0;
 170     p_vout->last_idle_date      = 0;
 171     p_vout->init_display_date   = mdate();
 172     p_vout->render_time         = 10000;
 173
 174     /* Initialize statistics fields */
 175     p_vout->c_fps_samples       = 0;
 176
 177     /* Initialize buffer index */
 178     p_vout->i_buffer_index      = 0;
 179
 180     /* Initialize pictures and subpictures - translation tables and functions
 181      * will be initialized later in InitThread */
 182     for( i_index = 0; i_index < VOUT_MAX_PICTURES; i_index++)
 183     {
 184         p_vout->p_picture[i_index].i_type   =   EMPTY_PICTURE;
 185         p_vout->p_picture[i_index].i_status =   FREE_PICTURE;
 186     }
 187     for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++)
 188     {
 189         p_vout->p_subpicture[i_index].i_type  = EMPTY_SUBPICTURE;
 190         p_vout->p_subpicture[i_index].i_status= FREE_SUBPICTURE;
 191     }
 192     p_vout->i_pictures = 0;
 193
 194     /* Create and initialize system-dependant method - this function issues its
 195      * own error messages */
 196     if( p_vout->pf_create( p_vout ) )
 197     {
 198         module_Unneed( p_main->p_bank, p_vout->p_module );
 199         free( p_vout );
 200         return( NULL );
 201     }
 202     intf_WarnMsg( 1, "actual configuration: %dx%d, %d/%d bpp (%d Bpl), "
 203                   "masks: 0x%x/0x%x/0x%x",
 204                   p_vout->i_width, p_vout->i_height, p_vout->i_screen_depth,
 205                   p_vout->i_bytes_per_pixel * 8, p_vout->i_bytes_per_line,
 206                   p_vout->i_red_mask, p_vout->i_green_mask,
 207                   p_vout->i_blue_mask );
 208
 209     /* Calculate shifts from system-updated masks */
 210     MaskToShift( &p_vout->i_red_lshift, &p_vout->i_red_rshift,
 211                  p_vout->i_red_mask );
 212     MaskToShift( &p_vout->i_green_lshift, &p_vout->i_green_rshift,
 213                  p_vout->i_green_mask );
 214     MaskToShift( &p_vout->i_blue_lshift, &p_vout->i_blue_rshift,
 215                  p_vout->i_blue_mask );
 216
 217     /* Set some useful colors */
 218     p_vout->i_white_pixel = RGB2PIXEL( p_vout, 255, 255, 255 );
 219     p_vout->i_black_pixel = RGB2PIXEL( p_vout, 0, 0, 0 );
 220     p_vout->i_gray_pixel  = RGB2PIXEL( p_vout, 128, 128, 128 );
 221     p_vout->i_blue_pixel  = RGB2PIXEL( p_vout, 0, 0, 50 );
 222
 223     /* Load fonts - fonts must be initialized after the system method since
 224      * they may be dependant on screen depth and other thread properties */
 225     p_vout->p_default_font = vout_LoadFont( VOUT_DEFAULT_FONT );
 226     if( p_vout->p_default_font == NULL )
 227     {
 228         intf_ErrMsg( "vout error: could not load default font" );
 229         p_vout->pf_destroy( p_vout );
 230         free( p_vout );
 231         return( NULL );
 232     }
 233
 234     p_vout->p_large_font = vout_LoadFont( VOUT_LARGE_FONT );
 235     if( p_vout->p_large_font == NULL )
 236     {
 237         intf_ErrMsg( "vout error: could not load large font" );
 238         vout_UnloadFont( p_vout->p_default_font );
 239         p_vout->pf_destroy( p_vout );
 240         free( p_vout );
 241         return( NULL );
 242     }
 243
 244     /* Create thread and set locks */
 245     vlc_mutex_init( &p_vout->picture_lock );
 246     vlc_mutex_init( &p_vout->subpicture_lock );
 247     vlc_mutex_init( &p_vout->change_lock );
 248
 249     if( vlc_thread_create( &p_vout->thread_id, "video output",
 250                            (void *) RunThread, (void *) p_vout) )
 251     {
 252         intf_ErrMsg("vout error: %s", strerror(ENOMEM));
 253         vout_UnloadFont( p_vout->p_default_font );
 254         vout_UnloadFont( p_vout->p_large_font );
 255         p_vout->pf_destroy( p_vout );
 256         free( p_vout );
 257         return( NULL );
 258     }
 259
 260     intf_Msg( "vout: video display initialized (%dx%d, %d/%d bpp)",
 261               p_vout->i_width, p_vout->i_height, p_vout->i_screen_depth,
 262               p_vout->i_bytes_per_pixel * 8 );
 263
 264     /* If status is NULL, wait until the thread is created */
 265     if( pi_status == NULL )
 266     {
 267         do
 268         {
 269             msleep( THREAD_SLEEP );
 270         }while( (i_status != THREAD_READY) && (i_status != THREAD_ERROR)
 271                 && (i_status != THREAD_FATAL) );
 272         if( i_status != THREAD_READY )
 273         {
 274             return( NULL );
 275         }
 276     }
 277     return( p_vout );
 278 }
 279
 280 /*****************************************************************************
 281  * vout_DestroyThread: destroys a previously created thread
 282  *****************************************************************************
 283  * Destroy a terminated thread.
 284  * The function will request a destruction of the specified thread. If pi_error
 285  * is NULL, it will return once the thread is destroyed. Else, it will be
 286  * update using one of the THREAD_* constants.
 287  *****************************************************************************/
 288 void vout_DestroyThread( vout_thread_t *p_vout, int *pi_status )
 289 {
 290     int     i_status;                                       /* thread status */
 291
 292     /* Set status */
 293     intf_DbgMsg("");
 294     p_vout->pi_status = (pi_status != NULL) ? pi_status : &i_status;
 295     *p_vout->pi_status = THREAD_DESTROY;
 296
 297     /* Request thread destruction */
 298     p_vout->b_die = 1;
 299
 300     /* If status is NULL, wait until thread has been destroyed */
 301     if( pi_status == NULL )
 302     {
 303         do
 304         {
 305             msleep( THREAD_SLEEP );
 306         }while( (i_status != THREAD_OVER) && (i_status != THREAD_ERROR)
 307                 && (i_status != THREAD_FATAL) );
 308     }
 309 }
 310
 311 /*****************************************************************************
 312  * vout_DisplaySubPicture: display a subpicture unit
 313  *****************************************************************************
 314  * Remove the reservation flag of an subpicture, which will cause it to be ready
 315  * for display. The picture does not need to be locked, since it is ignored by
 316  * the output thread if is reserved.
 317  *****************************************************************************/
 318 void  vout_DisplaySubPicture( vout_thread_t *p_vout, subpicture_t *p_subpic )
 319 {
 320 #ifdef DEBUG_VOUT
 321     char        psz_begin_date[MSTRTIME_MAX_SIZE]; /* buffer for date string */
 322     char        psz_end_date[MSTRTIME_MAX_SIZE];   /* buffer for date string */
 323 #endif
 324
 325 #ifdef DEBUG
 326     /* Check if status is valid */
 327     if( p_subpic->i_status != RESERVED_SUBPICTURE )
 328     {
 329         intf_DbgMsg("error: subpicture %p has invalid status %d", p_subpic,
 330                     p_subpic->i_status );
 331     }
 332 #endif
 333
 334     /* Remove reservation flag */
 335     p_subpic->i_status = READY_SUBPICTURE;
 336
 337 #ifdef DEBUG_VOUT
 338     /* Send subpicture information */
 339     intf_DbgMsg("subpicture %p: type=%d, begin date=%s, end date=%s",
 340                 p_subpic, p_subpic->i_type,
 341                 mstrtime( psz_begin_date, p_subpic->begin_date ),
 342                 mstrtime( psz_end_date, p_subpic->end_date ) );
 343 #endif
 344 }
 345
 346 /*****************************************************************************
 347  * vout_CreateSubPicture: allocate a subpicture in the video output heap.
 348  *****************************************************************************
 349  * This function create a reserved subpicture in the video output heap.
 350  * A null pointer is returned if the function fails. This method provides an
 351  * already allocated zone of memory in the spu data fields. It needs locking
 352  * since several pictures can be created by several producers threads.
 353  *****************************************************************************/
 354 subpicture_t *vout_CreateSubPicture( vout_thread_t *p_vout, int i_type,
 355                                      int i_size )
 356 {
 357     int                 i_subpic;                        /* subpicture index */
 358     subpicture_t *      p_free_subpic = NULL;       /* first free subpicture */
 359     subpicture_t *      p_destroyed_subpic = NULL; /* first destroyed subpic */
 360
 361     /* Get lock */
 362     vlc_mutex_lock( &p_vout->subpicture_lock );
 363
 364     /*
 365      * Look for an empty place
 366      */
 367     for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
 368     {
 369         if( p_vout->p_subpicture[i_subpic].i_status == DESTROYED_SUBPICTURE )
 370         {
 371             /* Subpicture is marked for destruction, but is still allocated */
 372             if( (p_vout->p_subpicture[i_subpic].i_type  == i_type)   &&
 373                 (p_vout->p_subpicture[i_subpic].i_size  >= i_size) )
 374             {
 375                 /* Memory size do match or is smaller : memory will not be
 376                  * reallocated, and function can end immediately - this is
 377                  * the best possible case, since no memory allocation needs
 378                  * to be done */
 379                 p_vout->p_subpicture[i_subpic].i_status = RESERVED_SUBPICTURE;
 380 #ifdef DEBUG_VOUT
 381                 intf_DbgMsg("subpicture %p (in destroyed subpicture slot)",
 382                             &p_vout->p_subpicture[i_subpic] );
 383 #endif
 384                 vlc_mutex_unlock( &p_vout->subpicture_lock );
 385                 return( &p_vout->p_subpicture[i_subpic] );
 386             }
 387             else if( p_destroyed_subpic == NULL )
 388             {
 389                 /* Memory size do not match, but subpicture index will be kept in
 390                  * case no other place are left */
 391                 p_destroyed_subpic = &p_vout->p_subpicture[i_subpic];
 392             }
 393         }
 394         else if( (p_free_subpic == NULL) &&
 395                  (p_vout->p_subpicture[i_subpic].i_status == FREE_SUBPICTURE ))
 396         {
 397             /* Subpicture is empty and ready for allocation */
 398             p_free_subpic = &p_vout->p_subpicture[i_subpic];
 399         }
 400     }
 401
 402     /* If no free subpictures are available, use a destroyed subpicture */
 403     if( (p_free_subpic == NULL) && (p_destroyed_subpic != NULL ) )
 404     {
 405         /* No free subpicture or matching destroyed subpictures have been
 406          * found, but a destroyed subpicture is still avalaible */
 407         free( p_destroyed_subpic->p_data );
 408         p_free_subpic = p_destroyed_subpic;
 409     }
 410
 411     /*
 412      * Prepare subpicture
 413      */
 414     if( p_free_subpic != NULL )
 415     {
 416         /* Allocate memory */
 417         switch( i_type )
 418         {
 419         case TEXT_SUBPICTURE:                             /* text subpicture */
 420             p_free_subpic->p_data = malloc( i_size + 1 );
 421             break;
 422         case DVD_SUBPICTURE:                          /* DVD subpicture unit */
 423             p_free_subpic->p_data = malloc( i_size );
 424             break;
 425 #ifdef DEBUG
 426         default:
 427             intf_DbgMsg("error: unknown subpicture type %d", i_type );
 428             p_free_subpic->p_data   =  NULL;
 429             break;
 430 #endif
 431         }
 432
 433         if( p_free_subpic->p_data != NULL )
 434         {
 435             /* Copy subpicture information, set some default values */
 436             p_free_subpic->i_type                      = i_type;
 437             p_free_subpic->i_status                    = RESERVED_SUBPICTURE;
 438             p_free_subpic->i_size                      = i_size;
 439             p_free_subpic->i_x                         = 0;
 440             p_free_subpic->i_y                         = 0;
 441             p_free_subpic->i_width                     = 0;
 442             p_free_subpic->i_height                    = 0;
 443             p_free_subpic->i_horizontal_align          = CENTER_RALIGN;
 444             p_free_subpic->i_vertical_align            = CENTER_RALIGN;
 445         }
 446         else
 447         {
 448             /* Memory allocation failed : set subpicture as empty */
 449             p_free_subpic->i_type   =  EMPTY_SUBPICTURE;
 450             p_free_subpic->i_status =  FREE_SUBPICTURE;
 451             p_free_subpic =            NULL;
 452             intf_ErrMsg( "vout error: spu allocation returned %s",
 453                          strerror( ENOMEM ) );
 454         }
 455
 456 #ifdef DEBUG_VOUT
 457         intf_DbgMsg("subpicture %p (in free subpicture slot)", p_free_subpic );
 458 #endif
 459         vlc_mutex_unlock( &p_vout->subpicture_lock );
 460         return( p_free_subpic );
 461     }
 462
 463     /* No free or destroyed subpicture could be found */
 464     intf_DbgMsg( "warning: subpicture heap is full" );
 465     vlc_mutex_unlock( &p_vout->subpicture_lock );
 466     return( NULL );
 467 }
 468
 469 /*****************************************************************************
 470  * vout_DestroySubPicture: remove a subpicture from the heap
 471  *****************************************************************************
 472  * This function frees a previously reserved subpicture.
 473  * It is meant to be used when the construction of a picture aborted.
 474  * This function does not need locking since reserved subpictures are ignored
 475  * by the output thread.
 476  *****************************************************************************/
 477 void vout_DestroySubPicture( vout_thread_t *p_vout, subpicture_t *p_subpic )
 478 {
 479 #ifdef DEBUG
 480    /* Check if status is valid */
 481    if( p_subpic->i_status != RESERVED_SUBPICTURE )
 482    {
 483        intf_DbgMsg("error: subpicture %p has invalid status %d",
 484                    p_subpic, p_subpic->i_status );
 485    }
 486 #endif
 487
 488     p_subpic->i_status = DESTROYED_SUBPICTURE;
 489
 490 #ifdef DEBUG_VOUT
 491     intf_DbgMsg("subpicture %p", p_subpic);
 492 #endif
 493 }
 494
 495 /*****************************************************************************
 496  * vout_DisplayPicture: display a picture
 497  *****************************************************************************
 498  * Remove the reservation flag of a picture, which will cause it to be ready for
 499  * display. The picture won't be displayed until vout_DatePicture has been
 500  * called.
 501  *****************************************************************************/
 502 void  vout_DisplayPicture( vout_thread_t *p_vout, picture_t *p_pic )
 503 {
 504     vlc_mutex_lock( &p_vout->picture_lock );
 505     switch( p_pic->i_status )
 506     {
 507     case RESERVED_PICTURE:
 508         p_pic->i_status = RESERVED_DISP_PICTURE;
 509         break;
 510     case RESERVED_DATED_PICTURE:
 511         p_pic->i_status = READY_PICTURE;
 512         break;
 513 #ifdef DEBUG
 514     default:
 515         intf_DbgMsg("error: picture %p has invalid status %d", p_pic, p_pic->i_status );
 516         break;
 517 #endif
 518     }
 519
 520 #ifdef DEBUG_VOUT
 521     intf_DbgMsg("picture %p", p_pic);
 522 #endif
 523     vlc_mutex_unlock( &p_vout->picture_lock );
 524 }
 525
 526 /*****************************************************************************
 527  * vout_DatePicture: date a picture
 528  *****************************************************************************
 529  * Remove the reservation flag of a picture, which will cause it to be ready for
 530  * display. The picture won't be displayed until vout_DisplayPicture has been
 531  * called.
 532  *****************************************************************************/
 533 void  vout_DatePicture( vout_thread_t *p_vout, picture_t *p_pic, mtime_t date )
 534 {
 535 #ifdef DEBUG_VOUT
 536     char        psz_date[MSTRTIME_MAX_SIZE];                         /* date */
 537 #endif
 538
 539     vlc_mutex_lock( &p_vout->picture_lock );
 540     p_pic->date = date;
 541     switch( p_pic->i_status )
 542     {
 543     case RESERVED_PICTURE:
 544         p_pic->i_status = RESERVED_DATED_PICTURE;
 545         break;
 546     case RESERVED_DISP_PICTURE:
 547         p_pic->i_status = READY_PICTURE;
 548         break;
 549 #ifdef DEBUG
 550     default:
 551         intf_DbgMsg("error: picture %p has invalid status %d", p_pic, p_pic->i_status );
 552         break;
 553 #endif
 554     }
 555
 556 #ifdef DEBUG_VOUT
 557     intf_DbgMsg("picture %p, display date: %s", p_pic, mstrtime( psz_date, p_pic->date) );
 558 #endif
 559     vlc_mutex_unlock( &p_vout->picture_lock );
 560 }
 561
 562 /*****************************************************************************
 563  * vout_CreatePicture: allocate a picture in the video output heap.
 564  *****************************************************************************
 565  * This function create a reserved image in the video output heap.
 566  * A null pointer is returned if the function fails. This method provides an
 567  * already allocated zone of memory in the picture data fields. It needs locking
 568  * since several pictures can be created by several producers threads.
 569  *****************************************************************************/
 570 picture_t *vout_CreatePicture( vout_thread_t *p_vout, int i_type,
 571                                int i_width, int i_height )
 572 {
 573     int         i_picture;                                  /* picture index */
 574     int         i_chroma_width = 0;                          /* chroma width */
 575     picture_t * p_free_picture = NULL;                 /* first free picture */
 576     picture_t * p_destroyed_picture = NULL;       /* first destroyed picture */
 577
 578     /* Get lock */
 579     vlc_mutex_lock( &p_vout->picture_lock );
 580
 581     /*
 582      * Look for an empty place
 583      */
 584     for( i_picture = 0; i_picture < VOUT_MAX_PICTURES; i_picture++ )
 585     {
 586         if( p_vout->p_picture[i_picture].i_status == DESTROYED_PICTURE )
 587         {
 588             /* Picture is marked for destruction, but is still allocated - note
 589              * that if width and type are the same for two pictures, chroma_width
 590              * should also be the same */
 591             if( (p_vout->p_picture[i_picture].i_type           == i_type)   &&
 592                 (p_vout->p_picture[i_picture].i_height         == i_height) &&
 593                 (p_vout->p_picture[i_picture].i_width          == i_width) )
 594             {
 595                 /* Memory size do match : memory will not be reallocated, and function
 596                  * can end immediately - this is the best possible case, since no
 597                  * memory allocation needs to be done */
 598                 p_vout->p_picture[i_picture].i_status = RESERVED_PICTURE;
 599                 p_vout->i_pictures++;
 600 #ifdef DEBUG_VOUT
 601                 intf_DbgMsg("picture %p (in destroyed picture slot)",
 602                             &p_vout->p_picture[i_picture] );
 603 #endif
 604                 vlc_mutex_unlock( &p_vout->picture_lock );
 605                 return( &p_vout->p_picture[i_picture] );
 606             }
 607             else if( p_destroyed_picture == NULL )
 608             {
 609                 /* Memory size do not match, but picture index will be kept in
 610                  * case no other place are left */
 611                 p_destroyed_picture = &p_vout->p_picture[i_picture];
 612             }
 613         }
 614         else if( (p_free_picture == NULL) &&
 615                  (p_vout->p_picture[i_picture].i_status == FREE_PICTURE ))
 616         {
 617             /* Picture is empty and ready for allocation */
 618             p_free_picture = &p_vout->p_picture[i_picture];
 619         }
 620     }
 621
 622     /* If no free picture is available, use a destroyed picture */
 623     if( (p_free_picture == NULL) && (p_destroyed_picture != NULL ) )
 624     {
 625         /* No free picture or matching destroyed picture has been found, but
 626          * a destroyed picture is still avalaible */
 627         free( p_destroyed_picture->p_data );
 628         p_free_picture = p_destroyed_picture;
 629     }
 630
 631     /*
 632      * Prepare picture
 633      */
 634     if( p_free_picture != NULL )
 635     {
 636         /* Allocate memory */
 637         switch( i_type )
 638         {
 639         case YUV_420_PICTURE:        /* YUV 420: 1,1/4,1/4 samples per pixel */
 640             i_chroma_width = i_width / 2;
 641             p_free_picture->p_data = malloc( i_height * i_chroma_width * 3 * sizeof( yuv_data_t ) );
 642             p_free_picture->p_y = (yuv_data_t *)p_free_picture->p_data;
 643             p_free_picture->p_u = (yuv_data_t *)p_free_picture->p_data +i_height*i_chroma_width*4/2;
 644             p_free_picture->p_v = (yuv_data_t *)p_free_picture->p_data +i_height*i_chroma_width*5/2;
 645             break;
 646         case YUV_422_PICTURE:        /* YUV 422: 1,1/2,1/2 samples per pixel */
 647             i_chroma_width = i_width / 2;
 648             p_free_picture->p_data = malloc( i_height * i_chroma_width * 4 * sizeof( yuv_data_t ) );
 649             p_free_picture->p_y = (yuv_data_t *)p_free_picture->p_data;
 650             p_free_picture->p_u = (yuv_data_t *)p_free_picture->p_data +i_height*i_chroma_width*2;
 651             p_free_picture->p_v = (yuv_data_t *)p_free_picture->p_data +i_height*i_chroma_width*3;
 652             break;
 653         case YUV_444_PICTURE:            /* YUV 444: 1,1,1 samples per pixel */
 654             i_chroma_width = i_width;
 655             p_free_picture->p_data = malloc( i_height * i_chroma_width * 3 * sizeof( yuv_data_t ) );
 656             p_free_picture->p_y = (yuv_data_t *)p_free_picture->p_data;
 657             p_free_picture->p_u = (yuv_data_t *)p_free_picture->p_data +i_height*i_chroma_width;
 658             p_free_picture->p_v = (yuv_data_t *)p_free_picture->p_data +i_height*i_chroma_width*2;
 659             break;
 660 #ifdef DEBUG
 661         default:
 662             intf_DbgMsg("error: unknown picture type %d", i_type );
 663             p_free_picture->p_data   =  NULL;
 664             break;
 665 #endif
 666         }
 667
 668         if( p_free_picture->p_data != NULL )
 669         {
 670             /* Copy picture information, set some default values */
 671             p_free_picture->i_type                      = i_type;
 672             p_free_picture->i_status                    = RESERVED_PICTURE;
 673             p_free_picture->i_matrix_coefficients       = 1;
 674             p_free_picture->i_width                     = i_width;
 675             p_free_picture->i_height                    = i_height;
 676             p_free_picture->i_chroma_width              = i_chroma_width;
 677             p_free_picture->i_display_horizontal_offset = 0;
 678             p_free_picture->i_display_vertical_offset   = 0;
 679             p_free_picture->i_display_width             = i_width;
 680             p_free_picture->i_display_height            = i_height;
 681             p_free_picture->i_aspect_ratio              = AR_SQUARE_PICTURE;
 682             p_free_picture->i_refcount                  = 0;
 683             p_vout->i_pictures++;
 684         }
 685         else
 686         {
 687             /* Memory allocation failed : set picture as empty */
 688             p_free_picture->i_type   =  EMPTY_PICTURE;
 689             p_free_picture->i_status =  FREE_PICTURE;
 690             p_free_picture =            NULL;
 691             intf_ErrMsg( "vout error: picture allocation returned %s",
 692                          strerror( ENOMEM ) );
 693         }
 694
 695 #ifdef DEBUG_VOUT
 696         intf_DbgMsg("picture %p (in free picture slot)", p_free_picture );
 697 #endif
 698         vlc_mutex_unlock( &p_vout->picture_lock );
 699
 700         /* Initialize mutex */
 701         vlc_mutex_init( &(p_free_picture->lock_deccount) );
 702
 703         return( p_free_picture );
 704     }
 705
 706     /* No free or destroyed picture could be found */
 707     intf_DbgMsg( "warning: picture heap is full" );
 708     vlc_mutex_unlock( &p_vout->picture_lock );
 709     return( NULL );
 710 }
 711
 712 /*****************************************************************************
 713  * vout_DestroyPicture: remove a permanent or reserved picture from the heap
 714  *****************************************************************************
 715  * This function frees a previously reserved picture or a permanent
 716  * picture. It is meant to be used when the construction of a picture aborted.
 717  * Note that the picture will be destroyed even if it is linked !
 718  *****************************************************************************/
 719 void vout_DestroyPicture( vout_thread_t *p_vout, picture_t *p_pic )
 720 {
 721     vlc_mutex_lock( &p_vout->picture_lock );
 722
 723 #ifdef DEBUG
 724     /* Check if picture status is valid */
 725     if( (p_pic->i_status != RESERVED_PICTURE) &&
 726         (p_pic->i_status != RESERVED_DATED_PICTURE) &&
 727         (p_pic->i_status != RESERVED_DISP_PICTURE) )
 728     {
 729         intf_DbgMsg("error: picture %p has invalid status %d", p_pic, p_pic->i_status );
 730     }
 731 #endif
 732
 733     p_pic->i_status = DESTROYED_PICTURE;
 734     p_vout->i_pictures--;
 735
 736 #ifdef DEBUG_VOUT
 737     intf_DbgMsg("picture %p", p_pic);
 738 #endif
 739
 740     /* destroy the lock that had been initialized in CreatePicture */
 741     vlc_mutex_destroy( &(p_pic->lock_deccount) );
 742
 743     vlc_mutex_unlock( &p_vout->picture_lock );
 744 }
 745
 746 /*****************************************************************************
 747  * vout_LinkPicture: increment reference counter of a picture
 748  *****************************************************************************
 749  * This function increment the reference counter of a picture in the video
 750  * heap. It needs a lock since several producer threads can access the picture.
 751  *****************************************************************************/
 752 void vout_LinkPicture( vout_thread_t *p_vout, picture_t *p_pic )
 753 {
 754     vlc_mutex_lock( &p_vout->picture_lock );
 755     p_pic->i_refcount++;
 756
 757 #ifdef DEBUG_VOUT
 758     intf_DbgMsg("picture %p refcount=%d", p_pic, p_pic->i_refcount );
 759 #endif
 760
 761     vlc_mutex_unlock( &p_vout->picture_lock );
 762 }
 763
 764 /*****************************************************************************
 765  * vout_UnlinkPicture: decrement reference counter of a picture
 766  *****************************************************************************
 767  * This function decrement the reference counter of a picture in the video heap.
 768  *****************************************************************************/
 769 void vout_UnlinkPicture( vout_thread_t *p_vout, picture_t *p_pic )
 770 {
 771     vlc_mutex_lock( &p_vout->picture_lock );
 772     p_pic->i_refcount--;
 773
 774 #ifdef DEBUG_VOUT
 775     if( p_pic->i_refcount < 0 )
 776     {
 777         intf_DbgMsg("error: refcount < 0");
 778         p_pic->i_refcount = 0;
 779     }
 780 #endif
 781
 782     if( (p_pic->i_refcount == 0) && (p_pic->i_status == DISPLAYED_PICTURE) )
 783     {
 784         p_pic->i_status = DESTROYED_PICTURE;
 785         p_vout->i_pictures--;
 786     }
 787
 788 #ifdef DEBUG_VOUT
 789     intf_DbgMsg("picture %p refcount=%d", p_pic, p_pic->i_refcount );
 790 #endif
 791
 792     vlc_mutex_unlock( &p_vout->picture_lock );
 793 }
 794
 795 /*****************************************************************************
 796  * vout_SetBuffers: set buffers adresses
 797  *****************************************************************************
 798  * This function is called by system drivers to set buffers video memory
 799  * adresses.
 800  *****************************************************************************/
 801 void vout_SetBuffers( vout_thread_t *p_vout, void *p_buf1, void *p_buf2 )
 802 {
 803     /* No picture previously */
 804     p_vout->p_buffer[0].i_pic_x =         0;
 805     p_vout->p_buffer[0].i_pic_y =         0;
 806     p_vout->p_buffer[0].i_pic_width =     0;
 807     p_vout->p_buffer[0].i_pic_height =    0;
 808     p_vout->p_buffer[1].i_pic_x =         0;
 809     p_vout->p_buffer[1].i_pic_y =         0;
 810     p_vout->p_buffer[1].i_pic_width =     0;
 811     p_vout->p_buffer[1].i_pic_height =    0;
 812
 813     /* The first area covers all the screen */
 814     p_vout->p_buffer[0].i_areas =                 1;
 815     p_vout->p_buffer[0].pi_area_begin[0] =        0;
 816     p_vout->p_buffer[0].pi_area_end[0] =          p_vout->i_height - 1;
 817     p_vout->p_buffer[1].i_areas =                 1;
 818     p_vout->p_buffer[1].pi_area_begin[0] =        0;
 819     p_vout->p_buffer[1].pi_area_end[0] =          p_vout->i_height - 1;
 820
 821     /* Set adresses */
 822     p_vout->p_buffer[0].p_data = p_buf1;
 823     p_vout->p_buffer[1].p_data = p_buf2;
 824 }
 825
 826 /*****************************************************************************
 827  * vout_Pixel2RGB: return red, green and blue from pixel value
 828  *****************************************************************************
 829  * Return color values, in 0-255 range, of the decomposition of a pixel. This
 830  * is a slow routine and should only be used for initialization phase.
 831  *****************************************************************************/
 832 void vout_Pixel2RGB( vout_thread_t *p_vout, u32 i_pixel, int *pi_red, int *pi_green, int *pi_blue )
 833 {
 834     *pi_red =   i_pixel & p_vout->i_red_mask;
 835     *pi_green = i_pixel & p_vout->i_green_mask;
 836     *pi_blue =  i_pixel & p_vout->i_blue_mask;
 837 }
 838
 839 /* following functions are local */
 840
 841 /*****************************************************************************
 842  * BinaryLog: computes the base 2 log of a binary value
 843  *****************************************************************************
 844  * This functions is used by MaskToShift, to get a bit index from a binary
 845  * value.
 846  *****************************************************************************/
 847 static int BinaryLog(u32 i)
 848 {
 849     int i_log = 0;
 850
 851     if(i & 0xffff0000)
 852     {
 853         i_log += 16;
 854     }
 855     if(i & 0xff00ff00)
 856     {
 857         i_log += 8;
 858     }
 859     if(i & 0xf0f0f0f0)
 860     {
 861         i_log += 4;
 862     }
 863     if(i & 0xcccccccc)
 864     {
 865         i_log += 2;
 866     }
 867     if(i & 0xaaaaaaaa)
 868     {
 869         i_log += 1;
 870     }
 871
 872     if (i != ((u32)1 << i_log))
 873     {
 874         intf_DbgMsg("internal error: binary log overflow");
 875     }
 876
 877     return( i_log );
 878 }
 879
 880 /*****************************************************************************
 881  * MaskToShift: transform a color mask into right and left shifts
 882  *****************************************************************************
 883  * This function is used for obtaining color shifts from masks.
 884  *****************************************************************************/
 885 static void MaskToShift( int *pi_left, int *pi_right, u32 i_mask )
 886 {
 887     u32 i_low, i_high;                 /* lower hand higher bits of the mask */
 888
 889     /* Get bits */
 890     i_low =  i_mask & (- i_mask);                   /* lower bit of the mask */
 891     i_high = i_mask + i_low;                       /* higher bit of the mask */
 892
 893     /* Transform bits into an index */
 894     i_low =  BinaryLog (i_low);
 895     i_high = BinaryLog (i_high);
 896
 897     /* Update pointers and return */
 898     *pi_left =   i_low;
 899     *pi_right = (8 - i_high + i_low);
 900 }
 901
 902 /*****************************************************************************
 903  * InitThread: initialize video output thread
 904  *****************************************************************************
 905  * This function is called from RunThread and performs the second step of the
 906  * initialization. It returns 0 on success. Note that the thread's flag are not
 907  * modified inside this function.
 908  *****************************************************************************/
 909 static int InitThread( vout_thread_t *p_vout )
 910 {
 911     /* Update status */
 912     *p_vout->pi_status = THREAD_START;
 913
 914     vlc_mutex_lock( &p_vout->change_lock );
 915
 916 #ifdef STATS
 917     p_vout->c_loops = 0;
 918 #endif
 919
 920    /* Initialize output method - this function issues its own error messages */
 921     if( p_vout->pf_init( p_vout ) )
 922     {
 923         return( 1 );
 924     }
 925
 926     /* Initialize convertion tables and functions */
 927     if( vout_InitYUV( p_vout ) )
 928     {
 929         intf_ErrMsg("vout error: can't allocate YUV translation tables");
 930         return( 1 );
 931     }
 932
 933     /* Mark thread as running and return */
 934     p_vout->b_active =          1;
 935     *p_vout->pi_status =        THREAD_READY;
 936
 937
 938     intf_DbgMsg("thread ready");
 939     return( 0 );
 940 }
 941
 942 /*****************************************************************************
 943  * RunThread: video output thread
 944  *****************************************************************************
 945  * Video output thread. This function does only returns when the thread is
 946  * terminated. It handles the pictures arriving in the video heap and the
 947  * display device events.
 948  *****************************************************************************/
 949 static void RunThread( vout_thread_t *p_vout)
 950 {
 951     int             i_index;                                /* index in heap */
 952     mtime_t         current_date;                            /* current date */
 953     mtime_t         display_date;                            /* display date */
 954     boolean_t       b_display;                               /* display flag */
 955     picture_t *     p_pic;                                /* picture pointer */
 956     subpicture_t *  p_subpic;                          /* subpicture pointer */
 957
 958     /*
 959      * Initialize thread
 960      */
 961     p_vout->b_error = InitThread( p_vout );
 962     if( p_vout->b_error )
 963     {
 964         DestroyThread( p_vout, THREAD_ERROR );
 965         return;
 966     }
 967
 968     /*
 969      * Main loop - it is not executed if an error occured during
 970      * initialization
 971      */
 972     while( (!p_vout->b_die) && (!p_vout->b_error) )
 973     {
 974         /* Initialize loop variables */
 975         p_pic =         NULL;
 976         p_subpic =      NULL;
 977         display_date =  0;
 978         current_date =  mdate();
 979 #ifdef STATS
 980         p_vout->c_loops++;
 981         if( !(p_vout->c_loops % VOUT_STATS_NB_LOOPS) )
 982         {
 983             intf_Msg("vout stats: picture heap: %d/%d",
 984                      p_vout->i_pictures, VOUT_MAX_PICTURES);
 985         }
 986 #endif
 987
 988         /*
 989          * Find the picture to display - this operation does not need lock,
 990          * since only READY_PICTUREs are handled
 991          */
 992         for( i_index = 0; i_index < VOUT_MAX_PICTURES; i_index++ )
 993         {
 994             if( (p_vout->p_picture[i_index].i_status == READY_PICTURE) &&
 995             ( (p_pic == NULL) ||
 996               (p_vout->p_picture[i_index].date < display_date) ) )
 997             {
 998                 p_pic = &p_vout->p_picture[i_index];
 999                 display_date = p_pic->date;
1000             }
1001         }
1002
1003         if( p_pic )
1004         {
1005             /* Computes FPS rate */
1006             p_vout->p_fps_sample[ p_vout->c_fps_samples++ % VOUT_FPS_SAMPLES ] = display_date;
1007
1008             if( display_date < current_date - p_vout->render_time )
1009             {
1010                 /* Picture is late: it will be destroyed and the thread
1011                  * will sleep and go to next picture */
1012
1013                 vlc_mutex_lock( &p_vout->picture_lock );
1014                 if( p_pic->i_refcount )
1015                 {
1016                     p_pic->i_status = DISPLAYED_PICTURE;
1017                 }
1018                 else
1019                 {
1020                     p_pic->i_status = DESTROYED_PICTURE;
1021                     p_vout->i_pictures--;
1022                 }
1023                 intf_WarnMsg( 3,
1024                         "warning: late picture skipped (%p)", p_pic );
1025                 vlc_mutex_unlock( &p_vout->picture_lock );
1026
1027                 continue;
1028             }
1029             else if( display_date > current_date + VOUT_DISPLAY_DELAY )
1030             {
1031                 /* A picture is ready to be rendered, but its rendering date
1032                  * is far from the current one so the thread will perform an
1033                  * empty loop as if no picture were found. The picture state
1034                  * is unchanged */
1035                 p_pic =         NULL;
1036                 display_date =  0;
1037             }
1038         }
1039         /*
1040          * Find the subpictures to display - this operation does not need
1041          * lock, since only READY_SUBPICTURE are handled. If no picture
1042          * has been selected, display_date will depend on the subpicture.
1043          * We get an easily parsable chained list of subpictures which
1044          * ends with NULL since p_subpic was initialized to NULL.
1045          */
1046         for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
1047         {
1048             if( p_vout->p_subpicture[i_index].i_status == READY_SUBPICTURE )
1049             {
1050                 p_vout->p_subpicture[i_index].p_next = p_subpic;
1051                 p_subpic = &p_vout->p_subpicture[i_index];
1052             }
1053         }
1054
1055         /*
1056          * Perform rendering, sleep and display rendered picture
1057          */
1058         if( p_pic )                        /* picture and perhaps subpicture */
1059         {
1060             b_display = p_vout->b_active;
1061             p_vout->last_display_date = display_date;
1062             p_vout->p_rendered_pic = p_pic;
1063
1064
1065
1066
1067             /* Set picture dimensions and clear buffer */
1068             SetBufferPicture( p_vout, p_pic );
1069
1070             /* FIXME: if b_need_render == 0 we need to do something with
1071              * the subpictures one day. */
1072
1073             if( p_vout->b_need_render && b_display )
1074             {
1075                 /* Render picture and information */
1076                 RenderPicture( p_vout, p_pic );
1077                 if( p_vout->b_info )
1078                 {
1079                     RenderPictureInfo( p_vout, p_pic );
1080                     RenderInfo( p_vout );
1081                 }
1082                 if( p_subpic )
1083                 {
1084                     RenderSubPicture( p_vout, p_subpic );
1085                 }
1086             }
1087
1088             /* Render interface and subpicture */
1089             if( b_display && p_vout->b_interface && p_vout->b_need_render )
1090             {
1091                 RenderInterface( p_vout );
1092             }
1093
1094         }
1095         else if( p_vout->b_active && p_vout->b_need_render
1096                   && p_vout->init_display_date == 0)
1097         {
1098             /* Idle or interface screen alone */
1099
1100             if( p_vout->b_interface && 0 /* && XXX?? intf_change */ )
1101             {
1102                 /* Interface has changed, so a new rendering is required - force
1103                  * it by setting last idle date to 0 */
1104                 p_vout->last_idle_date = 0;
1105             }
1106
1107             /* Render idle screen and update idle date, then render interface if
1108              * required */
1109             b_display = RenderIdle( p_vout );
1110             if( b_display )
1111             {
1112                 p_vout->last_idle_date = current_date;
1113                 if( p_vout->b_interface )
1114                 {
1115                     RenderInterface( p_vout );
1116                 }
1117             }
1118
1119         }
1120         else
1121         {
1122             b_display = 0;
1123         }
1124
1125
1126         /*
1127          * Check for the current time and
1128          * display splash screen if everything is on time
1129          */
1130         if( p_vout->init_display_date > 0 && p_vout->b_need_render )
1131         {
1132             if( p_vout->b_active &&
1133                     mdate()-p_vout->init_display_date < 5000000)
1134             {
1135                 /* there is something to display ! */
1136                     b_display = 1;
1137                     RenderSplash( p_vout );
1138
1139             } else {
1140                 /* no splash screen ! */
1141                 p_vout->init_display_date=0;
1142             }
1143         }
1144
1145
1146         /*
1147          * Sleep, wake up and display rendered picture
1148          */
1149
1150         if( display_date != 0 )
1151         {
1152             /* Store render time using Bresenham algorithm */
1153             p_vout->render_time += mdate() - current_date;
1154             p_vout->render_time >>= 1;
1155         }
1156
1157         /* Give back change lock */
1158         vlc_mutex_unlock( &p_vout->change_lock );
1159
1160         /* Sleep a while or until a given date */
1161         if( display_date != 0 )
1162         {
1163             mwait( display_date - VOUT_MWAIT_TOLERANCE );
1164         }
1165         else
1166         {
1167             msleep( VOUT_IDLE_SLEEP );
1168         }
1169
1170         /* On awakening, take back lock and send immediately picture to display,
1171          * then swap buffers */
1172         vlc_mutex_lock( &p_vout->change_lock );
1173 #ifdef DEBUG_VOUT
1174         intf_DbgMsg( "picture %p, subpicture %p in buffer %d, display=%d", p_pic, p_subpic,
1175                      p_vout->i_buffer_index, b_display /* && !(p_vout->i_changes & VOUT_NODISPLAY_CHANGE) */ );
1176 #endif
1177         if( b_display /* && !(p_vout->i_changes & VOUT_NODISPLAY_CHANGE) */ )
1178         {
1179             p_vout->pf_display( p_vout );
1180 #ifndef SYS_BEOS
1181             p_vout->i_buffer_index = ++p_vout->i_buffer_index & 1;
1182 #endif
1183         }
1184
1185         if( p_pic )
1186         {
1187             /* Remove picture from heap */
1188             vlc_mutex_lock( &p_vout->picture_lock );
1189             if( p_pic->i_refcount )
1190             {
1191                 p_pic->i_status = DISPLAYED_PICTURE;
1192             }
1193             else
1194             {
1195                 p_pic->i_status = DESTROYED_PICTURE;
1196                 p_vout->i_pictures--;
1197             }
1198             vlc_mutex_unlock( &p_vout->picture_lock );
1199         }
1200
1201
1202         /*
1203          * Check events and manage thread
1204          */
1205         if( p_vout->pf_manage( p_vout ) | Manage( p_vout ) )
1206         {
1207             /* A fatal error occured, and the thread must terminate immediately,
1208              * without displaying anything - setting b_error to 1 cause the
1209              * immediate end of the main while() loop. */
1210             p_vout->b_error = 1;
1211         }
1212     }
1213
1214     /*
1215      * Error loop - wait until the thread destruction is requested
1216      */
1217     if( p_vout->b_error )
1218     {
1219         ErrorThread( p_vout );
1220     }
1221
1222     /* End of thread */
1223     EndThread( p_vout );
1224     DestroyThread( p_vout, THREAD_OVER );
1225     intf_DbgMsg( "thread end" );
1226 }
1227
1228 /*****************************************************************************
1229  * ErrorThread: RunThread() error loop
1230  *****************************************************************************
1231  * This function is called when an error occured during thread main's loop. The
1232  * thread can still receive feed, but must be ready to terminate as soon as
1233  * possible.
1234  *****************************************************************************/
1235 static void ErrorThread( vout_thread_t *p_vout )
1236 {
1237     /* Wait until a `die' order */
1238     while( !p_vout->b_die )
1239     {
1240         /* Sleep a while */
1241         msleep( VOUT_IDLE_SLEEP );
1242     }
1243 }
1244
1245 /*****************************************************************************
1246  * EndThread: thread destruction
1247  *****************************************************************************
1248  * This function is called when the thread ends after a sucessful
1249  * initialization. It frees all ressources allocated by InitThread.
1250  *****************************************************************************/
1251 static void EndThread( vout_thread_t *p_vout )
1252 {
1253     int     i_index;                                        /* index in heap */
1254
1255     /* Store status */
1256     *p_vout->pi_status = THREAD_END;
1257
1258 #ifdef STATS
1259     {
1260         struct tms cpu_usage;
1261         times( &cpu_usage );
1262
1263         intf_Msg( "vout stats: cpu usage (user: %d, system: %d)",
1264                   cpu_usage.tms_utime, cpu_usage.tms_stime );
1265     }
1266 #endif
1267
1268     /* Destroy all remaining pictures and subpictures */
1269     for( i_index = 0; i_index < VOUT_MAX_PICTURES; i_index++ )
1270     {
1271         if( p_vout->p_picture[i_index].i_status != FREE_PICTURE )
1272         {
1273             free( p_vout->p_picture[i_index].p_data );
1274         }
1275     }
1276
1277     for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
1278     {
1279         if( p_vout->p_subpicture[i_index].i_status != FREE_SUBPICTURE )
1280         {
1281             free( p_vout->p_subpicture[i_index].p_data );
1282         }
1283     }
1284
1285     /* Destroy translation tables */
1286     vout_EndYUV( p_vout );
1287     p_vout->pf_end( p_vout );
1288
1289     /* Release the change lock */
1290     vlc_mutex_unlock( &p_vout->change_lock );
1291 }
1292
1293 /*****************************************************************************
1294  * DestroyThread: thread destruction
1295  *****************************************************************************
1296  * This function is called when the thread ends. It frees all ressources
1297  * allocated by CreateThread. Status is available at this stage.
1298  *****************************************************************************/
1299 static void DestroyThread( vout_thread_t *p_vout, int i_status )
1300 {
1301     int *pi_status;                                         /* status adress */
1302
1303     /* Store status adress */
1304     pi_status = p_vout->pi_status;
1305
1306     /* Destroy thread structures allocated by Create and InitThread */
1307     vout_UnloadFont( p_vout->p_default_font );
1308     vout_UnloadFont( p_vout->p_large_font );
1309     p_vout->pf_destroy( p_vout );
1310
1311     /* Destroy the locks */
1312     vlc_mutex_destroy( &p_vout->picture_lock );
1313     vlc_mutex_destroy( &p_vout->subpicture_lock );
1314     vlc_mutex_destroy( &p_vout->change_lock );
1315
1316     /* Release the module */
1317     module_Unneed( p_main->p_bank, p_vout->p_module );
1318
1319     /* Free structure */
1320     free( p_vout );
1321     *pi_status = i_status;
1322 }
1323
1324 /*****************************************************************************
1325  * Print: print simple text on a picture
1326  *****************************************************************************
1327  * This function will print a simple text on the picture. It is designed to
1328  * print debugging or general information.
1329  *****************************************************************************/
1330 void Print( vout_thread_t *p_vout, int i_x, int i_y, int i_h_align, int i_v_align, unsigned char *psz_text )
1331 {
1332     int                 i_text_height;                  /* total text height */
1333     int                 i_text_width;                    /* total text width */
1334
1335     /* Update upper left coordinates according to alignment */
1336     vout_TextSize( p_vout->p_default_font, 0, psz_text, &i_text_width, &i_text_height );
1337     if( !Align( p_vout, &i_x, &i_y, i_text_width, i_text_height, i_h_align, i_v_align ) )
1338     {
1339         /* Set area and print text */
1340         SetBufferArea( p_vout, i_x, i_y, i_text_width, i_text_height );
1341         vout_Print( p_vout->p_default_font, p_vout->p_buffer[ p_vout->i_buffer_index ].p_data +
1342                     i_y * p_vout->i_bytes_per_line + i_x * p_vout->i_bytes_per_pixel,
1343                     p_vout->i_bytes_per_pixel, p_vout->i_bytes_per_line,
1344                     p_vout->i_white_pixel, 0, 0,
1345                     0, psz_text, 100 );
1346     }
1347 }
1348
1349 /*****************************************************************************
1350  * SetBufferArea: activate an area in current buffer
1351  *****************************************************************************
1352  * This function is called when something is rendered on the current buffer.
1353  * It set the area as active and prepare it to be cleared on next rendering.
1354  * Pay attention to the fact that in this functions, i_h is in fact the end y
1355  * coordinate of the new area.
1356  *****************************************************************************/
1357 static void SetBufferArea( vout_thread_t *p_vout, int i_x, int i_y, int i_w, int i_h )
1358 {
1359     vout_buffer_t *     p_buffer;                          /* current buffer */
1360     int                 i_area_begin, i_area_end; /* area vertical extension */
1361     int                 i_area, i_area_copy;                   /* area index */
1362     int                 i_area_shift;            /* shift distance for areas */
1363
1364     /* Choose buffer and modify h to end of area position */
1365     p_buffer =  &p_vout->p_buffer[ p_vout->i_buffer_index ];
1366     i_h +=      i_y - 1;
1367
1368     /*
1369      * Remove part of the area which is inside the picture - this is done
1370      * by calling again SetBufferArea with the correct areas dimensions.
1371      */
1372     if( (i_x >= p_buffer->i_pic_x) && (i_x + i_w <= p_buffer->i_pic_x + p_buffer->i_pic_width) )
1373     {
1374         i_area_begin =  p_buffer->i_pic_y;
1375         i_area_end =    i_area_begin + p_buffer->i_pic_height - 1;
1376
1377         if( ((i_y >= i_area_begin) && (i_y <= i_area_end)) ||
1378             ((i_h >= i_area_begin) && (i_h <= i_area_end)) ||
1379             ((i_y <  i_area_begin) && (i_h > i_area_end)) )
1380         {
1381             /* Keep the stripe above the picture, if any */
1382             if( i_y < i_area_begin )
1383             {
1384                 SetBufferArea( p_vout, i_x, i_y, i_w, i_area_begin - i_y );
1385             }
1386             /* Keep the stripe below the picture, if any */
1387             if( i_h > i_area_end )
1388             {
1389                 SetBufferArea( p_vout, i_x, i_area_end, i_w, i_h - i_area_end );
1390             }
1391             return;
1392         }
1393     }
1394
1395     /* Skip some extensions until interesting areas */
1396     for( i_area = 0;
1397          (i_area < p_buffer->i_areas) &&
1398              (p_buffer->pi_area_end[i_area] + 1 <= i_y);
1399          i_area++ )
1400     {
1401         ;
1402     }
1403
1404     if( i_area == p_buffer->i_areas )
1405     {
1406         /* New area is below all existing ones: just add it at the end of the
1407          * array, if possible - otherwise, append it to the last one */
1408         if( i_area < VOUT_MAX_AREAS )
1409         {
1410             p_buffer->pi_area_begin[i_area] = i_y;
1411             p_buffer->pi_area_end[i_area] = i_h;
1412             p_buffer->i_areas++;
1413         }
1414         else
1415         {
1416 #ifdef DEBUG_VOUT
1417             intf_DbgMsg("area overflow");
1418 #endif
1419             p_buffer->pi_area_end[VOUT_MAX_AREAS - 1] = i_h;
1420         }
1421     }
1422     else
1423     {
1424         i_area_begin =  p_buffer->pi_area_begin[i_area];
1425         i_area_end =    p_buffer->pi_area_end[i_area];
1426
1427         if( i_y < i_area_begin )
1428         {
1429             if( i_h >= i_area_begin - 1 )
1430             {
1431                 /* Extend area above */
1432                 p_buffer->pi_area_begin[i_area] = i_y;
1433             }
1434             else
1435             {
1436                 /* Create a new area above : merge last area if overflow, then
1437                  * move all old areas down */
1438                 if( p_buffer->i_areas == VOUT_MAX_AREAS )
1439                 {
1440 #ifdef DEBUG_VOUT
1441                     intf_DbgMsg("areas overflow");
1442 #endif
1443                     p_buffer->pi_area_end[VOUT_MAX_AREAS - 2] = p_buffer->pi_area_end[VOUT_MAX_AREAS - 1];
1444                 }
1445                 else
1446                 {
1447                     p_buffer->i_areas++;
1448                 }
1449                 for( i_area_copy = p_buffer->i_areas - 1; i_area_copy > i_area; i_area_copy-- )
1450                 {
1451                     p_buffer->pi_area_begin[i_area_copy] = p_buffer->pi_area_begin[i_area_copy - 1];
1452                     p_buffer->pi_area_end[i_area_copy] =   p_buffer->pi_area_end[i_area_copy - 1];
1453                 }
1454                 p_buffer->pi_area_begin[i_area] = i_y;
1455                 p_buffer->pi_area_end[i_area] = i_h;
1456                 return;
1457             }
1458         }
1459         if( i_h > i_area_end )
1460         {
1461             /* Find further areas which can be merged with the new one */
1462             for( i_area_copy = i_area + 1;
1463                  (i_area_copy < p_buffer->i_areas) &&
1464                      (p_buffer->pi_area_begin[i_area] <= i_h);
1465                  i_area_copy++ )
1466             {
1467                 ;
1468             }
1469             i_area_copy--;
1470
1471             if( i_area_copy != i_area )
1472             {
1473                 /* Merge with last possible areas */
1474                 p_buffer->pi_area_end[i_area] = MAX( i_h, p_buffer->pi_area_end[i_area_copy] );
1475
1476                 /* Shift lower areas upward */
1477                 i_area_shift = i_area_copy - i_area;
1478                 p_buffer->i_areas -= i_area_shift;
1479                 for( i_area_copy = i_area + 1; i_area_copy < p_buffer->i_areas; i_area_copy++ )
1480                 {
1481                     p_buffer->pi_area_begin[i_area_copy] = p_buffer->pi_area_begin[i_area_copy + i_area_shift];
1482                     p_buffer->pi_area_end[i_area_copy] =   p_buffer->pi_area_end[i_area_copy + i_area_shift];
1483                 }
1484             }
1485             else
1486             {
1487                 /* Extend area below */
1488                 p_buffer->pi_area_end[i_area] = i_h;
1489             }
1490         }
1491     }
1492 }
1493
1494 /*****************************************************************************
1495  * SetBufferPicture: clear buffer and set picture area
1496  *****************************************************************************
1497  * This function is called before any rendering. It clears the current
1498  * rendering buffer and set the new picture area. If the picture pointer is
1499  * NULL, then no picture area is defined. Floating operations are avoided since
1500  * some MMX calculations may follow.
1501  *****************************************************************************/
1502 static void SetBufferPicture( vout_thread_t *p_vout, picture_t *p_pic )
1503 {
1504     vout_buffer_t *     p_buffer;                          /* current buffer */
1505     int                 i_pic_x, i_pic_y;                /* picture position */
1506     int                 i_pic_width, i_pic_height;     /* picture dimensions */
1507     int                 i_old_pic_y, i_old_pic_height;   /* old picture area */
1508     int                 i_vout_width, i_vout_height;   /* display dimensions */
1509     int                 i_area;                                /* area index */
1510     int                 i_data_index;                     /* area data index */
1511     int                 i_data_size;   /* area data size, in 256 bytes blocs */
1512     u64 *               p_data;                   /* area data, for clearing */
1513     byte_t *            p_data8;           /* area data, for clearing (slow) */
1514
1515     /* Choose buffer and set display dimensions */
1516     p_buffer =          &p_vout->p_buffer[ p_vout->i_buffer_index ];
1517     i_vout_width =      p_vout->i_width;
1518     i_vout_height =     p_vout->i_height;
1519
1520     /*
1521      * Computes new picture size
1522      */
1523     if( p_pic != NULL )
1524     {
1525         /* Try horizontal scaling first - width must be a mutiple of 16 */
1526         i_pic_width = (( p_vout->b_scale || (p_pic->i_width > i_vout_width)) ?
1527                        i_vout_width : p_pic->i_width) & ~0xf;
1528         switch( p_pic->i_aspect_ratio )
1529         {
1530         case AR_3_4_PICTURE:
1531             i_pic_height = i_pic_width * 3 / 4;
1532             break;
1533         case AR_16_9_PICTURE:
1534             i_pic_height = i_pic_width * 9 / 16;
1535             break;
1536         case AR_221_1_PICTURE:
1537             i_pic_height = i_pic_width * 100 / 221;
1538             break;
1539         case AR_SQUARE_PICTURE:
1540         default:
1541             i_pic_height = p_pic->i_height * i_pic_width / p_pic->i_width;
1542             break;
1543         }
1544
1545         /* If picture dimensions using horizontal scaling are too large, use
1546          * vertical scaling. Since width must be a multiple of 16, height is
1547          * adjusted again after. */
1548         if( i_pic_height > i_vout_height )
1549         {
1550             i_pic_height = ( p_vout->b_scale || (p_pic->i_height > i_vout_height)) ?
1551                 i_vout_height : p_pic->i_height;
1552             switch( p_pic->i_aspect_ratio )
1553             {
1554             case AR_3_4_PICTURE:
1555                 i_pic_width = (i_pic_height * 4 / 3) & ~0xf;
1556                 i_pic_height = i_pic_width * 3 / 4;
1557                 break;
1558             case AR_16_9_PICTURE:
1559                 i_pic_width = (i_pic_height * 16 / 9) & ~0xf;
1560                 i_pic_height = i_pic_width * 9 / 16;
1561                 break;
1562             case AR_221_1_PICTURE:
1563                 i_pic_width = (i_pic_height * 221 / 100) & ~0xf;
1564                 i_pic_height = i_pic_width * 100 / 221;
1565                 break;
1566             case AR_SQUARE_PICTURE:
1567             default:
1568                 i_pic_width = (p_pic->i_width * i_pic_height / p_pic->i_height) & ~0xf;
1569                 i_pic_height = p_pic->i_height * i_pic_width / p_pic->i_width;
1570                 break;
1571             }
1572         }
1573
1574         /* Set picture position */
1575         i_pic_x = (p_vout->i_width - i_pic_width) / 2;
1576         i_pic_y = (p_vout->i_height - i_pic_height) / 2;
1577
1578     }
1579     else
1580     {
1581         /* No picture: size is 0 */
1582         i_pic_x =       0;
1583         i_pic_y =       0;
1584         i_pic_width =   0;
1585         i_pic_height =  0;
1586     }
1587
1588     /*
1589      * Set new picture size - if it is smaller than the previous one, clear
1590      * around it. Since picture are centered, only their size is tested.
1591      */
1592     if( (p_buffer->i_pic_width > i_pic_width) || (p_buffer->i_pic_height > i_pic_height) )
1593     {
1594         i_old_pic_y =            p_buffer->i_pic_y;
1595         i_old_pic_height =       p_buffer->i_pic_height;
1596         p_buffer->i_pic_x =      i_pic_x;
1597         p_buffer->i_pic_y =      i_pic_y;
1598         p_buffer->i_pic_width =  i_pic_width;
1599         p_buffer->i_pic_height = i_pic_height;
1600         SetBufferArea( p_vout, 0, i_old_pic_y, p_vout->i_width, i_old_pic_height );
1601     }
1602     else
1603     {
1604         p_buffer->i_pic_x =      i_pic_x;
1605         p_buffer->i_pic_y =      i_pic_y;
1606         p_buffer->i_pic_width =  i_pic_width;
1607         p_buffer->i_pic_height = i_pic_height;
1608     }
1609
1610     /*
1611      * Clear areas
1612      */
1613     for( i_area = 0; i_area < p_buffer->i_areas; i_area++ )
1614     {
1615 #ifdef DEBUG_VOUT
1616         intf_DbgMsg("clearing picture %p area in buffer %d: %d-%d", p_pic,
1617                     p_vout->i_buffer_index, p_buffer->pi_area_begin[i_area], p_buffer->pi_area_end[i_area] );
1618 #endif
1619         i_data_size = (p_buffer->pi_area_end[i_area] - p_buffer->pi_area_begin[i_area] + 1) * p_vout->i_bytes_per_line;
1620         p_data = (u64*) (p_buffer->p_data + p_vout->i_bytes_per_line * p_buffer->pi_area_begin[i_area]);
1621         for( i_data_index = i_data_size / 256; i_data_index-- ; )
1622         {
1623             /* Clear 256 bytes block */
1624             *p_data++ = 0;  *p_data++ = 0;  *p_data++ = 0;  *p_data++ = 0;
1625             *p_data++ = 0;  *p_data++ = 0;  *p_data++ = 0;  *p_data++ = 0;
1626             *p_data++ = 0;  *p_data++ = 0;  *p_data++ = 0;  *p_data++ = 0;
1627             *p_data++ = 0;  *p_data++ = 0;  *p_data++ = 0;  *p_data++ = 0;
1628             *p_data++ = 0;  *p_data++ = 0;  *p_data++ = 0;  *p_data++ = 0;
1629             *p_data++ = 0;  *p_data++ = 0;  *p_data++ = 0;  *p_data++ = 0;
1630             *p_data++ = 0;  *p_data++ = 0;  *p_data++ = 0;  *p_data++ = 0;
1631             *p_data++ = 0;  *p_data++ = 0;  *p_data++ = 0;  *p_data++ = 0;
1632         }
1633         for( i_data_index = (i_data_size % 256) / 16; i_data_index--; )
1634         {
1635             /* Clear remaining 16 bytes blocks */
1636             *p_data++ = 0;  *p_data++ = 0;
1637         }
1638         p_data8 = (byte_t *)p_data;
1639         for( i_data_index = i_data_size % 16; i_data_index--; )
1640         {
1641             /* Clear remaining bytes */
1642             *p_data8++ = 0;
1643         }
1644     }
1645
1646     /*
1647      * Clear areas array
1648      */
1649     p_buffer->i_areas = 0;
1650 }
1651
1652 /*****************************************************************************
1653  * RenderPicture: render a picture
1654  *****************************************************************************
1655  * This function converts a picture from a video heap to a pixel-encoded image
1656  * and copies it to the current rendering buffer. No lock is required, since
1657  * the * rendered picture has been determined as existant, and will only be
1658  * destroyed by the vout thread later.
1659  *****************************************************************************/
1660 static void RenderPicture( vout_thread_t *p_vout, picture_t *p_pic )
1661 {
1662 #ifdef DEBUG_VOUT
1663     char                psz_date[MSTRTIME_MAX_SIZE];         /* picture date */
1664     mtime_t             render_time;               /* picture rendering time */
1665 #endif
1666     vout_buffer_t *     p_buffer;                        /* rendering buffer */
1667     byte_t *            p_pic_data;                /* convertion destination */
1668
1669     /* Get and set rendering information */
1670     p_buffer =          &p_vout->p_buffer[ p_vout->i_buffer_index ];
1671     p_pic_data =        p_buffer->p_data +
1672                         p_buffer->i_pic_x * p_vout->i_bytes_per_pixel +
1673                         p_buffer->i_pic_y * p_vout->i_bytes_per_line;
1674 #ifdef DEBUG_VOUT
1675     render_time = mdate();
1676 #endif
1677
1678
1679
1680     /*
1681      * Choose appropriate rendering function and render picture
1682      */
1683     switch( p_pic->i_type )
1684     {
1685     case YUV_420_PICTURE:
1686         p_vout->yuv.p_Convert420( p_vout, p_pic_data,
1687                                   p_pic->p_y, p_pic->p_u, p_pic->p_v,
1688                                   p_pic->i_width, p_pic->i_height,
1689                                   p_buffer->i_pic_width, p_buffer->i_pic_height,
1690                                   p_vout->i_bytes_per_line / p_vout->i_bytes_per_pixel,
1691                                   p_pic->i_matrix_coefficients );
1692         break;
1693     case YUV_422_PICTURE:
1694         p_vout->yuv.p_Convert422( p_vout, p_pic_data,
1695                                   p_pic->p_y, p_pic->p_u, p_pic->p_v,
1696                                   p_pic->i_width, p_pic->i_height,
1697                                   p_buffer->i_pic_width, p_buffer->i_pic_height,
1698                                   p_vout->i_bytes_per_line / p_vout->i_bytes_per_pixel,
1699                                   p_pic->i_matrix_coefficients );
1700         break;
1701     case YUV_444_PICTURE:
1702         p_vout->yuv.p_Convert444( p_vout, p_pic_data,
1703                                   p_pic->p_y, p_pic->p_u, p_pic->p_v,
1704                                   p_pic->i_width, p_pic->i_height,
1705                                   p_buffer->i_pic_width, p_buffer->i_pic_height,
1706                                   p_vout->i_bytes_per_line / p_vout->i_bytes_per_pixel,
1707                                   p_pic->i_matrix_coefficients );
1708         break;
1709 #ifdef DEBUG
1710     default:
1711         intf_DbgMsg("error: unknown picture type %d", p_pic->i_type );
1712         break;
1713 #endif
1714     }
1715
1716 #ifdef DEBUG_VOUT
1717     /* Print picture date and rendering time */
1718     intf_DbgMsg("picture %p rendered in buffer %d (%ld us), display date: %s", p_pic,
1719                 p_vout->i_buffer_index, (long) (mdate() - render_time),
1720                 mstrtime( psz_date, p_pic->date ));
1721 #endif
1722 }
1723
1724 /*****************************************************************************
1725  * RenderPictureInfo: print additionnal information on a picture
1726  *****************************************************************************
1727  * This function will print information such as fps and other picture
1728  * dependant information.
1729  *****************************************************************************/
1730 static void RenderPictureInfo( vout_thread_t *p_vout, picture_t *p_pic )
1731 {
1732     char        psz_buffer[256];                            /* string buffer */
1733
1734     /*
1735      * Print FPS rate in upper right corner
1736      */
1737     if( p_vout->c_fps_samples > VOUT_FPS_SAMPLES )
1738     {
1739         long i_fps = VOUT_FPS_SAMPLES * 1000000 * 10 /
1740                            ( p_vout->p_fps_sample[ (p_vout->c_fps_samples - 1)
1741                                                    % VOUT_FPS_SAMPLES ] -
1742                              p_vout->p_fps_sample[ p_vout->c_fps_samples
1743                                                    % VOUT_FPS_SAMPLES ] );
1744         sprintf( psz_buffer, "%li.%i fps", i_fps / 10, (int)i_fps % 10 );
1745         Print( p_vout, 0, 0, RIGHT_RALIGN, TOP_RALIGN, psz_buffer );
1746     }
1747
1748     /*
1749      * Print frames count and loop time in upper left corner
1750      */
1751     sprintf( psz_buffer, "%ld frames, render: %ldus",
1752              (long) p_vout->c_fps_samples, (long) p_vout->render_time );
1753     Print( p_vout, 0, 0, LEFT_RALIGN, TOP_RALIGN, psz_buffer );
1754
1755 #ifdef STATS
1756     /*
1757      * Print picture information in lower right corner
1758      */
1759     sprintf( psz_buffer, "%s picture %dx%d (%dx%d%+d%+d %s) -> %dx%d+%d+%d",
1760              (p_pic->i_type == YUV_420_PICTURE) ? "4:2:0" :
1761              ((p_pic->i_type == YUV_422_PICTURE) ? "4:2:2" :
1762               ((p_pic->i_type == YUV_444_PICTURE) ? "4:4:4" : "ukn-type")),
1763              p_pic->i_width, p_pic->i_height,
1764              p_pic->i_display_width, p_pic->i_display_height,
1765              p_pic->i_display_horizontal_offset, p_pic->i_display_vertical_offset,
1766              (p_pic->i_aspect_ratio == AR_SQUARE_PICTURE) ? "sq" :
1767              ((p_pic->i_aspect_ratio == AR_3_4_PICTURE) ? "4:3" :
1768               ((p_pic->i_aspect_ratio == AR_16_9_PICTURE) ? "16:9" :
1769                ((p_pic->i_aspect_ratio == AR_221_1_PICTURE) ? "2.21:1" : "ukn-ar" ))),
1770              p_vout->p_buffer[ p_vout->i_buffer_index ].i_pic_width,
1771              p_vout->p_buffer[ p_vout->i_buffer_index ].i_pic_height,
1772              p_vout->p_buffer[ p_vout->i_buffer_index ].i_pic_x,
1773              p_vout->p_buffer[ p_vout->i_buffer_index ].i_pic_y );
1774     Print( p_vout, 0, 0, RIGHT_RALIGN, BOTTOM_RALIGN, psz_buffer );
1775 #endif
1776 }
1777
1778 /*****************************************************************************
1779  * RenderSplash: render splash picture
1780  *****************************************************************************
1781  * This function will print something on the screen. It will return 0 if
1782  * nothing has been rendered, or 1 if something has been changed on the screen.
1783  * Note that if you absolutely want something to be printed, you will have
1784  * to force it by setting the last idle date to 0.
1785  * Unlike other rendering functions, this one calls the SetBufferPicture
1786  * function when needed.
1787  *****************************************************************************/
1788 int RenderSplash( vout_thread_t *p_vout )
1789 {
1790     int         i_x = 0, i_y = 0;                           /* text position */
1791     int         i_width, i_height;                              /* text size */
1792     char *psz_text =    "VideoLAN Client (" VERSION ")";  /* text to display */
1793
1794     memset( p_vout->p_buffer[ p_vout->i_buffer_index ].p_data,
1795                   p_vout->i_bytes_per_line * p_vout->i_height, 12);
1796
1797  //   SetBufferPicture( p_vout, NULL );
1798     vout_TextSize( p_vout->p_large_font, WIDE_TEXT | OUTLINED_TEXT, psz_text,
1799                    &i_width, &i_height );
1800     if( !Align( p_vout, &i_x, &i_y, i_width, i_height, CENTER_RALIGN, CENTER_RALIGN ) )
1801     {
1802         vout_Print( p_vout->p_large_font,
1803                     p_vout->p_buffer[ p_vout->i_buffer_index ].p_data +
1804                     i_x * p_vout->i_bytes_per_pixel + (i_y - 16 ) * p_vout->i_bytes_per_line,
1805                     p_vout->i_bytes_per_pixel, p_vout->i_bytes_per_line,
1806                     p_vout->i_white_pixel, p_vout->i_gray_pixel, 0,
1807                     WIDE_TEXT | OUTLINED_TEXT, psz_text, 100);
1808         SetBufferArea( p_vout, i_x, i_y, i_width, i_height);
1809     }
1810     return( 1 );
1811 }
1812
1813
1814 /*****************************************************************************
1815  * RenderIdle: render idle picture
1816  *****************************************************************************
1817  * This function will print something on the screen. It will return 0 if
1818  * nothing has been rendered, or 1 if something has been changed on the screen.
1819  * Note that if you absolutely want something to be printed, you will have
1820  * to force it by setting the last idle date to 0.
1821  * Unlike other rendering functions, this one calls the SetBufferPicture
1822  * function when needed.
1823  *****************************************************************************/
1824 int RenderIdle( vout_thread_t *p_vout )
1825 {
1826 #if 0
1827     int         i_x = 0, i_y = 0;                           /* text position */
1828     int         i_width, i_height;                              /* text size */
1829     int         i_amount = 0;                             /*  amount to draw */
1830     char *psz_text =    "Waiting for stream";            /* text to display */
1831     char *psz_wtext =   "[................]";
1832 #endif
1833     mtime_t     current_date;                                /* current date */
1834
1835
1836     memset( p_vout->p_buffer[ p_vout->i_buffer_index ].p_data,
1837                     p_vout->i_bytes_per_line * p_vout->i_height, 12);
1838
1839
1840     current_date = mdate();
1841     if( (current_date - p_vout->last_display_date) > VOUT_IDLE_DELAY
1842 //            && (current_date - p_vout->last_idle_date) > VOUT_IDLE_DELAY
1843     )
1844     {
1845         /* FIXME: idle screen disabled */
1846 #if 0
1847         SetBufferPicture( p_vout, NULL );
1848         vout_TextSize( p_vout->p_large_font, WIDE_TEXT | OUTLINED_TEXT, psz_text,
1849                        &i_width, &i_height );
1850         if( !Align( p_vout, &i_x, &i_y, i_width, i_height * 2, CENTER_RALIGN, CENTER_RALIGN ) )
1851         {
1852             i_amount = (int) ((current_date - p_vout->last_display_date ) / 5000LL);
1853             vout_Print( p_vout->p_large_font,
1854                         p_vout->p_buffer[ p_vout->i_buffer_index ].p_data +
1855                         i_x * p_vout->i_bytes_per_pixel + i_y * p_vout->i_bytes_per_line,
1856                         p_vout->i_bytes_per_pixel, p_vout->i_bytes_per_line,
1857                         p_vout->i_white_pixel, p_vout->i_gray_pixel, 0,
1858                         WIDE_TEXT | OUTLINED_TEXT, psz_text,  (i_amount / 3 ) %110);
1859
1860             vout_Print( p_vout->p_large_font,
1861                     p_vout->p_buffer[ p_vout->i_buffer_index ].p_data +
1862                     i_x * p_vout->i_bytes_per_pixel + (i_y + 16) * p_vout->i_bytes_per_line,
1863                     p_vout->i_bytes_per_pixel, p_vout->i_bytes_per_line,
1864                     p_vout->i_white_pixel, p_vout->i_gray_pixel, 0,
1865                     WIDE_TEXT | OUTLINED_TEXT, psz_wtext,  (i_amount/5)%110 );
1866
1867
1868             SetBufferArea( p_vout, i_x, i_y, i_width, i_height * 2 );
1869         }
1870 #endif
1871         return( 1 );
1872     }
1873     return( 0 );
1874 }
1875
1876 /*****************************************************************************
1877  * RenderInfo: render additionnal information
1878  *****************************************************************************
1879  * This function renders information which do not depend on the current
1880  * picture rendered.
1881  *****************************************************************************/
1882 static void RenderInfo( vout_thread_t *p_vout )
1883 {
1884 #ifdef DEBUG
1885     char        psz_buffer[256];                            /* string buffer */
1886     int         i_ready_pic = 0;                           /* ready pictures */
1887     int         i_reserved_pic = 0;                     /* reserved pictures */
1888     int         i_picture;                                  /* picture index */
1889 #endif
1890
1891 #ifdef DEBUG
1892     /*
1893      * Print thread state in lower left corner
1894      */
1895     for( i_picture = 0; i_picture < VOUT_MAX_PICTURES; i_picture++ )
1896     {
1897         switch( p_vout->p_picture[i_picture].i_status )
1898         {
1899         case RESERVED_PICTURE:
1900         case RESERVED_DATED_PICTURE:
1901         case RESERVED_DISP_PICTURE:
1902             i_reserved_pic++;
1903             break;
1904         case READY_PICTURE:
1905             i_ready_pic++;
1906             break;
1907         }
1908     }
1909     sprintf( psz_buffer, "pic: %d (%d/%d)/%d",
1910              p_vout->i_pictures, i_reserved_pic, i_ready_pic, VOUT_MAX_PICTURES );
1911     Print( p_vout, 0, 0, LEFT_RALIGN, BOTTOM_RALIGN, psz_buffer );
1912 #endif
1913 }
1914
1915 /*****************************************************************************
1916  * RenderSubPicture: render a subpicture
1917  *****************************************************************************
1918  * This function renders a sub picture unit.
1919  *****************************************************************************/
1920 static void RenderSubPicture( vout_thread_t *p_vout, subpicture_t *p_subpic )
1921 {
1922     p_vout_font_t       p_font;                                 /* text font */
1923     int                 i_width, i_height;          /* subpicture dimensions */
1924
1925     while( p_subpic != NULL )
1926     {
1927         switch( p_subpic->i_type )
1928         {
1929         case DVD_SUBPICTURE:                          /* DVD subpicture unit */
1930             /* test if the picture really has to be displayed */
1931             if( mdate() < p_subpic->begin_date )
1932             {
1933                 /* not yet, see you later */
1934                 break;
1935             }
1936             if( mdate() > p_subpic->end_date )
1937             {
1938                 /* too late, destroying the subpic */
1939                 vout_DestroySubPicture( p_vout, p_subpic );
1940                 break;
1941             }
1942             vout_RenderSPU( &p_vout->p_buffer[ p_vout->i_buffer_index ],
1943                             p_subpic, p_vout->i_bytes_per_pixel,
1944                             p_vout->i_bytes_per_line );
1945             break;
1946         case TEXT_SUBPICTURE:                            /* single line text */
1947             /* Select default font if not specified */
1948             p_font = p_subpic->type.text.p_font;
1949             if( p_font == NULL )
1950             {
1951                 p_font = p_vout->p_default_font;
1952             }
1953
1954             /* Compute text size (width and height fields are ignored)
1955              * and print it */
1956             vout_TextSize( p_font, p_subpic->type.text.i_style,
1957                            p_subpic->p_data, &i_width, &i_height );
1958             if( !Align( p_vout, &p_subpic->i_x, &p_subpic->i_y,
1959                         i_width, i_height, p_subpic->i_horizontal_align,
1960                         p_subpic->i_vertical_align ) )
1961             {
1962                 vout_Print( p_font,
1963                             p_vout->p_buffer[ p_vout->i_buffer_index ].p_data +
1964                             p_subpic->i_x * p_vout->i_bytes_per_pixel +
1965                             p_subpic->i_y * p_vout->i_bytes_per_line,
1966                             p_vout->i_bytes_per_pixel, p_vout->i_bytes_per_line,
1967                             p_subpic->type.text.i_char_color,
1968                             p_subpic->type.text.i_border_color,
1969                             p_subpic->type.text.i_bg_color,
1970                             p_subpic->type.text.i_style, p_subpic->p_data, 100 );
1971                 SetBufferArea( p_vout, p_subpic->i_x, p_subpic->i_y,
1972                                i_width, i_height );
1973             }
1974             break;
1975
1976 #ifdef DEBUG
1977         default:
1978             intf_DbgMsg( "error: unknown subpicture %p type %d",
1979                          p_subpic, p_subpic->i_type );
1980 #endif
1981         }
1982
1983         p_subpic = p_subpic->p_next;
1984     }
1985 }
1986
1987 /*****************************************************************************
1988  * RenderInterface: render the interface
1989  *****************************************************************************
1990  * This function renders the interface, if any.
1991  *****************************************************************************/
1992 static void RenderInterface( vout_thread_t *p_vout )
1993 {
1994     int         i_height, i_text_height;            /* total and text height */
1995     int         i_width_1, i_width_2;                          /* text width */
1996     int         i_byte;                                        /* byte index */
1997     const char *psz_text_1 = "[1-9] Channel   [i]nfo   [c]olor     [g/G]amma";
1998     const char *psz_text_2 = "[+/-] Volume    [m]ute   [s]caling   [Q]uit";
1999
2000     /* Get text size */
2001     vout_TextSize( p_vout->p_large_font, OUTLINED_TEXT, psz_text_1, &i_width_1, &i_height );
2002     vout_TextSize( p_vout->p_large_font, OUTLINED_TEXT, psz_text_2, &i_width_2, &i_text_height );
2003     i_height += i_text_height;
2004
2005     /* Render background */
2006     for( i_byte = (p_vout->i_height - i_height) * p_vout->i_bytes_per_line;
2007          i_byte < p_vout->i_height * p_vout->i_bytes_per_line;
2008          i_byte++ )
2009     {
2010         /* XXX?? noooo ! */
2011         p_vout->p_buffer[ p_vout->i_buffer_index ].p_data[ i_byte ] = p_vout->i_blue_pixel;
2012     }
2013
2014     /* Render text, if not larger than screen */
2015     if( i_width_1 < p_vout->i_width )
2016     {
2017         vout_Print( p_vout->p_large_font, p_vout->p_buffer[ p_vout->i_buffer_index ].p_data +
2018                     (p_vout->i_height - i_height) * p_vout->i_bytes_per_line,
2019                     p_vout->i_bytes_per_pixel, p_vout->i_bytes_per_line,
2020                     p_vout->i_white_pixel, p_vout->i_black_pixel, 0,
2021                     OUTLINED_TEXT, psz_text_1, 100 );
2022     }
2023     if( i_width_2 < p_vout->i_width )
2024     {
2025         vout_Print( p_vout->p_large_font, p_vout->p_buffer[ p_vout->i_buffer_index ].p_data +
2026                     (p_vout->i_height - i_height + i_text_height) * p_vout->i_bytes_per_line,
2027                     p_vout->i_bytes_per_pixel, p_vout->i_bytes_per_line,
2028                     p_vout->i_white_pixel, p_vout->i_black_pixel, 0,
2029                     OUTLINED_TEXT, psz_text_2, 100 );
2030     }
2031
2032     /* Activate modified area */
2033     SetBufferArea( p_vout, 0, p_vout->i_height - i_height, p_vout->i_width, i_height );
2034 }
2035
2036 /*****************************************************************************
2037  * Manage: manage thread
2038  *****************************************************************************
2039  * This function will handle changes in thread configuration.
2040  *****************************************************************************/
2041 static int Manage( vout_thread_t *p_vout )
2042 {
2043 #ifdef DEBUG_VOUT
2044     if( p_vout->i_changes )
2045     {
2046         intf_DbgMsg("changes: 0x%x (no display: 0x%x)", p_vout->i_changes,
2047                     0 /* p_vout->i_changes & VOUT_NODISPLAY_CHANGE */ );
2048     }
2049 #endif
2050
2051     /* On gamma or grayscale change, rebuild tables */
2052     if( p_vout->i_changes & (VOUT_GAMMA_CHANGE | VOUT_GRAYSCALE_CHANGE |
2053                              VOUT_YUV_CHANGE) )
2054     {
2055         if( vout_ResetYUV( p_vout ) )
2056         {
2057             intf_ErrMsg( "vout error: can't rebuild conversion tables" );
2058             return( 1 );
2059         }
2060     }
2061
2062     /* Clear changes flags which does not need management or have been
2063      * handled */
2064     p_vout->i_changes &= ~(VOUT_GAMMA_CHANGE  | VOUT_GRAYSCALE_CHANGE |
2065                            VOUT_YUV_CHANGE    | VOUT_INFO_CHANGE |
2066                            VOUT_INTF_CHANGE   | VOUT_SCALE_CHANGE |
2067                            VOUT_CURSOR_CHANGE | VOUT_FULLSCREEN_CHANGE );
2068
2069     /* Detect unauthorized changes */
2070     if( p_vout->i_changes )
2071     {
2072         /* Some changes were not acknowledged by p_vout->pf_manage or this
2073          * function, it means they should not be authorized */
2074         intf_ErrMsg( "vout error: unauthorized changes in the vout thread" );
2075         return( 1 );
2076     }
2077
2078     return( 0 );
2079 }
2080
2081 /*****************************************************************************
2082  * Align: align a subpicture in the screen
2083  *****************************************************************************
2084  * This function is used for rendering text or subpictures. It returns non 0
2085  * it the final aera is not fully included in display area. Return coordinates
2086  * are absolute.
2087  *****************************************************************************/
2088 static int Align( vout_thread_t *p_vout, int *pi_x, int *pi_y,
2089                    int i_width, int i_height, int i_h_align, int i_v_align )
2090 {
2091     /* Align horizontally */
2092     switch( i_h_align )
2093     {
2094     case CENTER_ALIGN:
2095         *pi_x -= i_width / 2;
2096         break;
2097     case CENTER_RALIGN:
2098         *pi_x += (p_vout->i_width - i_width) / 2;
2099         break;
2100     case RIGHT_ALIGN:
2101         *pi_x -= i_width;
2102         break;
2103     case RIGHT_RALIGN:
2104         *pi_x += p_vout->i_width - i_width;
2105         break;
2106     }
2107
2108     /* Align vertically */
2109     switch( i_v_align )
2110     {
2111     case CENTER_ALIGN:
2112         *pi_y -= i_height / 2;
2113         break;
2114     case CENTER_RALIGN:
2115         *pi_y += (p_vout->i_height - i_height) / 2;
2116         break;
2117     case BOTTOM_ALIGN:
2118         *pi_y -= i_height;
2119         break;
2120     case BOTTOM_RALIGN:
2121         *pi_y += p_vout->i_height - i_height;
2122         break;
2123     case SUBTITLE_RALIGN:
2124         *pi_y += (p_vout->i_height + p_vout->p_buffer[ p_vout->i_buffer_index ].i_pic_y +
2125                   p_vout->p_buffer[ p_vout->i_buffer_index ].i_pic_height - i_height) / 2;
2126         break;
2127     }
2128
2129     /* Return non 0 if clipping failed */
2130     return( (*pi_x < 0) || (*pi_y < 0) ||
2131             (*pi_x + i_width > p_vout->i_width) || (*pi_y + i_height > p_vout->i_height) );
2132 }
2133
2134 /*****************************************************************************
2135  * SetPalette: sets an 8 bpp palette
2136  *****************************************************************************
2137  * This function is just a prototype that does nothing. Architectures that
2138  * support palette allocation should override it.
2139  *****************************************************************************/
2140 static void     SetPalette        ( p_vout_thread_t p_vout, u16 *red,
2141                                     u16 *green, u16 *blue, u16 *transp )
2142 {
2143     intf_ErrMsg( "vout error: method does not support palette changing" );
2144 }
2145