[pcsx_rearmed.git] / include / psemu_plugin_defs.h

#ifndef _PSEMU_PLUGIN_DEFS_H
#define _PSEMU_PLUGIN_DEFS_H

#ifdef __cplusplus
extern "C" {
#endif

// this can't be __stdcall like it was in PSEmu API as too many functions are mixed up
#undef CALLBACK
#define CALLBACK

// header version
#define _PPDK_HEADER_VERSION		3

#define PLUGIN_VERSION				1

// plugin type returned by PSEgetLibType (types can be merged if plugin is multi type!)
#define PSE_LT_CDR					1
#define PSE_LT_GPU					2
#define PSE_LT_SPU					4
#define PSE_LT_PAD					8
#define PSE_LT_NET					16

// DLL function return codes
#define PSE_ERR_SUCCESS				0	// every function in DLL if completed sucessfully should return this value
#define PSE_ERR_FATAL				-1	// undefined error but fatal one, that kills all functionality

// XXX_Init return values
// Those return values apply to all libraries
// currently obsolete - preserved for compatibilty

#define PSE_INIT_ERR_SUCCESS		0	// initialization went OK
#define PSE_INIT_ERR_NOTCONFIGURED	-2	// this driver is not configured
#define PSE_INIT_ERR_NOHARDWARE		-3	// this driver can not operate properly on this hardware or hardware is not detected

/*         GPU PlugIn          */

//  GPU_Test return values

// sucess, everything configured, and went OK.
#define PSE_GPU_ERR_SUCCESS			0

// ERRORS
// this error might be returned as critical error but none of below
#define PSE_GPU_ERR					-20


// this driver is not configured
#define PSE_GPU_ERR_NOTCONFIGURED	PSE_GPU_ERR - 1
// this driver failed Init
#define PSE_GPU_ERR_INIT			PSE_GPU_ERR - 2

// WARNINGS
// this warning might be returned as undefined warning but allowing driver to continue
#define PSE_GPU_WARN				20

//  GPU_Query		- will be implemented soon

typedef struct
{
	unsigned int flags;
	unsigned int status;
 	void*	window;
	unsigned char reserved[100];
} gpuQueryS;

// gpuQueryS.flags
// if driver can operate in both modes it must support GPU_changeMode();
#define PSE_GPU_FLAGS_FULLSCREEN		1	// this driver can operate in fullscreen mode
#define PSE_GPU_FLAGS_WINDOWED			2	// this driver can operate in windowed mode

// gpuQueryS.status
#define PSE_GPU_STATUS_WINDOWWRONG	1	// this driver cannot operate in this windowed mode

//  GPU_Query	End	- will be implemented in v2


/*         CDR PlugIn          */

//	CDR_Test return values

// sucess, everything configured, and went OK.
#define PSE_CDR_ERR_SUCCESS			0

// general failure (error undefined)
#define PSE_CDR_ERR_FAILURE			-1

// ERRORS
#define PSE_CDR_ERR -40
// this driver is not configured
#define PSE_CDR_ERR_NOTCONFIGURED	PSE_CDR_ERR - 0
// if this driver is unable to read data from medium
#define PSE_CDR_ERR_NOREAD			PSE_CDR_ERR - 1

// WARNINGS
#define PSE_CDR_WARN 40
// if this driver emulates lame mode ie. can read only 2048 tracks and sector header is emulated
// this might happen to CDROMS that do not support RAW mode reading - surelly it will kill many games
#define PSE_CDR_WARN_LAMECD			PSE_CDR_WARN + 0


/*         SPU PlugIn          */

// some info retricted (now!)

// sucess, everything configured, and went OK.
#define PSE_SPU_ERR_SUCCESS 0

// ERRORS
// this error might be returned as critical error but none of below
#define PSE_SPU_ERR					-60

// this driver is not configured
#define PSE_SPU_ERR_NOTCONFIGURED	PSE_SPU_ERR - 1
// this driver failed Init
#define PSE_SPU_ERR_INIT			PSE_SPU_ERR - 2


// WARNINGS
// this warning might be returned as undefined warning but allowing driver to continue
#define PSE_SPU_WARN				60


/*         PAD PlugIn          */

/*

  functions that must be exported from PAD Plugin

  long	PADinit(long flags);	// called only once when PSEmu Starts
  void	PADshutdown(void);		// called when PSEmu exits
  long	PADopen(PadInitS *);	// called when PSEmu is running program
  long	PADclose(void);
  long	PADconfigure(void);
  void  PADabout(void);
  long  PADtest(void);			// called from Configure Dialog and after PADopen();
  long	PADquery(void);

  unsigned char PADstartPoll(int);
  unsigned char PADpoll(unsigned char, int *);

*/

// PADquery responses (notice - values ORed)
// PSEmu will use them also in PADinit to tell Plugin which Ports will use
// notice that PSEmu will call PADinit and PADopen only once when they are from
// same plugin

// might be used in port 1
#define PSE_PAD_USE_PORT1			1
// might be used in port 2
#define PSE_PAD_USE_PORT2			2


// No controller
#define PSE_PAD_TYPE_NONE			0
// MOUSE SCPH-1030
#define PSE_PAD_TYPE_MOUSE			1
// NEGCON - 16 button analog controller SLPH-00001
#define PSE_PAD_TYPE_NEGCON			2
// GUN CONTROLLER - gun controller SLPH-00014 from Konami
#define PSE_PAD_TYPE_GUN			3
// STANDARD PAD SCPH-1080, SCPH-1150
#define PSE_PAD_TYPE_STANDARD		4
// ANALOG JOYSTICK SCPH-1110
#define PSE_PAD_TYPE_ANALOGJOY		5
// GUNCON - gun controller SLPH-00034 from Namco
#define PSE_PAD_TYPE_GUNCON			6
// ANALOG CONTROLLER SCPH-1150
#define PSE_PAD_TYPE_ANALOGPAD		7


// sucess, everything configured, and went OK.
#define PSE_PAD_ERR_SUCCESS			0
// general plugin failure (undefined error)
#define PSE_PAD_ERR_FAILURE			-1


// ERRORS
// this error might be returned as critical error but none of below
#define PSE_PAD_ERR					-80
// this driver is not configured
#define PSE_PAD_ERR_NOTCONFIGURED	PSE_PAD_ERR - 1
// this driver failed Init
#define PSE_PAD_ERR_INIT			PSE_PAD_ERR - 2


// WARNINGS
// this warning might be returned as undefined warning but allowing driver to continue
#define PSE_PAD_WARN				80


typedef struct PadDataS
{
	// controller type - fill it withe predefined values above
	unsigned char controllerType;

	unsigned char padding;
	unsigned short saveSize;

	int portMultitap;
	int requestPadIndex;

	// status of buttons - every controller fills this field
	unsigned short buttonStatus;

	// for analog pad fill those next 4 bytes
	// values are analog in range 0-255 where 127 is center position
	unsigned char rightJoyX, rightJoyY, leftJoyX, leftJoyY;

	// for mouse fill those next 2 bytes
	// values are in range -128 - 127
	unsigned char moveX, moveY;

	// Lightgun values
	int absoluteX, absoluteY;

	unsigned char Vib[2];
	unsigned char VibF[2];
	
	struct {
		unsigned char configMode;
		unsigned char padMode; // 0 : digital 1: analog
		unsigned char cmd4dConfig[6];
		unsigned int  lastUseFrame;
		unsigned int  unused;
		unsigned char configModeUsed;
		unsigned char autoAnalogTried;
		unsigned char userToggled;
		unsigned char padding;
	} ds;
	unsigned char multitapLongModeEnabled;
	unsigned char padding2;
	unsigned char txData[34];

	unsigned char reserved[22];
} PadDataS;

/*         NET PlugIn v2       */
/* Added by linuzappz@pcsx.net */

/* Modes bits for NETsendData/NETrecvData */
#define PSE_NET_BLOCKING	0x00000000
#define PSE_NET_NONBLOCKING	0x00000001

/* note: unsupported fields should be zeroed.
 
typedef struct {
	char EmuName[32];
	char CdromID[9];	// ie. 'SCPH12345', no \0 trailing character
	char CdromLabel[11];
	void *psxMem;
	GPUshowScreenPic GPU_showScreenPic;
	GPUdisplayText GPU_displayText;
	PADsetSensitive PAD_setSensitive;
	char GPUpath[256];
	char SPUpath[256];
	char CDRpath[256];
	char MCD1path[256];
	char MCD2path[256];
	char BIOSpath[256];	// 'HLE' for internal bios
	char Unused[1024];
} netInfo;

*/

/*
  basic funcs:

   long NETopen(HWND hWnd)
    opens the connection.
    shall return 0 on success, else -1.
    -1 is also returned if the user selects offline mode.

   long NETclose()
    closes the connection.
    shall return 0 on success, else -1.

   void NETpause()
    this is called when the user paused the emulator.

   void NETresume()
    this is called when the user resumed the emulator.

   long NETqueryPlayer()
    returns player number

   long NETsendPadData(void *pData, int Size)
    this should be called for the first pad only on each side.

   long NETrecvPadData(void *pData, int Pad)
    call this for Pad 1/2 to get the data sent by the above func.

  extended funcs:

   long NETsendData(void *pData, int Size, int Mode)
    sends Size bytes from pData to the other side.

   long NETrecvData(void *pData, int Size, int Mode)
    receives Size bytes from pData to the other side.

   void NETsetInfo(netInfo *info);
    sets the netInfo struct.

   void NETkeypressed(int key) (linux only)
    key is a XK_?? (X11) keycode.
*/

#ifdef __cplusplus
}
#endif
#endif // _PSEMU_PLUGIN_DEFS_H
Commit	Line	Data
	1	#ifndef _PSEMU_PLUGIN_DEFS_H
	2	#define _PSEMU_PLUGIN_DEFS_H
	3
	4	#ifdef __cplusplus
	5	extern "C" {
	6	#endif
	7
	8	// this can't be __stdcall like it was in PSEmu API as too many functions are mixed up
	9	#undef CALLBACK
	10	#define CALLBACK
	11
	12	// header version
	13	#define _PPDK_HEADER_VERSION 3
	14
	15	#define PLUGIN_VERSION 1
	16
	17	// plugin type returned by PSEgetLibType (types can be merged if plugin is multi type!)
	18	#define PSE_LT_CDR 1
	19	#define PSE_LT_GPU 2
	20	#define PSE_LT_SPU 4
	21	#define PSE_LT_PAD 8
	22	#define PSE_LT_NET 16
	23
	24	// DLL function return codes
	25	#define PSE_ERR_SUCCESS 0 // every function in DLL if completed sucessfully should return this value
	26	#define PSE_ERR_FATAL -1 // undefined error but fatal one, that kills all functionality
	27
	28	// XXX_Init return values
	29	// Those return values apply to all libraries
	30	// currently obsolete - preserved for compatibilty
	31
	32	#define PSE_INIT_ERR_SUCCESS 0 // initialization went OK
	33	#define PSE_INIT_ERR_NOTCONFIGURED -2 // this driver is not configured
	34	#define PSE_INIT_ERR_NOHARDWARE -3 // this driver can not operate properly on this hardware or hardware is not detected
	35
	36	/* GPU PlugIn */
	37
	38	// GPU_Test return values
	39
	40	// sucess, everything configured, and went OK.
	41	#define PSE_GPU_ERR_SUCCESS 0
	42
	43	// ERRORS
	44	// this error might be returned as critical error but none of below
	45	#define PSE_GPU_ERR -20
	46
	47
	48	// this driver is not configured
	49	#define PSE_GPU_ERR_NOTCONFIGURED PSE_GPU_ERR - 1
	50	// this driver failed Init
	51	#define PSE_GPU_ERR_INIT PSE_GPU_ERR - 2
	52
	53	// WARNINGS
	54	// this warning might be returned as undefined warning but allowing driver to continue
	55	#define PSE_GPU_WARN 20
	56
	57	// GPU_Query - will be implemented soon
	58
	59	typedef struct
	60	{
	61	unsigned int flags;
	62	unsigned int status;
	63	void* window;
	64	unsigned char reserved[100];
	65	} gpuQueryS;
	66
	67	// gpuQueryS.flags
	68	// if driver can operate in both modes it must support GPU_changeMode();
	69	#define PSE_GPU_FLAGS_FULLSCREEN 1 // this driver can operate in fullscreen mode
	70	#define PSE_GPU_FLAGS_WINDOWED 2 // this driver can operate in windowed mode
	71
	72	// gpuQueryS.status
	73	#define PSE_GPU_STATUS_WINDOWWRONG 1 // this driver cannot operate in this windowed mode
	74
	75	// GPU_Query End - will be implemented in v2
	76
	77
	78	/* CDR PlugIn */
	79
	80	// CDR_Test return values
	81
	82	// sucess, everything configured, and went OK.
	83	#define PSE_CDR_ERR_SUCCESS 0
	84
	85	// general failure (error undefined)
	86	#define PSE_CDR_ERR_FAILURE -1
	87
	88	// ERRORS
	89	#define PSE_CDR_ERR -40
	90	// this driver is not configured
	91	#define PSE_CDR_ERR_NOTCONFIGURED PSE_CDR_ERR - 0
	92	// if this driver is unable to read data from medium
	93	#define PSE_CDR_ERR_NOREAD PSE_CDR_ERR - 1
	94
	95	// WARNINGS
	96	#define PSE_CDR_WARN 40
	97	// if this driver emulates lame mode ie. can read only 2048 tracks and sector header is emulated
	98	// this might happen to CDROMS that do not support RAW mode reading - surelly it will kill many games
	99	#define PSE_CDR_WARN_LAMECD PSE_CDR_WARN + 0
	100
	101
	102
	103
	104	/* SPU PlugIn */
	105
	106	// some info retricted (now!)
	107
	108	// sucess, everything configured, and went OK.
	109	#define PSE_SPU_ERR_SUCCESS 0
	110
	111	// ERRORS
	112	// this error might be returned as critical error but none of below
	113	#define PSE_SPU_ERR -60
	114
	115	// this driver is not configured
	116	#define PSE_SPU_ERR_NOTCONFIGURED PSE_SPU_ERR - 1
	117	// this driver failed Init
	118	#define PSE_SPU_ERR_INIT PSE_SPU_ERR - 2
	119
	120
	121	// WARNINGS
	122	// this warning might be returned as undefined warning but allowing driver to continue
	123	#define PSE_SPU_WARN 60
	124
	125
	126
	127
	128	/* PAD PlugIn */
	129
	130	/*
	131
	132	functions that must be exported from PAD Plugin
	133
	134	long PADinit(long flags); // called only once when PSEmu Starts
	135	void PADshutdown(void); // called when PSEmu exits
	136	long PADopen(PadInitS *); // called when PSEmu is running program
	137	long PADclose(void);
	138	long PADconfigure(void);
	139	void PADabout(void);
	140	long PADtest(void); // called from Configure Dialog and after PADopen();
	141	long PADquery(void);
	142
	143	unsigned char PADstartPoll(int);
	144	unsigned char PADpoll(unsigned char, int *);
	145
	146	*/
	147
	148	// PADquery responses (notice - values ORed)
	149	// PSEmu will use them also in PADinit to tell Plugin which Ports will use
	150	// notice that PSEmu will call PADinit and PADopen only once when they are from
	151	// same plugin
	152
	153	// might be used in port 1
	154	#define PSE_PAD_USE_PORT1 1
	155	// might be used in port 2
	156	#define PSE_PAD_USE_PORT2 2
	157
	158
	159
	160	// No controller
	161	#define PSE_PAD_TYPE_NONE 0
	162	// MOUSE SCPH-1030
	163	#define PSE_PAD_TYPE_MOUSE 1
	164	// NEGCON - 16 button analog controller SLPH-00001
	165	#define PSE_PAD_TYPE_NEGCON 2
	166	// GUN CONTROLLER - gun controller SLPH-00014 from Konami
	167	#define PSE_PAD_TYPE_GUN 3
	168	// STANDARD PAD SCPH-1080, SCPH-1150
	169	#define PSE_PAD_TYPE_STANDARD 4
	170	// ANALOG JOYSTICK SCPH-1110
	171	#define PSE_PAD_TYPE_ANALOGJOY 5
	172	// GUNCON - gun controller SLPH-00034 from Namco
	173	#define PSE_PAD_TYPE_GUNCON 6
	174	// ANALOG CONTROLLER SCPH-1150
	175	#define PSE_PAD_TYPE_ANALOGPAD 7
	176
	177
	178	// sucess, everything configured, and went OK.
	179	#define PSE_PAD_ERR_SUCCESS 0
	180	// general plugin failure (undefined error)
	181	#define PSE_PAD_ERR_FAILURE -1
	182
	183
	184	// ERRORS
	185	// this error might be returned as critical error but none of below
	186	#define PSE_PAD_ERR -80
	187	// this driver is not configured
	188	#define PSE_PAD_ERR_NOTCONFIGURED PSE_PAD_ERR - 1
	189	// this driver failed Init
	190	#define PSE_PAD_ERR_INIT PSE_PAD_ERR - 2
	191
	192
	193	// WARNINGS
	194	// this warning might be returned as undefined warning but allowing driver to continue
	195	#define PSE_PAD_WARN 80
	196
	197
	198	typedef struct PadDataS
	199	{
	200	// controller type - fill it withe predefined values above
	201	unsigned char controllerType;
	202
	203	unsigned char padding;
	204	unsigned short saveSize;
	205
	206	int portMultitap;
	207	int requestPadIndex;
	208
	209	// status of buttons - every controller fills this field
	210	unsigned short buttonStatus;
	211
	212	// for analog pad fill those next 4 bytes
	213	// values are analog in range 0-255 where 127 is center position
	214	unsigned char rightJoyX, rightJoyY, leftJoyX, leftJoyY;
	215
	216	// for mouse fill those next 2 bytes
	217	// values are in range -128 - 127
	218	unsigned char moveX, moveY;
	219
	220	// Lightgun values
	221	int absoluteX, absoluteY;
	222
	223	unsigned char Vib[2];
	224	unsigned char VibF[2];
	225
	226	struct {
	227	unsigned char configMode;
	228	unsigned char padMode; // 0 : digital 1: analog
	229	unsigned char cmd4dConfig[6];
	230	unsigned int lastUseFrame;
	231	unsigned int unused;
	232	unsigned char configModeUsed;
	233	unsigned char autoAnalogTried;
	234	unsigned char userToggled;
	235	unsigned char padding;
	236	} ds;
	237	unsigned char multitapLongModeEnabled;
	238	unsigned char padding2;
	239	unsigned char txData[34];
	240
	241	unsigned char reserved[22];
	242	} PadDataS;
	243
	244	/* NET PlugIn v2 */
	245	/* Added by linuzappz@pcsx.net */
	246
	247	/* Modes bits for NETsendData/NETrecvData */
	248	#define PSE_NET_BLOCKING 0x00000000
	249	#define PSE_NET_NONBLOCKING 0x00000001
	250
	251	/* note: unsupported fields should be zeroed.
	252
	253	typedef struct {
	254	char EmuName[32];
	255	char CdromID[9]; // ie. 'SCPH12345', no \0 trailing character
	256	char CdromLabel[11];
	257	void *psxMem;
	258	GPUshowScreenPic GPU_showScreenPic;
	259	GPUdisplayText GPU_displayText;
	260	PADsetSensitive PAD_setSensitive;
	261	char GPUpath[256];
	262	char SPUpath[256];
	263	char CDRpath[256];
	264	char MCD1path[256];
	265	char MCD2path[256];
	266	char BIOSpath[256]; // 'HLE' for internal bios
	267	char Unused[1024];
	268	} netInfo;
	269
	270	*/
	271
	272	/*
	273	basic funcs:
	274
	275	long NETopen(HWND hWnd)
	276	opens the connection.
	277	shall return 0 on success, else -1.
	278	-1 is also returned if the user selects offline mode.
	279
	280	long NETclose()
	281	closes the connection.
	282	shall return 0 on success, else -1.
	283
	284	void NETpause()
	285	this is called when the user paused the emulator.
	286
	287	void NETresume()
	288	this is called when the user resumed the emulator.
	289
	290	long NETqueryPlayer()
	291	returns player number
	292
	293	long NETsendPadData(void *pData, int Size)
	294	this should be called for the first pad only on each side.
	295
	296	long NETrecvPadData(void *pData, int Pad)
	297	call this for Pad 1/2 to get the data sent by the above func.
	298
	299	extended funcs:
	300
	301	long NETsendData(void *pData, int Size, int Mode)
	302	sends Size bytes from pData to the other side.
	303
	304	long NETrecvData(void *pData, int Size, int Mode)
	305	receives Size bytes from pData to the other side.
	306
	307	void NETsetInfo(netInfo *info);
	308	sets the netInfo struct.
	309
	310	void NETkeypressed(int key) (linux only)
	311	key is a XK_?? (X11) keycode.
	312	*/
	313
	314	#ifdef __cplusplus
	315	}
	316	#endif
	317	#endif // _PSEMU_PLUGIN_DEFS_H