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 "scripting_mainmenu.h"
  23 #include "config.h"
  24 #include "porting.h"
  25 #include "filesys.h"
  26 #include "main.h"
  27 #include "settings.h"
  28 #include "guiMainMenu.h"
  29 #include "sound.h"
  30 #include "sound_openal.h"
  31
  32 #include <IGUIStaticText.h>
  33 #include <ICameraSceneNode.h>
  34
  35 #if USE_CURL
  36 #include <curl/curl.h>
  37 #endif
  38
  39 /******************************************************************************/
  40 TextDestGuiEngine::TextDestGuiEngine(GUIEngine* engine)
  41 {
  42         m_engine = engine;
  43 }
  44
  45 /******************************************************************************/
  46 void TextDestGuiEngine::gotText(std::map<std::string, std::string> fields)
  47 {
  48         m_engine->getScriptIface()->handleMainMenuButtons(fields);
  49 }
  50
  51 /******************************************************************************/
  52 void TextDestGuiEngine::gotText(std::wstring text)
  53 {
  54         m_engine->getScriptIface()->handleMainMenuEvent(wide_to_narrow(text));
  55 }
  56
  57 /******************************************************************************/
  58 void MenuMusicFetcher::fetchSounds(const std::string &name,
  59                         std::set<std::string> &dst_paths,
  60                         std::set<std::string> &dst_datas)
  61 {
  62         if(m_fetched.count(name))
  63                 return;
  64         m_fetched.insert(name);
  65         std::string base;
  66         base = porting::path_share + DIR_DELIM + "sounds";
  67         dst_paths.insert(base + DIR_DELIM + name + ".ogg");
  68         int i;
  69         for(i=0; i<10; i++)
  70                 dst_paths.insert(base + DIR_DELIM + name + "."+itos(i)+".ogg");
  71         base = porting::path_user + DIR_DELIM + "sounds";
  72         dst_paths.insert(base + DIR_DELIM + name + ".ogg");
  73         for(i=0; i<10; i++)
  74                 dst_paths.insert(base + DIR_DELIM + name + "."+itos(i)+".ogg");
  75 }
  76
  77 /******************************************************************************/
  78 GUIEngine::GUIEngine(   irr::IrrlichtDevice* dev,
  79                                                 gui::IGUIElement* parent,
  80                                                 IMenuManager *menumgr,
  81                                                 scene::ISceneManager* smgr,
  82                                                 MainMenuData* data) :
  83         m_device(dev),
  84         m_parent(parent),
  85         m_menumanager(menumgr),
  86         m_smgr(smgr),
  87         m_data(data),
  88         m_sound_manager(NULL),
  89         m_formspecgui(0),
  90         m_buttonhandler(0),
  91         m_menu(0),
  92         m_startgame(false),
  93         m_script(0),
  94         m_scriptdir(""),
  95         m_irr_toplefttext(0),
  96         m_clouds_enabled(true),
  97         m_cloud()
  98 {
  99         //initialize texture pointers
 100         for (unsigned int i = 0; i < TEX_LAYER_MAX; i++) {
 101                 m_textures[i] = 0;
 102         }
 103         // is deleted by guiformspec!
 104         m_buttonhandler = new TextDestGuiEngine(this);
 105
 106         //create soundmanager
 107         MenuMusicFetcher soundfetcher;
 108 #if USE_SOUND
 109         m_sound_manager = createOpenALSoundManager(&soundfetcher);
 110 #endif
 111         if(!m_sound_manager)
 112                 m_sound_manager = &dummySoundManager;
 113
 114         //create topleft header
 115         core::rect<s32> rect(0, 0, 500, 40);
 116         rect += v2s32(4, 0);
 117         std::string t = "Minetest " VERSION_STRING;
 118
 119         m_irr_toplefttext =
 120                 m_device->getGUIEnvironment()->addStaticText(narrow_to_wide(t).c_str(),
 121                 rect,false,true,0,-1);
 122
 123         //create formspecsource
 124         m_formspecgui = new FormspecFormSource("",&m_formspecgui);
 125
 126         /* Create menu */
 127         m_menu =
 128                 new GUIFormSpecMenu(    m_device,
 129                                                                 m_parent,
 130                                                                 -1,
 131                                                                 m_menumanager,
 132                                                                 0 /* &client */,
 133                                                                 0 /* gamedef */);
 134
 135         m_menu->allowClose(false);
 136         m_menu->lockSize(true,v2u32(800,600));
 137         m_menu->setFormSource(m_formspecgui);
 138         m_menu->setTextDest(m_buttonhandler);
 139         m_menu->useGettext(true);
 140
 141         // Initialize scripting
 142
 143         infostream<<"GUIEngine: Initializing Lua"<<std::endl;
 144
 145         m_script = new MainMenuScripting(this);
 146
 147         try {
 148                 if (m_data->errormessage != "")
 149                 {
 150                         m_script->setMainMenuErrorMessage(m_data->errormessage);
 151                         m_data->errormessage = "";
 152                 }
 153
 154                 if (!loadMainMenuScript())
 155                         assert("no future without mainmenu" == 0);
 156
 157                 run();
 158         }
 159         catch(LuaError &e) {
 160                 errorstream << "MAINMENU ERROR: " << e.what() << std::endl;
 161                 m_data->errormessage = e.what();
 162         }
 163
 164         m_menu->quitMenu();
 165         m_menu->drop();
 166         m_menu = 0;
 167 }
 168
 169 /******************************************************************************/
 170 bool GUIEngine::loadMainMenuScript()
 171 {
 172         // Try custom menu script (main_menu_script)
 173
 174         std::string menuscript = g_settings->get("main_menu_script");
 175         if(menuscript != "") {
 176                 m_scriptdir = fs::RemoveLastPathComponent(menuscript);
 177
 178                 if(m_script->loadMod(menuscript, "__custommenu")) {
 179                         // custom menu script loaded
 180                         return true;
 181                 }
 182                 else {
 183                         infostream
 184                                 << "GUIEngine: execution of custom menu failed!"
 185                                 << std::endl
 186                                 << "\tfalling back to builtin menu"
 187                                 << std::endl;
 188                 }
 189         }
 190
 191         // Try builtin menu script (main_menu_script)
 192
 193         std::string builtin_menuscript =
 194                         porting::path_share + DIR_DELIM + "builtin"
 195                                 + DIR_DELIM + "mainmenu.lua";
 196
 197         m_scriptdir = fs::RemoveRelativePathComponents(
 198                         fs::RemoveLastPathComponent(builtin_menuscript));
 199
 200         if(m_script->loadMod(builtin_menuscript, "__builtinmenu")) {
 201                 // builtin menu script loaded
 202                 return true;
 203         }
 204         else {
 205                 errorstream
 206                         << "GUIEngine: unable to load builtin menu"
 207                         << std::endl;
 208         }
 209
 210         return false;
 211 }
 212
 213 /******************************************************************************/
 214 void GUIEngine::run()
 215 {
 216
 217         // Always create clouds because they may or may not be
 218         // needed based on the game selected
 219         video::IVideoDriver* driver = m_device->getVideoDriver();
 220
 221         cloudInit();
 222
 223         while(m_device->run() && (!m_startgame)) {
 224                 driver->beginScene(true, true, video::SColor(255,140,186,250));
 225
 226                 if (m_clouds_enabled)
 227                 {
 228                         cloudPreProcess();
 229                         drawOverlay(driver);
 230                 }
 231                 else
 232                         drawBackground(driver);
 233
 234                 drawHeader(driver);
 235                 drawFooter(driver);
 236
 237                 m_device->getGUIEnvironment()->drawAll();
 238
 239                 driver->endScene();
 240
 241                 if (m_clouds_enabled)
 242                         cloudPostProcess();
 243                 else
 244                         sleep_ms(25);
 245         }
 246 }
 247
 248 /******************************************************************************/
 249 GUIEngine::~GUIEngine()
 250 {
 251         video::IVideoDriver* driver = m_device->getVideoDriver();
 252         assert(driver != 0);
 253
 254         if(m_sound_manager != &dummySoundManager){
 255                 delete m_sound_manager;
 256                 m_sound_manager = NULL;
 257         }
 258
 259         //TODO: clean up m_menu here
 260
 261         infostream<<"GUIEngine: Deinitializing scripting"<<std::endl;
 262         delete m_script;
 263
 264         m_irr_toplefttext->setText(L"");
 265
 266         //initialize texture pointers
 267         for (unsigned int i = 0; i < TEX_LAYER_MAX; i++) {
 268                 if (m_textures[i] != 0)
 269                         driver->removeTexture(m_textures[i]);
 270         }
 271
 272         if (m_cloud.clouds)
 273                 m_cloud.clouds->drop();
 274 }
 275
 276 /******************************************************************************/
 277 void GUIEngine::cloudInit()
 278 {
 279         m_cloud.clouds = new Clouds(m_smgr->getRootSceneNode(),
 280                         m_smgr, -1, rand(), 100);
 281         m_cloud.clouds->update(v2f(0, 0), video::SColor(255,200,200,255));
 282
 283         m_cloud.camera = m_smgr->addCameraSceneNode(0,
 284                                 v3f(0,0,0), v3f(0, 60, 100));
 285         m_cloud.camera->setFarValue(10000);
 286
 287         m_cloud.lasttime = m_device->getTimer()->getTime();
 288 }
 289
 290 /******************************************************************************/
 291 void GUIEngine::cloudPreProcess()
 292 {
 293         u32 time = m_device->getTimer()->getTime();
 294
 295         if(time > m_cloud.lasttime)
 296                 m_cloud.dtime = (time - m_cloud.lasttime) / 1000.0;
 297         else
 298                 m_cloud.dtime = 0;
 299
 300         m_cloud.lasttime = time;
 301
 302         m_cloud.clouds->step(m_cloud.dtime*3);
 303         m_cloud.clouds->render();
 304         m_smgr->drawAll();
 305 }
 306
 307 /******************************************************************************/
 308 void GUIEngine::cloudPostProcess()
 309 {
 310         float fps_max = g_settings->getFloat("fps_max");
 311         // Time of frame without fps limit
 312         float busytime;
 313         u32 busytime_u32;
 314         // not using getRealTime is necessary for wine
 315         u32 time = m_device->getTimer()->getTime();
 316         if(time > m_cloud.lasttime)
 317                 busytime_u32 = time - m_cloud.lasttime;
 318         else
 319                 busytime_u32 = 0;
 320         busytime = busytime_u32 / 1000.0;
 321
 322         // FPS limiter
 323         u32 frametime_min = 1000./fps_max;
 324
 325         if(busytime_u32 < frametime_min) {
 326                 u32 sleeptime = frametime_min - busytime_u32;
 327                 m_device->sleep(sleeptime);
 328         }
 329 }
 330
 331 /******************************************************************************/
 332 void GUIEngine::drawBackground(video::IVideoDriver* driver)
 333 {
 334         v2u32 screensize = driver->getScreenSize();
 335
 336         video::ITexture* texture = m_textures[TEX_LAYER_BACKGROUND];
 337
 338         /* If no texture, draw background of solid color */
 339         if(!texture){
 340                 video::SColor color(255,80,58,37);
 341                 core::rect<s32> rect(0, 0, screensize.X, screensize.Y);
 342                 driver->draw2DRectangle(color, rect, NULL);
 343                 return;
 344         }
 345
 346         /* Draw background texture */
 347         v2u32 sourcesize = texture->getSize();
 348         driver->draw2DImage(texture,
 349                 core::rect<s32>(0, 0, screensize.X, screensize.Y),
 350                 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
 351                 NULL, NULL, true);
 352 }
 353
 354 /******************************************************************************/
 355 void GUIEngine::drawOverlay(video::IVideoDriver* driver)
 356 {
 357         v2u32 screensize = driver->getScreenSize();
 358
 359         video::ITexture* texture = m_textures[TEX_LAYER_OVERLAY];
 360
 361         /* If no texture, draw background of solid color */
 362         if(!texture)
 363                 return;
 364
 365         /* Draw background texture */
 366         v2u32 sourcesize = texture->getSize();
 367         driver->draw2DImage(texture,
 368                 core::rect<s32>(0, 0, screensize.X, screensize.Y),
 369                 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
 370                 NULL, NULL, true);
 371 }
 372
 373 /******************************************************************************/
 374 void GUIEngine::drawHeader(video::IVideoDriver* driver)
 375 {
 376         core::dimension2d<u32> screensize = driver->getScreenSize();
 377
 378         video::ITexture* texture = m_textures[TEX_LAYER_HEADER];
 379
 380         /* If no texture, draw nothing */
 381         if(!texture)
 382                 return;
 383
 384         f32 mult = (((f32)screensize.Width / 2)) /
 385                         ((f32)texture->getOriginalSize().Width);
 386
 387         v2s32 splashsize(((f32)texture->getOriginalSize().Width) * mult,
 388                         ((f32)texture->getOriginalSize().Height) * mult);
 389
 390         // Don't draw the header is there isn't enough room
 391         s32 free_space = (((s32)screensize.Height)-320)/2;
 392
 393         if (free_space > splashsize.Y) {
 394                 core::rect<s32> splashrect(0, 0, splashsize.X, splashsize.Y);
 395                 splashrect += v2s32((screensize.Width/2)-(splashsize.X/2),
 396                                 ((free_space/2)-splashsize.Y/2)+10);
 397
 398         video::SColor bgcolor(255,50,50,50);
 399
 400         driver->draw2DImage(texture, splashrect,
 401                 core::rect<s32>(core::position2d<s32>(0,0),
 402                 core::dimension2di(texture->getSize())),
 403                 NULL, NULL, true);
 404         }
 405 }
 406
 407 /******************************************************************************/
 408 void GUIEngine::drawFooter(video::IVideoDriver* driver)
 409 {
 410         core::dimension2d<u32> screensize = driver->getScreenSize();
 411
 412         video::ITexture* texture = m_textures[TEX_LAYER_FOOTER];
 413
 414         /* If no texture, draw nothing */
 415         if(!texture)
 416                 return;
 417
 418         f32 mult = (((f32)screensize.Width)) /
 419                         ((f32)texture->getOriginalSize().Width);
 420
 421         v2s32 footersize(((f32)texture->getOriginalSize().Width) * mult,
 422                         ((f32)texture->getOriginalSize().Height) * mult);
 423
 424         // Don't draw the footer if there isn't enough room
 425         s32 free_space = (((s32)screensize.Height)-320)/2;
 426
 427         if (free_space > footersize.Y) {
 428                 core::rect<s32> rect(0,0,footersize.X,footersize.Y);
 429                 rect += v2s32(screensize.Width/2,screensize.Height-footersize.Y);
 430                 rect -= v2s32(footersize.X/2, 0);
 431
 432                 driver->draw2DImage(texture, rect,
 433                         core::rect<s32>(core::position2d<s32>(0,0),
 434                         core::dimension2di(texture->getSize())),
 435                         NULL, NULL, true);
 436         }
 437 }
 438
 439 /******************************************************************************/
 440 bool GUIEngine::setTexture(texture_layer layer,std::string texturepath) {
 441
 442         video::IVideoDriver* driver = m_device->getVideoDriver();
 443         assert(driver != 0);
 444
 445         if (m_textures[layer] != 0)
 446         {
 447                 driver->removeTexture(m_textures[layer]);
 448                 m_textures[layer] = 0;
 449         }
 450
 451         if ((texturepath == "") || !fs::PathExists(texturepath))
 452                 return false;
 453
 454         m_textures[layer] = driver->getTexture(texturepath.c_str());
 455
 456         if (m_textures[layer] == 0) return false;
 457
 458         return true;
 459 }
 460
 461 /******************************************************************************/
 462 #if USE_CURL
 463 static size_t WriteCallback(void *contents, size_t size, size_t nmemb, void *userp)
 464 {
 465         FILE* targetfile = (FILE*) userp;
 466         fwrite(contents,size,nmemb,targetfile);
 467         return size * nmemb;
 468 }
 469 #endif
 470 bool GUIEngine::downloadFile(std::string url,std::string target) {
 471 #if USE_CURL
 472         //download file via curl
 473         CURL *curl;
 474
 475         curl = curl_easy_init();
 476
 477         if (curl)
 478         {
 479                 CURLcode res;
 480                 bool retval = true;
 481
 482                 FILE* targetfile = fopen(target.c_str(),"wb");
 483
 484                 if (targetfile) {
 485                         curl_easy_setopt(curl, CURLOPT_NOSIGNAL, 1);
 486                         curl_easy_setopt(curl, CURLOPT_URL, url.c_str());
 487                         curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, WriteCallback);
 488                         curl_easy_setopt(curl, CURLOPT_WRITEDATA, targetfile);
 489
 490                         res = curl_easy_perform(curl);
 491                         if (res != CURLE_OK) {
 492                                 errorstream << "File at url \"" << url
 493                                         <<"\" not found (" << curl_easy_strerror(res) << ")" <<std::endl;
 494                                 retval = false;
 495                         }
 496                         fclose(targetfile);
 497                 }
 498                 else {
 499                         retval = false;
 500                 }
 501
 502                 curl_easy_cleanup(curl);
 503                 return retval;
 504         }
 505 #endif
 506         return false;
 507 }
 508
 509 /******************************************************************************/
 510 void GUIEngine::setTopleftText(std::string append) {
 511         std::string toset = "Minetest " VERSION_STRING;
 512
 513         if (append != "") {
 514                 toset += " / ";
 515                 toset += append;
 516         }
 517
 518         m_irr_toplefttext->setText(narrow_to_wide(toset).c_str());
 519 }
 520
 521 /******************************************************************************/
 522 s32 GUIEngine::playSound(SimpleSoundSpec spec, bool looped)
 523 {
 524         s32 handle = m_sound_manager->playSound(spec, looped);
 525         return handle;
 526 }
 527
 528 /******************************************************************************/
 529 void GUIEngine::stopSound(s32 handle)
 530 {
 531         m_sound_manager->stopSound(handle);
 532 }