Search
lxdream.org :: lxdream/src/display.h
lxdream 0.9.1
released Jun 29
Download Now
filename src/display.h
changeset 674:377d987db8f2
prev669:ab344e42bca9
next681:1755a126b109
author nkeynes
date Mon May 26 10:42:18 2008 +0000 (11 years ago)
permissions -rw-r--r--
last change Fix save states for x86-64, and ensure compatibility between 32-bit and 64-bit versions
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 dream_video_H
    21 #define dream_video_H
    23 #define GL_GLEXT_PROTOTYPES 1
    25 #include <stdint.h>
    26 #include <glib.h>
    27 #include "lxdream.h"
    28 #ifdef APPLE_BUILD
    29 #include <OpenGL/gl.h>
    30 #include <OpenGL/glext.h>
    31 #else
    32 #include <GL/gl.h>
    33 #include <GL/glext.h>
    34 #endif
    36 #ifdef __cplusplus
    37 extern "C" {
    38 #endif
    40 /**
    41  * Supported colour formats. Note that BGRA4444 is only ever used for texture
    42  * rendering (it's not valid for display purposes).
    43  */
    44 #define COLFMT_BGRA1555  0
    45 #define COLFMT_RGB565    1
    46 #define COLFMT_BGRA4444  2
    47 #define COLFMT_YUV422    3 /* 8-bit YUV (texture source only) */
    48 #define COLFMT_BGR888    4 /* 24-bit BGR */
    49 #define COLFMT_BGRA8888  5
    50 #define COLFMT_INDEX4    6 /* 4 bit indexed colour (texture source only) */
    51 #define COLFMT_INDEX8    7 /* 8-bit indexed colour (texture source only) */
    52 #define COLFMT_BGR0888   8 /* 32-bit BGR */
    53 #define COLFMT_RGB888    9 /* 24-bit RGB (ie GL native) */
    55 struct colour_format {
    56     GLint type, format, int_format;
    57     int bpp;
    58 };
    59 extern struct colour_format colour_formats[];
    61 extern int colour_format_bytes[];
    63 /**
    64  * Structure to hold pixel data held in GL buffers.
    65  */
    66 struct render_buffer {
    67     uint32_t width;
    68     uint32_t height;
    69     uint32_t rowstride;
    70     uint32_t colour_format;
    71     sh4addr_t address; /* Address buffer was rendered to, or -1 for unrendered */
    72     uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */
    73     gboolean inverted;/* True if the buffer is upside down */
    74     uint32_t scale;
    75     unsigned int buf_id; /* driver-specific buffer id, if applicable */
    76     gboolean flushed; /* True if the buffer has been flushed to vram */
    77 };
    79 /**
    80  * Structure to hold pixel data stored in pvr2 vram, as opposed to data in
    81  * GL buffers.
    82  */
    83 struct frame_buffer {
    84     uint32_t width;
    85     uint32_t height;
    86     uint32_t rowstride;
    87     uint32_t colour_format;
    88     sh4addr_t address;
    89     uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */
    90     gboolean inverted;/* True if the buffer is upside down */
    91     unsigned char *data;
    92 };
    94 /**
    95  * Core video driver - exports function to setup a GL context, as well as handle
    96  * keyboard input and display resultant output.
    97  */
    98 typedef struct display_driver {
    99     char *name;
   100     /**
   101      * Initialize the driver. This is called only once at startup time, and
   102      * is guaranteed to be called before any other methods.
   103      * @return TRUE if the driver was successfully initialized, otherwise
   104      * FALSE.
   105      */
   106     gboolean (*init_driver)(void);
   108     /**
   109      * Cleanly shutdown the driver. Normally only called at system shutdown
   110      * time.
   111      */
   112     void (*shutdown_driver)(void);
   114     /**
   115      * Given a particular keysym, return the keycode associated with it.
   116      * @param keysym The keysym to be resolved, ie "Tab"
   117      * @return the display-specific keycode, or 0 if the keysym cannot
   118      * be resolved.
   119      */
   120     uint16_t (*resolve_keysym)( const gchar *keysym );
   122     /**
   123      * Given a native system keycode, convert it to a dreamcast keyboard code.
   124      */
   125     uint16_t (*convert_to_dckeysym)( uint16_t keycode );
   127     /**
   128      * Given a device-specific event code, return the corresponding keysym.
   129      * The string should be newly allocated (caller will free)
   130      */
   131     gchar *(*get_keysym_for_keycode)( uint16_t keycode );
   133     /**
   134      * Create a render target with the given width and height.
   135      */
   136     render_buffer_t (*create_render_buffer)( uint32_t width, uint32_t height );
   138     /**
   139      * Destroy the specified render buffer and release any associated
   140      * resources.
   141      */
   142     void (*destroy_render_buffer)( render_buffer_t buffer );
   144     /**
   145      * Set the current rendering target to the specified buffer.
   146      */
   147     gboolean (*set_render_target)( render_buffer_t buffer );
   149     /**
   150      * Load the supplied frame buffer into the given render buffer.
   151      * Included here to allow driver-specific optimizations.
   152      */
   153     void (*load_frame_buffer)( frame_buffer_t frame, render_buffer_t render );
   155     /**
   156      * Display a single frame using a previously rendered GL buffer.
   157      */
   158     void (*display_render_buffer)( render_buffer_t buffer );
   160     /**
   161      * Display a single blanked frame using a fixed colour for the
   162      * entire frame (specified in BGR888 format). 
   163      */
   164     void (*display_blank)( uint32_t rgb );
   166     /**
   167      * Copy the image data from the GL buffer to the target memory buffer,
   168      * using the format etc from the buffer. This may force a glFinish()
   169      * but does not invalidate the buffer.
   170      * @param target buffer to fill with image data, which must be large enough
   171      *  to accomodate the image.
   172      * @param buffer Render buffer to read from.
   173      * @param rowstride rowstride of the target data
   174      * @param format colour format to output the data in.
   175      */
   176     gboolean (*read_render_buffer)( unsigned char *target, render_buffer_t buffer,
   177 				    int rowstride, int format );
   179 } *display_driver_t;
   181 display_driver_t get_display_driver_by_name( const char *name );
   182 gboolean display_set_driver( display_driver_t driver );
   184 extern uint32_t pvr2_frame_counter;
   186 extern display_driver_t display_driver;
   188 extern struct display_driver display_agl_driver;
   189 extern struct display_driver display_gtk_driver;
   190 extern struct display_driver display_null_driver;
   192 /****************** Input methods **********************/
   194 typedef void (*input_key_callback_t)( void *data, uint32_t value, uint32_t pressure, gboolean isKeyDown );
   196 /**
   197  * Callback to receive mouse input events
   198  * @param data pointer passed in at the time the hook was registered
   199  * @param buttons bitmask of button states, where bit 0 is button 0 (left), bit 1 is button
   200  * 1 (middle), bit 2 is button 2 (right) and so forth.
   201  * @param x Horizontal movement since the last invocation (in relative mode) or window position 
   202  * (in absolute mode).
   203  * @param y Vertical movement since the last invocation (in relative mode) or window position
   204  * (in absolute mode).
   205  */
   206 typedef void (*input_mouse_callback_t)( void *data, uint32_t buttons, int32_t x, int32_t y );
   208 gboolean input_register_key( const gchar *keysym, input_key_callback_t callback,
   209 			     void *data, uint32_t value );
   211 void input_unregister_key( const gchar *keysym, input_key_callback_t callback,
   212 			   void *data, uint32_t value );
   214 /**
   215  * Register a hook to receive all input events
   216  */
   217 gboolean input_register_hook( input_key_callback_t callback, void *data );
   218 void input_unregister_hook( input_key_callback_t callback, void *data );
   220 /**
   221  * Register a mouse event hook.
   222  * @param relative TRUE if the caller wants relative mouse movement, FALSE for
   223  * absolute mouse positioning. It's not generally possible to receive both at the same time.
   224  */
   225 gboolean input_register_mouse_hook( gboolean relative, input_mouse_callback_t callback, void *data );
   226 void input_unregister_mouse_hook( input_mouse_callback_t callback, void *data );
   228 gboolean input_is_key_valid( const gchar *keysym );
   230 gboolean input_is_key_registered( const gchar *keysym );
   232 uint16_t input_keycode_to_dckeysym( uint16_t keycode );
   234 /********************** Display/Input methods ***********************/
   236 /**
   237  * Auxilliary input driver - provides input separate to and in addition to the
   238  * core UI/display. (primarily used for joystick devices)
   239  */
   240 typedef struct input_driver {
   241     const char *id; /* Short identifier to display in the UI for the device (eg "JS0" ) */
   243     /**
   244      * Given a particular keysym, return the keycode associated with it.
   245      * @param keysym The keysym to be resolved, ie "Tab"
   246      * @return the display-specific keycode, or 0 if the keysym cannot
   247      * be resolved.
   248      */
   249     uint16_t (*resolve_keysym)( struct input_driver *driver, const gchar *keysym );
   251     /**
   252      * Given a device-specific event code, convert it to a dreamcast keyboard code.
   253      * This is only required for actual keyboard devices, other devices should just
   254      * leave this method NULL.
   255      */
   256     uint16_t (*convert_to_dckeysym)( struct input_driver *driver, uint16_t keycode );
   258     /**
   259      * Given a device-specific event code, return the corresponding keysym.
   260      * The string should be newly allocated (caller will free)
   261      */
   262     gchar *(*get_keysym_for_keycode)( struct input_driver *driver, uint16_t keycode );
   264     /**
   265      * Destroy the input driver.
   266      */
   267     void (*destroy)( struct input_driver *driver );
   269 } *input_driver_t;       
   271 /**
   272  * Register a new input driver (which must have a unique name)
   273  * @param driver the driver to register
   274  * @param max_keycode the highest possible keycode reported by the device
   275  * @return TRUE on success, FALSE on failure (eg driver already registed).
   276  */
   277 gboolean input_register_device( input_driver_t driver, uint16_t max_keycode );
   279 /**
   280  * Determine if the system has an input driver with the given unique ID.
   281  * @param id driver id to check
   282  * @return TRUE if the device exists, otherwise FALSE
   283  */
   284 gboolean input_has_device( const gchar *id );
   286 /**
   287  * Unregister an input driver.
   288  * @param driver the driver to unregister
   289  * If the driver is not in fact registered, this function has no effect.
   290  */
   291 void input_unregister_device( input_driver_t driver );
   293 /**
   294  * Called from the UI to indicate that the emulation window is focused (ie
   295  * able to receive input). This method is used to gate non-UI input devices -
   296  * when the display is not focused, all input events will be silently ignored.
   297  */
   298 void display_set_focused( gboolean has_focus );
   300 void input_event_keydown( input_driver_t input, uint16_t keycode, uint32_t pressure );
   302 void input_event_keyup( input_driver_t input, uint16_t keycode, uint32_t pressure );
   304 void input_event_mouse( uint32_t buttons, int32_t x_axis, int32_t y_axis );
   307 typedef void (*display_keysym_callback_t)( void *data, const gchar *keysym );
   309 /**
   310  * Set the keysym hook function (normally used by the UI to receive non-UI
   311  * input events during configuration.
   312  */
   313 void input_set_keysym_hook( display_keysym_callback_t hook, void *data );
   317 #ifdef __cplusplus
   318 }
   319 #endif
   320 #endif
.