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