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