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