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