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