1 /*****************************************************************************
2 * fb.c : framebuffer plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2000-2009 VLC authors and VideoLAN
7 * Authors: Samuel Hocevar <sam@zoy.org>
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU Lesser General Public License as published by
12 * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public License
21 * along with this program; if not, write to the Free Software Foundation,
22 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
33 #include <signal.h> /* SIGUSR1, SIGUSR2 */
34 #include <fcntl.h> /* open() */
35 #include <unistd.h> /* close() */
37 #include <termios.h> /* struct termios */
38 #include <sys/ioctl.h>
39 #include <sys/mman.h> /* mmap() */
42 #include <linux/vt.h> /* VT_* */
43 #include <linux/kd.h> /* KD* */
45 #include <vlc_common.h>
46 #include <vlc_plugin.h>
47 #include <vlc_vout_display.h>
48 #include <vlc_picture_pool.h>
51 /*****************************************************************************
53 *****************************************************************************/
54 #define FB_DEV_VAR "fbdev"
56 #define DEVICE_TEXT N_("Framebuffer device")
57 #define DEVICE_LONGTEXT N_(\
58 "Framebuffer device to use for rendering (usually /dev/fb0).")
60 #define TTY_TEXT N_("Run fb on current tty")
61 #define TTY_LONGTEXT N_(\
62 "Run framebuffer on current TTY device (default enabled). " \
63 "(disable tty handling with caution)")
65 #define FB_MODE_TEXT N_("Framebuffer resolution to use")
66 #define FB_MODE_LONGTEXT N_(\
67 "Select the resolution for the framebuffer. Currently it supports " \
68 "the values 0=QCIF 1=CIF 2=NTSC 3=PAL, 4=auto (default 4=auto)")
70 #define HW_ACCEL_TEXT N_("Framebuffer uses hw acceleration")
71 #define HW_ACCEL_LONGTEXT N_(\
72 "If your framebuffer supports hardware acceleration or does double buffering " \
73 "in hardware then you must disable this option. It then does double buffering " \
76 #define CHROMA_TEXT N_("Image format (default RGB)")
77 #define CHROMA_LONGTEXT N_("Chroma fourcc used by the framebuffer. Default is RGB since the fb device has no way to report its chroma.")
79 static int Open (vlc_object_t *);
80 static void Close(vlc_object_t *);
83 set_shortname("Framebuffer")
84 set_category(CAT_VIDEO)
85 set_subcategory(SUBCAT_VIDEO_VOUT)
86 add_loadfile(FB_DEV_VAR, "/dev/fb0", DEVICE_TEXT, DEVICE_LONGTEXT,
88 add_bool("fb-tty", true, TTY_TEXT, TTY_LONGTEXT, true)
89 add_string( "fb-chroma", NULL, CHROMA_TEXT, CHROMA_LONGTEXT, true )
90 add_obsolete_string("fb-aspect-ratio")
91 add_integer("fb-mode", 4, FB_MODE_TEXT, FB_MODE_LONGTEXT,
93 add_bool("fb-hw-accel", true, HW_ACCEL_TEXT, HW_ACCEL_LONGTEXT,
95 set_description(N_("GNU/Linux framebuffer video output"))
96 set_capability("vout display", 30)
97 set_callbacks(Open, Close)
100 /*****************************************************************************
102 *****************************************************************************/
103 static picture_pool_t *Pool (vout_display_t *, unsigned);
104 static void Display(vout_display_t *, picture_t *, subpicture_t *);
105 static int Control(vout_display_t *, int, va_list);
108 static int OpenDisplay (vout_display_t *, bool force_resolution);
109 static void CloseDisplay (vout_display_t *);
111 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 */
128 struct sigaction sig_usr1; /* USR1 previous handler */
129 struct sigaction sig_usr2; /* USR2 previous handler */
131 struct vt_mode vt_mode; /* previous VT mode */
133 /* Framebuffer information */
134 int fd; /* device handle */
135 struct fb_var_screeninfo old_info; /* original mode information */
136 struct fb_var_screeninfo var_info; /* current mode information */
137 bool has_pan; /* does device supports panning ? */
138 struct fb_cmap fb_cmap; /* original colormap */
139 uint16_t *palette; /* original palette */
140 bool is_hw_accel; /* has hardware support */
142 /* Video information */
145 uint32_t line_length;
150 uint8_t *video_ptr; /* base address */
151 size_t video_size; /* page size */
154 picture_pool_t *pool;
158 static void ClearScreen(vout_display_sys_t *sys)
160 switch (sys->chroma) {
161 /* XXX: add other chromas */
162 case VLC_CODEC_UYVY: {
163 unsigned int j, size = sys->video_size / 4;
164 uint32_t *ptr = (uint32_t*)((uintptr_t)(sys->video_ptr + 3) & ~3);
165 for(j=0; j < size; j++)
166 ptr[j] = 0x10801080; /* U = V = 16, Y = 128 */
170 memset(sys->video_ptr, 0, sys->video_size);
175 * This function allocates and initializes a FB vout method.
177 static int Open(vlc_object_t *object)
179 vout_display_t *vd = (vout_display_t *)object;
180 vout_display_sys_t *sys;
182 /* Allocate instance and initialize some members */
183 vd->sys = sys = calloc(1, sizeof(*sys));
187 /* Does the framebuffer uses hw acceleration? */
188 sys->is_hw_accel = var_InheritBool(vd, "fb-hw-accel");
190 /* Set tty and fb devices */
191 sys->tty = 0; /* 0 == /dev/tty0 == current console */
192 sys->is_tty = var_InheritBool(vd, "fb-tty");
193 #if !defined(_WIN32) && defined(HAVE_ISATTY)
194 /* Check that stdin is a TTY */
195 if (sys->is_tty && !isatty(0)) {
196 msg_Warn(vd, "standard input is not a TTY");
200 msg_Warn(vd, "disabling TTY handling, use with caution because "
201 "there is no way to return to the TTY");
204 const int mode = var_InheritInteger(vd, "fb-mode");
205 bool force_resolution = true;
225 force_resolution = false;
229 char *chroma = var_InheritString(vd, "fb-chroma");
231 sys->chroma = vlc_fourcc_GetCodecFromString(VIDEO_ES, chroma);
234 msg_Dbg(vd, "forcing chroma '%s'", chroma);
236 msg_Warn(vd, "chroma %s invalid, using default", chroma);
243 if (sys->is_tty && TtyInit(vd)) {
249 sys->video_ptr = MAP_FAILED;
253 if (OpenDisplay(vd, force_resolution)) {
254 Close(VLC_OBJECT(vd));
257 vout_display_DeleteWindow(vd, NULL);
260 video_format_t fmt = vd->fmt;
263 fmt.i_chroma = sys->chroma;
267 msg_Dbg(vd, "%d bppd", sys->var_info.bits_per_pixel);
268 switch (sys->var_info.bits_per_pixel) {
269 case 8: /* FIXME: set the palette */
270 fmt.i_chroma = VLC_CODEC_RGB8;
273 fmt.i_chroma = VLC_CODEC_RGB15;
276 fmt.i_chroma = VLC_CODEC_RGB16;
279 fmt.i_chroma = VLC_CODEC_RGB24;
282 fmt.i_chroma = VLC_CODEC_RGB32;
285 msg_Err(vd, "unknown screendepth %i", sys->var_info.bits_per_pixel);
286 Close(VLC_OBJECT(vd));
289 if (sys->var_info.bits_per_pixel != 8) {
290 fmt.i_rmask = ((1 << sys->var_info.red.length) - 1)
291 << sys->var_info.red.offset;
292 fmt.i_gmask = ((1 << sys->var_info.green.length) - 1)
293 << sys->var_info.green.offset;
294 fmt.i_bmask = ((1 << sys->var_info.blue.length) - 1)
295 << sys->var_info.blue.offset;
299 fmt.i_visible_width = sys->width;
300 fmt.i_visible_height = sys->height;
303 vout_display_info_t info = vd->info;
304 info.has_hide_mouse = true;
311 vd->display = Display;
312 vd->control = Control;
316 vout_display_SendEventFullscreen(vd, true);
317 vout_display_SendEventDisplaySize(vd, fmt.i_visible_width, fmt.i_visible_height, true);
322 * Terminate an output method created by Open
324 static void Close(vlc_object_t *object)
326 vout_display_t *vd = (vout_display_t *)object;
327 vout_display_sys_t *sys = vd->sys;
330 picture_pool_Delete(sys->pool);
331 if (!sys->is_hw_accel && sys->picture)
332 picture_Release(sys->picture);
343 static picture_pool_t *Pool(vout_display_t *vd, unsigned count)
345 vout_display_sys_t *sys = vd->sys;
349 picture_resource_t rsc;
351 memset(&rsc, 0, sizeof(rsc));
352 rsc.p[0].p_pixels = sys->video_ptr;
353 rsc.p[0].i_lines = sys->var_info.yres;
354 rsc.p[0].i_pitch = sys->line_length;
356 sys->picture = picture_NewFromResource(&vd->fmt, &rsc);
361 if (sys->is_hw_accel)
362 sys->pool = picture_pool_New(1, &sys->picture);
364 sys->pool = picture_pool_NewFromFormat(&vd->fmt, count);
368 static void Display(vout_display_t *vd, picture_t *picture, subpicture_t *subpicture)
370 vout_display_sys_t *sys = vd->sys;
372 /* swap the two Y offsets if the drivers supports panning */
374 sys->var_info.yoffset = 0;
375 /*vd->sys->var_info.yoffset = vd->sys->var_info.yres; */
377 /* the X offset should be 0, but who knows ...
378 * some other app might have played with the framebuffer */
379 sys->var_info.xoffset = 0;
381 /* FIXME 'static' is damn wrong and it's dead code ... */
382 static int panned = 0;
384 ioctl(sys->fd, FBIOPAN_DISPLAY, &sys->var_info);
389 if (!sys->is_hw_accel)
390 picture_Copy(sys->picture, picture);
392 picture_Release(picture);
393 VLC_UNUSED(subpicture);
395 static int Control(vout_display_t *vd, int query, va_list args)
397 vout_display_sys_t *sys = vd->sys;
400 case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE: {
401 const vout_display_cfg_t *cfg = va_arg(args, const vout_display_cfg_t *);
402 if (cfg->display.width != sys->width ||
403 cfg->display.height != sys->height)
408 msg_Err(vd, "Unsupported query in vout display fb");
413 /* following functions are local */
414 static int TtyInit(vout_display_t *vd)
416 vout_display_sys_t *sys = vd->sys;
418 struct termios new_termios;
422 /* Set keyboard settings */
423 if (tcgetattr(0, &sys->old_termios) == -1) {
424 msg_Err(vd, "tcgetattr failed");
427 if (tcgetattr(0, &new_termios) == -1) {
428 msg_Err(vd, "tcgetattr failed");
431 /* new_termios.c_lflag &= ~ (ICANON | ISIG);
432 new_termios.c_lflag |= (ECHO | ECHOCTL); */
433 new_termios.c_lflag &= ~ (ICANON);
434 new_termios.c_lflag &= ~(ECHO | ECHOCTL);
435 new_termios.c_iflag = 0;
436 new_termios.c_cc[VMIN] = 1;
437 new_termios.c_cc[VTIME] = 0;
439 if (tcsetattr(0, TCSAFLUSH, &new_termios) == -1) {
440 msg_Err(vd, "tcsetattr failed");
443 ioctl(sys->tty, VT_RELDISP, VT_ACKACQ);
446 /* Set-up tty signal handler to be aware of tty changes */
447 struct sigaction sig_tty;
448 memset(&sig_tty, 0, sizeof(sig_tty));
449 sig_tty.sa_handler = SwitchDisplay;
450 sigemptyset(&sig_tty.sa_mask);
451 if (sigaction(SIGUSR1, &sig_tty, &sys->sig_usr1) ||
452 sigaction(SIGUSR2, &sig_tty, &sys->sig_usr2)) {
453 msg_Err(vd, "cannot set signal handler (%s)", vlc_strerror_c(errno));
454 /* FIXME SIGUSR1 could have succeed */
459 /* Set-up tty according to new signal handler */
460 if (-1 == ioctl(sys->tty, VT_GETMODE, &sys->vt_mode)) {
461 msg_Err(vd, "cannot get terminal mode (%s)", vlc_strerror_c(errno));
464 struct vt_mode vt_mode = sys->vt_mode;
465 vt_mode.mode = VT_PROCESS;
467 vt_mode.relsig = SIGUSR1;
468 vt_mode.acqsig = SIGUSR2;
470 if (-1 == ioctl(sys->tty, VT_SETMODE, &vt_mode)) {
471 msg_Err(vd, "cannot set terminal mode (%s)", vlc_strerror_c(errno));
478 sigaction(SIGUSR1, &sys->sig_usr1, NULL);
479 sigaction(SIGUSR2, &sys->sig_usr2, NULL);
482 tcsetattr(0, 0, &sys->old_termios);
486 static void TtyExit(vout_display_t *vd)
488 vout_display_sys_t *sys = vd->sys;
490 /* Reset the terminal */
491 ioctl(sys->tty, VT_SETMODE, &sys->vt_mode);
494 /* Remove signal handlers */
495 sigaction(SIGUSR1, &sys->sig_usr1, NULL);
496 sigaction(SIGUSR2, &sys->sig_usr2, NULL);
499 /* Reset the keyboard state */
500 tcsetattr(0, 0, &sys->old_termios);
502 /* Return to text mode */
506 /*****************************************************************************
507 * OpenDisplay: initialize framebuffer
508 *****************************************************************************/
509 static int OpenDisplay(vout_display_t *vd, bool force_resolution)
511 vout_display_sys_t *sys = vd->sys;
512 char *psz_device; /* framebuffer device path */
514 /* Open framebuffer device */
515 if (!(psz_device = var_InheritString(vd, FB_DEV_VAR))) {
516 msg_Err(vd, "don't know which fb device to open");
520 sys->fd = vlc_open(psz_device, O_RDWR);
522 msg_Err(vd, "cannot open %s (%s)", psz_device, vlc_strerror_c(errno));
528 /* Get framebuffer device information */
529 if (ioctl(sys->fd, FBIOGET_VSCREENINFO, &sys->var_info)) {
530 msg_Err(vd, "cannot get fb info (%s)", vlc_strerror_c(errno));
534 sys->old_info = sys->var_info;
536 /* Get some info on the framebuffer itself */
537 if (force_resolution) {
538 sys->var_info.xres = sys->var_info.xres_virtual = sys->width;
539 sys->var_info.yres = sys->var_info.yres_virtual = sys->height;
542 /* Set some attributes */
543 sys->var_info.activate = sys->is_tty ? FB_ACTIVATE_NXTOPEN :
545 sys->var_info.xoffset = 0;
546 sys->var_info.yoffset = 0;
548 if (ioctl(sys->fd, FBIOPUT_VSCREENINFO, &sys->var_info)) {
549 msg_Err(vd, "cannot set fb info (%s)", vlc_strerror_c(errno));
554 struct fb_fix_screeninfo fix_info;
555 /* Get some information again, in the definitive configuration */
556 if (ioctl(sys->fd, FBIOGET_FSCREENINFO, &fix_info) ||
557 ioctl(sys->fd, FBIOGET_VSCREENINFO, &sys->var_info)) {
558 msg_Err(vd, "cannot get additional fb info (%s)",
559 vlc_strerror_c(errno));
561 /* Restore fb config */
562 ioctl(sys->fd, FBIOPUT_VSCREENINFO, &sys->old_info);
568 /* If the fb has limitations on mode change,
569 * then keep the resolution of the fb */
570 if ((sys->height != sys->var_info.yres) ||
571 (sys->width != sys->var_info.xres)) {
573 "using framebuffer native resolution instead of requested (%ix%i)",
574 sys->width, sys->height);
576 sys->height = sys->var_info.yres;
577 sys->width = sys->var_info.xres_virtual ? sys->var_info.xres_virtual :
579 sys->line_length = fix_info.line_length;
581 /* FIXME: if the image is full-size, it gets cropped on the left
582 * because of the xres / xres_virtual slight difference */
583 msg_Dbg(vd, "%ix%i (virtual %ix%i) (request %ix%i)",
584 sys->var_info.xres, sys->var_info.yres,
585 sys->var_info.xres_virtual,
586 sys->var_info.yres_virtual,
587 sys->width, sys->height);
590 sys->has_pan = (fix_info.ypanstep || fix_info.ywrapstep);
592 switch (sys->var_info.bits_per_pixel) {
594 sys->palette = malloc(8 * 256 * sizeof(uint16_t));
596 /* Restore fb config */
597 ioctl(sys->fd, FBIOPUT_VSCREENINFO, &sys->old_info);
602 sys->fb_cmap.start = 0;
603 sys->fb_cmap.len = 256;
604 sys->fb_cmap.red = sys->palette;
605 sys->fb_cmap.green = sys->palette + 256 * sizeof(uint16_t);
606 sys->fb_cmap.blue = sys->palette + 2 * 256 * sizeof(uint16_t);
607 sys->fb_cmap.transp = sys->palette + 3 * 256 * sizeof(uint16_t);
609 /* Save the colormap */
610 ioctl(sys->fd, FBIOGETCMAP, &sys->fb_cmap);
612 sys->bytes_per_pixel = 1;
617 sys->bytes_per_pixel = 2;
621 sys->bytes_per_pixel = 3;
625 sys->bytes_per_pixel = 4;
629 msg_Err(vd, "screen depth %d is not supported",
630 sys->var_info.bits_per_pixel);
632 /* Restore fb config */
633 ioctl(sys->fd, FBIOPUT_VSCREENINFO, &sys->old_info);
639 sys->video_size = sys->line_length * sys->var_info.yres_virtual;
641 /* Map a framebuffer at the beginning */
642 sys->video_ptr = mmap(NULL, sys->video_size,
643 PROT_READ | PROT_WRITE, MAP_SHARED, sys->fd, 0);
645 if (sys->video_ptr == MAP_FAILED) {
646 msg_Err(vd, "cannot map video memory (%s)", vlc_strerror_c(errno));
648 if (sys->var_info.bits_per_pixel == 8) {
653 /* Restore fb config */
654 ioctl(sys->fd, FBIOPUT_VSCREENINFO, &sys->old_info);
663 "framebuffer type=%d, visual=%d, ypanstep=%d, ywrap=%d, accel=%d",
664 fix_info.type, fix_info.visual,
665 fix_info.ypanstep, fix_info.ywrapstep, fix_info.accel);
669 /*****************************************************************************
670 * CloseDisplay: terminate FB video thread output method
671 *****************************************************************************/
672 static void CloseDisplay(vout_display_t *vd)
674 vout_display_sys_t *sys = vd->sys;
676 if (sys->video_ptr != MAP_FAILED) {
678 munmap(sys->video_ptr, sys->video_size);
682 /* Restore palette */
683 if (sys->var_info.bits_per_pixel == 8) {
684 ioctl(sys->fd, FBIOPUTCMAP, &sys->fb_cmap);
689 /* Restore fb config */
690 ioctl(sys->fd, FBIOPUT_VSCREENINFO, &sys->old_info);
698 /*****************************************************************************
699 * SwitchDisplay: VT change signal handler
700 *****************************************************************************
701 * This function activates or deactivates the output of the thread. It is
702 * called by the VT driver, on terminal change.
703 *****************************************************************************/
704 static void SwitchDisplay(int i_signal)
708 vlc_mutex_lock(&p_vout_bank->lock);
710 /* XXX: only test the first video output */
711 if (p_vout_bank->i_count)
713 vd = p_vout_bank->pp_vout[0];
717 case SIGUSR1: /* vt has been released */
719 ioctl(sys->tty, VT_RELDISP, 1);
721 case SIGUSR2: /* vt has been acquired */
723 ioctl(sys->tty, VT_RELDISP, VT_ACTIVATE);
724 /* handle blanking */
725 vlc_mutex_lock(&vd->change_lock);
726 vd->i_changes |= VOUT_SIZE_CHANGE;
727 vlc_mutex_unlock(&vd->change_lock);
732 vlc_mutex_unlock(&p_vout_bank->lock);
736 /*****************************************************************************
737 * TextMode and GfxMode : switch tty to text/graphic mode
738 *****************************************************************************
739 * These functions toggle the tty mode.
740 *****************************************************************************/
741 static void TextMode(int tty)
743 /* return to text mode */
744 if (-1 == ioctl(tty, KDSETMODE, KD_TEXT)) {
745 /*msg_Err(vd, "failed ioctl KDSETMODE KD_TEXT");*/
749 static void GfxMode(int tty)
751 /* switch to graphic mode */
752 if (-1 == ioctl(tty, KDSETMODE, KD_GRAPHICS)) {
753 /*msg_Err(vd, "failed ioctl KDSETMODE KD_GRAPHICS");*/