src/wx/metadata_dialog.cc

   1 /*
   2     Copyright (C) 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 #include "dcpomatic_button.h"
  23 #include "full_language_tag_dialog.h"
  24 #include "metadata_dialog.h"
  25 #include "wx_util.h"
  26 #include "lib/film.h"
  27 #include <boost/bind.hpp>
  28 #include <boost/weak_ptr.hpp>
  29 #include <wx/notebook.h>
  30 #include <wx/spinctrl.h>
  31 #include <wx/wx.h>
  32
  33
  34 using std::weak_ptr;
  35
  36
  37 MetadataDialog::MetadataDialog (wxWindow* parent, weak_ptr<Film> weak_film)
  38         : wxDialog (parent, wxID_ANY, _("Metadata"))
  39         , WeakFilm (weak_film)
  40 {
  41
  42 }
  43
  44
  45 void
  46 MetadataDialog::setup ()
  47 {
  48         auto notebook = new wxNotebook (this, wxID_ANY);
  49
  50         auto prepare = [notebook](std::function<void (wxPanel*, wxSizer*)> setup, wxString name) {
  51                 auto panel = new wxPanel (notebook, wxID_ANY);
  52                 auto sizer = new wxFlexGridSizer (2, DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
  53                 sizer->AddGrowableCol (1, 1);
  54                 setup (panel, sizer);
  55                 auto overall_sizer = new wxBoxSizer (wxVERTICAL);
  56                 overall_sizer->Add (sizer, 1, wxEXPAND | wxALL, DCPOMATIC_DIALOG_BORDER);
  57                 panel->SetSizer (overall_sizer);
  58                 notebook->AddPage (panel, name);
  59         };
  60
  61         prepare (boost::bind(&MetadataDialog::setup_standard, this, _1, _2), _("Standard"));
  62         prepare (boost::bind(&MetadataDialog::setup_advanced, this, _1, _2), _("Advanced"));
  63
  64         auto overall_sizer = new wxBoxSizer (wxVERTICAL);
  65         overall_sizer->Add (notebook, 1, wxEXPAND | wxALL, DCPOMATIC_DIALOG_BORDER);
  66
  67         auto buttons = CreateSeparatedButtonSizer (wxCLOSE);
  68         if (buttons) {
  69                 overall_sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
  70         }
  71
  72         SetSizer (overall_sizer);
  73         overall_sizer->Layout ();
  74         overall_sizer->SetSizeHints (this);
  75
  76         _edit_release_territory->Bind (wxEVT_BUTTON, boost::bind(&MetadataDialog::edit_release_territory, this));
  77         _enable_release_territory->Bind (wxEVT_CHECKBOX, boost::bind(&MetadataDialog::enable_release_territory_changed, this));
  78         _enable_facility->Bind (wxEVT_CHECKBOX, boost::bind(&MetadataDialog::enable_facility_changed, this));
  79         _facility->Bind (wxEVT_TEXT, boost::bind(&MetadataDialog::facility_changed, this));
  80         _enable_studio->Bind (wxEVT_CHECKBOX, boost::bind(&MetadataDialog::enable_studio_changed, this));
  81         _studio->Bind (wxEVT_TEXT, boost::bind(&MetadataDialog::studio_changed, this));
  82         _enable_chain->Bind (wxEVT_CHECKBOX, boost::bind(&MetadataDialog::enable_chain_changed, this));
  83         _chain->Bind (wxEVT_TEXT, boost::bind(&MetadataDialog::chain_changed, this));
  84         _temp_version->Bind (wxEVT_CHECKBOX, boost::bind(&MetadataDialog::temp_version_changed, this));
  85         _pre_release->Bind (wxEVT_CHECKBOX, boost::bind(&MetadataDialog::pre_release_changed, this));
  86         _red_band->Bind (wxEVT_CHECKBOX, boost::bind(&MetadataDialog::red_band_changed, this));
  87         _two_d_version_of_three_d->Bind (wxEVT_CHECKBOX, boost::bind(&MetadataDialog::two_d_version_of_three_d_changed, this));
  88         _enable_luminance->Bind (wxEVT_CHECKBOX, boost::bind(&MetadataDialog::enable_luminance_changed, this));
  89         _luminance_value->Bind (wxEVT_SPINCTRLDOUBLE, boost::bind(&MetadataDialog::luminance_changed, this));
  90         _luminance_unit->Bind (wxEVT_CHOICE, boost::bind(&MetadataDialog::luminance_changed, this));
  91
  92         _film_changed_connection = film()->Change.connect(boost::bind(&MetadataDialog::film_changed, this, _1, _2));
  93
  94         film_changed (ChangeType::DONE, Film::Property::RELEASE_TERRITORY);
  95         film_changed (ChangeType::DONE, Film::Property::FACILITY);
  96         film_changed (ChangeType::DONE, Film::Property::STUDIO);
  97         film_changed (ChangeType::DONE, Film::Property::TEMP_VERSION);
  98         film_changed (ChangeType::DONE, Film::Property::PRE_RELEASE);
  99         film_changed (ChangeType::DONE, Film::Property::RED_BAND);
 100         film_changed (ChangeType::DONE, Film::Property::TWO_D_VERSION_OF_THREE_D);
 101         film_changed (ChangeType::DONE, Film::Property::CHAIN);
 102         film_changed (ChangeType::DONE, Film::Property::LUMINANCE);
 103
 104         setup_sensitivity ();
 105 }
 106
 107
 108 void
 109 MetadataDialog::film_changed (ChangeType type, Film::Property property)
 110 {
 111         if (type != ChangeType::DONE) {
 112                 return;
 113         }
 114
 115         if (property == Film::Property::RELEASE_TERRITORY) {
 116                 auto rt = film()->release_territory();
 117                 checked_set (_enable_release_territory, static_cast<bool>(rt));
 118                 if (rt) {
 119                         _release_territory = *rt;
 120                         checked_set (_release_territory_text, std_to_wx(*dcp::LanguageTag::get_subtag_description(*_release_territory)));
 121                 }
 122         } else if (property == Film::Property::FACILITY) {
 123                 checked_set (_enable_facility, static_cast<bool>(film()->facility()));
 124                 if (film()->facility()) {
 125                         checked_set (_facility, *film()->facility());
 126                 }
 127         } else if (property == Film::Property::STUDIO) {
 128                 checked_set (_enable_studio, static_cast<bool>(film()->studio()));
 129                 if (film()->studio()) {
 130                         checked_set (_studio, *film()->studio());
 131                 }
 132         } else if (property == Film::Property::CHAIN) {
 133                 checked_set (_enable_chain, static_cast<bool>(film()->chain()));
 134                 if (film()->chain()) {
 135                         checked_set (_chain, *film()->chain());
 136                 }
 137         } else if (property == Film::Property::TEMP_VERSION) {
 138                 checked_set (_temp_version, film()->temp_version());
 139         } else if (property == Film::Property::PRE_RELEASE) {
 140                 checked_set (_pre_release, film()->pre_release());
 141         } else if (property == Film::Property::RED_BAND) {
 142                 checked_set (_red_band, film()->red_band());
 143         } else if (property == Film::Property::TWO_D_VERSION_OF_THREE_D) {
 144                 checked_set (_two_d_version_of_three_d, film()->two_d_version_of_three_d());
 145         } else if (property == Film::Property::LUMINANCE) {
 146                 auto lum = film()->luminance();
 147                 checked_set (_enable_luminance, static_cast<bool>(lum));
 148                 if (lum) {
 149                         checked_set (_luminance_value, lum->value());
 150                         switch (lum->unit()) {
 151                         case dcp::Luminance::Unit::CANDELA_PER_SQUARE_METRE:
 152                                 checked_set (_luminance_unit, 0);
 153                                 break;
 154                         case dcp::Luminance::Unit::FOOT_LAMBERT:
 155                                 checked_set (_luminance_unit, 1);
 156                                 break;
 157                         }
 158                 } else {
 159                         checked_set (_luminance_unit, 1);
 160                 }
 161         }
 162 }
 163
 164
 165 void
 166 MetadataDialog::setup_standard (wxPanel* panel, wxSizer* sizer)
 167 {
 168         _enable_release_territory = new wxCheckBox (panel, wxID_ANY, _("Release territory"));
 169         sizer->Add (_enable_release_territory, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
 170         {
 171                 auto s = new wxBoxSizer (wxHORIZONTAL);
 172                 _release_territory_text = new wxStaticText (panel, wxID_ANY, wxT(""));
 173                 s->Add (_release_territory_text, 1, wxLEFT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_X_GAP);
 174                 _edit_release_territory = new Button (panel, _("Edit..."));
 175                 s->Add (_edit_release_territory, 0, wxLEFT, DCPOMATIC_SIZER_GAP);
 176                 sizer->Add (s, 0, wxEXPAND);
 177         }
 178 }
 179
 180
 181 void
 182 MetadataDialog::edit_release_territory ()
 183 {
 184         DCPOMATIC_ASSERT (film()->release_territory());
 185         auto d = new RegionSubtagDialog(this, *film()->release_territory());
 186         d->ShowModal ();
 187         auto tag = d->get();
 188         if (tag) {
 189                 _release_territory = *tag;
 190                 film()->set_release_territory(*tag);
 191         }
 192         d->Destroy ();
 193 }
 194
 195
 196 void
 197 MetadataDialog::setup_sensitivity ()
 198 {
 199         auto const enabled = _enable_release_territory->GetValue();
 200         _release_territory_text->Enable (enabled);
 201         _edit_release_territory->Enable (enabled);
 202         _facility->Enable (_enable_facility->GetValue());
 203         _chain->Enable (_enable_chain->GetValue());
 204         _studio->Enable (_enable_studio->GetValue());
 205         _luminance_value->Enable (_enable_luminance->GetValue());
 206         _luminance_unit->Enable (_enable_luminance->GetValue());
 207 }
 208
 209
 210 void
 211 MetadataDialog::enable_release_territory_changed ()
 212 {
 213         setup_sensitivity ();
 214         if (_enable_release_territory->GetValue()) {
 215                 film()->set_release_territory (_release_territory.get_value_or(dcp::LanguageTag::RegionSubtag("US")));
 216         } else {
 217                 film()->set_release_territory ();
 218         }
 219 }
 220
 221
 222 void
 223 MetadataDialog::setup_advanced (wxPanel* panel, wxSizer* sizer)
 224 {
 225         _enable_facility = new wxCheckBox (panel, wxID_ANY, _("Facility"));
 226         sizer->Add (_enable_facility, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL);
 227         _facility = new wxTextCtrl (panel, wxID_ANY);
 228         sizer->Add (_facility, 1, wxEXPAND);
 229
 230         _enable_studio = new wxCheckBox (panel, wxID_ANY, _("Studio"));
 231         sizer->Add (_enable_studio, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL);
 232         _studio = new wxTextCtrl (panel, wxID_ANY);
 233         sizer->Add (_studio, 1, wxEXPAND);
 234
 235         _enable_chain = new wxCheckBox (panel, wxID_ANY, _("Chain"));
 236         sizer->Add (_enable_chain, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL);
 237         _chain = new wxTextCtrl (panel, wxID_ANY);
 238         sizer->Add (_chain, 1, wxEXPAND);
 239
 240         _temp_version = new wxCheckBox (panel, wxID_ANY, _("Temporary version"));
 241         sizer->Add (_temp_version, 0, wxALIGN_CENTER_VERTICAL);
 242         sizer->AddSpacer (0);
 243
 244         _pre_release = new wxCheckBox (panel, wxID_ANY, _("Pre-release"));
 245         sizer->Add (_pre_release, 0, wxALIGN_CENTER_VERTICAL);
 246         sizer->AddSpacer (0);
 247
 248         _red_band = new wxCheckBox (panel, wxID_ANY, _("Red band"));
 249         sizer->Add (_red_band, 0, wxALIGN_CENTER_VERTICAL);
 250         sizer->AddSpacer (0);
 251
 252         _two_d_version_of_three_d = new wxCheckBox (panel, wxID_ANY, _("2D version of 3D DCP"));
 253         sizer->Add (_two_d_version_of_three_d, 0, wxALIGN_CENTER_VERTICAL);
 254         sizer->AddSpacer (0);
 255
 256         _enable_luminance = new wxCheckBox (panel, wxID_ANY, _("Luminance"));
 257         sizer->Add (_enable_luminance, 0, wxALIGN_CENTER_VERTICAL);
 258         {
 259                 auto s = new wxBoxSizer (wxHORIZONTAL);
 260                 _luminance_value = new wxSpinCtrlDouble (panel, wxID_ANY);
 261                 _luminance_value->SetDigits (1);
 262                 _luminance_value->SetIncrement (0.1);
 263                 s->Add (_luminance_value, 0);
 264                 _luminance_unit = new wxChoice (panel, wxID_ANY);
 265                 s->Add (_luminance_unit, 0, wxLEFT, DCPOMATIC_SIZER_X_GAP);
 266                 sizer->Add (s, 1, wxEXPAND);
 267         }
 268
 269         _luminance_unit->Append (wxString::FromUTF8(_("candela per m²")));
 270         _luminance_unit->Append (_("foot lambert"));
 271
 272 }
 273
 274
 275 void
 276 MetadataDialog::facility_changed ()
 277 {
 278         film()->set_facility (wx_to_std(_facility->GetValue()));
 279 }
 280
 281
 282 void
 283 MetadataDialog::enable_facility_changed ()
 284 {
 285         setup_sensitivity ();
 286         if (_enable_facility->GetValue()) {
 287                 film()->set_facility (wx_to_std(_facility->GetValue()));
 288         } else {
 289                 film()->set_facility ();
 290         }
 291 }
 292
 293
 294 void
 295 MetadataDialog::studio_changed ()
 296 {
 297         film()->set_studio (wx_to_std(_studio->GetValue()));
 298 }
 299
 300
 301 void
 302 MetadataDialog::enable_studio_changed ()
 303 {
 304         setup_sensitivity ();
 305         if (_enable_studio->GetValue()) {
 306                 film()->set_studio (wx_to_std(_studio->GetValue()));
 307         } else {
 308                 film()->set_studio ();
 309         }
 310 }
 311
 312
 313 void
 314 MetadataDialog::temp_version_changed ()
 315 {
 316         film()->set_temp_version(_temp_version->GetValue());
 317 }
 318
 319
 320 void
 321 MetadataDialog::pre_release_changed ()
 322 {
 323         film()->set_pre_release(_pre_release->GetValue());
 324 }
 325
 326
 327 void
 328 MetadataDialog::red_band_changed ()
 329 {
 330         film()->set_red_band(_red_band->GetValue());
 331 }
 332
 333
 334 void
 335 MetadataDialog::two_d_version_of_three_d_changed ()
 336 {
 337         film()->set_two_d_version_of_three_d(_two_d_version_of_three_d->GetValue());
 338 }
 339
 340
 341 void
 342 MetadataDialog::chain_changed ()
 343 {
 344         film()->set_chain (wx_to_std(_chain->GetValue()));
 345 }
 346
 347
 348 void
 349 MetadataDialog::enable_chain_changed ()
 350 {
 351         setup_sensitivity ();
 352         if (_enable_chain->GetValue()) {
 353                 chain_changed ();
 354         } else {
 355                 film()->set_chain ();
 356         }
 357 }
 358
 359
 360 void
 361 MetadataDialog::enable_luminance_changed ()
 362 {
 363         setup_sensitivity ();
 364         if (_enable_luminance->GetValue()) {
 365                 luminance_changed ();
 366         } else {
 367                 film()->set_luminance ();
 368         }
 369 }
 370
 371
 372 void
 373 MetadataDialog::luminance_changed ()
 374 {
 375         dcp::Luminance::Unit unit;
 376         switch (_luminance_unit->GetSelection()) {
 377         case 0:
 378                 unit = dcp::Luminance::Unit::CANDELA_PER_SQUARE_METRE;
 379                 break;
 380         case 1:
 381                 unit = dcp::Luminance::Unit::FOOT_LAMBERT;
 382                 break;
 383         default:
 384                 DCPOMATIC_ASSERT (false);
 385         }
 386
 387         film()->set_luminance (dcp::Luminance(_luminance_value->GetValue(), unit));
 388 }
 389