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