1 /*****************************************************************************
2 * vout_ggi.c: GGI video output display method
3 *****************************************************************************
4 * Copyright (C) 1998, 1999, 2000, 2001 VideoLAN
5 * $Id: vout_ggi.c,v 1.10 2001/05/30 17:03:12 sam Exp $
7 * Authors: Vincent Seguin <seguin@via.ecp.fr>
8 * 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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
23 *****************************************************************************/
25 #define MODULE_NAME ggi
26 #include "modules_inner.h"
28 /*****************************************************************************
30 *****************************************************************************/
33 #include <errno.h> /* ENOMEM */
34 #include <stdlib.h> /* free() */
35 #include <string.h> /* strerror() */
47 #include "video_output.h"
50 #include "interface.h"
54 #include "modules_export.h"
56 /*****************************************************************************
57 * vout_sys_t: video output GGI method descriptor
58 *****************************************************************************
59 * This structure is part of the video output thread descriptor.
60 * It describes the GGI specific properties of an output thread.
61 *****************************************************************************/
62 typedef struct vout_sys_s
64 /* GGI system informations */
65 ggi_visual_t p_display; /* display device */
67 /* Buffer information */
68 ggi_directbuffer * p_buffer[2]; /* buffers */
69 boolean_t b_must_acquire; /* must be acquired before writing */
72 /*****************************************************************************
74 *****************************************************************************/
75 static int vout_Probe ( probedata_t *p_data );
76 static int vout_Create ( struct vout_thread_s * );
77 static int vout_Init ( struct vout_thread_s * );
78 static void vout_End ( struct vout_thread_s * );
79 static void vout_Destroy ( struct vout_thread_s * );
80 static int vout_Manage ( struct vout_thread_s * );
81 static void vout_Display ( struct vout_thread_s * );
83 static int GGIOpenDisplay ( vout_thread_t *p_vout );
84 static void GGICloseDisplay( vout_thread_t *p_vout );
86 /*****************************************************************************
87 * Functions exported as capabilities. They are declared as static so that
88 * we don't pollute the namespace too much.
89 *****************************************************************************/
90 void _M( vout_getfunctions )( function_list_t * p_function_list )
92 p_function_list->pf_probe = vout_Probe;
93 p_function_list->functions.vout.pf_create = vout_Create;
94 p_function_list->functions.vout.pf_init = vout_Init;
95 p_function_list->functions.vout.pf_end = vout_End;
96 p_function_list->functions.vout.pf_destroy = vout_Destroy;
97 p_function_list->functions.vout.pf_manage = vout_Manage;
98 p_function_list->functions.vout.pf_display = vout_Display;
99 p_function_list->functions.vout.pf_setpalette = NULL;
102 /*****************************************************************************
103 * vout_Probe: probe the video driver and return a score
104 *****************************************************************************
105 * This function tries to initialize GGI and returns a score to the
106 * plugin manager so that it can select the best plugin.
107 *****************************************************************************/
108 static int vout_Probe( probedata_t *p_data )
110 if( TestMethod( VOUT_METHOD_VAR, "ggi" ) )
118 /*****************************************************************************
119 * vout_Create: allocate GGI video thread output method
120 *****************************************************************************
121 * This function allocate and initialize a GGI vout method. It uses some of the
122 * vout properties to choose the correct mode, and change them according to the
123 * mode actually used.
124 *****************************************************************************/
125 int vout_Create( vout_thread_t *p_vout )
127 /* Allocate structure */
128 p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
129 if( p_vout->p_sys == NULL )
131 intf_ErrMsg( "vout error: %s", strerror(ENOMEM) );
135 /* Open and initialize device */
136 if( GGIOpenDisplay( p_vout ) )
138 intf_ErrMsg( "vout error: can't initialize GGI display" );
139 free( p_vout->p_sys );
146 /*****************************************************************************
147 * vout_Init: initialize GGI video thread output method
148 *****************************************************************************
149 * This function initialize the GGI display device.
150 *****************************************************************************/
151 int vout_Init( vout_thread_t *p_vout )
153 #define p_b p_vout->p_sys->p_buffer
154 /* Acquire first buffer */
155 if( p_vout->p_sys->b_must_acquire )
157 ggiResourceAcquire( p_b[ p_vout->i_buffer_index ]->resource,
161 /* Listen to the keyboard and the mouse buttons */
162 ggiSetEventMask( p_vout->p_sys->p_display,
163 emKeyboard | emPtrButtonPress | emPtrButtonRelease );
165 /* Set asynchronous display mode -- usually quite faster */
166 ggiAddFlags( p_vout->p_sys->p_display, GGIFLAG_ASYNC );
172 /*****************************************************************************
173 * vout_End: terminate GGI video thread output method
174 *****************************************************************************
175 * Terminate an output method created by vout_Create
176 *****************************************************************************/
177 void vout_End( vout_thread_t *p_vout )
179 #define p_b p_vout->p_sys->p_buffer
181 if( p_vout->p_sys->b_must_acquire )
183 ggiResourceRelease( p_b[ p_vout->i_buffer_index ]->resource );
188 /*****************************************************************************
189 * vout_Destroy: destroy GGI video thread output method
190 *****************************************************************************
191 * Terminate an output method created by vout_Create
192 *****************************************************************************/
193 void vout_Destroy( vout_thread_t *p_vout )
195 GGICloseDisplay( p_vout );
197 free( p_vout->p_sys );
200 /*****************************************************************************
201 * vout_Manage: handle GGI events
202 *****************************************************************************
203 * This function should be called regularly by video output thread. It returns
204 * a non null value if an error occured.
205 *****************************************************************************/
206 int vout_Manage( vout_thread_t *p_vout )
208 struct timeval tv = { 0, 1000 }; /* 1 millisecond */
212 mask = emKeyboard | emPtrButtonPress | emPtrButtonRelease;
214 ggiEventPoll( p_vout->p_sys->p_display, mask, &tv );
216 while( ggiEventsQueued( p_vout->p_sys->p_display, mask) )
218 ggiEventRead( p_vout->p_sys->p_display, &event, mask);
220 switch( event.any.type )
224 switch( event.key.sym )
229 /* FIXME pass message ! */
230 //p_main->p_intf->b_die = 1;
238 case evPtrButtonRelease:
240 switch( event.pbutton.button )
242 case GII_PBUTTON_RIGHT:
243 /* FIXME: need locking ! */
244 //p_main->p_intf->b_menu_change = 1;
257 /*****************************************************************************
258 * vout_Display: displays previously rendered output
259 *****************************************************************************
260 * This function send the currently rendered image to the display, wait until
261 * it is displayed and switch the two rendering buffer, preparing next frame.
262 *****************************************************************************/
263 void vout_Display( vout_thread_t *p_vout )
265 #define p_b p_vout->p_sys->p_buffer
266 /* Change display frame */
267 if( p_vout->p_sys->b_must_acquire )
269 ggiResourceRelease( p_b[ p_vout->i_buffer_index ]->resource );
271 ggiSetDisplayFrame( p_vout->p_sys->p_display,
272 p_b[ p_vout->i_buffer_index ]->frame );
274 /* Swap buffers and change write frame */
275 if( p_vout->p_sys->b_must_acquire )
277 ggiResourceAcquire( p_b[ (p_vout->i_buffer_index + 1) & 1]->resource,
280 ggiSetWriteFrame( p_vout->p_sys->p_display,
281 p_b[ (p_vout->i_buffer_index + 1) & 1]->frame );
283 /* Flush the output so that it actually displays */
284 ggiFlush( p_vout->p_sys->p_display );
288 /* following functions are local */
290 /*****************************************************************************
291 * GGIOpenDisplay: open and initialize GGI device
292 *****************************************************************************
293 * Open and initialize display according to preferences specified in the vout
295 *****************************************************************************/
296 static int GGIOpenDisplay( vout_thread_t *p_vout )
298 #define p_b p_vout->p_sys->p_buffer
299 ggi_mode mode; /* mode descriptor */
300 ggi_color col_fg; /* foreground color */
301 ggi_color col_bg; /* background color */
302 int i_index; /* all purposes index */
305 /* Initialize library */
308 intf_ErrMsg( "vout error: can't initialize GGI library" );
313 psz_display = main_GetPszVariable( VOUT_DISPLAY_VAR, NULL );
315 p_vout->p_sys->p_display = ggiOpen( psz_display, NULL );
317 if( p_vout->p_sys->p_display == NULL )
319 intf_ErrMsg( "vout error: can't open GGI default display" );
324 /* Find most appropriate mode */
325 mode.frames = 2; /* 2 buffers */
326 mode.visible.x = main_GetIntVariable( VOUT_WIDTH_VAR,
327 VOUT_WIDTH_DEFAULT );
328 mode.visible.y = main_GetIntVariable( VOUT_HEIGHT_VAR,
329 VOUT_HEIGHT_DEFAULT );
330 mode.virt.x = GGI_AUTO;
331 mode.virt.y = GGI_AUTO;
332 mode.size.x = GGI_AUTO;
333 mode.size.y = GGI_AUTO;
334 mode.graphtype = GT_15BIT; /* minimum usable screen depth */
335 mode.dpp.x = GGI_AUTO;
336 mode.dpp.y = GGI_AUTO;
337 ggiCheckMode( p_vout->p_sys->p_display, &mode );
339 /* FIXME: Check that returned mode has some minimum properties */
342 if( ggiSetMode( p_vout->p_sys->p_display, &mode ) )
344 intf_ErrMsg( "vout error: can't set GGI mode" );
345 ggiClose( p_vout->p_sys->p_display );
350 /* Check buffers properties */
351 p_vout->p_sys->b_must_acquire = 0;
352 for( i_index = 0; i_index < 2; i_index++ )
354 /* Get buffer address */
355 p_vout->p_sys->p_buffer[ i_index ] =
356 (ggi_directbuffer *)ggiDBGetBuffer( p_vout->p_sys->p_display,
358 if( p_b[ i_index ] == NULL )
360 intf_ErrMsg( "vout error: double buffering is not possible" );
361 ggiClose( p_vout->p_sys->p_display );
366 /* Check buffer properties */
367 if( ! ( p_b[ i_index ]->type & GGI_DB_SIMPLE_PLB )
368 || ( p_b[ i_index ]->page_size != 0 )
369 || ( p_b[ i_index ]->write == NULL )
370 || ( p_b[ i_index ]->noaccess != 0 )
371 || ( p_b[ i_index ]->align != 0 ) )
373 intf_ErrMsg( "vout error: incorrect video memory type" );
374 ggiClose( p_vout->p_sys->p_display );
379 /* Check if buffer needs to be acquired before write */
380 if( ggiResourceMustAcquire( p_b[ i_index ]->resource ) )
382 p_vout->p_sys->b_must_acquire = 1;
386 if( p_vout->p_sys->b_must_acquire )
388 intf_DbgMsg("buffers must be acquired");
391 /* Set graphic context colors */
392 col_fg.r = col_fg.g = col_fg.b = -1;
393 col_bg.r = col_bg.g = col_bg.b = 0;
394 if( ggiSetGCForeground(p_vout->p_sys->p_display,
395 ggiMapColor(p_vout->p_sys->p_display,&col_fg)) ||
396 ggiSetGCBackground(p_vout->p_sys->p_display,
397 ggiMapColor(p_vout->p_sys->p_display,&col_bg)) )
399 intf_ErrMsg( "vout error: can't set colors" );
400 ggiClose( p_vout->p_sys->p_display );
405 /* Set clipping for text */
406 if( ggiSetGCClipping(p_vout->p_sys->p_display, 0, 0,
407 mode.visible.x, mode.visible.y ) )
409 intf_ErrMsg( "vout error: can't set clipping" );
410 ggiClose( p_vout->p_sys->p_display );
415 /* Set thread information */
416 p_vout->i_width = mode.visible.x;
417 p_vout->i_height = mode.visible.y;
418 p_vout->i_bytes_per_line = p_b[ 0 ]->buffer.plb.stride;
419 p_vout->i_screen_depth = p_b[ 0 ]->buffer.plb.pixelformat->depth;
420 p_vout->i_bytes_per_pixel = p_b[ 0 ]->buffer.plb.pixelformat->size / 8;
421 p_vout->i_red_mask = p_b[ 0 ]->buffer.plb.pixelformat->red_mask;
422 p_vout->i_green_mask = p_b[ 0 ]->buffer.plb.pixelformat->green_mask;
423 p_vout->i_blue_mask = p_b[ 0 ]->buffer.plb.pixelformat->blue_mask;
425 /* FIXME: set palette in 8bpp */
427 /* Set and initialize buffers */
428 p_vout->pf_setbuffers( p_vout, p_b[ 0 ]->write, p_b[ 1 ]->write );
434 /*****************************************************************************
435 * GGICloseDisplay: close and reset GGI device
436 *****************************************************************************
437 * This function returns all resources allocated by GGIOpenDisplay and restore
438 * the original state of the device.
439 *****************************************************************************/
440 static void GGICloseDisplay( vout_thread_t *p_vout )
442 /* Restore original mode and close display */
443 ggiClose( p_vout->p_sys->p_display );