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