Merge branch 'master' into blender2.8
[blender.git] / source / creator / creator.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file creator/creator.c
29  *  \ingroup creator
30  */
31
32 #include <stdlib.h>
33 #include <string.h>
34
35 #ifdef WIN32
36 #  if defined(_MSC_VER) && defined(_M_X64)
37 #    include <math.h> /* needed for _set_FMA3_enable */
38 #  endif
39 #  include <windows.h>
40 #  include "utfconv.h"
41 #endif
42
43 #include "MEM_guardedalloc.h"
44
45 #include "CLG_log.h"
46
47 #include "DNA_genfile.h"
48
49 #include "BLI_args.h"
50 #include "BLI_threads.h"
51 #include "BLI_utildefines.h"
52 #include "BLI_callbacks.h"
53 #include "BLI_string.h"
54 #include "BLI_system.h"
55 #include "BLI_threads.h"
56
57 /* mostly init functions */
58 #include "BKE_appdir.h"
59 #include "BKE_blender.h"
60 #include "BKE_brush.h"
61 #include "BKE_cachefile.h"
62 #include "BKE_context.h"
63 #include "BKE_font.h"
64 #include "BKE_global.h"
65 #include "BKE_material.h"
66 #include "BKE_modifier.h"
67 #include "BKE_gpencil_modifier.h"
68 #include "BKE_node.h"
69 #include "BKE_shader_fx.h"
70 #include "BKE_sound.h"
71 #include "BKE_image.h"
72 #include "BKE_particle.h"
73
74 #include "DEG_depsgraph.h"
75
76 #include "IMB_imbuf.h"  /* for IMB_init */
77
78 #include "RE_engine.h"
79 #include "RE_render_ext.h"
80
81 #include "ED_datafiles.h"
82
83 #include "WM_api.h"
84 #include "WM_toolsystem.h"
85
86 #include "RNA_define.h"
87
88 #ifdef WITH_FREESTYLE
89 #  include "FRS_freestyle.h"
90 #endif
91
92 #include <signal.h>
93
94 #ifdef __FreeBSD__
95 #  include <floatingpoint.h>
96 #endif
97
98 #ifdef WITH_BINRELOC
99 #  include "binreloc.h"
100 #endif
101
102 #ifdef WITH_LIBMV
103 #  include "libmv-capi.h"
104 #endif
105
106 #ifdef WITH_CYCLES_LOGGING
107 #  include "CCL_api.h"
108 #endif
109
110 #ifdef WITH_SDL_DYNLOAD
111 #  include "sdlew.h"
112 #endif
113
114 #include "creator_intern.h"  /* own include */
115
116
117 /*      Local Function prototypes */
118 #ifdef WITH_PYTHON_MODULE
119 int  main_python_enter(int argc, const char **argv);
120 void main_python_exit(void);
121 #endif
122
123 /* written to by 'creator_args.c' */
124 struct ApplicationState app_state = {
125         .signal = {
126                 .use_crash_handler = true,
127                 .use_abort_handler = true,
128         },
129         .exit_code_on_error = {
130                 .python = 0,
131         }
132 };
133
134 /* -------------------------------------------------------------------- */
135
136 /** \name Application Level Callbacks
137  *
138  * Initialize callbacks for the modules that need them.
139  *
140  * \{ */
141
142 static void callback_mem_error(const char *errorStr)
143 {
144         fputs(errorStr, stderr);
145         fflush(stderr);
146 }
147
148 static void main_callback_setup(void)
149 {
150         /* Error output from the alloc routines: */
151         MEM_set_error_callback(callback_mem_error);
152 }
153
154 /* free data on early exit (if Python calls 'sys.exit()' while parsing args for eg). */
155 struct CreatorAtExitData {
156         bArgs *ba;
157 #ifdef WIN32
158         const char **argv;
159         int argv_num;
160 #endif
161 };
162
163 static void callback_main_atexit(void *user_data)
164 {
165         struct CreatorAtExitData *app_init_data = user_data;
166
167         if (app_init_data->ba) {
168                 BLI_argsFree(app_init_data->ba);
169                 app_init_data->ba = NULL;
170         }
171
172 #ifdef WIN32
173         if (app_init_data->argv) {
174                 while (app_init_data->argv_num) {
175                         free((void *)app_init_data->argv[--app_init_data->argv_num]);
176                 }
177                 free((void *)app_init_data->argv);
178                 app_init_data->argv = NULL;
179         }
180 #endif
181 }
182
183 static void callback_clg_fatal(void *fp)
184 {
185         BLI_system_backtrace(fp);
186 }
187
188 /** \} */
189
190
191
192 /* -------------------------------------------------------------------- */
193
194 /** \name Main Function
195  * \{ */
196
197 #ifdef WITH_PYTHON_MODULE
198 /* allow python module to call main */
199 #  define main main_python_enter
200 static void *evil_C = NULL;
201
202 #  ifdef __APPLE__
203      /* environ is not available in mac shared libraries */
204 #    include <crt_externs.h>
205 char **environ = NULL;
206 #  endif
207 #endif
208
209 /**
210  * Blender's main function responsibilities are:
211  * - setup subsystems.
212  * - handle arguments.
213  * - run #WM_main() event loop,
214  *   or exit immediately when running in background mode.
215  */
216 int main(
217         int argc,
218 #ifdef WIN32
219         const char **UNUSED(argv_c)
220 #else
221         const char **argv
222 #endif
223         )
224 {
225         bContext *C;
226
227 #ifndef WITH_PYTHON_MODULE
228         bArgs *ba;
229 #endif
230
231 #ifdef WIN32
232         char **argv;
233         int argv_num;
234 #endif
235
236         /* --- end declarations --- */
237
238         /* ensure we free data on early-exit */
239         struct CreatorAtExitData app_init_data = {NULL};
240         BKE_blender_atexit_register(callback_main_atexit, &app_init_data);
241
242         /* Unbuffered stdout makes stdout and stderr better synchronized, and helps
243          * when stepping through code in a debugger (prints are immediately
244          * visible). */
245         setvbuf(stdout, NULL, _IONBF, 0);
246
247 #ifdef WIN32
248         /* We delay loading of openmp so we can set the policy here. */
249 # if defined(_MSC_VER)
250         _putenv_s("OMP_WAIT_POLICY", "PASSIVE");
251 # endif
252
253         /* FMA3 support in the 2013 CRT is broken on Vista and Windows 7 RTM (fixed in SP1). Just disable it. */
254 #  if defined(_MSC_VER) && defined(_M_X64)
255         _set_FMA3_enable(0);
256 #  endif
257
258         /* Win32 Unicode Args */
259         /* NOTE: cannot use guardedalloc malloc here, as it's not yet initialized
260          *       (it depends on the args passed in, which is what we're getting here!)
261          */
262         {
263                 wchar_t **argv_16 = CommandLineToArgvW(GetCommandLineW(), &argc);
264                 argv = malloc(argc * sizeof(char *));
265                 for (argv_num = 0; argv_num < argc; argv_num++) {
266                         argv[argv_num] = alloc_utf_8_from_16(argv_16[argv_num], 0);
267                 }
268                 LocalFree(argv_16);
269
270                 /* free on early-exit */
271                 app_init_data.argv = argv;
272                 app_init_data.argv_num = argv_num;
273         }
274 #endif  /* WIN32 */
275
276         /* NOTE: Special exception for guarded allocator type switch:
277          *       we need to perform switch from lock-free to fully
278          *       guarded allocator before any allocation happened.
279          */
280         {
281                 int i;
282                 for (i = 0; i < argc; i++) {
283                         if (STREQ(argv[i], "--debug") || STREQ(argv[i], "-d") ||
284                             STREQ(argv[i], "--debug-memory") || STREQ(argv[i], "--debug-all"))
285                         {
286                                 printf("Switching to fully guarded memory allocator.\n");
287                                 MEM_use_guarded_allocator();
288                                 break;
289                         }
290                         else if (STREQ(argv[i], "--")) {
291                                 break;
292                         }
293                 }
294         }
295
296 #ifdef BUILD_DATE
297         {
298                 time_t temp_time = build_commit_timestamp;
299                 struct tm *tm = gmtime(&temp_time);
300                 if (LIKELY(tm)) {
301                         strftime(build_commit_date, sizeof(build_commit_date), "%Y-%m-%d", tm);
302                         strftime(build_commit_time, sizeof(build_commit_time), "%H:%M", tm);
303                 }
304                 else {
305                         const char *unknown = "date-unknown";
306                         BLI_strncpy(build_commit_date, unknown, sizeof(build_commit_date));
307                         BLI_strncpy(build_commit_time, unknown, sizeof(build_commit_time));
308                 }
309         }
310 #endif
311
312 #ifdef WITH_SDL_DYNLOAD
313         sdlewInit();
314 #endif
315
316         /* Initialize logging */
317         CLG_init();
318         CLG_fatal_fn_set(callback_clg_fatal);
319
320         C = CTX_create();
321
322 #ifdef WITH_PYTHON_MODULE
323 #ifdef __APPLE__
324         environ = *_NSGetEnviron();
325 #endif
326
327 #undef main
328         evil_C = C;
329 #endif
330
331
332
333 #ifdef WITH_BINRELOC
334         br_init(NULL);
335 #endif
336
337 #ifdef WITH_LIBMV
338         libmv_initLogging(argv[0]);
339 #elif defined(WITH_CYCLES_LOGGING)
340         CCL_init_logging(argv[0]);
341 #endif
342
343         main_callback_setup();
344
345 #if defined(__APPLE__) && !defined(WITH_PYTHON_MODULE)
346         /* patch to ignore argument finder gives us (pid?) */
347         if (argc == 2 && STREQLEN(argv[1], "-psn_", 5)) {
348                 extern int GHOST_HACK_getFirstFile(char buf[]);
349                 static char firstfilebuf[512];
350
351                 argc = 1;
352
353                 if (GHOST_HACK_getFirstFile(firstfilebuf)) {
354                         argc = 2;
355                         argv[1] = firstfilebuf;
356                 }
357         }
358 #endif
359
360 #ifdef __FreeBSD__
361         fpsetmask(0);
362 #endif
363
364         /* initialize path to executable */
365         BKE_appdir_program_path_init(argv[0]);
366
367         BLI_threadapi_init();
368         BLI_thread_put_process_on_fast_node();
369
370         DNA_sdna_current_init();
371
372         BKE_blender_globals_init();  /* blender.c */
373
374         IMB_init();
375         BKE_cachefiles_init();
376         BKE_images_init();
377         BKE_modifier_init();
378         BKE_gpencil_modifier_init();
379         BKE_shaderfx_init();
380         DEG_register_node_types();
381
382         BKE_brush_system_init();
383         RE_texture_rng_init();
384
385
386         BLI_callback_global_init();
387
388         /* first test for background */
389 #ifndef WITH_PYTHON_MODULE
390         ba = BLI_argsInit(argc, (const char **)argv); /* skip binary path */
391
392         /* ensure we free on early exit */
393         app_init_data.ba = ba;
394
395         main_args_setup(C, ba);
396
397         BLI_argsParse(ba, 1, NULL, NULL);
398
399         main_signal_setup();
400
401 #else
402         G.factory_startup = true;  /* using preferences or user startup makes no sense for py-as-module */
403 #endif
404
405 #ifdef WITH_FFMPEG
406         IMB_ffmpeg_init();
407 #endif
408
409         /* after level 1 args, this is so playanim skips RNA init */
410         RNA_init();
411
412         RE_engines_init();
413         init_nodesystem();
414         psys_init_rng();
415         /* end second init */
416
417
418 #if defined(WITH_PYTHON_MODULE) || defined(WITH_HEADLESS)
419         G.background = true; /* python module mode ALWAYS runs in background mode (for now) */
420 #else
421         if (G.background) {
422                 main_signal_setup_background();
423         }
424 #endif
425
426         /* background render uses this font too */
427         BKE_vfont_builtin_register(datatoc_bfont_pfb, datatoc_bfont_pfb_size);
428
429         /* Initialize ffmpeg if built in, also needed for bg mode if videos are
430          * rendered via ffmpeg */
431         BKE_sound_init_once();
432
433         init_def_material();
434
435         if (G.background == 0) {
436 #ifndef WITH_PYTHON_MODULE
437                 BLI_argsParse(ba, 2, NULL, NULL);
438                 BLI_argsParse(ba, 3, NULL, NULL);
439 #endif
440                 WM_init(C, argc, (const char **)argv);
441
442                 /* this is properly initialized with user defs, but this is default */
443                 /* call after loading the startup.blend so we can read U.tempdir */
444                 BKE_tempdir_init(U.tempdir);
445         }
446         else {
447 #ifndef WITH_PYTHON_MODULE
448                 BLI_argsParse(ba, 3, NULL, NULL);
449 #endif
450
451                 WM_init(C, argc, (const char **)argv);
452
453                 /* don't use user preferences temp dir */
454                 BKE_tempdir_init(NULL);
455         }
456 #ifdef WITH_PYTHON
457         /**
458          * NOTE: the U.pythondir string is NULL until WM_init() is executed,
459          * so we provide the BPY_ function below to append the user defined
460          * python-dir to Python's sys.path at this point.  Simply putting
461          * WM_init() before #BPY_python_start() crashes Blender at startup.
462          */
463
464         /* TODO - U.pythondir */
465 #else
466         printf("\n* WARNING * - Blender compiled without Python!\nthis is not intended for typical usage\n\n");
467 #endif
468
469         CTX_py_init_set(C, 1);
470         WM_keyconfig_init(C);
471
472 #ifdef WITH_FREESTYLE
473         /* initialize Freestyle */
474         FRS_initialize();
475         FRS_set_context(C);
476 #endif
477
478         /* OK we are ready for it */
479 #ifndef WITH_PYTHON_MODULE
480         main_args_setup_post(C, ba);
481
482         if (G.background == 0) {
483                 if (!G.file_loaded)
484                         if (U.uiflag2 & USER_KEEP_SESSION)
485                                 WM_recover_last_session(C, NULL);
486         }
487
488 #endif
489
490         /* Explicitly free data allocated for argument parsing:
491          * - 'ba'
492          * - 'argv' on WIN32.
493          */
494         callback_main_atexit(&app_init_data);
495         BKE_blender_atexit_unregister(callback_main_atexit, &app_init_data);
496
497         /* paranoid, avoid accidental re-use */
498 #ifndef WITH_PYTHON_MODULE
499         ba = NULL;
500         (void)ba;
501 #endif
502
503 #ifdef WIN32
504         argv = NULL;
505         (void)argv;
506 #endif
507
508 #ifdef WITH_PYTHON_MODULE
509         return 0; /* keep blender in background mode running */
510 #endif
511
512         if (G.background) {
513                 /* Using window-manager API in background mode is a bit odd, but works fine. */
514                 WM_exit(C);
515         }
516         else {
517                 if (!G.file_loaded) {
518                         WM_init_splash(C);
519                 }
520         }
521
522         WM_main(C);
523
524         return 0;
525 } /* end of int main(argc, argv) */
526
527 #ifdef WITH_PYTHON_MODULE
528 void main_python_exit(void)
529 {
530         WM_exit_ext((bContext *)evil_C, true);
531         evil_C = NULL;
532 }
533 #endif
534
535 /** \} */