/* Copyright (C) 2012-2013 Carl Hetherington 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 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, 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. */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "film.h" #include "job.h" #include "util.h" #include "job_manager.h" #include "transcode_job.h" #include "scp_dcp_job.h" #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 "dcp_content_type.h" #include "ratio.h" #include "cross.h" #include "cinema.h" #include "i18n.h" using std::string; using std::stringstream; using std::multimap; using std::pair; using std::map; using std::vector; 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::weak_ptr; using boost::lexical_cast; using boost::dynamic_pointer_cast; using boost::to_upper_copy; using boost::ends_with; using boost::starts_with; using boost::optional; using libdcp::Size; using libdcp::Signer; /* 5 -> 6 * AudioMapping XML changed. * 6 -> 7 * Subtitle offset changed to subtitle y offset, and subtitle x offset added. * 7 -> 8 * Use tag in rather than . */ int const Film::current_state_version = 8; /** Construct a Film object in a given directory. * * @param dir Film directory. */ Film::Film (boost::filesystem::path dir, bool log) : _playlist (new Playlist) , _use_dci_name (true) , _dcp_content_type (Config::instance()->default_dcp_content_type ()) , _container (Config::instance()->default_container ()) , _resolution (RESOLUTION_2K) , _scaler (Scaler::from_id ("bicubic")) , _with_subtitles (false) , _signed (true) , _encrypted (false) , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ()) , _dci_metadata (Config::instance()->default_dci_metadata ()) , _video_frame_rate (24) , _audio_channels (6) , _three_d (false) , _sequence_video (true) , _interop (false) , _state_version (current_state_version) , _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) */ boost::filesystem::path p (boost::filesystem::system_complete (dir)); boost::filesystem::path result; for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) { if (*i == "..") { if (boost::filesystem::is_symlink (result) || result.filename() == "..") { result /= *i; } else { result = result.parent_path (); } } else if (*i != ".") { result /= *i; } } set_directory (result); if (log) { _log.reset (new FileLog (file ("log"))); } else { _log.reset (new NullLog); } _playlist->set_sequence_video (_sequence_video); } string Film::video_identifier () const { assert (container ()); LocaleGuard lg; stringstream s; s << container()->id() << "_" << resolution_to_string (_resolution) << "_" << _playlist->video_identifier() << "_" << _video_frame_rate << "_" << scaler()->id() << "_" << j2k_bandwidth(); if (encrypted ()) { s << "_E"; } else { s << "_P"; } if (_interop) { s << "_I"; } else { s << "_S"; } if (_three_d) { s << "_3D"; } return s.str (); } /** @return The path to the directory to write video frame info files to */ boost::filesystem::path Film::info_dir () const { boost::filesystem::path p; p /= "info"; p /= video_identifier (); return dir (p); } boost::filesystem::path Film::internal_video_mxf_dir () const { return dir ("video"); } boost::filesystem::path Film::internal_video_mxf_filename () const { return video_identifier() + ".mxf"; } boost::filesystem::path Film::video_mxf_filename () const { return filename_safe_name() + "_video.mxf"; } boost::filesystem::path Film::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; } boost::filesystem::path Film::audio_analysis_path (shared_ptr c) const { boost::filesystem::path p = dir ("analysis"); p /= c->digest(); return p; } /** Add suitable Jobs to the JobManager to create a DCP for this Film */ void Film::make_dcp () { set_dci_date_today (); if (dcp_name().find ("/") != string::npos) { throw BadSettingError (_("name"), _("cannot contain slashes")); } log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary())); { char buffer[128]; gethostname (buffer, sizeof (buffer)); log()->log (String::compose ("Starting to make DCP on %1", buffer)); } ContentList cl = content (); for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) { log()->log (String::compose ("Content: %1", (*i)->technical_summary())); } log()->log (String::compose ("DCP video rate %1 fps", video_frame_rate())); log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads())); log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth())); #ifdef DCPOMATIC_DEBUG log()->log ("DCP-o-matic built in debug mode."); #else log()->log ("DCP-o-matic built in optimised mode."); #endif #ifdef LIBDCP_DEBUG log()->log ("libdcp built in debug mode."); #else log()->log ("libdcp built in optimised mode."); #endif #ifdef DCPOMATIC_WINDOWS OSVERSIONINFO info; info.dwOSVersionInfoSize = sizeof (info); GetVersionEx (&info); log()->log (String::compose ("Windows version %1.%2.%3 SP %4", info.dwMajorVersion, info.dwMinorVersion, info.dwBuildNumber, info.szCSDVersion)); #endif log()->log (String::compose ("CPU: %1, %2 processors", cpu_info(), boost::thread::hardware_concurrency ())); list > const m = mount_info (); for (list >::const_iterator i = m.begin(); i != m.end(); ++i) { log()->log (String::compose ("Mount: %1 %2", i->first, i->second)); } if (container() == 0) { throw MissingSettingError (_("container")); } if (content().empty()) { throw StringError (_("You must add some content to the DCP before creating it")); } if (dcp_content_type() == 0) { throw MissingSettingError (_("content type")); } if (name().empty()) { throw MissingSettingError (_("name")); } JobManager::instance()->add (shared_ptr (new TranscodeJob (shared_from_this()))); } /** Start a job to send our DCP to the configured TMS */ void Film::send_dcp_to_tms () { shared_ptr j (new SCPDCPJob (shared_from_this())); 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 Film::metadata () const { LocaleGuard lg; shared_ptr doc (new xmlpp::Document); xmlpp::Element* root = doc->create_root_node ("Metadata"); root->add_child("Version")->add_child_text (lexical_cast (current_state_version)); root->add_child("Name")->add_child_text (_name); root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0"); if (_dcp_content_type) { root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ()); } if (_container) { root->add_child("Container")->add_child_text (_container->id ()); } root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution)); root->add_child("Scaler")->add_child_text (_scaler->id ()); root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0"); root->add_child("J2KBandwidth")->add_child_text (lexical_cast (_j2k_bandwidth)); _dci_metadata.as_xml (root->add_child ("DCIMetadata")); root->add_child("VideoFrameRate")->add_child_text (lexical_cast (_video_frame_rate)); root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date)); root->add_child("AudioChannels")->add_child_text (lexical_cast (_audio_channels)); 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("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 ()); _playlist->as_xml (root->add_child ("Playlist")); return doc; } /** Write state to our `metadata' file */ void Film::write_metadata () const { boost::filesystem::create_directories (directory ()); shared_ptr doc = metadata (); doc->write_to_file_formatted (file("metadata.xml").string ()); _dirty = false; } /** Read state from our metadata file */ void Film::read_metadata () { 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 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::Document f ("Metadata"); f.read_file (file ("metadata.xml")); _state_version = f.number_child ("Version"); _name = f.string_child ("Name"); _use_dci_name = f.bool_child ("UseDCIName"); { optional c = f.optional_string_child ("DCPContentType"); if (c) { _dcp_content_type = DCPContentType::from_dci_name (c.get ()); } } { optional c = f.optional_string_child ("Container"); if (c) { _container = Ratio::from_id (c.get ()); } } _resolution = string_to_resolution (f.string_child ("Resolution")); _scaler = Scaler::from_id (f.string_child ("Scaler")); _with_subtitles = f.bool_child ("WithSubtitles"); _j2k_bandwidth = f.number_child ("J2KBandwidth"); _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata")); _video_frame_rate = f.number_child ("VideoFrameRate"); _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate")); _signed = f.optional_bool_child("Signed").get_value_or (true); _encrypted = f.bool_child ("Encrypted"); _audio_channels = f.number_child ("AudioChannels"); _sequence_video = f.bool_child ("SequenceVideo"); _three_d = f.bool_child ("ThreeD"); _interop = f.bool_child ("Interop"); _key = libdcp::Key (f.string_child ("Key")); _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version); _dirty = false; } /** Given a directory name, return its full path within the Film's directory. * The directory (and its parents) will be created if they do not exist. */ boost::filesystem::path Film::dir (boost::filesystem::path d) const { boost::filesystem::path p; p /= _directory; p /= d; boost::filesystem::create_directories (p); return p; } /** Given a file or directory name, return its full path within the Film's directory. * Any required parent directories will be created. */ boost::filesystem::path Film::file (boost::filesystem::path f) const { boost::filesystem::path p; p /= _directory; p /= f; boost::filesystem::create_directories (p.parent_path ()); return p; } /** @return a DCI-compliant name for a DCP of this film */ string Film::dci_name (bool if_created_now) const { stringstream d; string fixed_name = to_upper_copy (name()); for (size_t i = 0; i < fixed_name.length(); ++i) { if (fixed_name[i] == ' ') { fixed_name[i] = '-'; } } /* Spec is that the name part should be maximum 14 characters, as I understand it */ if (fixed_name.length() > 14) { fixed_name = fixed_name.substr (0, 14); } d << fixed_name; if (dcp_content_type()) { d << "_" << dcp_content_type()->dci_name(); d << "-" << dci_metadata().content_version; } if (three_d ()) { d << "-3D"; } if (video_frame_rate() != 24) { d << "-" << video_frame_rate(); } if (container()) { d << "_" << container()->dci_name(); } DCIMetadata const dm = dci_metadata (); if (!dm.audio_language.empty ()) { d << "_" << dm.audio_language; if (!dm.subtitle_language.empty()) { d << "-" << dm.subtitle_language; } else { d << "-XX"; } } if (!dm.territory.empty ()) { d << "_" << dm.territory; if (!dm.rating.empty ()) { d << "-" << dm.rating; } } 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; } d << "_" << resolution_to_string (_resolution); if (!dm.studio.empty ()) { d << "_" << dm.studio; } if (if_created_now) { d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ()); } else { d << "_" << boost::gregorian::to_iso_string (_dci_date); } if (!dm.facility.empty ()) { d << "_" << dm.facility; } if (!dm.package_type.empty ()) { d << "_" << dm.package_type; } return d.str (); } /** @return name to give the DCP */ string Film::dcp_name (bool if_created_now) const { if (use_dci_name()) { return dci_name (if_created_now); } return name(); } void Film::set_directory (boost::filesystem::path d) { _directory = d; _dirty = true; } void Film::set_name (string n) { _name = n; signal_changed (NAME); } void Film::set_use_dci_name (bool u) { _use_dci_name = u; signal_changed (USE_DCI_NAME); } void Film::set_dcp_content_type (DCPContentType const * t) { _dcp_content_type = t; signal_changed (DCP_CONTENT_TYPE); } void Film::set_container (Ratio const * c) { _container = c; signal_changed (CONTAINER); } void Film::set_resolution (Resolution r) { _resolution = r; signal_changed (RESOLUTION); } void Film::set_scaler (Scaler const * s) { _scaler = s; signal_changed (SCALER); } void Film::set_with_subtitles (bool w) { _with_subtitles = w; signal_changed (WITH_SUBTITLES); } void Film::set_j2k_bandwidth (int b) { _j2k_bandwidth = b; signal_changed (J2K_BANDWIDTH); } void Film::set_dci_metadata (DCIMetadata m) { _dci_metadata = m; signal_changed (DCI_METADATA); } void Film::set_video_frame_rate (int f) { _video_frame_rate = f; signal_changed (VIDEO_FRAME_RATE); } void Film::set_audio_channels (int c) { _audio_channels = c; signal_changed (AUDIO_CHANNELS); } void Film::set_three_d (bool t) { _three_d = t; signal_changed (THREE_D); } void Film::set_interop (bool i) { _interop = i; signal_changed (INTEROP); } void Film::signal_changed (Property p) { _dirty = true; switch (p) { case Film::CONTENT: set_video_frame_rate (_playlist->best_dcp_frame_rate ()); break; case Film::VIDEO_FRAME_RATE: case Film::SEQUENCE_VIDEO: _playlist->maybe_sequence_video (); break; default: break; } if (ui_signaller) { ui_signaller->emit (boost::bind (boost::ref (Changed), p)); } } void Film::set_dci_date_today () { _dci_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 (); stringstream 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 { boost::filesystem::path p; p /= "j2c"; p /= video_identifier (); stringstream s; s.width (8); s << setfill('0') << f; if (e == EYES_LEFT) { s << ".L"; } else if (e == EYES_RIGHT) { s << ".R"; } s << ".j2c"; if (t) { s << ".tmp"; } p /= s.str(); return file (p); } /** @return List of subdirectories (not full paths) containing DCPs that can be successfully libdcp::DCP::read() */ list Film::dcps () const { list out; boost::filesystem::path const dir = directory (); for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) { if ( boost::filesystem::is_directory (*i) && i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis" ) { try { libdcp::DCP dcp (*i); dcp.read (); out.push_back (i->path().leaf ()); } catch (...) { } } } return out; } shared_ptr Film::make_player () const { return shared_ptr (new Player (shared_from_this (), _playlist)); } void Film::set_signed (bool s) { _signed = s; signal_changed (SIGNED); } void Film::set_encrypted (bool e) { _encrypted = e; signal_changed (ENCRYPTED); } shared_ptr Film::playlist () const { return _playlist; } ContentList Film::content () const { return _playlist->content (); } void Film::examine_and_add_content (shared_ptr c) { shared_ptr j (new ExamineContentJob (shared_from_this(), c)); j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr (j), boost::weak_ptr (c))); JobManager::instance()->add (j); } void Film::maybe_add_content (weak_ptr j, weak_ptr c) { shared_ptr job = j.lock (); if (!job || !job->finished_ok ()) { return; } shared_ptr content = c.lock (); if (content) { add_content (content); } } void Film::add_content (shared_ptr c) { /* Add video content after any existing content */ if (dynamic_pointer_cast (c)) { c->set_position (_playlist->video_end ()); } _playlist->add (c); } void Film::remove_content (shared_ptr c) { _playlist->remove (c); } void Film::move_content_earlier (shared_ptr c) { _playlist->move_earlier (c); } void Film::move_content_later (shared_ptr c) { _playlist->move_later (c); } Time Film::length () const { return _playlist->length (); } bool Film::has_subtitles () const { return _playlist->has_subtitles (); } OutputVideoFrame Film::best_video_frame_rate () const { return _playlist->best_dcp_frame_rate (); } void Film::playlist_content_changed (boost::weak_ptr c, int p) { if (p == VideoContentProperty::VIDEO_FRAME_RATE) { set_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); } OutputAudioFrame Film::time_to_audio_frames (Time t) const { return divide_with_round (t * audio_frame_rate (), TIME_HZ); } OutputVideoFrame Film::time_to_video_frames (Time t) const { return divide_with_round (t * video_frame_rate (), TIME_HZ); } Time Film::audio_frames_to_time (OutputAudioFrame f) const { return divide_with_round (f * TIME_HZ, audio_frame_rate ()); } Time Film::video_frames_to_time (OutputVideoFrame f) const { return divide_with_round (f * TIME_HZ, video_frame_rate ()); } OutputAudioFrame Film::audio_frame_rate () const { /* XXX */ return 48000; } void Film::set_sequence_video (bool s) { _sequence_video = s; _playlist->set_sequence_video (s); signal_changed (SEQUENCE_VIDEO); } libdcp::Size Film::full_frame () const { switch (_resolution) { case RESOLUTION_2K: return libdcp::Size (2048, 1080); case RESOLUTION_4K: return libdcp::Size (4096, 2160); } assert (false); return libdcp::Size (); } libdcp::KDM Film::make_kdm ( shared_ptr target, boost::filesystem::path dcp_dir, boost::posix_time::ptime from, boost::posix_time::ptime until ) const { shared_ptr signer = make_signer (); libdcp::DCP dcp (dir (dcp_dir.string ())); try { dcp.read (); } catch (...) { throw KDMError (_("Could not read DCP to make KDM for")); } time_t now = time (0); struct tm* tm = localtime (&now); string const issue_date = libdcp::tm_to_string (tm); dcp.cpls().front()->set_mxf_keys (key ()); return libdcp::KDM (dcp.cpls().front(), signer, target, from, until, "DCP-o-matic", issue_date); } list Film::make_kdms ( list > screens, boost::filesystem::path dcp, boost::posix_time::ptime from, boost::posix_time::ptime until ) const { list kdms; for (list >::iterator i = screens.begin(); i != screens.end(); ++i) { kdms.push_back (make_kdm ((*i)->certificate, dcp, from, until)); } return kdms; } /** @return The approximate disk space required to encode a DCP of this film with the * current settings, in bytes. */ uint64_t Film::required_disk_space () const { return uint64_t (j2k_bandwidth() / 8) * length() / TIME_HZ; } /** This method checks the disk that the Film is on and tries to decide whether or not * there will be enough space to make a DCP for it. If so, true is returned; if not, * false is returned and required and availabe are filled in with the amount of disk space * required and available respectively (in Gb). * * Note: the decision made by this method isn't, of course, 100% reliable. */ bool Film::should_be_enough_disk_space (double& required, double& available) const { boost::filesystem::space_info s = boost::filesystem::space (internal_video_mxf_dir ()); required = double (required_disk_space ()) / 1073741824.0f; available = double (s.available) / 1073741824.0f; return (available - required) > 1; }