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_sound_manager,
 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                 IrrlichtDevice *device = RenderingEngine::get_raw_device();
 302                 u32 frametime_min = 1000 / (device->isWindowFocused()
 303                         ? g_settings->getFloat("fps_max")
 304                         : g_settings->getFloat("fps_max_unfocused"));
 305                 if (m_clouds_enabled)
 306                         cloudPostProcess(frametime_min, device);
 307                 else
 308                         sleep_ms(frametime_min);
 309
 310                 m_script->step();
 311
 312 #ifdef __ANDROID__
 313                 m_menu->getAndroidUIInput();
 314 #endif
 315         }
 316 }
 317
 318 /******************************************************************************/
 319 GUIEngine::~GUIEngine()
 320 {
 321         if (m_sound_manager != &dummySoundManager){
 322                 delete m_sound_manager;
 323                 m_sound_manager = NULL;
 324         }
 325
 326         infostream<<"GUIEngine: Deinitializing scripting"<<std::endl;
 327         delete m_script;
 328
 329         m_irr_toplefttext->setText(L"");
 330
 331         //clean up texture pointers
 332         for (image_definition &texture : m_textures) {
 333                 if (texture.texture)
 334                         RenderingEngine::get_video_driver()->removeTexture(texture.texture);
 335         }
 336
 337         delete m_texture_source;
 338
 339         if (m_cloud.clouds)
 340                 m_cloud.clouds->drop();
 341 }
 342
 343 /******************************************************************************/
 344 void GUIEngine::cloudInit()
 345 {
 346         m_cloud.clouds = new Clouds(m_smgr, -1, rand());
 347         m_cloud.clouds->setHeight(100.0f);
 348         m_cloud.clouds->update(v3f(0, 0, 0), video::SColor(255,240,240,255));
 349
 350         m_cloud.camera = m_smgr->addCameraSceneNode(0,
 351                                 v3f(0,0,0), v3f(0, 60, 100));
 352         m_cloud.camera->setFarValue(10000);
 353
 354         m_cloud.lasttime = RenderingEngine::get_timer_time();
 355 }
 356
 357 /******************************************************************************/
 358 void GUIEngine::cloudPreProcess()
 359 {
 360         u32 time = RenderingEngine::get_timer_time();
 361
 362         if(time > m_cloud.lasttime)
 363                 m_cloud.dtime = (time - m_cloud.lasttime) / 1000.0;
 364         else
 365                 m_cloud.dtime = 0;
 366
 367         m_cloud.lasttime = time;
 368
 369         m_cloud.clouds->step(m_cloud.dtime*3);
 370         m_cloud.clouds->render();
 371         m_smgr->drawAll();
 372 }
 373
 374 /******************************************************************************/
 375 void GUIEngine::cloudPostProcess(u32 frametime_min, IrrlichtDevice *device)
 376 {
 377         // Time of frame without fps limit
 378         u32 busytime_u32;
 379
 380         // not using getRealTime is necessary for wine
 381         u32 time = RenderingEngine::get_timer_time();
 382         if(time > m_cloud.lasttime)
 383                 busytime_u32 = time - m_cloud.lasttime;
 384         else
 385                 busytime_u32 = 0;
 386
 387         // FPS limit
 388         if (busytime_u32 < frametime_min) {
 389                 u32 sleeptime = frametime_min - busytime_u32;
 390                 device->sleep(sleeptime);
 391         }
 392 }
 393
 394 /******************************************************************************/
 395 void GUIEngine::setFormspecPrepend(const std::string &fs)
 396 {
 397         if (m_menu) {
 398                 m_menu->setFormspecPrepend(fs);
 399         }
 400 }
 401
 402
 403 /******************************************************************************/
 404 void GUIEngine::drawBackground(video::IVideoDriver *driver)
 405 {
 406         v2u32 screensize = driver->getScreenSize();
 407
 408         video::ITexture* texture = m_textures[TEX_LAYER_BACKGROUND].texture;
 409
 410         /* If no texture, draw background of solid color */
 411         if(!texture){
 412                 video::SColor color(255,80,58,37);
 413                 core::rect<s32> rect(0, 0, screensize.X, screensize.Y);
 414                 driver->draw2DRectangle(color, rect, NULL);
 415                 return;
 416         }
 417
 418         v2u32 sourcesize = texture->getOriginalSize();
 419
 420         if (m_textures[TEX_LAYER_BACKGROUND].tile)
 421         {
 422                 v2u32 tilesize(
 423                                 MYMAX(sourcesize.X,m_textures[TEX_LAYER_BACKGROUND].minsize),
 424                                 MYMAX(sourcesize.Y,m_textures[TEX_LAYER_BACKGROUND].minsize));
 425                 for (unsigned int x = 0; x < screensize.X; x += tilesize.X )
 426                 {
 427                         for (unsigned int y = 0; y < screensize.Y; y += tilesize.Y )
 428                         {
 429                                 draw2DImageFilterScaled(driver, texture,
 430                                         core::rect<s32>(x, y, x+tilesize.X, y+tilesize.Y),
 431                                         core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
 432                                         NULL, NULL, true);
 433                         }
 434                 }
 435                 return;
 436         }
 437
 438         /* Draw background texture */
 439         draw2DImageFilterScaled(driver, texture,
 440                 core::rect<s32>(0, 0, screensize.X, screensize.Y),
 441                 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
 442                 NULL, NULL, true);
 443 }
 444
 445 /******************************************************************************/
 446 void GUIEngine::drawOverlay(video::IVideoDriver *driver)
 447 {
 448         v2u32 screensize = driver->getScreenSize();
 449
 450         video::ITexture* texture = m_textures[TEX_LAYER_OVERLAY].texture;
 451
 452         /* If no texture, draw nothing */
 453         if(!texture)
 454                 return;
 455
 456         /* Draw background texture */
 457         v2u32 sourcesize = texture->getOriginalSize();
 458         draw2DImageFilterScaled(driver, texture,
 459                 core::rect<s32>(0, 0, screensize.X, screensize.Y),
 460                 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
 461                 NULL, NULL, true);
 462 }
 463
 464 /******************************************************************************/
 465 void GUIEngine::drawHeader(video::IVideoDriver *driver)
 466 {
 467         core::dimension2d<u32> screensize = driver->getScreenSize();
 468
 469         video::ITexture* texture = m_textures[TEX_LAYER_HEADER].texture;
 470
 471         /* If no texture, draw nothing */
 472         if(!texture)
 473                 return;
 474
 475         f32 mult = (((f32)screensize.Width / 2.0)) /
 476                         ((f32)texture->getOriginalSize().Width);
 477
 478         v2s32 splashsize(((f32)texture->getOriginalSize().Width) * mult,
 479                         ((f32)texture->getOriginalSize().Height) * mult);
 480
 481         // Don't draw the header if there isn't enough room
 482         s32 free_space = (((s32)screensize.Height)-320)/2;
 483
 484         if (free_space > splashsize.Y) {
 485                 core::rect<s32> splashrect(0, 0, splashsize.X, splashsize.Y);
 486                 splashrect += v2s32((screensize.Width/2)-(splashsize.X/2),
 487                                 ((free_space/2)-splashsize.Y/2)+10);
 488
 489         video::SColor bgcolor(255,50,50,50);
 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 = RenderingEngine::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(RenderingEngine::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 }
 617
 618 /******************************************************************************/
 619 unsigned int GUIEngine::queueAsync(const std::string &serialized_func,
 620                 const std::string &serialized_params)
 621 {
 622         return m_script->queueAsync(serialized_func, serialized_params);
 623 }