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