src/guiEngine.cpp

   1 /*
   2 Minetest
   3 Copyright (C) 2013 sapier
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #include "guiEngine.h"
  21
  22 #include "scripting_mainmenu.h"
  23 #include "config.h"
  24 #include "version.h"
  25 #include "porting.h"
  26 #include "filesys.h"
  27 #include "main.h"
  28 #include "settings.h"
  29 #include "guiMainMenu.h"
  30 #include "sound.h"
  31 #include "sound_openal.h"
  32 #include "clouds.h"
  33 #include "httpfetch.h"
  34
  35 #include <IGUIStaticText.h>
  36 #include <ICameraSceneNode.h>
  37
  38 #if USE_CURL
  39 #include <curl/curl.h>
  40 #endif
  41
  42 /******************************************************************************/
  43 /** TextDestGuiEngine                                                         */
  44 /******************************************************************************/
  45 TextDestGuiEngine::TextDestGuiEngine(GUIEngine* engine)
  46 {
  47         m_engine = engine;
  48 }
  49
  50 /******************************************************************************/
  51 void TextDestGuiEngine::gotText(std::map<std::string, std::string> fields)
  52 {
  53         m_engine->getScriptIface()->handleMainMenuButtons(fields);
  54 }
  55
  56 /******************************************************************************/
  57 void TextDestGuiEngine::gotText(std::wstring text)
  58 {
  59         m_engine->getScriptIface()->handleMainMenuEvent(wide_to_narrow(text));
  60 }
  61
  62 /******************************************************************************/
  63 /** MenuTextureSource                                                         */
  64 /******************************************************************************/
  65 MenuTextureSource::MenuTextureSource(video::IVideoDriver *driver)
  66 {
  67         m_driver = driver;
  68 }
  69
  70 /******************************************************************************/
  71 MenuTextureSource::~MenuTextureSource()
  72 {
  73         for (std::set<std::string>::iterator it = m_to_delete.begin();
  74                         it != m_to_delete.end(); ++it) {
  75                 const char *tname = (*it).c_str();
  76                 video::ITexture *texture = m_driver->getTexture(tname);
  77                 m_driver->removeTexture(texture);
  78         }
  79 }
  80
  81 /******************************************************************************/
  82 video::ITexture* MenuTextureSource::getTexture(const std::string &name, u32 *id)
  83 {
  84         if(id)
  85                 *id = 0;
  86         if(name.empty())
  87                 return NULL;
  88         m_to_delete.insert(name);
  89         return m_driver->getTexture(name.c_str());
  90 }
  91
  92 /******************************************************************************/
  93 /** MenuMusicFetcher                                                          */
  94 /******************************************************************************/
  95 void MenuMusicFetcher::fetchSounds(const std::string &name,
  96                         std::set<std::string> &dst_paths,
  97                         std::set<std::string> &dst_datas)
  98 {
  99         if(m_fetched.count(name))
 100                 return;
 101         m_fetched.insert(name);
 102         std::string base;
 103         base = porting::path_share + DIR_DELIM + "sounds";
 104         dst_paths.insert(base + DIR_DELIM + name + ".ogg");
 105         int i;
 106         for(i=0; i<10; i++)
 107                 dst_paths.insert(base + DIR_DELIM + name + "."+itos(i)+".ogg");
 108         base = porting::path_user + DIR_DELIM + "sounds";
 109         dst_paths.insert(base + DIR_DELIM + name + ".ogg");
 110         for(i=0; i<10; i++)
 111                 dst_paths.insert(base + DIR_DELIM + name + "."+itos(i)+".ogg");
 112 }
 113
 114 /******************************************************************************/
 115 /** GUIEngine                                                                 */
 116 /******************************************************************************/
 117 GUIEngine::GUIEngine(   irr::IrrlichtDevice* dev,
 118                                                 gui::IGUIElement* parent,
 119                                                 IMenuManager *menumgr,
 120                                                 scene::ISceneManager* smgr,
 121                                                 MainMenuData* data,
 122                                                 bool& kill) :
 123         m_device(dev),
 124         m_parent(parent),
 125         m_menumanager(menumgr),
 126         m_smgr(smgr),
 127         m_data(data),
 128         m_texture_source(NULL),
 129         m_sound_manager(NULL),
 130         m_formspecgui(0),
 131         m_buttonhandler(0),
 132         m_menu(0),
 133         m_kill(kill),
 134         m_startgame(false),
 135         m_script(0),
 136         m_scriptdir(""),
 137         m_irr_toplefttext(0),
 138         m_clouds_enabled(true),
 139         m_cloud()
 140 {
 141         //initialize texture pointers
 142         for (unsigned int i = 0; i < TEX_LAYER_MAX; i++) {
 143                 m_textures[i] = 0;
 144         }
 145         // is deleted by guiformspec!
 146         m_buttonhandler = new TextDestGuiEngine(this);
 147
 148         //create texture source
 149         m_texture_source = new MenuTextureSource(m_device->getVideoDriver());
 150
 151         //create soundmanager
 152         MenuMusicFetcher soundfetcher;
 153 #if USE_SOUND
 154         m_sound_manager = createOpenALSoundManager(&soundfetcher);
 155 #endif
 156         if(!m_sound_manager)
 157                 m_sound_manager = &dummySoundManager;
 158
 159         //create topleft header
 160         core::rect<s32> rect(0, 0, 500, 20);
 161         rect += v2s32(4, 0);
 162         std::string t = std::string("Minetest ") + minetest_version_hash;
 163
 164         m_irr_toplefttext =
 165                 m_device->getGUIEnvironment()->addStaticText(narrow_to_wide(t).c_str(),
 166                 rect,false,true,0,-1);
 167
 168         //create formspecsource
 169         m_formspecgui = new FormspecFormSource("");
 170
 171         /* Create menu */
 172         m_menu = new GUIFormSpecMenu(m_device,
 173                         m_parent,
 174                         -1,
 175                         m_menumanager,
 176                         NULL /* &client */,
 177                         NULL /* gamedef */,
 178                         m_texture_source,
 179                         m_formspecgui,
 180                         m_buttonhandler,
 181                         NULL);
 182
 183         m_menu->allowClose(false);
 184         m_menu->lockSize(true,v2u32(800,600));
 185
 186         // Initialize scripting
 187
 188         infostream << "GUIEngine: Initializing Lua" << std::endl;
 189
 190         m_script = new MainMenuScripting(this);
 191
 192         try {
 193                 if (m_data->errormessage != "") {
 194                         m_script->setMainMenuErrorMessage(m_data->errormessage);
 195                         m_data->errormessage = "";
 196                 }
 197
 198                 if (!loadMainMenuScript()) {
 199                         errorstream << "No future without mainmenu" << std::endl;
 200                         abort();
 201                 }
 202
 203                 run();
 204         }
 205         catch(LuaError &e) {
 206                 errorstream << "MAINMENU ERROR: " << e.what() << std::endl;
 207                 m_data->errormessage = e.what();
 208         }
 209
 210         m_menu->quitMenu();
 211         m_menu->drop();
 212         m_menu = 0;
 213 }
 214
 215 /******************************************************************************/
 216 bool GUIEngine::loadMainMenuScript()
 217 {
 218         // Try custom menu script (main_menu_path)
 219
 220         m_scriptdir = g_settings->get("main_menu_path");
 221         if (m_scriptdir.empty()) {
 222                 m_scriptdir = porting::path_share + DIR_DELIM "builtin" + DIR_DELIM "mainmenu";
 223         }
 224
 225         std::string script = porting::path_share + DIR_DELIM "builtin" + DIR_DELIM "init.lua";
 226         if (m_script->loadScript(script)) {
 227                 // Menu script loaded
 228                 return true;
 229         } else {
 230                 infostream
 231                         << "GUIEngine: execution of menu script in: \""
 232                         << m_scriptdir << "\" failed!" << std::endl;
 233         }
 234
 235         return false;
 236 }
 237
 238 /******************************************************************************/
 239 void GUIEngine::run()
 240 {
 241
 242         // Always create clouds because they may or may not be
 243         // needed based on the game selected
 244         video::IVideoDriver* driver = m_device->getVideoDriver();
 245
 246         cloudInit();
 247
 248         while(m_device->run() && (!m_startgame) && (!m_kill)) {
 249                 driver->beginScene(true, true, video::SColor(255,140,186,250));
 250
 251                 if (m_clouds_enabled)
 252                 {
 253                         cloudPreProcess();
 254                         drawOverlay(driver);
 255                 }
 256                 else
 257                         drawBackground(driver);
 258
 259                 drawHeader(driver);
 260                 drawFooter(driver);
 261
 262                 m_device->getGUIEnvironment()->drawAll();
 263
 264                 driver->endScene();
 265
 266                 if (m_clouds_enabled)
 267                         cloudPostProcess();
 268                 else
 269                         sleep_ms(25);
 270
 271                 m_script->step();
 272         }
 273 }
 274
 275 /******************************************************************************/
 276 GUIEngine::~GUIEngine()
 277 {
 278         video::IVideoDriver* driver = m_device->getVideoDriver();
 279         assert(driver != 0);
 280
 281         if(m_sound_manager != &dummySoundManager){
 282                 delete m_sound_manager;
 283                 m_sound_manager = NULL;
 284         }
 285
 286         //TODO: clean up m_menu here
 287
 288         infostream<<"GUIEngine: Deinitializing scripting"<<std::endl;
 289         delete m_script;
 290
 291         m_irr_toplefttext->setText(L"");
 292
 293         //clean up texture pointers
 294         for (unsigned int i = 0; i < TEX_LAYER_MAX; i++) {
 295                 if (m_textures[i] != 0)
 296                         driver->removeTexture(m_textures[i]);
 297         }
 298
 299         delete m_texture_source;
 300
 301         if (m_cloud.clouds)
 302                 m_cloud.clouds->drop();
 303 }
 304
 305 /******************************************************************************/
 306 void GUIEngine::cloudInit()
 307 {
 308         m_cloud.clouds = new Clouds(m_smgr->getRootSceneNode(),
 309                         m_smgr, -1, rand(), 100);
 310         m_cloud.clouds->update(v2f(0, 0), video::SColor(255,200,200,255));
 311
 312         m_cloud.camera = m_smgr->addCameraSceneNode(0,
 313                                 v3f(0,0,0), v3f(0, 60, 100));
 314         m_cloud.camera->setFarValue(10000);
 315
 316         m_cloud.lasttime = m_device->getTimer()->getTime();
 317 }
 318
 319 /******************************************************************************/
 320 void GUIEngine::cloudPreProcess()
 321 {
 322         u32 time = m_device->getTimer()->getTime();
 323
 324         if(time > m_cloud.lasttime)
 325                 m_cloud.dtime = (time - m_cloud.lasttime) / 1000.0;
 326         else
 327                 m_cloud.dtime = 0;
 328
 329         m_cloud.lasttime = time;
 330
 331         m_cloud.clouds->step(m_cloud.dtime*3);
 332         m_cloud.clouds->render();
 333         m_smgr->drawAll();
 334 }
 335
 336 /******************************************************************************/
 337 void GUIEngine::cloudPostProcess()
 338 {
 339         float fps_max = g_settings->getFloat("fps_max");
 340         // Time of frame without fps limit
 341         float busytime;
 342         u32 busytime_u32;
 343         // not using getRealTime is necessary for wine
 344         u32 time = m_device->getTimer()->getTime();
 345         if(time > m_cloud.lasttime)
 346                 busytime_u32 = time - m_cloud.lasttime;
 347         else
 348                 busytime_u32 = 0;
 349         busytime = busytime_u32 / 1000.0;
 350
 351         // FPS limiter
 352         u32 frametime_min = 1000./fps_max;
 353
 354         if(busytime_u32 < frametime_min) {
 355                 u32 sleeptime = frametime_min - busytime_u32;
 356                 m_device->sleep(sleeptime);
 357         }
 358 }
 359
 360 /******************************************************************************/
 361 void GUIEngine::drawBackground(video::IVideoDriver* driver)
 362 {
 363         v2u32 screensize = driver->getScreenSize();
 364
 365         video::ITexture* texture = m_textures[TEX_LAYER_BACKGROUND];
 366
 367         /* If no texture, draw background of solid color */
 368         if(!texture){
 369                 video::SColor color(255,80,58,37);
 370                 core::rect<s32> rect(0, 0, screensize.X, screensize.Y);
 371                 driver->draw2DRectangle(color, rect, NULL);
 372                 return;
 373         }
 374
 375         /* Draw background texture */
 376         v2u32 sourcesize = texture->getOriginalSize();
 377         driver->draw2DImage(texture,
 378                 core::rect<s32>(0, 0, screensize.X, screensize.Y),
 379                 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
 380                 NULL, NULL, true);
 381 }
 382
 383 /******************************************************************************/
 384 void GUIEngine::drawOverlay(video::IVideoDriver* driver)
 385 {
 386         v2u32 screensize = driver->getScreenSize();
 387
 388         video::ITexture* texture = m_textures[TEX_LAYER_OVERLAY];
 389
 390         /* If no texture, draw background of solid color */
 391         if(!texture)
 392                 return;
 393
 394         /* Draw background texture */
 395         v2u32 sourcesize = texture->getOriginalSize();
 396         driver->draw2DImage(texture,
 397                 core::rect<s32>(0, 0, screensize.X, screensize.Y),
 398                 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
 399                 NULL, NULL, true);
 400 }
 401
 402 /******************************************************************************/
 403 void GUIEngine::drawHeader(video::IVideoDriver* driver)
 404 {
 405         core::dimension2d<u32> screensize = driver->getScreenSize();
 406
 407         video::ITexture* texture = m_textures[TEX_LAYER_HEADER];
 408
 409         /* If no texture, draw nothing */
 410         if(!texture)
 411                 return;
 412
 413         f32 mult = (((f32)screensize.Width / 2.0)) /
 414                         ((f32)texture->getOriginalSize().Width);
 415
 416         v2s32 splashsize(((f32)texture->getOriginalSize().Width) * mult,
 417                         ((f32)texture->getOriginalSize().Height) * mult);
 418
 419         // Don't draw the header is there isn't enough room
 420         s32 free_space = (((s32)screensize.Height)-320)/2;
 421
 422         if (free_space > splashsize.Y) {
 423                 core::rect<s32> splashrect(0, 0, splashsize.X, splashsize.Y);
 424                 splashrect += v2s32((screensize.Width/2)-(splashsize.X/2),
 425                                 ((free_space/2)-splashsize.Y/2)+10);
 426
 427         video::SColor bgcolor(255,50,50,50);
 428
 429         driver->draw2DImage(texture, splashrect,
 430                 core::rect<s32>(core::position2d<s32>(0,0),
 431                 core::dimension2di(texture->getOriginalSize())),
 432                 NULL, NULL, true);
 433         }
 434 }
 435
 436 /******************************************************************************/
 437 void GUIEngine::drawFooter(video::IVideoDriver* driver)
 438 {
 439         core::dimension2d<u32> screensize = driver->getScreenSize();
 440
 441         video::ITexture* texture = m_textures[TEX_LAYER_FOOTER];
 442
 443         /* If no texture, draw nothing */
 444         if(!texture)
 445                 return;
 446
 447         f32 mult = (((f32)screensize.Width)) /
 448                         ((f32)texture->getOriginalSize().Width);
 449
 450         v2s32 footersize(((f32)texture->getOriginalSize().Width) * mult,
 451                         ((f32)texture->getOriginalSize().Height) * mult);
 452
 453         // Don't draw the footer if there isn't enough room
 454         s32 free_space = (((s32)screensize.Height)-320)/2;
 455
 456         if (free_space > footersize.Y) {
 457                 core::rect<s32> rect(0,0,footersize.X,footersize.Y);
 458                 rect += v2s32(screensize.Width/2,screensize.Height-footersize.Y);
 459                 rect -= v2s32(footersize.X/2, 0);
 460
 461                 driver->draw2DImage(texture, rect,
 462                         core::rect<s32>(core::position2d<s32>(0,0),
 463                         core::dimension2di(texture->getOriginalSize())),
 464                         NULL, NULL, true);
 465         }
 466 }
 467
 468 /******************************************************************************/
 469 bool GUIEngine::setTexture(texture_layer layer,std::string texturepath) {
 470
 471         video::IVideoDriver* driver = m_device->getVideoDriver();
 472         assert(driver != 0);
 473
 474         if (m_textures[layer] != 0)
 475         {
 476                 driver->removeTexture(m_textures[layer]);
 477                 m_textures[layer] = 0;
 478         }
 479
 480         if ((texturepath == "") || !fs::PathExists(texturepath))
 481                 return false;
 482
 483         m_textures[layer] = driver->getTexture(texturepath.c_str());
 484
 485         if (m_textures[layer] == 0) return false;
 486
 487         return true;
 488 }
 489
 490 /******************************************************************************/
 491 bool GUIEngine::downloadFile(std::string url,std::string target) {
 492 #if USE_CURL
 493         std::ofstream targetfile(target.c_str(), std::ios::out | std::ios::binary);
 494
 495         if (!targetfile.good()) {
 496                 return false;
 497         }
 498
 499         HTTPFetchRequest fetchrequest;
 500         HTTPFetchResult fetchresult;
 501         fetchrequest.url = url;
 502         fetchrequest.caller = HTTPFETCH_SYNC;
 503         httpfetch_sync(fetchrequest, fetchresult);
 504
 505         if (fetchresult.succeeded) {
 506                 targetfile << fetchresult.data;
 507         } else {
 508                 return false;
 509         }
 510
 511         return true;
 512 #else
 513         return false;
 514 #endif
 515 }
 516
 517 /******************************************************************************/
 518 void GUIEngine::setTopleftText(std::string append) {
 519         std::string toset = std::string("Minetest ") + minetest_version_hash;
 520
 521         if (append != "") {
 522                 toset += " / ";
 523                 toset += append;
 524         }
 525
 526         m_irr_toplefttext->setText(narrow_to_wide(toset).c_str());
 527 }
 528
 529 /******************************************************************************/
 530 s32 GUIEngine::playSound(SimpleSoundSpec spec, bool looped)
 531 {
 532         s32 handle = m_sound_manager->playSound(spec, looped);
 533         return handle;
 534 }
 535
 536 /******************************************************************************/
 537 void GUIEngine::stopSound(s32 handle)
 538 {
 539         m_sound_manager->stopSound(handle);
 540 }
 541
 542 /******************************************************************************/
 543 unsigned int GUIEngine::queueAsync(std::string serialized_func,
 544                 std::string serialized_params) {
 545         return m_script->queueAsync(serialized_func, serialized_params);
 546 }
 547