Allow specification of audio forensic marking (in KDMs) for some channels only. ...
[dcpomatic.git] / src / wx / kdm_output_panel.cc
index db4ad8647bdd83d07a5d64e31434f6cdcefd4a85..d76a2735902d97923466f8ce1bac34b7ad391b1e 100644 (file)
@@ -1,24 +1,36 @@
 /*
-    Copyright (C) 2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2015-2018 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
+#include "lib/config.h"
+#include "lib/cinema.h"
+#include "lib/cinema_kdms.h"
+#include "lib/send_kdm_email_job.h"
 #include "kdm_output_panel.h"
+#include "kdm_timing_panel.h"
+#include "confirm_kdm_email_dialog.h"
 #include "wx_util.h"
+#include "kdm_advanced_dialog.h"
+#include "name_format_editor.h"
+#include "check_box.h"
+#include "dcpomatic_button.h"
+#include <dcp/exceptions.h>
 #include <dcp/types.h>
 #ifdef DCPOMATIC_USE_OWN_PICKER
 #include "dir_picker_ctrl.h"
 #endif
 #include <wx/stdpaths.h>
 
+using std::pair;
+using std::string;
+using std::list;
+using std::exception;
+using std::make_pair;
+using boost::shared_ptr;
+using boost::function;
+
 KDMOutputPanel::KDMOutputPanel (wxWindow* parent, bool interop)
        : wxPanel (parent, wxID_ANY)
+       , _forensic_mark_video (true)
+       , _forensic_mark_audio (true)
+       , _forensic_mark_audio_up_to (12)
 {
        wxFlexGridSizer* table = new wxFlexGridSizer (2, DCPOMATIC_SIZER_X_GAP, 0);
 
        add_label_to_sizer (table, this, _("KDM type"), true);
+
+       wxBoxSizer* type = new wxBoxSizer (wxHORIZONTAL);
        _type = new wxChoice (this, wxID_ANY);
        _type->Append ("Modified Transitional 1", ((void *) dcp::MODIFIED_TRANSITIONAL_1));
+       _type->Append ("Multiple Modified Transitional 1", ((void *) dcp::MULTIPLE_MODIFIED_TRANSITIONAL_1));
+       _type->Append ("Modified Transitional 1 (without AuthorizedDeviceInfo)", ((void *) dcp::MODIFIED_TRANSITIONAL_TEST));
        if (!interop) {
                _type->Append ("DCI Any", ((void *) dcp::DCI_ANY));
                _type->Append ("DCI Specific", ((void *) dcp::DCI_SPECIFIC));
        }
-       table->Add (_type, 1, wxEXPAND);
+       type->Add (_type, 1, wxEXPAND);
        _type->SetSelection (0);
+       wxButton* advanced = new Button (this, _("Advanced..."));
+       type->Add (advanced, 0, wxALIGN_CENTER_VERTICAL);
+       table->Add (type, 1, wxEXPAND);
 
-       _write_to = new wxRadioButton (this, wxID_ANY, _("Write to"));
+       add_label_to_sizer (table, this, _("Folder / ZIP name format"), true, 0, wxALIGN_TOP | wxTOP | wxLEFT | wxRIGHT);
+       _container_name_format = new NameFormatEditor (this, Config::instance()->kdm_container_name_format(), dcp::NameFormat::Map(), dcp::NameFormat::Map(), "");
+       table->Add (_container_name_format->panel(), 1, wxEXPAND);
+
+       add_label_to_sizer (table, this, _("Filename format"), true, 0, wxALIGN_TOP | wxTOP | wxLEFT | wxRIGHT);
+       dcp::NameFormat::Map titles;
+       titles['f'] = wx_to_std (_("film name"));
+       titles['c'] = wx_to_std (_("cinema"));
+       titles['s'] = wx_to_std (_("screen"));
+       titles['b'] = wx_to_std (_("from date/time"));
+       titles['e'] = wx_to_std (_("to date/time"));
+       dcp::NameFormat::Map ex;
+       ex['f'] = "Bambi";
+       ex['c'] = "Lumière";
+       ex['s'] = "Screen 1";
+       ex['b'] = "2012/03/15 12:30";
+       ex['e'] = "2012/03/22 02:30";
+       _filename_format = new NameFormatEditor (this, Config::instance()->kdm_filename_format(), titles, ex, ".xml");
+       table->Add (_filename_format->panel(), 1, wxEXPAND);
+
+       _write_to = new CheckBox (this, _("Write to"));
        table->Add (_write_to, 1, wxEXPAND);
 
 #ifdef DCPOMATIC_USE_OWN_PICKER
@@ -51,18 +101,49 @@ KDMOutputPanel::KDMOutputPanel (wxWindow* parent, bool interop)
        _folder = new wxDirPickerCtrl (this, wxID_ANY, wxEmptyString, wxDirSelectorPromptStr, wxDefaultPosition, wxSize (300, -1));
 #endif
 
-       _folder->SetPath (wxStandardPaths::Get().GetDocumentsDir());
+       boost::optional<boost::filesystem::path> path = Config::instance()->default_kdm_directory ();
+       if (path) {
+               _folder->SetPath (std_to_wx (path->string ()));
+       } else {
+               _folder->SetPath (wxStandardPaths::Get().GetDocumentsDir());
+       }
 
        table->Add (_folder, 1, wxEXPAND);
 
-       _email = new wxRadioButton (this, wxID_ANY, _("Send by email"));
+       wxSizer* write_options = new wxBoxSizer(wxVERTICAL);
+       _write_flat = new wxRadioButton (this, wxID_ANY, _("Write all KDMs to the same folder"), wxDefaultPosition, wxDefaultSize, wxRB_GROUP);
+       write_options->Add (_write_flat);
+       _write_folder = new wxRadioButton (this, wxID_ANY, _("Write a folder for each cinema's KDMs"));
+       write_options->Add (_write_folder);
+       _write_zip = new wxRadioButton (this, wxID_ANY, _("Write a ZIP file for each cinema's KDMs"));
+       write_options->Add (_write_zip);
+       table->AddSpacer (0);
+       table->Add (write_options);
+
+       _email = new CheckBox (this, _("Send by email"));
        table->Add (_email, 1, wxEXPAND);
        table->AddSpacer (0);
 
+       switch (Config::instance()->last_kdm_write_type().get_value_or(Config::KDM_WRITE_FLAT)) {
+       case Config::KDM_WRITE_FLAT:
+               _write_flat->SetValue (true);
+               break;
+       case Config::KDM_WRITE_FOLDER:
+               _write_folder->SetValue (true);
+               break;
+       case Config::KDM_WRITE_ZIP:
+               _write_zip->SetValue (true);
+               break;
+       }
+
        _write_to->SetValue (true);
 
-       _write_to->Bind (wxEVT_COMMAND_RADIOBUTTON_SELECTED, boost::bind (&KDMOutputPanel::setup_sensitivity, this));
-       _email->Bind    (wxEVT_COMMAND_RADIOBUTTON_SELECTED, boost::bind (&KDMOutputPanel::setup_sensitivity, this));
+       _write_to->Bind     (wxEVT_CHECKBOX, boost::bind (&KDMOutputPanel::setup_sensitivity, this));
+       _email->Bind        (wxEVT_CHECKBOX, boost::bind (&KDMOutputPanel::setup_sensitivity, this));
+       _write_flat->Bind   (wxEVT_RADIOBUTTON, boost::bind (&KDMOutputPanel::kdm_write_type_changed, this));
+       _write_folder->Bind (wxEVT_RADIOBUTTON, boost::bind (&KDMOutputPanel::kdm_write_type_changed, this));
+       _write_zip->Bind    (wxEVT_RADIOBUTTON, boost::bind (&KDMOutputPanel::kdm_write_type_changed, this));
+       advanced->Bind      (wxEVT_BUTTON, boost::bind (&KDMOutputPanel::advanced_clicked, this));
 
        SetSizer (table);
 }
@@ -70,19 +151,151 @@ KDMOutputPanel::KDMOutputPanel (wxWindow* parent, bool interop)
 void
 KDMOutputPanel::setup_sensitivity ()
 {
-       _folder->Enable (_write_to->GetValue ());
+       bool const write = _write_to->GetValue ();
+       _folder->Enable (write);
+       _write_flat->Enable (write);
+       _write_folder->Enable (write);
+       _write_zip->Enable (write);
 }
 
-boost::filesystem::path
-KDMOutputPanel::directory () const
+void
+KDMOutputPanel::advanced_clicked ()
 {
-       return wx_to_std (_folder->GetPath ());
+       KDMAdvancedDialog* d = new KDMAdvancedDialog (this, _forensic_mark_video, _forensic_mark_audio, _forensic_mark_audio_up_to);
+       d->ShowModal ();
+       _forensic_mark_video = d->forensic_mark_video ();
+       _forensic_mark_audio = d->forensic_mark_audio ();
+       _forensic_mark_audio_up_to = d->forensic_mark_audio_up_to ();
+       d->Destroy ();
 }
 
-bool
-KDMOutputPanel::write_to () const
+void
+KDMOutputPanel::kdm_write_type_changed ()
 {
-       return _write_to->GetValue ();
+       if (_write_flat->GetValue()) {
+               Config::instance()->set_last_kdm_write_type (Config::KDM_WRITE_FLAT);
+       } else if (_write_folder->GetValue()) {
+               Config::instance()->set_last_kdm_write_type (Config::KDM_WRITE_FOLDER);
+       } else if (_write_zip->GetValue()) {
+               Config::instance()->set_last_kdm_write_type (Config::KDM_WRITE_ZIP);
+       }
+}
+
+pair<shared_ptr<Job>, int>
+KDMOutputPanel::make (
+       list<shared_ptr<ScreenKDM> > screen_kdms, string name, KDMTimingPanel* timing, function<bool (boost::filesystem::path)> confirm_overwrite
+       )
+{
+       list<CinemaKDMs> const cinema_kdms = CinemaKDMs::collect (screen_kdms);
+
+       /* Decide whether to proceed */
+
+       bool proceed = true;
+
+       if (_email->GetValue ()) {
+
+               if (Config::instance()->mail_server().empty ()) {
+                       proceed = false;
+                       error_dialog (this, _("You must set up a mail server in Preferences before you can send emails."));
+               }
+
+               bool cinemas_with_no_email = false;
+               BOOST_FOREACH (CinemaKDMs i, cinema_kdms) {
+                       if (i.cinema->emails.empty ()) {
+                               cinemas_with_no_email = true;
+                       }
+               }
+
+               if (proceed && cinemas_with_no_email && !confirm_dialog (
+                           this,
+                           _("You have selected some cinemas that have no configured email address.  Do you want to continue?")
+                           )) {
+                       proceed = false;
+               }
+
+               if (proceed && Config::instance()->confirm_kdm_email ()) {
+                       list<string> emails;
+                       BOOST_FOREACH (CinemaKDMs i, cinema_kdms) {
+                               BOOST_FOREACH (string j, i.cinema->emails) {
+                                       emails.push_back (j);
+                               }
+                       }
+
+                       if (!emails.empty ()) {
+                               ConfirmKDMEmailDialog* d = new ConfirmKDMEmailDialog (this, emails);
+                               if (d->ShowModal() == wxID_CANCEL) {
+                                       proceed = false;
+                               }
+                       }
+               }
+       }
+
+       if (!proceed) {
+               return make_pair (shared_ptr<Job>(), 0);
+       }
+
+       Config::instance()->set_kdm_filename_format (_filename_format->get ());
+
+       int written = 0;
+       shared_ptr<Job> job;
+
+       try {
+               dcp::NameFormat::Map name_values;
+               name_values['f'] = name;
+               name_values['b'] = dcp::LocalTime(timing->from()).date() + " " + dcp::LocalTime(timing->from()).time_of_day(false, false);
+               name_values['e'] = dcp::LocalTime(timing->until()).date() + " " + dcp::LocalTime(timing->until()).time_of_day(false, false);
+
+               if (_write_to->GetValue()) {
+                       if (_write_flat->GetValue()) {
+                               written = ScreenKDM::write_files (
+                                       screen_kdms,
+                                       directory(),
+                                       _filename_format->get(),
+                                       name_values,
+                                       confirm_overwrite
+                                       );
+                       } else if (_write_folder->GetValue()) {
+                               written = CinemaKDMs::write_directories (
+                                       CinemaKDMs::collect (screen_kdms),
+                                       directory(),
+                                       _container_name_format->get(),
+                                       _filename_format->get(),
+                                       name_values,
+                                       confirm_overwrite
+                                       );
+                       } else if (_write_zip->GetValue()) {
+                               written = CinemaKDMs::write_zip_files (
+                                       CinemaKDMs::collect (screen_kdms),
+                                       directory(),
+                                       _container_name_format->get(),
+                                       _filename_format->get(),
+                                       name_values,
+                                       confirm_overwrite
+                                       );
+                       }
+               }
+
+               if (_email->GetValue ()) {
+                       job.reset (
+                               new SendKDMEmailJob (
+                                       cinema_kdms,
+                                       _container_name_format->get(),
+                                       _filename_format->get(),
+                                       name_values,
+                                       name
+                                       )
+                               );
+               }
+
+       } catch (dcp::NotEncryptedError& e) {
+               error_dialog (this, _("CPL's content is not encrypted."));
+       } catch (exception& e) {
+               error_dialog (this, std_to_wx(e.what()));
+       } catch (...) {
+               error_dialog (this, _("An unknown exception occurred."));
+       }
+
+       return make_pair (job, written);
 }
 
 dcp::Formulation
@@ -90,3 +303,9 @@ KDMOutputPanel::formulation () const
 {
        return (dcp::Formulation) reinterpret_cast<intptr_t> (_type->GetClientData (_type->GetSelection()));
 }
+
+boost::filesystem::path
+KDMOutputPanel::directory () const
+{
+       return wx_to_std (_folder->GetPath ());
+}