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