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