Search
lxdream.org :: lxdream/src/display.h
lxdream 0.9.1
released Jun 29
Download Now
filename src/display.h
changeset 1134:f502f3d32f90
prev1076:18c164e8aec4
next1159:580436b01b6c
author nkeynes
date Fri Oct 22 20:55:32 2010 +1000 (12 years ago)
permissions -rw-r--r--
last change Dump more information with --gl-info, and print it a little more nicely
view annotate diff log raw
     1 /**
     2  * $Id$
     3  *
     4  * The PC side of the video support (responsible for actually displaying / 
     5  * rendering frames)
     6  *
     7  * Copyright (c) 2005 Nathan Keynes.
     8  *
     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.
    13  *
    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.
    18  */
    20 #ifndef lxdream_display_H
    21 #define lxdream_display_H 1
    23 #define GL_GLEXT_PROTOTYPES 1
    25 #include <stdint.h>
    26 #include <stdio.h>
    27 #include <glib.h>
    28 #include "lxdream.h"
    29 #include "gettext.h"
    30 #include "config.h"
    31 #ifdef APPLE_BUILD
    32 #include <OpenGL/gl.h>
    33 #include <OpenGL/glext.h>
    34 #else
    35 #include <GL/gl.h>
    36 #include <GL/glext.h>
    37 #endif
    39 #ifdef __cplusplus
    40 extern "C" {
    41 #endif
    43 /**
    44  * Supported colour formats. Note that BGRA4444 is only ever used for texture
    45  * rendering (it's not valid for display purposes).
    46  */
    47 #define COLFMT_BGRA1555  0
    48 #define COLFMT_RGB565    1
    49 #define COLFMT_BGRA4444  2
    50 #define COLFMT_YUV422    3 /* 8-bit YUV (texture source only) */
    51 #define COLFMT_BGR888    4 /* 24-bit BGR */
    52 #define COLFMT_BGRA8888  5
    53 #define COLFMT_INDEX4    6 /* 4 bit indexed colour (texture source only) */
    54 #define COLFMT_INDEX8    7 /* 8-bit indexed colour (texture source only) */
    55 #define COLFMT_BGR0888   8 /* 32-bit BGR */
    56 #define COLFMT_RGB888    9 /* 24-bit RGB (ie GL native) */
    58 /**
    59  * The standard display size (for the purposes of mouse inputs, etc, is 640x480 -
    60  * events should be adjusted accordingly if this is not the actual window size.
    61  */ 
    62 #define DISPLAY_WIDTH 640
    63 #define DISPLAY_HEIGHT 480
    65 struct colour_format {
    66     GLint type, format, int_format;
    67     int bpp;
    68 };
    69 extern struct colour_format colour_formats[];
    71 extern int colour_format_bytes[];
    73 /**
    74  * Structure to hold pixel data held in GL buffers.
    75  */
    76 struct render_buffer {
    77     uint32_t width;
    78     uint32_t height;
    79     uint32_t rowstride;
    80     uint32_t colour_format;
    81     sh4addr_t address; /* Address buffer was rendered to, or -1 for unrendered */
    82     uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */
    83     gboolean inverted;/* True if the buffer is upside down */
    84     uint32_t scale;
    85     GLuint tex_id;    /* texture bound to render buffer, if any (0 = none). 
    86                        * The render buffer does not own the texture */
    87     unsigned int buf_id; /* driver-specific buffer id, if applicable */
    88     gboolean flushed; /* True if the buffer has been flushed to vram */
    89 };
    91 /**
    92  * Structure to hold pixel data stored in pvr2 vram, as opposed to data in
    93  * GL buffers.
    94  */
    95 struct frame_buffer {
    96     uint32_t width;
    97     uint32_t height;
    98     uint32_t rowstride;
    99     uint32_t colour_format;
   100     sh4addr_t address;
   101     uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */
   102     gboolean inverted;/* True if the buffer is upside down */
   103     unsigned char *data;
   104 };
   106 struct display_capabilities {
   107     gboolean has_gl;
   108     int stencil_bits; /* 0 = no stencil buffer */
   109 };
   111 /**
   112  * Core video driver - exports function to setup a GL context, as well as handle
   113  * keyboard input and display resultant output.
   114  */
   115 typedef struct display_driver {
   116     char *name;
   117     /**
   118      * Short (<60 chars) description of the driver. This should be marked for
   119      * localization.
   120      */
   121     char *description;
   122     /**
   123      * Initialize the driver. This is called only once at startup time, and
   124      * is guaranteed to be called before any other methods.
   125      * @return TRUE if the driver was successfully initialized, otherwise
   126      * FALSE.
   127      */
   128     gboolean (*init_driver)(void);
   130     /**
   131      * Cleanly shutdown the driver. Normally only called at system shutdown
   132      * time.
   133      */
   134     void (*shutdown_driver)(void);
   136     /**
   137      * Given a particular keysym, return the keycode associated with it.
   138      * @param keysym The keysym to be resolved, ie "Tab"
   139      * @return the display-specific keycode, or 0 if the keysym cannot
   140      * be resolved.
   141      */
   142     uint16_t (*resolve_keysym)( const gchar *keysym );
   144     /**
   145      * Given a native system keycode, convert it to a dreamcast keyboard code.
   146      */
   147     uint16_t (*convert_to_dckeysym)( uint16_t keycode );
   149     /**
   150      * Given a device-specific event code, return the corresponding keysym.
   151      * The string should be newly allocated (caller will free)
   152      */
   153     gchar *(*get_keysym_for_keycode)( uint16_t keycode );
   155     /**
   156      * Create a render target with the given width and height. If a texture ID
   157      * is supplied (non-zero), the render buffer writes its output to that texture.
   158      * @param tex_id 0 or a valid GL texture name which must have been initialized to
   159      * the correct dimensions. 
   160      */
   161     render_buffer_t (*create_render_buffer)( uint32_t width, uint32_t height, GLuint tex_id );
   163     /**
   164      * Destroy the specified render buffer and release any associated
   165      * resources.
   166      */
   167     void (*destroy_render_buffer)( render_buffer_t buffer );
   169     /**
   170      * Set the current rendering target to the specified buffer.
   171      */
   172     gboolean (*set_render_target)( render_buffer_t buffer );
   174     /**
   175      * Complete rendering and clear the current rendering target. If the 
   176      * buffer has a bound texture, it will be updated if necessary.
   177      */
   178     void (*finish_render)( render_buffer_t buffer );
   180     /**
   181      * Load the supplied frame buffer into the given render buffer.
   182      * Included here to allow driver-specific optimizations.
   183      */
   184     void (*load_frame_buffer)( frame_buffer_t frame, render_buffer_t render );
   186     /**
   187      * Display a single frame using a previously rendered GL buffer.
   188      */
   189     void (*display_render_buffer)( render_buffer_t buffer );
   191     /**
   192      * Display a single blanked frame using a fixed colour for the
   193      * entire frame (specified in BGR888 format). 
   194      */
   195     void (*display_blank)( uint32_t rgb );
   197     /**
   198      * Swap front/back window buffers
   199      */
   200     void (*swap_buffers)();
   202     /**
   203      * Copy the image data from the GL buffer to the target memory buffer,
   204      * using the format etc from the buffer. This may force a glFinish()
   205      * but does not invalidate the buffer.
   206      * @param target buffer to fill with image data, which must be large enough
   207      *  to accomodate the image.
   208      * @param buffer Render buffer to read from.
   209      * @param rowstride rowstride of the target data
   210      * @param format colour format to output the data in.
   211      */
   212     gboolean (*read_render_buffer)( unsigned char *target, render_buffer_t buffer,
   213             int rowstride, int format );
   215     /**
   216      * Dump driver-specific information about the implementation to the given stream
   217      */
   218     void (*print_info)( FILE *out );
   220     struct display_capabilities capabilities;
   221 } *display_driver_t;
   223 /**
   224  * Print the configured video drivers to the output stream, one to a line.
   225  */
   226 void print_display_drivers( FILE *out );
   227 display_driver_t get_display_driver_by_name( const char *name );
   228 gboolean display_set_driver( display_driver_t driver );
   230 extern uint32_t pvr2_frame_counter;
   232 extern display_driver_t display_driver;
   234 extern struct display_driver display_gtk_driver;
   235 extern struct display_driver display_osx_driver;
   236 extern struct display_driver display_null_driver;
   238 /****************** Input methods **********************/
   240 #define MAX_MOUSE_BUTTONS 32
   242 /* Pressure is 0..127  (allowing a joystick to be defined as two half-axes of 7- bits each) */
   243 #define MAX_PRESSURE 0x7F
   245 typedef key_binding_t input_key_callback_t;
   247 /**
   248  * Callback to receive mouse input events
   249  * @param data pointer passed in at the time the hook was registered
   250  * @param buttons bitmask of button states, where bit 0 is button 0 (left), bit 1 is button
   251  * 1 (middle), bit 2 is button 2 (right) and so forth.
   252  * @param x Horizontal movement since the last invocation (in relative mode) or window position 
   253  * (in absolute mode).
   254  * @param y Vertical movement since the last invocation (in relative mode) or window position
   255  * (in absolute mode).
   256  * @param absolute If TRUE, x and y are the current window coordinates 
   257  *  of the mouse cursor. Otherwise, x and y are deltas from the previous mouse position.
   258  */
   259 typedef void (*input_mouse_callback_t)( void *data, uint32_t buttons, int32_t x, int32_t y, gboolean absolute );
   261 gboolean input_register_key( const gchar *keysym, input_key_callback_t callback,
   262                              void *data, uint32_t value );
   264 void input_unregister_key( const gchar *keysym, input_key_callback_t callback,
   265                            void *data, uint32_t value );
   267 gboolean input_register_keygroup( lxdream_config_group_t group );
   268 void input_unregister_keygroup( lxdream_config_group_t group );
   269 gboolean input_keygroup_changed( void *data, lxdream_config_group_t group, unsigned key,
   270                              const gchar *oldval, const gchar *newval );
   272 /**
   273  * Register a hook to receive all keyboard input events
   274  */
   275 gboolean input_register_keyboard_hook( input_key_callback_t callback, void *data );
   276 void input_unregister_keyboard_hook( input_key_callback_t callback, void *data );
   278 /**
   279  * Register a mouse event hook.
   280  * @param relative TRUE if the caller wants relative mouse movement, FALSE for
   281  * absolute mouse positioning. It's not generally possible to receive both at the same time.
   282  */
   283 gboolean input_register_mouse_hook( gboolean relative, input_mouse_callback_t callback, void *data );
   284 void input_unregister_mouse_hook( input_mouse_callback_t callback, void *data );
   286 gboolean input_is_key_valid( const gchar *keysym );
   288 gboolean input_is_key_registered( const gchar *keysym );
   290 uint16_t input_keycode_to_dckeysym( uint16_t keycode );
   292 /********************** Display/Input methods ***********************/
   294 /**
   295  * Auxilliary input driver - provides input separate to and in addition to the
   296  * core UI/display. (primarily used for joystick devices)
   297  */
   298 typedef struct input_driver {
   299     const char *id; /* Short identifier to display in the UI for the device (eg "JS0" ) */
   301     /**
   302      * Given a particular keysym, return the keycode associated with it.
   303      * @param keysym The keysym to be resolved, ie "Tab"
   304      * @return the display-specific keycode, or 0 if the keysym cannot
   305      * be resolved.
   306      */
   307     uint16_t (*resolve_keysym)( struct input_driver *driver, const gchar *keysym );
   309     /**
   310      * Given a device-specific event code, convert it to a dreamcast keyboard code.
   311      * This is only required for actual keyboard devices, other devices should just
   312      * leave this method NULL.
   313      */
   314     uint16_t (*convert_to_dckeysym)( struct input_driver *driver, uint16_t keycode );
   316     /**
   317      * Given a device-specific event code, return the corresponding keysym.
   318      * The string should be newly allocated (caller will free)
   319      */
   320     gchar *(*get_keysym_for_keycode)( struct input_driver *driver, uint16_t keycode );
   322     /**
   323      * Destroy the input driver.
   324      */
   325     void (*destroy)( struct input_driver *driver );
   327 } *input_driver_t;       
   329 extern struct input_driver system_mouse_driver;
   331 /**
   332  * Register a new input driver (which must have a unique name)
   333  * @param driver the driver to register
   334  * @param max_keycode the highest possible keycode reported by the device
   335  * @return TRUE on success, FALSE on failure (eg driver already registed).
   336  */
   337 gboolean input_register_device( input_driver_t driver, uint16_t max_keycode );
   339 /**
   340  * Determine if the system has an input driver with the given unique ID.
   341  * @param id driver id to check
   342  * @return TRUE if the device exists, otherwise FALSE
   343  */
   344 gboolean input_has_device( const gchar *id );
   346 /**
   347  * Unregister an input driver.
   348  * @param driver the driver to unregister
   349  * If the driver is not in fact registered, this function has no effect.
   350  */
   351 void input_unregister_device( input_driver_t driver );
   353 /**
   354  * Called from the UI to indicate that the emulation window is focused (ie
   355  * able to receive input). This method is used to gate non-UI input devices -
   356  * when the display is not focused, all input events will be silently ignored.
   357  */
   358 void display_set_focused( gboolean has_focus );
   360 /**
   361  * Fire a keydown event on the specified device
   362  * @param input The input device source generating the event, or NULL for the 
   363  *        default GUI device
   364  * @param keycode The device-specific keycode
   365  * @param pressure The pressure of the key (0 to 127), where 0 is unpressed and
   366  *        127 is maximum pressure. Devices without pressure sensitivity should 
   367  *        always use MAX_PRESSURE (127) 
   368  */
   369 void input_event_keydown( input_driver_t input, uint16_t keycode, uint32_t pressure );
   371 void input_event_keyup( input_driver_t input, uint16_t keycode );
   373 /**
   374  * Receive an input mouse down event. Normally these should be absolute events when
   375  * the mouse is not grabbed, and relative when it is.
   376  * @param button the button pressed, where 0 == first button
   377  * @param x_axis The relative or absolute position of the mouse cursor on the X axis
   378  * @param y_axis The relative or absolute position of the mouse cursor on the Y axis
   379  * @param absolute If TRUE, x_axis and y_axis are the current window coordinates 
   380  *  of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position.
   381  */
   382 void input_event_mousedown( uint16_t button, int32_t x_axis, int32_t y_axis, gboolean absolute );
   384 /**
   385  * Receive an input mouse up event. Normally these should be absolute events when
   386  * the mouse is not grabbed, and relative when it is.
   387  * @param button the button released, where 0 == first button
   388  * @param x_axis The relative or absolute position of the mouse cursor on the X axis
   389  * @param y_axis The relative or absolute position of the mouse cursor on the Y axis
   390  * @param absolute If TRUE, x_axis and y_axis are the current window coordinates 
   391  *  of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position.
   392  */
   393 void input_event_mouseup( uint16_t button, int32_t x_axis, int32_t y_axis, gboolean absolute );
   395 /**
   396  * Receive an input mouse motion event. Normally these should be absolute events when
   397  * the mouse is not grabbed, and relative when it is.
   398  * @param x_axis The relative or absolute position of the mouse cursor on the X axis
   399  * @param y_axis The relative or absolute position of the mouse cursor on the Y axis
   400  * @param absolute If TRUE, x_axis and y_axis are the current window coordinates 
   401  *  of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position.
   402  */
   403 void input_event_mousemove( int32_t x_axis, int32_t y_axis, gboolean absolute );
   405 /**
   406  * Given a keycode and the originating input driver, return the corresponding 
   407  * keysym. The caller is responsible for freeing the string.
   408  * @return a newly allocated string, or NULL of the keycode is unresolvable.
   409  */
   410 gchar *input_keycode_to_keysym( input_driver_t driver, uint16_t keycode );
   412 typedef void (*display_keysym_callback_t)( void *data, const gchar *keysym );
   414 /**
   415  * Set the keysym hook function (normally used by the UI to receive non-UI
   416  * input events during configuration.
   417  */
   418 void input_set_keysym_hook( display_keysym_callback_t hook, void *data );
   422 #ifdef __cplusplus
   423 }
   424 #endif
   425 #endif /* !lxdream_display_H */
.