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