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