Use MAP_FAILED
[vlc.git] / modules / video_output / fb.c
1 /*****************************************************************************
2  * fb.c : framebuffer plugin for vlc
3  *****************************************************************************
4  * Copyright (C) 2000, 2001 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Samuel Hocevar <sam@zoy.org>
8  *          Jean-Paul Saman
9  *
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.
14  *
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.
19  *
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  *****************************************************************************/
24
25 /*****************************************************************************
26  * Preamble
27  *****************************************************************************/
28
29 #ifdef HAVE_CONFIG_H
30 # include "config.h"
31 #endif
32
33 #include <errno.h>                                                 /* ENOMEM */
34 #include <signal.h>                                      /* SIGUSR1, SIGUSR2 */
35 #include <fcntl.h>                                                 /* open() */
36 #include <unistd.h>                                               /* close() */
37
38 #include <termios.h>                                       /* struct termios */
39 #include <sys/ioctl.h>
40 #include <sys/mman.h>                                              /* mmap() */
41
42 #include <linux/fb.h>
43 #include <linux/vt.h>                                                /* VT_* */
44 #include <linux/kd.h>                                                 /* KD* */
45
46 #include <vlc_common.h>
47 #include <vlc_plugin.h>
48 #include <vlc_vout.h>
49 #include <vlc_interface.h>
50
51 /*****************************************************************************
52  * Local prototypes
53  *****************************************************************************/
54 static int  Create    ( vlc_object_t * );
55 static void Destroy   ( vlc_object_t * );
56
57 static int  Init      ( vout_thread_t * );
58 static void End       ( vout_thread_t * );
59 static int  Manage    ( vout_thread_t * );
60 static void Display   ( vout_thread_t *, picture_t * );
61 static int  Control   ( vout_thread_t *, int, va_list );
62
63 static int  NewPicture     ( vout_thread_t *, picture_t * );
64 static void FreePicture    ( vout_thread_t *, picture_t * );
65
66 static int  OpenDisplay    ( vout_thread_t * );
67 static void CloseDisplay   ( vout_thread_t * );
68 static void SwitchDisplay  ( int i_signal );
69 static void TextMode       ( int i_tty );
70 static void GfxMode        ( int i_tty );
71
72 #define MAX_DIRECTBUFFERS 1
73
74 /*****************************************************************************
75  * Module descriptor
76  *****************************************************************************/
77 #define FB_DEV_VAR "fbdev"
78
79 #define DEVICE_TEXT N_("Framebuffer device")
80 #define DEVICE_LONGTEXT N_( \
81     "Framebuffer device to use for rendering (usually /dev/fb0).")
82
83 #define TTY_TEXT N_("Run fb on current tty.")
84 #define TTY_LONGTEXT N_( \
85     "Run framebuffer on current TTY device (default enabled). " \
86     "(disable tty handling with caution)" )
87
88 #define CHROMA_TEXT N_("Chroma used.")
89 #define CHROMA_LONGTEXT N_( \
90     "Force use of a specific chroma for output. Default is I420." )
91
92 #define ASPECT_RATIO_TEXT N_("Video aspect ratio")
93 #define ASPECT_RATIO_LONGTEXT N_( \
94     "Aspect ratio of the video image (4:3, 16:9). Default is square pixels." )
95
96 #define FB_MODE_TEXT N_("Framebuffer resolution to use.")
97 #define FB_MODE_LONGTEXT N_( \
98     "Select the resolution for the framebuffer. Currently it supports " \
99     "the values 0=QCIF 1=CIF 2=NTSC 3=PAL, 4=auto (default 4=auto)" )
100
101 #define HW_ACCEL_TEXT N_("Framebuffer uses hw acceleration.")
102 #define HW_ACCEL_LONGTEXT N_( \
103     "If your framebuffer supports hardware acceleration or does double buffering " \
104     "in hardware then you must disable this option. It then does double buffering " \
105     "in software." )
106
107 vlc_module_begin ()
108     set_shortname( "Framebuffer" )
109     set_category( CAT_VIDEO )
110     set_subcategory( SUBCAT_VIDEO_VOUT )
111     add_file( FB_DEV_VAR, "/dev/fb0", NULL, DEVICE_TEXT, DEVICE_LONGTEXT,
112               false )
113     add_bool( "fb-tty", 1, NULL, TTY_TEXT, TTY_LONGTEXT, true )
114     add_string( "fb-chroma", NULL, NULL, CHROMA_TEXT, CHROMA_LONGTEXT,
115                 true )
116     add_string( "fb-aspect-ratio", NULL, NULL, ASPECT_RATIO_TEXT,
117                 ASPECT_RATIO_LONGTEXT, true )
118     add_integer( "fb-mode", 4, NULL, FB_MODE_TEXT, FB_MODE_LONGTEXT,
119                  true )
120     add_bool( "fb-hw-accel", true, NULL, HW_ACCEL_TEXT, HW_ACCEL_LONGTEXT,
121               true )
122     set_description( N_("GNU/Linux framebuffer video output") )
123     set_capability( "video output", 30 )
124     set_callbacks( Create, Destroy )
125 vlc_module_end ()
126
127 /*****************************************************************************
128  * vout_sys_t: video output framebuffer method descriptor
129  *****************************************************************************
130  * This structure is part of the video output thread descriptor.
131  * It describes the FB specific properties of an output thread.
132  *****************************************************************************/
133 struct vout_sys_t
134 {
135     /* System information */
136     int                 i_tty;                          /* tty device handle */
137     bool                b_tty;
138     struct termios      old_termios;
139
140     /* Original configuration information */
141     struct sigaction            sig_usr1;           /* USR1 previous handler */
142     struct sigaction            sig_usr2;           /* USR2 previous handler */
143     struct vt_mode              vt_mode;                 /* previous VT mode */
144
145     /* Framebuffer information */
146     int                         i_fd;                       /* device handle */
147     struct fb_var_screeninfo    old_info;       /* original mode information */
148     struct fb_var_screeninfo    var_info;        /* current mode information */
149     bool                        b_pan;     /* does device supports panning ? */
150     struct fb_cmap              fb_cmap;                /* original colormap */
151     uint16_t                    *p_palette;              /* original palette */
152     bool                        b_hw_accel;          /* has hardware support */
153
154     /* Video information */
155     uint32_t i_width;
156     uint32_t i_height;
157     int      i_aspect;
158     int      i_bytes_per_pixel;
159     bool     b_auto;       /* Automatically adjust video size to fb size */
160     vlc_fourcc_t i_chroma;
161
162     /* Video memory */
163     uint8_t    *p_video;                                      /* base adress */
164     size_t      i_page_size;                                    /* page size */
165 };
166
167 struct picture_sys_t
168 {
169     uint8_t *    p_data;                                      /* base adress */
170 };
171
172 /*****************************************************************************
173  * Create: allocates FB video thread output method
174  *****************************************************************************
175  * This function allocates and initializes a FB vout method.
176  *****************************************************************************/
177 static int Create( vlc_object_t *p_this )
178 {
179     vout_thread_t *p_vout = (vout_thread_t *)p_this;
180     vout_sys_t    *p_sys;
181     char          *psz_chroma;
182     char          *psz_aspect;
183     int           i_mode;
184     struct sigaction    sig_tty;                 /* sigaction for tty change */
185     struct vt_mode      vt_mode;                          /* vt current mode */
186     struct termios      new_termios;
187
188     /* Allocate instance and initialize some members */
189     p_vout->p_sys = p_sys = malloc( sizeof( vout_sys_t ) );
190     if( p_vout->p_sys == NULL )
191         return VLC_ENOMEM;
192     memset( p_sys, 0, sizeof(vout_sys_t) );
193
194     p_vout->pf_init = Init;
195     p_vout->pf_end = End;
196     p_vout->pf_manage = Manage;
197     p_vout->pf_render = NULL;
198     p_vout->pf_display = Display;
199     p_vout->pf_control = Control;
200
201     /* Does the framebuffer uses hw acceleration? */
202     p_sys->b_hw_accel = var_CreateGetBool( p_vout, "fb-hw-accel" );
203
204     /* Set tty and fb devices */
205     p_sys->i_tty = 0; /* 0 == /dev/tty0 == current console */
206     p_sys->b_tty = var_CreateGetBool( p_vout, "fb-tty" );
207 #ifndef WIN32
208 #if defined(HAVE_ISATTY)
209     /* Check that stdin is a TTY */
210     if( p_sys->b_tty && !isatty( 0 ) )
211     {
212         msg_Warn( p_vout, "fd 0 is not a TTY" );
213         return VLC_EGENERIC;
214     }
215     else
216     {
217         msg_Warn( p_vout, "disabling tty handling, use with caution because "
218                           "there is no way to return to the tty." );
219     }
220 #endif
221 #endif
222
223     psz_chroma = var_CreateGetNonEmptyString( p_vout, "fb-chroma" );
224     if( psz_chroma )
225     {
226         if( strlen( psz_chroma ) == 4 )
227         {
228             p_sys->i_chroma = VLC_FOURCC( psz_chroma[0],
229                                    psz_chroma[1],
230                                    psz_chroma[2],
231                                    psz_chroma[3] );
232             msg_Dbg( p_vout, "forcing chroma '%s'", psz_chroma );
233         }
234         else
235         {
236             msg_Warn( p_vout, "invalid chroma (%s), using defaults.",
237                       psz_chroma );
238         }
239         free( psz_chroma );
240         psz_chroma = NULL;
241     }
242
243     p_sys->i_aspect = -1;
244     psz_aspect = var_CreateGetNonEmptyString( p_vout, "fb-aspect-ratio" );
245     if( psz_aspect )
246     {
247         char *psz_parser = strchr( psz_aspect, ':' );
248
249         if( psz_parser )
250         {
251             *psz_parser++ = '\0';
252             p_sys->i_aspect = ( atoi( psz_aspect )
253                               * VOUT_ASPECT_FACTOR ) / atoi( psz_parser );
254         }
255         msg_Dbg( p_vout, "using aspect ratio %d:%d",
256                   atoi( psz_aspect ), atoi( psz_parser ) );
257
258         free( psz_aspect );
259         psz_aspect = NULL;
260     }
261
262     p_sys->b_auto = false;
263     i_mode = var_CreateGetInteger( p_vout, "fb-mode" );
264     switch( i_mode )
265     {
266         case 0: /* QCIF */
267             p_sys->i_width  = 176;
268             p_sys->i_height = 144;
269             break;
270         case 1: /* CIF */
271             p_sys->i_width  = 352;
272             p_sys->i_height = 288;
273             break;
274         case 2: /* NTSC */
275             p_sys->i_width  = 640;
276             p_sys->i_height = 480;
277             break;
278         case 3: /* PAL */
279             p_sys->i_width  = 704;
280             p_sys->i_height = 576;
281             break;
282         case 4:
283         default:
284             p_sys->b_auto = true;
285             break;
286      }
287
288     /* tty handling */
289     if( p_sys->b_tty )
290     {
291         GfxMode( p_sys->i_tty );
292
293         /* Set keyboard settings */
294         if( tcgetattr(0, &p_vout->p_sys->old_termios) == -1 )
295         {
296             msg_Err( p_vout, "tcgetattr failed" );
297         }
298
299         if( tcgetattr(0, &new_termios) == -1 )
300         {
301             msg_Err( p_vout, "tcgetattr failed" );
302         }
303
304         /* new_termios.c_lflag &= ~ (ICANON | ISIG);
305         new_termios.c_lflag |= (ECHO | ECHOCTL); */
306         new_termios.c_lflag &= ~ (ICANON);
307         new_termios.c_lflag &= ~(ECHO | ECHOCTL);
308         new_termios.c_iflag = 0;
309         new_termios.c_cc[VMIN] = 1;
310         new_termios.c_cc[VTIME] = 0;
311
312         if( tcsetattr(0, TCSAFLUSH, &new_termios) == -1 )
313         {
314             msg_Err( p_vout, "tcsetattr failed" );
315         }
316
317         ioctl( p_sys->i_tty, VT_RELDISP, VT_ACKACQ );
318
319         /* Set-up tty signal handler to be aware of tty changes */
320         memset( &sig_tty, 0, sizeof( sig_tty ) );
321         sig_tty.sa_handler = SwitchDisplay;
322         sigemptyset( &sig_tty.sa_mask );
323         if( sigaction( SIGUSR1, &sig_tty, &p_vout->p_sys->sig_usr1 ) ||
324             sigaction( SIGUSR2, &sig_tty, &p_vout->p_sys->sig_usr2 ) )
325         {
326             msg_Err( p_vout, "cannot set signal handler (%m)" );
327             tcsetattr(0, 0, &p_vout->p_sys->old_termios);
328             TextMode( p_sys->i_tty );
329             free( p_vout->p_sys );
330             return VLC_EGENERIC;
331         }
332
333         /* Set-up tty according to new signal handler */
334         if( -1 == ioctl( p_sys->i_tty, VT_GETMODE, &p_vout->p_sys->vt_mode ) )
335         {
336             msg_Err( p_vout, "cannot get terminal mode (%m)" );
337             sigaction( SIGUSR1, &p_vout->p_sys->sig_usr1, NULL );
338             sigaction( SIGUSR2, &p_vout->p_sys->sig_usr2, NULL );
339             tcsetattr(0, 0, &p_vout->p_sys->old_termios);
340             TextMode( p_sys->i_tty );
341             free( p_vout->p_sys );
342             return VLC_EGENERIC;
343         }
344         memcpy( &vt_mode, &p_vout->p_sys->vt_mode, sizeof( vt_mode ) );
345         vt_mode.mode   = VT_PROCESS;
346         vt_mode.waitv  = 0;
347         vt_mode.relsig = SIGUSR1;
348         vt_mode.acqsig = SIGUSR2;
349
350         if( -1 == ioctl( p_sys->i_tty, VT_SETMODE, &vt_mode ) )
351         {
352             msg_Err( p_vout, "cannot set terminal mode (%m)" );
353             sigaction( SIGUSR1, &p_vout->p_sys->sig_usr1, NULL );
354             sigaction( SIGUSR2, &p_vout->p_sys->sig_usr2, NULL );
355             tcsetattr(0, 0, &p_vout->p_sys->old_termios);
356             TextMode( p_sys->i_tty );
357             free( p_vout->p_sys );
358             return VLC_EGENERIC;
359         }
360     }
361
362     if( OpenDisplay( p_vout ) )
363     {
364         Destroy( VLC_OBJECT(p_vout) );
365         return VLC_EGENERIC;
366     }
367
368     return VLC_SUCCESS;
369 }
370
371
372 /*****************************************************************************
373  * Destroy: destroy FB video thread output method
374  *****************************************************************************
375  * Terminate an output method created by Create
376  *****************************************************************************/
377 static void Destroy( vlc_object_t *p_this )
378 {
379     vout_thread_t *p_vout = (vout_thread_t *)p_this;
380
381     CloseDisplay( p_vout );
382
383     if( p_vout->p_sys->b_tty )
384     {
385         /* Reset the terminal */
386         ioctl( p_vout->p_sys->i_tty, VT_SETMODE, &p_vout->p_sys->vt_mode );
387
388         /* Remove signal handlers */
389         sigaction( SIGUSR1, &p_vout->p_sys->sig_usr1, NULL );
390         sigaction( SIGUSR2, &p_vout->p_sys->sig_usr2, NULL );
391
392         /* Reset the keyboard state */
393         tcsetattr( 0, 0, &p_vout->p_sys->old_termios );
394
395         /* Return to text mode */
396         TextMode( p_vout->p_sys->i_tty );
397     }
398
399     /* Destroy structure */
400     free( p_vout->p_sys );
401 }
402
403 /*****************************************************************************
404  * NewPicture: allocate a picture
405  *****************************************************************************
406  * Returns 0 on success, -1 otherwise
407  *****************************************************************************/
408 static int NewPicture( vout_thread_t *p_vout, picture_t *p_pic )
409 {
410     /* We know the chroma, allocate a buffer which will be used
411      * directly by the decoder */
412     p_pic->p_sys = malloc( sizeof( picture_sys_t ) );
413     if( p_pic->p_sys == NULL )
414     {
415         return VLC_ENOMEM;
416     }
417
418     /* Fill in picture_t fields */
419     vout_InitPicture( VLC_OBJECT(p_vout), p_pic, p_vout->output.i_chroma,
420                       p_vout->output.i_width, p_vout->output.i_height,
421                       p_vout->output.i_aspect );
422
423     p_pic->p_sys->p_data = malloc( p_vout->p_sys->i_page_size );
424     if( !p_pic->p_sys->p_data )
425     {
426         free( p_pic->p_sys );
427         p_pic->p_sys = NULL;
428         return VLC_ENOMEM;
429     }
430
431     p_pic->p->p_pixels = (uint8_t*) p_pic->p_sys->p_data;
432
433     p_pic->p->i_pixel_pitch = p_vout->p_sys->i_bytes_per_pixel;
434     p_pic->p->i_lines = p_vout->p_sys->var_info.yres;
435     p_pic->p->i_visible_lines = p_vout->p_sys->var_info.yres;
436
437     if( p_vout->p_sys->var_info.xres_virtual )
438     {
439         p_pic->p->i_pitch = p_vout->p_sys->var_info.xres_virtual
440                              * p_vout->p_sys->i_bytes_per_pixel;
441     }
442     else
443     {
444         p_pic->p->i_pitch = p_vout->p_sys->var_info.xres
445                              * p_vout->p_sys->i_bytes_per_pixel;
446     }
447
448     p_pic->p->i_visible_pitch = p_vout->p_sys->var_info.xres
449                                  * p_vout->p_sys->i_bytes_per_pixel;
450     p_pic->i_planes = 1;
451
452     return VLC_SUCCESS;
453 }
454
455 /*****************************************************************************
456  * FreePicture: destroy a picture allocated with NewPicture
457  *****************************************************************************
458  * Destroy Image AND associated data.
459  *****************************************************************************/
460 static void FreePicture( vout_thread_t *p_vout, picture_t *p_pic )
461 {
462     VLC_UNUSED(p_vout);
463     free( p_pic->p_sys->p_data );
464     free( p_pic->p_sys );
465     p_pic->p_sys = NULL;
466 }
467
468 /*****************************************************************************
469  * Init: initialize framebuffer video thread output method
470  *****************************************************************************/
471 static int Init( vout_thread_t *p_vout )
472 {
473     vout_sys_t *p_sys = p_vout->p_sys;
474     int i_index;
475     picture_t *p_pic = NULL;
476
477     I_OUTPUTPICTURES = 0;
478
479     p_vout->output.i_width  = p_vout->render.i_width;
480     p_vout->output.i_height = p_vout->render.i_height;
481     p_vout->output.i_aspect = p_vout->render.i_aspect;
482
483     p_vout->fmt_out = p_vout->fmt_in;
484     if( p_sys->i_chroma == 0 )
485     {
486         /* Initialize the output structure: RGB with square pixels, whatever
487          * the input format is, since it's the only format we know */
488         switch( p_sys->var_info.bits_per_pixel )
489         {
490         case 8: /* FIXME: set the palette */
491             p_vout->output.i_chroma = VLC_FOURCC('R','G','B','2'); break;
492         case 15:
493             p_vout->output.i_chroma = VLC_FOURCC('R','V','1','5'); break;
494         case 16:
495             p_vout->output.i_chroma = VLC_FOURCC('R','V','1','6'); break;
496         case 24:
497             p_vout->output.i_chroma = VLC_FOURCC('R','V','2','4'); break;
498         case 32:
499             p_vout->output.i_chroma = VLC_FOURCC('R','V','3','2'); break;
500         default:
501             msg_Err( p_vout, "unknown screen depth %i",
502                      p_vout->p_sys->var_info.bits_per_pixel );
503             return VLC_EGENERIC;
504         }
505
506         if( p_sys->var_info.bits_per_pixel != 8 )
507         {
508             p_vout->output.i_rmask = ( (1 << p_sys->var_info.red.length) - 1 )
509                                  << p_sys->var_info.red.offset;
510             p_vout->output.i_gmask = ( (1 << p_sys->var_info.green.length) - 1 )
511                                  << p_sys->var_info.green.offset;
512             p_vout->output.i_bmask = ( (1 << p_sys->var_info.blue.length) - 1 )
513                                  << p_sys->var_info.blue.offset;
514         }
515     }
516     else
517     {
518         p_vout->output.i_chroma = p_sys->i_chroma;
519     }
520     p_vout->fmt_out.i_chroma = p_vout->output.i_chroma;
521
522     p_vout->output.i_width =
523     p_vout->fmt_out.i_width =
524     p_vout->fmt_out.i_visible_width = p_sys->i_width;
525     p_vout->output.i_height =
526     p_vout->fmt_out.i_height =
527     p_vout->fmt_out.i_visible_height = p_sys->i_height;
528
529     /* Assume we have square pixels */
530     if( p_sys->i_aspect < 0 )
531     {
532         p_vout->output.i_aspect = ( p_sys->i_width
533                                   * VOUT_ASPECT_FACTOR ) / p_sys->i_height;
534     }
535     else p_vout->output.i_aspect = p_sys->i_aspect;
536
537     p_vout->fmt_out.i_sar_num = p_vout->fmt_out.i_sar_den = 1;
538     p_vout->fmt_out.i_aspect  = p_vout->render.i_aspect = p_vout->output.i_aspect;
539     p_vout->fmt_out.i_x_offset= p_vout->fmt_out.i_y_offset = 0;
540
541     /* Clear the screen */
542     memset( p_sys->p_video, 0, p_sys->i_page_size );
543
544     if( !p_sys->b_hw_accel )
545     {
546         /* Try to initialize up to MAX_DIRECTBUFFERS direct buffers */
547         while( I_OUTPUTPICTURES < MAX_DIRECTBUFFERS )
548         {
549             p_pic = NULL;
550
551             /* Find an empty picture slot */
552             for( i_index = 0 ; i_index < VOUT_MAX_PICTURES ; i_index++ )
553             {
554                 if( p_vout->p_picture[ i_index ].i_status == FREE_PICTURE )
555                 {
556                     p_pic = p_vout->p_picture + i_index;
557                     break;
558                 }
559             }
560
561             /* Allocate the picture */
562             if( p_pic == NULL || NewPicture( p_vout, p_pic ) )
563             {
564                 break;
565             }
566
567             p_pic->i_status = DESTROYED_PICTURE;
568             p_pic->i_type   = DIRECT_PICTURE;
569
570             PP_OUTPUTPICTURE[ I_OUTPUTPICTURES ] = p_pic;
571
572             I_OUTPUTPICTURES++;
573         }
574     }
575     else
576     {
577         /* Try to initialize 1 direct buffer */
578         p_pic = NULL;
579
580         /* Find an empty picture slot */
581         for( i_index = 0 ; i_index < VOUT_MAX_PICTURES ; i_index++ )
582         {
583             if( p_vout->p_picture[ i_index ].i_status == FREE_PICTURE )
584             {
585                 p_pic = p_vout->p_picture + i_index;
586                 break;
587             }
588         }
589
590         /* Allocate the picture */
591         if( p_pic == NULL )
592         {
593             return VLC_EGENERIC;
594         }
595
596         /* We know the chroma, allocate a buffer which will be used
597         * directly by the decoder */
598         p_pic->p->p_pixels = p_vout->p_sys->p_video;
599         p_pic->p->i_pixel_pitch = p_vout->p_sys->i_bytes_per_pixel;
600         p_pic->p->i_lines = p_vout->p_sys->var_info.yres;
601         p_pic->p->i_visible_lines = p_vout->p_sys->var_info.yres;
602
603         if( p_vout->p_sys->var_info.xres_virtual )
604         {
605             p_pic->p->i_pitch = p_vout->p_sys->var_info.xres_virtual
606                                 * p_vout->p_sys->i_bytes_per_pixel;
607         }
608         else
609         {
610             p_pic->p->i_pitch = p_vout->p_sys->var_info.xres
611                                 * p_vout->p_sys->i_bytes_per_pixel;
612         }
613
614         p_pic->p->i_visible_pitch = p_vout->p_sys->var_info.xres
615                                     * p_vout->p_sys->i_bytes_per_pixel;
616         p_pic->i_planes = 1;
617         p_pic->i_status = DESTROYED_PICTURE;
618         p_pic->i_type   = DIRECT_PICTURE;
619
620         PP_OUTPUTPICTURE[ I_OUTPUTPICTURES ] = p_pic;
621
622         I_OUTPUTPICTURES++;
623     }
624
625     return VLC_SUCCESS;
626 }
627
628 /*****************************************************************************
629  * End: terminate framebuffer video thread output method
630  *****************************************************************************/
631 static void End( vout_thread_t *p_vout )
632 {
633     if( !p_vout->p_sys->b_hw_accel )
634     {
635         int i_index;
636
637         /* Free the direct buffers we allocated */
638         for( i_index = I_OUTPUTPICTURES ; i_index ; )
639         {
640             i_index--;
641             FreePicture( p_vout, PP_OUTPUTPICTURE[ i_index ] );
642         }
643
644     }
645     /* Clear the screen */
646     memset( p_vout->p_sys->p_video, 0, p_vout->p_sys->i_page_size );
647 }
648
649 /*****************************************************************************
650  * Control: control facility for the vout
651  *****************************************************************************/
652 static int Control( vout_thread_t *p_vout, int i_query, va_list args )
653 {
654     switch( i_query )
655     {
656        default:
657             return vout_vaControlDefault( p_vout, i_query, args );
658     }
659 }
660
661 /*****************************************************************************
662  * Manage: handle FB events
663  *****************************************************************************
664  * This function should be called regularly by video output thread. It manages
665  * console events. It returns a non null value on error.
666  *****************************************************************************/
667 static int Manage( vout_thread_t *p_vout )
668 {
669 #if 0
670     uint8_t buf;
671
672     if ( read(0, &buf, 1) == 1)
673     {
674         switch( buf )
675         {
676         case 'q':
677             libvlc_Quit( p_vout->p_libvlc );
678             break;
679
680         default:
681             break;
682         }
683     }
684 #endif
685
686     /*
687      * Size change
688      */
689     if( p_vout->i_changes & VOUT_SIZE_CHANGE )
690     {
691         msg_Dbg( p_vout, "reinitializing framebuffer screen" );
692         p_vout->i_changes &= ~VOUT_SIZE_CHANGE;
693
694         /* Destroy XImages to change their size */
695         End( p_vout );
696
697         /* Recreate XImages. If SysInit failed, the thread can't go on. */
698         if( Init( p_vout ) )
699         {
700             msg_Err( p_vout, "cannot reinit framebuffer screen" );
701             return VLC_EGENERIC;
702         }
703
704         /* Clear screen */
705         memset( p_vout->p_sys->p_video, 0, p_vout->p_sys->i_page_size );
706
707 #if 0
708         /* Tell the video output thread that it will need to rebuild YUV
709          * tables. This is needed since conversion buffer size may have changed */
710         p_vout->i_changes |= VOUT_YUV_CHANGE;
711 #endif
712     }
713
714     return VLC_SUCCESS;
715 }
716
717 /*****************************************************************************
718  * Display: displays previously rendered output
719  *****************************************************************************
720  * This function send the currently rendered image to FB image, waits until
721  * it is displayed and switch the two rendering buffers, preparing next frame.
722  *****************************************************************************/
723 static void Display( vout_thread_t *p_vout, picture_t *p_pic )
724 {
725 static int panned=0;
726     /* swap the two Y offsets if the drivers supports panning */
727     if( p_vout->p_sys->b_pan )
728     {
729         p_vout->p_sys->var_info.yoffset = 0;
730         /*p_vout->p_sys->var_info.yoffset = p_vout->p_sys->var_info.yres; */
731
732         /* the X offset should be 0, but who knows ...
733          * some other app might have played with the framebuffer */
734         p_vout->p_sys->var_info.xoffset = 0;
735
736         if( panned < 0 )
737         {
738             ioctl( p_vout->p_sys->i_fd,
739                    FBIOPAN_DISPLAY, &p_vout->p_sys->var_info );
740             panned++;
741         }
742     }
743
744     if( !p_vout->p_sys->b_hw_accel )
745     {
746         vlc_memcpy( p_vout->p_sys->p_video, p_pic->p->p_pixels,
747                     p_vout->p_sys->i_page_size );
748     }
749 }
750
751 #if 0
752 static void SetPalette( vout_thread_t *p_vout, uint16_t *red, uint16_t *green,
753                                                uint16_t *blue, uint16_t *transp )
754 {
755     struct fb_cmap cmap = { 0, 256, red, green, blue, transp };
756
757     ioctl( p_vout->p_sys->i_fd, FBIOPUTCMAP, &cmap );
758 }
759 #endif
760
761 /* following functions are local */
762
763 /*****************************************************************************
764  * OpenDisplay: initialize framebuffer
765  *****************************************************************************/
766 static int OpenDisplay( vout_thread_t *p_vout )
767 {
768     vout_sys_t *p_sys = (vout_sys_t *) p_vout->p_sys;
769     char *psz_device;                             /* framebuffer device path */
770     struct fb_fix_screeninfo    fix_info;     /* framebuffer fix information */
771
772     /* Open framebuffer device */
773     if( !(psz_device = config_GetPsz( p_vout, FB_DEV_VAR )) )
774     {
775         msg_Err( p_vout, "don't know which fb device to open" );
776         return VLC_EGENERIC;
777     }
778
779     p_sys->i_fd = open( psz_device, O_RDWR);
780     if( p_sys->i_fd == -1 )
781     {
782         msg_Err( p_vout, "cannot open %s (%m)", psz_device );
783         free( psz_device );
784         return VLC_EGENERIC;
785     }
786     free( psz_device );
787     psz_device = NULL;
788
789     /* Get framebuffer device information */
790     if( ioctl( p_sys->i_fd, FBIOGET_VSCREENINFO, &p_sys->var_info ) )
791     {
792         msg_Err( p_vout, "cannot get fb info (%m)" );
793         close( p_sys->i_fd );
794         return VLC_EGENERIC;
795     }
796
797     memcpy( &p_sys->old_info, &p_sys->var_info,
798             sizeof( struct fb_var_screeninfo ) );
799
800     /* Get some info on the framebuffer itself */
801     if( !p_sys->b_auto )
802     {
803         p_sys->var_info.xres = p_sys->var_info.xres_virtual = p_sys->i_width;
804         p_sys->var_info.yres = p_sys->var_info.yres_virtual = p_sys->i_height;
805         p_vout->fmt_out.i_width = p_sys->i_width;
806         p_vout->fmt_out.i_height = p_sys->i_height;
807     }
808
809     /* Set some attributes */
810     p_sys->var_info.activate = p_sys->b_tty
811                                ? FB_ACTIVATE_NXTOPEN
812                                : FB_ACTIVATE_NOW;
813     p_sys->var_info.xoffset =  0;
814     p_sys->var_info.yoffset =  0;
815
816     if( ioctl( p_sys->i_fd, FBIOPUT_VSCREENINFO, &p_sys->var_info ) )
817     {
818         msg_Err( p_vout, "cannot set fb info (%m)" );
819         close( p_sys->i_fd );
820         return VLC_EGENERIC;
821     }
822
823     /* Get some information again, in the definitive configuration */
824     if( ioctl( p_sys->i_fd, FBIOGET_FSCREENINFO, &fix_info )
825          || ioctl( p_sys->i_fd, FBIOGET_VSCREENINFO, &p_sys->var_info ) )
826     {
827         msg_Err( p_vout, "cannot get additional fb info (%m)" );
828
829         /* Restore fb config */
830         ioctl( p_sys->i_fd, FBIOPUT_VSCREENINFO, &p_sys->old_info );
831
832         close( p_sys->i_fd );
833         return VLC_EGENERIC;
834     }
835
836     /* If the fb has limitations on mode change,
837      * then keep the resolution of the fb */
838     if( (p_sys->i_height != p_sys->var_info.yres) ||
839         (p_sys->i_width != p_sys->var_info.xres) )
840     {
841         p_sys->b_auto = true;
842         msg_Warn( p_vout,
843                   "using framebuffer native resolution instead of requested (%ix%i)",
844                   p_sys->i_width, p_sys->i_height );
845     }
846     p_sys->i_height = p_sys->var_info.yres;
847     p_sys->i_width  = p_sys->var_info.xres_virtual
848                                ? p_sys->var_info.xres_virtual
849                                : p_sys->var_info.xres;
850
851     /* FIXME: if the image is full-size, it gets cropped on the left
852      * because of the xres / xres_virtual slight difference */
853     msg_Dbg( p_vout, "%ix%i (virtual %ix%i) (request %ix%i)",
854              p_sys->var_info.xres, p_sys->var_info.yres,
855              p_sys->var_info.xres_virtual,
856              p_sys->var_info.yres_virtual,
857              p_sys->i_width, p_sys->i_height );
858
859     p_sys->p_palette = NULL;
860     p_sys->b_pan = ( fix_info.ypanstep || fix_info.ywrapstep );
861
862     switch( p_sys->var_info.bits_per_pixel )
863     {
864     case 8:
865         p_sys->p_palette = malloc( 8 * 256 * sizeof( uint16_t ) );
866         if( !p_sys->p_palette )
867         {
868             /* Restore fb config */
869             ioctl( p_sys->i_fd, FBIOPUT_VSCREENINFO, &p_sys->old_info );
870
871             close( p_sys->i_fd );
872             return VLC_ENOMEM;
873         }
874         p_sys->fb_cmap.start = 0;
875         p_sys->fb_cmap.len = 256;
876         p_sys->fb_cmap.red = p_sys->p_palette;
877         p_sys->fb_cmap.green = p_sys->p_palette + 256 * sizeof( uint16_t );
878         p_sys->fb_cmap.blue = p_sys->p_palette + 2 * 256 * sizeof( uint16_t );
879         p_sys->fb_cmap.transp = p_sys->p_palette + 3 * 256 * sizeof( uint16_t );
880
881         /* Save the colormap */
882         ioctl( p_sys->i_fd, FBIOGETCMAP, &p_sys->fb_cmap );
883
884         p_sys->i_bytes_per_pixel = 1;
885         break;
886
887     case 15:
888     case 16:
889         p_sys->i_bytes_per_pixel = 2;
890         break;
891
892     case 24:
893         p_sys->i_bytes_per_pixel = 3;
894         break;
895
896     case 32:
897         p_sys->i_bytes_per_pixel = 4;
898         break;
899
900     default:
901         msg_Err( p_vout, "screen depth %d is not supported",
902                          p_sys->var_info.bits_per_pixel );
903
904         /* Restore fb config */
905         ioctl( p_sys->i_fd, FBIOPUT_VSCREENINFO, &p_sys->old_info );
906
907         close( p_sys->i_fd );
908         return VLC_EGENERIC;
909     }
910
911     p_sys->i_page_size = p_sys->i_width * p_sys->i_height *
912                          p_sys->i_bytes_per_pixel;
913
914     /* Map a framebuffer at the beginning */
915     p_sys->p_video = mmap( NULL, p_sys->i_page_size,
916                               PROT_READ | PROT_WRITE, MAP_SHARED,
917                               p_sys->i_fd, 0 );
918
919     if( p_sys->p_video == MAP_FAILED )
920     {
921         msg_Err( p_vout, "cannot map video memory (%m)" );
922
923         if( p_sys->var_info.bits_per_pixel == 8 )
924         {
925             free( p_sys->p_palette );
926             p_sys->p_palette = NULL;
927         }
928
929         /* Restore fb config */
930         ioctl( p_sys->i_fd, FBIOPUT_VSCREENINFO, &p_vout->p_sys->old_info );
931
932         close( p_sys->i_fd );
933         return VLC_EGENERIC;
934     }
935
936     msg_Dbg( p_vout, "framebuffer type=%d, visual=%d, ypanstep=%d, "
937              "ywrap=%d, accel=%d", fix_info.type, fix_info.visual,
938              fix_info.ypanstep, fix_info.ywrapstep, fix_info.accel );
939     return VLC_SUCCESS;
940 }
941
942 /*****************************************************************************
943  * CloseDisplay: terminate FB video thread output method
944  *****************************************************************************/
945 static void CloseDisplay( vout_thread_t *p_vout )
946 {
947     /* Clear display */
948     memset( p_vout->p_sys->p_video, 0, p_vout->p_sys->i_page_size );
949     munmap( p_vout->p_sys->p_video, p_vout->p_sys->i_page_size );
950
951     if( p_vout->p_sys->i_fd >= 0 )
952     {
953         /* Restore palette */
954         if( p_vout->p_sys->var_info.bits_per_pixel == 8 )
955         {
956             ioctl( p_vout->p_sys->i_fd,
957                    FBIOPUTCMAP, &p_vout->p_sys->fb_cmap );
958             free( p_vout->p_sys->p_palette );
959             p_vout->p_sys->p_palette = NULL;
960         }
961
962         /* Restore fb config */
963         ioctl( p_vout->p_sys->i_fd,
964                FBIOPUT_VSCREENINFO, &p_vout->p_sys->old_info );
965
966         /* Close fb */
967         close( p_vout->p_sys->i_fd );
968     }
969 }
970
971 /*****************************************************************************
972  * SwitchDisplay: VT change signal handler
973  *****************************************************************************
974  * This function activates or deactivates the output of the thread. It is
975  * called by the VT driver, on terminal change.
976  *****************************************************************************/
977 static void SwitchDisplay( int i_signal )
978 {
979     VLC_UNUSED( i_signal );
980 #if 0
981     vout_thread_t *p_vout;
982
983     vlc_mutex_lock( &p_vout_bank->lock );
984
985     /* XXX: only test the first video output */
986     if( p_vout_bank->i_count )
987     {
988         p_vout = p_vout_bank->pp_vout[0];
989
990         switch( i_signal )
991         {
992         case SIGUSR1:                                /* vt has been released */
993             p_vout->b_active = 0;
994             ioctl( p_sys->i_tty, VT_RELDISP, 1 );
995             break;
996         case SIGUSR2:                                /* vt has been acquired */
997             p_vout->b_active = 1;
998             ioctl( p_sys->i_tty, VT_RELDISP, VT_ACTIVATE );
999             /* handle blanking */
1000             vlc_mutex_lock( &p_vout->change_lock );
1001             p_vout->i_changes |= VOUT_SIZE_CHANGE;
1002             vlc_mutex_unlock( &p_vout->change_lock );
1003             break;
1004         }
1005     }
1006
1007     vlc_mutex_unlock( &p_vout_bank->lock );
1008 #endif
1009 }
1010
1011 /*****************************************************************************
1012  * TextMode and GfxMode : switch tty to text/graphic mode
1013  *****************************************************************************
1014  * These functions toggle the tty mode.
1015  *****************************************************************************/
1016 static void TextMode( int i_tty )
1017 {
1018     /* return to text mode */
1019     if( -1 == ioctl(i_tty, KDSETMODE, KD_TEXT) )
1020     {
1021         /*msg_Err( p_vout, "failed ioctl KDSETMODE KD_TEXT" );*/
1022     }
1023 }
1024
1025 static void GfxMode( int i_tty )
1026 {
1027     /* switch to graphic mode */
1028     if( -1 == ioctl(i_tty, KDSETMODE, KD_GRAPHICS) )
1029     {
1030         /*msg_Err( p_vout, "failed ioctl KDSETMODE KD_GRAPHICS" );*/
1031     }
1032 }