Missed update to private test repo version.
[dcpomatic.git] / src / wx / wx_util.cc
1 /*
2     Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
3
4     This file is part of DCP-o-matic.
5
6     DCP-o-matic 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     DCP-o-matic 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 DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
18
19 */
20
21
22 /** @file src/wx/wx_util.cc
23  *  @brief Some utility functions and classes.
24  */
25
26
27 #include "file_picker_ctrl.h"
28 #include "language_tag_widget.h"
29 #include "password_entry.h"
30 #include "region_subtag_widget.h"
31 #include "static_text.h"
32 #include "wx_ptr.h"
33 #include "wx_util.h"
34 #include "lib/config.h"
35 #include "lib/cross.h"
36 #include "lib/job.h"
37 #include "lib/job_manager.h"
38 #include "lib/util.h"
39 #include "lib/version.h"
40 #include <dcp/locale_convert.h>
41 #include <dcp/warnings.h>
42 LIBDCP_DISABLE_WARNINGS
43 #include <wx/spinctrl.h>
44 #include <wx/splash.h>
45 #include <wx/progdlg.h>
46 #include <wx/filepicker.h>
47 #include <wx/sizer.h>
48 LIBDCP_ENABLE_WARNINGS
49 #include <boost/thread.hpp>
50
51
52 using std::string;
53 using std::vector;
54 using std::pair;
55 using std::shared_ptr;
56 using boost::optional;
57 using dcp::locale_convert;
58 using namespace dcpomatic;
59
60
61 wxStaticText *
62 #ifdef __WXOSX__
63 create_label (wxWindow* p, wxString t, bool left)
64 #else
65 create_label (wxWindow* p, wxString t, bool)
66 #endif
67 {
68 #ifdef __WXOSX__
69         if (left) {
70                 t += wxT (":");
71         }
72 #endif
73         return new StaticText (p, t);
74 }
75
76
77 #ifdef __WXOSX__
78 static
79 void
80 setup_osx_flags (wxSizer* s, bool left, int& flags)
81 {
82         if (left) {
83                 auto box = dynamic_cast<wxBoxSizer*>(s);
84                 if (!box || box->GetOrientation() != wxHORIZONTAL) {
85                         flags |= wxALIGN_RIGHT;
86                 }
87         }
88 }
89 #endif
90
91
92 /** Add a wxStaticText to a wxSizer.
93  *  @param s Sizer to add to.
94  *  @param p Parent window for the wxStaticText.
95  *  @param t Text for the wxStaticText.
96  *  @param left true if this label is a `left label'; ie the sort
97  *  of label which should be right-aligned on OS X.
98  *  @param prop Proportion to pass when calling Add() on the wxSizer.
99  */
100 wxStaticText *
101 add_label_to_sizer (wxSizer* s, wxWindow* p, wxString t, bool left, int prop, int flags)
102 {
103 #ifdef __WXOSX__
104         setup_osx_flags (s, left, flags);
105 #endif
106         auto m = create_label (p, t, left);
107         s->Add (m, prop, flags, DCPOMATIC_SIZER_GAP);
108         return m;
109 }
110
111
112 wxStaticText *
113 #ifdef __WXOSX__
114 add_label_to_sizer (wxSizer* s, wxStaticText* t, bool left, int prop, int flags)
115 #else
116 add_label_to_sizer (wxSizer* s, wxStaticText* t, bool, int prop, int flags)
117 #endif
118 {
119 #ifdef __WXOSX__
120         setup_osx_flags (s, left, flags);
121 #endif
122         s->Add (t, prop, flags, DCPOMATIC_SIZER_GAP);
123         return t;
124 }
125
126
127 wxStaticText *
128 add_label_to_sizer(wxGridBagSizer* s, wxWindow* p, wxString t, bool left, wxGBPosition pos, wxGBSpan span, bool indent)
129 {
130         int flags = wxALIGN_CENTER_VERTICAL | wxLEFT;
131 #ifdef __WXOSX__
132         setup_osx_flags (s, left, flags);
133 #endif
134         auto m = create_label (p, t, left);
135         s->Add(m, pos, span, flags, indent ? DCPOMATIC_SIZER_X_GAP : 0);
136         return m;
137 }
138
139
140 wxStaticText *
141 #ifdef __WXOSX__
142 add_label_to_sizer (wxGridBagSizer* s, wxStaticText* t, bool left, wxGBPosition pos, wxGBSpan span)
143 #else
144 add_label_to_sizer (wxGridBagSizer* s, wxStaticText* t, bool, wxGBPosition pos, wxGBSpan span)
145 #endif
146 {
147         int flags = wxALIGN_CENTER_VERTICAL | wxLEFT | wxRIGHT;
148 #ifdef __WXOSX__
149         setup_osx_flags (s, left, flags);
150 #endif
151         s->Add (t, pos, span, flags);
152         return t;
153 }
154
155
156 /** Pop up an error dialogue box.
157  *  @param parent Parent.
158  *  @param m Message.
159  *  @param e Extended message.
160  */
161 void
162 error_dialog (wxWindow* parent, wxString m, optional<wxString> e)
163 {
164         auto d = make_wx<wxMessageDialog>(parent, m, _("DCP-o-matic"), wxOK | wxICON_ERROR);
165         if (e) {
166                 wxString em = *e;
167                 em[0] = wxToupper (em[0]);
168                 d->SetExtendedMessage (em);
169         }
170         d->ShowModal ();
171 }
172
173
174 /** Pop up an error dialogue box.
175  *  @param parent Parent.
176  *  @param m Message.
177  */
178 void
179 message_dialog (wxWindow* parent, wxString m)
180 {
181         auto d = make_wx<wxMessageDialog>(parent, m, _("DCP-o-matic"), wxOK | wxICON_INFORMATION);
182         d->ShowModal ();
183 }
184
185
186 /** @return true if the user answered "yes" */
187 bool
188 confirm_dialog (wxWindow* parent, wxString m)
189 {
190         auto d = make_wx<wxMessageDialog>(parent, m, _("DCP-o-matic"), wxYES_NO | wxICON_QUESTION);
191         return d->ShowModal() == wxID_YES;
192 }
193
194
195 /** @param s wxWidgets string.
196  *  @return Corresponding STL string.
197  */
198 string
199 wx_to_std (wxString s)
200 {
201         return string (s.ToUTF8());
202 }
203
204
205 /** @param s STL string.
206  *  @return Corresponding wxWidgets string.
207  */
208 wxString
209 std_to_wx (string s)
210 {
211         return wxString (s.c_str(), wxConvUTF8);
212 }
213
214
215 string
216 string_client_data (wxClientData* o)
217 {
218         return wx_to_std (dynamic_cast<wxStringClientData*>(o)->GetData());
219 }
220
221
222 void
223 checked_set (FilePickerCtrl* widget, boost::filesystem::path value)
224 {
225         if (widget->path() != value) {
226                 if (value.empty()) {
227                         /* Hack to make wxWidgets clear the control when we are passed
228                            an empty value.
229                         */
230                         value = " ";
231                 }
232                 widget->set_path(value);
233         }
234 }
235
236
237 void
238 checked_set (wxDirPickerCtrl* widget, boost::filesystem::path value)
239 {
240         if (widget->GetPath() != std_to_wx (value.string())) {
241                 if (value.empty()) {
242                         /* Hack to make wxWidgets clear the control when we are passed
243                            an empty value.
244                         */
245                         value = " ";
246                 }
247                 widget->SetPath (std_to_wx (value.string()));
248         }
249 }
250
251
252 void
253 checked_set (wxSpinCtrl* widget, int value)
254 {
255         if (widget->GetValue() != value) {
256                 widget->SetValue (value);
257         }
258 }
259
260
261 void
262 checked_set (wxSpinCtrlDouble* widget, double value)
263 {
264         /* XXX: completely arbitrary epsilon */
265         if (fabs (widget->GetValue() - value) > 1e-16) {
266                 widget->SetValue (value);
267         }
268 }
269
270
271 void
272 checked_set (wxChoice* widget, int value)
273 {
274         if (widget->GetSelection() != value) {
275                 widget->SetSelection (value);
276         }
277 }
278
279
280 void
281 checked_set (wxChoice* widget, string value)
282 {
283         wxClientData* o = nullptr;
284         if (widget->GetSelection() != -1) {
285                 o = widget->GetClientObject (widget->GetSelection ());
286         }
287
288         if (!o || string_client_data(o) != value) {
289                 for (unsigned int i = 0; i < widget->GetCount(); ++i) {
290                         if (string_client_data (widget->GetClientObject (i)) == value) {
291                                 widget->SetSelection (i);
292                         }
293                 }
294         }
295 }
296
297
298 void
299 checked_set (wxChoice* widget, vector<pair<string, string>> items)
300 {
301        vector<pair<string, string>> current;
302        for (unsigned int i = 0; i < widget->GetCount(); ++i) {
303                current.push_back (
304                        make_pair(
305                                wx_to_std(widget->GetString(i)),
306                                widget->GetClientData() ? string_client_data(widget->GetClientObject(i)) : ""
307                                )
308                        );
309        }
310
311        if (current == items) {
312                return;
313        }
314
315        widget->Clear ();
316        for (auto i: items) {
317                widget->Append (std_to_wx(i.first), new wxStringClientData(std_to_wx(i.second)));
318        }
319 }
320
321
322 void
323 checked_set (wxTextCtrl* widget, string value)
324 {
325         if (widget->GetValue() != std_to_wx (value)) {
326                 widget->ChangeValue (std_to_wx (value));
327         }
328 }
329
330
331 void
332 checked_set (PasswordEntry* entry, string value)
333 {
334         if (entry->get() != value) {
335                 entry->set(value);
336         }
337 }
338
339
340 void
341 checked_set (wxTextCtrl* widget, wxString value)
342 {
343         if (widget->GetValue() != value) {
344                 widget->ChangeValue (value);
345         }
346 }
347
348
349 void
350 checked_set (wxStaticText* widget, string value)
351 {
352         if (widget->GetLabel() != std_to_wx (value)) {
353                 widget->SetLabel (std_to_wx (value));
354         }
355 }
356
357
358 void
359 checked_set (wxStaticText* widget, wxString value)
360 {
361         if (widget->GetLabel() != value) {
362                 widget->SetLabel (value);
363         }
364 }
365
366
367 void
368 checked_set (wxCheckBox* widget, bool value)
369 {
370         if (widget->GetValue() != value) {
371                 widget->SetValue (value);
372         }
373 }
374
375
376 void
377 checked_set (wxRadioButton* widget, bool value)
378 {
379         if (widget->GetValue() != value) {
380                 widget->SetValue (value);
381         }
382 }
383
384
385 void
386 checked_set(LanguageTagWidget* widget, dcp::LanguageTag value)
387 {
388         if (widget->get() != value) {
389                 widget->set(value);
390         }
391 }
392
393
394 void
395 checked_set(LanguageTagWidget* widget, optional<dcp::LanguageTag> value)
396 {
397         if (widget->get() != value) {
398                 widget->set(value);
399         }
400 }
401
402
403 void
404 checked_set(RegionSubtagWidget* widget, optional<dcp::LanguageTag::RegionSubtag> value)
405 {
406         if (widget->get() != value) {
407                 widget->set(value);
408         }
409 }
410
411
412 void
413 dcpomatic_setup_i18n ()
414 {
415         int language = wxLANGUAGE_DEFAULT;
416
417         auto config_lang = Config::instance()->language ();
418         if (config_lang && !config_lang->empty ()) {
419                 auto const li = wxLocale::FindLanguageInfo (std_to_wx (config_lang.get ()));
420                 if (li) {
421                         language = li->Language;
422                 }
423         }
424
425         wxLocale* locale = nullptr;
426         if (wxLocale::IsAvailable (language)) {
427                 locale = new wxLocale (language, wxLOCALE_LOAD_DEFAULT);
428
429 #ifdef DCPOMATIC_WINDOWS
430                 locale->AddCatalogLookupPathPrefix (std_to_wx (mo_path().string()));
431 #endif
432
433 #ifdef DCPOMATIC_LINUX
434                 locale->AddCatalogLookupPathPrefix (LINUX_LOCALE_PREFIX);
435
436                 /* We have to include the wxWidgets .mo in our distribution,
437                    so we rename it to avoid clashes with any other installation
438                    of wxWidgets.
439                 */
440                 locale->AddCatalog (wxT ("dcpomatic2-wxstd"));
441
442                 /* Fedora 29 (at least) installs wxstd3.mo instead of wxstd.mo */
443                 locale->AddCatalog (wxT ("wxstd3"));
444 #endif
445
446                 locale->AddCatalog(wxT("wxstd"));
447                 locale->AddCatalog(wxT("libdcpomatic2-wx"));
448                 locale->AddCatalog(wxT("dcpomatic2"));
449
450                 if (!locale->IsOk()) {
451                         delete locale;
452                         locale = new wxLocale (wxLANGUAGE_ENGLISH);
453                 }
454         }
455
456         if (locale) {
457                 dcpomatic_setup_gettext_i18n (wx_to_std (locale->GetCanonicalName ()));
458         }
459 }
460
461
462 int
463 wx_get (wxSpinCtrl* w)
464 {
465         return w->GetValue ();
466 }
467
468
469 int
470 wx_get (wxChoice* w)
471 {
472         return w->GetSelection ();
473 }
474
475
476 double
477 wx_get (wxSpinCtrlDouble* w)
478 {
479         return w->GetValue ();
480 }
481
482
483 /** @param s String of the form Context|String
484  *  @return translation, or String if no translation is available.
485  */
486 wxString
487 context_translation (wxString s)
488 {
489         auto t = wxGetTranslation (s);
490         if (t == s) {
491                 /* No translation; strip the context */
492                 int c = t.Find (wxT ("|"));
493                 if (c != wxNOT_FOUND) {
494                         t = t.Mid (c + 1);
495                 }
496         }
497
498         return t;
499 }
500
501
502 wxString
503 time_to_timecode (DCPTime t, double fps)
504 {
505         auto w = t.seconds ();
506         int const h = (w / 3600);
507         w -= h * 3600;
508         int const m = (w / 60);
509         w -= m * 60;
510         int const s = floor (w);
511         w -= s;
512         int const f = lrint (w * fps);
513         return wxString::Format (wxT("%02d:%02d:%02d.%02d"), h, m, s, f);
514 }
515
516
517 void
518 setup_audio_channels_choice (wxChoice* choice, int minimum)
519 {
520         vector<pair<string, string>> items;
521         for (int i = minimum; i <= 16; i += 2) {
522                 if (i == 2) {
523                         items.push_back (make_pair(wx_to_std(_("2 - stereo")), locale_convert<string>(i)));
524                 } else if (i == 4) {
525                         items.push_back (make_pair(wx_to_std(_("4 - L/C/R/Lfe")), locale_convert<string>(i)));
526                 } else if (i == 6) {
527                         items.push_back (make_pair(wx_to_std(_("6 - 5.1")), locale_convert<string>(i)));
528                 } else if (i == 8) {
529                         items.push_back (make_pair(wx_to_std(_("8 - 5.1/HI/VI")), locale_convert<string>(i)));
530                 } else if (i == 12) {
531                         items.push_back (make_pair(wx_to_std(_("12 - 7.1/HI/VI")), locale_convert<string>(i)));
532                 } else {
533                         items.push_back (make_pair(locale_convert<string> (i), locale_convert<string>(i)));
534                 }
535         }
536
537         checked_set (choice, items);
538 }
539
540
541 wxSplashScreen*
542 maybe_show_splash ()
543 {
544         wxSplashScreen* splash = nullptr;
545
546         try {
547                 wxBitmap bitmap;
548                 if (bitmap.LoadFile(bitmap_path("splash.png"), wxBITMAP_TYPE_PNG)) {
549                         {
550                                 /* This wxMemoryDC must be destroyed before bitmap can be used elsewhere */
551                                 wxMemoryDC dc(bitmap);
552                                 auto const version = wxString::Format("%s (%s)", dcpomatic_version, dcpomatic_git_commit);
553                                 auto screen_size = dc.GetSize();
554                                 auto text_size = dc.GetTextExtent(version);
555                                 dc.DrawText(version, (screen_size.GetWidth() - text_size.GetWidth()) / 2, 236);
556                         }
557 #ifdef DCPOMATIC_WINDOWS
558                         /* Having wxSTAY_ON_TOP means error dialogues hide behind the splash screen on Windows, no matter what I try */
559                         splash = new wxSplashScreen(bitmap, wxSPLASH_CENTRE_ON_SCREEN | wxSPLASH_NO_TIMEOUT, 0, nullptr, -1, wxDefaultPosition, wxDefaultSize, wxBORDER_SIMPLE | wxFRAME_NO_TASKBAR);
560 #else
561                         splash = new wxSplashScreen(bitmap, wxSPLASH_CENTRE_ON_SCREEN | wxSPLASH_NO_TIMEOUT, 0, nullptr, -1);
562 #endif
563                         wxYield ();
564                 }
565         } catch (boost::filesystem::filesystem_error& e) {
566                 /* Maybe we couldn't find the splash image; never mind */
567         }
568
569         return splash;
570 }
571
572
573 double
574 calculate_mark_interval (double mark_interval)
575 {
576         if (mark_interval > 5) {
577                 mark_interval -= lrint (mark_interval) % 5;
578         }
579         if (mark_interval > 10) {
580                 mark_interval -= lrint (mark_interval) % 10;
581         }
582         if (mark_interval > 60) {
583                 mark_interval -= lrint (mark_interval) % 60;
584         }
585         if (mark_interval > 3600) {
586                 mark_interval -= lrint (mark_interval) % 3600;
587         }
588
589         if (mark_interval < 1) {
590                 mark_interval = 1;
591         }
592
593         return mark_interval;
594 }
595
596
597 /** @return false if the task was cancelled */
598 bool
599 display_progress (wxString title, wxString task)
600 {
601         auto jm = JobManager::instance ();
602
603         wxProgressDialog progress (title, task, 100, 0, wxPD_CAN_ABORT);
604
605         bool ok = true;
606
607         while (jm->work_to_do()) {
608                 dcpomatic_sleep_seconds (1);
609                 if (!progress.Pulse()) {
610                         /* user pressed cancel */
611                         for (auto i: jm->get()) {
612                                 i->cancel();
613                         }
614                         ok = false;
615                         break;
616                 }
617         }
618
619         return ok;
620 }
621
622
623 int
624 get_offsets (vector<Offset>& offsets)
625 {
626         offsets.push_back (Offset(_("UTC-11"),  -11,  0));
627         offsets.push_back (Offset(_("UTC-10"),  -10,  0));
628         offsets.push_back (Offset(_("UTC-9"),    -9,  0));
629         offsets.push_back (Offset(_("UTC-8"),    -8,  0));
630         offsets.push_back (Offset(_("UTC-7"),    -7,  0));
631         offsets.push_back (Offset(_("UTC-6"),    -6,  0));
632         offsets.push_back (Offset(_("UTC-5"),    -5,  0));
633         offsets.push_back (Offset(_("UTC-4:30"), -4, 30));
634         offsets.push_back (Offset(_("UTC-4"),    -4,  0));
635         offsets.push_back (Offset(_("UTC-3:30"), -3, 30));
636         offsets.push_back (Offset(_("UTC-3"),    -3,  0));
637         offsets.push_back (Offset(_("UTC-2"),    -2,  0));
638         offsets.push_back (Offset(_("UTC-1"),    -1,  0));
639         int utc = offsets.size();
640         offsets.push_back (Offset(_("UTC")  ,     0,  0));
641         offsets.push_back (Offset(_("UTC+1"),     1,  0));
642         offsets.push_back (Offset(_("UTC+2"),     2,  0));
643         offsets.push_back (Offset(_("UTC+3"),     3,  0));
644         offsets.push_back (Offset(_("UTC+4"),     4,  0));
645         offsets.push_back (Offset(_("UTC+5"),     5,  0));
646         offsets.push_back (Offset(_("UTC+5:30"),  5, 30));
647         offsets.push_back (Offset(_("UTC+6"),     6,  0));
648         offsets.push_back (Offset(_("UTC+7"),     7,  0));
649         offsets.push_back (Offset(_("UTC+8"),     8,  0));
650         offsets.push_back (Offset(_("UTC+9"),     9,  0));
651         offsets.push_back (Offset(_("UTC+9:30"),  9, 30));
652         offsets.push_back (Offset(_("UTC+10"),   10,  0));
653         offsets.push_back (Offset(_("UTC+11"),   11,  0));
654         offsets.push_back (Offset(_("UTC+12"),   12,  0));
655
656         return utc;
657 }
658
659
660 wxString
661 bitmap_path (string name)
662 {
663         boost::filesystem::path base;
664
665 #ifdef DCPOMATIC_DEBUG
666         /* Hack to allow Linux and OS X to find icons when running from the source tree */
667         char* path = getenv ("DCPOMATIC_GRAPHICS");
668         if (path) {
669                 base = path;
670         } else {
671                 base = resources_path();
672         }
673
674         if (!boost::filesystem::exists(base / name)) {
675                 base = path / boost::filesystem::path("osx/preferences");
676         }
677 #else
678         base = resources_path();
679 #endif
680
681         auto p = base / name;
682         return std_to_wx (p.string());
683 }
684
685
686 wxString
687 icon_path(string name)
688 {
689         return gui_is_dark() ? bitmap_path(String::compose("%1_white.png", name)) : bitmap_path(String::compose("%1_black.png", name));
690 }
691
692
693 wxSize
694 small_button_size (wxWindow* parent, wxString text)
695 {
696         wxClientDC dc (parent);
697         auto size = dc.GetTextExtent (text);
698         size.SetHeight (-1);
699         size.IncBy (32, 0);
700         return size;
701 }
702
703
704 bool
705 gui_is_dark ()
706 {
707 #if defined(DCPOMATIC_OSX) && wxCHECK_VERSION(3, 1, 0)
708         auto appearance = wxSystemSettings::GetAppearance();
709         return appearance.IsDark();
710 #else
711         return false;
712 #endif
713 }
714
715
716 #if wxCHECK_VERSION(3,1,0)
717 double
718 dpi_scale_factor (wxWindow* window)
719 {
720         return window->GetDPIScaleFactor();
721 }
722 #else
723 double
724 dpi_scale_factor (wxWindow*)
725 {
726         return 1;
727 }
728 #endif
729
730
731
732 int
733 search_ctrl_height ()
734 {
735 #ifdef __WXGTK3__
736         return 30;
737 #else
738         return -1;
739 #endif
740 }
741
742
743 void
744 report_config_load_failure(wxWindow* parent, Config::LoadFailure what)
745 {
746         switch (what) {
747         case Config::LoadFailure::CONFIG:
748                 message_dialog(parent, _("The existing configuration failed to load.  Default values will be used instead.  These may take a short time to create."));
749                 break;
750         case Config::LoadFailure::CINEMAS:
751                 message_dialog(
752                         parent,
753                         _(wxString::Format("The cinemas list for creating KDMs (cinemas.xml) failed to load.  Please check the numbered backup files in %s",
754                                            std_to_wx(Config::instance()->cinemas_file().parent_path().string())))
755                         );
756                 break;
757         case Config::LoadFailure::DKDM_RECIPIENTS:
758                 message_dialog(
759                         parent,
760                         _(wxString::Format("The recipients list for creating DKDMs (dkdm_recipients.xml) failed to load.  Please check the numbered backup files in %s",
761                                            std_to_wx(Config::instance()->dkdm_recipients_file().parent_path().string())))
762                         );
763                 break;
764         }
765 }
766