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