2 Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
21 /** @file src/wx/wx_util.cc
22 * @brief Some utility functions and classes.
26 #include "file_picker_ctrl.h"
27 #include "static_text.h"
28 #include "password_entry.h"
29 #include "lib/config.h"
30 #include "lib/job_manager.h"
32 #include "lib/cross.h"
34 #include <dcp/locale_convert.h>
35 #include <wx/spinctrl.h>
36 #include <wx/splash.h>
37 #include <wx/progdlg.h>
38 #include <wx/filepicker.h>
39 #include <boost/thread.hpp>
44 using boost::shared_ptr;
45 using boost::optional;
46 using dcp::locale_convert;
47 using namespace dcpomatic;
51 create_label (wxWindow* p, wxString t, bool left)
53 create_label (wxWindow* p, wxString t, bool)
61 return new StaticText (p, t);
64 /** Add a wxStaticText to a wxSizer, aligning it at vertical centre.
65 * @param s Sizer to add to.
66 * @param p Parent window for the wxStaticText.
67 * @param t Text for the wxStaticText.
68 * @param left true if this label is a `left label'; ie the sort
69 * of label which should be right-aligned on OS X.
70 * @param prop Proportion to pass when calling Add() on the wxSizer.
73 add_label_to_sizer (wxSizer* s, wxWindow* p, wxString t, bool left, int prop, int flags)
77 flags |= wxALIGN_RIGHT;
80 wxStaticText* m = create_label (p, t, left);
81 s->Add (m, prop, flags, 6);
87 add_label_to_sizer (wxSizer* s, wxStaticText* t, bool left, int prop, int flags)
89 add_label_to_sizer (wxSizer* s, wxStaticText* t, bool, int prop, int flags)
94 flags |= wxALIGN_RIGHT;
97 s->Add (t, prop, flags, 6);
102 add_label_to_sizer (wxGridBagSizer* s, wxWindow* p, wxString t, bool left, wxGBPosition pos, wxGBSpan span)
104 int flags = wxALIGN_CENTER_VERTICAL | wxLEFT | wxRIGHT;
107 flags |= wxALIGN_RIGHT;
110 wxStaticText* m = create_label (p, t, left);
111 s->Add (m, pos, span, flags);
117 add_label_to_sizer (wxGridBagSizer* s, wxStaticText* t, bool left, wxGBPosition pos, wxGBSpan span)
119 add_label_to_sizer (wxGridBagSizer* s, wxStaticText* t, bool, wxGBPosition pos, wxGBSpan span)
122 int flags = wxALIGN_CENTER_VERTICAL | wxLEFT | wxRIGHT;
125 flags |= wxALIGN_RIGHT;
128 s->Add (t, pos, span, flags);
132 /** Pop up an error dialogue box.
133 * @param parent Parent.
135 * @param e Extended message.
138 error_dialog (wxWindow* parent, wxString m, optional<wxString> e)
140 wxMessageDialog* d = new wxMessageDialog (parent, m, _("DCP-o-matic"), wxOK | wxICON_ERROR);
143 em[0] = wxToupper (em[0]);
144 d->SetExtendedMessage (em);
150 /** Pop up an error dialogue box.
151 * @param parent Parent.
155 message_dialog (wxWindow* parent, wxString m)
157 wxMessageDialog* d = new wxMessageDialog (parent, m, _("DCP-o-matic"), wxOK | wxICON_INFORMATION);
162 /** @return true if the user answered "yes" */
164 confirm_dialog (wxWindow* parent, wxString m)
166 wxMessageDialog* d = new wxMessageDialog (parent, m, _("DCP-o-matic"), wxYES_NO | wxICON_QUESTION);
167 int const r = d->ShowModal ();
169 return r == wxID_YES;
173 /** @param s wxWidgets string.
174 * @return Corresponding STL string.
177 wx_to_std (wxString s)
179 return string (s.ToUTF8 ());
182 /** @param s STL string.
183 * @return Corresponding wxWidgets string.
188 return wxString (s.c_str(), wxConvUTF8);
192 string_client_data (wxClientData* o)
194 return wx_to_std (dynamic_cast<wxStringClientData*>(o)->GetData());
198 checked_set (FilePickerCtrl* widget, boost::filesystem::path value)
200 if (widget->GetPath() != std_to_wx (value.string())) {
202 /* Hack to make wxWidgets clear the control when we are passed
207 widget->SetPath (std_to_wx (value.string()));
212 checked_set (wxDirPickerCtrl* widget, boost::filesystem::path value)
214 if (widget->GetPath() != std_to_wx (value.string())) {
216 /* Hack to make wxWidgets clear the control when we are passed
221 widget->SetPath (std_to_wx (value.string()));
226 checked_set (wxSpinCtrl* widget, int value)
228 if (widget->GetValue() != value) {
229 widget->SetValue (value);
234 checked_set (wxSpinCtrlDouble* widget, double value)
236 /* XXX: completely arbitrary epsilon */
237 if (fabs (widget->GetValue() - value) > 1e-16) {
238 widget->SetValue (value);
243 checked_set (wxChoice* widget, int value)
245 if (widget->GetSelection() != value) {
246 widget->SetSelection (value);
251 checked_set (wxChoice* widget, string value)
254 if (widget->GetSelection() != -1) {
255 o = widget->GetClientObject (widget->GetSelection ());
258 if (!o || string_client_data(o) != value) {
259 for (unsigned int i = 0; i < widget->GetCount(); ++i) {
260 if (string_client_data (widget->GetClientObject (i)) == value) {
261 widget->SetSelection (i);
268 checked_set (wxChoice* widget, vector<pair<string, string> > items)
270 vector<pair<string, string> > current;
271 for (unsigned int i = 0; i < widget->GetCount(); ++i) {
274 wx_to_std (widget->GetString (i)),
275 string_client_data (widget->GetClientObject (i))
280 if (current == items) {
285 for (vector<pair<string, string> >::const_iterator i = items.begin(); i != items.end(); ++i) {
286 widget->Append (std_to_wx (i->first), new wxStringClientData (std_to_wx (i->second)));
291 checked_set (wxTextCtrl* widget, string value)
293 if (widget->GetValue() != std_to_wx (value)) {
294 widget->ChangeValue (std_to_wx (value));
299 checked_set (PasswordEntry* entry, string value)
301 if (entry->get() != value) {
307 checked_set (wxTextCtrl* widget, wxString value)
309 if (widget->GetValue() != value) {
310 widget->ChangeValue (value);
315 checked_set (wxStaticText* widget, string value)
317 if (widget->GetLabel() != std_to_wx (value)) {
318 widget->SetLabel (std_to_wx (value));
323 checked_set (wxStaticText* widget, wxString value)
325 if (widget->GetLabel() != value) {
326 widget->SetLabel (value);
331 checked_set (wxCheckBox* widget, bool value)
333 if (widget->GetValue() != value) {
334 widget->SetValue (value);
339 checked_set (wxRadioButton* widget, bool value)
341 if (widget->GetValue() != value) {
342 widget->SetValue (value);
347 dcpomatic_setup_i18n ()
349 int language = wxLANGUAGE_DEFAULT;
351 boost::optional<string> config_lang = Config::instance()->language ();
352 if (config_lang && !config_lang->empty ()) {
353 wxLanguageInfo const * li = wxLocale::FindLanguageInfo (std_to_wx (config_lang.get ()));
355 language = li->Language;
359 wxLocale* locale = 0;
360 if (wxLocale::IsAvailable (language)) {
361 locale = new wxLocale (language, wxLOCALE_LOAD_DEFAULT);
363 #ifdef DCPOMATIC_WINDOWS
364 locale->AddCatalogLookupPathPrefix (std_to_wx (mo_path().string()));
367 #ifdef DCPOMATIC_LINUX
368 locale->AddCatalogLookupPathPrefix (LINUX_LOCALE_PREFIX);
370 /* We have to include the wxWidgets .mo in our distribution,
371 so we rename it to avoid clashes with any other installation
374 locale->AddCatalog (wxT ("dcpomatic2-wxstd"));
376 /* Fedora 29 (at least) installs wxstd3.mo instead of wxstd.mo */
377 locale->AddCatalog (wxT ("wxstd3"));
380 locale->AddCatalog (wxT ("libdcpomatic2-wx"));
381 locale->AddCatalog (wxT ("dcpomatic2"));
383 if (!locale->IsOk()) {
385 locale = new wxLocale (wxLANGUAGE_ENGLISH);
390 dcpomatic_setup_gettext_i18n (wx_to_std (locale->GetCanonicalName ()));
395 wx_get (wxSpinCtrl* w)
397 return w->GetValue ();
403 return w->GetSelection ();
407 wx_get (wxSpinCtrlDouble* w)
409 return w->GetValue ();
412 /** @param s String of the form Context|String
413 * @return translation, or String if no translation is available.
416 context_translation (wxString s)
418 wxString t = wxGetTranslation (s);
420 /* No translation; strip the context */
421 int c = t.Find (wxT ("|"));
422 if (c != wxNOT_FOUND) {
431 time_to_timecode (DCPTime t, double fps)
433 double w = t.seconds ();
434 int const h = (w / 3600);
436 int const m = (w / 60);
438 int const s = floor (w);
440 int const f = lrint (w * fps);
441 return wxString::Format (wxT("%02d:%02d:%02d.%02d"), h, m, s, f);
445 setup_audio_channels_choice (wxChoice* choice, int minimum)
447 vector<pair<string, string> > items;
448 for (int i = minimum; i <= 16; i += 2) {
450 items.push_back (make_pair (wx_to_std (_("2 - stereo")), locale_convert<string> (i)));
452 items.push_back (make_pair (wx_to_std (_("4 - L/C/R/Lfe")), locale_convert<string> (i)));
454 items.push_back (make_pair (wx_to_std (_("6 - 5.1")), locale_convert<string> (i)));
456 items.push_back (make_pair (wx_to_std (_("8 - 5.1/HI/VI")), locale_convert<string> (i)));
457 } else if (i == 12) {
458 items.push_back (make_pair (wx_to_std (_("12 - 7.1/HI/VI")), locale_convert<string> (i)));
460 items.push_back (make_pair (locale_convert<string> (i), locale_convert<string> (i)));
464 checked_set (choice, items);
470 wxSplashScreen* splash = 0;
473 boost::filesystem::path p = shared_path () / "splash.png";
474 if (bitmap.LoadFile (std_to_wx (p.string ()), wxBITMAP_TYPE_PNG)) {
475 splash = new wxSplashScreen (bitmap, wxSPLASH_CENTRE_ON_SCREEN | wxSPLASH_NO_TIMEOUT, 0, 0, -1);
478 } catch (boost::filesystem::filesystem_error& e) {
479 /* Maybe we couldn't find the splash image; never mind */
486 calculate_mark_interval (double mark_interval)
488 if (mark_interval > 5) {
489 mark_interval -= lrint (mark_interval) % 5;
491 if (mark_interval > 10) {
492 mark_interval -= lrint (mark_interval) % 10;
494 if (mark_interval > 60) {
495 mark_interval -= lrint (mark_interval) % 60;
497 if (mark_interval > 3600) {
498 mark_interval -= lrint (mark_interval) % 3600;
501 if (mark_interval < 1) {
505 return mark_interval;
509 /** @return false if the task was cancelled */
511 display_progress (wxString title, wxString task)
513 JobManager* jm = JobManager::instance ();
515 wxProgressDialog progress (title, task, 100, 0, wxPD_CAN_ABORT);
519 while (jm->work_to_do()) {
520 dcpomatic_sleep_seconds (1);
521 if (!progress.Pulse()) {
522 /* user pressed cancel */
523 BOOST_FOREACH (shared_ptr<Job> i, jm->get()) {
536 get_offsets (vector<Offset>& offsets)
538 offsets.push_back (Offset(_("UTC-11"), -11, 0));
539 offsets.push_back (Offset(_("UTC-10"), -10, 0));
540 offsets.push_back (Offset(_("UTC-9"), -9, 0));
541 offsets.push_back (Offset(_("UTC-8"), -8, 0));
542 offsets.push_back (Offset(_("UTC-7"), -7, 0));
543 offsets.push_back (Offset(_("UTC-6"), -6, 0));
544 offsets.push_back (Offset(_("UTC-5"), -5, 0));
545 offsets.push_back (Offset(_("UTC-4:30"), -4, 30));
546 offsets.push_back (Offset(_("UTC-4"), -4, 0));
547 offsets.push_back (Offset(_("UTC-3:30"), -3, 30));
548 offsets.push_back (Offset(_("UTC-3"), -3, 0));
549 offsets.push_back (Offset(_("UTC-2"), -2, 0));
550 offsets.push_back (Offset(_("UTC-1"), -1, 0));
551 int utc = offsets.size();
552 offsets.push_back (Offset(_("UTC") , 0, 0));
553 offsets.push_back (Offset(_("UTC+1"), 1, 0));
554 offsets.push_back (Offset(_("UTC+2"), 2, 0));
555 offsets.push_back (Offset(_("UTC+3"), 3, 0));
556 offsets.push_back (Offset(_("UTC+4"), 4, 0));
557 offsets.push_back (Offset(_("UTC+5"), 5, 0));
558 offsets.push_back (Offset(_("UTC+5:30"), 5, 30));
559 offsets.push_back (Offset(_("UTC+6"), 6, 0));
560 offsets.push_back (Offset(_("UTC+7"), 7, 0));
561 offsets.push_back (Offset(_("UTC+8"), 8, 0));
562 offsets.push_back (Offset(_("UTC+9"), 9, 0));
563 offsets.push_back (Offset(_("UTC+9:30"), 9, 30));
564 offsets.push_back (Offset(_("UTC+10"), 10, 0));
565 offsets.push_back (Offset(_("UTC+11"), 11, 0));
566 offsets.push_back (Offset(_("UTC+12"), 12, 0));