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 <fstream>
  23 #include <IGUIStaticText.h>
  24 #include <ICameraSceneNode.h>
  25 #include "scripting_mainmenu.h"
  26 #include "util/numeric.h"
  27 #include "config.h"
  28 #include "version.h"
  29 #include "porting.h"
  30 #include "filesys.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 #include "fontengine.h"
  39 #include "guiscalingfilter.h"
  40 #include "irrlicht_changes/static_text.h"
  41
  42 #ifdef __ANDROID__
  43 #include "client/tile.h"
  44 #include <GLES/gl.h>
  45 #endif
  46
  47
  48 /******************************************************************************/
  49 void TextDestGuiEngine::gotText(const StringMap &fields)
  50 {
  51         m_engine->getScriptIface()->handleMainMenuButtons(fields);
  52 }
  53
  54 /******************************************************************************/
  55 void TextDestGuiEngine::gotText(const std::wstring &text)
  56 {
  57         m_engine->getScriptIface()->handleMainMenuEvent(wide_to_utf8(text));
  58 }
  59
  60 /******************************************************************************/
  61 MenuTextureSource::~MenuTextureSource()
  62 {
  63         for (std::set<std::string>::iterator it = m_to_delete.begin();
  64                         it != m_to_delete.end(); ++it) {
  65                 const char *tname = (*it).c_str();
  66                 video::ITexture *texture = m_driver->getTexture(tname);
  67                 m_driver->removeTexture(texture);
  68         }
  69 }
  70
  71 /******************************************************************************/
  72 video::ITexture *MenuTextureSource::getTexture(const std::string &name, u32 *id)
  73 {
  74         if(id)
  75                 *id = 0;
  76         if(name.empty())
  77                 return NULL;
  78         m_to_delete.insert(name);
  79
  80 #ifdef __ANDROID__
  81         video::IImage *image = m_driver->createImageFromFile(name.c_str());
  82         if (image) {
  83                 image = Align2Npot2(image, m_driver);
  84                 video::ITexture* retval = m_driver->addTexture(name.c_str(), image);
  85                 image->drop();
  86                 return retval;
  87         }
  88 #endif
  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                 JoystickController *joystick,
 119                 gui::IGUIElement *parent,
 120                 IMenuManager *menumgr,
 121                 scene::ISceneManager *smgr,
 122                 MainMenuData *data,
 123                 bool &kill) :
 124         m_device(dev),
 125         m_parent(parent),
 126         m_menumanager(menumgr),
 127         m_smgr(smgr),
 128         m_data(data),
 129         m_kill(kill)
 130 {
 131         //initialize texture pointers
 132         for (unsigned int i = 0; i < TEX_LAYER_MAX; i++) {
 133                 m_textures[i].texture = NULL;
 134         }
 135         // is deleted by guiformspec!
 136         m_buttonhandler = new TextDestGuiEngine(this);
 137
 138         //create texture source
 139         m_texture_source = new MenuTextureSource(m_device->getVideoDriver());
 140
 141         //create soundmanager
 142         MenuMusicFetcher soundfetcher;
 143 #if USE_SOUND
 144         m_sound_manager = createOpenALSoundManager(&soundfetcher);
 145 #endif
 146         if(!m_sound_manager)
 147                 m_sound_manager = &dummySoundManager;
 148
 149         //create topleft header
 150         m_toplefttext = L"";
 151
 152         core::rect<s32> rect(0, 0, g_fontengine->getTextWidth(m_toplefttext.c_str()),
 153                 g_fontengine->getTextHeight());
 154         rect += v2s32(4, 0);
 155
 156         m_irr_toplefttext =
 157                 addStaticText(m_device->getGUIEnvironment(), m_toplefttext,
 158                         rect, false, true, 0, -1);
 159
 160         //create formspecsource
 161         m_formspecgui = new FormspecFormSource("");
 162
 163         /* Create menu */
 164         m_menu = new GUIFormSpecMenu(m_device,
 165                         joystick,
 166                         m_parent,
 167                         -1,
 168                         m_menumanager,
 169                         NULL /* &client */,
 170                         m_texture_source,
 171                         m_formspecgui,
 172                         m_buttonhandler,
 173                         false);
 174
 175         m_menu->allowClose(false);
 176         m_menu->lockSize(true,v2u32(800,600));
 177
 178         // Initialize scripting
 179
 180         infostream << "GUIEngine: Initializing Lua" << std::endl;
 181
 182         m_script = new MainMenuScripting(this);
 183
 184         try {
 185                 m_script->setMainMenuData(&m_data->script_data);
 186                 m_data->script_data.errormessage = "";
 187
 188                 if (!loadMainMenuScript()) {
 189                         errorstream << "No future without main menu!" << std::endl;
 190                         abort();
 191                 }
 192
 193                 run();
 194         } catch (LuaError &e) {
 195                 errorstream << "Main menu error: " << e.what() << std::endl;
 196                 m_data->script_data.errormessage = e.what();
 197         }
 198
 199         m_menu->quitMenu();
 200         m_menu->drop();
 201         m_menu = NULL;
 202 }
 203
 204 /******************************************************************************/
 205 bool GUIEngine::loadMainMenuScript()
 206 {
 207         // Set main menu path (for core.get_mainmenu_path())
 208         m_scriptdir = g_settings->get("main_menu_path");
 209         if (m_scriptdir.empty()) {
 210                 m_scriptdir = porting::path_share + DIR_DELIM + "builtin" + DIR_DELIM + "mainmenu";
 211         }
 212
 213         // Load builtin (which will load the main menu script)
 214         std::string script = porting::path_share + DIR_DELIM "builtin" + DIR_DELIM "init.lua";
 215         try {
 216                 m_script->loadScript(script);
 217                 // Menu script loaded
 218                 return true;
 219         } catch (const ModError &e) {
 220                 errorstream << "GUIEngine: execution of menu script failed: "
 221                         << e.what() << std::endl;
 222         }
 223
 224         return false;
 225 }
 226
 227 /******************************************************************************/
 228 void GUIEngine::run()
 229 {
 230         // Always create clouds because they may or may not be
 231         // needed based on the game selected
 232         video::IVideoDriver* driver = m_device->getVideoDriver();
 233
 234         cloudInit();
 235
 236         unsigned int text_height = g_fontengine->getTextHeight();
 237
 238         irr::core::dimension2d<u32> previous_screen_size(g_settings->getU16("screen_w"),
 239                 g_settings->getU16("screen_h"));
 240
 241         while (m_device->run() && (!m_startgame) && (!m_kill)) {
 242
 243                 const irr::core::dimension2d<u32> &current_screen_size =
 244                         m_device->getVideoDriver()->getScreenSize();
 245                 // Verify if window size has changed and save it if it's the case
 246                 // Ensure evaluating settings->getBool after verifying screensize
 247                 // First condition is cheaper
 248                 if (previous_screen_size != current_screen_size &&
 249                                 current_screen_size != irr::core::dimension2d<u32>(0,0) &&
 250                                 g_settings->getBool("autosave_screensize")) {
 251                         g_settings->setU16("screen_w", current_screen_size.Width);
 252                         g_settings->setU16("screen_h", current_screen_size.Height);
 253                         previous_screen_size = current_screen_size;
 254                 }
 255
 256                 //check if we need to update the "upper left corner"-text
 257                 if (text_height != g_fontengine->getTextHeight()) {
 258                         updateTopLeftTextSize();
 259                         text_height = g_fontengine->getTextHeight();
 260                 }
 261
 262                 driver->beginScene(true, true, video::SColor(255,140,186,250));
 263
 264                 if (m_clouds_enabled)
 265                 {
 266                         cloudPreProcess();
 267                         drawOverlay(driver);
 268                 }
 269                 else
 270                         drawBackground(driver);
 271
 272                 drawHeader(driver);
 273                 drawFooter(driver);
 274
 275                 m_device->getGUIEnvironment()->drawAll();
 276
 277                 driver->endScene();
 278
 279                 if (m_clouds_enabled)
 280                         cloudPostProcess();
 281                 else
 282                         sleep_ms(25);
 283
 284                 m_script->step();
 285
 286 #ifdef __ANDROID__
 287                 m_menu->getAndroidUIInput();
 288 #endif
 289         }
 290 }
 291
 292 /******************************************************************************/
 293 GUIEngine::~GUIEngine()
 294 {
 295         video::IVideoDriver* driver = m_device->getVideoDriver();
 296         FATAL_ERROR_IF(driver == 0, "Could not get video driver");
 297
 298         if(m_sound_manager != &dummySoundManager){
 299                 delete m_sound_manager;
 300                 m_sound_manager = NULL;
 301         }
 302
 303         infostream<<"GUIEngine: Deinitializing scripting"<<std::endl;
 304         delete m_script;
 305
 306         m_irr_toplefttext->setText(L"");
 307
 308         //clean up texture pointers
 309         for (unsigned int i = 0; i < TEX_LAYER_MAX; i++) {
 310                 if (m_textures[i].texture)
 311                         driver->removeTexture(m_textures[i].texture);
 312         }
 313
 314         delete m_texture_source;
 315
 316         if (m_cloud.clouds)
 317                 m_cloud.clouds->drop();
 318 }
 319
 320 /******************************************************************************/
 321 void GUIEngine::cloudInit()
 322 {
 323         m_cloud.clouds = new Clouds(m_smgr->getRootSceneNode(),
 324                         m_smgr, -1, rand(), 100);
 325         m_cloud.clouds->update(v2f(0, 0), video::SColor(255,200,200,255));
 326
 327         m_cloud.camera = m_smgr->addCameraSceneNode(0,
 328                                 v3f(0,0,0), v3f(0, 60, 100));
 329         m_cloud.camera->setFarValue(10000);
 330
 331         m_cloud.lasttime = m_device->getTimer()->getTime();
 332 }
 333
 334 /******************************************************************************/
 335 void GUIEngine::cloudPreProcess()
 336 {
 337         u32 time = m_device->getTimer()->getTime();
 338
 339         if(time > m_cloud.lasttime)
 340                 m_cloud.dtime = (time - m_cloud.lasttime) / 1000.0;
 341         else
 342                 m_cloud.dtime = 0;
 343
 344         m_cloud.lasttime = time;
 345
 346         m_cloud.clouds->step(m_cloud.dtime*3);
 347         m_cloud.clouds->render();
 348         m_smgr->drawAll();
 349 }
 350
 351 /******************************************************************************/
 352 void GUIEngine::cloudPostProcess()
 353 {
 354         float fps_max = g_settings->getFloat("pause_fps_max");
 355         // Time of frame without fps limit
 356         u32 busytime_u32;
 357
 358         // not using getRealTime is necessary for wine
 359         u32 time = m_device->getTimer()->getTime();
 360         if(time > m_cloud.lasttime)
 361                 busytime_u32 = time - m_cloud.lasttime;
 362         else
 363                 busytime_u32 = 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                                 draw2DImageFilterScaled(driver, 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         draw2DImageFilterScaled(driver, 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 nothing */
 424         if(!texture)
 425                 return;
 426
 427         /* Draw background texture */
 428         v2u32 sourcesize = texture->getOriginalSize();
 429         draw2DImageFilterScaled(driver, 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 if 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         draw2DImageFilterScaled(driver, 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                 draw2DImageFilterScaled(driver, 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         FATAL_ERROR_IF(driver == 0, "Could not get video driver");
 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(const std::string &url, const 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(const std::string &text)
 561 {
 562         m_toplefttext = utf8_to_wide(text);
 563
 564         updateTopLeftTextSize();
 565 }
 566
 567 /******************************************************************************/
 568 void GUIEngine::updateTopLeftTextSize()
 569 {
 570         core::rect<s32> rect(0, 0, g_fontengine->getTextWidth(m_toplefttext.c_str()),
 571                 g_fontengine->getTextHeight());
 572         rect += v2s32(4, 0);
 573
 574         m_irr_toplefttext->remove();
 575         m_irr_toplefttext =
 576                 addStaticText(m_device->getGUIEnvironment(), m_toplefttext,
 577                         rect, false, true, 0, -1);
 578 }
 579
 580 /******************************************************************************/
 581 s32 GUIEngine::playSound(SimpleSoundSpec spec, bool looped)
 582 {
 583         s32 handle = m_sound_manager->playSound(spec, looped);
 584         return handle;
 585 }
 586
 587 /******************************************************************************/
 588 void GUIEngine::stopSound(s32 handle)
 589 {
 590         m_sound_manager->stopSound(handle);
 591 }
 592
 593 /******************************************************************************/
 594 unsigned int GUIEngine::queueAsync(const std::string &serialized_func,
 595                 const std::string &serialized_params)
 596 {
 597         return m_script->queueAsync(serialized_func, serialized_params);
 598 }
 599