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