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