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("",&m_formspecgui);
 170
 171         /* Create menu */
 172         m_menu =
 173                 new GUIFormSpecMenu(    m_device,
 174                                                                 m_parent,
 175                                                                 -1,
 176                                                                 m_menumanager,
 177                                                                 0 /* &client */,
 178                                                                 0 /* gamedef */,
 179                                                                 m_texture_source);
 180
 181         m_menu->allowClose(false);
 182         m_menu->lockSize(true,v2u32(800,600));
 183         m_menu->setFormSource(m_formspecgui);
 184         m_menu->setTextDest(m_buttonhandler);
 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                 {
 195                         m_script->setMainMenuErrorMessage(m_data->errormessage);
 196                         m_data->errormessage = "";
 197                 }
 198
 199                 if (!loadMainMenuScript())
 200                         assert("no future without mainmenu" == 0);
 201
 202                 run();
 203         }
 204         catch(LuaError &e) {
 205                 errorstream << "MAINMENU ERROR: " << e.what() << std::endl;
 206                 m_data->errormessage = e.what();
 207         }
 208
 209         m_menu->quitMenu();
 210         m_menu->drop();
 211         m_menu = 0;
 212 }
 213
 214 /******************************************************************************/
 215 bool GUIEngine::loadMainMenuScript()
 216 {
 217         // Try custom menu script (main_menu_script)
 218
 219         std::string menuscript = g_settings->get("main_menu_script");
 220         if(menuscript != "") {
 221                 m_scriptdir = fs::RemoveLastPathComponent(menuscript);
 222
 223                 if(m_script->loadMod(menuscript, "__custommenu")) {
 224                         // custom menu script loaded
 225                         return true;
 226                 }
 227                 else {
 228                         infostream
 229                                 << "GUIEngine: execution of custom menu failed!"
 230                                 << std::endl
 231                                 << "\tfalling back to builtin menu"
 232                                 << std::endl;
 233                 }
 234         }
 235
 236         // Try builtin menu script (main_menu_script)
 237
 238         std::string builtin_menuscript =
 239                         porting::path_share + DIR_DELIM + "builtin"
 240                                 + DIR_DELIM + "mainmenu.lua";
 241
 242         m_scriptdir = fs::RemoveRelativePathComponents(
 243                         fs::RemoveLastPathComponent(builtin_menuscript));
 244
 245         if(m_script->loadMod(builtin_menuscript, "__builtinmenu")) {
 246                 // builtin menu script loaded
 247                 return true;
 248         }
 249         else {
 250                 errorstream
 251                         << "GUIEngine: unable to load builtin menu"
 252                         << std::endl;
 253         }
 254
 255         return false;
 256 }
 257
 258 /******************************************************************************/
 259 void GUIEngine::run()
 260 {
 261
 262         // Always create clouds because they may or may not be
 263         // needed based on the game selected
 264         video::IVideoDriver* driver = m_device->getVideoDriver();
 265
 266         cloudInit();
 267
 268         while(m_device->run() && (!m_startgame) && (!m_kill)) {
 269                 driver->beginScene(true, true, video::SColor(255,140,186,250));
 270
 271                 if (m_clouds_enabled)
 272                 {
 273                         cloudPreProcess();
 274                         drawOverlay(driver);
 275                 }
 276                 else
 277                         drawBackground(driver);
 278
 279                 drawHeader(driver);
 280                 drawFooter(driver);
 281
 282                 m_device->getGUIEnvironment()->drawAll();
 283
 284                 driver->endScene();
 285
 286                 if (m_clouds_enabled)
 287                         cloudPostProcess();
 288                 else
 289                         sleep_ms(25);
 290
 291                 m_script->Step();
 292         }
 293 }
 294
 295 /******************************************************************************/
 296 GUIEngine::~GUIEngine()
 297 {
 298         video::IVideoDriver* driver = m_device->getVideoDriver();
 299         assert(driver != 0);
 300
 301         if(m_sound_manager != &dummySoundManager){
 302                 delete m_sound_manager;
 303                 m_sound_manager = NULL;
 304         }
 305
 306         //TODO: clean up m_menu here
 307
 308         infostream<<"GUIEngine: Deinitializing scripting"<<std::endl;
 309         delete m_script;
 310
 311         m_irr_toplefttext->setText(L"");
 312
 313         //clean up texture pointers
 314         for (unsigned int i = 0; i < TEX_LAYER_MAX; i++) {
 315                 if (m_textures[i] != 0)
 316                         driver->removeTexture(m_textures[i]);
 317         }
 318
 319         delete m_texture_source;
 320
 321         if (m_cloud.clouds)
 322                 m_cloud.clouds->drop();
 323 }
 324
 325 /******************************************************************************/
 326 void GUIEngine::cloudInit()
 327 {
 328         m_cloud.clouds = new Clouds(m_smgr->getRootSceneNode(),
 329                         m_smgr, -1, rand(), 100);
 330         m_cloud.clouds->update(v2f(0, 0), video::SColor(255,200,200,255));
 331
 332         m_cloud.camera = m_smgr->addCameraSceneNode(0,
 333                                 v3f(0,0,0), v3f(0, 60, 100));
 334         m_cloud.camera->setFarValue(10000);
 335
 336         m_cloud.lasttime = m_device->getTimer()->getTime();
 337 }
 338
 339 /******************************************************************************/
 340 void GUIEngine::cloudPreProcess()
 341 {
 342         u32 time = m_device->getTimer()->getTime();
 343
 344         if(time > m_cloud.lasttime)
 345                 m_cloud.dtime = (time - m_cloud.lasttime) / 1000.0;
 346         else
 347                 m_cloud.dtime = 0;
 348
 349         m_cloud.lasttime = time;
 350
 351         m_cloud.clouds->step(m_cloud.dtime*3);
 352         m_cloud.clouds->render();
 353         m_smgr->drawAll();
 354 }
 355
 356 /******************************************************************************/
 357 void GUIEngine::cloudPostProcess()
 358 {
 359         float fps_max = g_settings->getFloat("fps_max");
 360         // Time of frame without fps limit
 361         float busytime;
 362         u32 busytime_u32;
 363         // not using getRealTime is necessary for wine
 364         u32 time = m_device->getTimer()->getTime();
 365         if(time > m_cloud.lasttime)
 366                 busytime_u32 = time - m_cloud.lasttime;
 367         else
 368                 busytime_u32 = 0;
 369         busytime = busytime_u32 / 1000.0;
 370
 371         // FPS limiter
 372         u32 frametime_min = 1000./fps_max;
 373
 374         if(busytime_u32 < frametime_min) {
 375                 u32 sleeptime = frametime_min - busytime_u32;
 376                 m_device->sleep(sleeptime);
 377         }
 378 }
 379
 380 /******************************************************************************/
 381 void GUIEngine::drawBackground(video::IVideoDriver* driver)
 382 {
 383         v2u32 screensize = driver->getScreenSize();
 384
 385         video::ITexture* texture = m_textures[TEX_LAYER_BACKGROUND];
 386
 387         /* If no texture, draw background of solid color */
 388         if(!texture){
 389                 video::SColor color(255,80,58,37);
 390                 core::rect<s32> rect(0, 0, screensize.X, screensize.Y);
 391                 driver->draw2DRectangle(color, rect, NULL);
 392                 return;
 393         }
 394
 395         /* Draw background texture */
 396         v2u32 sourcesize = texture->getOriginalSize();
 397         driver->draw2DImage(texture,
 398                 core::rect<s32>(0, 0, screensize.X, screensize.Y),
 399                 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
 400                 NULL, NULL, true);
 401 }
 402
 403 /******************************************************************************/
 404 void GUIEngine::drawOverlay(video::IVideoDriver* driver)
 405 {
 406         v2u32 screensize = driver->getScreenSize();
 407
 408         video::ITexture* texture = m_textures[TEX_LAYER_OVERLAY];
 409
 410         /* If no texture, draw background of solid color */
 411         if(!texture)
 412                 return;
 413
 414         /* Draw background texture */
 415         v2u32 sourcesize = texture->getOriginalSize();
 416         driver->draw2DImage(texture,
 417                 core::rect<s32>(0, 0, screensize.X, screensize.Y),
 418                 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
 419                 NULL, NULL, true);
 420 }
 421
 422 /******************************************************************************/
 423 void GUIEngine::drawHeader(video::IVideoDriver* driver)
 424 {
 425         core::dimension2d<u32> screensize = driver->getScreenSize();
 426
 427         video::ITexture* texture = m_textures[TEX_LAYER_HEADER];
 428
 429         /* If no texture, draw nothing */
 430         if(!texture)
 431                 return;
 432
 433         f32 mult = (((f32)screensize.Width / 2.0)) /
 434                         ((f32)texture->getOriginalSize().Width);
 435
 436         v2s32 splashsize(((f32)texture->getOriginalSize().Width) * mult,
 437                         ((f32)texture->getOriginalSize().Height) * mult);
 438
 439         // Don't draw the header is there isn't enough room
 440         s32 free_space = (((s32)screensize.Height)-320)/2;
 441
 442         if (free_space > splashsize.Y) {
 443                 core::rect<s32> splashrect(0, 0, splashsize.X, splashsize.Y);
 444                 splashrect += v2s32((screensize.Width/2)-(splashsize.X/2),
 445                                 ((free_space/2)-splashsize.Y/2)+10);
 446
 447         video::SColor bgcolor(255,50,50,50);
 448
 449         driver->draw2DImage(texture, splashrect,
 450                 core::rect<s32>(core::position2d<s32>(0,0),
 451                 core::dimension2di(texture->getOriginalSize())),
 452                 NULL, NULL, true);
 453         }
 454 }
 455
 456 /******************************************************************************/
 457 void GUIEngine::drawFooter(video::IVideoDriver* driver)
 458 {
 459         core::dimension2d<u32> screensize = driver->getScreenSize();
 460
 461         video::ITexture* texture = m_textures[TEX_LAYER_FOOTER];
 462
 463         /* If no texture, draw nothing */
 464         if(!texture)
 465                 return;
 466
 467         f32 mult = (((f32)screensize.Width)) /
 468                         ((f32)texture->getOriginalSize().Width);
 469
 470         v2s32 footersize(((f32)texture->getOriginalSize().Width) * mult,
 471                         ((f32)texture->getOriginalSize().Height) * mult);
 472
 473         // Don't draw the footer if there isn't enough room
 474         s32 free_space = (((s32)screensize.Height)-320)/2;
 475
 476         if (free_space > footersize.Y) {
 477                 core::rect<s32> rect(0,0,footersize.X,footersize.Y);
 478                 rect += v2s32(screensize.Width/2,screensize.Height-footersize.Y);
 479                 rect -= v2s32(footersize.X/2, 0);
 480
 481                 driver->draw2DImage(texture, rect,
 482                         core::rect<s32>(core::position2d<s32>(0,0),
 483                         core::dimension2di(texture->getOriginalSize())),
 484                         NULL, NULL, true);
 485         }
 486 }
 487
 488 /******************************************************************************/
 489 bool GUIEngine::setTexture(texture_layer layer,std::string texturepath) {
 490
 491         video::IVideoDriver* driver = m_device->getVideoDriver();
 492         assert(driver != 0);
 493
 494         if (m_textures[layer] != 0)
 495         {
 496                 driver->removeTexture(m_textures[layer]);
 497                 m_textures[layer] = 0;
 498         }
 499
 500         if ((texturepath == "") || !fs::PathExists(texturepath))
 501                 return false;
 502
 503         m_textures[layer] = driver->getTexture(texturepath.c_str());
 504
 505         if (m_textures[layer] == 0) return false;
 506
 507         return true;
 508 }
 509
 510 /******************************************************************************/
 511 bool GUIEngine::downloadFile(std::string url,std::string target) {
 512 #if USE_CURL
 513         bool retval = true;
 514
 515         FILE* targetfile = fopen(target.c_str(),"wb");
 516
 517         if (targetfile) {
 518                 HTTPFetchRequest fetchrequest;
 519                 HTTPFetchResult fetchresult;
 520                 fetchrequest.url = url;
 521                 fetchrequest.useragent = std::string("Minetest ")+minetest_version_hash;
 522                 fetchrequest.timeout = g_settings->getS32("curl_timeout");
 523                 fetchrequest.caller = HTTPFETCH_SYNC;
 524                 httpfetch_sync(fetchrequest,fetchresult);
 525
 526                 if (fetchresult.succeeded) {
 527                         if (fwrite(fetchresult.data.c_str(),1,fetchresult.data.size(),targetfile) != fetchresult.data.size()) {
 528                                 retval = false;
 529                         }
 530                 }
 531                 else {
 532                         retval = false;
 533                 }
 534                 fclose(targetfile);
 535         }
 536         else {
 537                 retval = false;
 538         }
 539
 540         return retval;
 541 #else
 542         return false;
 543 #endif
 544 }
 545
 546 /******************************************************************************/
 547 void GUIEngine::setTopleftText(std::string append) {
 548         std::string toset = std::string("Minetest ") + minetest_version_hash;
 549
 550         if (append != "") {
 551                 toset += " / ";
 552                 toset += append;
 553         }
 554
 555         m_irr_toplefttext->setText(narrow_to_wide(toset).c_str());
 556 }
 557
 558 /******************************************************************************/
 559 s32 GUIEngine::playSound(SimpleSoundSpec spec, bool looped)
 560 {
 561         s32 handle = m_sound_manager->playSound(spec, looped);
 562         return handle;
 563 }
 564
 565 /******************************************************************************/
 566 void GUIEngine::stopSound(s32 handle)
 567 {
 568         m_sound_manager->stopSound(handle);
 569 }
 570
 571 /******************************************************************************/
 572 unsigned int GUIEngine::DoAsync(std::string serialized_fct,
 573                 std::string serialized_params) {
 574         return m_script->DoAsync(serialized_fct,serialized_params);
 575 }