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
 140         // Initialize scripting
 141
 142         infostream<<"GUIEngine: Initializing Lua"<<std::endl;
 143
 144         m_script = new MainMenuScripting(this);
 145
 146         try {
 147                 if (m_data->errormessage != "")
 148                 {
 149                         m_script->setMainMenuErrorMessage(m_data->errormessage);
 150                         m_data->errormessage = "";
 151                 }
 152
 153                 if (!loadMainMenuScript())
 154                         assert("no future without mainmenu" == 0);
 155
 156                 run();
 157         }
 158         catch(LuaError &e) {
 159                 errorstream << "MAINMENU ERROR: " << e.what() << std::endl;
 160                 m_data->errormessage = e.what();
 161         }
 162
 163         m_menu->quitMenu();
 164         m_menu->drop();
 165         m_menu = 0;
 166 }
 167
 168 /******************************************************************************/
 169 bool GUIEngine::loadMainMenuScript()
 170 {
 171         // Try custom menu script (main_menu_script)
 172
 173         std::string menuscript = g_settings->get("main_menu_script");
 174         if(menuscript != "") {
 175                 m_scriptdir = fs::RemoveLastPathComponent(menuscript);
 176
 177                 if(m_script->loadMod(menuscript, "__custommenu")) {
 178                         // custom menu script loaded
 179                         return true;
 180                 }
 181                 else {
 182                         infostream
 183                                 << "GUIEngine: execution of custom menu failed!"
 184                                 << std::endl
 185                                 << "\tfalling back to builtin menu"
 186                                 << std::endl;
 187                 }
 188         }
 189
 190         // Try builtin menu script (main_menu_script)
 191
 192         std::string builtin_menuscript =
 193                         porting::path_share + DIR_DELIM + "builtin"
 194                                 + DIR_DELIM + "mainmenu.lua";
 195
 196         m_scriptdir = fs::RemoveRelativePathComponents(
 197                         fs::RemoveLastPathComponent(builtin_menuscript));
 198
 199         if(m_script->loadMod(builtin_menuscript, "__builtinmenu")) {
 200                 // builtin menu script loaded
 201                 return true;
 202         }
 203         else {
 204                 errorstream
 205                         << "GUIEngine: unable to load builtin menu"
 206                         << std::endl;
 207         }
 208
 209         return false;
 210 }
 211
 212 /******************************************************************************/
 213 void GUIEngine::run()
 214 {
 215
 216         // Always create clouds because they may or may not be
 217         // needed based on the game selected
 218         video::IVideoDriver* driver = m_device->getVideoDriver();
 219
 220         cloudInit();
 221
 222         while(m_device->run() && (!m_startgame)) {
 223                 driver->beginScene(true, true, video::SColor(255,140,186,250));
 224
 225                 if (m_clouds_enabled)
 226                 {
 227                         cloudPreProcess();
 228                         drawOverlay(driver);
 229                 }
 230                 else
 231                         drawBackground(driver);
 232
 233                 drawHeader(driver);
 234                 drawFooter(driver);
 235
 236                 m_device->getGUIEnvironment()->drawAll();
 237
 238                 driver->endScene();
 239
 240                 if (m_clouds_enabled)
 241                         cloudPostProcess();
 242                 else
 243                         sleep_ms(25);
 244         }
 245 }
 246
 247 /******************************************************************************/
 248 GUIEngine::~GUIEngine()
 249 {
 250         video::IVideoDriver* driver = m_device->getVideoDriver();
 251         assert(driver != 0);
 252
 253         if(m_sound_manager != &dummySoundManager){
 254                 delete m_sound_manager;
 255                 m_sound_manager = NULL;
 256         }
 257
 258         //TODO: clean up m_menu here
 259
 260         infostream<<"GUIEngine: Deinitializing scripting"<<std::endl;
 261         delete m_script;
 262
 263         m_irr_toplefttext->setText(L"");
 264
 265         //initialize texture pointers
 266         for (unsigned int i = 0; i < TEX_LAYER_MAX; i++) {
 267                 if (m_textures[i] != 0)
 268                         driver->removeTexture(m_textures[i]);
 269         }
 270
 271         if (m_cloud.clouds)
 272                 m_cloud.clouds->drop();
 273 }
 274
 275 /******************************************************************************/
 276 void GUIEngine::cloudInit()
 277 {
 278         m_cloud.clouds = new Clouds(m_smgr->getRootSceneNode(),
 279                         m_smgr, -1, rand(), 100);
 280         m_cloud.clouds->update(v2f(0, 0), video::SColor(255,200,200,255));
 281
 282         m_cloud.camera = m_smgr->addCameraSceneNode(0,
 283                                 v3f(0,0,0), v3f(0, 60, 100));
 284         m_cloud.camera->setFarValue(10000);
 285
 286         m_cloud.lasttime = m_device->getTimer()->getTime();
 287 }
 288
 289 /******************************************************************************/
 290 void GUIEngine::cloudPreProcess()
 291 {
 292         u32 time = m_device->getTimer()->getTime();
 293
 294         if(time > m_cloud.lasttime)
 295                 m_cloud.dtime = (time - m_cloud.lasttime) / 1000.0;
 296         else
 297                 m_cloud.dtime = 0;
 298
 299         m_cloud.lasttime = time;
 300
 301         m_cloud.clouds->step(m_cloud.dtime*3);
 302         m_cloud.clouds->render();
 303         m_smgr->drawAll();
 304 }
 305
 306 /******************************************************************************/
 307 void GUIEngine::cloudPostProcess()
 308 {
 309         float fps_max = g_settings->getFloat("fps_max");
 310         // Time of frame without fps limit
 311         float busytime;
 312         u32 busytime_u32;
 313         // not using getRealTime is necessary for wine
 314         u32 time = m_device->getTimer()->getTime();
 315         if(time > m_cloud.lasttime)
 316                 busytime_u32 = time - m_cloud.lasttime;
 317         else
 318                 busytime_u32 = 0;
 319         busytime = busytime_u32 / 1000.0;
 320
 321         // FPS limiter
 322         u32 frametime_min = 1000./fps_max;
 323
 324         if(busytime_u32 < frametime_min) {
 325                 u32 sleeptime = frametime_min - busytime_u32;
 326                 m_device->sleep(sleeptime);
 327         }
 328 }
 329
 330 /******************************************************************************/
 331 void GUIEngine::drawBackground(video::IVideoDriver* driver)
 332 {
 333         v2u32 screensize = driver->getScreenSize();
 334
 335         video::ITexture* texture = m_textures[TEX_LAYER_BACKGROUND];
 336
 337         /* If no texture, draw background of solid color */
 338         if(!texture){
 339                 video::SColor color(255,80,58,37);
 340                 core::rect<s32> rect(0, 0, screensize.X, screensize.Y);
 341                 driver->draw2DRectangle(color, rect, NULL);
 342                 return;
 343         }
 344
 345         /* Draw background texture */
 346         v2u32 sourcesize = texture->getSize();
 347         driver->draw2DImage(texture,
 348                 core::rect<s32>(0, 0, screensize.X, screensize.Y),
 349                 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
 350                 NULL, NULL, true);
 351 }
 352
 353 /******************************************************************************/
 354 void GUIEngine::drawOverlay(video::IVideoDriver* driver)
 355 {
 356         v2u32 screensize = driver->getScreenSize();
 357
 358         video::ITexture* texture = m_textures[TEX_LAYER_OVERLAY];
 359
 360         /* If no texture, draw background of solid color */
 361         if(!texture)
 362                 return;
 363
 364         /* Draw background texture */
 365         v2u32 sourcesize = texture->getSize();
 366         driver->draw2DImage(texture,
 367                 core::rect<s32>(0, 0, screensize.X, screensize.Y),
 368                 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
 369                 NULL, NULL, true);
 370 }
 371
 372 /******************************************************************************/
 373 void GUIEngine::drawHeader(video::IVideoDriver* driver)
 374 {
 375         core::dimension2d<u32> screensize = driver->getScreenSize();
 376
 377         video::ITexture* texture = m_textures[TEX_LAYER_HEADER];
 378
 379         /* If no texture, draw nothing */
 380         if(!texture)
 381                 return;
 382
 383         f32 mult = (((f32)screensize.Width / 2)) /
 384                         ((f32)texture->getOriginalSize().Width);
 385
 386         v2s32 splashsize(((f32)texture->getOriginalSize().Width) * mult,
 387                         ((f32)texture->getOriginalSize().Height) * mult);
 388
 389         // Don't draw the header is there isn't enough room
 390         s32 free_space = (((s32)screensize.Height)-320)/2;
 391
 392         if (free_space > splashsize.Y) {
 393                 core::rect<s32> splashrect(0, 0, splashsize.X, splashsize.Y);
 394                 splashrect += v2s32((screensize.Width/2)-(splashsize.X/2),
 395                                 ((free_space/2)-splashsize.Y/2)+10);
 396
 397         video::SColor bgcolor(255,50,50,50);
 398
 399         driver->draw2DImage(texture, splashrect,
 400                 core::rect<s32>(core::position2d<s32>(0,0),
 401                 core::dimension2di(texture->getSize())),
 402                 NULL, NULL, true);
 403         }
 404 }
 405
 406 /******************************************************************************/
 407 void GUIEngine::drawFooter(video::IVideoDriver* driver)
 408 {
 409         core::dimension2d<u32> screensize = driver->getScreenSize();
 410
 411         video::ITexture* texture = m_textures[TEX_LAYER_FOOTER];
 412
 413         /* If no texture, draw nothing */
 414         if(!texture)
 415                 return;
 416
 417         f32 mult = (((f32)screensize.Width)) /
 418                         ((f32)texture->getOriginalSize().Width);
 419
 420         v2s32 footersize(((f32)texture->getOriginalSize().Width) * mult,
 421                         ((f32)texture->getOriginalSize().Height) * mult);
 422
 423         // Don't draw the footer if there isn't enough room
 424         s32 free_space = (((s32)screensize.Height)-320)/2;
 425
 426         if (free_space > footersize.Y) {
 427                 core::rect<s32> rect(0,0,footersize.X,footersize.Y);
 428                 rect += v2s32(screensize.Width/2,screensize.Height-footersize.Y);
 429                 rect -= v2s32(footersize.X/2, 0);
 430
 431                 driver->draw2DImage(texture, rect,
 432                         core::rect<s32>(core::position2d<s32>(0,0),
 433                         core::dimension2di(texture->getSize())),
 434                         NULL, NULL, true);
 435         }
 436 }
 437
 438 /******************************************************************************/
 439 bool GUIEngine::setTexture(texture_layer layer,std::string texturepath) {
 440
 441         video::IVideoDriver* driver = m_device->getVideoDriver();
 442         assert(driver != 0);
 443
 444         if (m_textures[layer] != 0)
 445         {
 446                 driver->removeTexture(m_textures[layer]);
 447                 m_textures[layer] = 0;
 448         }
 449
 450         if ((texturepath == "") || !fs::PathExists(texturepath))
 451                 return false;
 452
 453         m_textures[layer] = driver->getTexture(texturepath.c_str());
 454
 455         if (m_textures[layer] == 0) return false;
 456
 457         return true;
 458 }
 459
 460 /******************************************************************************/
 461 #if USE_CURL
 462 static size_t WriteCallback(void *contents, size_t size, size_t nmemb, void *userp)
 463 {
 464         FILE* targetfile = (FILE*) userp;
 465         fwrite(contents,size,nmemb,targetfile);
 466         return size * nmemb;
 467 }
 468 #endif
 469 bool GUIEngine::downloadFile(std::string url,std::string target) {
 470 #if USE_CURL
 471         //download file via curl
 472         CURL *curl;
 473
 474         curl = curl_easy_init();
 475
 476         if (curl)
 477         {
 478                 CURLcode res;
 479                 bool retval = true;
 480
 481                 FILE* targetfile = fopen(target.c_str(),"wb");
 482
 483                 if (targetfile) {
 484                         curl_easy_setopt(curl, CURLOPT_NOSIGNAL, 1);
 485                         curl_easy_setopt(curl, CURLOPT_URL, url.c_str());
 486                         curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, WriteCallback);
 487                         curl_easy_setopt(curl, CURLOPT_WRITEDATA, targetfile);
 488
 489                         res = curl_easy_perform(curl);
 490                         if (res != CURLE_OK) {
 491                                 errorstream << "File at url \"" << url
 492                                         <<"\" not found (" << curl_easy_strerror(res) << ")" <<std::endl;
 493                                 retval = false;
 494                         }
 495                         fclose(targetfile);
 496                 }
 497                 else {
 498                         retval = false;
 499                 }
 500
 501                 curl_easy_cleanup(curl);
 502                 return retval;
 503         }
 504 #endif
 505         return false;
 506 }
 507
 508 /******************************************************************************/
 509 void GUIEngine::setTopleftText(std::string append) {
 510         std::string toset = "Minetest " VERSION_STRING;
 511
 512         if (append != "") {
 513                 toset += " / ";
 514                 toset += append;
 515         }
 516
 517         m_irr_toplefttext->setText(narrow_to_wide(toset).c_str());
 518 }
 519
 520 /******************************************************************************/
 521 s32 GUIEngine::playSound(SimpleSoundSpec spec, bool looped)
 522 {
 523         s32 handle = m_sound_manager->playSound(spec, looped);
 524         return handle;
 525 }
 526
 527 /******************************************************************************/
 528 void GUIEngine::stopSound(s32 handle)
 529 {
 530         m_sound_manager->stopSound(handle);
 531 }