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