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