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