Fix audio driver starting in debug mode, add -diagnostics mode

Aerofoil/Aerofoil.vcxproj

@@ -156,6 +156,7 @@
     <ClCompile Include="GpFontHandler_FreeType2.cpp" />
     <ClCompile Include="GpGlobalConfig.cpp" />
     <ClCompile Include="GpInputDriverFactory.cpp" />
+    <ClCompile Include="GpLogDriver_Win32.cpp" />
     <ClCompile Include="GpMain.cpp" />
     <ClCompile Include="GpMain_Win32.cpp" />
     <ClCompile Include="GpMemoryBuffer.cpp" />
@@ -175,6 +176,7 @@
     <ClInclude Include="..\GpCommon\IGpCursor.h" />
     <ClInclude Include="..\GpCommon\IGpAudioChannelCallbacks.h" />
     <ClInclude Include="..\GpCommon\IGpDisplayDriverSurface.h" />
+    <ClInclude Include="..\GpCommon\IGpLogDriver.h" />
     <ClInclude Include="GpAppEnvironment.h" />
     <ClInclude Include="GpAudioDriverFactory.h" />
     <ClInclude Include="GpDisplayDriverFactory.h" />
@@ -185,6 +187,7 @@
     <ClInclude Include="GpFontHandlerFactory.h" />
     <ClInclude Include="GpGlobalConfig.h" />
     <ClInclude Include="GpInputDriverFactory.h" />
+    <ClInclude Include="GpLogDriver_Win32.h" />
     <ClInclude Include="GpMain.h" />
     <ClInclude Include="GpMemoryBuffer.h" />
     <ClInclude Include="GpMutex_Win32.h" />

Aerofoil/Aerofoil.vcxproj.filters

@@ -58,6 +58,9 @@
     <ClCompile Include="GpThreadEvent_Win32.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="GpLogDriver_Win32.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="..\GpCommon\EGpInputDriverType.h">
@@ -141,6 +144,10 @@
     <ClInclude Include="resource.h">
       <Filter>Resource Files</Filter>
     </ClInclude>
+    <ClInclude Include="..\GpCommon\IGpLogDriver.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
+    <ClInclude Include="GpLogDriver_Win32.h" />
   </ItemGroup>
   <ItemGroup>
     <Image Include="ConvertedResources\Large128.ico">

Aerofoil/GpFileStream_Win32.cpp

@@ -142,3 +142,8 @@ void GpFileStream_Win32::Close()
 {
 	CloseHandle(m_handle);
 }
+
+void GpFileStream_Win32::Flush()
+{
+	FlushFileBuffers(m_handle);
+}

Aerofoil/GpFileStream_Win32.h

@@ -20,7 +20,8 @@ public:
 	bool Truncate(PortabilityLayer::UFilePos_t loc) override;
 	PortabilityLayer::UFilePos_t Size() const override;
 	PortabilityLayer::UFilePos_t Tell() const override;
-	void Close() override;
+	void Close() override;
+	void Flush() override;
 
 private:
 	HANDLE m_handle;

Aerofoil/GpFileSystem_Win32.cpp

@@ -122,16 +122,19 @@ GpFileSystem_Win32::GpFileSystem_Win32()
 		m_userHousesDir = m_prefsDir + L"\\Houses";
 		m_userSavesDir = m_prefsDir + L"\\SavedGames";
 		m_scoresDir = m_prefsDir + L"\\Scores";
+		m_logsDir = m_prefsDir + L"\\Logs";
 
 		CreateDirectoryW(m_prefsDir.c_str(), nullptr);
 		CreateDirectoryW(m_scoresDir.c_str(), nullptr);
 		CreateDirectoryW(m_userHousesDir.c_str(), nullptr);
 		CreateDirectoryW(m_userSavesDir.c_str(), nullptr);
+		CreateDirectoryW(m_logsDir.c_str(), nullptr);
 
 		m_prefsDir.append(L"\\");
 		m_scoresDir.append(L"\\");
 		m_userHousesDir.append(L"\\");
 		m_userSavesDir.append(L"\\");
+		m_logsDir.append(L"\\");
 	}
 
 	DWORD modulePathSize = GetModuleFileNameW(nullptr, m_executablePath, MAX_PATH);
@@ -514,6 +517,9 @@ bool GpFileSystem_Win32::ResolvePath(PortabilityLayer::VirtualDirectory_t virtua
 	case PortabilityLayer::VirtualDirectories::kHighScores:
 		baseDir = m_scoresDir.c_str();
 		break;
+	case PortabilityLayer::VirtualDirectories::kLogs:
+		baseDir = m_logsDir.c_str();
+		break;
 	default:
 		return false;
 	}

Aerofoil/GpFileSystem_Win32.h

@@ -34,6 +34,7 @@ private:
 	std::wstring m_scoresDir;
 	std::wstring m_packagedDir;
 	std::wstring m_housesDir;
+	std::wstring m_logsDir;
 	std::wstring m_userHousesDir;
 	std::wstring m_userSavesDir;
 	std::wstring m_resourcesDir;

Aerofoil/GpGlobalConfig.h

@@ -2,7 +2,9 @@
 
 #include "EGpDisplayDriverType.h"
 #include "EGpAudioDriverType.h"
-#include "EGpInputDriverType.h"
+#include "EGpInputDriverType.h"
+
+struct IGpLogDriver;
 
 struct GpGlobalConfig
 {
@@ -11,6 +13,7 @@ struct GpGlobalConfig
 	const EGpInputDriverType *m_inputDriverTypes;
 	size_t m_numInputDrivers;
 
+	IGpLogDriver *m_logger;
 	void *m_osGlobals;
 };
 

Aerofoil/GpLogDriver_Win32.cpp

@@ -0,0 +1,113 @@
+#include "GpLogDriver_Win32.h"
+#include "GpFileSystem_Win32.h"
+
+#include "GpApplicationName.h"
+#include "IOStream.h"
+
+GpLogDriver_Win32::GpLogDriver_Win32()
+	: m_stream(nullptr)
+	, m_isInitialized(false)
+{
+}
+
+void GpLogDriver_Win32::Init()
+{
+	ms_instance.InitInternal();
+}
+
+void GpLogDriver_Win32::VPrintf(Category category, const char *fmt, va_list args)
+{
+	size_t fmtSize = 0;
+	bool hasFormatting = false;
+	for (const char *fmtCheck = fmt; *fmtCheck; fmtCheck++)
+	{
+		if (*fmtCheck == '%')
+			hasFormatting = true;
+
+		fmtSize++;
+	}
+
+	SYSTEMTIME sysTime;
+	GetSystemTime(&sysTime);
+
+	char timestampBuffer[64];
+	sprintf(timestampBuffer, "[%02d:%02d:%02d:%03d] ", sysTime.wHour, sysTime.wMinute, sysTime.wSecond, sysTime.wMilliseconds);
+
+	m_stream->Write(timestampBuffer, strlen(timestampBuffer));
+
+	const char *debugTag = "";
+
+	switch (category)
+	{
+	case Category_Warning:
+		debugTag = "[WARNING] ";
+		break;
+	case Category_Error:
+		debugTag = "[ERROR] ";
+		break;
+	};
+
+	if (debugTag[0])
+		m_stream->Write(debugTag, strlen(debugTag));
+
+	if (!hasFormatting)
+		m_stream->Write(fmt, fmtSize);
+	else
+	{
+		int formattedSize = vsnprintf(nullptr, 0, fmt, args);
+		if (formattedSize <= 0)
+			return;
+
+		char *charBuff = static_cast<char*>(malloc(formattedSize + 1));
+		if (!charBuff)
+			return;
+
+		vsnprintf(charBuff, formattedSize + 1, fmt, args);
+
+		m_stream->Write(charBuff, formattedSize);
+		free(charBuff);
+	}
+
+	m_stream->Write("\n", 1);
+
+	m_stream->Flush();
+}
+
+void GpLogDriver_Win32::Shutdown()
+{
+	if (m_stream)
+		m_stream->Close();
+}
+
+GpLogDriver_Win32 *GpLogDriver_Win32::GetInstance()
+{
+	if (ms_instance.m_isInitialized)
+		return &ms_instance;
+	else
+		return nullptr;
+}
+
+void GpLogDriver_Win32::InitInternal()
+{
+	SYSTEMTIME utcTime;
+	GetSystemTime(&utcTime);
+
+	char logFileName[256];
+
+	sprintf(logFileName, GP_APPLICATION_NAME "-%04d-%02d-%02d_%02d-%02d_%02d.txt", utcTime.wYear, utcTime.wMonth, utcTime.wDay, utcTime.wHour, utcTime.wMinute, utcTime.wSecond);
+
+	m_stream = GpFileSystem_Win32::GetInstance()->OpenFile(PortabilityLayer::VirtualDirectories::kLogs, logFileName, true, GpFileCreationDispositions::kCreateOrOverwrite);
+	if (m_stream)
+	{
+		this->Printf(IGpLogDriver::Category_Information, GP_APPLICATION_NAME " build " __TIMESTAMP__);
+#ifdef NDEBUG
+		this->Printf(IGpLogDriver::Category_Information, "Configuration: Release");
+#else
+		this->Printf(IGpLogDriver::Category_Information, "Configuration: Debug");
+#endif
+
+		m_isInitialized = true;
+	}
+}
+
+GpLogDriver_Win32 GpLogDriver_Win32::ms_instance;

Aerofoil/GpLogDriver_Win32.h

@@ -0,0 +1,29 @@
+#pragma once
+
+#include "IGpLogDriver.h"
+
+namespace PortabilityLayer
+{
+	class IOStream;
+}
+
+class GpLogDriver_Win32 : public IGpLogDriver
+{
+public:
+	GpLogDriver_Win32();
+
+	static void Init();
+
+	void VPrintf(Category category, const char *fmt, va_list args) override;
+	void Shutdown() override;
+
+	static GpLogDriver_Win32 *GetInstance();
+
+private:
+	void InitInternal();
+
+	PortabilityLayer::IOStream *m_stream;
+	bool m_isInitialized;
+
+	static GpLogDriver_Win32 ms_instance;
+};

Aerofoil/GpMain.cpp

@@ -63,6 +63,7 @@ int GpMain::Run()
 	ddProps.m_type = g_gpGlobalConfig.m_displayDriverType;
 	ddProps.m_osGlobals = g_gpGlobalConfig.m_osGlobals;
 	ddProps.m_eventQueue = eventQueue;
+	ddProps.m_logger = g_gpGlobalConfig.m_logger;
 
 	GpAudioDriverProperties adProps;
 	memset(&adProps, 0, sizeof(adProps));
@@ -72,10 +73,11 @@ int GpMain::Run()
 	adProps.m_type = g_gpGlobalConfig.m_audioDriverType;
 	adProps.m_sampleRate = (244800 * 2 + 11) / (11 * 2);
 #ifdef NDEBUG
-	adProps.m_debug = true;
-#else
 	adProps.m_debug = false;
+#else
+	adProps.m_debug = true;
 #endif
+	adProps.m_logger = g_gpGlobalConfig.m_logger;
 
 	IGpInputDriver **inputDrivers = static_cast<IGpInputDriver**>(malloc(sizeof(IGpInputDriver*) * g_gpGlobalConfig.m_numInputDrivers));
 

Aerofoil/GpMain_Win32.cpp

@@ -5,6 +5,7 @@
 #include "GpGlobalConfig.h"
 #include "GpFiber_Win32.h"
 #include "GpFileSystem_Win32.h"
+#include "GpLogDriver_Win32.h"
 #include "GpInputDriverFactory.h"
 #include "GpAppInterface.h"
 #include "GpSystemServices_Win32.h"
@@ -17,6 +18,7 @@
 
 #include "resource.h"
 
+#include <shellapi.h>
 #include <stdio.h>
 #include <windowsx.h>
 
@@ -394,12 +396,28 @@ static void TranslateWindowsMessage(const MSG *msg, IGpVOSEventQueue *eventQueue
 
 int WINAPI WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine, int nCmdShow)
 {
+	LPWSTR cmdLine = GetCommandLineW();
+
+	int nArgs;
+	LPWSTR *cmdLineArgs = CommandLineToArgvW(cmdLine, &nArgs);
+
+	for (int i = 1; i < nArgs; i++)
+	{
+		if (!wcscmp(cmdLineArgs[i], L"-diagnostics"))
+			GpLogDriver_Win32::Init();
+	}
+
+	IGpLogDriver *logger = GpLogDriver_Win32::GetInstance();
+
 	GpAppInterface_Get()->PL_HostFileSystem_SetInstance(GpFileSystem_Win32::GetInstance());
 	GpAppInterface_Get()->PL_HostSystemServices_SetInstance(GpSystemServices_Win32::GetInstance());
+	GpAppInterface_Get()->PL_HostLogDriver_SetInstance(GpLogDriver_Win32::GetInstance());
 
 	g_gpWindowsGlobals.m_hInstance = hInstance;
 	g_gpWindowsGlobals.m_hPrevInstance = hPrevInstance;
-	g_gpWindowsGlobals.m_cmdLine = lpCmdLine;
+	g_gpWindowsGlobals.m_cmdLine = cmdLine;
+	g_gpWindowsGlobals.m_cmdLineArgc = nArgs;
+	g_gpWindowsGlobals.m_cmdLineArgv = cmdLineArgs;
 	g_gpWindowsGlobals.m_nCmdShow = nCmdShow;
 	g_gpWindowsGlobals.m_baseDir = GpFileSystem_Win32::GetInstance()->GetBasePath();
 	g_gpWindowsGlobals.m_hwnd = nullptr;
@@ -422,10 +440,21 @@ int WINAPI WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine
 	g_gpGlobalConfig.m_numInputDrivers = sizeof(inputDrivers) / sizeof(inputDrivers[0]);
 
 	g_gpGlobalConfig.m_osGlobals = &g_gpWindowsGlobals;
+	g_gpGlobalConfig.m_logger = logger;
 
 	GpDisplayDriverFactory::RegisterDisplayDriverFactory(EGpDisplayDriverType_D3D11, GpDriver_CreateDisplayDriver_D3D11);
 	GpAudioDriverFactory::RegisterAudioDriverFactory(EGpAudioDriverType_XAudio2, GpDriver_CreateAudioDriver_XAudio2);
 	GpInputDriverFactory::RegisterInputDriverFactory(EGpInputDriverType_XInput, GpDriver_CreateInputDriver_XInput);
 
-	return GpMain::Run();
+	if (logger)
+		logger->Printf(IGpLogDriver::Category_Information, "Windows environment configured, starting up");
+
+	int returnCode = GpMain::Run();
+
+	if (logger)
+		logger->Printf(IGpLogDriver::Category_Information, "Windows environment exited with code %i, cleaning up", returnCode);
+
+	LocalFree(cmdLineArgs);
+
+	return returnCode;
 }