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;
50 create_label (wxWindow* p, wxString t, bool left)
52 create_label (wxWindow* p, wxString t, bool)
60 return new StaticText (p, t);
63 /** Add a wxStaticText to a wxSizer, aligning it at vertical centre.
64 * @param s Sizer to add to.
65 * @param p Parent window for the wxStaticText.
66 * @param t Text for the wxStaticText.
67 * @param left true if this label is a `left label'; ie the sort
68 * of label which should be right-aligned on OS X.
69 * @param prop Proportion to pass when calling Add() on the wxSizer.
72 add_label_to_sizer (wxSizer* s, wxWindow* p, wxString t, bool left, int prop, int flags)
76 flags |= wxALIGN_RIGHT;
79 wxStaticText* m = create_label (p, t, left);
80 s->Add (m, prop, flags, 6);
86 add_label_to_sizer (wxSizer* s, wxStaticText* t, bool left, int prop, int flags)
88 add_label_to_sizer (wxSizer* s, wxStaticText* t, bool, int prop, int flags)
93 flags |= wxALIGN_RIGHT;
96 s->Add (t, prop, flags, 6);
101 add_label_to_sizer (wxGridBagSizer* s, wxWindow* p, wxString t, bool left, wxGBPosition pos, wxGBSpan span)
103 int flags = wxALIGN_CENTER_VERTICAL | wxLEFT | wxRIGHT;
106 flags |= wxALIGN_RIGHT;
109 wxStaticText* m = create_label (p, t, left);
110 s->Add (m, pos, span, flags);
116 add_label_to_sizer (wxGridBagSizer* s, wxStaticText* t, bool left, wxGBPosition pos, wxGBSpan span)
118 add_label_to_sizer (wxGridBagSizer* s, wxStaticText* t, bool, wxGBPosition pos, wxGBSpan span)
121 int flags = wxALIGN_CENTER_VERTICAL | wxLEFT | wxRIGHT;
124 flags |= wxALIGN_RIGHT;
127 s->Add (t, pos, span, flags);
131 /** Pop up an error dialogue box.
132 * @param parent Parent.
134 * @param e Extended message.
137 error_dialog (wxWindow* parent, wxString m, optional<wxString> e)
139 wxMessageDialog* d = new wxMessageDialog (parent, m, _("DCP-o-matic"), wxOK | wxICON_ERROR);
142 em[0] = wxToupper (em[0]);
143 d->SetExtendedMessage (em);
149 /** Pop up an error dialogue box.
150 * @param parent Parent.
154 message_dialog (wxWindow* parent, wxString m)
156 wxMessageDialog* d = new wxMessageDialog (parent, m, _("DCP-o-matic"), wxOK | wxICON_INFORMATION);
161 /** @return true if the user answered "yes" */
163 confirm_dialog (wxWindow* parent, wxString m)
165 wxMessageDialog* d = new wxMessageDialog (parent, m, _("DCP-o-matic"), wxYES_NO | wxICON_QUESTION);
166 int const r = d->ShowModal ();
168 return r == wxID_YES;
172 /** @param s wxWidgets string.
173 * @return Corresponding STL string.
176 wx_to_std (wxString s)
178 return string (s.ToUTF8 ());
181 /** @param s STL string.
182 * @return Corresponding wxWidgets string.
187 return wxString (s.c_str(), wxConvUTF8);
191 string_client_data (wxClientData* o)
193 return wx_to_std (dynamic_cast<wxStringClientData*>(o)->GetData());
197 checked_set (FilePickerCtrl* widget, boost::filesystem::path value)
199 if (widget->GetPath() != std_to_wx (value.string())) {
201 /* Hack to make wxWidgets clear the control when we are passed
206 widget->SetPath (std_to_wx (value.string()));
211 checked_set (wxDirPickerCtrl* widget, boost::filesystem::path value)
213 if (widget->GetPath() != std_to_wx (value.string())) {
215 /* Hack to make wxWidgets clear the control when we are passed
220 widget->SetPath (std_to_wx (value.string()));
225 checked_set (wxSpinCtrl* widget, int value)
227 if (widget->GetValue() != value) {
228 widget->SetValue (value);
233 checked_set (wxSpinCtrlDouble* widget, double value)
235 /* XXX: completely arbitrary epsilon */
236 if (fabs (widget->GetValue() - value) > 1e-16) {
237 widget->SetValue (value);
242 checked_set (wxChoice* widget, int value)
244 if (widget->GetSelection() != value) {
245 widget->SetSelection (value);
250 checked_set (wxChoice* widget, string value)
253 if (widget->GetSelection() != -1) {
254 o = widget->GetClientObject (widget->GetSelection ());
257 if (!o || string_client_data(o) != value) {
258 for (unsigned int i = 0; i < widget->GetCount(); ++i) {
259 if (string_client_data (widget->GetClientObject (i)) == value) {
260 widget->SetSelection (i);
267 checked_set (wxChoice* widget, vector<pair<string, string> > items)
269 vector<pair<string, string> > current;
270 for (unsigned int i = 0; i < widget->GetCount(); ++i) {
273 wx_to_std (widget->GetString (i)),
274 string_client_data (widget->GetClientObject (i))
279 if (current == items) {
284 for (vector<pair<string, string> >::const_iterator i = items.begin(); i != items.end(); ++i) {
285 widget->Append (std_to_wx (i->first), new wxStringClientData (std_to_wx (i->second)));
290 checked_set (wxTextCtrl* widget, string value)
292 if (widget->GetValue() != std_to_wx (value)) {
293 widget->ChangeValue (std_to_wx (value));
298 checked_set (PasswordEntry* entry, string value)
300 if (entry->get() != value) {
306 checked_set (wxTextCtrl* widget, wxString value)
308 if (widget->GetValue() != value) {
309 widget->ChangeValue (value);
314 checked_set (wxStaticText* widget, string value)
316 if (widget->GetLabel() != std_to_wx (value)) {
317 widget->SetLabel (std_to_wx (value));
322 checked_set (wxStaticText* widget, wxString value)
324 if (widget->GetLabel() != value) {
325 widget->SetLabel (value);
330 checked_set (wxCheckBox* widget, bool value)
332 if (widget->GetValue() != value) {
333 widget->SetValue (value);
338 checked_set (wxRadioButton* widget, bool value)
340 if (widget->GetValue() != value) {
341 widget->SetValue (value);
346 dcpomatic_setup_i18n ()
348 int language = wxLANGUAGE_DEFAULT;
350 boost::optional<string> config_lang = Config::instance()->language ();
351 if (config_lang && !config_lang->empty ()) {
352 wxLanguageInfo const * li = wxLocale::FindLanguageInfo (std_to_wx (config_lang.get ()));
354 language = li->Language;
358 wxLocale* locale = 0;
359 if (wxLocale::IsAvailable (language)) {
360 locale = new wxLocale (language, wxLOCALE_LOAD_DEFAULT);
362 #ifdef DCPOMATIC_WINDOWS
363 locale->AddCatalogLookupPathPrefix (std_to_wx (mo_path().string()));
366 #ifdef DCPOMATIC_LINUX
367 locale->AddCatalogLookupPathPrefix (LINUX_LOCALE_PREFIX);
369 /* We have to include the wxWidgets .mo in our distribution,
370 so we rename it to avoid clashes with any other installation
373 locale->AddCatalog (wxT ("dcpomatic2-wxstd"));
375 /* Fedora 29 (at least) installs wxstd3.mo instead of wxstd.mo */
376 locale->AddCatalog (wxT ("wxstd3"));
379 locale->AddCatalog (wxT ("libdcpomatic2-wx"));
380 locale->AddCatalog (wxT ("dcpomatic2"));
382 if (!locale->IsOk()) {
384 locale = new wxLocale (wxLANGUAGE_ENGLISH);
389 dcpomatic_setup_gettext_i18n (wx_to_std (locale->GetCanonicalName ()));
394 wx_get (wxSpinCtrl* w)
396 return w->GetValue ();
402 return w->GetSelection ();
406 wx_get (wxSpinCtrlDouble* w)
408 return w->GetValue ();
411 /** @param s String of the form Context|String
412 * @return translation, or String if no translation is available.
415 context_translation (wxString s)
417 wxString t = wxGetTranslation (s);
419 /* No translation; strip the context */
420 int c = t.Find (wxT ("|"));
421 if (c != wxNOT_FOUND) {
430 time_to_timecode (DCPTime t, double fps)
432 double w = t.seconds ();
433 int const h = (w / 3600);
435 int const m = (w / 60);
437 int const s = floor (w);
439 int const f = lrint (w * fps);
440 return wxString::Format (wxT("%02d:%02d:%02d.%02d"), h, m, s, f);
444 setup_audio_channels_choice (wxChoice* choice, int minimum)
446 vector<pair<string, string> > items;
447 for (int i = minimum; i <= 16; i += 2) {
449 items.push_back (make_pair (wx_to_std (_("2 - stereo")), locale_convert<string> (i)));
451 items.push_back (make_pair (wx_to_std (_("4 - L/C/R/Lfe")), locale_convert<string> (i)));
453 items.push_back (make_pair (wx_to_std (_("6 - 5.1")), locale_convert<string> (i)));
455 items.push_back (make_pair (wx_to_std (_("8 - 5.1/HI/VI")), locale_convert<string> (i)));
456 } else if (i == 12) {
457 items.push_back (make_pair (wx_to_std (_("12 - 7.1/HI/VI")), locale_convert<string> (i)));
459 items.push_back (make_pair (locale_convert<string> (i), locale_convert<string> (i)));
463 checked_set (choice, items);
469 wxSplashScreen* splash = 0;
472 boost::filesystem::path p = shared_path () / "splash.png";
473 if (bitmap.LoadFile (std_to_wx (p.string ()), wxBITMAP_TYPE_PNG)) {
474 splash = new wxSplashScreen (bitmap, wxSPLASH_CENTRE_ON_SCREEN | wxSPLASH_NO_TIMEOUT, 0, 0, -1);
477 } catch (boost::filesystem::filesystem_error& e) {
478 /* Maybe we couldn't find the splash image; never mind */
485 calculate_mark_interval (double mark_interval)
487 if (mark_interval > 5) {
488 mark_interval -= lrint (mark_interval) % 5;
490 if (mark_interval > 10) {
491 mark_interval -= lrint (mark_interval) % 10;
493 if (mark_interval > 60) {
494 mark_interval -= lrint (mark_interval) % 60;
496 if (mark_interval > 3600) {
497 mark_interval -= lrint (mark_interval) % 3600;
500 if (mark_interval < 1) {
504 return mark_interval;
508 /** @return false if the task was cancelled */
510 display_progress (wxString title, wxString task)
512 JobManager* jm = JobManager::instance ();
514 wxProgressDialog progress (title, task, 100, 0, wxPD_CAN_ABORT);
518 while (jm->work_to_do()) {
520 if (!progress.Pulse()) {
521 /* user pressed cancel */
522 BOOST_FOREACH (shared_ptr<Job> i, jm->get()) {
534 report_errors_from_last_job (wxWindow* parent)
536 JobManager* jm = JobManager::instance ();
538 DCPOMATIC_ASSERT (!jm->get().empty());
540 shared_ptr<Job> last = jm->get().back();
541 if (last->finished_in_error()) {
542 error_dialog(parent, std_to_wx(last->error_summary()) + ".\n", std_to_wx(last->error_details()));