2012-04-03 17:19:18 +00:00
/* SSNES - A frontend for libretro.
2012-01-08 00:08:18 +00:00
* Copyright ( C ) 2010 - 2012 - Hans - Kristian Arntzen
2010-05-28 16:22:57 +00:00
*
* SSNES is free software : you can redistribute it and / or modify it under the terms
* of the GNU General Public License as published by the Free Software Found -
* ation , either version 3 of the License , or ( at your option ) any later version .
*
* SSNES is distributed in the hope that it will be useful , but WITHOUT ANY WARRANTY ;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE . See the GNU General Public License for more details .
*
* You should have received a copy of the GNU General Public License along with SSNES .
* If not , see < http : //www.gnu.org/licenses/>.
*/
# ifndef __DRIVER__H
# define __DRIVER__H
2011-01-07 11:50:14 +00:00
# include <sys/types.h>
2011-12-24 12:46:12 +00:00
# include "boolean.h"
2010-05-28 16:22:57 +00:00
# include <stdlib.h>
# include <stdint.h>
2011-12-24 23:59:46 +00:00
# include "msvc/msvc_compat.h"
2011-09-13 12:40:33 +00:00
# include "input/keysym.h"
2010-05-28 16:22:57 +00:00
2011-12-24 12:46:12 +00:00
# define AUDIO_CHUNK_SIZE_BLOCKING 64
# define AUDIO_CHUNK_SIZE_NONBLOCKING 2048 // So we don't get complete line-noise when fast-forwarding audio.
# define AUDIO_MAX_RATIO 16
2011-10-25 21:02:17 +00:00
// SNES has 12 buttons from 0-11 (libsnes.hpp)
# define SSNES_FIRST_META_KEY 12
2011-01-08 17:37:45 +00:00
enum
{
2011-10-25 21:02:17 +00:00
SSNES_FAST_FORWARD_KEY = SSNES_FIRST_META_KEY ,
2011-05-24 00:31:21 +00:00
SSNES_FAST_FORWARD_HOLD_KEY ,
2011-01-08 17:37:45 +00:00
SSNES_LOAD_STATE_KEY ,
SSNES_SAVE_STATE_KEY ,
SSNES_FULLSCREEN_TOGGLE_KEY ,
SSNES_QUIT_KEY ,
2011-01-23 22:09:54 +00:00
SSNES_STATE_SLOT_PLUS ,
SSNES_STATE_SLOT_MINUS ,
2011-01-29 17:42:21 +00:00
SSNES_AUDIO_INPUT_RATE_PLUS ,
SSNES_AUDIO_INPUT_RATE_MINUS ,
2011-01-31 15:48:42 +00:00
SSNES_REWIND ,
2011-02-02 11:45:56 +00:00
SSNES_MOVIE_RECORD_TOGGLE ,
2011-02-05 19:46:58 +00:00
SSNES_PAUSE_TOGGLE ,
2011-10-17 19:30:58 +00:00
SSNES_FRAMEADVANCE ,
2011-03-24 19:41:28 +00:00
SSNES_RESET ,
2011-03-29 16:04:41 +00:00
SSNES_SHADER_NEXT ,
SSNES_SHADER_PREV ,
2011-04-17 11:30:59 +00:00
SSNES_CHEAT_INDEX_PLUS ,
SSNES_CHEAT_INDEX_MINUS ,
2011-05-15 15:16:29 +00:00
SSNES_CHEAT_TOGGLE ,
2011-05-17 17:20:41 +00:00
SSNES_SCREENSHOT ,
2011-09-06 17:53:22 +00:00
SSNES_DSP_CONFIG ,
2011-11-26 14:54:58 +00:00
SSNES_MUTE ,
2012-01-21 13:24:38 +00:00
SSNES_NETPLAY_FLIP ,
2012-03-04 11:01:07 +00:00
SSNES_SLOWMOTION ,
2012-01-11 09:00:24 +00:00
2012-01-20 23:30:01 +00:00
# ifdef SSNES_CONSOLE
2012-01-11 09:00:24 +00:00
SSNES_CHEAT_INPUT ,
2012-01-11 01:25:49 +00:00
SSNES_SRAM_WRITE_PROTECT ,
2012-01-11 09:00:24 +00:00
# endif
2011-09-06 17:53:22 +00:00
SSNES_BIND_LIST_END
2011-01-08 17:37:45 +00:00
} ;
2010-08-16 16:40:17 +00:00
2010-05-28 16:22:57 +00:00
struct snes_keybind
{
2012-01-30 00:20:35 +00:00
bool valid ;
2010-05-28 16:22:57 +00:00
int id ;
2011-09-13 12:40:33 +00:00
enum ssnes_key key ;
2012-03-09 17:17:53 +00:00
// PC only uses lower 16-bits.
// Full 64-bit can be used for port-specific purposes, like simplifying multiple binds, etc.
uint64_t joykey ;
2010-12-23 23:58:42 +00:00
uint32_t joyaxis ;
2010-05-28 16:22:57 +00:00
} ;
2010-05-29 12:45:40 +00:00
typedef struct video_info
{
2011-05-05 18:23:08 +00:00
unsigned width ;
unsigned height ;
2010-05-29 12:45:40 +00:00
bool fullscreen ;
bool vsync ;
bool force_aspect ;
bool smooth ;
2012-01-17 22:49:03 +00:00
unsigned input_scale ; // Maximum input size: SSNES_SCALE_BASE * input_scale
2011-03-07 16:22:03 +00:00
bool rgb32 ; // Use 32-bit RGBA rather than native XBGR1555.
2010-05-29 12:45:40 +00:00
} video_info_t ;
2010-05-28 16:22:57 +00:00
typedef struct audio_driver
{
2011-11-01 19:27:59 +00:00
void * ( * init ) ( const char * device , unsigned rate , unsigned latency ) ;
ssize_t ( * write ) ( void * data , const void * buf , size_t size ) ;
bool ( * stop ) ( void * data ) ;
bool ( * start ) ( void * data ) ;
void ( * set_nonblock_state ) ( void * data , bool toggle ) ; // Should we care about blocking in audio thread? Fast forwarding.
void ( * free ) ( void * data ) ;
2011-01-15 19:37:42 +00:00
bool ( * use_float ) ( void * data ) ; // Defines if driver will take standard floating point samples, or int16_t samples.
2010-12-29 19:05:57 +00:00
const char * ident ;
2012-02-14 00:16:37 +00:00
size_t ( * write_avail ) ( void * data ) ; // Optional
size_t ( * buffer_size ) ( void * data ) ; // Optional
2010-05-28 16:22:57 +00:00
} audio_driver_t ;
2012-01-12 19:16:47 +00:00
# define AXIS_NEG(x) (((uint32_t)(x) << 16) | UINT16_C(0xFFFF))
# define AXIS_POS(x) ((uint32_t)(x) | UINT32_C(0xFFFF0000))
# define AXIS_NONE UINT32_C(0xFFFFFFFF)
2012-03-09 17:17:53 +00:00
# define AXIS_DIR_NONE UINT16_C(0xFFFF)
2011-01-08 21:15:02 +00:00
2012-01-12 19:16:47 +00:00
# define AXIS_NEG_GET(x) (((uint32_t)(x) >> 16) & UINT16_C(0xFFFF))
# define AXIS_POS_GET(x) ((uint32_t)(x) & UINT16_C(0xFFFF))
2011-01-08 21:15:02 +00:00
2012-03-09 17:17:53 +00:00
# define NO_BTN UINT16_C(0xFFFF) // I hope no joypad will ever have this many buttons ... ;)
2011-01-08 21:15:02 +00:00
# define HAT_UP_MASK (1 << 15)
# define HAT_DOWN_MASK (1 << 14)
# define HAT_LEFT_MASK (1 << 13)
# define HAT_RIGHT_MASK (1 << 12)
# define HAT_MAP(x, hat) ((x & ((1 << 12) - 1)) | hat)
# define HAT_MASK (HAT_UP_MASK | HAT_DOWN_MASK | HAT_LEFT_MASK | HAT_RIGHT_MASK)
# define GET_HAT_DIR(x) (x & HAT_MASK)
# define GET_HAT(x) (x & (~HAT_MASK))
2010-05-28 16:22:57 +00:00
typedef struct input_driver
{
2011-11-01 19:27:59 +00:00
void * ( * init ) ( void ) ;
void ( * poll ) ( void * data ) ;
int16_t ( * input_state ) ( void * data , const struct snes_keybind * * snes_keybinds , bool port , unsigned device , unsigned index , unsigned id ) ;
bool ( * key_pressed ) ( void * data , int key ) ;
void ( * free ) ( void * data ) ;
2010-12-29 19:05:57 +00:00
const char * ident ;
2010-05-28 16:22:57 +00:00
} input_driver_t ;
typedef struct video_driver
{
2011-11-01 19:27:59 +00:00
void * ( * init ) ( const video_info_t * video , const input_driver_t * * input , void * * input_data ) ;
2011-01-06 19:01:32 +00:00
// Should the video driver act as an input driver as well? :) The video init might preinitialize an input driver to override the settings in case the video driver relies on input driver for event handling, e.g.
2011-11-01 19:27:59 +00:00
bool ( * frame ) ( void * data , const void * frame , unsigned width , unsigned height , unsigned pitch , const char * msg ) ; // msg is for showing a message on the screen along with the video frame.
void ( * set_nonblock_state ) ( void * data , bool toggle ) ; // Should we care about syncing to vblank? Fast forwarding.
2011-01-06 19:01:32 +00:00
// Is the window still active?
bool ( * alive ) ( void * data ) ;
2011-02-05 20:45:44 +00:00
bool ( * focus ) ( void * data ) ; // Does the window have focus?
2011-03-29 16:04:41 +00:00
bool ( * xml_shader ) ( void * data , const char * path ) ; // Sets XML-shader. Might not be implemented.
2011-11-01 19:27:59 +00:00
void ( * free ) ( void * data ) ;
2010-12-29 19:05:57 +00:00
const char * ident ;
2012-02-13 18:17:13 +00:00
// Callbacks essentially useless on PC, but useful on consoles where the drivers are used for more stuff.
# ifdef SSNES_CONSOLE
void ( * set_swap_block_state ) ( void * data , bool toggle ) ; // Block swapping from being called in ::frame().
2012-02-13 19:57:32 +00:00
void ( * swap ) ( void * data ) ; // Explicitly swap buffers. Only useful when set_swap_block_state() is set to true.
2012-04-09 20:02:46 +00:00
void ( * set_aspect_ratio ) ( void * data , unsigned aspectratio_idx ) ; // TODO: refactor this properly to float.
2012-02-13 18:17:13 +00:00
# endif
2012-03-30 17:09:34 +00:00
void ( * set_rotation ) ( void * data , unsigned rotation ) ;
2010-05-28 16:22:57 +00:00
} video_driver_t ;
typedef struct driver
{
const audio_driver_t * audio ;
const video_driver_t * video ;
const input_driver_t * input ;
void * audio_data ;
void * video_data ;
void * input_data ;
} driver_t ;
2010-12-24 00:26:36 +00:00
void init_drivers ( void ) ;
2012-04-01 17:38:50 +00:00
void init_drivers_pre ( void ) ;
2010-12-24 00:26:36 +00:00
void uninit_drivers ( void ) ;
void init_video_input ( void ) ;
void uninit_video_input ( void ) ;
void init_audio ( void ) ;
void uninit_audio ( void ) ;
extern driver_t driver ;
//////////////////////////////////////////////// Backends
extern const audio_driver_t audio_rsound ;
extern const audio_driver_t audio_oss ;
extern const audio_driver_t audio_alsa ;
extern const audio_driver_t audio_roar ;
extern const audio_driver_t audio_openal ;
2011-01-01 02:53:30 +00:00
extern const audio_driver_t audio_jack ;
2011-01-07 14:50:16 +00:00
extern const audio_driver_t audio_sdl ;
2011-01-27 00:46:00 +00:00
extern const audio_driver_t audio_xa ;
2011-01-29 00:15:09 +00:00
extern const audio_driver_t audio_pulse ;
2011-05-14 23:46:11 +00:00
extern const audio_driver_t audio_ext ;
2011-08-04 16:45:40 +00:00
extern const audio_driver_t audio_dsound ;
2011-08-08 15:27:52 +00:00
extern const audio_driver_t audio_coreaudio ;
2011-12-13 22:17:37 +00:00
extern const audio_driver_t audio_xenon360 ;
2012-01-05 12:30:13 +00:00
extern const audio_driver_t audio_xdk360 ;
2011-11-30 16:11:42 +00:00
extern const audio_driver_t audio_ps3 ;
2011-12-14 11:49:13 +00:00
extern const audio_driver_t audio_wii ;
2010-12-24 00:26:36 +00:00
extern const video_driver_t video_gl ;
2011-12-14 13:26:40 +00:00
extern const video_driver_t video_wii ;
2011-12-15 12:54:22 +00:00
extern const video_driver_t video_xenon360 ;
2011-03-13 03:51:09 +00:00
extern const video_driver_t video_xvideo ;
2012-01-05 12:30:13 +00:00
extern const video_driver_t video_xdk360 ;
2011-04-21 01:23:44 +00:00
extern const video_driver_t video_sdl ;
2011-05-11 15:57:31 +00:00
extern const video_driver_t video_ext ;
2011-01-06 17:34:11 +00:00
extern const input_driver_t input_sdl ;
2011-03-13 03:51:09 +00:00
extern const input_driver_t input_x ;
2011-12-02 01:22:29 +00:00
extern const input_driver_t input_ps3 ;
2011-12-14 00:35:17 +00:00
extern const input_driver_t input_xenon360 ;
2011-12-14 12:20:22 +00:00
extern const input_driver_t input_wii ;
2012-01-05 12:30:13 +00:00
extern const input_driver_t input_xdk360 ;
2010-12-24 00:26:36 +00:00
////////////////////////////////////////////////
2012-03-28 22:30:50 +00:00
// Convenience macros.
# ifdef HAVE_GRIFFIN
2012-03-28 23:15:22 +00:00
# include "console/griffin/hook.h"
2012-03-28 22:30:50 +00:00
# else
# define audio_init_func(device, rate, latency) driver.audio->init(device, rate, latency)
# define audio_write_func(buf, size) driver.audio->write(driver.audio_data, buf, size)
# define audio_stop_func() driver.audio->stop(driver.audio_data)
# define audio_start_func() driver.audio->start(driver.audio_data)
# define audio_set_nonblock_state_func(state) driver.audio->set_nonblock_state(driver.audio_data, state)
# define audio_free_func() driver.audio->free(driver.audio_data)
# define audio_use_float_func() driver.audio->use_float(driver.audio_data)
# define audio_write_avail_func() driver.audio->write_avail(driver.audio_data)
# define audio_buffer_size_func() driver.audio->buffer_size(driver.audio_data)
# define video_init_func(video_info, input, input_data) \
driver . video - > init ( video_info , input , input_data )
# define video_frame_func(data, width, height, pitch, msg) \
driver . video - > frame ( driver . video_data , data , width , height , pitch , msg )
# define video_set_nonblock_state_func(state) driver.video->set_nonblock_state(driver.video_data, state)
# define video_alive_func() driver.video->alive(driver.video_data)
# define video_focus_func() driver.video->focus(driver.video_data)
# define video_xml_shader_func(path) driver.video->xml_shader(driver.video_data, path)
2012-03-30 17:09:34 +00:00
# define video_set_rotation_func(rotate) driver.video->set_rotation(driver.video_data, rotate)
2012-04-09 14:04:24 +00:00
# define video_set_aspect_ratio_func(aspect_idx) driver.video->set_aspect_ratio(driver.video_data, aspect_idx)
2012-03-28 22:30:50 +00:00
# define video_free_func() driver.video->free(driver.video_data)
# define input_init_func() driver.input->init()
# define input_poll_func() driver.input->poll(driver.input_data)
# define input_input_state_func(snes_keybinds, port, device, index, id) \
driver . input - > input_state ( driver . input_data , snes_keybinds , port , device , index , id )
# define input_key_pressed_func(key) driver.input->key_pressed(driver.input_data, key)
# define input_free_func() driver.input->free(driver.input_data)
2010-05-28 16:22:57 +00:00
# endif
2012-03-28 22:30:50 +00:00
# endif