project64/Source/Project64-core/Plugins/PluginBase.cpp

260 lines
7.8 KiB
C++
Raw Normal View History

/****************************************************************************
* *
2015-11-10 05:21:49 +00:00
* Project64 - A Nintendo 64 emulator. *
* http://www.pj64-emu.com/ *
* Copyright (C) 2012 Project64. All rights reserved. *
* *
* License: *
* GNU/GPLv2 http://www.gnu.org/licenses/gpl-2.0.html *
* *
****************************************************************************/
#include "stdafx.h"
2015-12-06 09:59:58 +00:00
#include "PluginBase.h"
#include <Windows.h>
CPlugin::CPlugin() :
2015-12-10 18:23:00 +00:00
DllAbout(NULL),
DllConfig(NULL),
CloseDLL(NULL),
RomOpen(NULL),
RomClosed(NULL),
PluginOpened(NULL),
SetSettingInfo(NULL),
SetSettingInfo2(NULL),
SetSettingInfo3(NULL),
m_hDll(NULL),
m_Initialized(false),
m_RomOpen(false)
{
2015-11-08 06:08:15 +00:00
memset(&m_PluginInfo, 0, sizeof(m_PluginInfo));
}
CPlugin::~CPlugin()
{
2015-11-08 06:08:15 +00:00
UnloadPlugin();
}
2015-12-10 18:23:00 +00:00
bool CPlugin::Load(const char * FileName)
{
2015-11-08 06:08:15 +00:00
// Already loaded, so unload first.
if (m_hDll != NULL)
{
UnloadPlugin();
}
// Try to load the plugin DLL
//Try to load the DLL library
if (bHaveDebugger())
{
m_hDll = LoadLibrary(FileName);
}
else
{
UINT LastErrorMode = SetErrorMode(SEM_FAILCRITICALERRORS);
m_hDll = LoadLibrary(FileName);
SetErrorMode(LastErrorMode);
}
if (m_hDll == NULL)
{
return false;
}
// Get DLL information
void(__cdecl *GetDllInfo) (PLUGIN_INFO * PluginInfo);
LoadFunction(GetDllInfo);
if (GetDllInfo == NULL) { return false; }
GetDllInfo(&m_PluginInfo);
if (!ValidPluginVersion(m_PluginInfo)) { return false; }
if (m_PluginInfo.Type != type()) { return false; }
2015-12-10 18:23:00 +00:00
CloseDLL = (void(__cdecl *)(void)) GetProcAddress((HMODULE)m_hDll, "CloseDLL");
RomOpen = (void(__cdecl *)(void)) GetProcAddress((HMODULE)m_hDll, "RomOpen");
RomClosed = (void(__cdecl *)(void)) GetProcAddress((HMODULE)m_hDll, "RomClosed");
PluginOpened = (void(__cdecl *)(void)) GetProcAddress((HMODULE)m_hDll, "PluginLoaded");
DllConfig = (void(__cdecl *)(void *)) GetProcAddress((HMODULE)m_hDll, "DllConfig");
DllAbout = (void(__cdecl *)(void *)) GetProcAddress((HMODULE)m_hDll, "DllAbout");
2015-11-08 06:08:15 +00:00
2015-12-10 18:23:00 +00:00
SetSettingInfo3 = (void(__cdecl *)(PLUGIN_SETTINGS3 *))GetProcAddress((HMODULE)m_hDll, "SetSettingInfo3");
2015-11-08 06:08:15 +00:00
if (SetSettingInfo3)
{
PLUGIN_SETTINGS3 info;
2015-12-10 18:23:00 +00:00
info.FlushSettings = (void(*)(void * handle))CSettings::FlushSettings;
2015-11-08 06:08:15 +00:00
SetSettingInfo3(&info);
}
2015-12-10 18:23:00 +00:00
SetSettingInfo2 = (void(__cdecl *)(PLUGIN_SETTINGS2 *))GetProcAddress((HMODULE)m_hDll, "SetSettingInfo2");
2015-11-08 06:08:15 +00:00
if (SetSettingInfo2)
{
PLUGIN_SETTINGS2 info;
2015-12-10 18:23:00 +00:00
info.FindSystemSettingId = (uint32_t(*)(void * handle, const char *))CSettings::FindSetting;
2015-11-08 06:08:15 +00:00
SetSettingInfo2(&info);
}
2015-12-10 18:23:00 +00:00
SetSettingInfo = (void(__cdecl *)(PLUGIN_SETTINGS *))GetProcAddress((HMODULE)m_hDll, "SetSettingInfo");
2015-11-08 06:08:15 +00:00
if (SetSettingInfo)
{
PLUGIN_SETTINGS info;
info.dwSize = sizeof(PLUGIN_SETTINGS);
info.DefaultStartRange = GetDefaultSettingStartRange();
info.SettingStartRange = GetSettingStartRange();
info.MaximumSettings = MaxPluginSetting;
info.NoDefault = Default_None;
info.DefaultLocation = g_Settings->LoadDword(Setting_UseFromRegistry) ? SettingType_Registry : SettingType_CfgFile;
info.handle = g_Settings;
info.RegisterSetting = (void(*)(void *, int, int, SettingDataType, SettingType, const char *, const char *, uint32_t))&CSettings::RegisterSetting;
info.GetSetting = (uint32_t(*)(void *, int))&CSettings::GetSetting;
info.GetSettingSz = (const char * (*)(void *, int, char *, int))&CSettings::GetSettingSz;
info.SetSetting = (void(*)(void *, int, uint32_t))&CSettings::SetSetting;
info.SetSettingSz = (void(*)(void *, int, const char *))&CSettings::SetSettingSz;
info.UseUnregisteredSetting = NULL;
SetSettingInfo(&info);
}
if (RomClosed == NULL)
return false;
if (!LoadFunctions())
{
return false;
}
WriteTrace(PluginTraceType(), TraceDebug, "Functions loaded");
2015-11-08 06:08:15 +00:00
if (PluginOpened)
{
WriteTrace(PluginTraceType(), TraceDebug, "Before Plugin Opened");
2015-11-08 06:08:15 +00:00
PluginOpened();
WriteTrace(PluginTraceType(), TraceDebug, "After Plugin Opened");
2015-11-08 06:08:15 +00:00
}
return true;
}
void CPlugin::RomOpened()
{
2015-11-08 06:08:15 +00:00
if (m_RomOpen)
{
2015-11-08 06:08:15 +00:00
return;
}
2015-11-08 06:08:15 +00:00
2015-12-10 18:23:00 +00:00
if (RomOpen != NULL)
{
WriteTrace(PluginTraceType(), TraceDebug, "Before Rom Open");
2015-11-08 06:08:15 +00:00
RomOpen();
WriteTrace(PluginTraceType(), TraceDebug, "After Rom Open");
2015-11-08 06:08:15 +00:00
}
m_RomOpen = true;
}
void CPlugin::RomClose()
{
2015-11-08 06:08:15 +00:00
if (!m_RomOpen)
return;
WriteTrace(PluginTraceType(), TraceDebug, "Before Rom Close");
2015-11-08 06:08:15 +00:00
RomClosed();
m_RomOpen = false;
WriteTrace(PluginTraceType(), TraceDebug, "After Rom Close");
}
void CPlugin::GameReset()
{
2015-11-08 06:08:15 +00:00
if (m_RomOpen)
{
RomClose();
if (RomOpen)
{
RomOpen();
}
}
}
void CPlugin::Close()
{
WriteTrace(PluginTraceType(), TraceDebug, "(%s): Start", PluginType());
2015-11-08 06:08:15 +00:00
RomClose();
if (m_Initialized)
{
CloseDLL();
m_Initialized = false;
}
WriteTrace(PluginTraceType(), TraceDebug, "(%s): Done", PluginType());
}
void CPlugin::UnloadPlugin()
{
WriteTrace(PluginTraceType(), TraceDebug, "(%s): unloading", PluginType());
2015-11-08 06:08:15 +00:00
memset(&m_PluginInfo, 0, sizeof(m_PluginInfo));
if (m_hDll != NULL)
{
UnloadPluginDetails();
FreeLibrary((HMODULE)m_hDll);
m_hDll = NULL;
}
DllAbout = NULL;
CloseDLL = NULL;
RomOpen = NULL;
RomClosed = NULL;
PluginOpened = NULL;
DllConfig = NULL;
SetSettingInfo = NULL;
SetSettingInfo2 = NULL;
SetSettingInfo3 = NULL;
}
2015-12-10 18:23:00 +00:00
const char * CPlugin::PluginType() const
{
2015-11-08 06:08:15 +00:00
switch (m_PluginInfo.Type)
{
case PLUGIN_TYPE_RSP: return "RSP";
case PLUGIN_TYPE_GFX: return "GFX";
case PLUGIN_TYPE_AUDIO: return "Audio";
case PLUGIN_TYPE_CONTROLLER: return "Control";
}
return "Unknown";
}
TraceModuleProject64 CPlugin::PluginTraceType() const
{
2015-11-08 06:08:15 +00:00
switch (m_PluginInfo.Type)
{
case PLUGIN_TYPE_RSP: return TraceRSPPlugin;
case PLUGIN_TYPE_GFX: return TraceGFXPlugin;
case PLUGIN_TYPE_AUDIO: return TraceAudioPlugin;
case PLUGIN_TYPE_CONTROLLER: return TraceControllerPlugin;
2015-11-08 06:08:15 +00:00
}
return TraceUnknown;
2015-11-08 06:08:15 +00:00
}
2015-12-10 18:23:00 +00:00
bool CPlugin::ValidPluginVersion(PLUGIN_INFO & PluginInfo)
2015-11-08 06:08:15 +00:00
{
switch (PluginInfo.Type)
{
case PLUGIN_TYPE_RSP:
if (!PluginInfo.MemoryBswaped) { return false; }
2015-12-10 18:23:00 +00:00
if (PluginInfo.Version == 0x0001) { return true; }
if (PluginInfo.Version == 0x0100) { return true; }
if (PluginInfo.Version == 0x0101) { return true; }
if (PluginInfo.Version == 0x0102) { return true; }
2015-11-08 06:08:15 +00:00
break;
case PLUGIN_TYPE_GFX:
if (!PluginInfo.MemoryBswaped) { return false; }
2015-12-10 18:23:00 +00:00
if (PluginInfo.Version == 0x0102) { return true; }
if (PluginInfo.Version == 0x0103) { return true; }
if (PluginInfo.Version == 0x0104) { return true; }
2015-11-08 06:08:15 +00:00
break;
case PLUGIN_TYPE_AUDIO:
if (!PluginInfo.MemoryBswaped) { return false; }
2015-12-10 18:23:00 +00:00
if (PluginInfo.Version == 0x0101) { return true; }
if (PluginInfo.Version == 0x0102) { return true; }
2015-11-08 06:08:15 +00:00
break;
case PLUGIN_TYPE_CONTROLLER:
if (PluginInfo.Version == 0x0100) { return true; }
if (PluginInfo.Version == 0x0101) { return true; }
if (PluginInfo.Version == 0x0102) { return true; }
break;
}
return FALSE;
2015-12-10 18:23:00 +00:00
}