git.sesse.net Git - vlc/blob - modules/video_output/ggi.c

   1 /*****************************************************************************
   2  * ggi.c : GGI plugin for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2000-2009 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Vincent Seguin <seguin@via.ecp.fr>
   8  *          Samuel Hocevar <sam@zoy.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28 #include <errno.h>                                                 /* ENOMEM */
  29
  30 #include <ggi/ggi.h>
  31
  32 #ifdef HAVE_CONFIG_H
  33 # include "config.h"
  34 #endif
  35
  36 #include <vlc_common.h>
  37 #include <vlc_plugin.h>
  38 #include <vlc_interface.h>
  39 #include <vlc_vout.h>
  40
  41 /*****************************************************************************
  42  * Local prototypes
  43  *****************************************************************************/
  44 static int  Create    ( vlc_object_t * );
  45 static void Destroy   ( vlc_object_t * );
  46
  47 static int  Init      ( vout_thread_t * );
  48 static void End       ( vout_thread_t * );
  49 static int  Manage    ( vout_thread_t * );
  50 static void Display   ( vout_thread_t *, picture_t * );
  51
  52 static int  OpenDisplay    ( vout_thread_t * );
  53 static void CloseDisplay   ( vout_thread_t * );
  54 static void SetPalette     ( vout_thread_t *, uint16_t *, uint16_t *, uint16_t * );
  55
  56 /*****************************************************************************
  57  * Module descriptor
  58  *****************************************************************************/
  59 #define DISPLAY_TEXT N_("X11 display")
  60 #define DISPLAY_LONGTEXT N_( \
  61             "X11 hardware display to use.\n" \
  62             "By default, VLC will use the value of the DISPLAY " \
  63             "environment variable.")
  64
  65 vlc_module_begin ()
  66     add_string( "ggi-display", NULL, NULL, DISPLAY_TEXT, DISPLAY_LONGTEXT, true )
  67     set_description( "General Graphics Interface video output" )
  68     set_capability( "video output", 30 )
  69     set_callbacks( Create, Destroy )
  70 vlc_module_end ()
  71
  72 /*****************************************************************************
  73  * vout_sys_t: video output GGI method descriptor
  74  *****************************************************************************
  75  * This structure is part of the video output thread descriptor.
  76  * It describes the GGI specific properties of an output thread.
  77  *****************************************************************************/
  78 struct vout_sys_t
  79 {
  80     /* GGI system information */
  81     ggi_visual_t        p_display;                         /* display device */
  82
  83     ggi_mode            mode;                             /* mode descriptor */
  84     int                 i_bits_per_pixel;
  85
  86     /* Buffer information */
  87     ggi_directbuffer *  pp_buffer[2];                             /* buffers */
  88     int                 i_index;
  89
  90     bool          b_must_acquire;   /* must be acquired before writing */
  91 };
  92
  93 /*****************************************************************************
  94  * Create: allocate GGI video thread output method
  95  *****************************************************************************
  96  * This function allocate and initialize a GGI vout method. It uses some of the
  97  * vout properties to choose the correct mode, and change them according to the
  98  * mode actually used.
  99  *****************************************************************************/
 100 static int Create( vlc_object_t *p_this )
 101 {
 102     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 103
 104     /* Allocate structure */
 105     p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
 106     if( p_vout->p_sys == NULL )
 107         return VLC_ENOMEM;
 108
 109     /* Open and initialize device */
 110     if( OpenDisplay( p_vout ) )
 111     {
 112         msg_Err( p_vout, "cannot initialize GGI display" );
 113         free( p_vout->p_sys );
 114         return VLC_EGENERIC;
 115     }
 116
 117     p_vout->pf_init = Init;
 118     p_vout->pf_end = End;
 119     p_vout->pf_manage = Manage;
 120     p_vout->pf_render = NULL;
 121     p_vout->pf_display = Display;
 122
 123     return VLC_SUCCESS;
 124 }
 125
 126 /*****************************************************************************
 127  * Init: initialize GGI video thread output method
 128  *****************************************************************************
 129  * This function initialize the GGI display device.
 130  *****************************************************************************/
 131 static int Init( vout_thread_t *p_vout )
 132 {
 133 #define p_b p_vout->p_sys->pp_buffer
 134     int i_index;
 135     picture_t *p_pic;
 136
 137     I_OUTPUTPICTURES = 0;
 138
 139     p_vout->output.i_width  = p_vout->p_sys->mode.visible.x;
 140     p_vout->output.i_height = p_vout->p_sys->mode.visible.y;
 141     p_vout->output.i_aspect = p_vout->p_sys->mode.visible.x
 142                                * VOUT_ASPECT_FACTOR
 143                                / p_vout->p_sys->mode.visible.y;
 144
 145     switch( p_vout->p_sys->i_bits_per_pixel )
 146     {
 147         case 8:
 148             p_vout->output.i_chroma = VLC_CODEC_RGB8;
 149             p_vout->output.pf_setpalette = SetPalette;
 150             break;
 151         case 15:
 152             p_vout->output.i_chroma = VLC_CODEC_RGB15; break;
 153         case 16:
 154             p_vout->output.i_chroma = VLC_CODEC_RGB16; break;
 155         case 24:
 156             p_vout->output.i_chroma = VLC_CODEC_RGB24; break;
 157         case 32:
 158             p_vout->output.i_chroma = VLC_CODEC_RGB32; break;
 159         default:
 160             msg_Err( p_vout, "unknown screen depth %i",
 161                      p_vout->p_sys->i_bits_per_pixel );
 162             return VLC_EGENERIC;
 163     }
 164
 165     /* Only useful for bits_per_pixel != 8 */
 166     p_vout->output.i_rmask = p_b[ 0 ]->buffer.plb.pixelformat->red_mask;
 167     p_vout->output.i_gmask = p_b[ 0 ]->buffer.plb.pixelformat->green_mask;
 168     p_vout->output.i_bmask = p_b[ 0 ]->buffer.plb.pixelformat->blue_mask;
 169
 170     p_pic = NULL;
 171
 172     /* Find an empty picture slot */
 173     for( i_index = 0 ; i_index < VOUT_MAX_PICTURES ; i_index++ )
 174     {
 175         if( p_vout->p_picture[ i_index ].i_status == FREE_PICTURE )
 176         {
 177             p_pic = p_vout->p_picture + i_index;
 178             break;
 179         }
 180     }
 181
 182     if( p_pic == NULL )
 183     {
 184         return VLC_EGENERIC;
 185     }
 186
 187     /* We know the chroma, allocate a buffer which will be used
 188      * directly by the decoder */
 189     p_vout->p_sys->i_index = 0;
 190     p_pic->p->p_pixels = p_b[ 0 ]->write;
 191     p_pic->p->i_pixel_pitch = p_b[ 0 ]->buffer.plb.pixelformat->size / 8;
 192     p_pic->p->i_lines = p_vout->p_sys->mode.visible.y;
 193     p_pic->p->i_visible_lines = p_vout->p_sys->mode.visible.y;
 194
 195     p_pic->p->i_pitch = p_b[ 0 ]->buffer.plb.stride;
 196
 197     if( p_b[ 0 ]->buffer.plb.pixelformat->size / 8
 198          * p_vout->p_sys->mode.visible.x
 199         != p_b[ 0 ]->buffer.plb.stride )
 200     {
 201         p_pic->p->i_visible_pitch = p_b[ 0 ]->buffer.plb.pixelformat->size
 202                                      / 8 * p_vout->p_sys->mode.visible.x;
 203     }
 204     else
 205     {
 206         p_pic->p->i_visible_pitch = p_b[ 0 ]->buffer.plb.stride;
 207     }
 208
 209     p_pic->i_planes = 1;
 210
 211     p_pic->i_status = DESTROYED_PICTURE;
 212     p_pic->i_type   = DIRECT_PICTURE;
 213
 214     PP_OUTPUTPICTURE[ I_OUTPUTPICTURES ] = p_pic;
 215
 216     I_OUTPUTPICTURES++;
 217
 218     /* Acquire first buffer */
 219     if( p_vout->p_sys->b_must_acquire )
 220     {
 221         ggiResourceAcquire( p_b[ 0 ]->resource,
 222                             GGI_ACTYPE_WRITE );
 223     }
 224
 225     /* Listen to the keyboard and the mouse buttons */
 226     ggiSetEventMask( p_vout->p_sys->p_display,
 227                      emKeyboard | emPtrButtonPress | emPtrButtonRelease );
 228
 229     /* Set asynchronous display mode -- usually quite faster */
 230     ggiAddFlags( p_vout->p_sys->p_display, GGIFLAG_ASYNC );
 231
 232     return VLC_SUCCESS;
 233 #undef p_b
 234 }
 235
 236 /*****************************************************************************
 237  * End: terminate GGI video thread output method
 238  *****************************************************************************
 239  * Terminate an output method created by Create
 240  *****************************************************************************/
 241 static void End( vout_thread_t *p_vout )
 242 {
 243 #define p_b p_vout->p_sys->pp_buffer
 244     /* Release buffer */
 245     if( p_vout->p_sys->b_must_acquire )
 246     {
 247         ggiResourceRelease( p_b[ p_vout->p_sys->i_index ]->resource );
 248     }
 249 #undef p_b
 250 }
 251
 252 /*****************************************************************************
 253  * Destroy: destroy GGI video thread output method
 254  *****************************************************************************
 255  * Terminate an output method created by Create
 256  *****************************************************************************/
 257 static void Destroy( vlc_object_t *p_this )
 258 {
 259     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 260
 261     CloseDisplay( p_vout );
 262
 263     free( p_vout->p_sys );
 264 }
 265
 266 /*****************************************************************************
 267  * Manage: handle GGI events
 268  *****************************************************************************
 269  * This function should be called regularly by video output thread. It returns
 270  * a non null value if an error occurred.
 271  *****************************************************************************/
 272 static int Manage( vout_thread_t *p_vout )
 273 {
 274     struct timeval tv = { 0, 1000 };                        /* 1 millisecond */
 275     gii_event_mask mask;
 276     gii_event      event;
 277
 278     mask = emKeyboard | emPtrButtonPress | emPtrButtonRelease;
 279
 280     ggiEventPoll( p_vout->p_sys->p_display, mask, &tv );
 281
 282     while( ggiEventsQueued( p_vout->p_sys->p_display, mask) )
 283     {
 284         ggiEventRead( p_vout->p_sys->p_display, &event, mask);
 285
 286         switch( event.any.type )
 287         {
 288             case evKeyRelease:
 289
 290                 switch( event.key.sym )
 291                 {
 292                     case 'q':
 293                     case 'Q':
 294                     case GIIUC_Escape:
 295                         libvlc_Quit( p_vout->p_libvlc );
 296                         break;
 297
 298                     default:
 299                         break;
 300                 }
 301                 break;
 302
 303             case evPtrButtonRelease:
 304
 305                 switch( event.pbutton.button )
 306                 {
 307                     case GII_PBUTTON_LEFT:
 308                         var_SetBool( p_vout, "mouse-clicked", true );
 309                         break;
 310
 311                     case GII_PBUTTON_RIGHT:
 312                         var_SetBool( p_vout->p_libvlc, "intf-popupmenu", true );
 313                         break;
 314                 }
 315                 break;
 316
 317             default:
 318                 break;
 319         }
 320     }
 321
 322     return( 0 );
 323 }
 324
 325 /*****************************************************************************
 326  * Display: displays previously rendered output
 327  *****************************************************************************/
 328 static void Display( vout_thread_t *p_vout, picture_t *p_pic )
 329 {
 330 #define p_b p_vout->p_sys->pp_buffer
 331     p_pic->p->p_pixels = p_b[ p_vout->p_sys->i_index ]->write;
 332
 333     /* Change display frame */
 334     if( p_vout->p_sys->b_must_acquire )
 335     {
 336         ggiResourceRelease( p_b[ p_vout->p_sys->i_index ]->resource );
 337     }
 338     ggiSetDisplayFrame( p_vout->p_sys->p_display,
 339                         p_b[ p_vout->p_sys->i_index ]->frame );
 340
 341     /* Swap buffers and change write frame */
 342     p_vout->p_sys->i_index ^= 1;
 343     p_pic->p->p_pixels = p_b[ p_vout->p_sys->i_index ]->write;
 344
 345     if( p_vout->p_sys->b_must_acquire )
 346     {
 347         ggiResourceAcquire( p_b[ p_vout->p_sys->i_index ]->resource,
 348                             GGI_ACTYPE_WRITE );
 349     }
 350     ggiSetWriteFrame( p_vout->p_sys->p_display,
 351                       p_b[ p_vout->p_sys->i_index ]->frame );
 352
 353     /* Flush the output so that it actually displays */
 354     ggiFlush( p_vout->p_sys->p_display );
 355 #undef p_b
 356 }
 357
 358 /* following functions are local */
 359
 360 /*****************************************************************************
 361  * OpenDisplay: open and initialize GGI device
 362  *****************************************************************************
 363  * Open and initialize display according to preferences specified in the vout
 364  * thread fields.
 365  *****************************************************************************/
 366 static int OpenDisplay( vout_thread_t *p_vout )
 367 {
 368 #define p_b p_vout->p_sys->pp_buffer
 369     ggi_color   col_fg;                                  /* foreground color */
 370     ggi_color   col_bg;                                  /* background color */
 371     int         i_index;                               /* all purposes index */
 372     char        *psz_display;
 373
 374     /* Initialize library */
 375     if( ggiInit() )
 376     {
 377         msg_Err( p_vout, "cannot initialize GGI library" );
 378         return VLC_EGENERIC;
 379     }
 380
 381     /* Open display */
 382     psz_display = config_GetPsz( p_vout, "ggi-display" );
 383
 384     p_vout->p_sys->p_display = ggiOpen( psz_display, NULL );
 385     free( psz_display );
 386
 387     if( p_vout->p_sys->p_display == NULL )
 388     {
 389         msg_Err( p_vout, "cannot open GGI default display" );
 390         ggiExit();
 391         return VLC_EGENERIC;
 392     }
 393
 394     /* Find most appropriate mode */
 395     p_vout->p_sys->mode.frames =    2;                          /* 2 buffers */
 396     p_vout->p_sys->mode.visible.x = config_GetInt( p_vout, "width" );
 397     p_vout->p_sys->mode.visible.y = config_GetInt( p_vout, "height" );
 398     p_vout->p_sys->mode.virt.x =    GGI_AUTO;
 399     p_vout->p_sys->mode.virt.y =    GGI_AUTO;
 400     p_vout->p_sys->mode.size.x =    GGI_AUTO;
 401     p_vout->p_sys->mode.size.y =    GGI_AUTO;
 402     p_vout->p_sys->mode.graphtype = GT_15BIT;        /* minimum usable depth */
 403     p_vout->p_sys->mode.dpp.x =     GGI_AUTO;
 404     p_vout->p_sys->mode.dpp.y =     GGI_AUTO;
 405     ggiCheckMode( p_vout->p_sys->p_display, &p_vout->p_sys->mode );
 406
 407     /* FIXME: Check that returned mode has some minimum properties */
 408
 409     /* Set mode */
 410     if( ggiSetMode( p_vout->p_sys->p_display, &p_vout->p_sys->mode ) )
 411     {
 412         msg_Err( p_vout, "cannot set GGI mode" );
 413         ggiClose( p_vout->p_sys->p_display );
 414         ggiExit();
 415         return VLC_EGENERIC;
 416     }
 417
 418     /* Check buffers properties */
 419     p_vout->p_sys->b_must_acquire = 0;
 420     for( i_index = 0; i_index < 2; i_index++ )
 421     {
 422         /* Get buffer address */
 423         p_vout->p_sys->pp_buffer[ i_index ] =
 424             (ggi_directbuffer *)ggiDBGetBuffer( p_vout->p_sys->p_display,
 425                                                 i_index );
 426         if( p_b[ i_index ] == NULL )
 427         {
 428             msg_Err( p_vout, "double buffering is not possible" );
 429             ggiClose( p_vout->p_sys->p_display );
 430             ggiExit();
 431             return VLC_EGENERIC;
 432         }
 433
 434         /* Check buffer properties */
 435         if( ! ( p_b[ i_index ]->type & GGI_DB_SIMPLE_PLB )
 436            || ( p_b[ i_index ]->page_size != 0 )
 437            || ( p_b[ i_index ]->write == NULL )
 438            || ( p_b[ i_index ]->noaccess != 0 )
 439            || ( p_b[ i_index ]->align != 0 ) )
 440         {
 441             msg_Err( p_vout, "incorrect video memory type" );
 442             ggiClose( p_vout->p_sys->p_display );
 443             ggiExit();
 444             return VLC_EGENERIC;
 445         }
 446
 447         /* Check if buffer needs to be acquired before write */
 448         if( ggiResourceMustAcquire( p_b[ i_index ]->resource ) )
 449         {
 450             p_vout->p_sys->b_must_acquire = 1;
 451         }
 452     }
 453
 454     /* Set graphic context colors */
 455     col_fg.r = col_fg.g = col_fg.b = -1;
 456     col_bg.r = col_bg.g = col_bg.b = 0;
 457     if( ggiSetGCForeground(p_vout->p_sys->p_display,
 458                            ggiMapColor(p_vout->p_sys->p_display,&col_fg)) ||
 459         ggiSetGCBackground(p_vout->p_sys->p_display,
 460                            ggiMapColor(p_vout->p_sys->p_display,&col_bg)) )
 461     {
 462         msg_Err( p_vout, "cannot set colors" );
 463         ggiClose( p_vout->p_sys->p_display );
 464         ggiExit();
 465         return VLC_EGENERIC;
 466     }
 467
 468     /* Set clipping for text */
 469     if( ggiSetGCClipping( p_vout->p_sys->p_display, 0, 0,
 470                           p_vout->p_sys->mode.visible.x,
 471                           p_vout->p_sys->mode.visible.y ) )
 472     {
 473         msg_Err( p_vout, "cannot set clipping" );
 474         ggiClose( p_vout->p_sys->p_display );
 475         ggiExit();
 476         return VLC_EGENERIC;
 477     }
 478
 479     /* FIXME: set palette in 8bpp */
 480     p_vout->p_sys->i_bits_per_pixel = p_b[ 0 ]->buffer.plb.pixelformat->depth;
 481
 482     return VLC_SUCCESS;
 483 #undef p_b
 484 }
 485
 486 /*****************************************************************************
 487  * CloseDisplay: close and reset GGI device
 488  *****************************************************************************
 489  * This function returns all resources allocated by OpenDisplay and restore
 490  * the original state of the device.
 491  *****************************************************************************/
 492 static void CloseDisplay( vout_thread_t *p_vout )
 493 {
 494     /* Restore original mode and close display */
 495     ggiClose( p_vout->p_sys->p_display );
 496
 497     /* Exit library */
 498     ggiExit();
 499 }
 500
 501 /*****************************************************************************
 502  * SetPalette: sets an 8 bpp palette
 503  *****************************************************************************/
 504 static void SetPalette( vout_thread_t *p_vout,
 505                         uint16_t *red, uint16_t *green, uint16_t *blue )
 506 {
 507     ggi_color colors[256];
 508     int i;
 509
 510     /* Fill colors with color information */
 511     for( i = 0; i < 256; i++ )
 512     {
 513         colors[ i ].r = red[ i ];
 514         colors[ i ].g = green[ i ];
 515         colors[ i ].b = blue[ i ];
 516         colors[ i ].a = 0;
 517     }
 518
 519     /* Set palette */
 520     if( ggiSetPalette( p_vout->p_sys->p_display, 0, 256, colors ) < 0 )
 521     {
 522         msg_Err( p_vout, "failed to set palette" );
 523     }
 524 }
 525