From df5228d00d70d68218e7f606131a0c5fa2caba9f Mon Sep 17 00:00:00 2001 From: Carl Hetherington Date: Sat, 18 Dec 2021 14:23:50 +0100 Subject: [PATCH] Move make_dcp() out of Film (#2132). --- src/lib/film.cc | 63 ------------------- src/lib/film.h | 1 - src/lib/make_dcp.cc | 105 ++++++++++++++++++++++++++++++++ src/lib/make_dcp.h | 29 +++++++++ src/lib/wscript | 1 + src/tools/dcpomatic.cc | 107 +++++++++++++++++---------------- src/tools/dcpomatic_batch.cc | 5 +- src/tools/dcpomatic_cli.cc | 6 +- test/interrupt_encoder_test.cc | 3 +- test/reels_test.cc | 3 +- test/test.cc | 3 +- test/threed_test.cc | 3 +- 12 files changed, 204 insertions(+), 125 deletions(-) create mode 100644 src/lib/make_dcp.cc create mode 100644 src/lib/make_dcp.h diff --git a/src/lib/film.cc b/src/lib/film.cc index 718d6c61d..7cf67546e 100644 --- a/src/lib/film.cc +++ b/src/lib/film.cc @@ -377,69 +377,6 @@ Film::subtitle_analysis_path (shared_ptr content) const } -/** Add suitable Jobs to the JobManager to create a DCP for this Film */ -void -Film::make_dcp (TranscodeJob::ChangedBehaviour behaviour) -{ - if (dcp_name().find ("/") != string::npos) { - throw BadSettingError (_("name"), _("Cannot contain slashes")); - } - - if (container() == nullptr) { - throw MissingSettingError (_("container")); - } - - if (content().empty()) { - throw runtime_error (_("You must add some content to the DCP before creating it")); - } - - if (length() == DCPTime()) { - throw runtime_error (_("The DCP is empty, perhaps because all the content has zero length.")); - } - - if (dcp_content_type() == nullptr) { - throw MissingSettingError (_("content type")); - } - - if (name().empty()) { - set_name ("DCP"); - } - - for (auto i: content ()) { - if (!i->paths_valid()) { - throw runtime_error (_("some of your content is missing")); - } - auto dcp = dynamic_pointer_cast(i); - if (dcp && dcp->needs_kdm()) { - throw runtime_error (_("Some of your content needs a KDM")); - } - if (dcp && dcp->needs_assets()) { - throw runtime_error (_("Some of your content needs an OV")); - } - } - - set_isdcf_date_today (); - - for (auto i: environment_info ()) { - LOG_GENERAL_NC (i); - } - - for (auto i: content ()) { - LOG_GENERAL ("Content: %1", i->technical_summary()); - } - LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate()); - if (Config::instance()->only_servers_encode ()) { - LOG_GENERAL_NC ("0 threads: ONLY SERVERS SET TO ENCODE"); - } else { - LOG_GENERAL ("%1 threads", Config::instance()->master_encoding_threads()); - } - LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth()); - - auto tj = make_shared(shared_from_this(), behaviour); - tj->set_encoder (make_shared(shared_from_this(), tj)); - JobManager::instance()->add (tj); -} - /** Start a job to send our DCP to the configured TMS */ void Film::send_dcp_to_tms () diff --git a/src/lib/film.h b/src/lib/film.h index 7103f6271..1d1034775 100644 --- a/src/lib/film.h +++ b/src/lib/film.h @@ -118,7 +118,6 @@ public: boost::filesystem::path subtitle_analysis_path (std::shared_ptr) const; void send_dcp_to_tms (); - void make_dcp (TranscodeJob::ChangedBehaviour behaviour); /** @return Logger. * It is safe to call this from any thread. diff --git a/src/lib/make_dcp.cc b/src/lib/make_dcp.cc new file mode 100644 index 000000000..934387fcd --- /dev/null +++ b/src/lib/make_dcp.cc @@ -0,0 +1,105 @@ +/* + Copyright (C) 2021 Carl Hetherington + + 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. + + 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 DCP-o-matic. If not, see . + +*/ + + +#include "config.h" +#include "dcp_content.h" +#include "dcp_encoder.h" +#include "dcpomatic_log.h" +#include "environment_info.h" +#include "film.h" +#include "job_manager.h" +#include "make_dcp.h" +#include "transcode_job.h" +#include + +#include "i18n.h" + + +using std::dynamic_pointer_cast; +using std::make_shared; +using std::runtime_error; +using std::shared_ptr; +using std::string; + + +/** Add suitable Jobs to the JobManager to create a DCP for a Film */ +void +make_dcp (shared_ptr film, TranscodeJob::ChangedBehaviour behaviour) +{ + if (film->dcp_name().find("/") != string::npos) { + throw BadSettingError (_("name"), _("Cannot contain slashes")); + } + + if (film->container() == nullptr) { + throw MissingSettingError (_("container")); + } + + if (film->content().empty()) { + throw runtime_error (_("You must add some content to the DCP before creating it")); + } + + if (film->length() == dcpomatic::DCPTime()) { + throw runtime_error (_("The DCP is empty, perhaps because all the content has zero length.")); + } + + if (film->dcp_content_type() == nullptr) { + throw MissingSettingError (_("content type")); + } + + if (film->name().empty()) { + film->set_name ("DCP"); + } + + for (auto i: film->content()) { + if (!i->paths_valid()) { + throw runtime_error (_("Some of your content is missing")); + } + auto dcp = dynamic_pointer_cast(i); + if (dcp && dcp->needs_kdm()) { + throw runtime_error (_("Some of your content needs a KDM")); + } + if (dcp && dcp->needs_assets()) { + throw runtime_error (_("Some of your content needs an OV")); + } + } + + film->set_isdcf_date_today (); + + for (auto info: environment_info()) { + LOG_GENERAL_NC (info); + } + + for (auto content: film->content()) { + LOG_GENERAL ("Content: %1", content->technical_summary()); + } + LOG_GENERAL ("DCP video rate %1 fps", film->video_frame_rate()); + if (Config::instance()->only_servers_encode()) { + LOG_GENERAL_NC ("0 threads: ONLY SERVERS SET TO ENCODE"); + } else { + LOG_GENERAL ("%1 threads", Config::instance()->master_encoding_threads()); + } + LOG_GENERAL ("J2K bandwidth %1", film->j2k_bandwidth()); + + auto tj = make_shared(film, behaviour); + tj->set_encoder (make_shared(film, tj)); + JobManager::instance()->add (tj); +} + diff --git a/src/lib/make_dcp.h b/src/lib/make_dcp.h new file mode 100644 index 000000000..9f5072782 --- /dev/null +++ b/src/lib/make_dcp.h @@ -0,0 +1,29 @@ +/* + Copyright (C) 2021 Carl Hetherington + + 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. + + 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 DCP-o-matic. If not, see . + +*/ + + +#include "transcode_job.h" + + +class Film; + + +void make_dcp (std::shared_ptr film, TranscodeJob::ChangedBehaviour behaviour); + diff --git a/src/lib/wscript b/src/lib/wscript index 5f8a6cff7..44a4da2dd 100644 --- a/src/lib/wscript +++ b/src/lib/wscript @@ -132,6 +132,7 @@ sources = """ kdm_with_metadata.cc log.cc log_entry.cc + make_dcp.cc maths_util.cc memory_util.cc mid_side_decoder.cc diff --git a/src/tools/dcpomatic.cc b/src/tools/dcpomatic.cc index 42fc421e8..90c939a08 100644 --- a/src/tools/dcpomatic.cc +++ b/src/tools/dcpomatic.cc @@ -24,78 +24,79 @@ */ -#include "wx/standard_controls.h" -#include "wx/film_viewer.h" -#include "wx/film_editor.h" -#include "wx/job_manager_view.h" -#include "wx/full_config_dialog.h" -#include "wx/wx_util.h" -#include "wx/film_name_location_dialog.h" -#include "wx/wx_signal_manager.h" -#include "wx/recreate_chain_dialog.h" #include "wx/about_dialog.h" -#include "wx/kdm_dialog.h" -#include "wx/dkdm_dialog.h" -#include "wx/self_dkdm_dialog.h" -#include "wx/servers_list_dialog.h" -#include "wx/hints_dialog.h" -#include "wx/update_dialog.h" #include "wx/content_panel.h" -#include "wx/report_problem_dialog.h" -#include "wx/video_waveform_dialog.h" -#include "wx/system_information_dialog.h" -#include "wx/save_template_dialog.h" -#include "wx/templates_dialog.h" -#include "wx/nag_dialog.h" +#include "wx/dkdm_dialog.h" #include "wx/export_subtitles_dialog.h" #include "wx/export_video_file_dialog.h" -#include "wx/paste_dialog.h" +#include "wx/film_editor.h" +#include "wx/film_name_location_dialog.h" +#include "wx/film_viewer.h" #include "wx/focus_manager.h" +#include "wx/full_config_dialog.h" +#include "wx/hints_dialog.h" #include "wx/html_dialog.h" -#include "wx/send_i18n_dialog.h" #include "wx/i18n_hook.h" -#include "lib/film.h" +#include "wx/job_manager_view.h" +#include "wx/kdm_dialog.h" +#include "wx/nag_dialog.h" +#include "wx/paste_dialog.h" +#include "wx/recreate_chain_dialog.h" +#include "wx/report_problem_dialog.h" +#include "wx/save_template_dialog.h" +#include "wx/self_dkdm_dialog.h" +#include "wx/send_i18n_dialog.h" +#include "wx/servers_list_dialog.h" +#include "wx/standard_controls.h" +#include "wx/system_information_dialog.h" +#include "wx/templates_dialog.h" +#include "wx/update_dialog.h" +#include "wx/video_waveform_dialog.h" +#include "wx/wx_signal_manager.h" +#include "wx/wx_util.h" #include "lib/analytics.h" -#include "lib/emailer.h" +#include "lib/audio_content.h" +#include "lib/check_content_change_job.h" +#include "lib/cinema.h" +#include "lib/compose.hpp" #include "lib/config.h" -#include "lib/cross.h" -#include "lib/util.h" -#include "lib/video_content.h" #include "lib/content.h" -#include "lib/version.h" -#include "lib/signal_manager.h" -#include "lib/log.h" -#include "lib/screen.h" -#include "lib/job_manager.h" -#include "lib/exceptions.h" -#include "lib/cinema.h" -#include "lib/kdm_with_metadata.h" -#include "lib/send_kdm_email_job.h" -#include "lib/encode_server_finder.h" -#include "lib/update_checker.h" -#include "lib/cross.h" #include "lib/content_factory.h" -#include "lib/compose.hpp" -#include "lib/dcpomatic_socket.h" -#include "lib/hints.h" +#include "lib/cross.h" +#include "lib/cross.h" #include "lib/dcp_content.h" -#include "lib/ffmpeg_encoder.h" -#include "lib/transcode_job.h" -#include "lib/dkdm_wrapper.h" -#include "lib/audio_content.h" -#include "lib/check_content_change_job.h" -#include "lib/text_content.h" #include "lib/dcpomatic_log.h" +#include "lib/dcpomatic_socket.h" +#include "lib/dkdm_wrapper.h" +#include "lib/emailer.h" +#include "lib/encode_server_finder.h" +#include "lib/exceptions.h" +#include "lib/ffmpeg_encoder.h" +#include "lib/film.h" +#include "lib/hints.h" +#include "lib/job_manager.h" +#include "lib/kdm_with_metadata.h" +#include "lib/log.h" +#include "lib/make_dcp.h" +#include "lib/screen.h" +#include "lib/send_kdm_email_job.h" +#include "lib/signal_manager.h" #include "lib/subtitle_encoder.h" +#include "lib/text_content.h" +#include "lib/transcode_job.h" +#include "lib/update_checker.h" +#include "lib/util.h" +#include "lib/version.h" +#include "lib/video_content.h" #include "lib/warnings.h" #include #include DCPOMATIC_DISABLE_WARNINGS -#include -#include #include +#include #include #include +#include #include DCPOMATIC_ENABLE_WARNINGS #ifdef __WXGTK__ @@ -104,8 +105,8 @@ DCPOMATIC_ENABLE_WARNINGS #ifdef __WXMSW__ #include #endif -#include #include +#include #include #include /* This is OK as it's only used with DCPOMATIC_WINDOWS */ @@ -816,7 +817,7 @@ private: a long time, and crashes/power failures are moderately likely. */ _film->write_metadata (); - _film->make_dcp (TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP); + make_dcp (_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP); } catch (BadSettingError& e) { error_dialog (this, wxString::Format (_("Bad setting for %s."), std_to_wx(e.setting()).data()), std_to_wx(e.what())); } catch (std::exception& e) { diff --git a/src/tools/dcpomatic_batch.cc b/src/tools/dcpomatic_batch.cc index d3aa2500b..ef8816708 100644 --- a/src/tools/dcpomatic_batch.cc +++ b/src/tools/dcpomatic_batch.cc @@ -32,6 +32,7 @@ #include "lib/film.h" #include "lib/job.h" #include "lib/job_manager.h" +#include "lib/make_dcp.h" #include "lib/transcode_job.h" #include "lib/util.h" #include "lib/version.h" @@ -211,7 +212,7 @@ public: } } - film->make_dcp (TranscodeJob::ChangedBehaviour::STOP); + make_dcp (film, TranscodeJob::ChangedBehaviour::STOP); } catch (std::exception& e) { auto p = std_to_wx (path.string ()); auto b = p.ToUTF8 (); @@ -450,7 +451,7 @@ class App : public wxApp try { film = make_shared(i); film->read_metadata (); - film->make_dcp (TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP); + make_dcp (film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP); } catch (exception& e) { error_dialog ( 0, diff --git a/src/tools/dcpomatic_cli.cc b/src/tools/dcpomatic_cli.cc index 18ffcee90..71353d463 100644 --- a/src/tools/dcpomatic_cli.cc +++ b/src/tools/dcpomatic_cli.cc @@ -30,6 +30,7 @@ #include "lib/job_manager.h" #include "lib/json_server.h" #include "lib/log.h" +#include "lib/make_dcp.h" #include "lib/ratio.h" #include "lib/signal_manager.h" #include "lib/transcode_job.h" @@ -393,7 +394,7 @@ main (int argc, char* argv[]) } } - TranscodeJob::ChangedBehaviour behaviour = check ? TranscodeJob::ChangedBehaviour::STOP : TranscodeJob::ChangedBehaviour::IGNORE; + TranscodeJob::ChangedBehaviour const behaviour = check ? TranscodeJob::ChangedBehaviour::STOP : TranscodeJob::ChangedBehaviour::IGNORE; if (export_format) { auto job = std::make_shared(film, behaviour); @@ -405,13 +406,14 @@ main (int argc, char* argv[]) JobManager::instance()->add (job); } else { try { - film->make_dcp (behaviour); + make_dcp (film, behaviour); } catch (runtime_error& e) { std::cerr << "Could not make DCP: " << e.what() << "\n"; exit(EXIT_FAILURE); } } + make_dcp (film, behaviour); bool const error = show_jobs_on_console (progress); if (keep_going) { diff --git a/test/interrupt_encoder_test.cc b/test/interrupt_encoder_test.cc index 5b76e67d3..2e839336d 100644 --- a/test/interrupt_encoder_test.cc +++ b/test/interrupt_encoder_test.cc @@ -31,6 +31,7 @@ #include "lib/ffmpeg_content.h" #include "lib/film.h" #include "lib/job_manager.h" +#include "lib/make_dcp.h" #include "lib/ratio.h" #include "test.h" #include @@ -54,7 +55,7 @@ BOOST_AUTO_TEST_CASE (interrupt_encoder_test) film->examine_and_add_content (content); BOOST_REQUIRE (!wait_for_jobs()); - film->make_dcp (TranscodeJob::ChangedBehaviour::IGNORE); + make_dcp (film, TranscodeJob::ChangedBehaviour::IGNORE); dcpomatic_sleep_seconds (10); diff --git a/test/reels_test.cc b/test/reels_test.cc index 618a5b29b..82123b3e1 100644 --- a/test/reels_test.cc +++ b/test/reels_test.cc @@ -31,6 +31,7 @@ #include "lib/ffmpeg_content.h" #include "lib/film.h" #include "lib/image_content.h" +#include "lib/make_dcp.h" #include "lib/ratio.h" #include "lib/string_text_file_content.h" #include "lib/video_content.h" @@ -564,7 +565,7 @@ BOOST_AUTO_TEST_CASE (reels_should_not_be_short4) BOOST_CHECK (film->reels().front() == dcpomatic::DCPTimePeriod(dcpomatic::DCPTime(), dcpomatic::DCPTime::from_frames(263, 24))); film->write_metadata (); - film->make_dcp (TranscodeJob::ChangedBehaviour::IGNORE); + make_dcp (film, TranscodeJob::ChangedBehaviour::IGNORE); BOOST_REQUIRE (!wait_for_jobs()); vector dirs = { film->dir(film->dcp_name(false)) }; diff --git a/test/test.cc b/test/test.cc index fba6aea9f..7497a0ea1 100644 --- a/test/test.cc +++ b/test/test.cc @@ -38,6 +38,7 @@ #include "lib/job.h" #include "lib/job_manager.h" #include "lib/log_entry.h" +#include "lib/make_dcp.h" #include "lib/ratio.h" #include "lib/signal_manager.h" #include "lib/util.h" @@ -893,7 +894,7 @@ void make_and_verify_dcp (shared_ptr film, vector ignore) { film->write_metadata (); - film->make_dcp (TranscodeJob::ChangedBehaviour::IGNORE); + make_dcp (film, TranscodeJob::ChangedBehaviour::IGNORE); BOOST_REQUIRE (!wait_for_jobs()); auto notes = dcp::verify ({film->dir(film->dcp_name())}, &stage, &progress, TestPaths::xsd()); bool ok = true; diff --git a/test/threed_test.cc b/test/threed_test.cc index 0dd163035..4fe91ebca 100644 --- a/test/threed_test.cc +++ b/test/threed_test.cc @@ -33,6 +33,7 @@ #include "lib/film.h" #include "lib/job.h" #include "lib/job_manager.h" +#include "lib/make_dcp.h" #include "lib/ratio.h" #include "lib/video_content.h" #include "test.h" @@ -186,7 +187,7 @@ BOOST_AUTO_TEST_CASE (threed_test7) c->video->set_length (24); film->set_three_d (true); - film->make_dcp (TranscodeJob::ChangedBehaviour::IGNORE); + make_dcp (film, TranscodeJob::ChangedBehaviour::IGNORE); film->write_metadata (); auto jm = JobManager::instance (); -- 2.30.2