1 /*****************************************************************************
2 * fb.c : framebuffer plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2000-2009 the VideoLAN team
7 * Authors: Samuel Hocevar <sam@zoy.org>
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.
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.
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 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
33 #include <errno.h> /* ENOMEM */
34 #include <signal.h> /* SIGUSR1, SIGUSR2 */
35 #include <fcntl.h> /* open() */
36 #include <unistd.h> /* close() */
38 #include <termios.h> /* struct termios */
39 #include <sys/ioctl.h>
40 #include <sys/mman.h> /* mmap() */
43 #include <linux/vt.h> /* VT_* */
44 #include <linux/kd.h> /* KD* */
46 #include <vlc_common.h>
47 #include <vlc_plugin.h>
48 #include <vlc_vout_display.h>
49 #include <vlc_picture_pool.h>
50 #include <vlc_charset.h>
52 /*****************************************************************************
54 *****************************************************************************/
55 #define FB_DEV_VAR "fbdev"
57 #define DEVICE_TEXT N_("Framebuffer device")
58 #define DEVICE_LONGTEXT N_(\
59 "Framebuffer device to use for rendering (usually /dev/fb0).")
61 #define TTY_TEXT N_("Run fb on current tty.")
62 #define TTY_LONGTEXT N_(\
63 "Run framebuffer on current TTY device (default enabled). " \
64 "(disable tty handling with caution)")
66 #define FB_MODE_TEXT N_("Framebuffer resolution to use.")
67 #define FB_MODE_LONGTEXT N_(\
68 "Select the resolution for the framebuffer. Currently it supports " \
69 "the values 0=QCIF 1=CIF 2=NTSC 3=PAL, 4=auto (default 4=auto)")
71 #define HW_ACCEL_TEXT N_("Framebuffer uses hw acceleration.")
72 #define HW_ACCEL_LONGTEXT N_(\
73 "If your framebuffer supports hardware acceleration or does double buffering " \
74 "in hardware then you must disable this option. It then does double buffering " \
77 #define CHROMA_TEXT N_("Image format (default RGB).")
78 #define CHROMA_LONGTEXT N_("Chroma fourcc used by the framebuffer. Default is RGB since the fb device has no way to report its chroma.")
80 static int Open (vlc_object_t *);
81 static void Close(vlc_object_t *);
84 set_shortname("Framebuffer")
85 set_category(CAT_VIDEO)
86 set_subcategory(SUBCAT_VIDEO_VOUT)
87 add_file(FB_DEV_VAR, "/dev/fb0", NULL, DEVICE_TEXT, DEVICE_LONGTEXT,
89 add_bool("fb-tty", true, NULL, TTY_TEXT, TTY_LONGTEXT, true)
90 add_string( "fb-chroma", NULL, NULL, CHROMA_TEXT, CHROMA_LONGTEXT, true )
91 add_obsolete_string("fb-aspect-ratio")
92 add_integer("fb-mode", 4, NULL, FB_MODE_TEXT, FB_MODE_LONGTEXT,
94 add_bool("fb-hw-accel", true, NULL, HW_ACCEL_TEXT, HW_ACCEL_LONGTEXT,
96 set_description(N_("GNU/Linux framebuffer video output"))
97 set_capability("vout display", 30)
98 set_callbacks(Open, Close)
101 /*****************************************************************************
103 *****************************************************************************/
104 static picture_pool_t *Pool (vout_display_t *, unsigned);
105 static void Display(vout_display_t *, picture_t *);
106 static int Control(vout_display_t *, int, va_list);
107 static void Manage (vout_display_t *);
110 static int OpenDisplay (vout_display_t *, bool force_resolution);
111 static void CloseDisplay (vout_display_t *);
112 static void SwitchDisplay(int i_signal);
113 static void TextMode (int tty);
114 static void GfxMode (int tty);
116 static int TtyInit(vout_display_t *);
117 static void TtyExit(vout_display_t *);
120 struct vout_display_sys_t {
121 /* System information */
122 int tty; /* tty device handle */
124 struct termios old_termios;
126 /* Original configuration information */
127 struct sigaction sig_usr1; /* USR1 previous handler */
128 struct sigaction sig_usr2; /* USR2 previous handler */
129 struct vt_mode vt_mode; /* previous VT mode */
131 /* Framebuffer information */
132 int fd; /* device handle */
133 struct fb_var_screeninfo old_info; /* original mode information */
134 struct fb_var_screeninfo var_info; /* current mode information */
135 bool has_pan; /* does device supports panning ? */
136 struct fb_cmap fb_cmap; /* original colormap */
137 uint16_t *palette; /* original palette */
138 bool is_hw_accel; /* has hardware support */
140 /* Video information */
143 uint32_t line_length;
148 uint8_t *video_ptr; /* base adress */
149 size_t video_size; /* page size */
152 picture_pool_t *pool;
156 static void ClearScreen(vout_display_sys_t *sys)
158 switch (sys->chroma) {
159 /* XXX: add other chromas */
160 case VLC_CODEC_UYVY: {
161 unsigned int j, size = sys->video_size / 4;
162 uint32_t *ptr = (uint32_t*)((uintptr_t)(sys->video_ptr + 3) & ~3);
163 for(j=0; j < size; j++)
164 ptr[j] = 0x10801080; /* U = V = 16, Y = 128 */
168 memset(sys->video_ptr, 0, sys->video_size);
173 * This function allocates and initializes a FB vout method.
175 static int Open(vlc_object_t *object)
177 vout_display_t *vd = (vout_display_t *)object;
178 vout_display_sys_t *sys;
180 /* Allocate instance and initialize some members */
181 vd->sys = sys = calloc(1, sizeof(*sys));
185 /* Does the framebuffer uses hw acceleration? */
186 sys->is_hw_accel = var_CreateGetBool(vd, "fb-hw-accel");
188 /* Set tty and fb devices */
189 sys->tty = 0; /* 0 == /dev/tty0 == current console */
190 sys->is_tty = var_CreateGetBool(vd, "fb-tty");
191 #if !defined(WIN32) && defined(HAVE_ISATTY)
192 /* Check that stdin is a TTY */
193 if (sys->is_tty && !isatty(0)) {
194 msg_Warn(vd, "fd 0 is not a TTY");
198 msg_Warn(vd, "disabling tty handling, use with caution because "
199 "there is no way to return to the tty.");
202 const int mode = var_CreateGetInteger(vd, "fb-mode");
203 bool force_resolution = true;
223 force_resolution = false;
227 char *chroma = var_CreateGetNonEmptyString(vd, "fb-chroma");
229 sys->chroma = vlc_fourcc_GetCodecFromString(VIDEO_ES, chroma);
232 msg_Dbg(vd, "forcing chroma '%s'", chroma);
234 msg_Warn(vd, "chroma %s invalid, using default", chroma);
241 if (sys->is_tty && TtyInit(vd)) {
247 sys->video_ptr = MAP_FAILED;
251 if (OpenDisplay(vd, force_resolution)) {
252 Close(VLC_OBJECT(vd));
257 video_format_t fmt = vd->fmt;
260 fmt.i_chroma = sys->chroma;
264 msg_Dbg(vd, "%d bppd", sys->var_info.bits_per_pixel);
265 switch (sys->var_info.bits_per_pixel) {
266 case 8: /* FIXME: set the palette */
267 fmt.i_chroma = VLC_CODEC_RGB8;
270 fmt.i_chroma = VLC_CODEC_RGB15;
273 fmt.i_chroma = VLC_CODEC_RGB16;
276 fmt.i_chroma = VLC_CODEC_RGB24;
279 fmt.i_chroma = VLC_CODEC_RGB32;
282 msg_Err(vd, "unknown screendepth %i", sys->var_info.bits_per_pixel);
283 Close(VLC_OBJECT(vd));
286 if (sys->var_info.bits_per_pixel != 8) {
287 fmt.i_rmask = ((1 << sys->var_info.red.length) - 1)
288 << sys->var_info.red.offset;
289 fmt.i_gmask = ((1 << sys->var_info.green.length) - 1)
290 << sys->var_info.green.offset;
291 fmt.i_bmask = ((1 << sys->var_info.blue.length) - 1)
292 << sys->var_info.blue.offset;
296 fmt.i_width = sys->width;
297 fmt.i_height = sys->height;
300 vout_display_info_t info = vd->info;
301 info.has_hide_mouse = true;
308 vd->display = Display;
309 vd->control = Control;
313 vout_display_SendEventFullscreen(vd, true);
314 vout_display_SendEventDisplaySize(vd, fmt.i_width, fmt.i_height, true);
319 * Terminate an output method created by Open
321 static void Close(vlc_object_t *object)
323 vout_display_t *vd = (vout_display_t *)object;
324 vout_display_sys_t *sys = vd->sys;
327 picture_pool_Delete(sys->pool);
328 if (!sys->is_hw_accel && sys->picture)
329 picture_Release(sys->picture);
340 static picture_pool_t *Pool(vout_display_t *vd, unsigned count)
342 vout_display_sys_t *sys = vd->sys;
346 picture_resource_t rsc;
348 memset(&rsc, 0, sizeof(rsc));
349 rsc.p[0].p_pixels = sys->video_ptr;
350 rsc.p[0].i_lines = sys->var_info.yres;
351 rsc.p[0].i_pitch = sys->line_length;
353 sys->picture = picture_NewFromResource(&vd->fmt, &rsc);
358 if (sys->is_hw_accel)
359 sys->pool = picture_pool_New(1, &sys->picture);
361 sys->pool = picture_pool_NewFromFormat(&vd->fmt, count);
365 static void Display(vout_display_t *vd, picture_t *picture)
367 vout_display_sys_t *sys = vd->sys;
369 /* swap the two Y offsets if the drivers supports panning */
371 sys->var_info.yoffset = 0;
372 /*vd->sys->var_info.yoffset = vd->sys->var_info.yres; */
374 /* the X offset should be 0, but who knows ...
375 * some other app might have played with the framebuffer */
376 sys->var_info.xoffset = 0;
378 /* FIXME 'static' is damn wrong and it's dead code ... */
379 static int panned = 0;
381 ioctl(sys->fd, FBIOPAN_DISPLAY, &sys->var_info);
386 if (!sys->is_hw_accel)
387 picture_Copy(sys->picture, picture);
389 picture_Release(picture);
391 static int Control(vout_display_t *vd, int query, va_list args)
393 vout_display_sys_t *sys = vd->sys;
396 case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE: {
397 const vout_display_cfg_t *cfg = va_arg(args, const vout_display_cfg_t *);
398 if (cfg->display.width != sys->width ||
399 cfg->display.height != sys->height)
404 msg_Err(vd, "Unsupported query in vout display fb");
408 static void Manage (vout_display_t *vd)
415 if (vd->i_changes & VOUT_SIZE_CHANGE)
417 msg_Dbg(vd, "reinitializing framebuffer screen");
418 vd->i_changes &= ~VOUT_SIZE_CHANGE;
420 vout_display_SendEventDisplaySize();
422 ClearScreen(vd->sys);
427 /* following functions are local */
428 static int TtyInit(vout_display_t *vd)
430 vout_display_sys_t *sys = vd->sys;
432 struct termios new_termios;
436 /* Set keyboard settings */
437 if (tcgetattr(0, &sys->old_termios) == -1) {
438 msg_Err(vd, "tcgetattr failed");
441 if (tcgetattr(0, &new_termios) == -1) {
442 msg_Err(vd, "tcgetattr failed");
445 /* new_termios.c_lflag &= ~ (ICANON | ISIG);
446 new_termios.c_lflag |= (ECHO | ECHOCTL); */
447 new_termios.c_lflag &= ~ (ICANON);
448 new_termios.c_lflag &= ~(ECHO | ECHOCTL);
449 new_termios.c_iflag = 0;
450 new_termios.c_cc[VMIN] = 1;
451 new_termios.c_cc[VTIME] = 0;
453 if (tcsetattr(0, TCSAFLUSH, &new_termios) == -1) {
454 msg_Err(vd, "tcsetattr failed");
457 ioctl(sys->tty, VT_RELDISP, VT_ACKACQ);
459 /* Set-up tty signal handler to be aware of tty changes */
460 struct sigaction sig_tty;
461 memset(&sig_tty, 0, sizeof(sig_tty));
462 sig_tty.sa_handler = SwitchDisplay;
463 sigemptyset(&sig_tty.sa_mask);
464 if (sigaction(SIGUSR1, &sig_tty, &sys->sig_usr1) ||
465 sigaction(SIGUSR2, &sig_tty, &sys->sig_usr2)) {
466 msg_Err(vd, "cannot set signal handler (%m)");
467 /* FIXME SIGUSR1 could have succeed */
471 /* Set-up tty according to new signal handler */
472 if (-1 == ioctl(sys->tty, VT_GETMODE, &sys->vt_mode)) {
473 msg_Err(vd, "cannot get terminal mode (%m)");
476 struct vt_mode vt_mode = sys->vt_mode;
477 vt_mode.mode = VT_PROCESS;
479 vt_mode.relsig = SIGUSR1;
480 vt_mode.acqsig = SIGUSR2;
482 if (-1 == ioctl(sys->tty, VT_SETMODE, &vt_mode)) {
483 msg_Err(vd, "cannot set terminal mode (%m)");
489 sigaction(SIGUSR1, &sys->sig_usr1, NULL);
490 sigaction(SIGUSR2, &sys->sig_usr2, NULL);
492 tcsetattr(0, 0, &sys->old_termios);
496 static void TtyExit(vout_display_t *vd)
498 vout_display_sys_t *sys = vd->sys;
500 /* Reset the terminal */
501 ioctl(sys->tty, VT_SETMODE, &sys->vt_mode);
503 /* Remove signal handlers */
504 sigaction(SIGUSR1, &sys->sig_usr1, NULL);
505 sigaction(SIGUSR2, &sys->sig_usr2, NULL);
507 /* Reset the keyboard state */
508 tcsetattr(0, 0, &sys->old_termios);
510 /* Return to text mode */
514 /*****************************************************************************
515 * OpenDisplay: initialize framebuffer
516 *****************************************************************************/
517 static int OpenDisplay(vout_display_t *vd, bool force_resolution)
519 vout_display_sys_t *sys = vd->sys;
520 char *psz_device; /* framebuffer device path */
522 /* Open framebuffer device */
523 if (!(psz_device = config_GetPsz(vd, FB_DEV_VAR))) {
524 msg_Err(vd, "don't know which fb device to open");
528 sys->fd = utf8_open(psz_device, O_RDWR);
530 msg_Err(vd, "cannot open %s (%m)", psz_device);
536 /* Get framebuffer device information */
537 if (ioctl(sys->fd, FBIOGET_VSCREENINFO, &sys->var_info)) {
538 msg_Err(vd, "cannot get fb info (%m)");
542 sys->old_info = sys->var_info;
544 /* Get some info on the framebuffer itself */
545 if (force_resolution) {
546 sys->var_info.xres = sys->var_info.xres_virtual = sys->width;
547 sys->var_info.yres = sys->var_info.yres_virtual = sys->height;
550 /* Set some attributes */
551 sys->var_info.activate = sys->is_tty ? FB_ACTIVATE_NXTOPEN :
553 sys->var_info.xoffset = 0;
554 sys->var_info.yoffset = 0;
556 if (ioctl(sys->fd, FBIOPUT_VSCREENINFO, &sys->var_info)) {
557 msg_Err(vd, "cannot set fb info (%m)");
562 struct fb_fix_screeninfo fix_info;
563 /* Get some information again, in the definitive configuration */
564 if (ioctl(sys->fd, FBIOGET_FSCREENINFO, &fix_info) ||
565 ioctl(sys->fd, FBIOGET_VSCREENINFO, &sys->var_info)) {
566 msg_Err(vd, "cannot get additional fb info (%m)");
568 /* Restore fb config */
569 ioctl(sys->fd, FBIOPUT_VSCREENINFO, &sys->old_info);
575 /* If the fb has limitations on mode change,
576 * then keep the resolution of the fb */
577 if ((sys->height != sys->var_info.yres) ||
578 (sys->width != sys->var_info.xres)) {
580 "using framebuffer native resolution instead of requested (%ix%i)",
581 sys->width, sys->height);
583 sys->height = sys->var_info.yres;
584 sys->width = sys->var_info.xres_virtual ? sys->var_info.xres_virtual :
586 sys->line_length = fix_info.line_length;
588 /* FIXME: if the image is full-size, it gets cropped on the left
589 * because of the xres / xres_virtual slight difference */
590 msg_Dbg(vd, "%ix%i (virtual %ix%i) (request %ix%i)",
591 sys->var_info.xres, sys->var_info.yres,
592 sys->var_info.xres_virtual,
593 sys->var_info.yres_virtual,
594 sys->width, sys->height);
597 sys->has_pan = (fix_info.ypanstep || fix_info.ywrapstep);
599 switch (sys->var_info.bits_per_pixel) {
601 sys->palette = malloc(8 * 256 * sizeof(uint16_t));
603 /* Restore fb config */
604 ioctl(sys->fd, FBIOPUT_VSCREENINFO, &sys->old_info);
609 sys->fb_cmap.start = 0;
610 sys->fb_cmap.len = 256;
611 sys->fb_cmap.red = sys->palette;
612 sys->fb_cmap.green = sys->palette + 256 * sizeof(uint16_t);
613 sys->fb_cmap.blue = sys->palette + 2 * 256 * sizeof(uint16_t);
614 sys->fb_cmap.transp = sys->palette + 3 * 256 * sizeof(uint16_t);
616 /* Save the colormap */
617 ioctl(sys->fd, FBIOGETCMAP, &sys->fb_cmap);
619 sys->bytes_per_pixel = 1;
624 sys->bytes_per_pixel = 2;
628 sys->bytes_per_pixel = 3;
632 sys->bytes_per_pixel = 4;
636 msg_Err(vd, "screen depth %d is not supported",
637 sys->var_info.bits_per_pixel);
639 /* Restore fb config */
640 ioctl(sys->fd, FBIOPUT_VSCREENINFO, &sys->old_info);
646 sys->video_size = sys->line_length * sys->var_info.yres_virtual;
648 /* Map a framebuffer at the beginning */
649 sys->video_ptr = mmap(NULL, sys->video_size,
650 PROT_READ | PROT_WRITE, MAP_SHARED, sys->fd, 0);
652 if (sys->video_ptr == MAP_FAILED) {
653 msg_Err(vd, "cannot map video memory (%m)");
655 if (sys->var_info.bits_per_pixel == 8) {
660 /* Restore fb config */
661 ioctl(sys->fd, FBIOPUT_VSCREENINFO, &sys->old_info);
670 "framebuffer type=%d, visual=%d, ypanstep=%d, ywrap=%d, accel=%d",
671 fix_info.type, fix_info.visual,
672 fix_info.ypanstep, fix_info.ywrapstep, fix_info.accel);
676 /*****************************************************************************
677 * CloseDisplay: terminate FB video thread output method
678 *****************************************************************************/
679 static void CloseDisplay(vout_display_t *vd)
681 vout_display_sys_t *sys = vd->sys;
683 if (sys->video_ptr != MAP_FAILED) {
685 munmap(sys->video_ptr, sys->video_size);
689 /* Restore palette */
690 if (sys->var_info.bits_per_pixel == 8) {
691 ioctl(sys->fd, FBIOPUTCMAP, &sys->fb_cmap);
696 /* Restore fb config */
697 ioctl(sys->fd, FBIOPUT_VSCREENINFO, &sys->old_info);
704 /*****************************************************************************
705 * SwitchDisplay: VT change signal handler
706 *****************************************************************************
707 * This function activates or deactivates the output of the thread. It is
708 * called by the VT driver, on terminal change.
709 *****************************************************************************/
710 static void SwitchDisplay(int i_signal)
712 VLC_UNUSED(i_signal);
716 vlc_mutex_lock(&p_vout_bank->lock);
718 /* XXX: only test the first video output */
719 if (p_vout_bank->i_count)
721 vd = p_vout_bank->pp_vout[0];
725 case SIGUSR1: /* vt has been released */
727 ioctl(sys->tty, VT_RELDISP, 1);
729 case SIGUSR2: /* vt has been acquired */
731 ioctl(sys->tty, VT_RELDISP, VT_ACTIVATE);
732 /* handle blanking */
733 vlc_mutex_lock(&vd->change_lock);
734 vd->i_changes |= VOUT_SIZE_CHANGE;
735 vlc_mutex_unlock(&vd->change_lock);
740 vlc_mutex_unlock(&p_vout_bank->lock);
744 /*****************************************************************************
745 * TextMode and GfxMode : switch tty to text/graphic mode
746 *****************************************************************************
747 * These functions toggle the tty mode.
748 *****************************************************************************/
749 static void TextMode(int tty)
751 /* return to text mode */
752 if (-1 == ioctl(tty, KDSETMODE, KD_TEXT)) {
753 /*msg_Err(vd, "failed ioctl KDSETMODE KD_TEXT");*/
757 static void GfxMode(int tty)
759 /* switch to graphic mode */
760 if (-1 == ioctl(tty, KDSETMODE, KD_GRAPHICS)) {
761 /*msg_Err(vd, "failed ioctl KDSETMODE KD_GRAPHICS");*/