nkeynes@144: /** nkeynes@561: * $Id$ nkeynes@144: * nkeynes@144: * The PC side of the video support (responsible for actually displaying / nkeynes@144: * rendering frames) nkeynes@144: * nkeynes@144: * Copyright (c) 2005 Nathan Keynes. nkeynes@144: * nkeynes@144: * This program is free software; you can redistribute it and/or modify nkeynes@144: * it under the terms of the GNU General Public License as published by nkeynes@144: * the Free Software Foundation; either version 2 of the License, or nkeynes@144: * (at your option) any later version. nkeynes@144: * nkeynes@144: * This program is distributed in the hope that it will be useful, nkeynes@144: * but WITHOUT ANY WARRANTY; without even the implied warranty of nkeynes@144: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the nkeynes@144: * GNU General Public License for more details. nkeynes@144: */ nkeynes@144: nkeynes@736: #ifndef lxdream_display_H nkeynes@736: #define lxdream_display_H 1 nkeynes@144: nkeynes@669: #define GL_GLEXT_PROTOTYPES 1 nkeynes@669: nkeynes@144: #include nkeynes@700: #include nkeynes@144: #include nkeynes@700: #include nkeynes@540: #include "lxdream.h" nkeynes@540: #ifdef APPLE_BUILD nkeynes@540: #include nkeynes@540: #include nkeynes@540: #else nkeynes@327: #include nkeynes@540: #include nkeynes@540: #endif nkeynes@144: nkeynes@144: #ifdef __cplusplus nkeynes@144: extern "C" { nkeynes@144: #endif nkeynes@144: nkeynes@144: /** nkeynes@477: * Supported colour formats. Note that BGRA4444 is only ever used for texture nkeynes@144: * rendering (it's not valid for display purposes). nkeynes@144: */ nkeynes@477: #define COLFMT_BGRA1555 0 nkeynes@144: #define COLFMT_RGB565 1 nkeynes@477: #define COLFMT_BGRA4444 2 nkeynes@144: #define COLFMT_YUV422 3 /* 8-bit YUV (texture source only) */ nkeynes@477: #define COLFMT_BGR888 4 /* 24-bit BGR */ nkeynes@477: #define COLFMT_BGRA8888 5 nkeynes@144: #define COLFMT_INDEX4 6 /* 4 bit indexed colour (texture source only) */ nkeynes@144: #define COLFMT_INDEX8 7 /* 8-bit indexed colour (texture source only) */ nkeynes@477: #define COLFMT_BGR0888 8 /* 32-bit BGR */ nkeynes@477: #define COLFMT_RGB888 9 /* 24-bit RGB (ie GL native) */ nkeynes@327: nkeynes@327: struct colour_format { nkeynes@327: GLint type, format, int_format; nkeynes@327: int bpp; nkeynes@327: }; nkeynes@327: extern struct colour_format colour_formats[]; nkeynes@144: nkeynes@162: extern int colour_format_bytes[]; nkeynes@162: nkeynes@352: /** nkeynes@352: * Structure to hold pixel data held in GL buffers. nkeynes@352: */ nkeynes@477: struct render_buffer { nkeynes@352: uint32_t width; nkeynes@352: uint32_t height; nkeynes@144: uint32_t rowstride; nkeynes@674: uint32_t colour_format; nkeynes@352: sh4addr_t address; /* Address buffer was rendered to, or -1 for unrendered */ nkeynes@352: uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */ nkeynes@477: gboolean inverted;/* True if the buffer is upside down */ nkeynes@674: uint32_t scale; nkeynes@424: unsigned int buf_id; /* driver-specific buffer id, if applicable */ nkeynes@352: gboolean flushed; /* True if the buffer has been flushed to vram */ nkeynes@477: }; nkeynes@144: nkeynes@144: /** nkeynes@352: * Structure to hold pixel data stored in pvr2 vram, as opposed to data in nkeynes@352: * GL buffers. nkeynes@352: */ nkeynes@477: struct frame_buffer { nkeynes@352: uint32_t width; nkeynes@352: uint32_t height; nkeynes@352: uint32_t rowstride; nkeynes@674: uint32_t colour_format; nkeynes@352: sh4addr_t address; nkeynes@352: uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */ nkeynes@477: gboolean inverted;/* True if the buffer is upside down */ nkeynes@502: unsigned char *data; nkeynes@477: }; nkeynes@352: nkeynes@352: /** nkeynes@352: * Core video driver - exports function to setup a GL context, as well as handle nkeynes@352: * keyboard input and display resultant output. nkeynes@144: */ nkeynes@144: typedef struct display_driver { nkeynes@144: char *name; nkeynes@144: /** nkeynes@700: * Short (<60 chars) description of the driver. This should be marked for nkeynes@700: * localization. nkeynes@700: */ nkeynes@700: char *description; nkeynes@700: /** nkeynes@144: * Initialize the driver. This is called only once at startup time, and nkeynes@144: * is guaranteed to be called before any other methods. nkeynes@144: * @return TRUE if the driver was successfully initialized, otherwise nkeynes@144: * FALSE. nkeynes@144: */ nkeynes@144: gboolean (*init_driver)(void); nkeynes@144: nkeynes@144: /** nkeynes@144: * Cleanly shutdown the driver. Normally only called at system shutdown nkeynes@144: * time. nkeynes@144: */ nkeynes@144: void (*shutdown_driver)(void); nkeynes@144: nkeynes@144: /** nkeynes@144: * Given a particular keysym, return the keycode associated with it. nkeynes@144: * @param keysym The keysym to be resolved, ie "Tab" nkeynes@144: * @return the display-specific keycode, or 0 if the keysym cannot nkeynes@144: * be resolved. nkeynes@144: */ nkeynes@144: uint16_t (*resolve_keysym)( const gchar *keysym ); nkeynes@144: nkeynes@144: /** nkeynes@608: * Given a native system keycode, convert it to a dreamcast keyboard code. nkeynes@608: */ nkeynes@608: uint16_t (*convert_to_dckeysym)( uint16_t keycode ); nkeynes@608: nkeynes@608: /** nkeynes@614: * Given a device-specific event code, return the corresponding keysym. nkeynes@614: * The string should be newly allocated (caller will free) nkeynes@614: */ nkeynes@614: gchar *(*get_keysym_for_keycode)( uint16_t keycode ); nkeynes@614: nkeynes@614: /** nkeynes@352: * Create a render target with the given width and height. nkeynes@144: */ nkeynes@352: render_buffer_t (*create_render_buffer)( uint32_t width, uint32_t height ); nkeynes@144: nkeynes@144: /** nkeynes@352: * Destroy the specified render buffer and release any associated nkeynes@352: * resources. nkeynes@144: */ nkeynes@352: void (*destroy_render_buffer)( render_buffer_t buffer ); nkeynes@352: nkeynes@144: /** nkeynes@352: * Set the current rendering target to the specified buffer. nkeynes@144: */ nkeynes@352: gboolean (*set_render_target)( render_buffer_t buffer ); nkeynes@352: nkeynes@352: /** nkeynes@477: * Load the supplied frame buffer into the given render buffer. nkeynes@477: * Included here to allow driver-specific optimizations. nkeynes@352: */ nkeynes@477: void (*load_frame_buffer)( frame_buffer_t frame, render_buffer_t render ); nkeynes@352: nkeynes@352: /** nkeynes@352: * Display a single frame using a previously rendered GL buffer. nkeynes@352: */ nkeynes@669: void (*display_render_buffer)( render_buffer_t buffer ); nkeynes@144: nkeynes@144: /** nkeynes@144: * Display a single blanked frame using a fixed colour for the nkeynes@477: * entire frame (specified in BGR888 format). nkeynes@144: */ nkeynes@669: void (*display_blank)( uint32_t rgb ); nkeynes@144: nkeynes@144: /** nkeynes@352: * Copy the image data from the GL buffer to the target memory buffer, nkeynes@352: * using the format etc from the buffer. This may force a glFinish() nkeynes@352: * but does not invalidate the buffer. nkeynes@477: * @param target buffer to fill with image data, which must be large enough nkeynes@477: * to accomodate the image. nkeynes@477: * @param buffer Render buffer to read from. nkeynes@477: * @param rowstride rowstride of the target data nkeynes@477: * @param format colour format to output the data in. nkeynes@144: */ nkeynes@477: gboolean (*read_render_buffer)( unsigned char *target, render_buffer_t buffer, nkeynes@736: int rowstride, int format ); nkeynes@352: nkeynes@144: } *display_driver_t; nkeynes@144: nkeynes@700: /** nkeynes@700: * Print the configured video drivers to the output stream, one to a line. nkeynes@700: */ nkeynes@700: void print_display_drivers( FILE *out ); nkeynes@531: display_driver_t get_display_driver_by_name( const char *name ); nkeynes@370: gboolean display_set_driver( display_driver_t driver ); nkeynes@144: nkeynes@144: extern uint32_t pvr2_frame_counter; nkeynes@144: nkeynes@144: extern display_driver_t display_driver; nkeynes@144: nkeynes@144: extern struct display_driver display_gtk_driver; nkeynes@681: extern struct display_driver display_osx_driver; nkeynes@144: extern struct display_driver display_null_driver; nkeynes@144: nkeynes@144: /****************** Input methods **********************/ nkeynes@144: nkeynes@614: typedef void (*input_key_callback_t)( void *data, uint32_t value, uint32_t pressure, gboolean isKeyDown ); nkeynes@144: nkeynes@608: /** nkeynes@608: * Callback to receive mouse input events nkeynes@608: * @param data pointer passed in at the time the hook was registered nkeynes@608: * @param buttons bitmask of button states, where bit 0 is button 0 (left), bit 1 is button nkeynes@608: * 1 (middle), bit 2 is button 2 (right) and so forth. nkeynes@608: * @param x Horizontal movement since the last invocation (in relative mode) or window position nkeynes@608: * (in absolute mode). nkeynes@608: * @param y Vertical movement since the last invocation (in relative mode) or window position nkeynes@608: * (in absolute mode). nkeynes@608: */ nkeynes@608: typedef void (*input_mouse_callback_t)( void *data, uint32_t buttons, int32_t x, int32_t y ); nkeynes@608: nkeynes@144: gboolean input_register_key( const gchar *keysym, input_key_callback_t callback, nkeynes@736: void *data, uint32_t value ); nkeynes@144: nkeynes@451: void input_unregister_key( const gchar *keysym, input_key_callback_t callback, nkeynes@736: void *data, uint32_t value ); nkeynes@144: nkeynes@608: /** nkeynes@608: * Register a hook to receive all input events nkeynes@608: */ nkeynes@608: gboolean input_register_hook( input_key_callback_t callback, void *data ); nkeynes@608: void input_unregister_hook( input_key_callback_t callback, void *data ); nkeynes@608: nkeynes@608: /** nkeynes@608: * Register a mouse event hook. nkeynes@608: * @param relative TRUE if the caller wants relative mouse movement, FALSE for nkeynes@608: * absolute mouse positioning. It's not generally possible to receive both at the same time. nkeynes@608: */ nkeynes@608: gboolean input_register_mouse_hook( gboolean relative, input_mouse_callback_t callback, void *data ); nkeynes@608: void input_unregister_mouse_hook( input_mouse_callback_t callback, void *data ); nkeynes@608: nkeynes@144: gboolean input_is_key_valid( const gchar *keysym ); nkeynes@144: nkeynes@144: gboolean input_is_key_registered( const gchar *keysym ); nkeynes@144: nkeynes@614: uint16_t input_keycode_to_dckeysym( uint16_t keycode ); nkeynes@144: nkeynes@614: /********************** Display/Input methods ***********************/ nkeynes@614: nkeynes@614: /** nkeynes@614: * Auxilliary input driver - provides input separate to and in addition to the nkeynes@614: * core UI/display. (primarily used for joystick devices) nkeynes@614: */ nkeynes@614: typedef struct input_driver { nkeynes@614: const char *id; /* Short identifier to display in the UI for the device (eg "JS0" ) */ nkeynes@614: nkeynes@614: /** nkeynes@614: * Given a particular keysym, return the keycode associated with it. nkeynes@614: * @param keysym The keysym to be resolved, ie "Tab" nkeynes@614: * @return the display-specific keycode, or 0 if the keysym cannot nkeynes@614: * be resolved. nkeynes@614: */ nkeynes@614: uint16_t (*resolve_keysym)( struct input_driver *driver, const gchar *keysym ); nkeynes@614: nkeynes@614: /** nkeynes@614: * Given a device-specific event code, convert it to a dreamcast keyboard code. nkeynes@614: * This is only required for actual keyboard devices, other devices should just nkeynes@614: * leave this method NULL. nkeynes@614: */ nkeynes@614: uint16_t (*convert_to_dckeysym)( struct input_driver *driver, uint16_t keycode ); nkeynes@614: nkeynes@614: /** nkeynes@614: * Given a device-specific event code, return the corresponding keysym. nkeynes@614: * The string should be newly allocated (caller will free) nkeynes@614: */ nkeynes@614: gchar *(*get_keysym_for_keycode)( struct input_driver *driver, uint16_t keycode ); nkeynes@614: nkeynes@614: /** nkeynes@614: * Destroy the input driver. nkeynes@614: */ nkeynes@614: void (*destroy)( struct input_driver *driver ); nkeynes@614: nkeynes@614: } *input_driver_t; nkeynes@614: nkeynes@614: /** nkeynes@614: * Register a new input driver (which must have a unique name) nkeynes@614: * @param driver the driver to register nkeynes@614: * @param max_keycode the highest possible keycode reported by the device nkeynes@614: * @return TRUE on success, FALSE on failure (eg driver already registed). nkeynes@614: */ nkeynes@614: gboolean input_register_device( input_driver_t driver, uint16_t max_keycode ); nkeynes@614: nkeynes@614: /** nkeynes@615: * Determine if the system has an input driver with the given unique ID. nkeynes@615: * @param id driver id to check nkeynes@615: * @return TRUE if the device exists, otherwise FALSE nkeynes@615: */ nkeynes@615: gboolean input_has_device( const gchar *id ); nkeynes@615: nkeynes@615: /** nkeynes@614: * Unregister an input driver. nkeynes@614: * @param driver the driver to unregister nkeynes@614: * If the driver is not in fact registered, this function has no effect. nkeynes@614: */ nkeynes@614: void input_unregister_device( input_driver_t driver ); nkeynes@614: nkeynes@614: /** nkeynes@614: * Called from the UI to indicate that the emulation window is focused (ie nkeynes@614: * able to receive input). This method is used to gate non-UI input devices - nkeynes@614: * when the display is not focused, all input events will be silently ignored. nkeynes@614: */ nkeynes@614: void display_set_focused( gboolean has_focus ); nkeynes@614: nkeynes@614: void input_event_keydown( input_driver_t input, uint16_t keycode, uint32_t pressure ); nkeynes@614: nkeynes@614: void input_event_keyup( input_driver_t input, uint16_t keycode, uint32_t pressure ); nkeynes@144: nkeynes@608: void input_event_mouse( uint32_t buttons, int32_t x_axis, int32_t y_axis ); nkeynes@144: nkeynes@614: nkeynes@614: typedef void (*display_keysym_callback_t)( void *data, const gchar *keysym ); nkeynes@614: nkeynes@614: /** nkeynes@614: * Set the keysym hook function (normally used by the UI to receive non-UI nkeynes@614: * input events during configuration. nkeynes@614: */ nkeynes@614: void input_set_keysym_hook( display_keysym_callback_t hook, void *data ); nkeynes@614: nkeynes@614: nkeynes@144: nkeynes@144: #ifdef __cplusplus nkeynes@144: } nkeynes@144: #endif nkeynes@736: #endif /* !lxdream_display_H */