Search
lxdream.org :: lxdream/src/display.h
lxdream 0.9.1
released Jun 29
Download Now
filename src/display.h
changeset 1010:a506a2f66180
prev863:a5e5310061e2
next1072:d82e04e6d497
author nkeynes
date Sun Apr 12 02:04:27 2009 +0000 (11 years ago)
permissions -rw-r--r--
last change Fix analogue joystick input
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 #ifdef APPLE_BUILD
    31 #include <OpenGL/gl.h>
    32 #include <OpenGL/glext.h>
    33 #else
    34 #include <GL/gl.h>
    35 #include <GL/glext.h>
    36 #endif
    38 #ifdef __cplusplus
    39 extern "C" {
    40 #endif
    42 /**
    43  * Supported colour formats. Note that BGRA4444 is only ever used for texture
    44  * rendering (it's not valid for display purposes).
    45  */
    46 #define COLFMT_BGRA1555  0
    47 #define COLFMT_RGB565    1
    48 #define COLFMT_BGRA4444  2
    49 #define COLFMT_YUV422    3 /* 8-bit YUV (texture source only) */
    50 #define COLFMT_BGR888    4 /* 24-bit BGR */
    51 #define COLFMT_BGRA8888  5
    52 #define COLFMT_INDEX4    6 /* 4 bit indexed colour (texture source only) */
    53 #define COLFMT_INDEX8    7 /* 8-bit indexed colour (texture source only) */
    54 #define COLFMT_BGR0888   8 /* 32-bit BGR */
    55 #define COLFMT_RGB888    9 /* 24-bit RGB (ie GL native) */
    57 /**
    58  * The standard display size (for the purposes of mouse inputs, etc, is 640x480 -
    59  * events should be adjusted accordingly if this is not the actual window size.
    60  */ 
    61 #define DISPLAY_WIDTH 640
    62 #define DISPLAY_HEIGHT 480
    64 struct colour_format {
    65     GLint type, format, int_format;
    66     int bpp;
    67 };
    68 extern struct colour_format colour_formats[];
    70 extern int colour_format_bytes[];
    72 /**
    73  * Structure to hold pixel data held in GL buffers.
    74  */
    75 struct render_buffer {
    76     uint32_t width;
    77     uint32_t height;
    78     uint32_t rowstride;
    79     uint32_t colour_format;
    80     sh4addr_t address; /* Address buffer was rendered to, or -1 for unrendered */
    81     uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */
    82     gboolean inverted;/* True if the buffer is upside down */
    83     uint32_t scale;
    84     GLuint tex_id;    /* texture bound to render buffer, if any (0 = none). 
    85                        * The render buffer does not own the texture */
    86     unsigned int buf_id; /* driver-specific buffer id, if applicable */
    87     gboolean flushed; /* True if the buffer has been flushed to vram */
    88 };
    90 /**
    91  * Structure to hold pixel data stored in pvr2 vram, as opposed to data in
    92  * GL buffers.
    93  */
    94 struct frame_buffer {
    95     uint32_t width;
    96     uint32_t height;
    97     uint32_t rowstride;
    98     uint32_t colour_format;
    99     sh4addr_t address;
   100     uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */
   101     gboolean inverted;/* True if the buffer is upside down */
   102     unsigned char *data;
   103 };
   105 struct display_capabilities {
   106     int stencil_bits; /* 0 = no stencil buffer */
   107 };
   109 /**
   110  * Core video driver - exports function to setup a GL context, as well as handle
   111  * keyboard input and display resultant output.
   112  */
   113 typedef struct display_driver {
   114     char *name;
   115     /**
   116      * Short (<60 chars) description of the driver. This should be marked for
   117      * localization.
   118      */
   119     char *description;
   120     /**
   121      * Initialize the driver. This is called only once at startup time, and
   122      * is guaranteed to be called before any other methods.
   123      * @return TRUE if the driver was successfully initialized, otherwise
   124      * FALSE.
   125      */
   126     gboolean (*init_driver)(void);
   128     /**
   129      * Cleanly shutdown the driver. Normally only called at system shutdown
   130      * time.
   131      */
   132     void (*shutdown_driver)(void);
   134     /**
   135      * Given a particular keysym, return the keycode associated with it.
   136      * @param keysym The keysym to be resolved, ie "Tab"
   137      * @return the display-specific keycode, or 0 if the keysym cannot
   138      * be resolved.
   139      */
   140     uint16_t (*resolve_keysym)( const gchar *keysym );
   142     /**
   143      * Given a native system keycode, convert it to a dreamcast keyboard code.
   144      */
   145     uint16_t (*convert_to_dckeysym)( uint16_t keycode );
   147     /**
   148      * Given a device-specific event code, return the corresponding keysym.
   149      * The string should be newly allocated (caller will free)
   150      */
   151     gchar *(*get_keysym_for_keycode)( uint16_t keycode );
   153     /**
   154      * Create a render target with the given width and height. If a texture ID
   155      * is supplied (non-zero), the render buffer writes its output to that texture.
   156      * @param tex_id 0 or a valid GL texture name which must have been initialized to
   157      * the correct dimensions. 
   158      */
   159     render_buffer_t (*create_render_buffer)( uint32_t width, uint32_t height, GLuint tex_id );
   161     /**
   162      * Destroy the specified render buffer and release any associated
   163      * resources.
   164      */
   165     void (*destroy_render_buffer)( render_buffer_t buffer );
   167     /**
   168      * Set the current rendering target to the specified buffer.
   169      */
   170     gboolean (*set_render_target)( render_buffer_t buffer );
   172     /**
   173      * Complete rendering and clear the current rendering target. If the 
   174      * buffer has a bound texture, it will be updated if necessary.
   175      */
   176     void (*finish_render)( render_buffer_t buffer );
   178     /**
   179      * Load the supplied frame buffer into the given render buffer.
   180      * Included here to allow driver-specific optimizations.
   181      */
   182     void (*load_frame_buffer)( frame_buffer_t frame, render_buffer_t render );
   184     /**
   185      * Display a single frame using a previously rendered GL buffer.
   186      */
   187     void (*display_render_buffer)( render_buffer_t buffer );
   189     /**
   190      * Display a single blanked frame using a fixed colour for the
   191      * entire frame (specified in BGR888 format). 
   192      */
   193     void (*display_blank)( uint32_t rgb );
   195     /**
   196      * Copy the image data from the GL buffer to the target memory buffer,
   197      * using the format etc from the buffer. This may force a glFinish()
   198      * but does not invalidate the buffer.
   199      * @param target buffer to fill with image data, which must be large enough
   200      *  to accomodate the image.
   201      * @param buffer Render buffer to read from.
   202      * @param rowstride rowstride of the target data
   203      * @param format colour format to output the data in.
   204      */
   205     gboolean (*read_render_buffer)( unsigned char *target, render_buffer_t buffer,
   206             int rowstride, int format );
   208     struct display_capabilities capabilities;
   209 } *display_driver_t;
   211 /**
   212  * Print the configured video drivers to the output stream, one to a line.
   213  */
   214 void print_display_drivers( FILE *out );
   215 display_driver_t get_display_driver_by_name( const char *name );
   216 gboolean display_set_driver( display_driver_t driver );
   218 extern uint32_t pvr2_frame_counter;
   220 extern display_driver_t display_driver;
   222 extern struct display_driver display_gtk_driver;
   223 extern struct display_driver display_osx_driver;
   224 extern struct display_driver display_null_driver;
   226 /****************** Input methods **********************/
   228 #define MAX_MOUSE_BUTTONS 32
   230 /* Pressure is 0..127  (allowing a joystick to be defined as two half-axes of 7- bits each) */
   231 #define MAX_PRESSURE 0x7F
   233 typedef void (*input_key_callback_t)( void *data, uint32_t value, uint32_t pressure, gboolean isKeyDown );
   235 /**
   236  * Callback to receive mouse input events
   237  * @param data pointer passed in at the time the hook was registered
   238  * @param buttons bitmask of button states, where bit 0 is button 0 (left), bit 1 is button
   239  * 1 (middle), bit 2 is button 2 (right) and so forth.
   240  * @param x Horizontal movement since the last invocation (in relative mode) or window position 
   241  * (in absolute mode).
   242  * @param y Vertical movement since the last invocation (in relative mode) or window position
   243  * (in absolute mode).
   244  * @param absolute If TRUE, x and y are the current window coordinates 
   245  *  of the mouse cursor. Otherwise, x and y are deltas from the previous mouse position.
   246  */
   247 typedef void (*input_mouse_callback_t)( void *data, uint32_t buttons, int32_t x, int32_t y, gboolean absolute );
   249 gboolean input_register_key( const gchar *keysym, input_key_callback_t callback,
   250                              void *data, uint32_t value );
   252 void input_unregister_key( const gchar *keysym, input_key_callback_t callback,
   253                            void *data, uint32_t value );
   255 /**
   256  * Register a hook to receive all keyboard input events
   257  */
   258 gboolean input_register_keyboard_hook( input_key_callback_t callback, void *data );
   259 void input_unregister_keyboard_hook( input_key_callback_t callback, void *data );
   261 /**
   262  * Register a mouse event hook.
   263  * @param relative TRUE if the caller wants relative mouse movement, FALSE for
   264  * absolute mouse positioning. It's not generally possible to receive both at the same time.
   265  */
   266 gboolean input_register_mouse_hook( gboolean relative, input_mouse_callback_t callback, void *data );
   267 void input_unregister_mouse_hook( input_mouse_callback_t callback, void *data );
   269 gboolean input_is_key_valid( const gchar *keysym );
   271 gboolean input_is_key_registered( const gchar *keysym );
   273 uint16_t input_keycode_to_dckeysym( uint16_t keycode );
   275 /********************** Display/Input methods ***********************/
   277 /**
   278  * Auxilliary input driver - provides input separate to and in addition to the
   279  * core UI/display. (primarily used for joystick devices)
   280  */
   281 typedef struct input_driver {
   282     const char *id; /* Short identifier to display in the UI for the device (eg "JS0" ) */
   284     /**
   285      * Given a particular keysym, return the keycode associated with it.
   286      * @param keysym The keysym to be resolved, ie "Tab"
   287      * @return the display-specific keycode, or 0 if the keysym cannot
   288      * be resolved.
   289      */
   290     uint16_t (*resolve_keysym)( struct input_driver *driver, const gchar *keysym );
   292     /**
   293      * Given a device-specific event code, convert it to a dreamcast keyboard code.
   294      * This is only required for actual keyboard devices, other devices should just
   295      * leave this method NULL.
   296      */
   297     uint16_t (*convert_to_dckeysym)( struct input_driver *driver, uint16_t keycode );
   299     /**
   300      * Given a device-specific event code, return the corresponding keysym.
   301      * The string should be newly allocated (caller will free)
   302      */
   303     gchar *(*get_keysym_for_keycode)( struct input_driver *driver, uint16_t keycode );
   305     /**
   306      * Destroy the input driver.
   307      */
   308     void (*destroy)( struct input_driver *driver );
   310 } *input_driver_t;       
   312 extern struct input_driver system_mouse_driver;
   314 /**
   315  * Register a new input driver (which must have a unique name)
   316  * @param driver the driver to register
   317  * @param max_keycode the highest possible keycode reported by the device
   318  * @return TRUE on success, FALSE on failure (eg driver already registed).
   319  */
   320 gboolean input_register_device( input_driver_t driver, uint16_t max_keycode );
   322 /**
   323  * Determine if the system has an input driver with the given unique ID.
   324  * @param id driver id to check
   325  * @return TRUE if the device exists, otherwise FALSE
   326  */
   327 gboolean input_has_device( const gchar *id );
   329 /**
   330  * Unregister an input driver.
   331  * @param driver the driver to unregister
   332  * If the driver is not in fact registered, this function has no effect.
   333  */
   334 void input_unregister_device( input_driver_t driver );
   336 /**
   337  * Called from the UI to indicate that the emulation window is focused (ie
   338  * able to receive input). This method is used to gate non-UI input devices -
   339  * when the display is not focused, all input events will be silently ignored.
   340  */
   341 void display_set_focused( gboolean has_focus );
   343 /**
   344  * Fire a keydown event on the specified device
   345  * @param input The input device source generating the event, or NULL for the 
   346  *        default GUI device
   347  * @param keycode The device-specific keycode
   348  * @param pressure The pressure of the key (0 to 127), where 0 is unpressed and
   349  *        127 is maximum pressure. Devices without pressure sensitivity should 
   350  *        always use MAX_PRESSURE (127) 
   351  */
   352 void input_event_keydown( input_driver_t input, uint16_t keycode, uint32_t pressure );
   354 void input_event_keyup( input_driver_t input, uint16_t keycode );
   356 /**
   357  * Receive an input mouse down event. Normally these should be absolute events when
   358  * the mouse is not grabbed, and relative when it is.
   359  * @param button the button pressed, where 0 == first button
   360  * @param x_axis The relative or absolute position of the mouse cursor on the X axis
   361  * @param y_axis The relative or absolute position of the mouse cursor on the Y axis
   362  * @param absolute If TRUE, x_axis and y_axis are the current window coordinates 
   363  *  of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position.
   364  */
   365 void input_event_mousedown( uint16_t button, int32_t x_axis, int32_t y_axis, gboolean absolute );
   367 /**
   368  * Receive an input mouse up event. Normally these should be absolute events when
   369  * the mouse is not grabbed, and relative when it is.
   370  * @param button the button released, where 0 == first button
   371  * @param x_axis The relative or absolute position of the mouse cursor on the X axis
   372  * @param y_axis The relative or absolute position of the mouse cursor on the Y axis
   373  * @param absolute If TRUE, x_axis and y_axis are the current window coordinates 
   374  *  of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position.
   375  */
   376 void input_event_mouseup( uint16_t button, int32_t x_axis, int32_t y_axis, gboolean absolute );
   378 /**
   379  * Receive an input mouse motion event. Normally these should be absolute events when
   380  * the mouse is not grabbed, and relative when it is.
   381  * @param x_axis The relative or absolute position of the mouse cursor on the X axis
   382  * @param y_axis The relative or absolute position of the mouse cursor on the Y axis
   383  * @param absolute If TRUE, x_axis and y_axis are the current window coordinates 
   384  *  of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position.
   385  */
   386 void input_event_mousemove( int32_t x_axis, int32_t y_axis, gboolean absolute );
   388 /**
   389  * Given a keycode and the originating input driver, return the corresponding 
   390  * keysym. The caller is responsible for freeing the string.
   391  * @return a newly allocated string, or NULL of the keycode is unresolvable.
   392  */
   393 gchar *input_keycode_to_keysym( input_driver_t driver, uint16_t keycode );
   395 typedef void (*display_keysym_callback_t)( void *data, const gchar *keysym );
   397 /**
   398  * Set the keysym hook function (normally used by the UI to receive non-UI
   399  * input events during configuration.
   400  */
   401 void input_set_keysym_hook( display_keysym_callback_t hook, void *data );
   405 #ifdef __cplusplus
   406 }
   407 #endif
   408 #endif /* !lxdream_display_H */
.