src/tools/dcpomatic_cli.cc

   1 /*
   2     Copyright (C) 2012-2017 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   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.
  10
  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.
  15
  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/>.
  18
  19 */
  20
  21 #include "lib/film.h"
  22 #include "lib/filter.h"
  23 #include "lib/transcode_job.h"
  24 #include "lib/job_manager.h"
  25 #include "lib/util.h"
  26 #include "lib/version.h"
  27 #include "lib/cross.h"
  28 #include "lib/config.h"
  29 #include "lib/log.h"
  30 #include "lib/signal_manager.h"
  31 #include "lib/encode_server_finder.h"
  32 #include "lib/json_server.h"
  33 #include "lib/ratio.h"
  34 #include "lib/video_content.h"
  35 #include "lib/audio_content.h"
  36 #include "lib/dcpomatic_log.h"
  37 #include <dcp/version.h>
  38 #include <boost/foreach.hpp>
  39 #include <getopt.h>
  40 #include <iostream>
  41 #include <iomanip>
  42
  43 using std::string;
  44 using std::cerr;
  45 using std::cout;
  46 using std::vector;
  47 using std::pair;
  48 using std::setw;
  49 using std::list;
  50 using boost::shared_ptr;
  51 using boost::optional;
  52 using boost::dynamic_pointer_cast;
  53
  54 static void
  55 help (string n)
  56 {
  57         cerr << "Syntax: " << n << " [OPTION] [<FILM>]\n"
  58              << "  -v, --version        show DCP-o-matic version\n"
  59              << "  -h, --help           show this help\n"
  60              << "  -f, --flags          show flags passed to C++ compiler on build\n"
  61              << "  -n, --no-progress    do not print progress to stdout\n"
  62              << "  -r, --no-remote      do not use any remote servers\n"
  63              << "  -t, --threads        specify number of local encoding threads (overriding configuration)\n"
  64              << "  -j, --json <port>    run a JSON server on the specified port\n"
  65              << "  -k, --keep-going     keep running even when the job is complete\n"
  66              << "  -s, --servers <file> specify servers to use in a text file\n"
  67              << "  -l, --list-servers   just display a list of encoding servers that DCP-o-matic is configured to use; don't encode\n"
  68              << "  -d, --dcp-path       echo DCP's path to stdout on successful completion (implies -n)\n"
  69              << "  -c, --config <dir>   directory containing config.xml and cinemas.xml\n"
  70              << "      --dump           just dump a summary of the film's settings; don't encode\n"
  71              << "      --no-check       don't check project's content files for changes before making the DCP\n"
  72              << "\n"
  73              << "<FILM> is the film directory.\n";
  74 }
  75
  76 static void
  77 print_dump (shared_ptr<Film> film)
  78 {
  79         cout << film->dcp_name (true) << "\n"
  80              << film->container()->container_nickname() << " at " << ((film->resolution() == RESOLUTION_2K) ? "2K" : "4K") << "\n"
  81              << (film->j2k_bandwidth() / 1000000) << "Mbit/s" << "\n"
  82              << "Output " << film->video_frame_rate() << "fps " << (film->three_d() ? "3D" : "2D") << " " << (film->audio_frame_rate() / 1000) << "kHz\n"
  83              << (film->interop() ? "Inter-Op" : "SMPTE") << " " << (film->encrypted() ? "encrypted" : "unencrypted") << "\n";
  84
  85         BOOST_FOREACH (shared_ptr<Content> c, film->content ()) {
  86                 cout << "\n"
  87                      << c->path(0) << "\n"
  88                      << "\tat " << c->position().seconds ()
  89                      << " length " << c->full_length(film).seconds ()
  90                      << " start trim " << c->trim_start().seconds ()
  91                      << " end trim " << c->trim_end().seconds () << "\n";
  92
  93                 if (c->video) {
  94                         cout << "\t" << c->video->size().width << "x" << c->video->size().height << "\n"
  95                              << "\t" << c->active_video_frame_rate(film) << "fps\n"
  96                              << "\tcrop left " << c->video->left_crop()
  97                              << " right " << c->video->right_crop()
  98                              << " top " << c->video->top_crop()
  99                              << " bottom " << c->video->bottom_crop() << "\n"
 100                              << "\tscale " << c->video->scale().name() << "\n";
 101                         if (c->video->colour_conversion()) {
 102                                 if (c->video->colour_conversion().get().preset()) {
 103                                         cout << "\tcolour conversion "
 104                                              << PresetColourConversion::all()[c->video->colour_conversion().get().preset().get()].name
 105                                              << "\n";
 106                                 } else {
 107                                         cout << "\tcustom colour conversion\n";
 108                                 }
 109                         } else {
 110                                 cout << "\tno colour conversion\n";
 111                         }
 112
 113                 }
 114
 115                 if (c->audio) {
 116                         cout << "\t" << c->audio->delay() << " delay\n"
 117                              << "\t" << c->audio->gain() << " gain\n";
 118                 }
 119         }
 120 }
 121
 122 static void
 123 list_servers ()
 124 {
 125         while (true) {
 126                 int N = 0;
 127                 list<EncodeServerDescription> servers = EncodeServerFinder::instance()->servers();
 128
 129                 /* This is a bit fiddly because we want to list configured servers that are down as well
 130                    as all those (configured and found by broadcast) that are up.
 131                 */
 132
 133                 if (servers.empty() && Config::instance()->servers().empty()) {
 134                         cout << "No encoding servers found or configured.\n";
 135                         ++N;
 136                 } else {
 137                         cout << std::left << setw(24) << "Host" << " Status Threads\n";
 138                         ++N;
 139
 140                         /* Report the state of configured servers */
 141                         BOOST_FOREACH (string i, Config::instance()->servers()) {
 142                                 cout << std::left << setw(24) << i << " ";
 143
 144                                 /* See if this server is on the active list; if so, remove it and note
 145                                    the number of threads it is offering.
 146                                 */
 147                                 optional<int> threads;
 148                                 list<EncodeServerDescription>::iterator j = servers.begin ();
 149                                 while (j != servers.end ()) {
 150                                         if (i == j->host_name() && j->current_link_version()) {
 151                                                 threads = j->threads();
 152                                                 list<EncodeServerDescription>::iterator tmp = j;
 153                                                 ++tmp;
 154                                                 servers.erase (j);
 155                                                 j = tmp;
 156                                         } else {
 157                                                 ++j;
 158                                         }
 159                                 }
 160                                 if (static_cast<bool>(threads)) {
 161                                         cout << "UP     " << threads.get() << "\n";
 162                                 } else {
 163                                         cout << "DOWN\n";
 164                                 }
 165                                 ++N;
 166                         }
 167
 168                         /* Now report any left that have been found by broadcast */
 169                         BOOST_FOREACH (EncodeServerDescription const & i, servers) {
 170                                 if (i.current_link_version()) {
 171                                         cout << std::left << setw(24) << i.host_name() << " UP     " << i.threads() << "\n";
 172                                 } else {
 173                                         cout << std::left << setw(24) << i.host_name() << " bad version\n";
 174                                 }
 175                                 ++N;
 176                         }
 177                 }
 178
 179                 dcpomatic_sleep_seconds (1);
 180
 181                 for (int i = 0; i < N; ++i) {
 182                         cout << "\033[1A\033[2K";
 183                 }
 184         }
 185 }
 186
 187
 188 int
 189 main (int argc, char* argv[])
 190 {
 191         boost::filesystem::path film_dir;
 192         bool progress = true;
 193         bool no_remote = false;
 194         optional<int> threads;
 195         optional<int> json_port;
 196         bool keep_going = false;
 197         bool dump = false;
 198         optional<boost::filesystem::path> servers;
 199         bool list_servers_ = false;
 200         bool dcp_path = false;
 201         optional<boost::filesystem::path> config;
 202         bool check = true;
 203
 204         int option_index = 0;
 205         while (true) {
 206                 static struct option long_options[] = {
 207                         { "version", no_argument, 0, 'v'},
 208                         { "help", no_argument, 0, 'h'},
 209                         { "flags", no_argument, 0, 'f'},
 210                         { "no-progress", no_argument, 0, 'n'},
 211                         { "no-remote", no_argument, 0, 'r'},
 212                         { "threads", required_argument, 0, 't'},
 213                         { "json", required_argument, 0, 'j'},
 214                         { "keep-going", no_argument, 0, 'k' },
 215                         { "servers", required_argument, 0, 's' },
 216                         { "list-servers", no_argument, 0, 'l' },
 217                         { "dcp-path", no_argument, 0, 'd' },
 218                         { "config", required_argument, 0, 'c' },
 219                         /* Just using A, B, C ... from here on */
 220                         { "dump", no_argument, 0, 'A' },
 221                         { "no-check", no_argument, 0, 'B' },
 222                         { 0, 0, 0, 0 }
 223                 };
 224
 225                 int c = getopt_long (argc, argv, "vhfnrt:j:kAs:ldc:B", long_options, &option_index);
 226
 227                 if (c == -1) {
 228                         break;
 229                 }
 230
 231                 switch (c) {
 232                 case 'v':
 233                         cout << "dcpomatic version " << dcpomatic_version << " " << dcpomatic_git_commit << "\n";
 234                         exit (EXIT_SUCCESS);
 235                 case 'h':
 236                         help (argv[0]);
 237                         exit (EXIT_SUCCESS);
 238                 case 'f':
 239                         cout << dcpomatic_cxx_flags << "\n";
 240                         exit (EXIT_SUCCESS);
 241                 case 'n':
 242                         progress = false;
 243                         break;
 244                 case 'r':
 245                         no_remote = true;
 246                         break;
 247                 case 't':
 248                         threads = atoi (optarg);
 249                         break;
 250                 case 'j':
 251                         json_port = atoi (optarg);
 252                         break;
 253                 case 'k':
 254                         keep_going = true;
 255                         break;
 256                 case 'A':
 257                         dump = true;
 258                         break;
 259                 case 's':
 260                         servers = optarg;
 261                         break;
 262                 case 'l':
 263                         list_servers_ = true;
 264                         break;
 265                 case 'd':
 266                         dcp_path = true;
 267                         progress = false;
 268                         break;
 269                 case 'c':
 270                         config = optarg;
 271                         break;
 272                 case 'B':
 273                         check = false;
 274                         break;
 275                 }
 276         }
 277
 278         if (config) {
 279                 State::override_path = *config;
 280         }
 281
 282         if (servers) {
 283                 FILE* f = fopen_boost (*servers, "r");
 284                 if (!f) {
 285                         cerr << "Could not open servers list file " << *servers << "\n";
 286                         exit (EXIT_FAILURE);
 287                 }
 288                 vector<string> servers;
 289                 while (!feof (f)) {
 290                         char buffer[128];
 291                         if (fscanf (f, "%s.127", buffer) == 1) {
 292                                 servers.push_back (buffer);
 293                         }
 294                 }
 295                 fclose (f);
 296                 Config::instance()->set_servers (servers);
 297         }
 298
 299         if (list_servers_) {
 300                 list_servers ();
 301                 exit (EXIT_SUCCESS);
 302         }
 303
 304         if (optind >= argc) {
 305                 help (argv[0]);
 306                 exit (EXIT_FAILURE);
 307         }
 308
 309         film_dir = argv[optind];
 310
 311         dcpomatic_setup_path_encoding ();
 312         dcpomatic_setup ();
 313         signal_manager = new SignalManager ();
 314
 315         if (no_remote) {
 316                 EncodeServerFinder::instance()->stop ();
 317         }
 318
 319         if (json_port) {
 320                 new JSONServer (json_port.get ());
 321         }
 322
 323         if (threads) {
 324                 Config::instance()->set_master_encoding_threads (threads.get ());
 325         }
 326
 327         shared_ptr<Film> film;
 328         try {
 329                 film.reset (new Film (film_dir));
 330                 film->read_metadata ();
 331         } catch (std::exception& e) {
 332                 cerr << argv[0] << ": error reading film `" << film_dir.string() << "' (" << e.what() << ")\n";
 333                 exit (EXIT_FAILURE);
 334         }
 335
 336         if (dump) {
 337                 print_dump (film);
 338                 exit (EXIT_SUCCESS);
 339         }
 340
 341         dcpomatic_log = film->log ();
 342
 343         ContentList content = film->content ();
 344         for (ContentList::const_iterator i = content.begin(); i != content.end(); ++i) {
 345                 vector<boost::filesystem::path> paths = (*i)->paths ();
 346                 for (vector<boost::filesystem::path>::const_iterator j = paths.begin(); j != paths.end(); ++j) {
 347                         if (!boost::filesystem::exists (*j)) {
 348                                 cerr << argv[0] << ": content file " << *j << " not found.\n";
 349                                 exit (EXIT_FAILURE);
 350                         }
 351                 }
 352         }
 353
 354         if (progress) {
 355                 cout << "\nMaking DCP for " << film->name() << "\n";
 356         }
 357
 358         film->make_dcp (false, check);
 359         bool const error = show_jobs_on_console (progress);
 360
 361         if (keep_going) {
 362                 while (true) {
 363                         dcpomatic_sleep_seconds (3600);
 364                 }
 365         }
 366
 367         /* This is just to stop valgrind reporting leaks due to JobManager
 368            indirectly holding onto codecs.
 369         */
 370         JobManager::drop ();
 371
 372         EncodeServerFinder::drop ();
 373
 374         if (dcp_path && !error) {
 375                 cout << film->dir (film->dcp_name (false)).string() << "\n";
 376         }
 377
 378         return error ? EXIT_FAILURE : EXIT_SUCCESS;
 379 }