2 Copyright (C) 2021 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/>.
22 #include "dcpomatic_button.h"
23 #include "editable_list.h"
24 #include "full_language_tag_dialog.h"
25 #include "language_tag_widget.h"
26 #include "metadata_dialog.h"
27 #include "rating_dialog.h"
30 #include <dcp/warnings.h>
31 LIBDCP_DISABLE_WARNINGS
32 #include <wx/notebook.h>
33 #include <wx/spinctrl.h>
35 LIBDCP_ENABLE_WARNINGS
36 #include <boost/bind.hpp>
37 #include <boost/weak_ptr.hpp>
44 MetadataDialog::MetadataDialog (wxWindow* parent, weak_ptr<Film> weak_film)
45 : wxDialog (parent, wxID_ANY, _("Metadata"))
46 , WeakFilm (weak_film)
48 for (auto system: dcp::rating_systems()) {
49 _rating_system_agency_to_name[system.agency] = system.name;
55 MetadataDialog::setup ()
57 auto notebook = new wxNotebook (this, wxID_ANY);
59 auto prepare = [notebook](std::function<void (wxPanel*, wxSizer*)> setup, wxString name) {
60 auto panel = new wxPanel (notebook, wxID_ANY);
61 auto sizer = new wxFlexGridSizer (2, DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
62 sizer->AddGrowableCol (1, 1);
64 auto overall_sizer = new wxBoxSizer (wxVERTICAL);
65 overall_sizer->Add (sizer, 1, wxEXPAND | wxALL, DCPOMATIC_DIALOG_BORDER);
66 panel->SetSizer (overall_sizer);
67 notebook->AddPage (panel, name);
70 prepare (boost::bind(&MetadataDialog::setup_standard, this, _1, _2), _("Standard"));
71 prepare (boost::bind(&MetadataDialog::setup_advanced, this, _1, _2), _("Advanced"));
73 auto overall_sizer = new wxBoxSizer (wxVERTICAL);
74 overall_sizer->Add (notebook, 1, wxEXPAND | wxALL, DCPOMATIC_DIALOG_BORDER);
76 auto buttons = CreateSeparatedButtonSizer (wxCLOSE);
78 overall_sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
81 SetSizer (overall_sizer);
82 overall_sizer->Layout ();
83 overall_sizer->SetSizeHints (this);
85 _sign_language_video_language->Changed.connect (boost::bind(&MetadataDialog::sign_language_video_language_changed, this));
86 _edit_release_territory->Bind (wxEVT_BUTTON, boost::bind(&MetadataDialog::edit_release_territory, this));
87 _enable_release_territory->Bind (wxEVT_CHECKBOX, boost::bind(&MetadataDialog::enable_release_territory_changed, this));
88 _enable_facility->Bind (wxEVT_CHECKBOX, boost::bind(&MetadataDialog::enable_facility_changed, this));
89 _facility->Bind (wxEVT_TEXT, boost::bind(&MetadataDialog::facility_changed, this));
90 _enable_studio->Bind (wxEVT_CHECKBOX, boost::bind(&MetadataDialog::enable_studio_changed, this));
91 _studio->Bind (wxEVT_TEXT, boost::bind(&MetadataDialog::studio_changed, this));
92 _enable_chain->Bind (wxEVT_CHECKBOX, boost::bind(&MetadataDialog::enable_chain_changed, this));
93 _chain->Bind (wxEVT_TEXT, boost::bind(&MetadataDialog::chain_changed, this));
94 _temp_version->Bind (wxEVT_CHECKBOX, boost::bind(&MetadataDialog::temp_version_changed, this));
95 _pre_release->Bind (wxEVT_CHECKBOX, boost::bind(&MetadataDialog::pre_release_changed, this));
96 _red_band->Bind (wxEVT_CHECKBOX, boost::bind(&MetadataDialog::red_band_changed, this));
97 _two_d_version_of_three_d->Bind (wxEVT_CHECKBOX, boost::bind(&MetadataDialog::two_d_version_of_three_d_changed, this));
98 _enable_luminance->Bind (wxEVT_CHECKBOX, boost::bind(&MetadataDialog::enable_luminance_changed, this));
99 _luminance_value->Bind (wxEVT_SPINCTRLDOUBLE, boost::bind(&MetadataDialog::luminance_changed, this));
100 _luminance_unit->Bind (wxEVT_CHOICE, boost::bind(&MetadataDialog::luminance_changed, this));
102 _film_changed_connection = film()->Change.connect(boost::bind(&MetadataDialog::film_changed, this, _1, _2));
104 film_changed (ChangeType::DONE, Film::Property::RELEASE_TERRITORY);
105 film_changed (ChangeType::DONE, Film::Property::SIGN_LANGUAGE_VIDEO_LANGUAGE);
106 film_changed (ChangeType::DONE, Film::Property::FACILITY);
107 film_changed (ChangeType::DONE, Film::Property::STUDIO);
108 film_changed (ChangeType::DONE, Film::Property::TEMP_VERSION);
109 film_changed (ChangeType::DONE, Film::Property::PRE_RELEASE);
110 film_changed (ChangeType::DONE, Film::Property::RED_BAND);
111 film_changed (ChangeType::DONE, Film::Property::TWO_D_VERSION_OF_THREE_D);
112 film_changed (ChangeType::DONE, Film::Property::CHAIN);
113 film_changed (ChangeType::DONE, Film::Property::LUMINANCE);
115 setup_sensitivity ();
120 MetadataDialog::film_changed (ChangeType type, Film::Property property)
122 if (type != ChangeType::DONE) {
126 if (property == Film::Property::SIGN_LANGUAGE_VIDEO_LANGUAGE) {
127 _sign_language_video_language->set (film()->sign_language_video_language());
128 } else if (property == Film::Property::RELEASE_TERRITORY) {
129 auto rt = film()->release_territory();
130 checked_set (_enable_release_territory, static_cast<bool>(rt));
132 _release_territory = *rt;
133 checked_set (_release_territory_text, std_to_wx(*dcp::LanguageTag::get_subtag_description(*_release_territory)));
135 } else if (property == Film::Property::FACILITY) {
136 checked_set (_enable_facility, static_cast<bool>(film()->facility()));
137 if (film()->facility()) {
138 checked_set (_facility, *film()->facility());
140 } else if (property == Film::Property::STUDIO) {
141 checked_set (_enable_studio, static_cast<bool>(film()->studio()));
142 if (film()->studio()) {
143 checked_set (_studio, *film()->studio());
145 } else if (property == Film::Property::CHAIN) {
146 checked_set (_enable_chain, static_cast<bool>(film()->chain()));
147 if (film()->chain()) {
148 checked_set (_chain, *film()->chain());
150 } else if (property == Film::Property::TEMP_VERSION) {
151 checked_set (_temp_version, film()->temp_version());
152 } else if (property == Film::Property::PRE_RELEASE) {
153 checked_set (_pre_release, film()->pre_release());
154 } else if (property == Film::Property::RED_BAND) {
155 checked_set (_red_band, film()->red_band());
156 } else if (property == Film::Property::TWO_D_VERSION_OF_THREE_D) {
157 checked_set (_two_d_version_of_three_d, film()->two_d_version_of_three_d());
158 } else if (property == Film::Property::LUMINANCE) {
159 auto lum = film()->luminance();
160 checked_set (_enable_luminance, static_cast<bool>(lum));
162 checked_set (_luminance_value, lum->value());
163 switch (lum->unit()) {
164 case dcp::Luminance::Unit::CANDELA_PER_SQUARE_METRE:
165 checked_set (_luminance_unit, 0);
167 case dcp::Luminance::Unit::FOOT_LAMBERT:
168 checked_set (_luminance_unit, 1);
172 checked_set (_luminance_unit, 1);
179 MetadataDialog::setup_standard (wxPanel* panel, wxSizer* sizer)
181 _enable_release_territory = new wxCheckBox (panel, wxID_ANY, _("Release territory"));
182 sizer->Add (_enable_release_territory, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
184 auto s = new wxBoxSizer (wxHORIZONTAL);
185 _release_territory_text = new wxStaticText (panel, wxID_ANY, wxT(""));
186 s->Add (_release_territory_text, 1, wxLEFT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_X_GAP);
187 _edit_release_territory = new Button (panel, _("Edit..."));
188 s->Add (_edit_release_territory, 0, wxLEFT, DCPOMATIC_SIZER_GAP);
189 sizer->Add (s, 0, wxEXPAND);
192 vector<EditableListColumn> columns;
193 columns.push_back(EditableListColumn("Agency", 200, true));
194 columns.push_back(EditableListColumn("Label", 400, true));
195 _ratings = new EditableList<dcp::Rating, RatingDialog> (
198 boost::bind(&MetadataDialog::ratings, this),
199 boost::bind(&MetadataDialog::set_ratings, this, _1),
200 [this](dcp::Rating r, int c) {
202 auto iter = _rating_system_agency_to_name.find(r.agency);
203 if (iter != _rating_system_agency_to_name.end()) {
210 EditableListTitle::VISIBLE,
211 EditableListButton::NEW | EditableListButton::EDIT | EditableListButton::REMOVE
213 _ratings->SetMinSize(wxSize(600, -1));
218 MetadataDialog::edit_release_territory ()
220 DCPOMATIC_ASSERT (film()->release_territory());
221 auto d = new RegionSubtagDialog(this, *film()->release_territory());
225 _release_territory = *tag;
226 film()->set_release_territory(*tag);
233 MetadataDialog::setup_sensitivity ()
235 _sign_language_video_language->enable (film()->has_sign_language_video_channel());
236 auto const enabled = _enable_release_territory->GetValue();
237 _release_territory_text->Enable (enabled);
238 _edit_release_territory->Enable (enabled);
239 _facility->Enable (_enable_facility->GetValue());
240 _chain->Enable (_enable_chain->GetValue());
241 _studio->Enable (_enable_studio->GetValue());
242 _luminance_value->Enable (_enable_luminance->GetValue());
243 _luminance_unit->Enable (_enable_luminance->GetValue());
248 MetadataDialog::enable_release_territory_changed ()
250 setup_sensitivity ();
251 if (_enable_release_territory->GetValue()) {
252 film()->set_release_territory (_release_territory.get_value_or(dcp::LanguageTag::RegionSubtag("US")));
254 film()->set_release_territory ();
260 MetadataDialog::setup_advanced (wxPanel* panel, wxSizer* sizer)
262 add_label_to_sizer (sizer, panel, _("Sign language video language"), true, 0, wxALIGN_CENTER_VERTICAL | wxLEFT | wxRIGHT);
263 _sign_language_video_language = new LanguageTagWidget (panel, _("Language used for any sign language video track"), {}, {});
264 sizer->Add (_sign_language_video_language->sizer(), 1, wxEXPAND);
266 _enable_facility = new wxCheckBox (panel, wxID_ANY, _("Facility"));
267 sizer->Add (_enable_facility, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL);
268 _facility = new wxTextCtrl (panel, wxID_ANY);
269 sizer->Add (_facility, 1, wxEXPAND);
271 _enable_studio = new wxCheckBox (panel, wxID_ANY, _("Studio"));
272 sizer->Add (_enable_studio, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL);
273 _studio = new wxTextCtrl (panel, wxID_ANY);
274 sizer->Add (_studio, 1, wxEXPAND);
276 _enable_chain = new wxCheckBox (panel, wxID_ANY, _("Chain"));
277 sizer->Add (_enable_chain, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL);
278 _chain = new wxTextCtrl (panel, wxID_ANY);
279 sizer->Add (_chain, 1, wxEXPAND);
281 _temp_version = new wxCheckBox (panel, wxID_ANY, _("Temporary version"));
282 sizer->Add (_temp_version, 0, wxALIGN_CENTER_VERTICAL);
283 sizer->AddSpacer (0);
285 _pre_release = new wxCheckBox (panel, wxID_ANY, _("Pre-release"));
286 sizer->Add (_pre_release, 0, wxALIGN_CENTER_VERTICAL);
287 sizer->AddSpacer (0);
289 _red_band = new wxCheckBox (panel, wxID_ANY, _("Red band"));
290 sizer->Add (_red_band, 0, wxALIGN_CENTER_VERTICAL);
291 sizer->AddSpacer (0);
293 _two_d_version_of_three_d = new wxCheckBox (panel, wxID_ANY, _("2D version of 3D DCP"));
294 sizer->Add (_two_d_version_of_three_d, 0, wxALIGN_CENTER_VERTICAL);
295 sizer->AddSpacer (0);
297 _enable_luminance = new wxCheckBox (panel, wxID_ANY, _("Luminance"));
298 sizer->Add (_enable_luminance, 0, wxALIGN_CENTER_VERTICAL);
300 auto s = new wxBoxSizer (wxHORIZONTAL);
301 _luminance_value = new wxSpinCtrlDouble (panel, wxID_ANY);
302 _luminance_value->SetRange (0.1, 32.0);
303 _luminance_value->SetDigits (1);
304 _luminance_value->SetIncrement (0.1);
305 s->Add (_luminance_value, 0);
306 _luminance_unit = new wxChoice (panel, wxID_ANY);
307 s->Add (_luminance_unit, 0, wxLEFT, DCPOMATIC_SIZER_X_GAP);
308 sizer->Add (s, 1, wxEXPAND);
311 _luminance_unit->Append (_("candela per m²"));
312 _luminance_unit->Append (_("foot lambert"));
318 MetadataDialog::facility_changed ()
320 film()->set_facility (wx_to_std(_facility->GetValue()));
325 MetadataDialog::enable_facility_changed ()
327 setup_sensitivity ();
328 if (_enable_facility->GetValue()) {
329 film()->set_facility (wx_to_std(_facility->GetValue()));
331 film()->set_facility ();
337 MetadataDialog::studio_changed ()
339 film()->set_studio (wx_to_std(_studio->GetValue()));
344 MetadataDialog::enable_studio_changed ()
346 setup_sensitivity ();
347 if (_enable_studio->GetValue()) {
348 film()->set_studio (wx_to_std(_studio->GetValue()));
350 film()->set_studio ();
356 MetadataDialog::temp_version_changed ()
358 film()->set_temp_version(_temp_version->GetValue());
363 MetadataDialog::pre_release_changed ()
365 film()->set_pre_release(_pre_release->GetValue());
370 MetadataDialog::red_band_changed ()
372 film()->set_red_band(_red_band->GetValue());
377 MetadataDialog::two_d_version_of_three_d_changed ()
379 film()->set_two_d_version_of_three_d(_two_d_version_of_three_d->GetValue());
384 MetadataDialog::chain_changed ()
386 film()->set_chain (wx_to_std(_chain->GetValue()));
391 MetadataDialog::enable_chain_changed ()
393 setup_sensitivity ();
394 if (_enable_chain->GetValue()) {
397 film()->set_chain ();
403 MetadataDialog::enable_luminance_changed ()
405 setup_sensitivity ();
406 if (_enable_luminance->GetValue()) {
407 luminance_changed ();
409 film()->set_luminance ();
415 MetadataDialog::luminance_changed ()
417 dcp::Luminance::Unit unit;
418 switch (_luminance_unit->GetSelection()) {
420 unit = dcp::Luminance::Unit::CANDELA_PER_SQUARE_METRE;
423 unit = dcp::Luminance::Unit::FOOT_LAMBERT;
426 DCPOMATIC_ASSERT (false);
429 film()->set_luminance (dcp::Luminance(_luminance_value->GetValue(), unit));
434 MetadataDialog::sign_language_video_language_changed ()
436 film()->set_sign_language_video_language(_sign_language_video_language->get());
441 MetadataDialog::ratings() const
443 return film()->ratings();
448 MetadataDialog::set_ratings(vector<dcp::Rating> r)
450 film()->set_ratings(r);