Hand-apply 97dde0e6d77b874742161703944d60524023664e from master.
[dcpomatic.git] / src / lib / film.cc
index b01a70b7277789958ea2452687d7411ac82d254a..3aed4d9657ff088b6464ca5ede71e78abf2d2bf0 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 */
 
-#include <stdexcept>
-#include <iostream>
-#include <algorithm>
-#include <fstream>
-#include <cstdlib>
-#include <sstream>
-#include <iomanip>
-#include <unistd.h>
-#include <boost/filesystem.hpp>
-#include <boost/algorithm/string.hpp>
-#include <boost/lexical_cast.hpp>
-#include <libxml++/libxml++.h>
-#include <libcxml/cxml.h>
-#include <dcp/signer_chain.h>
-#include <dcp/cpl.h>
-#include <dcp/signer.h>
-#include <dcp/util.h>
-#include <dcp/local_time.h>
-#include <dcp/raw_convert.h>
+/** @file  src/film.cc
+ *  @brief A representation of some audio and video content, and details of
+ *  how they should be presented in a DCP.
+ */
+
 #include "film.h"
 #include "job.h"
 #include "util.h"
@@ -45,9 +31,7 @@
 #include "log.h"
 #include "exceptions.h"
 #include "examine_content_job.h"
-#include "scaler.h"
 #include "config.h"
-#include "version.h"
 #include "ui_signaller.h"
 #include "playlist.h"
 #include "player.h"
 #include "ratio.h"
 #include "cross.h"
 #include "cinema.h"
+#include "safe_stringstream.h"
+#include "environment_info.h"
+#include <libcxml/cxml.h>
+#include <dcp/cpl.h>
+#include <dcp/signer.h>
+#include <dcp/util.h>
+#include <dcp/local_time.h>
+#include <dcp/raw_convert.h>
+#include <dcp/decrypted_kdm.h>
+#include <libxml++/libxml++.h>
+#include <boost/filesystem.hpp>
+#include <boost/algorithm/string.hpp>
+#include <boost/lexical_cast.hpp>
+#include <boost/foreach.hpp>
+#include <unistd.h>
+#include <stdexcept>
+#include <iostream>
+#include <algorithm>
+#include <fstream>
+#include <cstdlib>
+#include <iomanip>
+#include <set>
 
 #include "i18n.h"
 
 using std::string;
-using std::stringstream;
 using std::multimap;
 using std::pair;
 using std::map;
@@ -70,6 +75,7 @@ using std::make_pair;
 using std::endl;
 using std::cout;
 using std::list;
+using std::set;
 using boost::shared_ptr;
 using boost::weak_ptr;
 using boost::dynamic_pointer_cast;
@@ -77,9 +83,11 @@ using boost::to_upper_copy;
 using boost::ends_with;
 using boost::starts_with;
 using boost::optional;
+using boost::is_any_of;
 using dcp::Size;
 using dcp::Signer;
 using dcp::raw_convert;
+using dcp::raw_convert;
 
 #define LOG_GENERAL(...) log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
 #define LOG_GENERAL_NC(...) log()->log (__VA_ARGS__, Log::TYPE_GENERAL);
@@ -92,6 +100,8 @@ using dcp::raw_convert;
  * Use <Scale> tag in <VideoContent> rather than <Ratio>.
  * 8 -> 9
  * DCI -> ISDCF
+ * 9 -> 10
+ * Subtitle X and Y scale.
  *
  * Bumped to 32 for 2.0 branch; some times are expressed in Times rather
  * than frames now.
@@ -109,7 +119,6 @@ Film::Film (boost::filesystem::path dir, bool log)
        , _dcp_content_type (Config::instance()->default_dcp_content_type ())
        , _container (Config::instance()->default_container ())
        , _resolution (RESOLUTION_2K)
-       , _scaler (Scaler::from_id ("bicubic"))
        , _signed (true)
        , _encrypted (false)
        , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
@@ -119,13 +128,14 @@ Film::Film (boost::filesystem::path dir, bool log)
        , _three_d (false)
        , _sequence_video (true)
        , _interop (false)
+       , _burn_subtitles (false)
        , _state_version (current_state_version)
        , _dirty (false)
 {
        set_isdcf_date_today ();
 
-       _playlist->Changed.connect (bind (&Film::playlist_changed, this));
-       _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
+       _playlist_changed_connection = _playlist->Changed.connect (bind (&Film::playlist_changed, this));
+       _playlist_content_changed_connection = _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
        
        /* Make state.directory a complete path without ..s (where possible)
           (Code swiped from Adam Bowen on stackoverflow)
@@ -145,7 +155,7 @@ Film::Film (boost::filesystem::path dir, bool log)
                }
        }
 
-       set_directory (result);
+       set_directory (result.make_preferred ());
        if (log) {
                _log.reset (new FileLog (file ("log")));
        } else {
@@ -155,19 +165,25 @@ Film::Film (boost::filesystem::path dir, bool log)
        _playlist->set_sequence_video (_sequence_video);
 }
 
+Film::~Film ()
+{
+       for (list<boost::signals2::connection>::const_iterator i = _job_connections.begin(); i != _job_connections.end(); ++i) {
+               i->disconnect ();
+       }
+}      
+
 string
 Film::video_identifier () const
 {
-       assert (container ());
+       DCPOMATIC_ASSERT (container ());
 
-       stringstream s;
+       SafeStringStream s;
        s.imbue (std::locale::classic ());
        
        s << container()->id()
          << "_" << resolution_to_string (_resolution)
          << "_" << _playlist->video_identifier()
          << "_" << _video_frame_rate
-         << "_" << scaler()->id()
          << "_" << j2k_bandwidth();
 
        if (encrypted ()) {
@@ -182,6 +198,10 @@ Film::video_identifier () const
                s << "_S";
        }
 
+       if (_burn_subtitles) {
+               s << "_B";
+       }
+
        if (_three_d) {
                s << "_3D";
        }
@@ -223,6 +243,12 @@ Film::audio_mxf_filename () const
        return filename_safe_name() + "_audio.mxf";
 }
 
+boost::filesystem::path
+Film::subtitle_xml_filename () const
+{
+       return filename_safe_name() + "_subtitle.xml";
+}
+
 string
 Film::filename_safe_name () const
 {
@@ -255,18 +281,7 @@ Film::make_dcp ()
                throw BadSettingError (_("name"), _("cannot contain slashes"));
        }
 
-       /* It seems to make sense to auto-save metadata here, since the make DCP may last
-          a long time, and crashes/power failures are moderately likely.
-        */
-       write_metadata ();
-
-       LOG_GENERAL ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary());
-
-       {
-               char buffer[128];
-               gethostname (buffer, sizeof (buffer));
-               LOG_GENERAL ("Starting to make DCP on %1", buffer);
-       }
+       environment_info (log ());
 
        ContentList cl = content ();
        for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
@@ -275,29 +290,6 @@ Film::make_dcp ()
        LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
        LOG_GENERAL ("%1 threads", Config::instance()->num_local_encoding_threads());
        LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
-#ifdef DCPOMATIC_DEBUG
-       LOG_GENERAL_NC ("DCP-o-matic built in debug mode.");
-#else
-       LOG_GENERAL_NC ("DCP-o-matic built in optimised mode.");
-#endif
-#ifdef LIBDCP_DEBUG
-       LOG_GENERAL_NC ("libdcp built in debug mode.");
-#else
-       LOG_GENERAL_NC ("libdcp built in optimised mode.");
-#endif
-
-#ifdef DCPOMATIC_WINDOWS
-       OSVERSIONINFO info;
-       info.dwOSVersionInfoSize = sizeof (info);
-       GetVersionEx (&info);
-       LOG_GENERAL ("Windows version %1.%2.%3 SP %4", info.dwMajorVersion, info.dwMinorVersion, info.dwBuildNumber, info.szCSDVersion);
-#endif 
-       
-       LOG_GENERAL ("CPU: %1, %2 processors", cpu_info(), boost::thread::hardware_concurrency ());
-       list<pair<string, string> > const m = mount_info ();
-       for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
-               LOG_GENERAL ("Mount: %1 %2", i->first, i->second);
-       }
        
        if (container() == 0) {
                throw MissingSettingError (_("container"));
@@ -364,7 +356,6 @@ Film::metadata () const
        }
 
        root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
-       root->add_child("Scaler")->add_child_text (_scaler->id ());
        root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
        _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
        root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
@@ -373,6 +364,7 @@ Film::metadata () const
        root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
        root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
        root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
+       root->add_child("BurnSubtitles")->add_child_text (_burn_subtitles ? "1" : "0");
        root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
        root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
        root->add_child("Key")->add_child_text (_key.hex ());
@@ -435,21 +427,34 @@ Film::read_metadata ()
        }
 
        _resolution = string_to_resolution (f.string_child ("Resolution"));
-       _scaler = Scaler::from_id (f.string_child ("Scaler"));
        _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
        _video_frame_rate = f.number_child<int> ("VideoFrameRate");
        _signed = f.optional_bool_child("Signed").get_value_or (true);
        _encrypted = f.bool_child ("Encrypted");
        _audio_channels = f.number_child<int> ("AudioChannels");
+       /* We used to allow odd numbers (and zero) channels, but it's just not worth
+          the pain.
+       */
+       if (_audio_channels == 0) {
+               _audio_channels = 2;
+       } else if ((_audio_channels % 2) == 1) {
+               _audio_channels++;
+       }
        _sequence_video = f.bool_child ("SequenceVideo");
        _three_d = f.bool_child ("ThreeD");
        _interop = f.bool_child ("Interop");
+       if (_state_version >= 32) {
+               _burn_subtitles = f.bool_child ("BurnSubtitles");
+       }
        _key = dcp::Key (f.string_child ("Key"));
 
        list<string> notes;
        /* This method is the only one that can return notes (so far) */
        _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
 
+       /* Write backtraces to this film's directory, until another film is loaded */
+       set_backtrace_file (file ("backtrace.txt"));
+
        _dirty = false;
        return notes;
 }
@@ -488,19 +493,42 @@ Film::file (boost::filesystem::path f) const
 string
 Film::isdcf_name (bool if_created_now) const
 {
-       stringstream d;
+       SafeStringStream d;
 
        string raw_name = name ();
+
+       /* Split the raw name up into words */
+       vector<string> words;
+       split (words, raw_name, is_any_of (" "));
+
        string fixed_name;
-       bool cap_next = true;
-       for (size_t i = 0; i < raw_name.length(); ++i) {
-               if (raw_name[i] == ' ') {
-                       cap_next = true;
-               } else if (cap_next) {
-                       fixed_name += toupper (raw_name[i]);
-                       cap_next = false;
-               } else {
-                       fixed_name += tolower (raw_name[i]);
+       
+       /* Add each word to fixed_name */
+       for (vector<string>::const_iterator i = words.begin(); i != words.end(); ++i) {
+               string w = *i;
+
+               /* First letter is always capitalised */
+               w[0] = toupper (w[0]);
+
+               /* Count caps in w */
+               size_t caps = 0;
+               for (size_t i = 0; i < w.size(); ++i) {
+                       if (isupper (w[i])) {
+                               ++caps;
+                       }
+               }
+               
+               /* If w is all caps make the rest of it lower case, otherwise
+                  leave it alone.
+               */
+               if (caps == w.size ()) {
+                       for (size_t i = 1; i < w.size(); ++i) {
+                               w[i] = tolower (w[i]);
+                       }
+               }
+
+               for (size_t i = 0; i < w.size(); ++i) {
+                       fixed_name += w[i];
                }
        }
 
@@ -553,18 +581,23 @@ Film::isdcf_name (bool if_created_now) const
                d << "_" << container()->isdcf_name();
        }
 
-       /* XXX: this only works for content which has been scaled to a given ratio,
-          and uses the first bit of content only.
-       */
+       ContentList cl = content ();
+       
+       /* XXX: this uses the first bit of content only */
 
        /* The standard says we don't do this for trailers, for some strange reason */
        if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::TRAILER) {
-               ContentList cl = content ();
                Ratio const * content_ratio = 0;
-               for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
+               for (ContentList::iterator i = cl.begin(); i != cl.end(); ++i) {
                        shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (*i);
-                       if (vc && (content_ratio == 0 || vc->scale().ratio() != content_ratio)) {
-                               content_ratio = vc->scale().ratio();
+                       if (vc) {
+                               /* Here's the first piece of video content */
+                               if (vc->scale().ratio ()) {
+                                       content_ratio = vc->scale().ratio ();
+                               } else {
+                                       content_ratio = Ratio::from_ratio (vc->video_size().ratio ());
+                               }
+                               break;
                        }
                }
                
@@ -589,25 +622,34 @@ Film::isdcf_name (bool if_created_now) const
                }
        }
 
-       switch (audio_channels ()) {
-       case 1:
-               d << "_10";
-               break;
-       case 2:
-               d << "_20";
-               break;
-       case 3:
-               d << "_30";
-               break;
-       case 4:
-               d << "_40";
-               break;
-       case 5:
-               d << "_50";
-               break;
-       case 6:
-               d << "_51";
-               break;
+       /* Find all mapped channels */
+
+       list<dcp::Channel> mapped;
+       for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
+               shared_ptr<const AudioContent> ac = dynamic_pointer_cast<const AudioContent> (*i);
+               if (ac) {
+                       list<dcp::Channel> c = ac->audio_mapping().mapped_dcp_channels ();
+                       copy (c.begin(), c.end(), back_inserter (mapped));
+               }
+       }
+
+       mapped.sort ();
+       mapped.unique ();
+       
+       /* Count them */
+                       
+       int non_lfe = 0;
+       int lfe = 0;
+       for (list<dcp::Channel>::const_iterator i = mapped.begin(); i != mapped.end(); ++i) {
+               if ((*i) == dcp::LFE) {
+                       ++lfe;
+               } else {
+                       ++non_lfe;
+               }
+       }
+
+       if (non_lfe) {
+               d << "_" << non_lfe << lfe;
        }
 
        /* XXX: HI/VI */
@@ -656,7 +698,6 @@ Film::dcp_name (bool if_created_now) const
        return name();
 }
 
-
 void
 Film::set_directory (boost::filesystem::path d)
 {
@@ -699,13 +740,6 @@ Film::set_resolution (Resolution r)
        signal_changed (RESOLUTION);
 }
 
-void
-Film::set_scaler (Scaler const * s)
-{
-       _scaler = s;
-       signal_changed (SCALER);
-}
-
 void
 Film::set_j2k_bandwidth (int b)
 {
@@ -748,6 +782,13 @@ Film::set_interop (bool i)
        signal_changed (INTEROP);
 }
 
+void
+Film::set_burn_subtitles (bool b)
+{
+       _burn_subtitles = b;
+       signal_changed (BURN_SUBTITLES);
+}
+
 void
 Film::signal_changed (Property p)
 {
@@ -782,7 +823,7 @@ Film::info_path (int f, Eyes e) const
        boost::filesystem::path p;
        p /= info_dir ();
 
-       stringstream s;
+       SafeStringStream s;
        s.width (8);
        s << setfill('0') << f;
 
@@ -809,7 +850,7 @@ Film::j2c_path (int f, Eyes e, bool t) const
        p /= "j2c";
        p /= video_identifier ();
 
-       stringstream s;
+       SafeStringStream s;
        s.width (8);
        s << setfill('0') << f;
 
@@ -829,7 +870,7 @@ Film::j2c_path (int f, Eyes e, bool t) const
        return file (p);
 }
 
-/** Find all the DCPs in our directory that can be libdcp::DCP::read() and return details of their CPLs */
+/** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs */
 vector<CPLSummary>
 Film::cpls () const
 {
@@ -894,6 +935,13 @@ Film::content () const
        return _playlist->content ();
 }
 
+void
+Film::examine_content (shared_ptr<Content> c)
+{
+       shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
+       JobManager::instance()->add (j);
+}
+
 void
 Film::examine_and_add_content (shared_ptr<Content> c)
 {
@@ -902,7 +950,11 @@ Film::examine_and_add_content (shared_ptr<Content> c)
        }
                        
        shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
-       j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
+
+       _job_connections.push_back (
+               j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)))
+               );
+       
        JobManager::instance()->add (j);
 }
 
@@ -972,7 +1024,11 @@ Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
 {
        if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
                set_video_frame_rate (_playlist->best_dcp_frame_rate ());
-       } 
+       } else if (
+               p == AudioContentProperty::AUDIO_MAPPING ||
+               p == AudioContentProperty::AUDIO_CHANNELS) {
+               signal_changed (NAME);
+       }
 
        if (ui_signaller) {
                ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
@@ -983,6 +1039,7 @@ void
 Film::playlist_changed ()
 {
        signal_changed (CONTENT);
+       signal_changed (NAME);
 }      
 
 int
@@ -1011,7 +1068,7 @@ Film::full_frame () const
                return dcp::Size (4096, 2160);
        }
 
-       assert (false);
+       DCPOMATIC_ASSERT (false);
        return dcp::Size ();
 }
 
@@ -1019,21 +1076,27 @@ Film::full_frame () const
 dcp::Size
 Film::frame_size () const
 {
-       return fit_ratio_within (container()->ratio(), full_frame ());
+       return fit_ratio_within (container()->ratio(), full_frame (), 1);
 }
 
 dcp::EncryptedKDM
 Film::make_kdm (
-       shared_ptr<dcp::Certificate> target,
+       dcp::Certificate target,
        boost::filesystem::path cpl_file,
        dcp::LocalTime from,
-       dcp::LocalTime until
+       dcp::LocalTime until,
+       dcp::Formulation formulation
        ) const
 {
        shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
+       shared_ptr<const dcp::Signer> signer = Config::instance()->signer();
+       if (!signer->valid ()) {
+               throw InvalidSignerError ();
+       }
+       
        return dcp::DecryptedKDM (
-               cpl, from, until, "DCP-o-matic", cpl->content_title_text(), dcp::LocalTime().as_string()
-               ).encrypt (make_signer(), target);
+               cpl, key(), from, until, "DCP-o-matic", cpl->content_title_text(), dcp::LocalTime().as_string()
+               ).encrypt (signer, target, formulation);
 }
 
 list<dcp::EncryptedKDM>
@@ -1041,13 +1104,16 @@ Film::make_kdms (
        list<shared_ptr<Screen> > screens,
        boost::filesystem::path dcp,
        dcp::LocalTime from,
-       dcp::LocalTime until
+       dcp::LocalTime until,
+       dcp::Formulation formulation
        ) const
 {
        list<dcp::EncryptedKDM> kdms;
 
        for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
-               kdms.push_back (make_kdm ((*i)->certificate, dcp, from, until));
+               if ((*i)->certificate) {
+                       kdms.push_back (make_kdm ((*i)->certificate.get(), dcp, from, until, formulation));
+               }
        }
 
        return kdms;
@@ -1077,3 +1143,28 @@ Film::should_be_enough_disk_space (double& required, double& available) const
        available = double (s.available) / 1073741824.0f;
        return (available - required) > 1;
 }
+
+string
+Film::subtitle_language () const
+{
+       set<string> languages;
+       
+       ContentList cl = content ();
+       BOOST_FOREACH (shared_ptr<Content>& c, cl) {
+               shared_ptr<SubtitleContent> sc = dynamic_pointer_cast<SubtitleContent> (c);
+               if (sc) {
+                       languages.insert (sc->subtitle_language ());
+               }
+       }
+
+       string all;
+       BOOST_FOREACH (string s, languages) {
+               if (!all.empty ()) {
+                       all += "/" + s;
+               } else {
+                       all += s;
+               }
+       }
+
+       return all;
+}