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 "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"
  28 #include "wx_util.h"
  29 #include "lib/film.h"
  30 #include <dcp/warnings.h>
  31 LIBDCP_DISABLE_WARNINGS
  32 #include <wx/notebook.h>
  33 #include <wx/spinctrl.h>
  34 #include <wx/wx.h>
  35 LIBDCP_ENABLE_WARNINGS
  36 #include <boost/bind.hpp>
  37 #include <boost/weak_ptr.hpp>
  38
  39
  40 using std::weak_ptr;
  41 using std::vector;
  42
  43
  44 MetadataDialog::MetadataDialog (wxWindow* parent, weak_ptr<Film> weak_film)
  45         : wxDialog (parent, wxID_ANY, _("Metadata"))
  46         , WeakFilm (weak_film)
  47 {
  48         for (auto system: dcp::rating_systems()) {
  49                 _rating_system_agency_to_name[system.agency] = system.name;
  50         }
  51 }
  52
  53
  54 void
  55 MetadataDialog::setup ()
  56 {
  57         auto notebook = new wxNotebook (this, wxID_ANY);
  58
  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);
  63                 setup (panel, sizer);
  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);
  68         };
  69
  70         prepare (boost::bind(&MetadataDialog::setup_standard, this, _1, _2), _("Standard"));
  71         prepare (boost::bind(&MetadataDialog::setup_advanced, this, _1, _2), _("Advanced"));
  72
  73         auto overall_sizer = new wxBoxSizer (wxVERTICAL);
  74         overall_sizer->Add (notebook, 1, wxEXPAND | wxALL, DCPOMATIC_DIALOG_BORDER);
  75
  76         auto buttons = CreateSeparatedButtonSizer (wxCLOSE);
  77         if (buttons) {
  78                 overall_sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
  79         }
  80
  81         SetSizer (overall_sizer);
  82         overall_sizer->Layout ();
  83         overall_sizer->SetSizeHints (this);
  84
  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));
 101
 102         _film_changed_connection = film()->Change.connect(boost::bind(&MetadataDialog::film_changed, this, _1, _2));
 103
 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);
 114
 115         setup_sensitivity ();
 116 }
 117
 118
 119 void
 120 MetadataDialog::film_changed (ChangeType type, Film::Property property)
 121 {
 122         if (type != ChangeType::DONE) {
 123                 return;
 124         }
 125
 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));
 131                 if (rt) {
 132                         _release_territory = *rt;
 133                         checked_set (_release_territory_text, std_to_wx(*dcp::LanguageTag::get_subtag_description(*_release_territory)));
 134                 }
 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());
 139                 }
 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());
 144                 }
 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());
 149                 }
 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));
 161                 if (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);
 166                                 break;
 167                         case dcp::Luminance::Unit::FOOT_LAMBERT:
 168                                 checked_set (_luminance_unit, 1);
 169                                 break;
 170                         }
 171                 } else {
 172                         checked_set (_luminance_unit, 1);
 173                 }
 174         }
 175 }
 176
 177
 178 void
 179 MetadataDialog::setup_standard (wxPanel* panel, wxSizer* sizer)
 180 {
 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);
 183         {
 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);
 190         }
 191
 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> (
 196                 panel,
 197                 columns,
 198                 boost::bind(&MetadataDialog::ratings, this),
 199                 boost::bind(&MetadataDialog::set_ratings, this, _1),
 200                 [this](dcp::Rating r, int c) {
 201                         if (c == 0) {
 202                                 auto iter = _rating_system_agency_to_name.find(r.agency);
 203                                 if (iter != _rating_system_agency_to_name.end()) {
 204                                         return iter->second;
 205                                 }
 206                                 return r.agency;
 207                         }
 208                         return r.label;
 209                 },
 210                 EditableListTitle::VISIBLE,
 211                 EditableListButton::NEW | EditableListButton::EDIT | EditableListButton::REMOVE
 212                 );
 213         _ratings->SetMinSize(wxSize(600, -1));
 214 }
 215
 216
 217 void
 218 MetadataDialog::edit_release_territory ()
 219 {
 220         DCPOMATIC_ASSERT (film()->release_territory());
 221         auto d = new RegionSubtagDialog(this, *film()->release_territory());
 222         d->ShowModal ();
 223         auto tag = d->get();
 224         if (tag) {
 225                 _release_territory = *tag;
 226                 film()->set_release_territory(*tag);
 227         }
 228         d->Destroy ();
 229 }
 230
 231
 232 void
 233 MetadataDialog::setup_sensitivity ()
 234 {
 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());
 244 }
 245
 246
 247 void
 248 MetadataDialog::enable_release_territory_changed ()
 249 {
 250         setup_sensitivity ();
 251         if (_enable_release_territory->GetValue()) {
 252                 film()->set_release_territory (_release_territory.get_value_or(dcp::LanguageTag::RegionSubtag("US")));
 253         } else {
 254                 film()->set_release_territory ();
 255         }
 256 }
 257
 258
 259 void
 260 MetadataDialog::setup_advanced (wxPanel* panel, wxSizer* sizer)
 261 {
 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);
 265
 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);
 270
 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);
 275
 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);
 280
 281         _temp_version = new wxCheckBox (panel, wxID_ANY, _("Temporary version"));
 282         sizer->Add (_temp_version, 0, wxALIGN_CENTER_VERTICAL);
 283         sizer->AddSpacer (0);
 284
 285         _pre_release = new wxCheckBox (panel, wxID_ANY, _("Pre-release"));
 286         sizer->Add (_pre_release, 0, wxALIGN_CENTER_VERTICAL);
 287         sizer->AddSpacer (0);
 288
 289         _red_band = new wxCheckBox (panel, wxID_ANY, _("Red band"));
 290         sizer->Add (_red_band, 0, wxALIGN_CENTER_VERTICAL);
 291         sizer->AddSpacer (0);
 292
 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);
 296
 297         _enable_luminance = new wxCheckBox (panel, wxID_ANY, _("Luminance"));
 298         sizer->Add (_enable_luminance, 0, wxALIGN_CENTER_VERTICAL);
 299         {
 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);
 309         }
 310
 311         _luminance_unit->Append (_("candela per m²"));
 312         _luminance_unit->Append (_("foot lambert"));
 313
 314 }
 315
 316
 317 void
 318 MetadataDialog::facility_changed ()
 319 {
 320         film()->set_facility (wx_to_std(_facility->GetValue()));
 321 }
 322
 323
 324 void
 325 MetadataDialog::enable_facility_changed ()
 326 {
 327         setup_sensitivity ();
 328         if (_enable_facility->GetValue()) {
 329                 film()->set_facility (wx_to_std(_facility->GetValue()));
 330         } else {
 331                 film()->set_facility ();
 332         }
 333 }
 334
 335
 336 void
 337 MetadataDialog::studio_changed ()
 338 {
 339         film()->set_studio (wx_to_std(_studio->GetValue()));
 340 }
 341
 342
 343 void
 344 MetadataDialog::enable_studio_changed ()
 345 {
 346         setup_sensitivity ();
 347         if (_enable_studio->GetValue()) {
 348                 film()->set_studio (wx_to_std(_studio->GetValue()));
 349         } else {
 350                 film()->set_studio ();
 351         }
 352 }
 353
 354
 355 void
 356 MetadataDialog::temp_version_changed ()
 357 {
 358         film()->set_temp_version(_temp_version->GetValue());
 359 }
 360
 361
 362 void
 363 MetadataDialog::pre_release_changed ()
 364 {
 365         film()->set_pre_release(_pre_release->GetValue());
 366 }
 367
 368
 369 void
 370 MetadataDialog::red_band_changed ()
 371 {
 372         film()->set_red_band(_red_band->GetValue());
 373 }
 374
 375
 376 void
 377 MetadataDialog::two_d_version_of_three_d_changed ()
 378 {
 379         film()->set_two_d_version_of_three_d(_two_d_version_of_three_d->GetValue());
 380 }
 381
 382
 383 void
 384 MetadataDialog::chain_changed ()
 385 {
 386         film()->set_chain (wx_to_std(_chain->GetValue()));
 387 }
 388
 389
 390 void
 391 MetadataDialog::enable_chain_changed ()
 392 {
 393         setup_sensitivity ();
 394         if (_enable_chain->GetValue()) {
 395                 chain_changed ();
 396         } else {
 397                 film()->set_chain ();
 398         }
 399 }
 400
 401
 402 void
 403 MetadataDialog::enable_luminance_changed ()
 404 {
 405         setup_sensitivity ();
 406         if (_enable_luminance->GetValue()) {
 407                 luminance_changed ();
 408         } else {
 409                 film()->set_luminance ();
 410         }
 411 }
 412
 413
 414 void
 415 MetadataDialog::luminance_changed ()
 416 {
 417         dcp::Luminance::Unit unit;
 418         switch (_luminance_unit->GetSelection()) {
 419         case 0:
 420                 unit = dcp::Luminance::Unit::CANDELA_PER_SQUARE_METRE;
 421                 break;
 422         case 1:
 423                 unit = dcp::Luminance::Unit::FOOT_LAMBERT;
 424                 break;
 425         default:
 426                 DCPOMATIC_ASSERT (false);
 427         }
 428
 429         film()->set_luminance (dcp::Luminance(_luminance_value->GetValue(), unit));
 430 }
 431
 432
 433 void
 434 MetadataDialog::sign_language_video_language_changed ()
 435 {
 436         film()->set_sign_language_video_language(_sign_language_video_language->get());
 437 }
 438
 439
 440 vector<dcp::Rating>
 441 MetadataDialog::ratings() const
 442 {
 443         return film()->ratings();
 444 }
 445
 446
 447 void
 448 MetadataDialog::set_ratings(vector<dcp::Rating> r)
 449 {
 450         film()->set_ratings(r);
 451 }
 452