path: root/src/tools/dcpomatic_cli.cc

/*
    Copyright (C) 2012-2022 Carl Hetherington <cth@carlh.net>

    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 <http://www.gnu.org/licenses/>.

*/


#include "lib/audio_content.h"
#include "lib/config.h"
#include "lib/cross.h"
#include "lib/dcpomatic_log.h"
#include "lib/encode_server_finder.h"
#include "lib/ffmpeg_encoder.h"
#include "lib/film.h"
#include "lib/filter.h"
#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"
#include "lib/util.h"
#include "lib/version.h"
#include "lib/video_content.h"
#include <dcp/version.h>
#include <getopt.h>
#include <iostream>
#include <iomanip>


using std::cerr;
using std::cout;
using std::dynamic_pointer_cast;
using std::list;
using std::pair;
using std::runtime_error;
using std::setw;
using std::shared_ptr;
using std::string;
using std::vector;
using boost::optional;


static void
help (string n)
{
	cerr << "Syntax: " << n << " [OPTION] [<FILM>]\n"
	     << "  -v, --version                     show DCP-o-matic version\n"
	     << "  -h, --help                        show this help\n"
	     << "  -f, --flags                       show flags passed to C++ compiler on build\n"
	     << "  -n, --no-progress                 do not print progress to stdout\n"
	     << "  -r, --no-remote                   do not use any remote servers\n"
	     << "  -t, --threads                     specify number of local encoding threads (overriding configuration)\n"
	     << "  -j, --json <port>                 run a JSON server on the specified port\n"
	     << "  -k, --keep-going                  keep running even when the job is complete\n"
	     << "  -s, --servers <file>              specify servers to use in a text file\n"
	     << "  -l, --list-servers                just display a list of encoding servers that DCP-o-matic is configured to use; don't encode\n"
	     << "  -d, --dcp-path                    echo DCP's path to stdout on successful completion (implies -n)\n"
	     << "  -c, --config <dir>                directory containing config.xml and cinemas.xml\n"
	     << "      --dump                        just dump a summary of the film's settings; don't encode\n"
	     << "      --no-check                    don't check project's content files for changes before making the DCP\n"
	     << "      --export-format <format>      export project to a file, rather than making a DCP: specify mov or mp4\n"
	     << "      --export-filename <filename>  filename to export to with --export-format\n"
	     << "\n"
	     << "<FILM> is the film directory.\n";
}


static void
print_dump (shared_ptr<Film> film)
{
	cout << film->dcp_name (true) << "\n"
	     << film->container()->container_nickname() << " at " << ((film->resolution() == Resolution::TWO_K) ? "2K" : "4K") << "\n"
	     << (film->j2k_bandwidth() / 1000000) << "Mbit/s" << "\n"
	     << "Output " << film->video_frame_rate() << "fps " << (film->three_d() ? "3D" : "2D") << " " << (film->audio_frame_rate() / 1000) << "kHz\n"
	     << (film->interop() ? "Inter-Op" : "SMPTE") << " " << (film->encrypted() ? "encrypted" : "unencrypted") << "\n";

	for (auto c: film->content()) {
		cout << "\n"
		     << c->path(0) << "\n"
		     << "\tat " << c->position().seconds ()
		     << " length " << c->full_length(film).seconds ()
		     << " start trim " << c->trim_start().seconds ()
		     << " end trim " << c->trim_end().seconds () << "\n";

		if (c->video) {
			cout << "\t" << c->video->size().width << "x" << c->video->size().height << "\n"
			     << "\t" << c->active_video_frame_rate(film) << "fps\n"
			     << "\tcrop left " << c->video->requested_left_crop()
			     << " right " << c->video->requested_right_crop()
			     << " top " << c->video->requested_top_crop()
			     << " bottom " << c->video->requested_bottom_crop() << "\n";
			if (c->video->custom_ratio()) {
				cout << "\tscale to custom ratio " << *c->video->custom_ratio() << ":1\n";
			}
			if (c->video->colour_conversion()) {
				if (c->video->colour_conversion().get().preset()) {
					cout << "\tcolour conversion "
					     << PresetColourConversion::all()[c->video->colour_conversion().get().preset().get()].name
					     << "\n";
				} else {
					cout << "\tcustom colour conversion\n";
				}
			} else {
				cout << "\tno colour conversion\n";
			}

		}

		if (c->audio) {
			cout << "\t" << c->audio->delay() << " delay\n"
			     << "\t" << c->audio->gain() << " gain\n";
		}
	}
}


static void
list_servers ()
{
	while (true) {
		int N = 0;
		auto servers = EncodeServerFinder::instance()->servers();

		/* This is a bit fiddly because we want to list configured servers that are down as well
		   as all those (configured and found by broadcast) that are up.
		*/

		if (servers.empty() && Config::instance()->servers().empty()) {
			cout << "No encoding servers found or configured.\n";
			++N;
		} else {
			cout << std::left << setw(24) << "Host" << " Status Threads\n";
			++N;

			/* Report the state of configured servers */
			for (auto i: Config::instance()->servers()) {
				cout << std::left << setw(24) << i << " ";

				/* See if this server is on the active list; if so, remove it and note
				   the number of threads it is offering.
				*/
				optional<int> threads;
				auto j = servers.begin ();
				while (j != servers.end ()) {
					if (i == j->host_name() && j->current_link_version()) {
						threads = j->threads();
						auto tmp = j;
						++tmp;
						servers.erase (j);
						j = tmp;
					} else {
						++j;
					}
				}
				if (static_cast<bool>(threads)) {
					cout << "UP     " << threads.get() << "\n";
				} else {
					cout << "DOWN\n";
				}
				++N;
			}

			/* Now report any left that have been found by broadcast */
			for (auto const& i: servers) {
				if (i.current_link_version()) {
					cout << std::left << setw(24) << i.host_name() << " UP     " << i.threads() << "\n";
				} else {
					cout << std::left << setw(24) << i.host_name() << " bad version\n";
				}
				++N;
			}
		}

		dcpomatic_sleep_seconds (1);

		for (int i = 0; i < N; ++i) {
			cout << "\033[1A\033[2K";
		}
	}
}


bool
show_jobs_on_console (bool progress)
{
	bool first = true;
	bool error = false;
	while (true) {

		dcpomatic_sleep_seconds (5);

		auto jobs = JobManager::instance()->get();

		if (!first && progress) {
			for (size_t i = 0; i < jobs.size(); ++i) {
				cout << "\033[1A\033[2K";
			}
			cout.flush ();
		}

		first = false;

		for (auto i: jobs) {
			if (progress) {
				cout << i->name();
				if (!i->sub_name().empty()) {
					cout << "; " << i->sub_name();
				}
				cout << ": ";

				if (i->progress ()) {
					cout << i->status() << "			    \n";
				} else {
					cout << ": Running	     \n";
				}
			}

			if (!progress && i->finished_in_error()) {
				/* We won't see this error if we haven't been showing progress,
				   so show it now.
				*/
				cout << i->status() << "\n";
			}

			if (i->finished_in_error()) {
				error = true;
			}
		}

		if (!JobManager::instance()->work_to_do()) {
			break;
		}
	}

	return error;
}


int
main (int argc, char* argv[])
{
	boost::filesystem::path film_dir;
	bool progress = true;
	bool no_remote = false;
	optional<int> threads;
	optional<int> json_port;
	bool keep_going = false;
	bool dump = false;
	optional<boost::filesystem::path> servers;
	bool list_servers_ = false;
	bool dcp_path = false;
	optional<boost::filesystem::path> config;
	bool check = true;
	optional<string> export_format;
	optional<boost::filesystem::path> export_filename;

	int option_index = 0;
	while (true) {
		static struct option long_options[] = {
			{ "version", no_argument, 0, 'v'},
			{ "help", no_argument, 0, 'h'},
			{ "flags", no_argument, 0, 'f'},
			{ "no-progress", no_argument, 0, 'n'},
			{ "no-remote", no_argument, 0, 'r'},
			{ "threads", required_argument, 0, 't'},
			{ "json", required_argument, 0, 'j'},
			{ "keep-going", no_argument, 0, 'k' },
			{ "servers", required_argument, 0, 's' },
			{ "list-servers", no_argument, 0, 'l' },
			{ "dcp-path", no_argument, 0, 'd' },
			{ "config", required_argument, 0, 'c' },
			/* Just using A, B, C ... from here on */
			{ "dump", no_argument, 0, 'A' },
			{ "no-check", no_argument, 0, 'B' },
			{ "export-format", required_argument, 0, 'C' },
			{ "export-filename", required_argument, 0, 'D' },
			{ 0, 0, 0, 0 }
		};

		int c = getopt_long (argc, argv, "vhfnrt:j:kAs:ldc:BC:D:", long_options, &option_index);

		if (c == -1) {
			break;
		}

		switch (c) {
		case 'v':
			cout << "dcpomatic version " << dcpomatic_version << " " << dcpomatic_git_commit << "\n";
			exit (EXIT_SUCCESS);
		case 'h':
			help (argv[0]);
			exit (EXIT_SUCCESS);
		case 'f':
			cout << dcpomatic_cxx_flags << "\n";
			exit (EXIT_SUCCESS);
		case 'n':
			progress = false;
			break;
		case 'r':
			no_remote = true;
			break;
		case 't':
			threads = atoi (optarg);
			break;
		case 'j':
			json_port = atoi (optarg);
			break;
		case 'k':
			keep_going = true;
			break;
		case 'A':
			dump = true;
			break;
		case 's':
			servers = optarg;
			break;
		case 'l':
			list_servers_ = true;
			break;
		case 'd':
			dcp_path = true;
			progress = false;
			break;
		case 'c':
			config = optarg;
			break;
		case 'B':
			check = false;
			break;
		case 'C':
			export_format = optarg;
			break;
		case 'D':
			export_filename = optarg;
			break;
		}
	}

	if (config) {
		State::override_path = *config;
	}

	if (servers) {
		dcp::File f(*servers, "r");
		if (!f) {
			cerr << "Could not open servers list file " << *servers << "\n";
			exit (EXIT_FAILURE);
		}
		vector<string> servers;
		while (!f.eof()) {
			char buffer[128];
			if (fscanf(f.get(), "%s.127", buffer) == 1) {
				servers.push_back (buffer);
			}
		}
		Config::instance()->set_servers (servers);
	}

	if (list_servers_) {
		list_servers ();
		exit (EXIT_SUCCESS);
	}

	if (optind >= argc) {
		help (argv[0]);
		exit (EXIT_FAILURE);
	}

	if (export_format && !export_filename) {
		cerr << "Argument --export-filename is required with --export-format\n";
		exit (EXIT_FAILURE);
	}

	if (!export_format && export_filename) {
		cerr << "Argument --export-format is required with --export-filename\n";
		exit (EXIT_FAILURE);
	}

	if (export_format && *export_format != "mp4" && *export_format != "mov") {
		cerr << "Unrecognised export format: must be mp4 or mov\n";
		exit (EXIT_FAILURE);
	}

	film_dir = argv[optind];

	dcpomatic_setup_path_encoding ();
	dcpomatic_setup ();
	signal_manager = new SignalManager ();

	if (no_remote || export_format) {
		EncodeServerFinder::instance()->stop ();
	}

	if (json_port) {
		new JSONServer (json_port.get ());
	}

	if (threads) {
		Config::instance()->set_master_encoding_threads (threads.get ());
	}

	shared_ptr<Film> film;
	try {
		film.reset (new Film (film_dir));
		film->read_metadata ();
	} catch (std::exception& e) {
		cerr << argv[0] << ": error reading film `" << film_dir.string() << "' (" << e.what() << ")\n";
		exit (EXIT_FAILURE);
	}

	if (dump) {
		print_dump (film);
		exit (EXIT_SUCCESS);
	}

	dcpomatic_log = film->log ();

	for (auto i: film->content()) {
		auto paths = i->paths();
		for (auto j: paths) {
			if (!boost::filesystem::exists(j)) {
				cerr << argv[0] << ": content file " << j << " not found.\n";
				exit (EXIT_FAILURE);
			}
		}
	}

	if (progress) {
		if (export_format) {
			cout << "\nExporting " << film->name() << "\n";
		} else {
			cout << "\nMaking DCP for " << film->name() << "\n";
		}
	}

	TranscodeJob::ChangedBehaviour const behaviour = check ? TranscodeJob::ChangedBehaviour::STOP : TranscodeJob::ChangedBehaviour::IGNORE;

	if (export_format) {
		auto job = std::make_shared<TranscodeJob>(film, behaviour);
		job->set_encoder (
			std::make_shared<FFmpegEncoder> (
				film, job, *export_filename, *export_format == "mp4" ? ExportFormat::H264_AAC : ExportFormat::PRORES_HQ, false, false, false, 23
				)
			);
		JobManager::instance()->add (job);
	} else {
		try {
			make_dcp (film, behaviour);
		} catch (runtime_error& e) {
			std::cerr << "Could not make DCP: " << e.what() << "\n";
			exit(EXIT_FAILURE);
		}
	}

	bool const error = show_jobs_on_console (progress);

	if (keep_going) {
		while (true) {
			dcpomatic_sleep_seconds (3600);
		}
	}

	/* This is just to stop valgrind reporting leaks due to JobManager
	   indirectly holding onto codecs.
	*/
	JobManager::drop ();

	EncodeServerFinder::drop ();

	if (dcp_path && !error) {
		cout << film->dir (film->dcp_name (false)).string() << "\n";
	}

	return error ? EXIT_FAILURE : EXIT_SUCCESS;
}