src/lib/util.cc

   1 /*
   2     Copyright (C) 2012-2021 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 /** @file src/lib/util.cc
  22  *  @brief Some utility functions and classes.
  23  */
  24
  25
  26 #define UNICODE 1
  27
  28
  29 #include "audio_buffers.h"
  30 #include "audio_processor.h"
  31 #include "cinema_sound_processor.h"
  32 #include "compose.hpp"
  33 #include "config.h"
  34 #include "constants.h"
  35 #include "cross.h"
  36 #include "crypto.h"
  37 #include "dcp_content_type.h"
  38 #include "dcpomatic_log.h"
  39 #include "digester.h"
  40 #include "exceptions.h"
  41 #include "ffmpeg_image_proxy.h"
  42 #include "filter.h"
  43 #include "font.h"
  44 #include "image.h"
  45 #include "job.h"
  46 #include "job_manager.h"
  47 #include "ratio.h"
  48 #include "rect.h"
  49 #include "render_text.h"
  50 #include "string_text.h"
  51 #include "text_decoder.h"
  52 #include "util.h"
  53 #include "video_content.h"
  54 #include <dcp/atmos_asset.h>
  55 #include <dcp/decrypted_kdm.h>
  56 #include <dcp/locale_convert.h>
  57 #include <dcp/picture_asset.h>
  58 #include <dcp/raw_convert.h>
  59 #include <dcp/sound_asset.h>
  60 #include <dcp/subtitle_asset.h>
  61 #include <dcp/util.h>
  62 #include <dcp/warnings.h>
  63 LIBDCP_DISABLE_WARNINGS
  64 extern "C" {
  65 #include <libavfilter/avfilter.h>
  66 #include <libavformat/avformat.h>
  67 #include <libavcodec/avcodec.h>
  68 }
  69 LIBDCP_ENABLE_WARNINGS
  70 #include <curl/curl.h>
  71 #include <glib.h>
  72 #include <pangomm/init.h>
  73 #include <unicode/utypes.h>
  74 #include <unicode/unistr.h>
  75 #include <unicode/translit.h>
  76 #include <boost/algorithm/string.hpp>
  77 #include <boost/range/algorithm/replace_if.hpp>
  78 #include <boost/thread.hpp>
  79 #include <boost/filesystem.hpp>
  80 LIBDCP_DISABLE_WARNINGS
  81 #include <boost/locale.hpp>
  82 LIBDCP_ENABLE_WARNINGS
  83 #ifdef DCPOMATIC_WINDOWS
  84 #include <boost/locale.hpp>
  85 #include <dbghelp.h>
  86 #endif
  87 #include <signal.h>
  88 #include <iomanip>
  89 #include <iostream>
  90 #include <fstream>
  91 #include <climits>
  92 #include <stdexcept>
  93 #ifdef DCPOMATIC_POSIX
  94 #include <execinfo.h>
  95 #include <cxxabi.h>
  96 #endif
  97
  98 #include "i18n.h"
  99
 100
 101 using std::bad_alloc;
 102 using std::cout;
 103 using std::endl;
 104 using std::istream;
 105 using std::list;
 106 using std::make_pair;
 107 using std::make_shared;
 108 using std::map;
 109 using std::min;
 110 using std::ostream;
 111 using std::pair;
 112 using std::set_terminate;
 113 using std::shared_ptr;
 114 using std::string;
 115 using std::vector;
 116 using std::wstring;
 117 using boost::thread;
 118 using boost::optional;
 119 using boost::lexical_cast;
 120 using boost::bad_lexical_cast;
 121 using boost::scoped_array;
 122 using dcp::Size;
 123 using dcp::raw_convert;
 124 using dcp::locale_convert;
 125 using namespace dcpomatic;
 126
 127
 128 /** Path to our executable, required by the stacktrace stuff and filled
 129  *  in during App::onInit().
 130  */
 131 string program_name;
 132 bool is_batch_converter = false;
 133 static boost::thread::id ui_thread;
 134 static boost::filesystem::path backtrace_file;
 135
 136 /** Convert some number of seconds to a string representation
 137  *  in hours, minutes and seconds.
 138  *
 139  *  @param s Seconds.
 140  *  @return String of the form H:M:S (where H is hours, M
 141  *  is minutes and S is seconds).
 142  */
 143 string
 144 seconds_to_hms (int s)
 145 {
 146         int m = s / 60;
 147         s -= (m * 60);
 148         int h = m / 60;
 149         m -= (h * 60);
 150
 151         char buffer[64];
 152         snprintf (buffer, sizeof(buffer), "%d:%02d:%02d", h, m, s);
 153         return buffer;
 154 }
 155
 156 string
 157 time_to_hmsf (DCPTime time, Frame rate)
 158 {
 159         Frame f = time.frames_round (rate);
 160         int s = f / rate;
 161         f -= (s * rate);
 162         int m = s / 60;
 163         s -= m * 60;
 164         int h = m / 60;
 165         m -= h * 60;
 166
 167         char buffer[64];
 168         snprintf (buffer, sizeof(buffer), "%d:%02d:%02d.%d", h, m, s, static_cast<int>(f));
 169         return buffer;
 170 }
 171
 172 /** @param s Number of seconds.
 173  *  @return String containing an approximate description of s (e.g. "about 2 hours")
 174  */
 175 string
 176 seconds_to_approximate_hms (int s)
 177 {
 178         int m = s / 60;
 179         s -= (m * 60);
 180         int h = m / 60;
 181         m -= (h * 60);
 182
 183         string ap;
 184
 185         bool hours = h > 0;
 186         bool minutes = h < 6 && m > 0;
 187         bool seconds = h == 0 && m < 10 && s > 0;
 188
 189         if (m > 30 && !minutes) {
 190                 /* round up the hours */
 191                 ++h;
 192         }
 193         if (s > 30 && !seconds) {
 194                 /* round up the minutes */
 195                 ++m;
 196                 if (m == 60) {
 197                         m = 0;
 198                         minutes = false;
 199                         ++h;
 200                 }
 201         }
 202
 203         if (hours) {
 204                 /// TRANSLATORS: h here is an abbreviation for hours
 205                 ap += locale_convert<string>(h) + _("h");
 206
 207                 if (minutes || seconds) {
 208                         ap += N_(" ");
 209                 }
 210         }
 211
 212         if (minutes) {
 213                 /// TRANSLATORS: m here is an abbreviation for minutes
 214                 ap += locale_convert<string>(m) + _("m");
 215
 216                 if (seconds) {
 217                         ap += N_(" ");
 218                 }
 219         }
 220
 221         if (seconds) {
 222                 /* Seconds */
 223                 /// TRANSLATORS: s here is an abbreviation for seconds
 224                 ap += locale_convert<string>(s) + _("s");
 225         }
 226
 227         return ap;
 228 }
 229
 230 double
 231 seconds (struct timeval t)
 232 {
 233         return t.tv_sec + (double (t.tv_usec) / 1e6);
 234 }
 235
 236 #ifdef DCPOMATIC_WINDOWS
 237
 238 /** Resolve symbol name and source location given the path to the executable */
 239 int
 240 addr2line (void const * const addr)
 241 {
 242         char addr2line_cmd[512] = { 0 };
 243         sprintf (addr2line_cmd, "addr2line -f -p -e %.256s %p > %s", program_name.c_str(), addr, backtrace_file.string().c_str());
 244         return system(addr2line_cmd);
 245 }
 246
 247 LIBDCP_DISABLE_WARNINGS
 248 /** This is called when C signals occur on Windows (e.g. SIGSEGV)
 249  *  (NOT C++ exceptions!).  We write a backtrace to backtrace_file by dark means.
 250  *  Adapted from code here: http://spin.atomicobject.com/2013/01/13/exceptions-stack-traces-c/
 251  */
 252 LONG WINAPI
 253 exception_handler(struct _EXCEPTION_POINTERS * info)
 254 {
 255         dcp::File f(backtrace_file, "w");
 256         if (f) {
 257                 fprintf(f.get(), "C-style exception %d\n", info->ExceptionRecord->ExceptionCode);
 258                 f.close();
 259         }
 260
 261         if (info->ExceptionRecord->ExceptionCode != EXCEPTION_STACK_OVERFLOW) {
 262                 CONTEXT* context = info->ContextRecord;
 263                 SymInitialize (GetCurrentProcess (), 0, true);
 264
 265                 STACKFRAME frame = { 0 };
 266
 267                 /* setup initial stack frame */
 268 #if _WIN64
 269                 frame.AddrPC.Offset    = context->Rip;
 270                 frame.AddrStack.Offset = context->Rsp;
 271                 frame.AddrFrame.Offset = context->Rbp;
 272 #else
 273                 frame.AddrPC.Offset    = context->Eip;
 274                 frame.AddrStack.Offset = context->Esp;
 275                 frame.AddrFrame.Offset = context->Ebp;
 276 #endif
 277                 frame.AddrPC.Mode      = AddrModeFlat;
 278                 frame.AddrStack.Mode   = AddrModeFlat;
 279                 frame.AddrFrame.Mode   = AddrModeFlat;
 280
 281                 while (
 282                         StackWalk (
 283                                 IMAGE_FILE_MACHINE_I386,
 284                                 GetCurrentProcess (),
 285                                 GetCurrentThread (),
 286                                 &frame,
 287                                 context,
 288                                 0,
 289                                 SymFunctionTableAccess,
 290                                 SymGetModuleBase,
 291                                 0
 292                                 )
 293                         ) {
 294                         addr2line((void *) frame.AddrPC.Offset);
 295                 }
 296         } else {
 297 #ifdef _WIN64
 298                 addr2line ((void *) info->ContextRecord->Rip);
 299 #else
 300                 addr2line ((void *) info->ContextRecord->Eip);
 301 #endif
 302         }
 303
 304         return EXCEPTION_CONTINUE_SEARCH;
 305 }
 306 LIBDCP_ENABLE_WARNINGS
 307 #endif
 308
 309 void
 310 set_backtrace_file (boost::filesystem::path p)
 311 {
 312         backtrace_file = p;
 313 }
 314
 315 /** This is called when there is an unhandled exception.  Any
 316  *  backtrace in this function is useless on Windows as the stack has
 317  *  already been unwound from the throw; we have the gdb wrap hack to
 318  *  cope with that.
 319  */
 320 void
 321 terminate ()
 322 {
 323         try {
 324                 static bool tried_throw = false;
 325                 // try once to re-throw currently active exception
 326                 if (!tried_throw) {
 327                         tried_throw = true;
 328                         throw;
 329                 }
 330         }
 331         catch (const std::exception &e) {
 332                 std::cerr << __FUNCTION__ << " caught unhandled exception. what(): "
 333                           << e.what() << std::endl;
 334         }
 335         catch (...) {
 336                 std::cerr << __FUNCTION__ << " caught unknown/unhandled exception."
 337                           << std::endl;
 338         }
 339
 340         abort();
 341 }
 342
 343 void
 344 dcpomatic_setup_path_encoding ()
 345 {
 346 #ifdef DCPOMATIC_WINDOWS
 347         /* Dark voodoo which, I think, gets boost::filesystem::path to
 348            correctly convert UTF-8 strings to paths, and also paths
 349            back to UTF-8 strings (on path::string()).
 350
 351            After this, constructing boost::filesystem::paths from strings
 352            converts from UTF-8 to UTF-16 inside the path.  Then
 353            path::string().c_str() gives UTF-8 and
 354            path::c_str()          gives UTF-16.
 355
 356            This is all Windows-only.  AFAICT Linux/OS X use UTF-8 everywhere,
 357            so things are much simpler.
 358         */
 359         std::locale::global (boost::locale::generator().generate (""));
 360         boost::filesystem::path::imbue (std::locale ());
 361 #endif
 362 }
 363
 364 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
 365  *  Must be called from the UI thread, if there is one.
 366  */
 367 void
 368 dcpomatic_setup ()
 369 {
 370 #ifdef DCPOMATIC_WINDOWS
 371         boost::filesystem::path p = g_get_user_config_dir ();
 372         p /= "backtrace.txt";
 373         set_backtrace_file (p);
 374         SetUnhandledExceptionFilter(exception_handler);
 375 #endif
 376
 377 #ifdef DCPOMATIC_HAVE_AVREGISTER
 378 LIBDCP_DISABLE_WARNINGS
 379         av_register_all ();
 380         avfilter_register_all ();
 381 LIBDCP_ENABLE_WARNINGS
 382 #endif
 383
 384 #ifdef DCPOMATIC_OSX
 385         /* Add our library directory to the libltdl search path so that
 386            xmlsec can find xmlsec1-openssl.
 387         */
 388         auto lib = directory_containing_executable().parent_path();
 389         lib /= "Frameworks";
 390         setenv ("LTDL_LIBRARY_PATH", lib.c_str (), 1);
 391 #endif
 392
 393         set_terminate (terminate);
 394
 395 #ifdef DCPOMATIC_WINDOWS
 396         putenv ("PANGOCAIRO_BACKEND=fontconfig");
 397         putenv (String::compose("FONTCONFIG_PATH=%1", resources_path().string()).c_str());
 398 #endif
 399
 400 #ifdef DCPOMATIC_OSX
 401         setenv ("PANGOCAIRO_BACKEND", "fontconfig", 1);
 402         setenv ("FONTCONFIG_PATH", resources_path().string().c_str(), 1);
 403 #endif
 404
 405         Pango::init ();
 406         dcp::init (libdcp_resources_path());
 407
 408 #if defined(DCPOMATIC_WINDOWS) || defined(DCPOMATIC_OSX)
 409         /* Render something to fontconfig to create its cache */
 410         list<StringText> subs;
 411         dcp::SubtitleString ss(
 412                 optional<string>(), false, false, false, dcp::Colour(), 42, 1, dcp::Time(), dcp::Time(), 0, dcp::HAlign::CENTER, 0, dcp::VAlign::CENTER, 0, dcp::Direction::LTR,
 413                 "Hello dolly", dcp::Effect::NONE, dcp::Colour(), dcp::Time(), dcp::Time(), 0
 414                 );
 415         subs.push_back (StringText(ss, 0, {}, dcp::Standard::SMPTE));
 416         render_text (subs, dcp::Size(640, 480), DCPTime(), 24);
 417 #endif
 418
 419         Ratio::setup_ratios ();
 420         PresetColourConversion::setup_colour_conversion_presets ();
 421         DCPContentType::setup_dcp_content_types ();
 422         Filter::setup_filters ();
 423         CinemaSoundProcessor::setup_cinema_sound_processors ();
 424         AudioProcessor::setup_audio_processors ();
 425
 426         curl_global_init (CURL_GLOBAL_ALL);
 427
 428         ui_thread = boost::this_thread::get_id ();
 429
 430         capture_asdcp_logs ();
 431 }
 432
 433 #ifdef DCPOMATIC_WINDOWS
 434 boost::filesystem::path
 435 mo_path ()
 436 {
 437         wchar_t buffer[512];
 438         GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
 439         boost::filesystem::path p (buffer);
 440         p = p.parent_path ();
 441         p = p.parent_path ();
 442         p /= "locale";
 443         return p;
 444 }
 445 #endif
 446
 447 #ifdef DCPOMATIC_OSX
 448 boost::filesystem::path
 449 mo_path ()
 450 {
 451         return "DCP-o-matic 2.app/Contents/Resources";
 452 }
 453 #endif
 454
 455 void
 456 dcpomatic_setup_gettext_i18n (string lang)
 457 {
 458 #ifdef DCPOMATIC_LINUX
 459         lang += ".UTF8";
 460 #endif
 461
 462         if (!lang.empty ()) {
 463                 /* Override our environment language.  Note that the caller must not
 464                    free the string passed into putenv().
 465                 */
 466                 string s = String::compose ("LANGUAGE=%1", lang);
 467                 putenv (strdup (s.c_str ()));
 468                 s = String::compose ("LANG=%1", lang);
 469                 putenv (strdup (s.c_str ()));
 470                 s = String::compose ("LC_ALL=%1", lang);
 471                 putenv (strdup (s.c_str ()));
 472         }
 473
 474         setlocale (LC_ALL, "");
 475         textdomain ("libdcpomatic2");
 476
 477 #if defined(DCPOMATIC_WINDOWS) || defined(DCPOMATIC_OSX)
 478         bindtextdomain ("libdcpomatic2", mo_path().string().c_str());
 479         bind_textdomain_codeset ("libdcpomatic2", "UTF8");
 480 #endif
 481
 482 #ifdef DCPOMATIC_LINUX
 483         bindtextdomain ("libdcpomatic2", LINUX_LOCALE_PREFIX);
 484 #endif
 485 }
 486
 487 /** Compute a digest of the first and last `size' bytes of a set of files. */
 488 string
 489 digest_head_tail (vector<boost::filesystem::path> files, boost::uintmax_t size)
 490 {
 491         boost::scoped_array<char> buffer (new char[size]);
 492         Digester digester;
 493
 494         /* Head */
 495         boost::uintmax_t to_do = size;
 496         char* p = buffer.get ();
 497         int i = 0;
 498         while (i < int64_t (files.size()) && to_do > 0) {
 499                 dcp::File f(files[i], "rb");
 500                 if (!f) {
 501                         throw OpenFileError (files[i].string(), errno, OpenFileError::READ);
 502                 }
 503
 504                 boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i]));
 505                 f.checked_read(p, this_time);
 506                 p += this_time;
 507                 to_do -= this_time;
 508
 509                 ++i;
 510         }
 511         digester.add (buffer.get(), size - to_do);
 512
 513         /* Tail */
 514         to_do = size;
 515         p = buffer.get ();
 516         i = files.size() - 1;
 517         while (i >= 0 && to_do > 0) {
 518                 dcp::File f(files[i], "rb");
 519                 if (!f) {
 520                         throw OpenFileError (files[i].string(), errno, OpenFileError::READ);
 521                 }
 522
 523                 boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i]));
 524                 f.seek(-this_time, SEEK_END);
 525                 f.checked_read(p, this_time);
 526                 p += this_time;
 527                 to_do -= this_time;
 528
 529                 --i;
 530         }
 531         digester.add (buffer.get(), size - to_do);
 532
 533         return digester.get ();
 534 }
 535
 536
 537 string
 538 simple_digest (vector<boost::filesystem::path> paths)
 539 {
 540         return digest_head_tail(paths, 1000000) + raw_convert<string>(boost::filesystem::file_size(paths.front()));
 541 }
 542
 543
 544 /** Trip an assert if the caller is not in the UI thread */
 545 void
 546 ensure_ui_thread ()
 547 {
 548         DCPOMATIC_ASSERT (boost::this_thread::get_id() == ui_thread);
 549 }
 550
 551 string
 552 audio_channel_name (int c)
 553 {
 554         DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
 555
 556         /// TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
 557         /// enhancement channel (sub-woofer).
 558         string const channels[] = {
 559                 _("Left"),
 560                 _("Right"),
 561                 _("Centre"),
 562                 _("Lfe (sub)"),
 563                 _("Left surround"),
 564                 _("Right surround"),
 565                 _("Hearing impaired"),
 566                 _("Visually impaired"),
 567                 _("Left centre"),
 568                 _("Right centre"),
 569                 _("Left rear surround"),
 570                 _("Right rear surround"),
 571                 _("D-BOX primary"),
 572                 _("D-BOX secondary"),
 573                 _("Unused"),
 574                 _("Unused")
 575         };
 576
 577         return channels[c];
 578 }
 579
 580 string
 581 short_audio_channel_name (int c)
 582 {
 583         DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
 584
 585         /// TRANSLATORS: these are short names of audio channels; Lfe is the low-frequency
 586         /// enhancement channel (sub-woofer).  HI is the hearing-impaired audio track and
 587         /// VI is the visually-impaired audio track (audio describe).  DBP is the D-BOX
 588         /// primary channel and DBS is the D-BOX secondary channel.
 589         string const channels[] = {
 590                 _("L"),
 591                 _("R"),
 592                 _("C"),
 593                 _("Lfe"),
 594                 _("Ls"),
 595                 _("Rs"),
 596                 _("HI"),
 597                 _("VI"),
 598                 _("9"),
 599                 _("10"),
 600                 _("BsL"),
 601                 _("BsR"),
 602                 _("DBP"),
 603                 _("DBS"),
 604                 _("Sign"),
 605                 _("16")
 606         };
 607
 608         return channels[c];
 609 }
 610
 611
 612 bool
 613 valid_image_file (boost::filesystem::path f)
 614 {
 615         if (boost::starts_with (f.leaf().string(), "._")) {
 616                 return false;
 617         }
 618
 619         auto ext = f.extension().string();
 620         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 621         return (
 622                 ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" ||
 623                 ext == ".png" || ext == ".bmp" || ext == ".tga" || ext == ".dpx" ||
 624                 ext == ".j2c" || ext == ".j2k" || ext == ".jp2" || ext == ".exr" ||
 625                 ext == ".jpf" || ext == ".psd"
 626                 );
 627 }
 628
 629 bool
 630 valid_sound_file (boost::filesystem::path f)
 631 {
 632         if (boost::starts_with (f.leaf().string(), "._")) {
 633                 return false;
 634         }
 635
 636         auto ext = f.extension().string();
 637         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 638         return (ext == ".wav" || ext == ".mp3" || ext == ".aif" || ext == ".aiff");
 639 }
 640
 641 bool
 642 valid_j2k_file (boost::filesystem::path f)
 643 {
 644         auto ext = f.extension().string();
 645         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 646         return (ext == ".j2k" || ext == ".j2c" || ext == ".jp2");
 647 }
 648
 649 string
 650 tidy_for_filename (string f)
 651 {
 652         boost::replace_if (f, boost::is_any_of ("\\/:"), '_');
 653         return f;
 654 }
 655
 656 dcp::Size
 657 fit_ratio_within (float ratio, dcp::Size full_frame)
 658 {
 659         if (ratio < full_frame.ratio ()) {
 660                 return dcp::Size (lrintf (full_frame.height * ratio), full_frame.height);
 661         }
 662
 663         return dcp::Size (full_frame.width, lrintf (full_frame.width / ratio));
 664 }
 665
 666 map<string, string>
 667 split_get_request (string url)
 668 {
 669         enum {
 670                 AWAITING_QUESTION_MARK,
 671                 KEY,
 672                 VALUE
 673         } state = AWAITING_QUESTION_MARK;
 674
 675         map<string, string> r;
 676         string k;
 677         string v;
 678         for (size_t i = 0; i < url.length(); ++i) {
 679                 switch (state) {
 680                 case AWAITING_QUESTION_MARK:
 681                         if (url[i] == '?') {
 682                                 state = KEY;
 683                         }
 684                         break;
 685                 case KEY:
 686                         if (url[i] == '=') {
 687                                 v.clear ();
 688                                 state = VALUE;
 689                         } else {
 690                                 k += url[i];
 691                         }
 692                         break;
 693                 case VALUE:
 694                         if (url[i] == '&') {
 695                                 r.insert (make_pair (k, v));
 696                                 k.clear ();
 697                                 state = KEY;
 698                         } else {
 699                                 v += url[i];
 700                         }
 701                         break;
 702                 }
 703         }
 704
 705         if (state == VALUE) {
 706                 r.insert (make_pair (k, v));
 707         }
 708
 709         return r;
 710 }
 711
 712
 713 static
 714 string
 715 asset_filename (shared_ptr<dcp::Asset> asset, string type, int reel_index, int reel_count, optional<string> summary, string extension)
 716 {
 717         dcp::NameFormat::Map values;
 718         values['t'] = type;
 719         values['r'] = raw_convert<string>(reel_index + 1);
 720         values['n'] = raw_convert<string>(reel_count);
 721         if (summary) {
 722                 values['c'] = careful_string_filter(summary.get());
 723         }
 724         return Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + extension);
 725 }
 726
 727
 728 string
 729 video_asset_filename (shared_ptr<dcp::PictureAsset> asset, int reel_index, int reel_count, optional<string> summary)
 730 {
 731         return asset_filename(asset, "j2c", reel_index, reel_count, summary, ".mxf");
 732 }
 733
 734
 735 string
 736 audio_asset_filename (shared_ptr<dcp::SoundAsset> asset, int reel_index, int reel_count, optional<string> summary)
 737 {
 738         return asset_filename(asset, "pcm", reel_index, reel_count, summary, ".mxf");
 739 }
 740
 741
 742 string
 743 subtitle_asset_filename (shared_ptr<dcp::SubtitleAsset> asset, int reel_index, int reel_count, optional<string> summary, string extension)
 744 {
 745         return asset_filename(asset, "sub", reel_index, reel_count, summary, extension);
 746 }
 747
 748
 749 string
 750 atmos_asset_filename (shared_ptr<dcp::AtmosAsset> asset, int reel_index, int reel_count, optional<string> summary)
 751 {
 752         return asset_filename(asset, "atmos", reel_index, reel_count, summary, ".mxf");
 753 }
 754
 755
 756 float
 757 relaxed_string_to_float (string s)
 758 {
 759         try {
 760                 boost::algorithm::replace_all (s, ",", ".");
 761                 return lexical_cast<float> (s);
 762         } catch (bad_lexical_cast &) {
 763                 boost::algorithm::replace_all (s, ".", ",");
 764                 return lexical_cast<float> (s);
 765         }
 766 }
 767
 768 string
 769 careful_string_filter (string s)
 770 {
 771         /* Filter out `bad' characters which `may' cause problems with some systems (either for DCP name or filename).
 772            There's no apparent list of what really is allowed, so this is a guess.
 773            Safety first and all that.
 774         */
 775
 776         /* First transliterate using libicu to try to remove accents in a "nice" way */
 777         auto transliterated = icu::UnicodeString::fromUTF8(icu::StringPiece(s));
 778         auto status = U_ZERO_ERROR;
 779         auto transliterator = icu::Transliterator::createInstance("NFD; [:M:] Remove; NFC", UTRANS_FORWARD, status);
 780         transliterator->transliterate(transliterated);
 781
 782         /* Some things are missed by ICU's transliterator */
 783         std::map<wchar_t, wchar_t> replacements = {
 784                 { L'ł',         L'l' },
 785                 { L'Ł',         L'L' }
 786         };
 787
 788         icu::UnicodeString transliterated_more;
 789         for (int i = 0; i < transliterated.length(); ++i) {
 790                 auto replacement = replacements.find(transliterated[i]);
 791                 if (replacement != replacements.end()) {
 792                         transliterated_more += replacement->second;
 793                 } else {
 794                         transliterated_more += transliterated[i];
 795                 }
 796         }
 797
 798         /* Then remove anything that's not in a very limited character set */
 799         wstring out;
 800         wstring const allowed = L"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_%.+";
 801         for (int i = 0; i < transliterated_more.length(); ++i) {
 802                 wchar_t c = transliterated_more[i];
 803                 if (allowed.find(c) != string::npos) {
 804                         out += c;
 805                 }
 806         }
 807
 808         return boost::locale::conv::utf_to_utf<char>(out);
 809 }
 810
 811 /** @param mapped List of mapped audio channels from a Film.
 812  *  @param channels Total number of channels in the Film.
 813  *  @return First: number of non-LFE soundtrack channels (L/R/C/Ls/Rs/Lc/Rc/Bsl/Bsr), second: number of LFE channels.
 814  */
 815 pair<int, int>
 816 audio_channel_types (list<int> mapped, int channels)
 817 {
 818         int non_lfe = 0;
 819         int lfe = 0;
 820
 821         for (auto i: mapped) {
 822                 if (i >= channels) {
 823                         /* This channel is mapped but is not included in the DCP */
 824                         continue;
 825                 }
 826
 827                 switch (static_cast<dcp::Channel>(i)) {
 828                 case dcp::Channel::LFE:
 829                         ++lfe;
 830                         break;
 831                 case dcp::Channel::LEFT:
 832                 case dcp::Channel::RIGHT:
 833                 case dcp::Channel::CENTRE:
 834                 case dcp::Channel::LS:
 835                 case dcp::Channel::RS:
 836                 case dcp::Channel::BSL:
 837                 case dcp::Channel::BSR:
 838                         ++non_lfe;
 839                         break;
 840                 case dcp::Channel::HI:
 841                 case dcp::Channel::VI:
 842                 case dcp::Channel::MOTION_DATA:
 843                 case dcp::Channel::SYNC_SIGNAL:
 844                 case dcp::Channel::SIGN_LANGUAGE:
 845                 case dcp::Channel::CHANNEL_COUNT:
 846                         break;
 847                 }
 848         }
 849
 850         return make_pair (non_lfe, lfe);
 851 }
 852
 853 shared_ptr<AudioBuffers>
 854 remap (shared_ptr<const AudioBuffers> input, int output_channels, AudioMapping map)
 855 {
 856         auto mapped = make_shared<AudioBuffers>(output_channels, input->frames());
 857         mapped->make_silent ();
 858
 859         int to_do = min (map.input_channels(), input->channels());
 860
 861         for (int i = 0; i < to_do; ++i) {
 862                 for (int j = 0; j < mapped->channels(); ++j) {
 863                         if (map.get(i, j) > 0) {
 864                                 mapped->accumulate_channel(
 865                                         input.get(),
 866                                         i,
 867                                         j,
 868                                         map.get(i, j)
 869                                         );
 870                         }
 871                 }
 872         }
 873
 874         return mapped;
 875 }
 876
 877 Eyes
 878 increment_eyes (Eyes e)
 879 {
 880         if (e == Eyes::LEFT) {
 881                 return Eyes::RIGHT;
 882         }
 883
 884         return Eyes::LEFT;
 885 }
 886
 887
 888 size_t
 889 utf8_strlen (string s)
 890 {
 891         size_t const len = s.length ();
 892         int N = 0;
 893         for (size_t i = 0; i < len; ++i) {
 894                 unsigned char c = s[i];
 895                 if ((c & 0xe0) == 0xc0) {
 896                         ++i;
 897                 } else if ((c & 0xf0) == 0xe0) {
 898                         i += 2;
 899                 } else if ((c & 0xf8) == 0xf0) {
 900                         i += 3;
 901                 }
 902                 ++N;
 903         }
 904         return N;
 905 }
 906
 907 string
 908 day_of_week_to_string (boost::gregorian::greg_weekday d)
 909 {
 910         switch (d.as_enum()) {
 911         case boost::date_time::Sunday:
 912                 return _("Sunday");
 913         case boost::date_time::Monday:
 914                 return _("Monday");
 915         case boost::date_time::Tuesday:
 916                 return _("Tuesday");
 917         case boost::date_time::Wednesday:
 918                 return _("Wednesday");
 919         case boost::date_time::Thursday:
 920                 return _("Thursday");
 921         case boost::date_time::Friday:
 922                 return _("Friday");
 923         case boost::date_time::Saturday:
 924                 return _("Saturday");
 925         }
 926
 927         return d.as_long_string ();
 928 }
 929
 930 /** @param size Size of picture that the subtitle will be overlaid onto */
 931 void
 932 emit_subtitle_image (ContentTimePeriod period, dcp::SubtitleImage sub, dcp::Size size, shared_ptr<TextDecoder> decoder)
 933 {
 934         /* XXX: this is rather inefficient; decoding the image just to get its size */
 935         FFmpegImageProxy proxy (sub.png_image());
 936         auto image = proxy.image(Image::Alignment::PADDED).image;
 937         /* set up rect with height and width */
 938         dcpomatic::Rect<double> rect(0, 0, image->size().width / double(size.width), image->size().height / double(size.height));
 939
 940         /* add in position */
 941
 942         switch (sub.h_align()) {
 943         case dcp::HAlign::LEFT:
 944                 rect.x += sub.h_position();
 945                 break;
 946         case dcp::HAlign::CENTER:
 947                 rect.x += 0.5 + sub.h_position() - rect.width / 2;
 948                 break;
 949         case dcp::HAlign::RIGHT:
 950                 rect.x += 1 - sub.h_position() - rect.width;
 951                 break;
 952         }
 953
 954         switch (sub.v_align()) {
 955         case dcp::VAlign::TOP:
 956                 rect.y += sub.v_position();
 957                 break;
 958         case dcp::VAlign::CENTER:
 959                 rect.y += 0.5 + sub.v_position() - rect.height / 2;
 960                 break;
 961         case dcp::VAlign::BOTTOM:
 962                 rect.y += 1 - sub.v_position() - rect.height;
 963                 break;
 964         }
 965
 966         decoder->emit_bitmap (period, image, rect);
 967 }
 968
 969 bool
 970 show_jobs_on_console (bool progress)
 971 {
 972         bool first = true;
 973         bool error = false;
 974         while (true) {
 975
 976                 dcpomatic_sleep_seconds (5);
 977
 978                 auto jobs = JobManager::instance()->get();
 979
 980                 if (!first && progress) {
 981                         for (size_t i = 0; i < jobs.size(); ++i) {
 982                                 cout << "\033[1A\033[2K";
 983                         }
 984                         cout.flush ();
 985                 }
 986
 987                 first = false;
 988
 989                 for (auto i: jobs) {
 990                         if (progress) {
 991                                 cout << i->name();
 992                                 if (!i->sub_name().empty()) {
 993                                         cout << "; " << i->sub_name();
 994                                 }
 995                                 cout << ": ";
 996
 997                                 if (i->progress ()) {
 998                                         cout << i->status() << "                            \n";
 999                                 } else {
1000                                         cout << ": Running           \n";
1001                                 }
1002                         }
1003
1004                         if (!progress && i->finished_in_error()) {
1005                                 /* We won't see this error if we haven't been showing progress,
1006                                    so show it now.
1007                                 */
1008                                 cout << i->status() << "\n";
1009                         }
1010
1011                         if (i->finished_in_error()) {
1012                                 error = true;
1013                         }
1014                 }
1015
1016                 if (!JobManager::instance()->work_to_do()) {
1017                         break;
1018                 }
1019         }
1020
1021         return error;
1022 }
1023
1024 /** XXX: could use mmap? */
1025 void
1026 copy_in_bits (boost::filesystem::path from, boost::filesystem::path to, std::function<void (float)> progress)
1027 {
1028         dcp::File f(from, "rb");
1029         if (!f) {
1030                 throw OpenFileError (from, errno, OpenFileError::READ);
1031         }
1032         dcp::File t(to, "wb");
1033         if (!t) {
1034                 throw OpenFileError (to, errno, OpenFileError::WRITE);
1035         }
1036
1037         /* on the order of a second's worth of copying */
1038         boost::uintmax_t const chunk = 20 * 1024 * 1024;
1039
1040         std::vector<uint8_t> buffer(chunk);
1041
1042         boost::uintmax_t const total = boost::filesystem::file_size (from);
1043         boost::uintmax_t remaining = total;
1044
1045         while (remaining) {
1046                 boost::uintmax_t this_time = min (chunk, remaining);
1047                 size_t N = f.read(buffer.data(), 1, chunk);
1048                 if (N < this_time) {
1049                         throw ReadFileError (from, errno);
1050                 }
1051
1052                 N = t.write(buffer.data(), 1, this_time);
1053                 if (N < this_time) {
1054                         throw WriteFileError (to, errno);
1055                 }
1056
1057                 progress (1 - float(remaining) / total);
1058                 remaining -= this_time;
1059         }
1060 }
1061
1062
1063 dcp::Size
1064 scale_for_display (dcp::Size s, dcp::Size display_container, dcp::Size film_container, PixelQuanta quanta)
1065 {
1066         /* Now scale it down if the display container is smaller than the film container */
1067         if (display_container != film_container) {
1068                 float const scale = min (
1069                         float (display_container.width) / film_container.width,
1070                         float (display_container.height) / film_container.height
1071                         );
1072
1073                 s.width = lrintf (s.width * scale);
1074                 s.height = lrintf (s.height * scale);
1075                 s = quanta.round (s);
1076         }
1077
1078         return s;
1079 }
1080
1081
1082 dcp::DecryptedKDM
1083 decrypt_kdm_with_helpful_error (dcp::EncryptedKDM kdm)
1084 {
1085         try {
1086                 return dcp::DecryptedKDM (kdm, Config::instance()->decryption_chain()->key().get());
1087         } catch (dcp::KDMDecryptionError& e) {
1088                 /* Try to flesh out the error a bit */
1089                 auto const kdm_subject_name = kdm.recipient_x509_subject_name();
1090                 bool on_chain = false;
1091                 auto dc = Config::instance()->decryption_chain();
1092                 for (auto i: dc->root_to_leaf()) {
1093                         if (i.subject() == kdm_subject_name) {
1094                                 on_chain = true;
1095                         }
1096                 }
1097                 if (!on_chain) {
1098                         throw KDMError (_("This KDM was not made for DCP-o-matic's decryption certificate."), e.what());
1099                 } else if (kdm_subject_name != dc->leaf().subject()) {
1100                         throw KDMError (_("This KDM was made for DCP-o-matic but not for its leaf certificate."), e.what());
1101                 } else {
1102                         throw;
1103                 }
1104         }
1105 }
1106
1107
1108 boost::filesystem::path
1109 default_font_file ()
1110 {
1111         boost::filesystem::path liberation_normal;
1112         try {
1113                 liberation_normal = resources_path() / "LiberationSans-Regular.ttf";
1114                 if (!boost::filesystem::exists (liberation_normal)) {
1115                         /* Hack for unit tests */
1116                         liberation_normal = resources_path() / "fonts" / "LiberationSans-Regular.ttf";
1117                 }
1118         } catch (boost::filesystem::filesystem_error& e) {
1119
1120         }
1121
1122         if (!boost::filesystem::exists(liberation_normal)) {
1123                 liberation_normal = "/usr/share/fonts/truetype/liberation/LiberationSans-Regular.ttf";
1124         }
1125         if (!boost::filesystem::exists(liberation_normal)) {
1126                 liberation_normal = "/usr/share/fonts/liberation-sans/LiberationSans-Regular.ttf";
1127         }
1128
1129         return liberation_normal;
1130 }
1131
1132
1133 string
1134 to_upper (string s)
1135 {
1136         transform (s.begin(), s.end(), s.begin(), ::toupper);
1137         return s;
1138 }
1139
1140
1141 /* Set to 1 to print the IDs of some of our threads to stdout on creation */
1142 #define DCPOMATIC_DEBUG_THREADS 0
1143
1144 #if DCPOMATIC_DEBUG_THREADS
1145 void
1146 start_of_thread (string name)
1147 {
1148         std::cout << "THREAD:" << name << ":" << std::hex << pthread_self() << "\n";
1149 }
1150 #else
1151 void
1152 start_of_thread (string)
1153 {
1154
1155 }
1156 #endif
1157
1158
1159 class LogSink : public Kumu::ILogSink
1160 {
1161 public:
1162         LogSink () {}
1163         LogSink (LogSink const&) = delete;
1164         LogSink& operator= (LogSink const&) = delete;
1165
1166         void WriteEntry(const Kumu::LogEntry& entry) override {
1167                 Kumu::AutoMutex L(m_lock);
1168                 WriteEntryToListeners(entry);
1169                 if (entry.TestFilter(m_filter)) {
1170                         string buffer;
1171                         entry.CreateStringWithOptions(buffer, m_options);
1172                         LOG_GENERAL("asdcplib: %1", buffer);
1173                 }
1174         }
1175 };
1176
1177
1178 void
1179 capture_asdcp_logs ()
1180 {
1181         static LogSink log_sink;
1182         Kumu::SetDefaultLogSink(&log_sink);
1183 }
1184
1185
1186 string
1187 error_details(boost::system::error_code ec)
1188 {
1189         return String::compose("%1:%2:%3", ec.category().name(), ec.value(), ec.message());
1190 }
1191
1192
1193 bool
1194 contains_assetmap(boost::filesystem::path dir)
1195 {
1196         return boost::filesystem::is_regular_file(dir / "ASSETMAP") || boost::filesystem::is_regular_file(dir / "ASSETMAP.xml");
1197 }
1198