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