1 /*****************************************************************************
2 * fb.c : framebuffer plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2000, 2001 the VideoLAN team
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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
27 #include <errno.h> /* ENOMEM */
28 #include <signal.h> /* SIGUSR1, SIGUSR2 */
29 #include <stdlib.h> /* free() */
30 #include <string.h> /* strerror() */
31 #include <fcntl.h> /* open() */
32 #include <unistd.h> /* close() */
34 #include <termios.h> /* struct termios */
35 #include <sys/ioctl.h>
36 #include <sys/mman.h> /* mmap() */
39 #include <linux/vt.h> /* VT_* */
40 #include <linux/kd.h> /* KD* */
45 /*****************************************************************************
47 *****************************************************************************/
48 static int Create ( vlc_object_t * );
49 static void Destroy ( vlc_object_t * );
51 static int Init ( vout_thread_t * );
52 static void End ( vout_thread_t * );
53 static int Manage ( vout_thread_t * );
54 static void Display ( vout_thread_t *, picture_t * );
56 static int OpenDisplay ( vout_thread_t * );
57 static void CloseDisplay ( vout_thread_t * );
58 static void SwitchDisplay ( int i_signal );
59 static void TextMode ( int i_tty );
60 static void GfxMode ( int i_tty );
62 /*****************************************************************************
64 *****************************************************************************/
65 #define FB_DEV_VAR "fbdev"
67 #define DEVICE_TEXT N_("Framebuffer device")
68 #define DEVICE_LONGTEXT N_( \
69 "You can select here the framebuffer device that will be used " \
70 "for rendering (usually /dev/fb0).")
73 set_shortname( "Framebuffer" );
74 set_category( CAT_VIDEO );
75 set_subcategory( SUBCAT_VIDEO_VOUT );
76 add_file( FB_DEV_VAR, "/dev/fb0", NULL, DEVICE_TEXT, DEVICE_LONGTEXT,
78 set_description( _("GNU/Linux console framebuffer video output") );
79 set_capability( "video output", 30 );
80 set_callbacks( Create, Destroy );
83 /*****************************************************************************
84 * vout_sys_t: video output framebuffer method descriptor
85 *****************************************************************************
86 * This structure is part of the video output thread descriptor.
87 * It describes the FB specific properties of an output thread.
88 *****************************************************************************/
91 /* System information */
92 int i_tty; /* tty device handle */
93 struct termios old_termios;
95 /* Original configuration information */
96 struct sigaction sig_usr1; /* USR1 previous handler */
97 struct sigaction sig_usr2; /* USR2 previous handler */
98 struct vt_mode vt_mode; /* previous VT mode */
100 /* Framebuffer information */
101 int i_fd; /* device handle */
102 struct fb_var_screeninfo old_info; /* original mode information */
103 struct fb_var_screeninfo var_info; /* current mode information */
104 vlc_bool_t b_pan; /* does device supports panning ? */
105 struct fb_cmap fb_cmap; /* original colormap */
106 uint16_t *p_palette; /* original palette */
108 /* Video information */
111 int i_bytes_per_pixel;
114 byte_t * p_video; /* base adress */
115 size_t i_page_size; /* page size */
118 /*****************************************************************************
119 * Create: allocates FB video thread output method
120 *****************************************************************************
121 * This function allocates and initializes a FB vout method.
122 *****************************************************************************/
123 static int Create( vlc_object_t *p_this )
125 vout_thread_t *p_vout = (vout_thread_t *)p_this;
127 struct sigaction sig_tty; /* sigaction for tty change */
128 struct vt_mode vt_mode; /* vt current mode */
129 struct termios new_termios;
131 /* Allocate instance and initialize some members */
132 p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
133 if( p_vout->p_sys == NULL )
138 p_vout->pf_init = Init;
139 p_vout->pf_end = End;
140 p_vout->pf_manage = Manage;
141 p_vout->pf_render = NULL;
142 p_vout->pf_display = Display;
144 /* Set tty and fb devices */
145 p_vout->p_sys->i_tty = 0; /* 0 == /dev/tty0 == current console */
147 GfxMode( p_vout->p_sys->i_tty );
149 /* Set keyboard settings */
150 if (tcgetattr(0, &p_vout->p_sys->old_termios) == -1)
152 msg_Err( p_vout, "tcgetattr failed" );
155 if (tcgetattr(0, &new_termios) == -1)
157 msg_Err( p_vout, "tcgetattr failed" );
160 /* new_termios.c_lflag &= ~ (ICANON | ISIG);
161 new_termios.c_lflag |= (ECHO | ECHOCTL); */
162 new_termios.c_lflag &= ~ (ICANON);
163 new_termios.c_lflag &= ~(ECHO | ECHOCTL);
164 new_termios.c_iflag = 0;
165 new_termios.c_cc[VMIN] = 1;
166 new_termios.c_cc[VTIME] = 0;
168 if (tcsetattr(0, TCSAFLUSH, &new_termios) == -1)
170 msg_Err( p_vout, "tcsetattr failed" );
173 ioctl( p_vout->p_sys->i_tty, VT_RELDISP, VT_ACKACQ );
175 /* Set-up tty signal handler to be aware of tty changes */
176 memset( &sig_tty, 0, sizeof( sig_tty ) );
177 sig_tty.sa_handler = SwitchDisplay;
178 sigemptyset( &sig_tty.sa_mask );
179 if( sigaction( SIGUSR1, &sig_tty, &p_vout->p_sys->sig_usr1 ) ||
180 sigaction( SIGUSR2, &sig_tty, &p_vout->p_sys->sig_usr2 ) )
182 msg_Err( p_vout, "cannot set signal handler (%s)", strerror(errno) );
183 tcsetattr(0, 0, &p_vout->p_sys->old_termios);
184 TextMode( p_vout->p_sys->i_tty );
185 free( p_vout->p_sys );
189 /* Set-up tty according to new signal handler */
190 if( -1 == ioctl( p_vout->p_sys->i_tty,
191 VT_GETMODE, &p_vout->p_sys->vt_mode ) )
193 msg_Err( p_vout, "cannot get terminal mode (%s)", strerror(errno) );
194 sigaction( SIGUSR1, &p_vout->p_sys->sig_usr1, NULL );
195 sigaction( SIGUSR2, &p_vout->p_sys->sig_usr2, NULL );
196 tcsetattr(0, 0, &p_vout->p_sys->old_termios);
197 TextMode( p_vout->p_sys->i_tty );
198 free( p_vout->p_sys );
201 memcpy( &vt_mode, &p_vout->p_sys->vt_mode, sizeof( vt_mode ) );
202 vt_mode.mode = VT_PROCESS;
204 vt_mode.relsig = SIGUSR1;
205 vt_mode.acqsig = SIGUSR2;
207 if( -1 == ioctl( p_vout->p_sys->i_tty, VT_SETMODE, &vt_mode ) )
209 msg_Err( p_vout, "cannot set terminal mode (%s)", strerror(errno) );
210 sigaction( SIGUSR1, &p_vout->p_sys->sig_usr1, NULL );
211 sigaction( SIGUSR2, &p_vout->p_sys->sig_usr2, NULL );
212 tcsetattr(0, 0, &p_vout->p_sys->old_termios);
213 TextMode( p_vout->p_sys->i_tty );
214 free( p_vout->p_sys );
218 if( OpenDisplay( p_vout ) )
220 ioctl( p_vout->p_sys->i_tty, VT_SETMODE, &p_vout->p_sys->vt_mode );
221 sigaction( SIGUSR1, &p_vout->p_sys->sig_usr1, NULL );
222 sigaction( SIGUSR2, &p_vout->p_sys->sig_usr2, NULL );
223 tcsetattr(0, 0, &p_vout->p_sys->old_termios);
224 TextMode( p_vout->p_sys->i_tty );
225 free( p_vout->p_sys );
232 /*****************************************************************************
233 * Init: initialize framebuffer video thread output method
234 *****************************************************************************/
235 static int Init( vout_thread_t *p_vout )
240 I_OUTPUTPICTURES = 0;
242 /* Initialize the output structure: RGB with square pixels, whatever
243 * the input format is, since it's the only format we know */
244 switch( p_vout->p_sys->var_info.bits_per_pixel )
246 case 8: /* FIXME: set the palette */
247 p_vout->output.i_chroma = VLC_FOURCC('R','G','B','2'); break;
249 p_vout->output.i_chroma = VLC_FOURCC('R','V','1','5'); break;
251 p_vout->output.i_chroma = VLC_FOURCC('R','V','1','6'); break;
253 p_vout->output.i_chroma = VLC_FOURCC('R','V','2','4'); break;
255 p_vout->output.i_chroma = VLC_FOURCC('R','V','3','2'); break;
257 msg_Err( p_vout, "unknown screen depth %i",
258 p_vout->p_sys->var_info.bits_per_pixel );
262 /* Only useful for p_vout->p_sys->var_info.bits_per_pixel != 8 */
263 p_vout->output.i_rmask = ( (1 << p_vout->p_sys->var_info.red.length) - 1 )
264 << p_vout->p_sys->var_info.red.offset;
265 p_vout->output.i_gmask = ( (1 << p_vout->p_sys->var_info.green.length) - 1 )
266 << p_vout->p_sys->var_info.green.offset;
267 p_vout->output.i_bmask = ( (1 << p_vout->p_sys->var_info.blue.length) - 1 )
268 << p_vout->p_sys->var_info.blue.offset;
270 p_vout->output.i_width = p_vout->p_sys->i_width;
271 p_vout->output.i_height = p_vout->p_sys->i_height;
273 /* Assume we have square pixels */
274 p_vout->output.i_aspect = p_vout->p_sys->i_width
275 * VOUT_ASPECT_FACTOR / p_vout->p_sys->i_height;
277 /* Clear the screen */
278 memset( p_vout->p_sys->p_video, 0, p_vout->p_sys->i_page_size );
280 /* Try to initialize 1 direct buffer */
283 /* Find an empty picture slot */
284 for( i_index = 0 ; i_index < VOUT_MAX_PICTURES ; i_index++ )
286 if( p_vout->p_picture[ i_index ].i_status == FREE_PICTURE )
288 p_pic = p_vout->p_picture + i_index;
293 /* Allocate the picture */
299 /* We know the chroma, allocate a buffer which will be used
300 * directly by the decoder */
301 p_pic->p->p_pixels = p_vout->p_sys->p_video;
302 p_pic->p->i_pixel_pitch = p_vout->p_sys->i_bytes_per_pixel;
303 p_pic->p->i_lines = p_vout->p_sys->var_info.yres;
304 p_pic->p->i_visible_lines = p_vout->p_sys->var_info.yres;
306 if( p_vout->p_sys->var_info.xres_virtual )
308 p_pic->p->i_pitch = p_vout->p_sys->var_info.xres_virtual
309 * p_vout->p_sys->i_bytes_per_pixel;
313 p_pic->p->i_pitch = p_vout->p_sys->var_info.xres
314 * p_vout->p_sys->i_bytes_per_pixel;
317 p_pic->p->i_visible_pitch = p_vout->p_sys->var_info.xres
318 * p_vout->p_sys->i_bytes_per_pixel;
322 p_pic->i_status = DESTROYED_PICTURE;
323 p_pic->i_type = DIRECT_PICTURE;
325 PP_OUTPUTPICTURE[ I_OUTPUTPICTURES ] = p_pic;
332 /*****************************************************************************
333 * End: terminate framebuffer video thread output method
334 *****************************************************************************/
335 static void End( vout_thread_t *p_vout )
337 /* Clear the screen */
338 memset( p_vout->p_sys->p_video, 0, p_vout->p_sys->i_page_size );
341 /*****************************************************************************
342 * Destroy: destroy FB video thread output method
343 *****************************************************************************
344 * Terminate an output method created by Create
345 *****************************************************************************/
346 static void Destroy( vlc_object_t *p_this )
348 vout_thread_t *p_vout = (vout_thread_t *)p_this;
350 CloseDisplay( p_vout );
352 /* Reset the terminal */
353 ioctl( p_vout->p_sys->i_tty, VT_SETMODE, &p_vout->p_sys->vt_mode );
355 /* Remove signal handlers */
356 sigaction( SIGUSR1, &p_vout->p_sys->sig_usr1, NULL );
357 sigaction( SIGUSR2, &p_vout->p_sys->sig_usr2, NULL );
359 /* Reset the keyboard state */
360 tcsetattr( 0, 0, &p_vout->p_sys->old_termios );
362 /* Return to text mode */
363 TextMode( p_vout->p_sys->i_tty );
365 /* Destroy structure */
366 free( p_vout->p_sys );
369 /*****************************************************************************
370 * Manage: handle FB events
371 *****************************************************************************
372 * This function should be called regularly by video output thread. It manages
373 * console events. It returns a non null value on error.
374 *****************************************************************************/
375 static int Manage( vout_thread_t *p_vout )
380 if ( read(0, &buf, 1) == 1)
385 p_vout->p_vlc->b_die = 1;
397 if( p_vout->i_changes & VOUT_SIZE_CHANGE )
399 msg_Dbg( p_vout, "reinitializing framebuffer screen" );
400 p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
402 /* Destroy XImages to change their size */
405 /* Recreate XImages. If SysInit failed, the thread can't go on. */
408 msg_Err( p_vout, "cannot reinit framebuffer screen" );
413 memset( p_vout->p_sys->p_video, 0, p_vout->p_sys->i_page_size );
416 /* Tell the video output thread that it will need to rebuild YUV
417 * tables. This is needed since conversion buffer size may have changed */
418 p_vout->i_changes |= VOUT_YUV_CHANGE;
425 /*****************************************************************************
426 * Display: displays previously rendered output
427 *****************************************************************************
428 * This function send the currently rendered image to FB image, waits until
429 * it is displayed and switch the two rendering buffers, preparing next frame.
430 *****************************************************************************/
431 static void Display( vout_thread_t *p_vout, picture_t *p_pic )
434 /* swap the two Y offsets if the drivers supports panning */
435 if( p_vout->p_sys->b_pan )
437 p_vout->p_sys->var_info.yoffset = 0;
438 /*p_vout->p_sys->var_info.yoffset = p_vout->p_sys->var_info.yres; */
440 /* the X offset should be 0, but who knows ...
441 * some other app might have played with the framebuffer */
442 p_vout->p_sys->var_info.xoffset = 0;
445 ioctl( p_vout->p_sys->i_fd,
446 FBIOPAN_DISPLAY, &p_vout->p_sys->var_info );
453 static void SetPalette( vout_thread_t *p_vout, uint16_t *red, uint16_t *green,
454 uint16_t *blue, uint16_t *transp )
456 struct fb_cmap cmap = { 0, 256, red, green, blue, transp };
458 ioctl( p_vout->p_sys->i_fd, FBIOPUTCMAP, &cmap );
462 /* following functions are local */
464 /*****************************************************************************
465 * OpenDisplay: initialize framebuffer
466 *****************************************************************************/
467 static int OpenDisplay( vout_thread_t *p_vout )
469 char *psz_device; /* framebuffer device path */
470 struct fb_fix_screeninfo fix_info; /* framebuffer fix information */
472 /* Open framebuffer device */
473 if( !(psz_device = config_GetPsz( p_vout, FB_DEV_VAR )) )
475 msg_Err( p_vout, "don't know which fb device to open" );
479 p_vout->p_sys->i_fd = open( psz_device, O_RDWR);
481 if( p_vout->p_sys->i_fd == -1 )
483 msg_Err( p_vout, "cannot open %s (%s)", psz_device, strerror(errno) );
489 /* Get framebuffer device information */
490 if( ioctl( p_vout->p_sys->i_fd,
491 FBIOGET_VSCREENINFO, &p_vout->p_sys->var_info ) )
493 msg_Err( p_vout, "cannot get fb info (%s)", strerror(errno) );
494 close( p_vout->p_sys->i_fd );
498 memcpy( &p_vout->p_sys->old_info, &p_vout->p_sys->var_info,
499 sizeof( struct fb_var_screeninfo ) );
501 /* Set some attributes */
502 p_vout->p_sys->var_info.activate = FB_ACTIVATE_NXTOPEN;
503 p_vout->p_sys->var_info.xoffset = 0;
504 p_vout->p_sys->var_info.yoffset = 0;
506 if( ioctl( p_vout->p_sys->i_fd,
507 FBIOPUT_VSCREENINFO, &p_vout->p_sys->var_info ) )
509 msg_Err( p_vout, "cannot set fb info (%s)", strerror(errno) );
510 close( p_vout->p_sys->i_fd );
514 /* Get some information again, in the definitive configuration */
515 if( ioctl( p_vout->p_sys->i_fd, FBIOGET_FSCREENINFO, &fix_info )
516 || ioctl( p_vout->p_sys->i_fd,
517 FBIOGET_VSCREENINFO, &p_vout->p_sys->var_info ) )
519 msg_Err( p_vout, "cannot get additional fb info (%s)",
522 /* Restore fb config */
523 ioctl( p_vout->p_sys->i_fd,
524 FBIOPUT_VSCREENINFO, &p_vout->p_sys->old_info );
526 close( p_vout->p_sys->i_fd );
530 /* FIXME: if the image is full-size, it gets cropped on the left
531 * because of the xres / xres_virtual slight difference */
532 msg_Dbg( p_vout, "%ix%i (virtual %ix%i)",
533 p_vout->p_sys->var_info.xres, p_vout->p_sys->var_info.yres,
534 p_vout->p_sys->var_info.xres_virtual,
535 p_vout->p_sys->var_info.yres_virtual );
537 p_vout->p_sys->i_height = p_vout->p_sys->var_info.yres;
538 p_vout->p_sys->i_width = p_vout->p_sys->var_info.xres_virtual
539 ? p_vout->p_sys->var_info.xres_virtual
540 : p_vout->p_sys->var_info.xres;
542 p_vout->p_sys->p_palette = NULL;
543 p_vout->p_sys->b_pan = ( fix_info.ypanstep || fix_info.ywrapstep );
545 switch( p_vout->p_sys->var_info.bits_per_pixel )
548 p_vout->p_sys->p_palette = malloc( 8 * 256 * sizeof( uint16_t ) );
549 p_vout->p_sys->fb_cmap.start = 0;
550 p_vout->p_sys->fb_cmap.len = 256;
551 p_vout->p_sys->fb_cmap.red = p_vout->p_sys->p_palette;
552 p_vout->p_sys->fb_cmap.green = p_vout->p_sys->p_palette + 256 * sizeof( uint16_t );
553 p_vout->p_sys->fb_cmap.blue = p_vout->p_sys->p_palette + 2 * 256 * sizeof( uint16_t );
554 p_vout->p_sys->fb_cmap.transp = p_vout->p_sys->p_palette + 3 * 256 * sizeof( uint16_t );
556 /* Save the colormap */
557 ioctl( p_vout->p_sys->i_fd, FBIOGETCMAP, &p_vout->p_sys->fb_cmap );
559 p_vout->p_sys->i_bytes_per_pixel = 1;
564 p_vout->p_sys->i_bytes_per_pixel = 2;
568 p_vout->p_sys->i_bytes_per_pixel = 3;
572 p_vout->p_sys->i_bytes_per_pixel = 4;
576 msg_Err( p_vout, "screen depth %d is not supported",
577 p_vout->p_sys->var_info.bits_per_pixel );
579 /* Restore fb config */
580 ioctl( p_vout->p_sys->i_fd,
581 FBIOPUT_VSCREENINFO, &p_vout->p_sys->old_info );
583 close( p_vout->p_sys->i_fd );
587 p_vout->p_sys->i_page_size = p_vout->p_sys->i_width *
588 p_vout->p_sys->i_height * p_vout->p_sys->i_bytes_per_pixel;
590 /* Map a framebuffer at the beginning */
591 p_vout->p_sys->p_video = mmap( 0, p_vout->p_sys->i_page_size,
592 PROT_READ | PROT_WRITE, MAP_SHARED,
593 p_vout->p_sys->i_fd, 0 );
595 if( p_vout->p_sys->p_video == ((void*)-1) )
597 msg_Err( p_vout, "cannot map video memory (%s)", strerror(errno) );
599 if( p_vout->p_sys->var_info.bits_per_pixel == 8 )
601 free( p_vout->p_sys->p_palette );
604 /* Restore fb config */
605 ioctl( p_vout->p_sys->i_fd,
606 FBIOPUT_VSCREENINFO, &p_vout->p_sys->old_info );
608 close( p_vout->p_sys->i_fd );
612 msg_Dbg( p_vout, "framebuffer type=%d, visual=%d, ypanstep=%d, "
613 "ywrap=%d, accel=%d", fix_info.type, fix_info.visual,
614 fix_info.ypanstep, fix_info.ywrapstep, fix_info.accel );
618 /*****************************************************************************
619 * CloseDisplay: terminate FB video thread output method
620 *****************************************************************************/
621 static void CloseDisplay( vout_thread_t *p_vout )
624 memset( p_vout->p_sys->p_video, 0, p_vout->p_sys->i_page_size );
626 /* Restore palette */
627 if( p_vout->p_sys->var_info.bits_per_pixel == 8 )
629 ioctl( p_vout->p_sys->i_fd,
630 FBIOPUTCMAP, &p_vout->p_sys->fb_cmap );
631 free( p_vout->p_sys->p_palette );
634 /* Restore fb config */
635 ioctl( p_vout->p_sys->i_fd,
636 FBIOPUT_VSCREENINFO, &p_vout->p_sys->old_info );
639 close( p_vout->p_sys->i_fd );
642 /*****************************************************************************
643 * SwitchDisplay: VT change signal handler
644 *****************************************************************************
645 * This function activates or deactivates the output of the thread. It is
646 * called by the VT driver, on terminal change.
647 *****************************************************************************/
648 static void SwitchDisplay(int i_signal)
651 vout_thread_t *p_vout;
653 vlc_mutex_lock( &p_vout_bank->lock );
655 /* XXX: only test the first video output */
656 if( p_vout_bank->i_count )
658 p_vout = p_vout_bank->pp_vout[0];
662 case SIGUSR1: /* vt has been released */
663 p_vout->b_active = 0;
664 ioctl( p_vout->p_sys->i_tty, VT_RELDISP, 1 );
666 case SIGUSR2: /* vt has been acquired */
667 p_vout->b_active = 1;
668 ioctl( p_vout->p_sys->i_tty, VT_RELDISP, VT_ACTIVATE );
669 /* handle blanking */
670 vlc_mutex_lock( &p_vout->change_lock );
671 p_vout->i_changes |= VOUT_SIZE_CHANGE;
672 vlc_mutex_unlock( &p_vout->change_lock );
677 vlc_mutex_unlock( &p_vout_bank->lock );
681 /*****************************************************************************
682 * TextMode and GfxMode : switch tty to text/graphic mode
683 *****************************************************************************
684 * These functions toggle the tty mode.
685 *****************************************************************************/
686 static void TextMode( int i_tty )
688 /* return to text mode */
689 if( -1 == ioctl(i_tty, KDSETMODE, KD_TEXT) )
691 /*msg_Err( p_vout, "failed ioctl KDSETMODE KD_TEXT" );*/
695 static void GfxMode( int i_tty )
697 /* switch to graphic mode */
698 if( -1 == ioctl(i_tty, KDSETMODE, KD_GRAPHICS) )
700 /*msg_Err( p_vout, "failed ioctl KDSETMODE KD_GRAPHICS" );*/