Merge master.
[dcpomatic.git] / src / lib / film.cc
index a6a53b3fccaaade906785589862cbc8ab4534214..487499e32acd8698ed2ca6f6b87ab0e24e7e558c 100644 (file)
@@ -1,3 +1,5 @@
+/* -*- c-basic-offset: 8; default-tab-width: 8; -*- */
+
 /*
     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
 
@@ -35,7 +37,6 @@
 #include "format.h"
 #include "job.h"
 #include "filter.h"
-#include "transcoder.h"
 #include "util.h"
 #include "job_manager.h"
 #include "ab_transcode_job.h"
 #include "config.h"
 #include "version.h"
 #include "ui_signaller.h"
-#include "video_decoder.h"
-#include "audio_decoder.h"
-#include "sndfile_decoder.h"
 #include "analyse_audio_job.h"
 #include "playlist.h"
+#include "player.h"
 #include "ffmpeg_content.h"
 #include "imagemagick_content.h"
 #include "sndfile_content.h"
+#include "dcp_content_type.h"
 
 #include "i18n.h"
 
@@ -71,6 +71,7 @@ using std::setfill;
 using std::min;
 using std::make_pair;
 using std::endl;
+using std::cout;
 using std::list;
 using boost::shared_ptr;
 using boost::lexical_cast;
@@ -91,13 +92,15 @@ int const Film::state_version = 4;
  */
 
 Film::Film (string d, bool must_exist)
-       : _use_dci_name (true)
+       : _playlist (new Playlist)
+       , _use_dci_name (true)
        , _trust_content_headers (true)
-       , _dcp_content_type (0)
-       , _format (0)
+       , _dcp_content_type (Config::instance()->default_dcp_content_type ())
+       , _format (Config::instance()->default_format ())
        , _scaler (Scaler::from_id ("bicubic"))
        , _trim_start (0)
        , _trim_end (0)
+       , _trim_type (CPL)
        , _ab (false)
        , _audio_gain (0)
        , _audio_delay (0)
@@ -107,10 +110,13 @@ Film::Film (string d, bool must_exist)
        , _colour_lut (0)
        , _j2k_bandwidth (200000000)
        , _dci_metadata (Config::instance()->default_dci_metadata ())
-       , _dcp_frame_rate (0)
+       , _dcp_video_frame_rate (0)
        , _dirty (false)
 {
        set_dci_date_today ();
+
+       _playlist->Changed.connect (bind (&Film::playlist_changed, this));
+       _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)
@@ -142,6 +148,8 @@ Film::Film (string d, bool must_exist)
 
        if (must_exist) {
                read_metadata ();
+       } else {
+               write_metadata ();
        }
 
        _log.reset (new FileLog (file ("log")));
@@ -151,6 +159,7 @@ Film::Film (Film const & o)
        : boost::enable_shared_from_this<Film> (o)
        /* note: the copied film shares the original's log */
        , _log               (o._log)
+       , _playlist          (new Playlist (o._playlist))
        , _directory         (o._directory)
        , _name              (o._name)
        , _use_dci_name      (o._use_dci_name)
@@ -162,6 +171,7 @@ Film::Film (Film const & o)
        , _scaler            (o._scaler)
        , _trim_start        (o._trim_start)
        , _trim_end          (o._trim_end)
+       , _trim_type         (o._trim_type)
        , _ab                (o._ab)
        , _audio_gain        (o._audio_gain)
        , _audio_delay       (o._audio_delay)
@@ -171,34 +181,26 @@ Film::Film (Film const & o)
        , _colour_lut        (o._colour_lut)
        , _j2k_bandwidth     (o._j2k_bandwidth)
        , _dci_metadata      (o._dci_metadata)
+       , _dcp_video_frame_rate (o._dcp_video_frame_rate)
        , _dci_date          (o._dci_date)
-       , _dcp_frame_rate    (o._dcp_frame_rate)
        , _dirty             (o._dirty)
 {
-       
-}
-
-Film::~Film ()
-{
-
+       _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
 }
 
 string
 Film::video_state_identifier () const
 {
        assert (format ());
-
-       return "XXX";
-
-#if 0  
+       LocaleGuard lg;
 
        pair<string, string> f = Filter::ffmpeg_strings (filters());
 
        stringstream s;
        s << format()->id()
-         << "_" << content_digest()
+         << "_" << _playlist->video_digest()
          << "_" << crop().left << "_" << crop().right << "_" << crop().top << "_" << crop().bottom
-         << "_" << _dcp_frame_rate
+         << "_" << _dcp_video_frame_rate
          << "_" << f.first << "_" << f.second
          << "_" << scaler()->id()
          << "_" << j2k_bandwidth()
@@ -210,7 +212,6 @@ Film::video_state_identifier () const
        }
 
        return s.str ();
-#endif 
 }
          
 /** @return The path to the directory to write video frame info files to */
@@ -224,24 +225,52 @@ Film::info_dir () const
 }
 
 string
-Film::video_mxf_dir () const
+Film::internal_video_mxf_dir () const
 {
        boost::filesystem::path p;
        return dir ("video");
 }
 
 string
-Film::video_mxf_filename () const
+Film::internal_video_mxf_filename () const
 {
        return video_state_identifier() + ".mxf";
 }
 
+string
+Film::dcp_video_mxf_filename () const
+{
+       return filename_safe_name() + "_video.mxf";
+}
+
+string
+Film::dcp_audio_mxf_filename () const
+{
+       return filename_safe_name() + "_audio.mxf";
+}
+
+string
+Film::filename_safe_name () const
+{
+       string const n = name ();
+       string o;
+       for (size_t i = 0; i < n.length(); ++i) {
+               if (isalnum (n[i])) {
+                       o += n[i];
+               } else {
+                       o += "_";
+               }
+       }
+
+       return o;
+}
+
 string
 Film::audio_analysis_path () const
 {
        boost::filesystem::path p;
        p /= "analysis";
-       p /= "XXX";//content_digest();
+       p /= _playlist->audio_digest();
        return file (p.string ());
 }
 
@@ -255,7 +284,7 @@ Film::make_dcp ()
                throw BadSettingError (_("name"), _("cannot contain slashes"));
        }
        
-       log()->log (String::compose ("DVD-o-matic %1 git %2 using %3", dvdomatic_version, dvdomatic_git_commit, dependency_version_summary()));
+       log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary()));
 
        {
                char buffer[128];
@@ -271,10 +300,10 @@ Film::make_dcp ()
 //     log()->log (String::compose ("Content at %1 fps, DCP at %2 fps", source_frame_rate(), dcp_frame_rate()));
        log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
        log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
-#ifdef DVDOMATIC_DEBUG
-       log()->log ("DVD-o-matic built in debug mode.");
+#ifdef DCPOMATIC_DEBUG
+       log()->log ("DCP-o-matic built in debug mode.");
 #else
-       log()->log ("DVD-o-matic built in optimised mode.");
+       log()->log ("DCP-o-matic built in optimised mode.");
 #endif
 #ifdef LIBDCP_DEBUG
        log()->log ("libdcp built in debug mode.");
@@ -288,8 +317,8 @@ Film::make_dcp ()
                throw MissingSettingError (_("format"));
        }
 
-       if (content().empty ()) {
-               throw MissingSettingError (_("content"));
+       if (_playlist->content().empty ()) {
+               throw StringError (_("You must add some content to the DCP before creating it"));
        }
 
        if (dcp_content_type() == 0) {
@@ -309,7 +338,7 @@ Film::make_dcp ()
        }
 }
 
-/** Start a job to analyse the audio of our content file */
+/** Start a job to analyse the audio in our Playlist */
 void
 Film::analyse_audio ()
 {
@@ -327,7 +356,6 @@ void
 Film::examine_content (shared_ptr<Content> c)
 {
        shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c, trust_content_headers ()));
-       j->Finished.connect (bind (&Film::examine_content_finished, this));
        JobManager::instance()->add (j);
 }
 
@@ -343,12 +371,6 @@ Film::analyse_audio_finished ()
        _analyse_audio_job.reset ();
 }
 
-void
-Film::examine_content_finished ()
-{
-       /* XXX */
-}
-
 /** Start a job to send our DCP to the configured TMS */
 void
 Film::send_dcp_to_tms ()
@@ -380,9 +402,8 @@ Film::encoded_frames () const
 void
 Film::write_metadata () const
 {
-       ContentList the_content = content ();
-       
        boost::mutex::scoped_lock lm (_state_mutex);
+       LocaleGuard lg;
 
        boost::filesystem::create_directories (directory());
 
@@ -393,12 +414,23 @@ Film::write_metadata () const
        root->add_child("Name")->add_child_text (_name);
        root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
        root->add_child("TrustContentHeaders")->add_child_text (_trust_content_headers ? "1" : "0");
+
        if (_dcp_content_type) {
                root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ());
        }
+
        if (_format) {
                root->add_child("Format")->add_child_text (_format->id ());
        }
+
+       switch (_trim_type) {
+       case CPL:
+               root->add_child("TrimType")->add_child_text ("CPL");
+               break;
+       case ENCODE:
+               root->add_child("TrimType")->add_child_text ("Encode");
+       }
+                       
        root->add_child("LeftCrop")->add_child_text (boost::lexical_cast<string> (_crop.left));
        root->add_child("RightCrop")->add_child_text (boost::lexical_cast<string> (_crop.right));
        root->add_child("TopCrop")->add_child_text (boost::lexical_cast<string> (_crop.top));
@@ -420,12 +452,9 @@ Film::write_metadata () const
        root->add_child("ColourLUT")->add_child_text (boost::lexical_cast<string> (_colour_lut));
        root->add_child("J2KBandwidth")->add_child_text (boost::lexical_cast<string> (_j2k_bandwidth));
        _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
+       root->add_child("DCPVideoFrameRate")->add_child_text (boost::lexical_cast<string> (_dcp_video_frame_rate));
        root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date));
-       root->add_child("DCPFrameRate")->add_child_text (boost::lexical_cast<string> (_dcp_frame_rate));
-
-       for (ContentList::iterator i = the_content.begin(); i != the_content.end(); ++i) {
-               (*i)->as_xml (root->add_child ("Content"));
-       }
+       _playlist->as_xml (root->add_child ("Playlist"));
 
        doc.write_to_file_formatted (file ("metadata.xml"));
        
@@ -437,9 +466,10 @@ void
 Film::read_metadata ()
 {
        boost::mutex::scoped_lock lm (_state_mutex);
+       LocaleGuard lg;
 
        if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
-               throw StringError (_("This film was created with an older version of DVD-o-matic, and unfortunately it cannot be loaded into this version.  You will need to create a new Film, re-add your content and set it up again.  Sorry!"));
+               throw StringError (_("This film was created with an older version of DCP-o-matic, and unfortunately it cannot be loaded into this version.  You will need to create a new Film, re-add your content and set it up again.  Sorry!"));
        }
 
        cxml::File f (file ("metadata.xml"), "Metadata");
@@ -462,10 +492,19 @@ Film::read_metadata ()
                }
        }
 
-       _crop.left = f.number_child<int> ("CropLeft");
-       _crop.right = f.number_child<int> ("CropRight");
-       _crop.top = f.number_child<int> ("CropTop");
-       _crop.bottom = f.number_child<int> ("CropBottom");
+       {
+               optional<string> c = f.optional_string_child ("TrimType");
+               if (!c || c.get() == "CPL") {
+                       _trim_type = CPL;
+               } else if (c && c.get() == "Encode") {
+                       _trim_type = ENCODE;
+               }
+       }
+
+       _crop.left = f.number_child<int> ("LeftCrop");
+       _crop.right = f.number_child<int> ("RightCrop");
+       _crop.top = f.number_child<int> ("TopCrop");
+       _crop.bottom = f.number_child<int> ("BottomCrop");
 
        {
                list<shared_ptr<cxml::Node> > c = f.node_children ("Filter");
@@ -486,22 +525,10 @@ Film::read_metadata ()
        _colour_lut = f.number_child<int> ("ColourLUT");
        _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
        _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
+       _dcp_video_frame_rate = f.number_child<int> ("DCPVideoFrameRate");
        _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
-       _dcp_frame_rate = f.number_child<int> ("DCPFrameRate");
 
-       list<shared_ptr<cxml::Node> > c = f.node_children ("Content");
-       for (list<shared_ptr<cxml::Node> >::iterator i = c.begin(); i != c.end(); ++i) {
-
-               string const type = (*i)->string_child ("Type");
-               
-               if (type == "FFmpeg") {
-                       _content.push_back (shared_ptr<Content> (new FFmpegContent (*i)));
-               } else if (type == "ImageMagick") {
-                       _content.push_back (shared_ptr<Content> (new ImageMagickContent (*i)));
-               } else if (type == "Sndfile") {
-                       _content.push_back (shared_ptr<Content> (new SndfileContent (*i)));
-               }
-       }
+       _playlist->set_from_xml (f.node_child ("Playlist"));
 
        _dirty = false;
 }
@@ -550,35 +577,6 @@ Film::file (string f) const
        return p.string ();
 }
 
-/** @return The sampling rate that we will resample the audio to */
-int
-Film::target_audio_sample_rate () const
-{
-       /* XXX: how often is this method called? */
-       
-       boost::shared_ptr<Playlist> p = playlist ();
-       if (p->has_audio ()) {
-               return 0;
-       }
-       
-       /* Resample to a DCI-approved sample rate */
-       double t = dcp_audio_sample_rate (p->audio_frame_rate());
-
-       FrameRateConversion frc (p->video_frame_rate(), dcp_frame_rate());
-
-       /* Compensate if the DCP is being run at a different frame rate
-          to the source; that is, if the video is run such that it will
-          look different in the DCP compared to the source (slower or faster).
-          skip/repeat doesn't come into effect here.
-       */
-
-       if (frc.change_speed) {
-               t *= p->video_frame_rate() * frc.factor() / dcp_frame_rate();
-       }
-
-       return rint (t);
-}
-
 /** @return a DCI-compliant name for a DCP of this film */
 string
 Film::dci_name (bool if_created_now) const
@@ -625,23 +623,7 @@ Film::dci_name (bool if_created_now) const
                }
        }
 
-       /* XXX */
-       switch (2) {
-       case 1:
-               d << "_10";
-               break;
-       case 2:
-               d << "_20";
-               break;
-       case 6:
-               d << "_51";
-               break;
-       case 8:
-               d << "_71";
-               break;
-       }
-
-       d << "_2K";
+       d << "_51_2K";
 
        if (!dm.studio.empty ()) {
                d << "_" << dm.studio;
@@ -713,11 +695,13 @@ Film::set_trust_content_headers (bool t)
        }
        
        signal_changed (TRUST_CONTENT_HEADERS);
-
-       if (!_trust_content_headers && !content().empty()) {
+       
+       Playlist::ContentList content = _playlist->content ();
+       if (!_trust_content_headers && !content.empty()) {
                /* We just said that we don't trust the content's header */
-               /* XXX */
-//             examine_content ();
+               for (Playlist::ContentList::iterator i = content.begin(); i != content.end(); ++i) {
+                       examine_content (*i);
+               }
        }
 }
               
@@ -848,6 +832,16 @@ Film::set_trim_end (int t)
        signal_changed (TRIM_END);
 }
 
+void
+Film::set_trim_type (TrimType t)
+{
+       {
+               boost::mutex::scoped_lock lm (_state_mutex);
+               _trim_type = t;
+       }
+       signal_changed (TRIM_TYPE);
+}
+
 void
 Film::set_ab (bool a)
 {
@@ -940,13 +934,13 @@ Film::set_dci_metadata (DCIMetadata m)
 
 
 void
-Film::set_dcp_frame_rate (int f)
+Film::set_dcp_video_frame_rate (int f)
 {
        {
                boost::mutex::scoped_lock lm (_state_mutex);
-               _dcp_frame_rate = f;
+               _dcp_video_frame_rate = f;
        }
-       signal_changed (DCP_FRAME_RATE);
+       signal_changed (DCP_VIDEO_FRAME_RATE);
 }
 
 void
@@ -957,6 +951,14 @@ Film::signal_changed (Property p)
                _dirty = true;
        }
 
+       switch (p) {
+       case Film::CONTENT:
+               set_dcp_video_frame_rate (_playlist->best_dcp_frame_rate ());
+               break;
+       default:
+               break;
+       }
+
        if (ui_signaller) {
                ui_signaller->emit (boost::bind (boost::ref (Changed), p));
        }
@@ -1023,22 +1025,114 @@ Film::have_dcp () const
        return true;
 }
 
+shared_ptr<Player>
+Film::player () const
+{
+       boost::mutex::scoped_lock lm (_state_mutex);
+       return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
+}
+
 shared_ptr<Playlist>
 Film::playlist () const
 {
        boost::mutex::scoped_lock lm (_state_mutex);
-       return shared_ptr<Playlist> (new Playlist (shared_from_this (), _content));
+       return _playlist;
+}
+
+Playlist::ContentList
+Film::content () const
+{
+       return _playlist->content ();
 }
 
 void
 Film::add_content (shared_ptr<Content> c)
 {
-       {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               _content.push_back (c);
+       _playlist->add (c);
+       examine_content (c);
+}
+
+void
+Film::remove_content (shared_ptr<Content> c)
+{
+       _playlist->remove (c);
+}
+
+Time
+Film::length () const
+{
+       return _playlist->length (shared_from_this ());
+}
+
+bool
+Film::has_subtitles () const
+{
+       return _playlist->has_subtitles ();
+}
+
+OutputVideoFrame
+Film::best_dcp_video_frame_rate () const
+{
+       return _playlist->best_dcp_frame_rate ();
+}
+
+void
+Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
+{
+       if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
+               set_dcp_video_frame_rate (_playlist->best_dcp_frame_rate ());
+       } 
+
+       if (ui_signaller) {
+               ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
        }
+}
 
+void
+Film::playlist_changed ()
+{
        signal_changed (CONTENT);
+}      
 
-       examine_content (c);
+int
+Film::loop () const
+{
+       return _playlist->loop ();
+}
+
+void
+Film::set_loop (int c)
+{
+       _playlist->set_loop (c);
+}
+
+OutputAudioFrame
+Film::time_to_audio_frames (Time t) const
+{
+       return t * dcp_audio_frame_rate () / TIME_HZ;
+}
+
+OutputVideoFrame
+Film::time_to_video_frames (Time t) const
+{
+       return t * dcp_video_frame_rate () / TIME_HZ;
+}
+
+Time
+Film::audio_frames_to_time (OutputAudioFrame f) const
+{
+       return f * TIME_HZ / dcp_audio_frame_rate ();
+}
+
+Time
+Film::video_frames_to_time (OutputVideoFrame f) const
+{
+       return f * TIME_HZ / dcp_video_frame_rate ();
+}
+
+OutputAudioFrame
+Film::dcp_audio_frame_rate () const
+{
+       /* XXX */
+       return 48000;
 }