Hand-apply 62f8054d65a8bd31689fc0c977c1bb2385e71afa from master; config of encryption...
[dcpomatic.git] / src / lib / film.cc
index a8e05b751c267ea6eb3800a4829abdd674d49aaa..5e08ed9979844500c9e16b6f979c93c4edb32919 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
 
 */
 
+/** @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"
@@ -26,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 "cross.h"
 #include "cinema.h"
 #include "safe_stringstream.h"
+#include "environment_info.h"
+#include "raw_convert.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>
@@ -82,8 +86,6 @@ 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);
@@ -115,7 +117,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 ())
@@ -131,8 +132,8 @@ Film::Film (boost::filesystem::path dir, bool log)
 {
        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)
@@ -162,6 +163,13 @@ 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
 {
@@ -174,7 +182,6 @@ Film::video_identifier () const
          << "_" << resolution_to_string (_resolution)
          << "_" << _playlist->video_identifier()
          << "_" << _video_frame_rate
-         << "_" << scaler()->id()
          << "_" << j2k_bandwidth();
 
        if (encrypted ()) {
@@ -200,14 +207,14 @@ Film::video_identifier () const
        return s.str ();
 }
          
-/** @return The path to the directory to write video frame info files to */
+/** @return The file to write video frame info to */
 boost::filesystem::path
-Film::info_dir () const
+Film::info_file () const
 {
        boost::filesystem::path p;
        p /= "info";
        p /= video_identifier ();
-       return dir (p);
+       return file (p);
 }
 
 boost::filesystem::path
@@ -272,13 +279,7 @@ Film::make_dcp ()
                throw BadSettingError (_("name"), _("cannot contain slashes"));
        }
 
-       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) {
@@ -287,29 +288,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"));
@@ -338,25 +316,6 @@ Film::send_dcp_to_tms ()
        JobManager::instance()->add (j);
 }
 
-/** Count the number of frames that have been encoded for this film.
- *  @return frame count.
- */
-int
-Film::encoded_frames () const
-{
-       if (container() == 0) {
-               return 0;
-       }
-
-       int N = 0;
-       for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
-               ++N;
-               boost::this_thread::interruption_point ();
-       }
-
-       return N;
-}
-
 shared_ptr<xmlpp::Document>
 Film::metadata () const
 {
@@ -376,7 +335,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));
@@ -448,12 +406,19 @@ 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");
@@ -595,11 +560,12 @@ Film::isdcf_name (bool if_created_now) const
                d << "_" << container()->isdcf_name();
        }
 
+       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::iterator i = cl.begin(); i != cl.end(); ++i) {
                        shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (*i);
@@ -635,25 +601,39 @@ 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 (static_cast<int> (*i) >= audio_channels()) {
+                       /* This channel is mapped but is not included in the DCP */
+                       continue;
+               }
+               
+               if ((*i) == dcp::LFE) {
+                       ++lfe;
+               } else {
+                       ++non_lfe;
+               }
+       }
+
+       if (non_lfe) {
+               d << "_" << non_lfe << lfe;
        }
 
        /* XXX: HI/VI */
@@ -744,13 +724,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)
 {
@@ -828,32 +801,6 @@ Film::set_isdcf_date_today ()
        _isdcf_date = boost::gregorian::day_clock::local_day ();
 }
 
-boost::filesystem::path
-Film::info_path (int f, Eyes e) const
-{
-       boost::filesystem::path p;
-       p /= info_dir ();
-
-       SafeStringStream s;
-       s.width (8);
-       s << setfill('0') << f;
-
-       if (e == EYES_LEFT) {
-               s << ".L";
-       } else if (e == EYES_RIGHT) {
-               s << ".R";
-       }
-
-       s << ".md5";
-       
-       p /= s.str();
-
-       /* info_dir() will already have added any initial bit of the path,
-          so don't call file() on this.
-       */
-       return p;
-}
-
 boost::filesystem::path
 Film::j2c_path (int f, Eyes e, bool t) const
 {
@@ -934,6 +881,13 @@ Film::set_encrypted (bool e)
        signal_changed (ENCRYPTED);
 }
 
+void
+Film::set_key (dcp::Key key)
+{
+       _key = key;
+       signal_changed (KEY);
+}
+
 shared_ptr<Playlist>
 Film::playlist () const
 {
@@ -947,21 +901,25 @@ Film::content () const
 }
 
 void
-Film::examine_content (shared_ptr<Content> c, bool calculate_digest)
+Film::examine_content (shared_ptr<Content> c)
 {
-       shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c, calculate_digest));
+       shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
        JobManager::instance()->add (j);
 }
 
 void
-Film::examine_and_add_content (shared_ptr<Content> c, bool calculate_digest)
+Film::examine_and_add_content (shared_ptr<Content> c)
 {
        if (dynamic_pointer_cast<FFmpegContent> (c)) {
                run_ffprobe (c->path(0), file ("ffprobe.log"), _log);
        }
                        
-       shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c, calculate_digest));
-       j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
+       shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), 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);
 }
 
@@ -1031,7 +989,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));
@@ -1042,6 +1004,7 @@ void
 Film::playlist_changed ()
 {
        signal_changed (CONTENT);
+       signal_changed (NAME);
 }      
 
 int