crown-engine/engine/Device.cpp

/*
Copyright (c) 2013 Daniele Bartolini, Michele Rossi
Copyright (c) 2012 Daniele Bartolini, Simone Boscaratto

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
OTHER DEALINGS IN THE SOFTWARE.
*/

#include <cstdlib>

#include "Config.h"
#include "Device.h"
#include "Accelerometer.h"
#include "Args.h"
#include "ConsoleServer.h"
#include "DebugRenderer.h"
#include "DiskFile.h"
#include "DiskFilesystem.h"
#include "JSONParser.h"
#include "Keyboard.h"
#include "Log.h"
#include "LuaEnvironment.h"
#include "Memory.h"
#include "Mouse.h"
#include "OS.h"
#include "OsWindow.h"
#include "Renderer.h"
#include "ResourceManager.h"
#include "StringSetting.h"
#include "StringUtils.h"
#include "TextReader.h"
#include "Touch.h"
#include "Types.h"
#include "Bundle.h"
#include "TempAllocator.h"
#include "ResourcePackage.h"

#if defined(LINUX) || defined(WINDOWS)
	#include "BundleCompiler.h"
#endif

#if defined(ANDROID)
	#include "ApkFilesystem.h"
#endif

#define MAX_SUBSYSTEMS_HEAP 16 * 1024 * 1024

namespace crown
{
//-----------------------------------------------------------------------------
Device::Device() : 
	m_allocator(default_allocator(), MAX_SUBSYSTEMS_HEAP),

	m_preferred_window_width(1000),
	m_preferred_window_height(625),
	m_preferred_window_fullscreen(0),
	m_parent_window_handle(0),
	m_compile(0),
	m_continue(0),

	m_quit_after_init(0),

	m_is_init(false),
	m_is_running(false),
	m_is_paused(false),
	m_is_really_paused(false),

	m_frame_count(0),

	m_last_time(0),
	m_current_time(0),
	m_last_delta_time(0.0f),
	m_time_since_start(0.0),

	m_filesystem(NULL),
	m_lua_environment(NULL),
	m_renderer(NULL),
	m_debug_renderer(NULL),

	m_bundle_compiler(NULL),
	m_resource_manager(NULL),
	m_resource_bundle(NULL),

	m_renderer_init_request(false)
{
	// Bundle dir is current dir by default.
	string::strncpy(m_bundle_dir, os::get_cwd(), MAX_PATH_LENGTH);
	string::strncpy(m_source_dir, "", MAX_PATH_LENGTH);
	string::strncpy(m_boot_file, "lua/game", MAX_PATH_LENGTH);
}

//-----------------------------------------------------------------------------
Device::~Device()
{
}

//-----------------------------------------------------------------------------
bool Device::init(int argc, char** argv)
{
	CE_ASSERT(!is_init(), "Engine already initialized");

	parse_command_line(argc, argv);
	check_preferred_settings();

	// Resource compilation only in debug or development mode and only on linux or windows builds
	#if (defined(LINUX) || defined(WINDOWS)) && (defined(CROWN_DEBUG) || defined(CROWN_DEVELOPMENT))
		if (m_compile == 1)
		{
			m_bundle_compiler = CE_NEW(m_allocator, BundleCompiler);
			if (!m_bundle_compiler->compile(m_bundle_dir, m_source_dir))
			{
				CE_DELETE(m_allocator, m_bundle_compiler);
				m_allocator.clear();
				Log::e("Exiting.");
				exit(EXIT_FAILURE);
			}

			if (!m_continue)
			{
				CE_DELETE(m_allocator, m_bundle_compiler);
				m_allocator.clear();
				exit(EXIT_SUCCESS);
			}
		}
	#endif

	init();

	return true;
}

//-----------------------------------------------------------------------------
void Device::init()
{
	// Initialize
	Log::i("Initializing Crown Engine %d.%d.%d...", CROWN_VERSION_MAJOR, CROWN_VERSION_MINOR, CROWN_VERSION_MICRO);

	// Default bundle filesystem
	#if defined (LINUX) || defined(WINDOWS)
		m_filesystem = CE_NEW(m_allocator, DiskFilesystem)(m_bundle_dir);
	#elif defined(ANDROID)
		m_filesystem = CE_NEW(m_allocator, ApkFilesystem)();
	#endif
	Log::d("Filesystem created.");

	// Read settings from crown.config
	read_engine_settings();

	m_resource_bundle = Bundle::create(m_allocator, *m_filesystem);

	// Create resource manager
	m_resource_manager = CE_NEW(m_allocator, ResourceManager)(*m_resource_bundle, 0);
	Log::d("Resource manager created.");
	Log::d("Resource seed: %d", m_resource_manager->seed());

	// Create input devices
	m_keyboard = CE_NEW(m_allocator, Keyboard);
	m_mouse = CE_NEW(m_allocator, Mouse);
	m_touch = CE_NEW(m_allocator, Touch);

	// Create renderer
	m_renderer = CE_NEW(m_allocator, Renderer)(m_allocator);
	m_renderer->init();
	Log::d("Renderer created.");

	// Create debug renderer
	m_debug_renderer = CE_NEW(m_allocator, DebugRenderer)(*m_renderer);
	Log::d("Debug renderer created.");

	m_lua_environment = CE_NEW(m_allocator, LuaEnvironment)();
	m_lua_environment->init();
	Log::d("Lua environment created.");

	Log::i("Crown Engine initialized.");
	Log::i("Initializing Game...");

	m_is_init = true;
	start();

	// Execute lua boot file
	if (m_lua_environment->load_and_execute(m_boot_file))
	{
		if (!m_lua_environment->call_global("init", 0))
		{
			pause();
		}
	}
	else
	{
		pause();
	}

	Log::d("Total allocated size: %llu", m_allocator.allocated_size());

	if (m_quit_after_init == 1)
	{
		stop();
		shutdown();
	}
}

//-----------------------------------------------------------------------------
void Device::shutdown()
{
	CE_ASSERT(is_init(), "Engine is not initialized");

	// Shutdowns the game
	m_lua_environment->call_global("shutdown", 0);

	Log::i("Releasing LuaEnvironment...");
	if (m_lua_environment)
	{
		m_lua_environment->shutdown();
		
		CE_DELETE(m_allocator, m_lua_environment);
	}

	Log::i("Releasing Input Devices...");
	CE_DELETE(m_allocator, m_touch);
	CE_DELETE(m_allocator, m_mouse);
	CE_DELETE(m_allocator, m_keyboard);

	Log::i("Releasing DebugRenderer...");
	if (m_debug_renderer)
	{
		CE_DELETE(m_allocator, m_debug_renderer);
	}

	Log::i("Releasing Renderer...");
	if (m_renderer)
	{
		m_renderer->shutdown();
		CE_DELETE(m_allocator, m_renderer);
	}

	Log::i("Releasing ResourceManager...");
	if (m_resource_manager)
	{
		CE_DELETE(m_allocator, m_resource_manager);
	}

	if (m_resource_bundle)
	{
		Bundle::destroy(m_allocator, m_resource_bundle);
	}

	Log::i("Releasing Filesystem...");
	if (m_filesystem)
	{
		CE_DELETE(m_allocator, m_filesystem);
	}

	#if (defined(LINUX) || defined(WINDOWS)) && (defined(CROWN_DEBUG) || defined(CROWN_DEVELOPMENT))
		Log::i("Releasing BundleCompiler...");
		if (m_bundle_compiler)
		{
			CE_DELETE(m_allocator, m_bundle_compiler);
		}
	#endif

	m_allocator.clear();

	m_is_init = false;
}

//-----------------------------------------------------------------------------
bool Device::is_init() const
{
	return m_is_init;
}

//-----------------------------------------------------------------------------
bool Device::is_paused() const
{
	return m_is_paused;
}

//-----------------------------------------------------------------------------
Filesystem* Device::filesystem()
{
	return m_filesystem;
}

//-----------------------------------------------------------------------------
ResourceManager* Device::resource_manager()
{
	return m_resource_manager;
}

//-----------------------------------------------------------------------------
LuaEnvironment* Device::lua_environment()
{
	return m_lua_environment;
}

//-----------------------------------------------------------------------------
Renderer* Device::renderer()
{
	return m_renderer;
}

//-----------------------------------------------------------------------------
DebugRenderer* Device::debug_renderer()
{
	return m_debug_renderer;
}

//-----------------------------------------------------------------------------
Keyboard* Device::keyboard()
{
	return m_keyboard;
}

//-----------------------------------------------------------------------------
Mouse* Device::mouse()
{
	return m_mouse;
}

//-----------------------------------------------------------------------------
Touch* Device::touch()
{
	return m_touch;
}

//-----------------------------------------------------------------------------
Accelerometer* Device::accelerometer()
{
	return NULL;
}

//-----------------------------------------------------------------------------
void Device::start()
{
	CE_ASSERT(m_is_init, "Cannot start uninitialized engine.");

	m_is_running = true;
	m_last_time = os::milliseconds();
}

//-----------------------------------------------------------------------------
void Device::stop()
{
	CE_ASSERT(m_is_init, "Cannot stop uninitialized engine.");

	m_is_running = false;
}

//-----------------------------------------------------------------------------
void Device::pause()
{
	m_is_paused = true;
}

//-----------------------------------------------------------------------------
void Device::unpause()
{
	m_is_paused = false;
}

//-----------------------------------------------------------------------------
bool Device::is_running() const
{
	return m_is_running;
}

//-----------------------------------------------------------------------------
uint64_t Device::frame_count() const
{
	return m_frame_count;
}

//-----------------------------------------------------------------------------
float Device::last_delta_time() const
{
	return m_last_delta_time;
}

//-----------------------------------------------------------------------------
double Device::time_since_start() const
{
	return m_time_since_start;
}

//-----------------------------------------------------------------------------
void Device::frame()
{
	m_current_time = os::microseconds();
	m_last_delta_time = (m_current_time - m_last_time) / 1000000.0f;
	m_last_time = m_current_time;
	m_time_since_start += m_last_delta_time;

	if (!m_is_paused)
	{
		m_resource_manager->poll_resource_loader();

		m_renderer->set_layer_clear(0, CLEAR_COLOR | CLEAR_DEPTH, Color4::LIGHTBLUE, 1.0f);
		m_renderer->commit(0);

		if (!m_lua_environment->call_global("frame", 1, ARGUMENT_FLOAT, last_delta_time()))
		{
			pause();
		}

		m_renderer->frame();

		m_keyboard->update();
		m_mouse->update();
	}

	m_frame_count++;
}

//-----------------------------------------------------------------------------
ResourcePackage* Device::create_resource_package(const char* name)
{
	CE_ASSERT_NOT_NULL(name);

	ResourceId package_id = m_resource_manager->load("package", name);
	m_resource_manager->flush();

	PackageResource* package_res = (PackageResource*) m_resource_manager->data(package_id);
	ResourcePackage* package = CE_NEW(default_allocator(), ResourcePackage)(*m_resource_manager, package_id, package_res);

	return package;
}

//-----------------------------------------------------------------------------
void Device::destroy_resource_package(ResourcePackage* package)
{
	CE_ASSERT_NOT_NULL(package);

	m_resource_manager->unload(package->resource_id());
	CE_DELETE(default_allocator(), package);
}

//-----------------------------------------------------------------------------
void Device::compile(const char* , const char* , const char* )
{
}

//-----------------------------------------------------------------------------
void Device::reload(ResourceId name)
{
	(void)name;
}

//-----------------------------------------------------------------------------
void Device::parse_command_line(int argc, char** argv)
{
	static ArgsOption options[] = 
	{
		{ "help",             AOA_NO_ARGUMENT,       NULL,        'i' },
		{ "source-dir",       AOA_REQUIRED_ARGUMENT, NULL,        's' },
		{ "bundle-dir",       AOA_REQUIRED_ARGUMENT, NULL,        'b' },
		{ "compile",          AOA_NO_ARGUMENT,       &m_compile,   1 },
		{ "continue",         AOA_NO_ARGUMENT,       &m_continue,  1 },
		{ "width",            AOA_REQUIRED_ARGUMENT, NULL,        'w' },
		{ "height",           AOA_REQUIRED_ARGUMENT, NULL,        'h' },
		{ "fullscreen",       AOA_NO_ARGUMENT,       &m_preferred_window_fullscreen, 1 },
		{ "parent-window",    AOA_REQUIRED_ARGUMENT, NULL,        'p' },
		{ "quit-after-init",  AOA_NO_ARGUMENT,       &m_quit_after_init, 1 },
		{ NULL, 0, NULL, 0 }
	};

	Args args(argc, argv, "", options);

	int32_t opt;

	while ((opt = args.getopt()) != -1)
	{
		switch (opt)
		{
			case 0:
			{
				break;
			}
			// Source directory
			case 's':
			{
				string::strncpy(m_source_dir, args.optarg(), MAX_PATH_LENGTH);
				break;
			}
			// Bundle directory
			case 'b':
			{
				string::strncpy(m_bundle_dir, args.optarg(), MAX_PATH_LENGTH);
				break;
			}
			// Window width
			case 'w':
			{
				m_preferred_window_width = atoi(args.optarg());
				break;
			}
			// Window height
			case 'h':
			{
				m_preferred_window_height = atoi(args.optarg());
				break;
			}
			// Parent window
			case 'p':
			{
				m_parent_window_handle = string::parse_uint(args.optarg());
				break;
			}
			case 'i':
			case '?':
			default:
			{
				print_help_message();
				exit(EXIT_FAILURE);
			}
		}
	}
}

//-----------------------------------------------------------------------------
void Device::check_preferred_settings()
{
	if (m_compile == 1)
	{
		if (string::strcmp(m_source_dir, "") == 0)
		{
			Log::e("You have to specify the source directory when running in compile mode.");
			exit(EXIT_FAILURE);
		}

		if (!os::is_absolute_path(m_source_dir))
		{
			Log::e("The source directory must be absolute.");
			exit(EXIT_FAILURE);
		}
	}

	if (!os::is_absolute_path(m_bundle_dir))
	{
		Log::e("The bundle directory must be absolute.");
		exit(EXIT_FAILURE);
	}

	if (m_preferred_window_width == 0 || m_preferred_window_height == 0)
	{
		Log::e("Window width and height must be greater than zero.");
		exit(EXIT_FAILURE);
	}
}

//-----------------------------------------------------------------------------
void Device::read_engine_settings()
{
	// Check crown.config existance
	CE_ASSERT(m_filesystem->is_file("crown.config"), "Unable to open crown.config");

	// Copy crown config in a buffer
	TempAllocator4096 allocator;

	File* config_file = m_filesystem->open("crown.config", FOM_READ);

	char* json_string = (char*)allocator.allocate(config_file->size());

	config_file->read(json_string, config_file->size());

	m_filesystem->close(config_file);

	// Parse crown.config
	JSONParser parser(json_string);

	JSONElement root = parser.root();

	// Boot
	if (root.has_key("boot"))
	{
		const char* boot = root.key("boot").string_value();
		const size_t boot_length = string::strlen(boot) + 1;

		string::strncpy(m_boot_file, boot, boot_length);
	}
	// Window width
	if (root.has_key("window_width"))
	{
		m_preferred_window_width = root.key("window_width").int_value();
	}
	// Window height
	if (root.has_key("window_height"))
	{
		m_preferred_window_height = root.key("window_height").int_value();
	}

	allocator.deallocate(json_string);

	Log::i("Configuration set");
}

//-----------------------------------------------------------------------------
void Device::print_help_message()
{
	os::printf(
	"Usage: crown [options]\n"
	"Options:\n\n"

	"All of the following options take precedence over\n"
	"environment variables and configuration files.\n\n"

	"  --help                     Show this help.\n"
	"  --bundle-dir <path>        Use <path> as the source directory for compiled resources.\n"
	"  --width <width>            Set the <width> of the main window.\n"
	"  --height <width>           Set the <height> of the main window.\n"
	"  --fullscreen               Start in fullscreen.\n"
	"  --parent-window <handle>   Set the parent window <handle> of the main window.\n"
	"                             Used only by tools.\n"

	"\nAvailable only in debug and development builds:\n\n"

	"  --source-dir <path>        Use <path> as the source directory for resource compilation.\n"
	"  --compile                  Run the engine as resource compiler.\n"
	"  --continue                 Do a full compile of the resources and continue the execution.\n"
	"  --quit-after-init          Quit the engine immediately after the initialization.\n");
}

static Device* g_device;

void set_device(Device* device)
{
	g_device = device;
}

Device* device()
{
	return g_device;
}

} // namespace crown