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