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