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