src/lib/util.cc

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