2 Copyright (C) 2012-2022 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
23 #include "lib/audio_content.h"
24 #include "lib/config.h"
25 #include "lib/cross.h"
26 #include "lib/dcpomatic_log.h"
27 #include "lib/encode_server_finder.h"
28 #include "lib/ffmpeg_encoder.h"
30 #include "lib/filter.h"
31 #include "lib/hints.h"
32 #include "lib/job_manager.h"
33 #include "lib/json_server.h"
35 #include "lib/make_dcp.h"
36 #include "lib/ratio.h"
37 #include "lib/signal_manager.h"
38 #include "lib/transcode_job.h"
40 #include "lib/version.h"
41 #include "lib/video_content.h"
42 #include <dcp/filesystem.h>
43 #include <dcp/version.h>
51 using std::dynamic_pointer_cast;
54 using std::runtime_error;
56 using std::shared_ptr;
59 using boost::optional;
65 cerr << "Syntax: " << n << " [OPTION] [<FILM>]\n"
66 << " -v, --version show DCP-o-matic version\n"
67 << " -h, --help show this help\n"
68 << " -f, --flags show flags passed to C++ compiler on build\n"
69 << " -n, --no-progress do not print progress to stdout\n"
70 << " -r, --no-remote do not use any remote servers\n"
71 << " -t, --threads specify number of local encoding threads (overriding configuration)\n"
72 << " -j, --json <port> run a JSON server on the specified port\n"
73 << " -k, --keep-going keep running even when the job is complete\n"
74 << " -s, --servers <file> specify servers to use in a text file\n"
75 << " -l, --list-servers just display a list of encoding servers that DCP-o-matic is configured to use; don't encode\n"
76 << " -d, --dcp-path echo DCP's path to stdout on successful completion (implies -n)\n"
77 << " -c, --config <dir> directory containing config.xml and cinemas.xml\n"
78 << " --dump just dump a summary of the film's settings; don't encode\n"
79 << " --no-check don't check project's content files for changes before making the DCP\n"
80 << " --export-format <format> export project to a file, rather than making a DCP: specify mov or mp4\n"
81 << " --export-filename <filename> filename to export to with --export-format\n"
82 << " --hints analyze film for hints before encoding and abort if any are found\n"
84 << "<FILM> is the film directory.\n";
89 print_dump (shared_ptr<Film> film)
91 cout << film->dcp_name (true) << "\n"
92 << film->container()->container_nickname() << " at " << ((film->resolution() == Resolution::TWO_K) ? "2K" : "4K") << "\n"
93 << (film->j2k_bandwidth() / 1000000) << "Mbit/s" << "\n"
94 << "Duration " << (film->length().timecode(film->video_frame_rate())) << "\n"
95 << "Output " << film->video_frame_rate() << "fps " << (film->three_d() ? "3D" : "2D") << " " << (film->audio_frame_rate() / 1000) << "kHz\n"
96 << (film->interop() ? "Inter-Op" : "SMPTE") << " " << (film->encrypted() ? "encrypted" : "unencrypted") << "\n";
98 for (auto c: film->content()) {
100 << c->path(0).string() << "\n"
101 << "\tat " << c->position().seconds ()
102 << " length " << c->full_length(film).seconds ()
103 << " start trim " << c->trim_start().seconds ()
104 << " end trim " << c->trim_end().seconds () << "\n";
107 cout << "\t" << c->video->size().width << "x" << c->video->size().height << "\n"
108 << "\t" << c->active_video_frame_rate(film) << "fps\n"
109 << "\tcrop left " << c->video->requested_left_crop()
110 << " right " << c->video->requested_right_crop()
111 << " top " << c->video->requested_top_crop()
112 << " bottom " << c->video->requested_bottom_crop() << "\n";
113 if (c->video->custom_ratio()) {
114 cout << "\tscale to custom ratio " << *c->video->custom_ratio() << ":1\n";
116 if (c->video->colour_conversion()) {
117 if (c->video->colour_conversion().get().preset()) {
118 cout << "\tcolour conversion "
119 << PresetColourConversion::all()[c->video->colour_conversion().get().preset().get()].name
122 cout << "\tcustom colour conversion\n";
125 cout << "\tno colour conversion\n";
131 cout << "\t" << c->audio->delay() << " delay\n"
132 << "\t" << c->audio->gain() << " gain\n";
143 auto servers = EncodeServerFinder::instance()->servers();
145 /* This is a bit fiddly because we want to list configured servers that are down as well
146 as all those (configured and found by broadcast) that are up.
149 if (servers.empty() && Config::instance()->servers().empty()) {
150 cout << "No encoding servers found or configured.\n";
153 cout << std::left << setw(24) << "Host" << " Status Threads\n";
156 /* Report the state of configured servers */
157 for (auto i: Config::instance()->servers()) {
158 cout << std::left << setw(24) << i << " ";
160 /* See if this server is on the active list; if so, remove it and note
161 the number of threads it is offering.
163 optional<int> threads;
164 auto j = servers.begin ();
165 while (j != servers.end ()) {
166 if (i == j->host_name() && j->current_link_version()) {
167 threads = j->threads();
176 if (static_cast<bool>(threads)) {
177 cout << "UP " << threads.get() << "\n";
184 /* Now report any left that have been found by broadcast */
185 for (auto const& i: servers) {
186 if (i.current_link_version()) {
187 cout << std::left << setw(24) << i.host_name() << " UP " << i.threads() << "\n";
189 cout << std::left << setw(24) << i.host_name() << " bad version\n";
195 dcpomatic_sleep_seconds (1);
197 for (int i = 0; i < N; ++i) {
198 cout << "\033[1A\033[2K";
205 show_jobs_on_console (bool progress)
211 dcpomatic_sleep_seconds (5);
213 auto jobs = JobManager::instance()->get();
215 if (!first && progress) {
216 for (size_t i = 0; i < jobs.size(); ++i) {
217 cout << UP_ONE_LINE_AND_ERASE;
227 if (!i->sub_name().empty()) {
228 cout << "; " << i->sub_name();
232 if (i->progress ()) {
233 cout << i->status() << " \n";
235 cout << ": Running \n";
239 if (!progress && i->finished_in_error()) {
240 /* We won't see this error if we haven't been showing progress,
243 cout << i->status() << "\n";
246 if (i->finished_in_error()) {
251 if (!JobManager::instance()->work_to_do()) {
261 main (int argc, char* argv[])
263 boost::filesystem::path film_dir;
264 bool progress = true;
265 bool no_remote = false;
266 optional<int> threads;
267 optional<int> json_port;
268 bool keep_going = false;
270 optional<boost::filesystem::path> servers;
271 bool list_servers_ = false;
272 bool dcp_path = false;
273 optional<boost::filesystem::path> config;
275 optional<string> export_format;
276 optional<boost::filesystem::path> export_filename;
279 int option_index = 0;
281 static struct option long_options[] = {
282 { "version", no_argument, 0, 'v'},
283 { "help", no_argument, 0, 'h'},
284 { "flags", no_argument, 0, 'f'},
285 { "no-progress", no_argument, 0, 'n'},
286 { "no-remote", no_argument, 0, 'r'},
287 { "threads", required_argument, 0, 't'},
288 { "json", required_argument, 0, 'j'},
289 { "keep-going", no_argument, 0, 'k' },
290 { "servers", required_argument, 0, 's' },
291 { "list-servers", no_argument, 0, 'l' },
292 { "dcp-path", no_argument, 0, 'd' },
293 { "config", required_argument, 0, 'c' },
294 /* Just using A, B, C ... from here on */
295 { "dump", no_argument, 0, 'A' },
296 { "no-check", no_argument, 0, 'B' },
297 { "export-format", required_argument, 0, 'C' },
298 { "export-filename", required_argument, 0, 'D' },
299 { "hints", no_argument, 0, 'E' },
303 int c = getopt_long (argc, argv, "vhfnrt:j:kAs:ldc:BC:D:E", long_options, &option_index);
311 cout << "dcpomatic version " << dcpomatic_version << " " << dcpomatic_git_commit << "\n";
317 cout << dcpomatic_cxx_flags << "\n";
326 threads = atoi (optarg);
329 json_port = atoi (optarg);
341 list_servers_ = true;
354 export_format = optarg;
357 export_filename = optarg;
366 State::override_path = *config;
370 dcp::File f(*servers, "r");
372 cerr << "Could not open servers list file " << *servers << "\n";
375 vector<string> servers;
378 if (fscanf(f.get(), "%s.127", buffer) == 1) {
379 servers.push_back (buffer);
382 Config::instance()->set_servers (servers);
390 if (optind >= argc) {
395 if (export_format && !export_filename) {
396 cerr << "Argument --export-filename is required with --export-format\n";
400 if (!export_format && export_filename) {
401 cerr << "Argument --export-format is required with --export-filename\n";
405 if (export_format && *export_format != "mp4" && *export_format != "mov") {
406 cerr << "Unrecognised export format: must be mp4 or mov\n";
410 film_dir = argv[optind];
412 dcpomatic_setup_path_encoding ();
414 signal_manager = new SignalManager ();
416 if (no_remote || export_format) {
417 EncodeServerFinder::instance()->stop ();
421 new JSONServer (json_port.get ());
425 Config::instance()->set_master_encoding_threads (threads.get ());
428 shared_ptr<Film> film;
430 film.reset (new Film (film_dir));
431 film->read_metadata ();
432 } catch (std::exception& e) {
433 cerr << argv[0] << ": error reading film `" << film_dir.string() << "' (" << e.what() << ")\n";
442 dcpomatic_log = film->log ();
444 for (auto i: film->content()) {
445 auto paths = i->paths();
446 for (auto j: paths) {
447 if (!dcp::filesystem::exists(j)) {
448 cerr << argv[0] << ": content file " << j << " not found.\n";
454 if (!export_format && hints) {
455 string const prefix = "Checking project for hints";
456 bool pulse_phase = false;
457 vector<string> hints;
458 bool finished = false;
460 Hints hint_finder(film);
461 hint_finder.Progress.connect([prefix](string progress) {
462 std::cout << UP_ONE_LINE_AND_ERASE << prefix << ": " << progress << "\n";
465 hint_finder.Pulse.connect([prefix, &pulse_phase]() {
466 std::cout << UP_ONE_LINE_AND_ERASE << prefix << ": " << (pulse_phase ? "X" : "x") << "\n";
468 pulse_phase = !pulse_phase;
470 hint_finder.Hint.connect([&hints](string hint) {
471 hints.push_back(hint);
473 hint_finder.Finished.connect([&finished]() {
477 std::cout << prefix << ":\n";
482 signal_manager->ui_idle();
483 dcpomatic_sleep_milliseconds(200);
486 std::cout << UP_ONE_LINE_AND_ERASE;
488 if (!hints.empty()) {
489 std::cerr << "Hints:\n\n";
490 for (auto hint: hints) {
491 std::cerr << word_wrap("* " + hint, 70) << "\n";
493 std::cerr << "*** Encoding aborted because hints were found ***\n\n";
494 std::cerr << "Modify your settings and run the command again, or run without\n";
495 std::cerr << "the `--hints' option to ignore these hints and encode anyway.\n";
502 cout << "\nExporting " << film->name() << "\n";
504 cout << "\nMaking DCP for " << film->name() << "\n";
508 TranscodeJob::ChangedBehaviour const behaviour = check ? TranscodeJob::ChangedBehaviour::STOP : TranscodeJob::ChangedBehaviour::IGNORE;
511 auto job = std::make_shared<TranscodeJob>(film, behaviour);
513 std::make_shared<FFmpegEncoder> (
514 film, job, *export_filename, *export_format == "mp4" ? ExportFormat::H264_AAC : ExportFormat::PRORES_HQ, false, false, false, 23
517 JobManager::instance()->add (job);
520 make_dcp (film, behaviour);
521 } catch (runtime_error& e) {
522 std::cerr << "Could not make DCP: " << e.what() << "\n";
527 bool const error = show_jobs_on_console (progress);
531 dcpomatic_sleep_seconds (3600);
535 /* This is just to stop valgrind reporting leaks due to JobManager
536 indirectly holding onto codecs.
540 EncodeServerFinder::drop ();
542 if (dcp_path && !error) {
543 cout << film->dir (film->dcp_name (false)).string() << "\n";
546 return error ? EXIT_FAILURE : EXIT_SUCCESS;