git.sesse.net Git - vlc/blob - plugins/fb/vout_fb.c

   1 /*****************************************************************************
   2  * vout_fb.c: Linux framebuffer video output display method
   3  *****************************************************************************
   4  * Copyright (C) 1999, 2000 VideoLAN
   5  *
   6  * Authors:
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  21  *****************************************************************************/
  22
  23 /*****************************************************************************
  24  * Preamble
  25  *****************************************************************************/
  26 #include "defs.h"
  27
  28 #include <errno.h>                                                 /* ENOMEM */
  29 #include <stdlib.h>                                                /* free() */
  30 #include <string.h>                                            /* strerror() */
  31
  32 #include <fcntl.h>                                                 /* open() */
  33 #include <unistd.h>                                               /* close() */
  34 #include <linux/fb.h>
  35 #include <sys/ioctl.h>
  36 #include <sys/mman.h>                                              /* mmap() */
  37
  38 #include "config.h"
  39 #include "common.h"
  40 #include "threads.h"
  41 #include "mtime.h"
  42 #include "plugins.h"
  43
  44 #include "video.h"
  45 #include "video_output.h"
  46
  47 #include "intf_msg.h"
  48 #include "main.h"
  49
  50 /*****************************************************************************
  51  * vout_sys_t: video output framebuffer method descriptor
  52  *****************************************************************************
  53  * This structure is part of the video output thread descriptor.
  54  * It describes the FB specific properties of an output thread.
  55  *****************************************************************************/
  56 typedef struct vout_sys_s
  57 {
  58     /* System informations */
  59     int                         i_fb_dev;       /* framebuffer device handle */
  60     struct fb_var_screeninfo    var_info;   /* framebuffer mode informations */
  61
  62     /* Video memory */
  63     byte_t *                    p_video;                      /* base adress */
  64     size_t                      i_page_size;                    /* page size */
  65
  66     struct fb_cmap              fb_cmap;                /* original colormap */
  67     unsigned short              *fb_palette;             /* original palette */
  68
  69 } vout_sys_t;
  70
  71 /*****************************************************************************
  72  * Local prototypes
  73  *****************************************************************************/
  74 static int     FBOpenDisplay   ( vout_thread_t *p_vout );
  75 static void    FBCloseDisplay  ( vout_thread_t *p_vout );
  76
  77 /*****************************************************************************
  78  * vout_SysCreate: allocates FB video thread output method
  79  *****************************************************************************
  80  * This function allocates and initializes a FB vout method.
  81  *****************************************************************************/
  82 int vout_SysCreate( vout_thread_t *p_vout, char *psz_display,
  83                     int i_root_window, void *p_data )
  84 {
  85     /* Allocate structure */
  86     p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
  87     if( p_vout->p_sys == NULL )
  88     {
  89         intf_ErrMsg("error: %s\n", strerror(ENOMEM) );
  90         return( 1 );
  91     }
  92
  93     /* Open and initialize device */
  94     if( FBOpenDisplay( p_vout ) )
  95     {
  96         intf_ErrMsg("vout error: can't open display\n");
  97         free( p_vout->p_sys );
  98         return( 1 );
  99     }
 100
 101     return( 0 );
 102 }
 103
 104 /*****************************************************************************
 105  * vout_SysInit: initialize framebuffer video thread output method
 106  *****************************************************************************/
 107 int vout_SysInit( vout_thread_t *p_vout )
 108 {
 109     return( 0 );
 110 }
 111
 112 /*****************************************************************************
 113  * vout_SysEnd: terminate FB video thread output method
 114  *****************************************************************************/
 115 void vout_SysEnd( vout_thread_t *p_vout )
 116 {
 117     ;
 118 }
 119
 120 /*****************************************************************************
 121  * vout_SysDestroy: destroy FB video thread output method
 122  *****************************************************************************
 123  * Terminate an output method created by vout_CreateOutputMethod
 124  *****************************************************************************/
 125 void vout_SysDestroy( vout_thread_t *p_vout )
 126 {
 127     FBCloseDisplay( p_vout );
 128     free( p_vout->p_sys );
 129 }
 130
 131 /*****************************************************************************
 132  * vout_SysManage: handle FB events
 133  *****************************************************************************
 134  * This function should be called regularly by video output thread. It manages
 135  * console events. It returns a non null value on error.
 136  *****************************************************************************/
 137 int vout_SysManage( vout_thread_t *p_vout )
 138 {
 139     /*
 140      * Size change
 141      */
 142     if( p_vout->i_changes & VOUT_SIZE_CHANGE )
 143     {
 144         intf_DbgMsg("resizing window\n");
 145         p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
 146
 147         /* Destroy XImages to change their size */
 148         vout_SysEnd( p_vout );
 149
 150         /* Recreate XImages. If SysInit failed, the thread can't go on. */
 151         if( vout_SysInit( p_vout ) )
 152         {
 153             intf_ErrMsg("error: can't resize display\n");
 154             return( 1 );
 155         }
 156
 157 #if 1
 158         /* Tell the video output thread that it will need to rebuild YUV
 159          * tables. This is needed since conversion buffer size may have changed */
 160         p_vout->i_changes |= VOUT_YUV_CHANGE;
 161         intf_Msg("Video display resized (%dx%d)\n", p_vout->i_width, p_vout->i_height);
 162 #endif
 163     }
 164
 165     return 0;
 166 }
 167
 168 /*****************************************************************************
 169  * vout_SysDisplay: displays previously rendered output
 170  *****************************************************************************
 171  * This function send the currently rendered image to FB image, waits until
 172  * it is displayed and switch the two rendering buffers, preparing next frame.
 173  *****************************************************************************/
 174 void vout_SysDisplay( vout_thread_t *p_vout )
 175 {
 176     /* swap the two Y offsets */
 177     p_vout->p_sys->var_info.yoffset = p_vout->i_buffer_index ? p_vout->p_sys->var_info.yres : 0;
 178     /* the X offset should be 0, but who knows ...
 179      * some other app might have played with the framebuffer */
 180     p_vout->p_sys->var_info.xoffset = 0;
 181
 182     //ioctl( p_vout->p_sys->i_fb_dev, FBIOPUT_VSCREENINFO, &p_vout->p_sys->var_info );
 183     ioctl( p_vout->p_sys->i_fb_dev, FBIOPAN_DISPLAY, &p_vout->p_sys->var_info );
 184 }
 185
 186 /*****************************************************************************
 187  * vout_SetPalette: sets an 8 bpp palette
 188  *****************************************************************************
 189  * This function sets the palette given as an argument. It does not return
 190  * anything, but could later send information on which colors it was unable
 191  * to set.
 192  *****************************************************************************/
 193 void vout_SetPalette( p_vout_thread_t p_vout,
 194                       u16 *red, u16 *green, u16 *blue, u16 *transp )
 195 {
 196     struct fb_cmap cmap = { 0, 256, red, green, blue, transp };
 197     ioctl( p_vout->p_sys->i_fb_dev, FBIOPUTCMAP, &cmap );
 198 }
 199
 200 /* following functions are local */
 201
 202 /*****************************************************************************
 203  * FBOpenDisplay: open and initialize framebuffer device
 204  *****************************************************************************
 205  * XXX?? The framebuffer mode is only provided as a fast and efficient way to
 206  * display video, providing the card is configured and the mode ok. It is
 207  * not portable, and is not supposed to work with many cards. Use at your
 208  * own risk !
 209  *****************************************************************************/
 210
 211 static int FBOpenDisplay( vout_thread_t *p_vout )
 212 {
 213     char *psz_device;                             /* framebuffer device path */
 214     struct fb_fix_screeninfo    fix_info;     /* framebuffer fix information */
 215
 216     /* Open framebuffer device */
 217     psz_device = main_GetPszVariable( VOUT_FB_DEV_VAR, VOUT_FB_DEV_DEFAULT );
 218     p_vout->p_sys->i_fb_dev = open( psz_device, O_RDWR);
 219     if( p_vout->p_sys->i_fb_dev == -1 )
 220     {
 221         intf_ErrMsg("vout error: can't open %s (%s)\n", psz_device, strerror(errno) );
 222         return( 1 );
 223     }
 224
 225     /* Get framebuffer device informations */
 226     if( ioctl( p_vout->p_sys->i_fb_dev, FBIOGET_VSCREENINFO, &p_vout->p_sys->var_info ) )
 227     {
 228         intf_ErrMsg( "vout error: can't get framebuffer informations (%s)\n", strerror(errno) );
 229         close( p_vout->p_sys->i_fb_dev );
 230         return( 1 );
 231     }
 232
 233     /* Framebuffer must have some basic properties to be usable */
 234     /* XXX?? */
 235
 236     /* Set some attributes */
 237     p_vout->p_sys->var_info.activate = FB_ACTIVATE_NXTOPEN;
 238     p_vout->p_sys->var_info.xoffset =  0;
 239     p_vout->p_sys->var_info.yoffset =  0;
 240     intf_ErrMsg( "vout: ypanstep is %i\n", fix_info.ypanstep );
 241     /* XXX?? ask sam p_vout->p_sys->mode_info.sync = FB_SYNC_VERT_HIGH_ACT; */
 242
 243     if( ioctl( p_vout->p_sys->i_fb_dev, FBIOPUT_VSCREENINFO, &p_vout->p_sys->var_info ) )
 244     {
 245         intf_ErrMsg("vout error: can't set framebuffer informations (%s)\n", strerror(errno) );
 246         close( p_vout->p_sys->i_fb_dev );
 247         return( 1 );
 248     }
 249
 250     /* Get some informations again, in the definitive configuration */
 251     if( ioctl( p_vout->p_sys->i_fb_dev, FBIOGET_FSCREENINFO, &fix_info ) ||
 252         ioctl( p_vout->p_sys->i_fb_dev, FBIOGET_VSCREENINFO, &p_vout->p_sys->var_info ) )
 253     {
 254         intf_ErrMsg("vout error: can't get framebuffer informations (%s)\n", strerror(errno) );
 255         /* FIXME: restore fb config ?? */
 256         close( p_vout->p_sys->i_fb_dev );
 257         return( 1 );
 258     }
 259
 260     /* FIXME: if the image is full-size, it gets cropped on the left
 261      * because of the xres / xres_virtual slight difference */
 262     intf_Msg( "%ix%i (virtual %ix%i)\n", p_vout->p_sys->var_info.xres, p_vout->p_sys->var_info.yres, p_vout->p_sys->var_info.xres_virtual, p_vout->p_sys->var_info.yres_virtual );
 263     p_vout->i_width =                   p_vout->p_sys->var_info.xres_virtual ? p_vout->p_sys->var_info.xres_virtual : p_vout->p_sys->var_info.xres;
 264     p_vout->i_height =                  p_vout->p_sys->var_info.yres;
 265     p_vout->i_screen_depth =            p_vout->p_sys->var_info.bits_per_pixel;
 266     switch( p_vout->i_screen_depth )
 267     {
 268     case 8:                                                         /* 8 bpp */
 269         p_vout->p_sys->fb_palette = malloc( 8 * 256 * sizeof(unsigned short) );
 270         p_vout->p_sys->fb_cmap.start = 0;
 271         p_vout->p_sys->fb_cmap.len = 256;
 272         p_vout->p_sys->fb_cmap.red = p_vout->p_sys->fb_palette;
 273         p_vout->p_sys->fb_cmap.green = p_vout->p_sys->fb_palette + 256 * sizeof(unsigned short);
 274         p_vout->p_sys->fb_cmap.blue = p_vout->p_sys->fb_palette + 2 * 256 * sizeof(unsigned short);
 275         p_vout->p_sys->fb_cmap.transp = p_vout->p_sys->fb_palette + 3 * 256 * sizeof(unsigned short);
 276
 277         /* saves the colormap */
 278         ioctl( p_vout->p_sys->i_fb_dev, FBIOGETCMAP, &p_vout->p_sys->fb_cmap );
 279
 280         p_vout->i_bytes_per_pixel = 1;
 281         p_vout->i_bytes_per_line = p_vout->i_width;
 282         break;
 283
 284     case 15:                      /* 15 bpp (16bpp with a missing green bit) */
 285     case 16:                                        /* 16 bpp (65536 colors) */
 286         p_vout->i_bytes_per_pixel = 2;
 287         p_vout->i_bytes_per_line = p_vout->i_width * 2;
 288         break;
 289
 290     case 24:                                  /* 24 bpp (millions of colors) */
 291         p_vout->i_bytes_per_pixel = 3;
 292         p_vout->i_bytes_per_line = p_vout->i_width * 3;
 293         break;
 294
 295     case 32:                                  /* 32 bpp (millions of colors) */
 296         p_vout->i_bytes_per_pixel = 4;
 297         p_vout->i_bytes_per_line = p_vout->i_width * 4;
 298         break;
 299
 300     default:                                     /* unsupported screen depth */
 301         intf_ErrMsg( "vout error: screen depth %d is not supported\n",
 302                      p_vout->i_screen_depth);
 303         return( 1 );
 304         break;
 305     }
 306
 307     switch( p_vout->i_screen_depth )
 308     {
 309     case 15:
 310     case 16:
 311     case 24:
 312     case 32:
 313         p_vout->i_red_mask =    ( (1 << p_vout->p_sys->var_info.red.length) - 1 )
 314                                     << p_vout->p_sys->var_info.red.offset;
 315         p_vout->i_green_mask =    ( (1 << p_vout->p_sys->var_info.green.length) - 1 )
 316                                     << p_vout->p_sys->var_info.green.offset;
 317         p_vout->i_blue_mask =    ( (1 << p_vout->p_sys->var_info.blue.length) - 1 )
 318                                     << p_vout->p_sys->var_info.blue.offset;
 319     }
 320
 321     p_vout->p_sys->i_page_size = p_vout->i_width *
 322                 p_vout->i_height * p_vout->i_bytes_per_pixel;
 323
 324     /* Map two framebuffers a the very beginning of the fb */
 325     p_vout->p_sys->p_video = mmap(0, p_vout->p_sys->i_page_size * 2,
 326                           PROT_READ | PROT_WRITE, MAP_SHARED,
 327                           p_vout->p_sys->i_fb_dev, 0 );
 328     if( (int)p_vout->p_sys->p_video == -1 ) /* XXX?? according to man, it is -1. What about NULL ? */
 329     {
 330         intf_ErrMsg("vout error: can't map video memory (%s)\n", strerror(errno) );
 331         /* FIXME: restore fb config ?? */
 332         close( p_vout->p_sys->i_fb_dev );
 333         return( 1 );
 334     }
 335
 336     /* Set and initialize buffers */
 337     vout_SetBuffers( p_vout, p_vout->p_sys->p_video,
 338                      p_vout->p_sys->p_video + p_vout->p_sys->i_page_size );
 339     intf_DbgMsg("framebuffer type=%d, visual=%d, ypanstep=%d, ywrap=%d, accel=%d\n",
 340                 fix_info.type, fix_info.visual, fix_info.ypanstep, fix_info.ywrapstep, fix_info.accel );
 341     return( 0 );
 342 }
 343
 344 /*****************************************************************************
 345  * FBCloseDisplay: close and reset framebuffer device
 346  *****************************************************************************
 347  * Returns all resources allocated by FBOpenDisplay and restore the original
 348  * state of the device.
 349  *****************************************************************************/
 350 static void FBCloseDisplay( vout_thread_t *p_vout )
 351 {
 352     /* Restore palette */
 353     if( p_vout->i_screen_depth == 8 );
 354     {
 355         ioctl( p_vout->p_sys->i_fb_dev, FBIOPUTCMAP, &p_vout->p_sys->fb_cmap );
 356         free( p_vout->p_sys->fb_palette );
 357     }
 358
 359     /* Destroy window and close display */
 360     close( p_vout->p_sys->i_fb_dev );
 361 }
 362
 363