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