1 /*****************************************************************************
2 * vout_fb.c: framebuffer video output display method
3 *****************************************************************************
4 * Copyright (C) 1998, 1999, 2000, 2001 VideoLAN
5 * $Id: vout_fb.c,v 1.12 2001/05/07 03:14:09 stef Exp $
7 * Authors: Samuel Hocevar <sam@zoy.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
24 #define MODULE_NAME fb
25 #include "modules_inner.h"
27 /*****************************************************************************
29 *****************************************************************************/
32 #include <errno.h> /* ENOMEM */
33 #include <signal.h> /* SIGUSR1, SIGUSR2 */
34 #include <stdlib.h> /* free() */
35 #include <string.h> /* strerror() */
36 #include <fcntl.h> /* open() */
37 #include <unistd.h> /* close() */
39 #include <termios.h> /* struct termios */
40 #include <sys/ioctl.h>
41 #include <sys/mman.h> /* mmap() */
44 #include <linux/vt.h> /* VT_* */
45 #include <linux/kd.h> /* KD* */
55 #include "video_output.h"
60 /*****************************************************************************
61 * vout_sys_t: video output framebuffer method descriptor
62 *****************************************************************************
63 * This structure is part of the video output thread descriptor.
64 * It describes the FB specific properties of an output thread.
65 *****************************************************************************/
66 typedef struct vout_sys_s
68 /* System informations */
69 int i_tty_dev; /* tty device handle */
70 struct termios old_termios;
72 /* Original configuration informations */
73 struct sigaction sig_usr1; /* USR1 previous handler */
74 struct sigaction sig_usr2; /* USR2 previous handler */
75 struct vt_mode vt_mode; /* previous VT mode */
77 /* Framebuffer information */
78 int i_fb_dev; /* device handle */
79 struct fb_var_screeninfo old_info; /* original mode informations */
80 struct fb_var_screeninfo var_info; /* current mode informations */
81 boolean_t b_pan; /* does device supports panning ? */
82 struct fb_cmap fb_cmap; /* original colormap */
83 u16 *fb_palette; /* original palette */
86 byte_t * p_video; /* base adress */
87 size_t i_page_size; /* page size */
91 /*****************************************************************************
93 *****************************************************************************/
94 static int vout_Probe ( probedata_t *p_data );
95 static int vout_Create ( struct vout_thread_s * );
96 static int vout_Init ( struct vout_thread_s * );
97 static void vout_End ( struct vout_thread_s * );
98 static void vout_Destroy ( struct vout_thread_s * );
99 static int vout_Manage ( struct vout_thread_s * );
100 static void vout_Display ( struct vout_thread_s * );
101 static void vout_SetPalette( p_vout_thread_t p_vout, u16 *red, u16 *green,
102 u16 *blue, u16 *transp );
104 static int FBOpenDisplay ( struct vout_thread_s * );
105 static void FBCloseDisplay ( struct vout_thread_s * );
106 static void FBSwitchDisplay( int i_signal );
107 static void FBTextMode ( int i_tty_dev );
108 static void FBGfxMode ( int i_tty_dev );
110 /*****************************************************************************
111 * Functions exported as capabilities. They are declared as static so that
112 * we don't pollute the namespace too much.
113 *****************************************************************************/
114 void _M( vout_getfunctions )( function_list_t * p_function_list )
116 p_function_list->pf_probe = vout_Probe;
117 p_function_list->functions.vout.pf_create = vout_Create;
118 p_function_list->functions.vout.pf_init = vout_Init;
119 p_function_list->functions.vout.pf_end = vout_End;
120 p_function_list->functions.vout.pf_destroy = vout_Destroy;
121 p_function_list->functions.vout.pf_manage = vout_Manage;
122 p_function_list->functions.vout.pf_display = vout_Display;
123 p_function_list->functions.vout.pf_setpalette = vout_SetPalette;
126 /*****************************************************************************
127 * vout_Probe: probe the video driver and return a score
128 *****************************************************************************
129 * This function tries to open the framebuffer and returns a score to the
130 * plugin manager so that it can select the best plugin.
131 *****************************************************************************/
132 static int vout_Probe( probedata_t *p_data )
136 if( TestMethod( VOUT_METHOD_VAR, "fb" ) )
141 i_fd = open( main_GetPszVariable( VOUT_FB_DEV_VAR,
142 VOUT_FB_DEV_DEFAULT ), O_RDWR );
152 /*****************************************************************************
153 * vout_Create: allocates FB video thread output method
154 *****************************************************************************
155 * This function allocates and initializes a FB vout method.
156 *****************************************************************************/
157 static int vout_Create( vout_thread_t *p_vout )
159 struct sigaction sig_tty; /* sigaction for tty change */
160 struct vt_mode vt_mode; /* vt current mode */
161 struct termios new_termios;
163 /* Allocate instance and initialize some members */
164 p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
165 if( p_vout->p_sys == NULL )
170 /* Set tty and fb devices */
171 p_vout->p_sys->i_tty_dev = 0; /* 0 == /dev/tty0 == current console */
173 FBGfxMode( p_vout->p_sys->i_tty_dev );
175 /* Set keyboard settings */
176 if (tcgetattr(0, &p_vout->p_sys->old_termios) == -1)
178 intf_ErrMsg( "intf error: tcgetattr" );
181 if (tcgetattr(0, &new_termios) == -1)
183 intf_ErrMsg( "intf error: tcgetattr" );
186 /* new_termios.c_lflag &= ~ (ICANON | ISIG);
187 new_termios.c_lflag |= (ECHO | ECHOCTL); */
188 new_termios.c_lflag &= ~ (ICANON);
189 new_termios.c_lflag &= ~(ECHO | ECHOCTL);
190 new_termios.c_iflag = 0;
191 new_termios.c_cc[VMIN] = 1;
192 new_termios.c_cc[VTIME] = 0;
194 if (tcsetattr(0, TCSAFLUSH, &new_termios) == -1)
196 intf_ErrMsg( "intf error: tcsetattr" );
199 ioctl(p_vout->p_sys->i_tty_dev, VT_RELDISP, VT_ACKACQ);
201 /* Set-up tty signal handler to be aware of tty changes */
202 memset( &sig_tty, 0, sizeof( sig_tty ) );
203 sig_tty.sa_handler = FBSwitchDisplay;
204 sigemptyset( &sig_tty.sa_mask );
205 if( sigaction( SIGUSR1, &sig_tty, &p_vout->p_sys->sig_usr1 ) ||
206 sigaction( SIGUSR2, &sig_tty, &p_vout->p_sys->sig_usr2 ) )
208 intf_ErrMsg( "intf error: can't set up signal handler (%s)",
210 tcsetattr(0, 0, &p_vout->p_sys->old_termios);
211 FBTextMode( p_vout->p_sys->i_tty_dev );
212 free( p_vout->p_sys );
216 /* Set-up tty according to new signal handler */
217 if( ioctl(p_vout->p_sys->i_tty_dev, VT_GETMODE, &p_vout->p_sys->vt_mode)
220 intf_ErrMsg( "intf error: cant get terminal mode (%s)",
222 sigaction( SIGUSR1, &p_vout->p_sys->sig_usr1, NULL );
223 sigaction( SIGUSR2, &p_vout->p_sys->sig_usr2, NULL );
224 tcsetattr(0, 0, &p_vout->p_sys->old_termios);
225 FBTextMode( p_vout->p_sys->i_tty_dev );
226 free( p_vout->p_sys );
229 memcpy( &vt_mode, &p_vout->p_sys->vt_mode, sizeof( vt_mode ) );
230 vt_mode.mode = VT_PROCESS;
232 vt_mode.relsig = SIGUSR1;
233 vt_mode.acqsig = SIGUSR2;
235 if( ioctl(p_vout->p_sys->i_tty_dev, VT_SETMODE, &vt_mode) == -1 )
237 intf_ErrMsg( "intf error: can't set terminal mode (%s)",
239 sigaction( SIGUSR1, &p_vout->p_sys->sig_usr1, NULL );
240 sigaction( SIGUSR2, &p_vout->p_sys->sig_usr2, NULL );
241 tcsetattr(0, 0, &p_vout->p_sys->old_termios);
242 FBTextMode( p_vout->p_sys->i_tty_dev );
243 free( p_vout->p_sys );
247 if( FBOpenDisplay( p_vout ) )
249 ioctl(p_vout->p_sys->i_tty_dev, VT_SETMODE, &p_vout->p_sys->vt_mode);
250 sigaction( SIGUSR1, &p_vout->p_sys->sig_usr1, NULL );
251 sigaction( SIGUSR2, &p_vout->p_sys->sig_usr2, NULL );
252 tcsetattr(0, 0, &p_vout->p_sys->old_termios);
253 FBTextMode( p_vout->p_sys->i_tty_dev );
254 free( p_vout->p_sys );
261 /*****************************************************************************
262 * vout_Init: initialize framebuffer video thread output method
263 *****************************************************************************/
264 static int vout_Init( vout_thread_t *p_vout )
266 /* Clear the screen */
267 memset( p_vout->p_sys->p_video, 0, p_vout->p_sys->i_page_size * 2 );
272 /*****************************************************************************
273 * vout_End: terminate framebuffer video thread output method
274 *****************************************************************************/
275 static void vout_End( vout_thread_t *p_vout )
277 /* Clear the screen */
278 memset( p_vout->p_sys->p_video, 0, p_vout->p_sys->i_page_size * 2 );
281 /*****************************************************************************
282 * vout_Destroy: destroy FB video thread output method
283 *****************************************************************************
284 * Terminate an output method created by vout_CreateOutputMethod
285 *****************************************************************************/
286 static void vout_Destroy( vout_thread_t *p_vout )
288 FBCloseDisplay( p_vout );
290 /* Reset the terminal */
291 ioctl(p_vout->p_sys->i_tty_dev, VT_SETMODE, &p_vout->p_sys->vt_mode);
293 /* Remove signal handlers */
294 sigaction( SIGUSR1, &p_vout->p_sys->sig_usr1, NULL );
295 sigaction( SIGUSR2, &p_vout->p_sys->sig_usr2, NULL );
297 /* Reset the keyboard state */
298 tcsetattr( 0, 0, &p_vout->p_sys->old_termios );
300 /* Return to text mode */
301 FBTextMode( p_vout->p_sys->i_tty_dev );
303 /* Destroy structure */
304 free( p_vout->p_sys );
307 /*****************************************************************************
308 * vout_Manage: handle FB events
309 *****************************************************************************
310 * This function should be called regularly by video output thread. It manages
311 * console events. It returns a non null value on error.
312 *****************************************************************************/
313 static int vout_Manage( vout_thread_t *p_vout )
318 if ( read(0, &buf, 1) == 1)
323 p_main->p_intf->b_die = 1;
335 if( p_vout->i_changes & VOUT_SIZE_CHANGE )
337 intf_WarnMsg( 3, "vout: reinitializing framebuffer screen" );
338 p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
340 /* Destroy XImages to change their size */
343 /* Recreate XImages. If SysInit failed, the thread can't go on. */
344 if( vout_Init( p_vout ) )
346 intf_ErrMsg("error: cannot reinit framebuffer screen" );
351 memset( p_vout->p_sys->p_video, 0, p_vout->p_sys->i_page_size * 2 );
354 /* Tell the video output thread that it will need to rebuild YUV
355 * tables. This is needed since conversion buffer size may have changed */
356 p_vout->i_changes |= VOUT_YUV_CHANGE;
363 /*****************************************************************************
364 * vout_Display: displays previously rendered output
365 *****************************************************************************
366 * This function send the currently rendered image to FB image, waits until
367 * it is displayed and switch the two rendering buffers, preparing next frame.
368 *****************************************************************************/
369 static void vout_Display( vout_thread_t *p_vout )
371 /* swap the two Y offsets if the drivers supports panning */
372 if( p_vout->p_sys->b_pan )
374 p_vout->p_sys->var_info.yoffset =
375 p_vout->i_buffer_index ? p_vout->p_sys->var_info.yres : 0;
377 /* the X offset should be 0, but who knows ...
378 * some other app might have played with the framebuffer */
379 p_vout->p_sys->var_info.xoffset = 0;
381 ioctl( p_vout->p_sys->i_fb_dev,
382 FBIOPAN_DISPLAY, &p_vout->p_sys->var_info );
386 /*****************************************************************************
387 * vout_SetPalette: sets an 8 bpp palette
388 *****************************************************************************
389 * This function sets the palette given as an argument. It does not return
390 * anything, but could later send information on which colors it was unable
392 *****************************************************************************/
393 static void vout_SetPalette( p_vout_thread_t p_vout,
394 u16 *red, u16 *green, u16 *blue, u16 *transp )
396 struct fb_cmap cmap = { 0, 256, red, green, blue, transp };
398 ioctl( p_vout->p_sys->i_fb_dev, FBIOPUTCMAP, &cmap );
401 /* following functions are local */
403 /*****************************************************************************
404 * FBOpenDisplay: initialize framebuffer
405 *****************************************************************************/
406 static int FBOpenDisplay( vout_thread_t *p_vout )
408 char *psz_device; /* framebuffer device path */
409 struct fb_fix_screeninfo fix_info; /* framebuffer fix information */
411 /* Open framebuffer device */
412 psz_device = main_GetPszVariable( VOUT_FB_DEV_VAR, VOUT_FB_DEV_DEFAULT );
413 p_vout->p_sys->i_fb_dev = open( psz_device, O_RDWR);
414 if( p_vout->p_sys->i_fb_dev == -1 )
416 intf_ErrMsg("vout error: can't open %s (%s)", psz_device, strerror(errno) );
420 /* Get framebuffer device informations */
421 if( ioctl( p_vout->p_sys->i_fb_dev, FBIOGET_VSCREENINFO, &p_vout->p_sys->var_info ) )
423 intf_ErrMsg("vout error: can't get fb info (%s)", strerror(errno) );
424 close( p_vout->p_sys->i_fb_dev );
428 if( ioctl( p_vout->p_sys->i_fb_dev, FBIOGET_VSCREENINFO, &p_vout->p_sys->old_info ) )
430 intf_ErrMsg("vout error: can't get 2nd fb info (%s)", strerror(errno) );
431 close( p_vout->p_sys->i_fb_dev );
435 /* Set some attributes */
436 p_vout->p_sys->var_info.activate = FB_ACTIVATE_NXTOPEN;
437 p_vout->p_sys->var_info.xoffset = 0;
438 p_vout->p_sys->var_info.yoffset = 0;
440 if( ioctl( p_vout->p_sys->i_fb_dev, FBIOPUT_VSCREENINFO, &p_vout->p_sys->var_info ) )
442 intf_ErrMsg(" vout error: can't set fb info (%s)", strerror(errno) );
443 close( p_vout->p_sys->i_fb_dev );
447 /* Get some informations again, in the definitive configuration */
448 if( ioctl( p_vout->p_sys->i_fb_dev, FBIOGET_FSCREENINFO, &fix_info ) ||
449 ioctl( p_vout->p_sys->i_fb_dev, FBIOGET_VSCREENINFO, &p_vout->p_sys->var_info ) )
451 intf_ErrMsg(" vout error: can't get additional fb info (%s)", strerror(errno) );
453 /* Restore fb config */
454 ioctl( p_vout->p_sys->i_fb_dev, FBIOPUT_VSCREENINFO, &p_vout->p_sys->var_info );
456 close( p_vout->p_sys->i_fb_dev );
460 /* FIXME: if the image is full-size, it gets cropped on the left
461 * because of the xres / xres_virtual slight difference */
462 intf_WarnMsg( 3, "vout: %ix%i (virtual %ix%i)",
463 p_vout->p_sys->var_info.xres,
464 p_vout->p_sys->var_info.yres,
465 p_vout->p_sys->var_info.xres_virtual,
466 p_vout->p_sys->var_info.yres_virtual );
468 p_vout->i_height = p_vout->p_sys->var_info.yres;
469 p_vout->i_width = p_vout->p_sys->var_info.xres_virtual ?
470 p_vout->p_sys->var_info.xres_virtual
471 : p_vout->p_sys->var_info.xres;
473 p_vout->i_screen_depth = p_vout->p_sys->var_info.bits_per_pixel;
475 p_vout->p_sys->fb_palette = NULL;
476 p_vout->p_sys->b_pan = ( fix_info.ypanstep || fix_info.ywrapstep );
478 switch( p_vout->i_screen_depth )
481 p_vout->p_sys->fb_palette = malloc( 8 * 256 * sizeof( u16 ) );
482 p_vout->p_sys->fb_cmap.start = 0;
483 p_vout->p_sys->fb_cmap.len = 256;
484 p_vout->p_sys->fb_cmap.red = p_vout->p_sys->fb_palette;
485 p_vout->p_sys->fb_cmap.green = p_vout->p_sys->fb_palette + 256 * sizeof( u16 );
486 p_vout->p_sys->fb_cmap.blue = p_vout->p_sys->fb_palette + 2 * 256 * sizeof( u16 );
487 p_vout->p_sys->fb_cmap.transp = p_vout->p_sys->fb_palette + 3 * 256 * sizeof( u16 );
489 /* Save the colormap */
490 ioctl( p_vout->p_sys->i_fb_dev, FBIOGETCMAP, &p_vout->p_sys->fb_cmap );
492 p_vout->i_bytes_per_pixel = 1;
493 p_vout->i_bytes_per_line = p_vout->i_width;
496 case 15: /* 15 bpp (16bpp with a missing green bit) */
497 case 16: /* 16 bpp (65536 colors) */
498 p_vout->i_bytes_per_pixel = 2;
499 p_vout->i_bytes_per_line = p_vout->i_width * 2;
502 case 24: /* 24 bpp (millions of colors) */
503 p_vout->i_bytes_per_pixel = 3;
504 p_vout->i_bytes_per_line = p_vout->i_width * 3;
507 case 32: /* 32 bpp (millions of colors) */
508 p_vout->i_bytes_per_pixel = 4;
509 p_vout->i_bytes_per_line = p_vout->i_width * 4;
512 default: /* unsupported screen depth */
513 intf_ErrMsg( "vout error: screen depth %d is not supported",
514 p_vout->i_screen_depth);
516 /* Restore fb config */
517 ioctl( p_vout->p_sys->i_fb_dev, FBIOPUT_VSCREENINFO, &p_vout->p_sys->var_info );
519 close( p_vout->p_sys->i_fb_dev );
524 switch( p_vout->i_screen_depth )
530 p_vout->i_red_mask = ( (1 << p_vout->p_sys->var_info.red.length) - 1 )
531 << p_vout->p_sys->var_info.red.offset;
532 p_vout->i_green_mask = ( (1 << p_vout->p_sys->var_info.green.length) - 1 )
533 << p_vout->p_sys->var_info.green.offset;
534 p_vout->i_blue_mask = ( (1 << p_vout->p_sys->var_info.blue.length) - 1 )
535 << p_vout->p_sys->var_info.blue.offset;
538 p_vout->p_sys->i_page_size = p_vout->i_width *
539 p_vout->i_height * p_vout->i_bytes_per_pixel;
541 /* Map two framebuffers a the very beginning of the fb */
542 p_vout->p_sys->p_video = mmap( 0, p_vout->p_sys->i_page_size * 2,
543 PROT_READ | PROT_WRITE, MAP_SHARED,
544 p_vout->p_sys->i_fb_dev, 0 );
546 if( (int)p_vout->p_sys->p_video == -1 ) /* according to man, it is -1.
549 intf_ErrMsg("vout error: can't map video memory (%s)", strerror(errno) );
550 /* FIXME: restore fb config ?? */
551 if( p_vout->i_screen_depth == 8 )
553 free( p_vout->p_sys->fb_palette );
556 /* Restore fb config */
557 ioctl( p_vout->p_sys->i_fb_dev, FBIOPUT_VSCREENINFO, &p_vout->p_sys->var_info );
559 close( p_vout->p_sys->i_fb_dev );
563 /* Set and initialize buffers */
564 if( p_vout->p_sys->b_pan )
566 vout_SetBuffers( p_vout, p_vout->p_sys->p_video,
567 p_vout->p_sys->p_video
568 + p_vout->p_sys->i_page_size );
572 vout_SetBuffers( p_vout, p_vout->p_sys->p_video,
573 p_vout->p_sys->p_video );
576 intf_WarnMsg( 3, "framebuffer type=%d, visual=%d, ypanstep=%d, ywrap=%d, accel=%d",
577 fix_info.type, fix_info.visual, fix_info.ypanstep, fix_info.ywrapstep, fix_info.accel );
581 /*****************************************************************************
582 * FBCloseDisplay: terminate FB video thread output method
583 *****************************************************************************/
584 static void FBCloseDisplay( vout_thread_t *p_vout )
587 memset( p_vout->p_sys->p_video, 0, p_vout->p_sys->i_page_size * 2 );
589 /* Restore palette */
590 if( p_vout->i_screen_depth == 8 );
592 ioctl( p_vout->p_sys->i_fb_dev, FBIOPUTCMAP, &p_vout->p_sys->fb_cmap );
593 free( p_vout->p_sys->fb_palette );
596 /* Restore fb config */
597 ioctl( p_vout->p_sys->i_fb_dev, FBIOPUT_VSCREENINFO, &p_vout->p_sys->var_info );
600 close( p_vout->p_sys->i_fb_dev );
603 /*****************************************************************************
604 * FBSwitchDisplay: VT change signal handler
605 *****************************************************************************
606 * This function activates or deactivates the output of the thread. It is
607 * called by the VT driver, on terminal change.
608 *****************************************************************************/
609 static void FBSwitchDisplay(int i_signal)
611 vout_thread_t *p_vout;
613 vlc_mutex_lock( &p_vout_bank->lock );
615 /* XXX: only test the first video output */
616 if( p_vout_bank->i_count )
618 p_vout = p_vout_bank->pp_vout[0];
622 case SIGUSR1: /* vt has been released */
623 p_vout->b_active = 0;
624 ioctl( p_vout->p_sys->i_tty_dev, VT_RELDISP, 1 );
626 case SIGUSR2: /* vt has been acquired */
627 p_vout->b_active = 1;
628 ioctl( p_vout->p_sys->i_tty_dev, VT_RELDISP, VT_ACTIVATE );
629 /* handle blanking */
630 vlc_mutex_lock( &p_vout->change_lock );
631 p_vout->i_changes |= VOUT_SIZE_CHANGE;
632 vlc_mutex_unlock( &p_vout->change_lock );
637 vlc_mutex_unlock( &p_vout_bank->lock );
640 /*****************************************************************************
641 * FBTextMode and FBGfxMode : switch tty to text/graphic mode
642 *****************************************************************************
643 * These functions toggle the tty mode.
644 *****************************************************************************/
645 static void FBTextMode( int i_tty_dev )
647 /* return to text mode */
648 if (-1 == ioctl(i_tty_dev, KDSETMODE, KD_TEXT))
650 intf_ErrMsg( "intf error: failed ioctl KDSETMODE KD_TEXT" );
654 static void FBGfxMode( int i_tty_dev )
656 /* switch to graphic mode */
657 if (-1 == ioctl(i_tty_dev, KDSETMODE, KD_GRAPHICS))
659 intf_ErrMsg( "intf error: failed ioctl KDSETMODE KD_GRAPHICS" );