]> git.lizzy.rs Git - minetest.git/blob - src/client/clientlauncher.cpp
Fix texture tear issue
[minetest.git] / src / client / clientlauncher.cpp
1 /*
2 Minetest
3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
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 "mainmenumanager.h"
21 #include "debug.h"
22 #include "clouds.h"
23 #include "server.h"
24 #include "filesys.h"
25 #include "guiMainMenu.h"
26 #include "game.h"
27 #include "chat.h"
28 #include "gettext.h"
29 #include "profiler.h"
30 #include "log.h"
31 #include "serverlist.h"
32 #include "guiEngine.h"
33 #include "player.h"
34 #include "fontengine.h"
35 #include "clientlauncher.h"
36
37 /* mainmenumanager.h
38  */
39 gui::IGUIEnvironment *guienv = NULL;
40 gui::IGUIStaticText *guiroot = NULL;
41 MainMenuManager g_menumgr;
42
43 bool noMenuActive()
44 {
45         return g_menumgr.menuCount() == 0;
46 }
47
48 // Passed to menus to allow disconnecting and exiting
49 MainGameCallback *g_gamecallback = NULL;
50
51
52 // Instance of the time getter
53 static TimeGetter *g_timegetter = NULL;
54
55 u32 getTimeMs()
56 {
57         if (g_timegetter == NULL)
58                 return 0;
59         return g_timegetter->getTime(PRECISION_MILLI);
60 }
61
62 u32 getTime(TimePrecision prec) {
63         if (g_timegetter == NULL)
64                 return 0;
65         return g_timegetter->getTime(prec);
66 }
67
68 ClientLauncher::~ClientLauncher()
69 {
70         if (receiver)
71                 delete receiver;
72
73         if (input)
74                 delete input;
75
76         if (g_fontengine)
77                 delete g_fontengine;
78
79         if (device)
80                 device->drop();
81 }
82
83
84 bool ClientLauncher::run(GameParams &game_params, const Settings &cmd_args)
85 {
86         init_args(game_params, cmd_args);
87
88         // List video modes if requested
89         if (list_video_modes)
90                 return print_video_modes();
91
92         if (!init_engine()) {
93                 errorstream << "Could not initialize game engine." << std::endl;
94                 return false;
95         }
96
97         // Create time getter
98         g_timegetter = new IrrlichtTimeGetter(device);
99
100         // Speed tests (done after irrlicht is loaded to get timer)
101         if (cmd_args.getFlag("speedtests")) {
102                 dstream << "Running speed tests" << std::endl;
103                 speed_tests();
104                 return true;
105         }
106
107         video::IVideoDriver *video_driver = device->getVideoDriver();
108         if (video_driver == NULL) {
109                 errorstream << "Could not initialize video driver." << std::endl;
110                 return false;
111         }
112
113         porting::setXorgClassHint(video_driver->getExposedVideoData(), PROJECT_NAME_C);
114
115         /*
116                 This changes the minimum allowed number of vertices in a VBO.
117                 Default is 500.
118         */
119         //driver->setMinHardwareBufferVertexCount(50);
120
121         // Create game callback for menus
122         g_gamecallback = new MainGameCallback(device);
123
124         device->setResizable(true);
125
126         if (random_input)
127                 input = new RandomInputHandler();
128         else
129                 input = new RealInputHandler(device, receiver);
130
131         smgr = device->getSceneManager();
132         smgr->getParameters()->setAttribute(scene::ALLOW_ZWRITE_ON_TRANSPARENT, true);
133
134         guienv = device->getGUIEnvironment();
135         skin = guienv->getSkin();
136         skin->setColor(gui::EGDC_BUTTON_TEXT, video::SColor(255, 255, 255, 255));
137         skin->setColor(gui::EGDC_3D_LIGHT, video::SColor(0, 0, 0, 0));
138         skin->setColor(gui::EGDC_3D_HIGH_LIGHT, video::SColor(255, 30, 30, 30));
139         skin->setColor(gui::EGDC_3D_SHADOW, video::SColor(255, 0, 0, 0));
140         skin->setColor(gui::EGDC_HIGH_LIGHT, video::SColor(255, 70, 120, 50));
141         skin->setColor(gui::EGDC_HIGH_LIGHT_TEXT, video::SColor(255, 255, 255, 255));
142
143         g_fontengine = new FontEngine(g_settings, guienv);
144         FATAL_ERROR_IF(g_fontengine == NULL, "Font engine creation failed.");
145
146 #if (IRRLICHT_VERSION_MAJOR >= 1 && IRRLICHT_VERSION_MINOR >= 8) || IRRLICHT_VERSION_MAJOR >= 2
147         // Irrlicht 1.8 input colours
148         skin->setColor(gui::EGDC_EDITABLE, video::SColor(255, 128, 128, 128));
149         skin->setColor(gui::EGDC_FOCUSED_EDITABLE, video::SColor(255, 96, 134, 49));
150 #endif
151
152         // Create the menu clouds
153         if (!g_menucloudsmgr)
154                 g_menucloudsmgr = smgr->createNewSceneManager();
155         if (!g_menuclouds)
156                 g_menuclouds = new Clouds(g_menucloudsmgr->getRootSceneNode(),
157                                 g_menucloudsmgr, -1, rand(), 100);
158         g_menuclouds->update(v2f(0, 0), video::SColor(255, 200, 200, 255));
159         scene::ICameraSceneNode* camera;
160         camera = g_menucloudsmgr->addCameraSceneNode(0,
161                                 v3f(0, 0, 0), v3f(0, 60, 100));
162         camera->setFarValue(10000);
163
164         /*
165                 GUI stuff
166         */
167
168         ChatBackend chat_backend;
169
170         // If an error occurs, this is set to something by menu().
171         // It is then displayed before the menu shows on the next call to menu()
172         std::string error_message;
173         bool reconnect_requested = false;
174
175         bool first_loop = true;
176
177         /*
178                 Menu-game loop
179         */
180         bool retval = true;
181         bool *kill = porting::signal_handler_killstatus();
182
183         while (device->run() && !*kill && !g_gamecallback->shutdown_requested)
184         {
185                 // Set the window caption
186                 const wchar_t *text = wgettext("Main Menu");
187                 device->setWindowCaption((utf8_to_wide(PROJECT_NAME_C) + L" [" + text + L"]").c_str());
188                 delete[] text;
189
190                 try {   // This is used for catching disconnects
191
192                         guienv->clear();
193
194                         /*
195                                 We need some kind of a root node to be able to add
196                                 custom gui elements directly on the screen.
197                                 Otherwise they won't be automatically drawn.
198                         */
199                         guiroot = guienv->addStaticText(L"", core::rect<s32>(0, 0, 10000, 10000));
200
201                         bool game_has_run = launch_game(error_message, reconnect_requested,
202                                 game_params, cmd_args);
203
204                         // If skip_main_menu, we only want to startup once
205                         if (skip_main_menu && !first_loop)
206                                 break;
207
208                         first_loop = false;
209
210                         if (!game_has_run) {
211                                 if (skip_main_menu)
212                                         break;
213                                 else
214                                         continue;
215                         }
216
217                         // Break out of menu-game loop to shut down cleanly
218                         if (!device->run() || *kill) {
219                                 if (g_settings_path != "")
220                                         g_settings->updateConfigFile(g_settings_path.c_str());
221                                 break;
222                         }
223
224                         if (current_playername.length() > PLAYERNAME_SIZE-1) {
225                                 error_message = gettext("Player name too long.");
226                                 playername = current_playername.substr(0, PLAYERNAME_SIZE-1);
227                                 g_settings->set("name", playername);
228                                 continue;
229                         }
230
231                         device->getVideoDriver()->setTextureCreationFlag(
232                                         video::ETCF_CREATE_MIP_MAPS, g_settings->getBool("mip_map"));
233
234 #ifdef HAVE_TOUCHSCREENGUI
235                         receiver->m_touchscreengui = new TouchScreenGUI(device, receiver);
236                         g_touchscreengui = receiver->m_touchscreengui;
237 #endif
238
239                         the_game(
240                                 kill,
241                                 random_input,
242                                 input,
243                                 device,
244                                 worldspec.path,
245                                 current_playername,
246                                 current_password,
247                                 current_address,
248                                 current_port,
249                                 error_message,
250                                 chat_backend,
251                                 &reconnect_requested,
252                                 gamespec,
253                                 simple_singleplayer_mode
254                         );
255                         smgr->clear();
256
257 #ifdef HAVE_TOUCHSCREENGUI
258                         delete g_touchscreengui;
259                         g_touchscreengui = NULL;
260                         receiver->m_touchscreengui = NULL;
261 #endif
262
263                 } //try
264                 catch (con::PeerNotFoundException &e) {
265                         error_message = gettext("Connection error (timed out?)");
266                         errorstream << error_message << std::endl;
267                 }
268
269 #ifdef NDEBUG
270                 catch (std::exception &e) {
271                         std::string error_message = "Some exception: \"";
272                         error_message += e.what();
273                         error_message += "\"";
274                         errorstream << error_message << std::endl;
275                 }
276 #endif
277
278                 // If no main menu, show error and exit
279                 if (skip_main_menu) {
280                         if (!error_message.empty()) {
281                                 verbosestream << "error_message = "
282                                               << error_message << std::endl;
283                                 retval = false;
284                         }
285                         break;
286                 }
287         } // Menu-game loop
288
289         g_menuclouds->drop();
290         g_menucloudsmgr->drop();
291
292         return retval;
293 }
294
295 void ClientLauncher::init_args(GameParams &game_params, const Settings &cmd_args)
296 {
297
298         skip_main_menu = cmd_args.getFlag("go");
299
300         // FIXME: This is confusing (but correct)
301
302         /* If world_path is set then override it unless skipping the main menu using
303          * the --go command line param. Else, give preference to the address
304          * supplied on the command line
305          */
306         address = g_settings->get("address");
307         if (game_params.world_path != "" && !skip_main_menu)
308                 address = "";
309         else if (cmd_args.exists("address"))
310                 address = cmd_args.get("address");
311
312         playername = g_settings->get("name");
313         if (cmd_args.exists("name"))
314                 playername = cmd_args.get("name");
315
316         list_video_modes = cmd_args.getFlag("videomodes");
317
318         use_freetype = g_settings->getBool("freetype");
319
320         random_input = g_settings->getBool("random_input")
321                         || cmd_args.getFlag("random-input");
322 }
323
324 bool ClientLauncher::init_engine()
325 {
326         receiver = new MyEventReceiver();
327         create_engine_device();
328         return device != NULL;
329 }
330
331 bool ClientLauncher::launch_game(std::string &error_message,
332                 bool reconnect_requested, GameParams &game_params,
333                 const Settings &cmd_args)
334 {
335         // Initialize menu data
336         MainMenuData menudata;
337         menudata.address                         = address;
338         menudata.name                            = playername;
339         menudata.port                            = itos(game_params.socket_port);
340         menudata.script_data.errormessage        = error_message;
341         menudata.script_data.reconnect_requested = reconnect_requested;
342
343         error_message.clear();
344
345         if (cmd_args.exists("password"))
346                 menudata.password = cmd_args.get("password");
347
348         menudata.enable_public = g_settings->getBool("server_announce");
349
350         // If a world was commanded, append and select it
351         if (game_params.world_path != "") {
352                 worldspec.gameid = getWorldGameId(game_params.world_path, true);
353                 worldspec.name = _("[--world parameter]");
354
355                 if (worldspec.gameid == "") {   // Create new
356                         worldspec.gameid = g_settings->get("default_game");
357                         worldspec.name += " [new]";
358                 }
359                 worldspec.path = game_params.world_path;
360         }
361
362         /* Show the GUI menu
363          */
364         if (!skip_main_menu) {
365                 main_menu(&menudata);
366
367                 // Skip further loading if there was an exit signal.
368                 if (*porting::signal_handler_killstatus())
369                         return false;
370
371                 address = menudata.address;
372                 int newport = stoi(menudata.port);
373                 if (newport != 0)
374                         game_params.socket_port = newport;
375
376                 simple_singleplayer_mode = menudata.simple_singleplayer_mode;
377
378                 std::vector<WorldSpec> worldspecs = getAvailableWorlds();
379
380                 if (menudata.selected_world >= 0
381                                 && menudata.selected_world < (int)worldspecs.size()) {
382                         g_settings->set("selected_world_path",
383                                         worldspecs[menudata.selected_world].path);
384                         worldspec = worldspecs[menudata.selected_world];
385                 }
386         }
387
388         if (!menudata.script_data.errormessage.empty()) {
389                 /* The calling function will pass this back into this function upon the
390                  * next iteration (if any) causing it to be displayed by the GUI
391                  */
392                 error_message = menudata.script_data.errormessage;
393                 return false;
394         }
395
396         if (menudata.name == "")
397                 menudata.name = std::string("Guest") + itos(myrand_range(1000, 9999));
398         else
399                 playername = menudata.name;
400
401         password = menudata.password;
402
403         g_settings->set("name", playername);
404
405         current_playername = playername;
406         current_password   = password;
407         current_address    = address;
408         current_port       = game_params.socket_port;
409
410         // If using simple singleplayer mode, override
411         if (simple_singleplayer_mode) {
412                 assert(skip_main_menu == false);
413                 current_playername = "singleplayer";
414                 current_password = "";
415                 current_address = "";
416                 current_port = myrand_range(49152, 65535);
417         } else if (address != "") {
418                 ServerListSpec server;
419                 server["name"] = menudata.servername;
420                 server["address"] = menudata.address;
421                 server["port"] = menudata.port;
422                 server["description"] = menudata.serverdescription;
423                 ServerList::insert(server);
424         }
425
426         infostream << "Selected world: " << worldspec.name
427                    << " [" << worldspec.path << "]" << std::endl;
428
429         if (current_address == "") { // If local game
430                 if (worldspec.path == "") {
431                         error_message = gettext("No world selected and no address "
432                                         "provided. Nothing to do.");
433                         errorstream << error_message << std::endl;
434                         return false;
435                 }
436
437                 if (!fs::PathExists(worldspec.path)) {
438                         error_message = gettext("Provided world path doesn't exist: ")
439                                         + worldspec.path;
440                         errorstream << error_message << std::endl;
441                         return false;
442                 }
443
444                 // Load gamespec for required game
445                 gamespec = findWorldSubgame(worldspec.path);
446                 if (!gamespec.isValid() && !game_params.game_spec.isValid()) {
447                         error_message = gettext("Could not find or load game \"")
448                                         + worldspec.gameid + "\"";
449                         errorstream << error_message << std::endl;
450                         return false;
451                 }
452
453                 if (porting::signal_handler_killstatus())
454                         return true;
455
456                 if (game_params.game_spec.isValid() &&
457                                 game_params.game_spec.id != worldspec.gameid) {
458                         warningstream << "Overriding gamespec from \""
459                                     << worldspec.gameid << "\" to \""
460                                     << game_params.game_spec.id << "\"" << std::endl;
461                         gamespec = game_params.game_spec;
462                 }
463
464                 if (!gamespec.isValid()) {
465                         error_message = gettext("Invalid gamespec.");
466                         error_message += " (world.gameid=" + worldspec.gameid + ")";
467                         errorstream << error_message << std::endl;
468                         return false;
469                 }
470         }
471
472         return true;
473 }
474
475 void ClientLauncher::main_menu(MainMenuData *menudata)
476 {
477         bool *kill = porting::signal_handler_killstatus();
478         video::IVideoDriver *driver = device->getVideoDriver();
479
480         infostream << "Waiting for other menus" << std::endl;
481         while (device->run() && *kill == false) {
482                 if (noMenuActive())
483                         break;
484                 driver->beginScene(true, true, video::SColor(255, 128, 128, 128));
485                 guienv->drawAll();
486                 driver->endScene();
487                 // On some computers framerate doesn't seem to be automatically limited
488                 sleep_ms(25);
489         }
490         infostream << "Waited for other menus" << std::endl;
491
492         // Cursor can be non-visible when coming from the game
493 #ifndef ANDROID
494         device->getCursorControl()->setVisible(true);
495 #endif
496
497         /* show main menu */
498         GUIEngine mymenu(device, guiroot, &g_menumgr, smgr, menudata, *kill);
499
500         smgr->clear();  /* leave scene manager in a clean state */
501 }
502
503 bool ClientLauncher::create_engine_device()
504 {
505         // Resolution selection
506         bool fullscreen = g_settings->getBool("fullscreen");
507         u16 screenW = g_settings->getU16("screenW");
508         u16 screenH = g_settings->getU16("screenH");
509
510         // bpp, fsaa, vsync
511         bool vsync = g_settings->getBool("vsync");
512         u16 bits = g_settings->getU16("fullscreen_bpp");
513         u16 fsaa = g_settings->getU16("fsaa");
514
515         // stereo buffer required for pageflip stereo
516         bool stereo_buffer = g_settings->get("3d_mode") == "pageflip";
517
518         // Determine driver
519         video::E_DRIVER_TYPE driverType = video::EDT_OPENGL;
520         std::string driverstring = g_settings->get("video_driver");
521         std::vector<video::E_DRIVER_TYPE> drivers
522                 = porting::getSupportedVideoDrivers();
523         u32 i;
524         for (i = 0; i != drivers.size(); i++) {
525                 if (!strcasecmp(driverstring.c_str(),
526                         porting::getVideoDriverName(drivers[i]))) {
527                         driverType = drivers[i];
528                         break;
529                 }
530         }
531         if (i == drivers.size()) {
532                 errorstream << "Invalid video_driver specified; "
533                         "defaulting to opengl" << std::endl;
534         }
535
536         SIrrlichtCreationParameters params = SIrrlichtCreationParameters();
537         params.DriverType    = driverType;
538         params.WindowSize    = core::dimension2d<u32>(screenW, screenH);
539         params.Bits          = bits;
540         params.AntiAlias     = fsaa;
541         params.Fullscreen    = fullscreen;
542         params.Stencilbuffer = false;
543         params.Stereobuffer  = stereo_buffer;
544         params.Vsync         = vsync;
545         params.EventReceiver = receiver;
546         params.HighPrecisionFPU = g_settings->getBool("high_precision_fpu");
547         params.ZBufferBits   = 24;
548 #ifdef __ANDROID__
549         params.PrivateData = porting::app_global;
550         params.OGLES2ShaderPath = std::string(porting::path_user + DIR_DELIM +
551                         "media" + DIR_DELIM + "Shaders" + DIR_DELIM).c_str();
552 #endif
553
554         device = createDeviceEx(params);
555
556         if (device) {
557                 porting::initIrrlicht(device);
558         }
559
560         return device != NULL;
561 }
562
563 void ClientLauncher::speed_tests()
564 {
565         // volatile to avoid some potential compiler optimisations
566         volatile static s16 temp16;
567         volatile static f32 tempf;
568         static v3f tempv3f1;
569         static v3f tempv3f2;
570         static std::string tempstring;
571         static std::string tempstring2;
572
573         tempv3f1 = v3f();
574         tempv3f2 = v3f();
575         tempstring = std::string();
576         tempstring2 = std::string();
577
578         {
579                 infostream << "The following test should take around 20ms." << std::endl;
580                 TimeTaker timer("Testing std::string speed");
581                 const u32 jj = 10000;
582                 for (u32 j = 0; j < jj; j++) {
583                         tempstring = "";
584                         tempstring2 = "";
585                         const u32 ii = 10;
586                         for (u32 i = 0; i < ii; i++) {
587                                 tempstring2 += "asd";
588                         }
589                         for (u32 i = 0; i < ii+1; i++) {
590                                 tempstring += "asd";
591                                 if (tempstring == tempstring2)
592                                         break;
593                         }
594                 }
595         }
596
597         infostream << "All of the following tests should take around 100ms each."
598                    << std::endl;
599
600         {
601                 TimeTaker timer("Testing floating-point conversion speed");
602                 tempf = 0.001;
603                 for (u32 i = 0; i < 4000000; i++) {
604                         temp16 += tempf;
605                         tempf += 0.001;
606                 }
607         }
608
609         {
610                 TimeTaker timer("Testing floating-point vector speed");
611
612                 tempv3f1 = v3f(1, 2, 3);
613                 tempv3f2 = v3f(4, 5, 6);
614                 for (u32 i = 0; i < 10000000; i++) {
615                         tempf += tempv3f1.dotProduct(tempv3f2);
616                         tempv3f2 += v3f(7, 8, 9);
617                 }
618         }
619
620         {
621                 TimeTaker timer("Testing std::map speed");
622
623                 std::map<v2s16, f32> map1;
624                 tempf = -324;
625                 const s16 ii = 300;
626                 for (s16 y = 0; y < ii; y++) {
627                         for (s16 x = 0; x < ii; x++) {
628                                 map1[v2s16(x, y)] =  tempf;
629                                 tempf += 1;
630                         }
631                 }
632                 for (s16 y = ii - 1; y >= 0; y--) {
633                         for (s16 x = 0; x < ii; x++) {
634                                 tempf = map1[v2s16(x, y)];
635                         }
636                 }
637         }
638
639         {
640                 infostream << "Around 5000/ms should do well here." << std::endl;
641                 TimeTaker timer("Testing mutex speed");
642
643                 Mutex m;
644                 u32 n = 0;
645                 u32 i = 0;
646                 do {
647                         n += 10000;
648                         for (; i < n; i++) {
649                                 m.lock();
650                                 m.unlock();
651                         }
652                 }
653                 // Do at least 10ms
654                 while(timer.getTimerTime() < 10);
655
656                 u32 dtime = timer.stop();
657                 u32 per_ms = n / dtime;
658                 infostream << "Done. " << dtime << "ms, " << per_ms << "/ms" << std::endl;
659         }
660 }
661
662 bool ClientLauncher::print_video_modes()
663 {
664         IrrlichtDevice *nulldevice;
665
666         bool vsync = g_settings->getBool("vsync");
667         u16 fsaa = g_settings->getU16("fsaa");
668         MyEventReceiver* receiver = new MyEventReceiver();
669
670         SIrrlichtCreationParameters params = SIrrlichtCreationParameters();
671         params.DriverType    = video::EDT_NULL;
672         params.WindowSize    = core::dimension2d<u32>(640, 480);
673         params.Bits          = 24;
674         params.AntiAlias     = fsaa;
675         params.Fullscreen    = false;
676         params.Stencilbuffer = false;
677         params.Vsync         = vsync;
678         params.EventReceiver = receiver;
679         params.HighPrecisionFPU = g_settings->getBool("high_precision_fpu");
680
681         nulldevice = createDeviceEx(params);
682
683         if (nulldevice == NULL) {
684                 delete receiver;
685                 return false;
686         }
687
688         std::cout << _("Available video modes (WxHxD):") << std::endl;
689
690         video::IVideoModeList *videomode_list = nulldevice->getVideoModeList();
691
692         if (videomode_list != NULL) {
693                 s32 videomode_count = videomode_list->getVideoModeCount();
694                 core::dimension2d<u32> videomode_res;
695                 s32 videomode_depth;
696                 for (s32 i = 0; i < videomode_count; ++i) {
697                         videomode_res = videomode_list->getVideoModeResolution(i);
698                         videomode_depth = videomode_list->getVideoModeDepth(i);
699                         std::cout << videomode_res.Width << "x" << videomode_res.Height
700                                 << "x" << videomode_depth << std::endl;
701                 }
702
703                 std::cout << _("Active video mode (WxHxD):") << std::endl;
704                 videomode_res = videomode_list->getDesktopResolution();
705                 videomode_depth = videomode_list->getDesktopDepth();
706                 std::cout << videomode_res.Width << "x" << videomode_res.Height
707                         << "x" << videomode_depth << std::endl;
708
709         }
710
711         nulldevice->drop();
712         delete receiver;
713
714         return videomode_list != NULL;
715 }