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