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