Search
lxdream.org :: lxdream/src/display.h
lxdream 0.9.1
released Jun 29
Download Now
filename src/display.h
changeset 1251:b8ab59d39756
prev1245:01e0020adf88
next1256:a9d29fe74bf3
author nkeynes
date Sat Mar 03 16:11:28 2012 +1000 (10 years ago)
permissions -rw-r--r--
last change Support depth component 16 as well as 24 (add capability flag for the available bits)
Put remaining TODOs inside HAVE_OPENGL_FIXEDFUNC blocks
Add swap-buffer calls for EGL (does not appear to support rendering directly
to front-buffer)
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 #if HAVE_GLES2
    36 #include <GLES2/gl2.h>
    37 #include <GLES2/gl2ext.h>
    38 #else
    39 #include <GL/gl.h>
    40 #include <GL/glext.h>
    41 #endif
    42 #endif
    44 #ifdef __cplusplus
    45 extern "C" {
    46 #endif
    48 /**
    49  * Supported colour formats. Note that BGRA4444 is only ever used for texture
    50  * rendering (it's not valid for display purposes).
    51  */
    52 #define COLFMT_BGRA1555  0
    53 #define COLFMT_RGB565    1
    54 #define COLFMT_BGRA4444  2
    55 #define COLFMT_YUV422    3 /* 8-bit YUV (texture source only) */
    56 #define COLFMT_BGR888    4 /* 24-bit BGR */
    57 #define COLFMT_BGRA8888  5
    58 #define COLFMT_INDEX4    6 /* 4 bit indexed colour (texture source only) */
    59 #define COLFMT_INDEX8    7 /* 8-bit indexed colour (texture source only) */
    60 #define COLFMT_BGR0888   8 /* 32-bit BGR */
    61 #define COLFMT_RGB888    9 /* 24-bit RGB (ie GL native) */
    63 /**
    64  * The standard display size (for the purposes of mouse inputs, etc, is 640x480 -
    65  * events should be adjusted accordingly if this is not the actual window size.
    66  */ 
    67 #define DISPLAY_WIDTH 640
    68 #define DISPLAY_HEIGHT 480
    70 struct colour_format {
    71     GLint type, format, int_format;
    72     int bpp;
    73 };
    74 extern struct colour_format colour_formats[];
    76 extern int colour_format_bytes[];
    78 /**
    79  * Structure to hold pixel data held in GL buffers.
    80  */
    81 struct render_buffer {
    82     uint32_t width;
    83     uint32_t height;
    84     uint32_t rowstride;
    85     uint32_t colour_format;
    86     sh4addr_t address; /* Address buffer was rendered to, or -1 for unrendered */
    87     uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */
    88     gboolean inverted;/* True if the buffer is upside down */
    89     uint32_t scale;
    90     GLuint tex_id;    /* texture bound to render buffer, if any (0 = none). 
    91                        * The render buffer does not own the texture */
    92     unsigned int buf_id; /* driver-specific buffer id, if applicable */
    93     gboolean flushed; /* True if the buffer has been flushed to vram */
    94 };
    96 /**
    97  * Structure to hold pixel data stored in pvr2 vram, as opposed to data in
    98  * GL buffers.
    99  */
   100 struct frame_buffer {
   101     uint32_t width;
   102     uint32_t height;
   103     uint32_t rowstride;
   104     uint32_t colour_format;
   105     sh4addr_t address;
   106     uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */
   107     gboolean inverted;/* True if the buffer is upside down */
   108     unsigned char *data;
   109 };
   111 struct display_capabilities {
   112     gboolean has_gl;
   113     int depth_bits;
   114     int stencil_bits; /* 0 = no stencil buffer */
   115 };
   117 struct vertex_buffer {
   118     /**
   119      * Map the buffer into the host address space (if necessary) in preparation
   120      * for filling the buffer. This also implies a fence operation.
   121      * @param buf previously allocated buffer
   122      * @param size number of bytes of the buffer actually to be used. The buffer
   123      * will be resized if necessary.
   124      * @return a pointer to the start of the buffer.
   125      */
   126     void *(*map)(vertex_buffer_t buf, uint32_t size);
   128     /**
   129      * Unmap the buffer, after the vertex data is written.
   130      * @return the buffer base to use for gl*Pointer calls
   131      */
   132     void *(*unmap)(vertex_buffer_t buf);
   134     /**
   135      * Mark the buffer as finished, indicating that the vertex data is no
   136      * longer required (ie rendering is complete).
   137      */
   138     void (*finished)(vertex_buffer_t buf);
   140     /**
   141      * Delete the buffer and all associated resources.
   142      */
   143     void (*destroy)(vertex_buffer_t buf);
   145     /* Private data */
   146     void *data;
   147     GLuint id;
   148     uint32_t capacity;
   149     uint32_t mapped_size;
   150     GLuint fence;
   151 };
   154 /**
   155  * Core video driver - exports function to setup a GL context, as well as handle
   156  * keyboard input and display resultant output.
   157  */
   158 typedef struct display_driver {
   159     char *name;
   160     /**
   161      * Short (<60 chars) description of the driver. This should be marked for
   162      * localization.
   163      */
   164     char *description;
   165     /**
   166      * Initialize the driver. This is called only once at startup time, and
   167      * is guaranteed to be called before any other methods.
   168      * @return TRUE if the driver was successfully initialized, otherwise
   169      * FALSE.
   170      */
   171     gboolean (*init_driver)(void);
   173     /**
   174      * Cleanly shutdown the driver. Normally only called at system shutdown
   175      * time.
   176      */
   177     void (*shutdown_driver)(void);
   179     /**
   180      * Given a particular keysym, return the keycode associated with it.
   181      * @param keysym The keysym to be resolved, ie "Tab"
   182      * @return the display-specific keycode, or 0 if the keysym cannot
   183      * be resolved.
   184      */
   185     uint16_t (*resolve_keysym)( const gchar *keysym );
   187     /**
   188      * Given a native system keycode, convert it to a dreamcast keyboard code.
   189      */
   190     uint16_t (*convert_to_dckeysym)( uint16_t keycode );
   192     /**
   193      * Given a device-specific event code, return the corresponding keysym.
   194      * The string should be newly allocated (caller will free)
   195      */
   196     gchar *(*get_keysym_for_keycode)( uint16_t keycode );
   198     /**
   199      * Create a render target with the given width and height. If a texture ID
   200      * is supplied (non-zero), the render buffer writes its output to that texture.
   201      * @param tex_id 0 or a valid GL texture name which must have been initialized to
   202      * the correct dimensions. 
   203      */
   204     render_buffer_t (*create_render_buffer)( uint32_t width, uint32_t height, GLuint tex_id );
   206     /**
   207      * Destroy the specified render buffer and release any associated
   208      * resources.
   209      */
   210     void (*destroy_render_buffer)( render_buffer_t buffer );
   212     /**
   213      * Set the current rendering target to the specified buffer.
   214      */
   215     gboolean (*set_render_target)( render_buffer_t buffer );
   217     /**
   218      * Complete rendering and clear the current rendering target. If the 
   219      * buffer has a bound texture, it will be updated if necessary.
   220      */
   221     void (*finish_render)( render_buffer_t buffer );
   223     /**
   224      * Load the supplied frame buffer into the given render buffer.
   225      * Included here to allow driver-specific optimizations.
   226      */
   227     void (*load_frame_buffer)( frame_buffer_t frame, render_buffer_t render );
   229     /**
   230      * Display a single frame using a previously rendered GL buffer.
   231      */
   232     void (*display_render_buffer)( render_buffer_t buffer );
   234     /**
   235      * Display a single blanked frame using a fixed colour for the
   236      * entire frame (specified in BGR888 format). 
   237      */
   238     void (*display_blank)( uint32_t rgb );
   240     /**
   241      * Swap front/back window buffers
   242      */
   243     void (*swap_buffers)();
   245     /**
   246      * Copy the image data from the GL buffer to the target memory buffer,
   247      * using the format etc from the buffer. This may force a glFinish()
   248      * but does not invalidate the buffer.
   249      * @param target buffer to fill with image data, which must be large enough
   250      *  to accomodate the image.
   251      * @param buffer Render buffer to read from.
   252      * @param rowstride rowstride of the target data
   253      * @param format colour format to output the data in.
   254      */
   255     gboolean (*read_render_buffer)( unsigned char *target, render_buffer_t buffer,
   256             int rowstride, int format );
   258     /**
   259      * Create a new vertex buffer
   260      */
   261     vertex_buffer_t (*create_vertex_buffer)( );
   263     /**
   264      * Dump driver-specific information about the implementation to the given stream
   265      */
   266     void (*print_info)( FILE *out );
   268     struct display_capabilities capabilities;
   270 } *display_driver_t;
   272 /**
   273  * Print the configured video drivers to the output stream, one to a line.
   274  */
   275 void print_display_drivers( FILE *out );
   276 display_driver_t get_display_driver_by_name( const char *name );
   277 gboolean display_set_driver( display_driver_t driver );
   279 extern uint32_t pvr2_frame_counter;
   281 extern display_driver_t display_driver;
   283 extern struct display_driver display_gtk_driver;
   284 extern struct display_driver display_osx_driver;
   285 extern struct display_driver display_gl_driver;
   286 extern struct display_driver display_egl_driver;
   287 extern struct display_driver display_null_driver;
   289 /****************** Input methods **********************/
   291 #define MAX_MOUSE_BUTTONS 32
   293 /* Pressure is 0..127  (allowing a joystick to be defined as two half-axes of 7- bits each) */
   294 #define MAX_PRESSURE 0x7F
   296 typedef key_binding_t input_key_callback_t;
   298 /**
   299  * Callback to receive mouse input events
   300  * @param data pointer passed in at the time the hook was registered
   301  * @param buttons bitmask of button states, where bit 0 is button 0 (left), bit 1 is button
   302  * 1 (middle), bit 2 is button 2 (right) and so forth.
   303  * @param x Horizontal movement since the last invocation (in relative mode) or window position 
   304  * (in absolute mode).
   305  * @param y Vertical movement since the last invocation (in relative mode) or window position
   306  * (in absolute mode).
   307  * @param absolute If TRUE, x and y are the current window coordinates 
   308  *  of the mouse cursor. Otherwise, x and y are deltas from the previous mouse position.
   309  */
   310 typedef void (*input_mouse_callback_t)( void *data, uint32_t buttons, int32_t x, int32_t y, gboolean absolute );
   312 gboolean input_register_key( const gchar *keysym, input_key_callback_t callback,
   313                              void *data, uint32_t value );
   315 void input_unregister_key( const gchar *keysym, input_key_callback_t callback,
   316                            void *data, uint32_t value );
   318 gboolean input_register_keygroup( lxdream_config_group_t group );
   319 void input_unregister_keygroup( lxdream_config_group_t group );
   320 gboolean input_keygroup_changed( void *data, lxdream_config_group_t group, unsigned key,
   321                              const gchar *oldval, const gchar *newval );
   323 /**
   324  * Register a hook to receive all keyboard input events
   325  */
   326 gboolean input_register_keyboard_hook( input_key_callback_t callback, void *data );
   327 void input_unregister_keyboard_hook( input_key_callback_t callback, void *data );
   329 /**
   330  * Register a mouse event hook.
   331  * @param relative TRUE if the caller wants relative mouse movement, FALSE for
   332  * absolute mouse positioning. It's not generally possible to receive both at the same time.
   333  */
   334 gboolean input_register_mouse_hook( gboolean relative, input_mouse_callback_t callback, void *data );
   335 void input_unregister_mouse_hook( input_mouse_callback_t callback, void *data );
   337 gboolean input_is_key_valid( const gchar *keysym );
   339 gboolean input_is_key_registered( const gchar *keysym );
   341 uint16_t input_keycode_to_dckeysym( uint16_t keycode );
   343 /********************** Display/Input methods ***********************/
   345 /**
   346  * Auxilliary input driver - provides input separate to and in addition to the
   347  * core UI/display. (primarily used for joystick devices)
   348  */
   349 typedef struct input_driver {
   350     const char *id; /* Short identifier to display in the UI for the device (eg "JS0" ) */
   352     /**
   353      * Given a particular keysym, return the keycode associated with it.
   354      * @param keysym The keysym to be resolved, ie "Tab"
   355      * @return the display-specific keycode, or 0 if the keysym cannot
   356      * be resolved.
   357      */
   358     uint16_t (*resolve_keysym)( struct input_driver *driver, const gchar *keysym );
   360     /**
   361      * Given a device-specific event code, convert it to a dreamcast keyboard code.
   362      * This is only required for actual keyboard devices, other devices should just
   363      * leave this method NULL.
   364      */
   365     uint16_t (*convert_to_dckeysym)( struct input_driver *driver, uint16_t keycode );
   367     /**
   368      * Given a device-specific event code, return the corresponding keysym.
   369      * The string should be newly allocated (caller will free)
   370      */
   371     gchar *(*get_keysym_for_keycode)( struct input_driver *driver, uint16_t keycode );
   373     /**
   374      * Destroy the input driver.
   375      */
   376     void (*destroy)( struct input_driver *driver );
   378 } *input_driver_t;       
   380 extern struct input_driver system_mouse_driver;
   382 /**
   383  * Register a new input driver (which must have a unique name)
   384  * @param driver the driver to register
   385  * @param max_keycode the highest possible keycode reported by the device
   386  * @return TRUE on success, FALSE on failure (eg driver already registed).
   387  */
   388 gboolean input_register_device( input_driver_t driver, uint16_t max_keycode );
   390 /**
   391  * Determine if the system has an input driver with the given unique ID.
   392  * @param id driver id to check
   393  * @return TRUE if the device exists, otherwise FALSE
   394  */
   395 gboolean input_has_device( const gchar *id );
   397 /**
   398  * Unregister an input driver.
   399  * @param driver the driver to unregister
   400  * If the driver is not in fact registered, this function has no effect.
   401  */
   402 void input_unregister_device( input_driver_t driver );
   404 /**
   405  * Called from the UI to indicate that the emulation window is focused (ie
   406  * able to receive input). This method is used to gate non-UI input devices -
   407  * when the display is not focused, all input events will be silently ignored.
   408  */
   409 void display_set_focused( gboolean has_focus );
   411 /**
   412  * Fire a keydown event on the specified device
   413  * @param input The input device source generating the event, or NULL for the 
   414  *        default GUI device
   415  * @param keycode The device-specific keycode
   416  * @param pressure The pressure of the key (0 to 127), where 0 is unpressed and
   417  *        127 is maximum pressure. Devices without pressure sensitivity should 
   418  *        always use MAX_PRESSURE (127) 
   419  */
   420 void input_event_keydown( input_driver_t input, uint16_t keycode, uint32_t pressure );
   422 void input_event_keyup( input_driver_t input, uint16_t keycode );
   424 /**
   425  * Receive an input mouse down event. Normally these should be absolute events when
   426  * the mouse is not grabbed, and relative when it is.
   427  * @param button the button pressed, where 0 == first button
   428  * @param x_axis The relative or absolute position of the mouse cursor on the X axis
   429  * @param y_axis The relative or absolute position of the mouse cursor on the Y axis
   430  * @param absolute If TRUE, x_axis and y_axis are the current window coordinates 
   431  *  of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position.
   432  */
   433 void input_event_mousedown( uint16_t button, int32_t x_axis, int32_t y_axis, gboolean absolute );
   435 /**
   436  * Receive an input mouse up event. Normally these should be absolute events when
   437  * the mouse is not grabbed, and relative when it is.
   438  * @param button the button released, where 0 == first button
   439  * @param x_axis The relative or absolute position of the mouse cursor on the X axis
   440  * @param y_axis The relative or absolute position of the mouse cursor on the Y axis
   441  * @param absolute If TRUE, x_axis and y_axis are the current window coordinates 
   442  *  of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position.
   443  */
   444 void input_event_mouseup( uint16_t button, int32_t x_axis, int32_t y_axis, gboolean absolute );
   446 /**
   447  * Receive an input mouse motion event. Normally these should be absolute events when
   448  * the mouse is not grabbed, and relative when it is.
   449  * @param x_axis The relative or absolute position of the mouse cursor on the X axis
   450  * @param y_axis The relative or absolute position of the mouse cursor on the Y axis
   451  * @param absolute If TRUE, x_axis and y_axis are the current window coordinates 
   452  *  of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position.
   453  */
   454 void input_event_mousemove( int32_t x_axis, int32_t y_axis, gboolean absolute );
   456 /**
   457  * Given a keycode and the originating input driver, return the corresponding 
   458  * keysym. The caller is responsible for freeing the string.
   459  * @return a newly allocated string, or NULL of the keycode is unresolvable.
   460  */
   461 gchar *input_keycode_to_keysym( input_driver_t driver, uint16_t keycode );
   463 typedef void (*display_keysym_callback_t)( void *data, const gchar *keysym );
   465 /**
   466  * Set the keysym hook function (normally used by the UI to receive non-UI
   467  * input events during configuration.
   468  */
   469 void input_set_keysym_hook( display_keysym_callback_t hook, void *data );
   473 #ifdef __cplusplus
   474 }
   475 #endif
   476 #endif /* !lxdream_display_H */
.