nkeynes@144 | 1 | /**
|
nkeynes@561 | 2 | * $Id$
|
nkeynes@144 | 3 | *
|
nkeynes@144 | 4 | * The PC side of the video support (responsible for actually displaying /
|
nkeynes@144 | 5 | * rendering frames)
|
nkeynes@144 | 6 | *
|
nkeynes@144 | 7 | * Copyright (c) 2005 Nathan Keynes.
|
nkeynes@144 | 8 | *
|
nkeynes@144 | 9 | * This program is free software; you can redistribute it and/or modify
|
nkeynes@144 | 10 | * it under the terms of the GNU General Public License as published by
|
nkeynes@144 | 11 | * the Free Software Foundation; either version 2 of the License, or
|
nkeynes@144 | 12 | * (at your option) any later version.
|
nkeynes@144 | 13 | *
|
nkeynes@144 | 14 | * This program is distributed in the hope that it will be useful,
|
nkeynes@144 | 15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
nkeynes@144 | 16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
nkeynes@144 | 17 | * GNU General Public License for more details.
|
nkeynes@144 | 18 | */
|
nkeynes@144 | 19 |
|
nkeynes@736 | 20 | #ifndef lxdream_display_H
|
nkeynes@736 | 21 | #define lxdream_display_H 1
|
nkeynes@144 | 22 |
|
nkeynes@669 | 23 | #define GL_GLEXT_PROTOTYPES 1
|
nkeynes@669 | 24 |
|
nkeynes@144 | 25 | #include <stdint.h>
|
nkeynes@700 | 26 | #include <stdio.h>
|
nkeynes@144 | 27 | #include <glib.h>
|
nkeynes@540 | 28 | #include "lxdream.h"
|
nkeynes@755 | 29 | #include "gettext.h"
|
nkeynes@540 | 30 | #ifdef APPLE_BUILD
|
nkeynes@540 | 31 | #include <OpenGL/gl.h>
|
nkeynes@540 | 32 | #include <OpenGL/glext.h>
|
nkeynes@540 | 33 | #else
|
nkeynes@327 | 34 | #include <GL/gl.h>
|
nkeynes@540 | 35 | #include <GL/glext.h>
|
nkeynes@540 | 36 | #endif
|
nkeynes@144 | 37 |
|
nkeynes@144 | 38 | #ifdef __cplusplus
|
nkeynes@144 | 39 | extern "C" {
|
nkeynes@144 | 40 | #endif
|
nkeynes@144 | 41 |
|
nkeynes@144 | 42 | /**
|
nkeynes@477 | 43 | * Supported colour formats. Note that BGRA4444 is only ever used for texture
|
nkeynes@144 | 44 | * rendering (it's not valid for display purposes).
|
nkeynes@144 | 45 | */
|
nkeynes@477 | 46 | #define COLFMT_BGRA1555 0
|
nkeynes@144 | 47 | #define COLFMT_RGB565 1
|
nkeynes@477 | 48 | #define COLFMT_BGRA4444 2
|
nkeynes@144 | 49 | #define COLFMT_YUV422 3 /* 8-bit YUV (texture source only) */
|
nkeynes@477 | 50 | #define COLFMT_BGR888 4 /* 24-bit BGR */
|
nkeynes@477 | 51 | #define COLFMT_BGRA8888 5
|
nkeynes@144 | 52 | #define COLFMT_INDEX4 6 /* 4 bit indexed colour (texture source only) */
|
nkeynes@144 | 53 | #define COLFMT_INDEX8 7 /* 8-bit indexed colour (texture source only) */
|
nkeynes@477 | 54 | #define COLFMT_BGR0888 8 /* 32-bit BGR */
|
nkeynes@477 | 55 | #define COLFMT_RGB888 9 /* 24-bit RGB (ie GL native) */
|
nkeynes@327 | 56 |
|
nkeynes@327 | 57 | struct colour_format {
|
nkeynes@327 | 58 | GLint type, format, int_format;
|
nkeynes@327 | 59 | int bpp;
|
nkeynes@327 | 60 | };
|
nkeynes@327 | 61 | extern struct colour_format colour_formats[];
|
nkeynes@144 | 62 |
|
nkeynes@162 | 63 | extern int colour_format_bytes[];
|
nkeynes@162 | 64 |
|
nkeynes@352 | 65 | /**
|
nkeynes@352 | 66 | * Structure to hold pixel data held in GL buffers.
|
nkeynes@352 | 67 | */
|
nkeynes@477 | 68 | struct render_buffer {
|
nkeynes@352 | 69 | uint32_t width;
|
nkeynes@352 | 70 | uint32_t height;
|
nkeynes@144 | 71 | uint32_t rowstride;
|
nkeynes@674 | 72 | uint32_t colour_format;
|
nkeynes@352 | 73 | sh4addr_t address; /* Address buffer was rendered to, or -1 for unrendered */
|
nkeynes@352 | 74 | uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */
|
nkeynes@477 | 75 | gboolean inverted;/* True if the buffer is upside down */
|
nkeynes@674 | 76 | uint32_t scale;
|
nkeynes@805 | 77 | GLuint tex_id; /* texture bound to render buffer, if any (0 = none).
|
nkeynes@805 | 78 | * The render buffer does not own the texture */
|
nkeynes@424 | 79 | unsigned int buf_id; /* driver-specific buffer id, if applicable */
|
nkeynes@352 | 80 | gboolean flushed; /* True if the buffer has been flushed to vram */
|
nkeynes@477 | 81 | };
|
nkeynes@144 | 82 |
|
nkeynes@144 | 83 | /**
|
nkeynes@352 | 84 | * Structure to hold pixel data stored in pvr2 vram, as opposed to data in
|
nkeynes@352 | 85 | * GL buffers.
|
nkeynes@352 | 86 | */
|
nkeynes@477 | 87 | struct frame_buffer {
|
nkeynes@352 | 88 | uint32_t width;
|
nkeynes@352 | 89 | uint32_t height;
|
nkeynes@352 | 90 | uint32_t rowstride;
|
nkeynes@674 | 91 | uint32_t colour_format;
|
nkeynes@352 | 92 | sh4addr_t address;
|
nkeynes@352 | 93 | uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */
|
nkeynes@477 | 94 | gboolean inverted;/* True if the buffer is upside down */
|
nkeynes@502 | 95 | unsigned char *data;
|
nkeynes@477 | 96 | };
|
nkeynes@352 | 97 |
|
nkeynes@352 | 98 | /**
|
nkeynes@352 | 99 | * Core video driver - exports function to setup a GL context, as well as handle
|
nkeynes@352 | 100 | * keyboard input and display resultant output.
|
nkeynes@144 | 101 | */
|
nkeynes@144 | 102 | typedef struct display_driver {
|
nkeynes@144 | 103 | char *name;
|
nkeynes@144 | 104 | /**
|
nkeynes@700 | 105 | * Short (<60 chars) description of the driver. This should be marked for
|
nkeynes@700 | 106 | * localization.
|
nkeynes@700 | 107 | */
|
nkeynes@700 | 108 | char *description;
|
nkeynes@700 | 109 | /**
|
nkeynes@144 | 110 | * Initialize the driver. This is called only once at startup time, and
|
nkeynes@144 | 111 | * is guaranteed to be called before any other methods.
|
nkeynes@144 | 112 | * @return TRUE if the driver was successfully initialized, otherwise
|
nkeynes@144 | 113 | * FALSE.
|
nkeynes@144 | 114 | */
|
nkeynes@144 | 115 | gboolean (*init_driver)(void);
|
nkeynes@144 | 116 |
|
nkeynes@144 | 117 | /**
|
nkeynes@144 | 118 | * Cleanly shutdown the driver. Normally only called at system shutdown
|
nkeynes@144 | 119 | * time.
|
nkeynes@144 | 120 | */
|
nkeynes@144 | 121 | void (*shutdown_driver)(void);
|
nkeynes@144 | 122 |
|
nkeynes@144 | 123 | /**
|
nkeynes@144 | 124 | * Given a particular keysym, return the keycode associated with it.
|
nkeynes@144 | 125 | * @param keysym The keysym to be resolved, ie "Tab"
|
nkeynes@144 | 126 | * @return the display-specific keycode, or 0 if the keysym cannot
|
nkeynes@144 | 127 | * be resolved.
|
nkeynes@144 | 128 | */
|
nkeynes@144 | 129 | uint16_t (*resolve_keysym)( const gchar *keysym );
|
nkeynes@144 | 130 |
|
nkeynes@144 | 131 | /**
|
nkeynes@608 | 132 | * Given a native system keycode, convert it to a dreamcast keyboard code.
|
nkeynes@608 | 133 | */
|
nkeynes@608 | 134 | uint16_t (*convert_to_dckeysym)( uint16_t keycode );
|
nkeynes@608 | 135 |
|
nkeynes@608 | 136 | /**
|
nkeynes@614 | 137 | * Given a device-specific event code, return the corresponding keysym.
|
nkeynes@614 | 138 | * The string should be newly allocated (caller will free)
|
nkeynes@614 | 139 | */
|
nkeynes@614 | 140 | gchar *(*get_keysym_for_keycode)( uint16_t keycode );
|
nkeynes@614 | 141 |
|
nkeynes@614 | 142 | /**
|
nkeynes@805 | 143 | * Create a render target with the given width and height. If a texture ID
|
nkeynes@805 | 144 | * is supplied (non-zero), the render buffer writes its output to that texture.
|
nkeynes@805 | 145 | * @param tex_id 0 or a valid GL texture name which must have been initialized to
|
nkeynes@805 | 146 | * the correct dimensions.
|
nkeynes@144 | 147 | */
|
nkeynes@805 | 148 | render_buffer_t (*create_render_buffer)( uint32_t width, uint32_t height, GLuint tex_id );
|
nkeynes@144 | 149 |
|
nkeynes@144 | 150 | /**
|
nkeynes@352 | 151 | * Destroy the specified render buffer and release any associated
|
nkeynes@352 | 152 | * resources.
|
nkeynes@144 | 153 | */
|
nkeynes@352 | 154 | void (*destroy_render_buffer)( render_buffer_t buffer );
|
nkeynes@352 | 155 |
|
nkeynes@144 | 156 | /**
|
nkeynes@352 | 157 | * Set the current rendering target to the specified buffer.
|
nkeynes@144 | 158 | */
|
nkeynes@352 | 159 | gboolean (*set_render_target)( render_buffer_t buffer );
|
nkeynes@352 | 160 |
|
nkeynes@352 | 161 | /**
|
nkeynes@805 | 162 | * Complete rendering and clear the current rendering target. If the
|
nkeynes@805 | 163 | * buffer has a bound texture, it will be updated if necessary.
|
nkeynes@805 | 164 | */
|
nkeynes@805 | 165 | void (*finish_render)( render_buffer_t buffer );
|
nkeynes@805 | 166 |
|
nkeynes@805 | 167 | /**
|
nkeynes@477 | 168 | * Load the supplied frame buffer into the given render buffer.
|
nkeynes@477 | 169 | * Included here to allow driver-specific optimizations.
|
nkeynes@352 | 170 | */
|
nkeynes@477 | 171 | void (*load_frame_buffer)( frame_buffer_t frame, render_buffer_t render );
|
nkeynes@352 | 172 |
|
nkeynes@352 | 173 | /**
|
nkeynes@352 | 174 | * Display a single frame using a previously rendered GL buffer.
|
nkeynes@352 | 175 | */
|
nkeynes@669 | 176 | void (*display_render_buffer)( render_buffer_t buffer );
|
nkeynes@144 | 177 |
|
nkeynes@144 | 178 | /**
|
nkeynes@144 | 179 | * Display a single blanked frame using a fixed colour for the
|
nkeynes@477 | 180 | * entire frame (specified in BGR888 format).
|
nkeynes@144 | 181 | */
|
nkeynes@669 | 182 | void (*display_blank)( uint32_t rgb );
|
nkeynes@144 | 183 |
|
nkeynes@144 | 184 | /**
|
nkeynes@352 | 185 | * Copy the image data from the GL buffer to the target memory buffer,
|
nkeynes@352 | 186 | * using the format etc from the buffer. This may force a glFinish()
|
nkeynes@352 | 187 | * but does not invalidate the buffer.
|
nkeynes@477 | 188 | * @param target buffer to fill with image data, which must be large enough
|
nkeynes@477 | 189 | * to accomodate the image.
|
nkeynes@477 | 190 | * @param buffer Render buffer to read from.
|
nkeynes@477 | 191 | * @param rowstride rowstride of the target data
|
nkeynes@477 | 192 | * @param format colour format to output the data in.
|
nkeynes@144 | 193 | */
|
nkeynes@477 | 194 | gboolean (*read_render_buffer)( unsigned char *target, render_buffer_t buffer,
|
nkeynes@736 | 195 | int rowstride, int format );
|
nkeynes@352 | 196 |
|
nkeynes@144 | 197 | } *display_driver_t;
|
nkeynes@144 | 198 |
|
nkeynes@700 | 199 | /**
|
nkeynes@700 | 200 | * Print the configured video drivers to the output stream, one to a line.
|
nkeynes@700 | 201 | */
|
nkeynes@700 | 202 | void print_display_drivers( FILE *out );
|
nkeynes@531 | 203 | display_driver_t get_display_driver_by_name( const char *name );
|
nkeynes@370 | 204 | gboolean display_set_driver( display_driver_t driver );
|
nkeynes@144 | 205 |
|
nkeynes@144 | 206 | extern uint32_t pvr2_frame_counter;
|
nkeynes@144 | 207 |
|
nkeynes@144 | 208 | extern display_driver_t display_driver;
|
nkeynes@144 | 209 |
|
nkeynes@144 | 210 | extern struct display_driver display_gtk_driver;
|
nkeynes@681 | 211 | extern struct display_driver display_osx_driver;
|
nkeynes@144 | 212 | extern struct display_driver display_null_driver;
|
nkeynes@144 | 213 |
|
nkeynes@144 | 214 | /****************** Input methods **********************/
|
nkeynes@144 | 215 |
|
nkeynes@614 | 216 | typedef void (*input_key_callback_t)( void *data, uint32_t value, uint32_t pressure, gboolean isKeyDown );
|
nkeynes@144 | 217 |
|
nkeynes@608 | 218 | /**
|
nkeynes@608 | 219 | * Callback to receive mouse input events
|
nkeynes@608 | 220 | * @param data pointer passed in at the time the hook was registered
|
nkeynes@608 | 221 | * @param buttons bitmask of button states, where bit 0 is button 0 (left), bit 1 is button
|
nkeynes@608 | 222 | * 1 (middle), bit 2 is button 2 (right) and so forth.
|
nkeynes@608 | 223 | * @param x Horizontal movement since the last invocation (in relative mode) or window position
|
nkeynes@608 | 224 | * (in absolute mode).
|
nkeynes@608 | 225 | * @param y Vertical movement since the last invocation (in relative mode) or window position
|
nkeynes@608 | 226 | * (in absolute mode).
|
nkeynes@608 | 227 | */
|
nkeynes@608 | 228 | typedef void (*input_mouse_callback_t)( void *data, uint32_t buttons, int32_t x, int32_t y );
|
nkeynes@608 | 229 |
|
nkeynes@144 | 230 | gboolean input_register_key( const gchar *keysym, input_key_callback_t callback,
|
nkeynes@736 | 231 | void *data, uint32_t value );
|
nkeynes@144 | 232 |
|
nkeynes@451 | 233 | void input_unregister_key( const gchar *keysym, input_key_callback_t callback,
|
nkeynes@736 | 234 | void *data, uint32_t value );
|
nkeynes@144 | 235 |
|
nkeynes@608 | 236 | /**
|
nkeynes@608 | 237 | * Register a hook to receive all input events
|
nkeynes@608 | 238 | */
|
nkeynes@608 | 239 | gboolean input_register_hook( input_key_callback_t callback, void *data );
|
nkeynes@608 | 240 | void input_unregister_hook( input_key_callback_t callback, void *data );
|
nkeynes@608 | 241 |
|
nkeynes@608 | 242 | /**
|
nkeynes@608 | 243 | * Register a mouse event hook.
|
nkeynes@608 | 244 | * @param relative TRUE if the caller wants relative mouse movement, FALSE for
|
nkeynes@608 | 245 | * absolute mouse positioning. It's not generally possible to receive both at the same time.
|
nkeynes@608 | 246 | */
|
nkeynes@608 | 247 | gboolean input_register_mouse_hook( gboolean relative, input_mouse_callback_t callback, void *data );
|
nkeynes@608 | 248 | void input_unregister_mouse_hook( input_mouse_callback_t callback, void *data );
|
nkeynes@608 | 249 |
|
nkeynes@144 | 250 | gboolean input_is_key_valid( const gchar *keysym );
|
nkeynes@144 | 251 |
|
nkeynes@144 | 252 | gboolean input_is_key_registered( const gchar *keysym );
|
nkeynes@144 | 253 |
|
nkeynes@614 | 254 | uint16_t input_keycode_to_dckeysym( uint16_t keycode );
|
nkeynes@144 | 255 |
|
nkeynes@614 | 256 | /********************** Display/Input methods ***********************/
|
nkeynes@614 | 257 |
|
nkeynes@614 | 258 | /**
|
nkeynes@614 | 259 | * Auxilliary input driver - provides input separate to and in addition to the
|
nkeynes@614 | 260 | * core UI/display. (primarily used for joystick devices)
|
nkeynes@614 | 261 | */
|
nkeynes@614 | 262 | typedef struct input_driver {
|
nkeynes@614 | 263 | const char *id; /* Short identifier to display in the UI for the device (eg "JS0" ) */
|
nkeynes@614 | 264 |
|
nkeynes@614 | 265 | /**
|
nkeynes@614 | 266 | * Given a particular keysym, return the keycode associated with it.
|
nkeynes@614 | 267 | * @param keysym The keysym to be resolved, ie "Tab"
|
nkeynes@614 | 268 | * @return the display-specific keycode, or 0 if the keysym cannot
|
nkeynes@614 | 269 | * be resolved.
|
nkeynes@614 | 270 | */
|
nkeynes@614 | 271 | uint16_t (*resolve_keysym)( struct input_driver *driver, const gchar *keysym );
|
nkeynes@614 | 272 |
|
nkeynes@614 | 273 | /**
|
nkeynes@614 | 274 | * Given a device-specific event code, convert it to a dreamcast keyboard code.
|
nkeynes@614 | 275 | * This is only required for actual keyboard devices, other devices should just
|
nkeynes@614 | 276 | * leave this method NULL.
|
nkeynes@614 | 277 | */
|
nkeynes@614 | 278 | uint16_t (*convert_to_dckeysym)( struct input_driver *driver, uint16_t keycode );
|
nkeynes@614 | 279 |
|
nkeynes@614 | 280 | /**
|
nkeynes@614 | 281 | * Given a device-specific event code, return the corresponding keysym.
|
nkeynes@614 | 282 | * The string should be newly allocated (caller will free)
|
nkeynes@614 | 283 | */
|
nkeynes@614 | 284 | gchar *(*get_keysym_for_keycode)( struct input_driver *driver, uint16_t keycode );
|
nkeynes@614 | 285 |
|
nkeynes@614 | 286 | /**
|
nkeynes@614 | 287 | * Destroy the input driver.
|
nkeynes@614 | 288 | */
|
nkeynes@614 | 289 | void (*destroy)( struct input_driver *driver );
|
nkeynes@614 | 290 |
|
nkeynes@614 | 291 | } *input_driver_t;
|
nkeynes@614 | 292 |
|
nkeynes@614 | 293 | /**
|
nkeynes@614 | 294 | * Register a new input driver (which must have a unique name)
|
nkeynes@614 | 295 | * @param driver the driver to register
|
nkeynes@614 | 296 | * @param max_keycode the highest possible keycode reported by the device
|
nkeynes@614 | 297 | * @return TRUE on success, FALSE on failure (eg driver already registed).
|
nkeynes@614 | 298 | */
|
nkeynes@614 | 299 | gboolean input_register_device( input_driver_t driver, uint16_t max_keycode );
|
nkeynes@614 | 300 |
|
nkeynes@614 | 301 | /**
|
nkeynes@615 | 302 | * Determine if the system has an input driver with the given unique ID.
|
nkeynes@615 | 303 | * @param id driver id to check
|
nkeynes@615 | 304 | * @return TRUE if the device exists, otherwise FALSE
|
nkeynes@615 | 305 | */
|
nkeynes@615 | 306 | gboolean input_has_device( const gchar *id );
|
nkeynes@615 | 307 |
|
nkeynes@615 | 308 | /**
|
nkeynes@614 | 309 | * Unregister an input driver.
|
nkeynes@614 | 310 | * @param driver the driver to unregister
|
nkeynes@614 | 311 | * If the driver is not in fact registered, this function has no effect.
|
nkeynes@614 | 312 | */
|
nkeynes@614 | 313 | void input_unregister_device( input_driver_t driver );
|
nkeynes@614 | 314 |
|
nkeynes@614 | 315 | /**
|
nkeynes@614 | 316 | * Called from the UI to indicate that the emulation window is focused (ie
|
nkeynes@614 | 317 | * able to receive input). This method is used to gate non-UI input devices -
|
nkeynes@614 | 318 | * when the display is not focused, all input events will be silently ignored.
|
nkeynes@614 | 319 | */
|
nkeynes@614 | 320 | void display_set_focused( gboolean has_focus );
|
nkeynes@614 | 321 |
|
nkeynes@614 | 322 | void input_event_keydown( input_driver_t input, uint16_t keycode, uint32_t pressure );
|
nkeynes@614 | 323 |
|
nkeynes@614 | 324 | void input_event_keyup( input_driver_t input, uint16_t keycode, uint32_t pressure );
|
nkeynes@144 | 325 |
|
nkeynes@608 | 326 | void input_event_mouse( uint32_t buttons, int32_t x_axis, int32_t y_axis );
|
nkeynes@144 | 327 |
|
nkeynes@770 | 328 | /**
|
nkeynes@770 | 329 | * Given a keycode and the originating input driver, return the corresponding
|
nkeynes@770 | 330 | * keysym. The caller is responsible for freeing the string.
|
nkeynes@770 | 331 | * @return a newly allocated string, or NULL of the keycode is unresolvable.
|
nkeynes@770 | 332 | */
|
nkeynes@770 | 333 | gchar *input_keycode_to_keysym( input_driver_t driver, uint16_t keycode );
|
nkeynes@614 | 334 |
|
nkeynes@614 | 335 | typedef void (*display_keysym_callback_t)( void *data, const gchar *keysym );
|
nkeynes@614 | 336 |
|
nkeynes@614 | 337 | /**
|
nkeynes@614 | 338 | * Set the keysym hook function (normally used by the UI to receive non-UI
|
nkeynes@614 | 339 | * input events during configuration.
|
nkeynes@614 | 340 | */
|
nkeynes@614 | 341 | void input_set_keysym_hook( display_keysym_callback_t hook, void *data );
|
nkeynes@614 | 342 |
|
nkeynes@614 | 343 |
|
nkeynes@144 | 344 |
|
nkeynes@144 | 345 | #ifdef __cplusplus
|
nkeynes@144 | 346 | }
|
nkeynes@144 | 347 | #endif
|
nkeynes@736 | 348 | #endif /* !lxdream_display_H */
|