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