Search
lxdream.org :: lxdream/src/display.h
lxdream 0.9.1
released Jun 29
Download Now
filename src/display.h
changeset 1159:580436b01b6c
prev1134:f502f3d32f90
next1239:be3121267597
author nkeynes
date Fri Feb 24 21:11:58 2012 +1000 (9 years ago)
permissions -rw-r--r--
last change Add preprocessing support to genglsl
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 struct vertex_buffer {
   112     /**
   113      * Map the buffer into the host address space (if necessary) in preparation
   114      * for filling the buffer. This also implies a fence operation.
   115      * @param buf previously allocated buffer
   116      * @param size number of bytes of the buffer actually to be used. The buffer
   117      * will be resized if necessary.
   118      * @return a pointer to the start of the buffer.
   119      */
   120     void *(*map)(vertex_buffer_t buf, uint32_t size);
   122     /**
   123      * Unmap the buffer, after the vertex data is written.
   124      * @return the buffer base to use for gl*Pointer calls
   125      */
   126     void *(*unmap)(vertex_buffer_t buf);
   128     /**
   129      * Mark the buffer as finished, indicating that the vertex data is no
   130      * longer required (ie rendering is complete).
   131      */
   132     void (*finished)(vertex_buffer_t buf);
   134     /**
   135      * Delete the buffer and all associated resources.
   136      */
   137     void (*destroy)(vertex_buffer_t buf);
   139     /* Private data */
   140     void *data;
   141     GLuint id;
   142     uint32_t capacity;
   143     uint32_t mapped_size;
   144     GLuint fence;
   145 };
   148 /**
   149  * Core video driver - exports function to setup a GL context, as well as handle
   150  * keyboard input and display resultant output.
   151  */
   152 typedef struct display_driver {
   153     char *name;
   154     /**
   155      * Short (<60 chars) description of the driver. This should be marked for
   156      * localization.
   157      */
   158     char *description;
   159     /**
   160      * Initialize the driver. This is called only once at startup time, and
   161      * is guaranteed to be called before any other methods.
   162      * @return TRUE if the driver was successfully initialized, otherwise
   163      * FALSE.
   164      */
   165     gboolean (*init_driver)(void);
   167     /**
   168      * Cleanly shutdown the driver. Normally only called at system shutdown
   169      * time.
   170      */
   171     void (*shutdown_driver)(void);
   173     /**
   174      * Given a particular keysym, return the keycode associated with it.
   175      * @param keysym The keysym to be resolved, ie "Tab"
   176      * @return the display-specific keycode, or 0 if the keysym cannot
   177      * be resolved.
   178      */
   179     uint16_t (*resolve_keysym)( const gchar *keysym );
   181     /**
   182      * Given a native system keycode, convert it to a dreamcast keyboard code.
   183      */
   184     uint16_t (*convert_to_dckeysym)( uint16_t keycode );
   186     /**
   187      * Given a device-specific event code, return the corresponding keysym.
   188      * The string should be newly allocated (caller will free)
   189      */
   190     gchar *(*get_keysym_for_keycode)( uint16_t keycode );
   192     /**
   193      * Create a render target with the given width and height. If a texture ID
   194      * is supplied (non-zero), the render buffer writes its output to that texture.
   195      * @param tex_id 0 or a valid GL texture name which must have been initialized to
   196      * the correct dimensions. 
   197      */
   198     render_buffer_t (*create_render_buffer)( uint32_t width, uint32_t height, GLuint tex_id );
   200     /**
   201      * Destroy the specified render buffer and release any associated
   202      * resources.
   203      */
   204     void (*destroy_render_buffer)( render_buffer_t buffer );
   206     /**
   207      * Set the current rendering target to the specified buffer.
   208      */
   209     gboolean (*set_render_target)( render_buffer_t buffer );
   211     /**
   212      * Complete rendering and clear the current rendering target. If the 
   213      * buffer has a bound texture, it will be updated if necessary.
   214      */
   215     void (*finish_render)( render_buffer_t buffer );
   217     /**
   218      * Load the supplied frame buffer into the given render buffer.
   219      * Included here to allow driver-specific optimizations.
   220      */
   221     void (*load_frame_buffer)( frame_buffer_t frame, render_buffer_t render );
   223     /**
   224      * Display a single frame using a previously rendered GL buffer.
   225      */
   226     void (*display_render_buffer)( render_buffer_t buffer );
   228     /**
   229      * Display a single blanked frame using a fixed colour for the
   230      * entire frame (specified in BGR888 format). 
   231      */
   232     void (*display_blank)( uint32_t rgb );
   234     /**
   235      * Swap front/back window buffers
   236      */
   237     void (*swap_buffers)();
   239     /**
   240      * Copy the image data from the GL buffer to the target memory buffer,
   241      * using the format etc from the buffer. This may force a glFinish()
   242      * but does not invalidate the buffer.
   243      * @param target buffer to fill with image data, which must be large enough
   244      *  to accomodate the image.
   245      * @param buffer Render buffer to read from.
   246      * @param rowstride rowstride of the target data
   247      * @param format colour format to output the data in.
   248      */
   249     gboolean (*read_render_buffer)( unsigned char *target, render_buffer_t buffer,
   250             int rowstride, int format );
   252     /**
   253      * Create a new vertex buffer
   254      */
   255     vertex_buffer_t (*create_vertex_buffer)( );
   257     /**
   258      * Dump driver-specific information about the implementation to the given stream
   259      */
   260     void (*print_info)( FILE *out );
   262     struct display_capabilities capabilities;
   264 } *display_driver_t;
   266 /**
   267  * Print the configured video drivers to the output stream, one to a line.
   268  */
   269 void print_display_drivers( FILE *out );
   270 display_driver_t get_display_driver_by_name( const char *name );
   271 gboolean display_set_driver( display_driver_t driver );
   273 extern uint32_t pvr2_frame_counter;
   275 extern display_driver_t display_driver;
   277 extern struct display_driver display_gtk_driver;
   278 extern struct display_driver display_osx_driver;
   279 extern struct display_driver display_null_driver;
   281 /****************** Input methods **********************/
   283 #define MAX_MOUSE_BUTTONS 32
   285 /* Pressure is 0..127  (allowing a joystick to be defined as two half-axes of 7- bits each) */
   286 #define MAX_PRESSURE 0x7F
   288 typedef key_binding_t input_key_callback_t;
   290 /**
   291  * Callback to receive mouse input events
   292  * @param data pointer passed in at the time the hook was registered
   293  * @param buttons bitmask of button states, where bit 0 is button 0 (left), bit 1 is button
   294  * 1 (middle), bit 2 is button 2 (right) and so forth.
   295  * @param x Horizontal movement since the last invocation (in relative mode) or window position 
   296  * (in absolute mode).
   297  * @param y Vertical movement since the last invocation (in relative mode) or window position
   298  * (in absolute mode).
   299  * @param absolute If TRUE, x and y are the current window coordinates 
   300  *  of the mouse cursor. Otherwise, x and y are deltas from the previous mouse position.
   301  */
   302 typedef void (*input_mouse_callback_t)( void *data, uint32_t buttons, int32_t x, int32_t y, gboolean absolute );
   304 gboolean input_register_key( const gchar *keysym, input_key_callback_t callback,
   305                              void *data, uint32_t value );
   307 void input_unregister_key( const gchar *keysym, input_key_callback_t callback,
   308                            void *data, uint32_t value );
   310 gboolean input_register_keygroup( lxdream_config_group_t group );
   311 void input_unregister_keygroup( lxdream_config_group_t group );
   312 gboolean input_keygroup_changed( void *data, lxdream_config_group_t group, unsigned key,
   313                              const gchar *oldval, const gchar *newval );
   315 /**
   316  * Register a hook to receive all keyboard input events
   317  */
   318 gboolean input_register_keyboard_hook( input_key_callback_t callback, void *data );
   319 void input_unregister_keyboard_hook( input_key_callback_t callback, void *data );
   321 /**
   322  * Register a mouse event hook.
   323  * @param relative TRUE if the caller wants relative mouse movement, FALSE for
   324  * absolute mouse positioning. It's not generally possible to receive both at the same time.
   325  */
   326 gboolean input_register_mouse_hook( gboolean relative, input_mouse_callback_t callback, void *data );
   327 void input_unregister_mouse_hook( input_mouse_callback_t callback, void *data );
   329 gboolean input_is_key_valid( const gchar *keysym );
   331 gboolean input_is_key_registered( const gchar *keysym );
   333 uint16_t input_keycode_to_dckeysym( uint16_t keycode );
   335 /********************** Display/Input methods ***********************/
   337 /**
   338  * Auxilliary input driver - provides input separate to and in addition to the
   339  * core UI/display. (primarily used for joystick devices)
   340  */
   341 typedef struct input_driver {
   342     const char *id; /* Short identifier to display in the UI for the device (eg "JS0" ) */
   344     /**
   345      * Given a particular keysym, return the keycode associated with it.
   346      * @param keysym The keysym to be resolved, ie "Tab"
   347      * @return the display-specific keycode, or 0 if the keysym cannot
   348      * be resolved.
   349      */
   350     uint16_t (*resolve_keysym)( struct input_driver *driver, const gchar *keysym );
   352     /**
   353      * Given a device-specific event code, convert it to a dreamcast keyboard code.
   354      * This is only required for actual keyboard devices, other devices should just
   355      * leave this method NULL.
   356      */
   357     uint16_t (*convert_to_dckeysym)( struct input_driver *driver, uint16_t keycode );
   359     /**
   360      * Given a device-specific event code, return the corresponding keysym.
   361      * The string should be newly allocated (caller will free)
   362      */
   363     gchar *(*get_keysym_for_keycode)( struct input_driver *driver, uint16_t keycode );
   365     /**
   366      * Destroy the input driver.
   367      */
   368     void (*destroy)( struct input_driver *driver );
   370 } *input_driver_t;       
   372 extern struct input_driver system_mouse_driver;
   374 /**
   375  * Register a new input driver (which must have a unique name)
   376  * @param driver the driver to register
   377  * @param max_keycode the highest possible keycode reported by the device
   378  * @return TRUE on success, FALSE on failure (eg driver already registed).
   379  */
   380 gboolean input_register_device( input_driver_t driver, uint16_t max_keycode );
   382 /**
   383  * Determine if the system has an input driver with the given unique ID.
   384  * @param id driver id to check
   385  * @return TRUE if the device exists, otherwise FALSE
   386  */
   387 gboolean input_has_device( const gchar *id );
   389 /**
   390  * Unregister an input driver.
   391  * @param driver the driver to unregister
   392  * If the driver is not in fact registered, this function has no effect.
   393  */
   394 void input_unregister_device( input_driver_t driver );
   396 /**
   397  * Called from the UI to indicate that the emulation window is focused (ie
   398  * able to receive input). This method is used to gate non-UI input devices -
   399  * when the display is not focused, all input events will be silently ignored.
   400  */
   401 void display_set_focused( gboolean has_focus );
   403 /**
   404  * Fire a keydown event on the specified device
   405  * @param input The input device source generating the event, or NULL for the 
   406  *        default GUI device
   407  * @param keycode The device-specific keycode
   408  * @param pressure The pressure of the key (0 to 127), where 0 is unpressed and
   409  *        127 is maximum pressure. Devices without pressure sensitivity should 
   410  *        always use MAX_PRESSURE (127) 
   411  */
   412 void input_event_keydown( input_driver_t input, uint16_t keycode, uint32_t pressure );
   414 void input_event_keyup( input_driver_t input, uint16_t keycode );
   416 /**
   417  * Receive an input mouse down event. Normally these should be absolute events when
   418  * the mouse is not grabbed, and relative when it is.
   419  * @param button the button pressed, where 0 == first button
   420  * @param x_axis The relative or absolute position of the mouse cursor on the X axis
   421  * @param y_axis The relative or absolute position of the mouse cursor on the Y axis
   422  * @param absolute If TRUE, x_axis and y_axis are the current window coordinates 
   423  *  of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position.
   424  */
   425 void input_event_mousedown( uint16_t button, int32_t x_axis, int32_t y_axis, gboolean absolute );
   427 /**
   428  * Receive an input mouse up event. Normally these should be absolute events when
   429  * the mouse is not grabbed, and relative when it is.
   430  * @param button the button released, where 0 == first button
   431  * @param x_axis The relative or absolute position of the mouse cursor on the X axis
   432  * @param y_axis The relative or absolute position of the mouse cursor on the Y axis
   433  * @param absolute If TRUE, x_axis and y_axis are the current window coordinates 
   434  *  of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position.
   435  */
   436 void input_event_mouseup( uint16_t button, int32_t x_axis, int32_t y_axis, gboolean absolute );
   438 /**
   439  * Receive an input mouse motion event. Normally these should be absolute events when
   440  * the mouse is not grabbed, and relative when it is.
   441  * @param x_axis The relative or absolute position of the mouse cursor on the X axis
   442  * @param y_axis The relative or absolute position of the mouse cursor on the Y axis
   443  * @param absolute If TRUE, x_axis and y_axis are the current window coordinates 
   444  *  of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position.
   445  */
   446 void input_event_mousemove( int32_t x_axis, int32_t y_axis, gboolean absolute );
   448 /**
   449  * Given a keycode and the originating input driver, return the corresponding 
   450  * keysym. The caller is responsible for freeing the string.
   451  * @return a newly allocated string, or NULL of the keycode is unresolvable.
   452  */
   453 gchar *input_keycode_to_keysym( input_driver_t driver, uint16_t keycode );
   455 typedef void (*display_keysym_callback_t)( void *data, const gchar *keysym );
   457 /**
   458  * Set the keysym hook function (normally used by the UI to receive non-UI
   459  * input events during configuration.
   460  */
   461 void input_set_keysym_hook( display_keysym_callback_t hook, void *data );
   465 #ifdef __cplusplus
   466 }
   467 #endif
   468 #endif /* !lxdream_display_H */
.