Search
lxdream.org :: lxdream/src/display.h
lxdream 0.9.1
released Jun 29
Download Now
filename src/display.h
changeset 770:429ff505c450
prev755:ab873907b00e
next805:b355f7b3ff2e
author nkeynes
date Wed Jul 30 03:00:40 2008 +0000 (11 years ago)
permissions -rw-r--r--
last change Add debian changelog file
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 struct colour_format {
    58     GLint type, format, int_format;
    59     int bpp;
    60 };
    61 extern struct colour_format colour_formats[];
    63 extern int colour_format_bytes[];
    65 /**
    66  * Structure to hold pixel data held in GL buffers.
    67  */
    68 struct render_buffer {
    69     uint32_t width;
    70     uint32_t height;
    71     uint32_t rowstride;
    72     uint32_t colour_format;
    73     sh4addr_t address; /* Address buffer was rendered to, or -1 for unrendered */
    74     uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */
    75     gboolean inverted;/* True if the buffer is upside down */
    76     uint32_t scale;
    77     unsigned int buf_id; /* driver-specific buffer id, if applicable */
    78     gboolean flushed; /* True if the buffer has been flushed to vram */
    79 };
    81 /**
    82  * Structure to hold pixel data stored in pvr2 vram, as opposed to data in
    83  * GL buffers.
    84  */
    85 struct frame_buffer {
    86     uint32_t width;
    87     uint32_t height;
    88     uint32_t rowstride;
    89     uint32_t colour_format;
    90     sh4addr_t address;
    91     uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */
    92     gboolean inverted;/* True if the buffer is upside down */
    93     unsigned char *data;
    94 };
    96 /**
    97  * Core video driver - exports function to setup a GL context, as well as handle
    98  * keyboard input and display resultant output.
    99  */
   100 typedef struct display_driver {
   101     char *name;
   102     /**
   103      * Short (<60 chars) description of the driver. This should be marked for
   104      * localization.
   105      */
   106     char *description;
   107     /**
   108      * Initialize the driver. This is called only once at startup time, and
   109      * is guaranteed to be called before any other methods.
   110      * @return TRUE if the driver was successfully initialized, otherwise
   111      * FALSE.
   112      */
   113     gboolean (*init_driver)(void);
   115     /**
   116      * Cleanly shutdown the driver. Normally only called at system shutdown
   117      * time.
   118      */
   119     void (*shutdown_driver)(void);
   121     /**
   122      * Given a particular keysym, return the keycode associated with it.
   123      * @param keysym The keysym to be resolved, ie "Tab"
   124      * @return the display-specific keycode, or 0 if the keysym cannot
   125      * be resolved.
   126      */
   127     uint16_t (*resolve_keysym)( const gchar *keysym );
   129     /**
   130      * Given a native system keycode, convert it to a dreamcast keyboard code.
   131      */
   132     uint16_t (*convert_to_dckeysym)( uint16_t keycode );
   134     /**
   135      * Given a device-specific event code, return the corresponding keysym.
   136      * The string should be newly allocated (caller will free)
   137      */
   138     gchar *(*get_keysym_for_keycode)( uint16_t keycode );
   140     /**
   141      * Create a render target with the given width and height.
   142      */
   143     render_buffer_t (*create_render_buffer)( uint32_t width, uint32_t height );
   145     /**
   146      * Destroy the specified render buffer and release any associated
   147      * resources.
   148      */
   149     void (*destroy_render_buffer)( render_buffer_t buffer );
   151     /**
   152      * Set the current rendering target to the specified buffer.
   153      */
   154     gboolean (*set_render_target)( render_buffer_t buffer );
   156     /**
   157      * Load the supplied frame buffer into the given render buffer.
   158      * Included here to allow driver-specific optimizations.
   159      */
   160     void (*load_frame_buffer)( frame_buffer_t frame, render_buffer_t render );
   162     /**
   163      * Display a single frame using a previously rendered GL buffer.
   164      */
   165     void (*display_render_buffer)( render_buffer_t buffer );
   167     /**
   168      * Display a single blanked frame using a fixed colour for the
   169      * entire frame (specified in BGR888 format). 
   170      */
   171     void (*display_blank)( uint32_t rgb );
   173     /**
   174      * Copy the image data from the GL buffer to the target memory buffer,
   175      * using the format etc from the buffer. This may force a glFinish()
   176      * but does not invalidate the buffer.
   177      * @param target buffer to fill with image data, which must be large enough
   178      *  to accomodate the image.
   179      * @param buffer Render buffer to read from.
   180      * @param rowstride rowstride of the target data
   181      * @param format colour format to output the data in.
   182      */
   183     gboolean (*read_render_buffer)( unsigned char *target, render_buffer_t buffer,
   184             int rowstride, int format );
   186 } *display_driver_t;
   188 /**
   189  * Print the configured video drivers to the output stream, one to a line.
   190  */
   191 void print_display_drivers( FILE *out );
   192 display_driver_t get_display_driver_by_name( const char *name );
   193 gboolean display_set_driver( display_driver_t driver );
   195 extern uint32_t pvr2_frame_counter;
   197 extern display_driver_t display_driver;
   199 extern struct display_driver display_gtk_driver;
   200 extern struct display_driver display_osx_driver;
   201 extern struct display_driver display_null_driver;
   203 /****************** Input methods **********************/
   205 typedef void (*input_key_callback_t)( void *data, uint32_t value, uint32_t pressure, gboolean isKeyDown );
   207 /**
   208  * Callback to receive mouse input events
   209  * @param data pointer passed in at the time the hook was registered
   210  * @param buttons bitmask of button states, where bit 0 is button 0 (left), bit 1 is button
   211  * 1 (middle), bit 2 is button 2 (right) and so forth.
   212  * @param x Horizontal movement since the last invocation (in relative mode) or window position 
   213  * (in absolute mode).
   214  * @param y Vertical movement since the last invocation (in relative mode) or window position
   215  * (in absolute mode).
   216  */
   217 typedef void (*input_mouse_callback_t)( void *data, uint32_t buttons, int32_t x, int32_t y );
   219 gboolean input_register_key( const gchar *keysym, input_key_callback_t callback,
   220                              void *data, uint32_t value );
   222 void input_unregister_key( const gchar *keysym, input_key_callback_t callback,
   223                            void *data, uint32_t value );
   225 /**
   226  * Register a hook to receive all input events
   227  */
   228 gboolean input_register_hook( input_key_callback_t callback, void *data );
   229 void input_unregister_hook( input_key_callback_t callback, void *data );
   231 /**
   232  * Register a mouse event hook.
   233  * @param relative TRUE if the caller wants relative mouse movement, FALSE for
   234  * absolute mouse positioning. It's not generally possible to receive both at the same time.
   235  */
   236 gboolean input_register_mouse_hook( gboolean relative, input_mouse_callback_t callback, void *data );
   237 void input_unregister_mouse_hook( input_mouse_callback_t callback, void *data );
   239 gboolean input_is_key_valid( const gchar *keysym );
   241 gboolean input_is_key_registered( const gchar *keysym );
   243 uint16_t input_keycode_to_dckeysym( uint16_t keycode );
   245 /********************** Display/Input methods ***********************/
   247 /**
   248  * Auxilliary input driver - provides input separate to and in addition to the
   249  * core UI/display. (primarily used for joystick devices)
   250  */
   251 typedef struct input_driver {
   252     const char *id; /* Short identifier to display in the UI for the device (eg "JS0" ) */
   254     /**
   255      * Given a particular keysym, return the keycode associated with it.
   256      * @param keysym The keysym to be resolved, ie "Tab"
   257      * @return the display-specific keycode, or 0 if the keysym cannot
   258      * be resolved.
   259      */
   260     uint16_t (*resolve_keysym)( struct input_driver *driver, const gchar *keysym );
   262     /**
   263      * Given a device-specific event code, convert it to a dreamcast keyboard code.
   264      * This is only required for actual keyboard devices, other devices should just
   265      * leave this method NULL.
   266      */
   267     uint16_t (*convert_to_dckeysym)( struct input_driver *driver, uint16_t keycode );
   269     /**
   270      * Given a device-specific event code, return the corresponding keysym.
   271      * The string should be newly allocated (caller will free)
   272      */
   273     gchar *(*get_keysym_for_keycode)( struct input_driver *driver, uint16_t keycode );
   275     /**
   276      * Destroy the input driver.
   277      */
   278     void (*destroy)( struct input_driver *driver );
   280 } *input_driver_t;       
   282 /**
   283  * Register a new input driver (which must have a unique name)
   284  * @param driver the driver to register
   285  * @param max_keycode the highest possible keycode reported by the device
   286  * @return TRUE on success, FALSE on failure (eg driver already registed).
   287  */
   288 gboolean input_register_device( input_driver_t driver, uint16_t max_keycode );
   290 /**
   291  * Determine if the system has an input driver with the given unique ID.
   292  * @param id driver id to check
   293  * @return TRUE if the device exists, otherwise FALSE
   294  */
   295 gboolean input_has_device( const gchar *id );
   297 /**
   298  * Unregister an input driver.
   299  * @param driver the driver to unregister
   300  * If the driver is not in fact registered, this function has no effect.
   301  */
   302 void input_unregister_device( input_driver_t driver );
   304 /**
   305  * Called from the UI to indicate that the emulation window is focused (ie
   306  * able to receive input). This method is used to gate non-UI input devices -
   307  * when the display is not focused, all input events will be silently ignored.
   308  */
   309 void display_set_focused( gboolean has_focus );
   311 void input_event_keydown( input_driver_t input, uint16_t keycode, uint32_t pressure );
   313 void input_event_keyup( input_driver_t input, uint16_t keycode, uint32_t pressure );
   315 void input_event_mouse( uint32_t buttons, int32_t x_axis, int32_t y_axis );
   317 /**
   318  * Given a keycode and the originating input driver, return the corresponding 
   319  * keysym. The caller is responsible for freeing the string.
   320  * @return a newly allocated string, or NULL of the keycode is unresolvable.
   321  */
   322 gchar *input_keycode_to_keysym( input_driver_t driver, uint16_t keycode );
   324 typedef void (*display_keysym_callback_t)( void *data, const gchar *keysym );
   326 /**
   327  * Set the keysym hook function (normally used by the UI to receive non-UI
   328  * input events during configuration.
   329  */
   330 void input_set_keysym_hook( display_keysym_callback_t hook, void *data );
   334 #ifdef __cplusplus
   335 }
   336 #endif
   337 #endif /* !lxdream_display_H */
.