Credit Andrew - improve in-tree documentation
[goodguy/cinelerra.git] / cinelerra / preferencesthread.C
1
2 /*
3  * CINELERRA
4  * Copyright (C) 2011 Adam Williams <broadcast at earthling dot net>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  */
21
22 #include "aboutprefs.h"
23 #include "appearanceprefs.h"
24 #include "asset.h"
25 #include "audiodevice.inc"
26 #include "bcsignals.h"
27 #include "bctrace.h"
28 #include "cache.h"
29 #include "cplayback.h"
30 #include "cwindow.h"
31 #include "cwindowgui.h"
32 #include "bchash.h"
33 #include "edl.h"
34 #include "edlsession.h"
35 #include "file.h"
36 #include "filesystem.h"
37 #include "fonts.h"
38 #include "interfaceprefs.h"
39 #include "keys.h"
40 #include "language.h"
41 #include "levelwindow.h"
42 #include "levelwindowgui.h"
43 #include "mainclock.h"
44 #include "mainerror.h"
45 #include "mbuttons.h"
46 #include "meterpanel.h"
47 #include "mutex.h"
48 #include "mwindow.h"
49 #include "mwindowgui.h"
50 #include "patchbay.h"
51 #include "performanceprefs.h"
52 #include "playbackengine.h"
53 #include "playbackprefs.h"
54 #include "preferences.h"
55 #include "recordprefs.h"
56 #include "shbtnprefs.h"
57 #include "theme.h"
58 #include "trackcanvas.h"
59 #include "transportque.h"
60 #include "vwindow.h"
61 #include "vwindowgui.h"
62
63 #include <string.h>
64
65
66
67 #define WIDTH 860
68 #define HEIGHT 700
69
70
71 PreferencesMenuitem::PreferencesMenuitem(MWindow *mwindow)
72  : BC_MenuItem(_("Preferences..."), _("Shift-P"), 'P')
73 {
74         this->mwindow = mwindow;
75
76         set_shift(1);
77         thread = new PreferencesThread(mwindow);
78 }
79
80 PreferencesMenuitem::~PreferencesMenuitem()
81 {
82         delete thread;
83 }
84
85
86 int PreferencesMenuitem::handle_event()
87 {
88         mwindow->gui->unlock_window();
89         thread->start();
90         mwindow->gui->lock_window("PreferencesMenuitem::handle_event");
91         return 1;
92 }
93
94
95
96
97 PreferencesThread::PreferencesThread(MWindow *mwindow)
98  : BC_DialogThread()
99 {
100         this->mwindow = mwindow;
101         window = 0;
102         thread_running = 0;
103 }
104
105 PreferencesThread::~PreferencesThread()
106 {
107         close_window();
108 }
109
110 BC_Window* PreferencesThread::new_gui()
111 {
112
113         preferences = new Preferences;
114         edl = new EDL;
115         edl->create_objects();
116         current_dialog = mwindow->defaults->get("DEFAULTPREF", 0);
117         preferences->copy_from(mwindow->preferences);
118         edl->copy_session(mwindow->edl);
119         redraw_indexes = 0;
120         redraw_meters = 0;
121         redraw_times = 0;
122         redraw_overlays = 0;
123         close_assets = 0;
124         reload_plugins = 0;
125         //int need_new_indexes = 0;
126         rerender = 0;
127
128         mwindow->gui->lock_window("NewThread::new_gui");
129         int scr_x = mwindow->gui->get_screen_x(0, -1);
130         int scr_w = mwindow->gui->get_screen_w(0, -1);
131         int scr_h = mwindow->gui->get_screen_h(0, -1);
132
133         int w = WIDTH, h = HEIGHT;
134         int min_w = mwindow->theme->preferencescategory_x;
135         for(int i = 0; i < CATEGORIES; i++) {
136                 min_w += PreferencesButton::calculate_w(mwindow->gui, category_to_text(i)) -
137                         mwindow->theme->preferences_category_overlap;
138         }
139         if( w < min_w ) w = min_w;
140         int x = scr_x + scr_w / 2 - w / 2;
141         int y = scr_h / 2 - h / 2;
142
143         window = new PreferencesWindow(mwindow, this, x, y, w, h);
144         window->create_objects();
145         mwindow->gui->unlock_window();
146
147         thread_running = 1;
148         return window;
149 }
150
151 void PreferencesThread::handle_close_event(int result)
152 {
153         thread_running = 0;
154         if(!result)
155         {
156                 apply_settings();
157                 mwindow->save_defaults();
158         }
159
160         window = 0;
161         delete preferences;
162         edl->Garbage::remove_user();
163         preferences = 0;
164         edl = 0;
165
166         mwindow->defaults->update("DEFAULTPREF", current_dialog);
167         if( mwindow->restart() )
168                 mwindow->gui->set_done(0);
169 }
170
171
172
173 int PreferencesThread::update_framerate()
174 {
175         if(thread_running)
176         {
177                 lock_gui("PreferencesThread::update_framerate");
178                 PreferencesWindow *window = (PreferencesWindow*)get_gui();
179                 if(window) window->update_framerate();
180                 unlock_gui();
181         }
182         return 0;
183 }
184
185
186 void PreferencesThread::update_rates()
187 {
188         if(thread_running)
189         {
190                 lock_gui("PreferencesThread::update_framerate");
191                 PreferencesWindow *window = (PreferencesWindow*)get_gui();
192                 if(window) window->update_rates();
193                 unlock_gui();
194         }
195 }
196
197 int PreferencesThread::apply_settings()
198 {
199 // Compare sessions
200
201         PlaybackConfig *this_playback_config = edl->session->playback_config;
202         AudioOutConfig *this_aconfig = this_playback_config->aconfig;
203         VideoOutConfig *this_vconfig = this_playback_config->vconfig;
204         PlaybackConfig *playback_config = mwindow->edl->session->playback_config;
205         AudioOutConfig *aconfig = playback_config->aconfig;
206         VideoOutConfig *vconfig = playback_config->vconfig;
207
208         rerender =
209                 edl->session->need_rerender(mwindow->edl->session) ||
210                 (preferences->force_uniprocessor != mwindow->preferences->force_uniprocessor) ||
211                 this_playback_config->active_config != playback_config->active_config ||
212                 (*this_aconfig != *aconfig) || (*this_vconfig != *vconfig) ||
213                 !preferences->brender_asset->equivalent(*mwindow->preferences->brender_asset, 0, 1, edl);
214
215         if( preferences->autocolor_assets != mwindow->preferences->autocolor_assets )
216                 redraw_indexes = 1;
217
218         if( preferences->yuv_color_space != mwindow->preferences->yuv_color_space ||
219             preferences->yuv_color_range != mwindow->preferences->yuv_color_range ) {
220                 YUV::yuv.yuv_set_colors(
221                         preferences->yuv_color_space,
222                         preferences->yuv_color_range);
223                 rerender = 1;
224         }
225
226         if( preferences->highlight_inverse != mwindow->preferences->highlight_inverse ) {
227                 mwindow->gui->lock_window("PreferencesThread::apply_settings 0");
228                 mwindow->gui->hide_cursor(0);
229                 mwindow->gui->unlock_window();
230                 redraw_overlays = 1;
231         }
232         PreferencesWindow *window = (PreferencesWindow*)get_gui();
233         if( window ) window->unlock_window();
234         mwindow->stop_brender();
235         if( window ) window->lock_window("PreferencesThread::apply_settings 5");
236
237         if( strcmp(preferences->theme, mwindow->preferences->theme) ||
238             strcmp(preferences->plugin_icons, mwindow->preferences->plugin_icons) ||
239             preferences->awindow_picon_h != mwindow->preferences->awindow_picon_h ||
240             preferences->vicon_size != mwindow->preferences->vicon_size ||
241             preferences->vicon_color_mode != mwindow->preferences->vicon_color_mode )
242                 mwindow->restart_status = -1;  // reconstruct/restart program
243         if( strcmp(preferences->lv2_path, mwindow->preferences->lv2_path) != 0 )
244                 reload_plugins = 1;
245         if( reload_plugins ) {
246                 MWindow::remove_plugin_index();
247                 File::setenv_path("LV2_PATH", preferences->lv2_path, 1);
248                 mwindow->restart_status = -1;
249         }
250
251         mwindow->edl->copy_session(edl, 1);
252         mwindow->preferences->copy_from(preferences);
253
254         BC_Signals::set_catch_segv(mwindow->preferences->trap_sigsegv);
255         BC_Signals::set_catch_intr(mwindow->preferences->trap_sigintr);
256         BC_WindowBase::get_resources()->popupmenu_btnup = mwindow->preferences->popupmenu_btnup;
257         BC_WindowBase::get_resources()->grab_input_focus = mwindow->preferences->grab_input_focus;
258         BC_WindowBase::get_resources()->textbox_focus_policy = mwindow->preferences->textbox_focus_policy;
259         if( mwindow->preferences->trap_sigsegv || mwindow->preferences->trap_sigintr ) {
260                 BC_Trace::enable_locks();
261         }
262         else {
263                 BC_Trace::disable_locks();
264         }
265
266         mwindow->reset_android_remote();
267         int ffmpeg_early_probe = mwindow->preferences->get_file_probe_armed("FFMPEG_Early");
268         mwindow->gui->ffmpeg_toggle->update(ffmpeg_early_probe);
269         mwindow->gui->ffmpeg_toggle->set_tooltip(ffmpeg_early_probe ?
270                 FFMPEG_EARLY_TIP : FFMPEG_LATE_TIP);
271         mwindow->gui->mainshbtns->load(mwindow->preferences);
272         mwindow->init_brender();
273
274 //edl->session->recording_format->dump();
275 //mwindow->edl->session->recording_format->dump();
276
277         if(((mwindow->edl->session->output_w % 4) ||
278                 (mwindow->edl->session->output_h % 4)) &&
279                 mwindow->edl->session->playback_config->vconfig->driver == PLAYBACK_X11_GL)
280         {
281                 MainError::show_error(
282                         _("This project's dimensions are not multiples of 4 so\n"
283                         "it can't be rendered by OpenGL."));
284         }
285
286
287         if(redraw_meters)
288         {
289                 mwindow->cwindow->gui->lock_window("PreferencesThread::apply_settings");
290                 mwindow->cwindow->gui->meters->change_format(edl->session->meter_format,
291                         edl->session->min_meter_db,
292                         edl->session->max_meter_db);
293                 mwindow->cwindow->gui->unlock_window();
294
295
296
297                 for(int i = 0; i < mwindow->vwindows.size(); i++) {
298                         VWindow *vwindow = mwindow->vwindows.get(i);
299                         if( !vwindow->is_running() ) continue;
300                         vwindow->gui->lock_window("PreferencesThread::apply_settings");
301                         vwindow->gui->meters->change_format(edl->session->meter_format,
302                                 edl->session->min_meter_db,
303                                 edl->session->max_meter_db);
304                         vwindow->gui->unlock_window();
305
306                 }
307
308
309                 mwindow->gui->lock_window("PreferencesThread::apply_settings 1");
310                 mwindow->gui->set_meter_format(edl->session->meter_format,
311                         edl->session->min_meter_db,
312                         edl->session->max_meter_db);
313                 mwindow->gui->unlock_window();
314
315
316
317                 mwindow->lwindow->gui->lock_window("PreferencesThread::apply_settings");
318                 mwindow->lwindow->gui->panel->change_format(edl->session->meter_format,
319                         edl->session->min_meter_db,
320                         edl->session->max_meter_db);
321                 mwindow->lwindow->gui->unlock_window();
322         }
323
324         if(redraw_overlays)
325         {
326                 mwindow->gui->lock_window("PreferencesThread::apply_settings 2");
327                 mwindow->gui->show_cursor(0);
328                 mwindow->gui->draw_overlays(1);
329                 mwindow->gui->unlock_window();
330         }
331
332         if(redraw_times)
333         {
334                 mwindow->gui->lock_window("PreferencesThread::apply_settings 3");
335                 mwindow->gui->update(0, NO_DRAW, 1, 0, 0, 1, 0);
336                 mwindow->gui->redraw_time_dependancies();
337                 mwindow->gui->unlock_window();
338         }
339
340         if(rerender)
341         {
342 //printf("PreferencesThread::apply_settings 1\n");
343 // This doesn't stop and restart, only reloads the assets before
344 // the next play command.
345                 mwindow->cwindow->refresh_frame(CHANGE_ALL, mwindow->edl);
346 //printf("PreferencesThread::apply_settings 10\n");
347         }
348
349         if(redraw_indexes)
350         {
351                 mwindow->gui->lock_window("PreferencesThread::apply_settings 4");
352                 mwindow->gui->draw_trackmovement();
353                 mwindow->gui->unlock_window();
354         }
355
356         if(redraw_times || redraw_overlays || redraw_indexes)
357         {
358                 mwindow->gui->lock_window("PreferencesThread::apply_settings 5");
359                 mwindow->gui->flush();
360                 mwindow->gui->unlock_window();
361         }
362
363         return 0;
364 }
365
366 const char* PreferencesThread::category_to_text(int category)
367 {
368         PlaybackConfig *playback_config = edl->session->playback_config;
369         switch(category)
370         {
371                 case PLAYBACK_A:
372                         return playback_config->active_config==0 ?
373                                  _("*Playback A") : _("Playback A");
374                 case PLAYBACK_B:
375                         return playback_config->active_config==1 ?
376                                  _("*Playback B") : _("Playback B");
377                 case RECORD:
378                         return _("Recording");
379                 case PERFORMANCE:
380                         return _("Performance");
381                 case INTERFACE:
382                         return _("Interface");
383                 case APPEARANCE:
384                         return _("Appearance");
385                 case ABOUT:
386                         return _("About");
387         }
388         return "";
389 }
390
391 int PreferencesThread::text_to_category(const char *category)
392 {
393 SET_TRACE
394         int min_result = -1, result, result_num = 0;
395         for(int i = 0; i < CATEGORIES; i++)
396         {
397                 result = labs(strcmp(category_to_text(i), category));
398                 if(result < min_result || min_result < 0)
399                 {
400                         min_result = result;
401                         result_num = i;
402                 }
403         }
404 SET_TRACE
405         return result_num;
406 }
407
408
409
410
411
412
413
414
415 PreferencesWindow::PreferencesWindow(MWindow *mwindow,
416         PreferencesThread *thread, int x, int y, int w, int h)
417  : BC_Window(_(PROGRAM_NAME ": Preferences"), x,y, w,h,w,h, 1)
418 {
419         this->mwindow = mwindow;
420         this->thread = thread;
421         dialog = 0;
422         category = 0;
423 }
424
425 PreferencesWindow::~PreferencesWindow()
426 {
427         lock_window("PreferencesWindow::~PreferencesWindow");
428         delete category;
429
430
431         if(dialog) delete dialog;
432
433
434         for(int i = 0; i < categories.total; i++)
435                 delete categories.values[i];
436         unlock_window();
437 }
438
439 void PreferencesWindow::create_objects()
440 {
441         BC_Button *button;
442
443         lock_window("PreferencesWindow::create_objects");
444         set_icon(mwindow->theme->get_image("mwindow_icon"));
445         mwindow->theme->draw_preferences_bg(this);
446         flash();
447
448         int x = mwindow->theme->preferencescategory_x;
449         int y = mwindow->theme->preferencescategory_y;
450         for(int i = 0; i < CATEGORIES; i++)
451         {
452                 add_subwindow(category_button[i] = new PreferencesButton(mwindow,
453                         thread, x, y, i, thread->category_to_text(i),
454                         (i == thread->current_dialog) ?
455                                 mwindow->theme->get_image_set("category_button_checked") :
456                                 mwindow->theme->get_image_set("category_button")));
457                 x += category_button[i]->get_w() -
458                         mwindow->theme->preferences_category_overlap;
459         }
460
461
462 //      for(int i = 0; i < CATEGORIES; i++)
463 //              categories.append(new BC_ListBoxItem(thread->category_to_text(i)));
464 //      category = new PreferencesCategory(mwindow,
465 //              thread,
466 //              mwindow->theme->preferencescategory_x,
467 //              mwindow->theme->preferencescategory_y);
468 //      category->create_objects();
469
470
471         add_subwindow(button = new PreferencesOK(mwindow, thread));
472         add_subwindow(new PreferencesApply(mwindow, thread));
473         add_subwindow(new PreferencesCancel(mwindow, thread));
474
475         set_current_dialog(thread->current_dialog);
476
477         show_window();
478         unlock_window();
479 }
480
481 int PreferencesWindow::update_framerate()
482 {
483         lock_window("PreferencesWindow::update_framerate");
484         if(thread->current_dialog < PreferencesThread::RECORD)
485         {
486                 dialog->draw_framerate(1);
487 //              flash();
488         }
489         unlock_window();
490         return 0;
491 }
492
493
494 void PreferencesWindow::update_rates()
495 {
496         lock_window("PreferencesWindow::update_rates");
497         if(thread->current_dialog == PreferencesThread::PERFORMANCE)
498         {
499                 dialog->update_rates();
500         }
501         unlock_window();
502 }
503
504
505 int PreferencesWindow::set_current_dialog(int number)
506 {
507         if(dialog) delete dialog;
508         dialog = 0;
509         thread->current_dialog = number;
510
511 //PRINT_TRACE
512         PreferencesDialog *dialog2 = dialog;
513         dialog = 0;
514 //PRINT_TRACE
515
516 // Redraw category buttons
517         for(int i = 0; i < CATEGORIES; i++)
518         {
519                 if(i == number)
520                 {
521                         category_button[i]->set_images(
522                                 mwindow->theme->get_image_set("category_button_checked"));
523                 }
524                 else
525                 {
526                         category_button[i]->set_images(
527                                 mwindow->theme->get_image_set("category_button"));
528                 }
529                 category_button[i]->draw_face(0);
530
531 // Copy face to background for next button's overlap.
532 // Still can't do state changes right.
533         }
534
535
536 //PRINT_TRACE
537         PlaybackConfig *playback_config = thread->edl->session->playback_config;
538         switch(number)
539         {
540                 case PreferencesThread::PLAYBACK_A:
541                 case PreferencesThread::PLAYBACK_B:
542                         playback_config->load_defaults(mwindow->defaults,
543                                 number == PreferencesThread::PLAYBACK_A ? 0 : 1);
544                         add_subwindow(dialog = new PlaybackPrefs(mwindow, this, number));
545                         break;
546
547                 case PreferencesThread::RECORD:
548                         add_subwindow(dialog = new RecordPrefs(mwindow, this));
549                         break;
550
551                 case PreferencesThread::PERFORMANCE:
552                         add_subwindow(dialog = new PerformancePrefs(mwindow, this));
553                         break;
554
555                 case PreferencesThread::INTERFACE:
556                         add_subwindow(dialog = new InterfacePrefs(mwindow, this));
557                         break;
558
559                 case PreferencesThread::APPEARANCE:
560                         add_subwindow(dialog = new AppearancePrefs(mwindow, this));
561                         break;
562
563                 case PreferencesThread::ABOUT:
564                         add_subwindow(dialog = new AboutPrefs(mwindow, this));
565                         break;
566         }
567
568 //PRINT_TRACE
569         if(dialog)
570         {
571                 dialog->draw_top_background(this, 0, 0, dialog->get_w(), dialog->get_h());
572 //printf("PreferencesWindow::set_current_dialog %d\n", __LINE__);
573                 dialog->create_objects();
574 //printf("PreferencesWindow::set_current_dialog %d\n", __LINE__);
575                 dialog->lower_window();
576                 dialog->show_window(0);
577         }
578
579         if(dialog2)
580         {
581                 dialog2->hide_window(0);
582                 delete dialog2;
583         }
584
585         return 0;
586 }
587
588
589
590
591
592
593
594
595
596
597
598 PreferencesButton::PreferencesButton(MWindow *mwindow,
599         PreferencesThread *thread,
600         int x,
601         int y,
602         int category,
603         const char *text,
604         VFrame **images)
605  : BC_GenericButton(x, y, text, images)
606 {
607         this->mwindow = mwindow;
608         this->thread = thread;
609         this->category = category;
610 }
611
612 int PreferencesButton::handle_event()
613 {
614         thread->window->set_current_dialog(category);
615         return 1;
616 }
617
618
619
620
621
622
623
624
625
626 PreferencesDialog::PreferencesDialog(MWindow *mwindow,
627         PreferencesWindow *pwindow)
628  : BC_SubWindow(10,
629         40,
630         pwindow->get_w() - 20,
631         pwindow->get_h() - BC_GenericButton::calculate_h() - 10 - 40)
632 {
633         this->pwindow = pwindow;
634         this->mwindow = mwindow;
635         preferences = pwindow->thread->preferences;
636 }
637
638 PreferencesDialog::~PreferencesDialog()
639 {
640 }
641
642 // ============================== category window
643
644
645
646
647 PreferencesApply::PreferencesApply(MWindow *mwindow, PreferencesThread *thread)
648  : BC_GenericButton(thread->window->get_w() / 2 - BC_GenericButton::calculate_w(thread->window, _("Apply")) / 2,
649         thread->window->get_h() - BC_GenericButton::calculate_h() - 10,
650         _("Apply"))
651 {
652         this->mwindow = mwindow;
653         this->thread = thread;
654 }
655 int PreferencesApply::handle_event()
656 {
657         thread->apply_settings();
658         mwindow->save_defaults();
659         return 1;
660 }
661 int PreferencesApply::resize_event(int w, int h)
662 {
663         reposition_window(w/2 - get_w()/2, h-get_h()-10);
664         return 1;
665 }
666
667
668
669
670 PreferencesOK::PreferencesOK(MWindow *mwindow, PreferencesThread *thread)
671  : BC_GenericButton(10,
672         thread->window->get_h() - BC_GenericButton::calculate_h() - 10,
673         _("OK"))
674 {
675         this->mwindow = mwindow;
676         this->thread = thread;
677 }
678 int PreferencesOK::keypress_event()
679 {
680         if(get_keypress() == RETURN)
681         {
682                 thread->window->set_done(0);
683                 return 1;
684         }
685         return 0;
686 }
687 int PreferencesOK::handle_event()
688 {
689         thread->window->set_done(0);
690         return 1;
691 }
692 int PreferencesOK::resize_event(int w, int h)
693 {
694         reposition_window(10, h-get_h()-10);
695         return 1;
696 }
697
698
699
700 PreferencesCancel::PreferencesCancel(MWindow *mwindow, PreferencesThread *thread)
701  : BC_GenericButton(thread->window->get_w() - BC_GenericButton::calculate_w(thread->window, _("Cancel")) - 10,
702         thread->window->get_h() - BC_GenericButton::calculate_h() - 10,
703         _("Cancel"))
704 {
705         this->mwindow = mwindow;
706         this->thread = thread;
707 }
708 int PreferencesCancel::keypress_event()
709 {
710         if(get_keypress() == ESC)
711         {
712                 thread->window->set_done(1);
713                 return 1;
714         }
715         return 0;
716 }
717 int PreferencesCancel::handle_event()
718 {
719         thread->window->set_done(1);
720         return 1;
721 }
722 int PreferencesCancel::resize_event(int w, int h)
723 {
724         reposition_window(w-get_w()-10, h-get_h()-10);
725         return 1;
726 }
727
728
729
730
731
732
733
734
735
736
737 PreferencesCategory::PreferencesCategory(MWindow *mwindow, PreferencesThread *thread, int x, int y)
738  : BC_PopupTextBox(thread->window,
739                 &thread->window->categories,
740                 thread->category_to_text(thread->current_dialog),
741                 x,
742                 y,
743                 200,
744                 150)
745 {
746         this->mwindow = mwindow;
747         this->thread = thread;
748 }
749
750 PreferencesCategory::~PreferencesCategory()
751 {
752 }
753
754 int PreferencesCategory::handle_event()
755 {
756 SET_TRACE
757         thread->window->set_current_dialog(thread->text_to_category(get_text()));
758 SET_TRACE
759         return 1;
760 }