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 "variant.h"
  53 #include "video_content.h"
  54 #include <dcp/atmos_asset.h>
  55 #include <dcp/decrypted_kdm.h>
  56 #include <dcp/file.h>
  57 #include <dcp/filesystem.h>
  58 #include <dcp/locale_convert.h>
  59 #include <dcp/mpeg2_picture_asset.h>
  60 #include <dcp/picture_asset.h>
  61 #include <dcp/raw_convert.h>
  62 #include <dcp/scope_guard.h>
  63 #include <dcp/sound_asset.h>
  64 #include <dcp/subtitle_asset.h>
  65 #include <dcp/util.h>
  66 #include <dcp/warnings.h>
  67 LIBDCP_DISABLE_WARNINGS
  68 extern "C" {
  69 #include <libavfilter/avfilter.h>
  70 #include <libavformat/avformat.h>
  71 #include <libavcodec/avcodec.h>
  72 }
  73 LIBDCP_ENABLE_WARNINGS
  74 #include <curl/curl.h>
  75 #include <glib.h>
  76 #include <pangomm/init.h>
  77 #include <unicode/utypes.h>
  78 #include <unicode/unistr.h>
  79 #include <unicode/translit.h>
  80 #include <unicode/brkiter.h>
  81 #include <boost/algorithm/string.hpp>
  82 #include <boost/range/algorithm/replace_if.hpp>
  83 #include <boost/thread.hpp>
  84 #include <boost/filesystem.hpp>
  85 LIBDCP_DISABLE_WARNINGS
  86 #include <boost/locale.hpp>
  87 LIBDCP_ENABLE_WARNINGS
  88 #ifdef DCPOMATIC_WINDOWS
  89 #include <dbghelp.h>
  90 #endif
  91 #include <signal.h>
  92 #include <climits>
  93 #include <iomanip>
  94 #include <iostream>
  95 #include <fstream>
  96 #include <numeric>
  97 #include <stdexcept>
  98 #ifdef DCPOMATIC_POSIX
  99 #include <execinfo.h>
 100 #include <cxxabi.h>
 101 #endif
 102
 103 #include "i18n.h"
 104
 105
 106 using std::bad_alloc;
 107 using std::cout;
 108 using std::dynamic_pointer_cast;
 109 using std::endl;
 110 using std::istream;
 111 using std::list;
 112 using std::make_pair;
 113 using std::make_shared;
 114 using std::map;
 115 using std::min;
 116 using std::ostream;
 117 using std::pair;
 118 using std::set_terminate;
 119 using std::shared_ptr;
 120 using std::string;
 121 using std::vector;
 122 using std::wstring;
 123 using boost::thread;
 124 using boost::optional;
 125 using dcp::Size;
 126 using dcp::raw_convert;
 127 using dcp::locale_convert;
 128 using namespace dcpomatic;
 129
 130
 131 /** Path to our executable, required by the stacktrace stuff and filled
 132  *  in during App::onInit().
 133  */
 134 string program_name;
 135 bool is_batch_converter = false;
 136 static boost::thread::id ui_thread;
 137 static boost::filesystem::path backtrace_file;
 138
 139 /** Convert some number of seconds to a string representation
 140  *  in hours, minutes and seconds.
 141  *
 142  *  @param s Seconds.
 143  *  @return String of the form H:M:S (where H is hours, M
 144  *  is minutes and S is seconds).
 145  */
 146 string
 147 seconds_to_hms (int s)
 148 {
 149         int m = s / 60;
 150         s -= (m * 60);
 151         int h = m / 60;
 152         m -= (h * 60);
 153
 154         char buffer[64];
 155         snprintf (buffer, sizeof(buffer), "%d:%02d:%02d", h, m, s);
 156         return buffer;
 157 }
 158
 159 string
 160 time_to_hmsf (DCPTime time, Frame rate)
 161 {
 162         Frame f = time.frames_round (rate);
 163         int s = f / rate;
 164         f -= (s * rate);
 165         int m = s / 60;
 166         s -= m * 60;
 167         int h = m / 60;
 168         m -= h * 60;
 169
 170         char buffer[64];
 171         snprintf (buffer, sizeof(buffer), "%d:%02d:%02d.%d", h, m, s, static_cast<int>(f));
 172         return buffer;
 173 }
 174
 175 /** @param s Number of seconds.
 176  *  @return String containing an approximate description of s (e.g. "about 2 hours")
 177  */
 178 string
 179 seconds_to_approximate_hms (int s)
 180 {
 181         int m = s / 60;
 182         s -= (m * 60);
 183         int h = m / 60;
 184         m -= (h * 60);
 185
 186         string ap;
 187
 188         bool hours = h > 0;
 189         bool minutes = h < 6 && m > 0;
 190         bool seconds = h == 0 && m < 10 && s > 0;
 191
 192         if (m > 30 && !minutes) {
 193                 /* round up the hours */
 194                 ++h;
 195         }
 196         if (s > 30 && !seconds) {
 197                 /* round up the minutes */
 198                 ++m;
 199                 if (m == 60) {
 200                         m = 0;
 201                         minutes = false;
 202                         ++h;
 203                 }
 204         }
 205
 206         if (hours) {
 207                 /// TRANSLATORS: h here is an abbreviation for hours
 208                 ap += locale_convert<string>(h) + _("h");
 209
 210                 if (minutes || seconds) {
 211                         ap += N_(" ");
 212                 }
 213         }
 214
 215         if (minutes) {
 216                 /// TRANSLATORS: m here is an abbreviation for minutes
 217                 ap += locale_convert<string>(m) + _("m");
 218
 219                 if (seconds) {
 220                         ap += N_(" ");
 221                 }
 222         }
 223
 224         if (seconds) {
 225                 /* Seconds */
 226                 /// TRANSLATORS: s here is an abbreviation for seconds
 227                 ap += locale_convert<string>(s) + _("s");
 228         }
 229
 230         return ap;
 231 }
 232
 233 double
 234 seconds (struct timeval t)
 235 {
 236         return t.tv_sec + (double (t.tv_usec) / 1e6);
 237 }
 238
 239 #ifdef DCPOMATIC_WINDOWS
 240
 241 /** Resolve symbol name and source location given the path to the executable */
 242 int
 243 addr2line (void const * const addr)
 244 {
 245         char addr2line_cmd[512] = { 0 };
 246         sprintf (addr2line_cmd, "addr2line -f -p -e %.256s %p > %s", program_name.c_str(), addr, backtrace_file.string().c_str());
 247         std::cout << addr2line_cmd << "\n";
 248         return system(addr2line_cmd);
 249 }
 250
 251 LIBDCP_DISABLE_WARNINGS
 252 /** This is called when C signals occur on Windows (e.g. SIGSEGV)
 253  *  (NOT C++ exceptions!).  We write a backtrace to backtrace_file by dark means.
 254  *  Adapted from code here: http://spin.atomicobject.com/2013/01/13/exceptions-stack-traces-c/
 255  */
 256 LONG WINAPI
 257 exception_handler(struct _EXCEPTION_POINTERS * info)
 258 {
 259         dcp::File f(backtrace_file, "w");
 260         if (f) {
 261                 fprintf(f.get(), "C-style exception %d\n", info->ExceptionRecord->ExceptionCode);
 262                 f.close();
 263         }
 264
 265         if (info->ExceptionRecord->ExceptionCode != EXCEPTION_STACK_OVERFLOW) {
 266                 CONTEXT* context = info->ContextRecord;
 267                 SymInitialize (GetCurrentProcess (), 0, true);
 268
 269                 STACKFRAME frame = { 0 };
 270
 271                 /* setup initial stack frame */
 272 #if _WIN64
 273                 frame.AddrPC.Offset    = context->Rip;
 274                 frame.AddrStack.Offset = context->Rsp;
 275                 frame.AddrFrame.Offset = context->Rbp;
 276 #else
 277                 frame.AddrPC.Offset    = context->Eip;
 278                 frame.AddrStack.Offset = context->Esp;
 279                 frame.AddrFrame.Offset = context->Ebp;
 280 #endif
 281                 frame.AddrPC.Mode      = AddrModeFlat;
 282                 frame.AddrStack.Mode   = AddrModeFlat;
 283                 frame.AddrFrame.Mode   = AddrModeFlat;
 284
 285                 while (
 286                         StackWalk (
 287                                 IMAGE_FILE_MACHINE_I386,
 288                                 GetCurrentProcess (),
 289                                 GetCurrentThread (),
 290                                 &frame,
 291                                 context,
 292                                 0,
 293                                 SymFunctionTableAccess,
 294                                 SymGetModuleBase,
 295                                 0
 296                                 )
 297                         ) {
 298                         addr2line((void *) frame.AddrPC.Offset);
 299                 }
 300         } else {
 301 #ifdef _WIN64
 302                 addr2line ((void *) info->ContextRecord->Rip);
 303 #else
 304                 addr2line ((void *) info->ContextRecord->Eip);
 305 #endif
 306         }
 307
 308         return EXCEPTION_CONTINUE_SEARCH;
 309 }
 310 LIBDCP_ENABLE_WARNINGS
 311 #endif
 312
 313 void
 314 set_backtrace_file (boost::filesystem::path p)
 315 {
 316         backtrace_file = p;
 317 }
 318
 319 /** This is called when there is an unhandled exception.  Any
 320  *  backtrace in this function is useless on Windows as the stack has
 321  *  already been unwound from the throw; we have the gdb wrap hack to
 322  *  cope with that.
 323  */
 324 void
 325 terminate ()
 326 {
 327         try {
 328                 static bool tried_throw = false;
 329                 // try once to re-throw currently active exception
 330                 if (!tried_throw) {
 331                         tried_throw = true;
 332                         throw;
 333                 }
 334         }
 335         catch (const std::exception &e) {
 336                 std::cerr << __FUNCTION__ << " caught unhandled exception. what(): "
 337                           << e.what() << std::endl;
 338         }
 339         catch (...) {
 340                 std::cerr << __FUNCTION__ << " caught unknown/unhandled exception."
 341                           << std::endl;
 342         }
 343
 344         abort();
 345 }
 346
 347 void
 348 dcpomatic_setup_path_encoding ()
 349 {
 350 #ifdef DCPOMATIC_WINDOWS
 351         /* Dark voodoo which, I think, gets boost::filesystem::path to
 352            correctly convert UTF-8 strings to paths, and also paths
 353            back to UTF-8 strings (on path::string()).
 354
 355            After this, constructing boost::filesystem::paths from strings
 356            converts from UTF-8 to UTF-16 inside the path.  Then
 357            path::string().c_str() gives UTF-8 and
 358            path::c_str()          gives UTF-16.
 359
 360            This is all Windows-only.  AFAICT Linux/OS X use UTF-8 everywhere,
 361            so things are much simpler.
 362         */
 363         std::locale::global (boost::locale::generator().generate (""));
 364         boost::filesystem::path::imbue (std::locale ());
 365 #endif
 366 }
 367
 368
 369 class LogSink : public Kumu::ILogSink
 370 {
 371 public:
 372         LogSink () {}
 373         LogSink (LogSink const&) = delete;
 374         LogSink& operator= (LogSink const&) = delete;
 375
 376         void WriteEntry(const Kumu::LogEntry& entry) override {
 377                 Kumu::AutoMutex L(m_lock);
 378                 WriteEntryToListeners(entry);
 379                 if (entry.TestFilter(m_filter)) {
 380                         string buffer;
 381                         entry.CreateStringWithOptions(buffer, m_options);
 382                         LOG_GENERAL("asdcplib: %1", buffer);
 383                 }
 384         }
 385 };
 386
 387
 388 void
 389 capture_asdcp_logs ()
 390 {
 391         static LogSink log_sink;
 392         Kumu::SetDefaultLogSink(&log_sink);
 393 }
 394
 395
 396 static
 397 void
 398 ffmpeg_log_callback(void* ptr, int level, const char* fmt, va_list vl)
 399 {
 400         if (level > AV_LOG_WARNING) {
 401                 return;
 402         }
 403
 404         char line[1024];
 405         static int prefix = 0;
 406         av_log_format_line(ptr, level, fmt, vl, line, sizeof (line), &prefix);
 407         string str(line);
 408         boost::algorithm::trim(str);
 409         dcpomatic_log->log(String::compose("FFmpeg: %1", str), LogEntry::TYPE_GENERAL);
 410 }
 411
 412
 413 void
 414 capture_ffmpeg_logs()
 415 {
 416         av_log_set_callback(ffmpeg_log_callback);
 417 }
 418
 419
 420 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
 421  *  Must be called from the UI thread, if there is one.
 422  */
 423 void
 424 dcpomatic_setup ()
 425 {
 426 #ifdef DCPOMATIC_WINDOWS
 427         boost::filesystem::path p = g_get_user_config_dir ();
 428         p /= "backtrace.txt";
 429         set_backtrace_file (p);
 430         SetUnhandledExceptionFilter(exception_handler);
 431 #endif
 432
 433 #ifdef DCPOMATIC_GROK
 434         /* This makes grok support work with CUDA 12.2 */
 435         setenv("CUDA_MODULE_LOADING", "EAGER", 1);
 436 #endif
 437
 438 #ifdef DCPOMATIC_HAVE_AVREGISTER
 439 LIBDCP_DISABLE_WARNINGS
 440         av_register_all ();
 441         avfilter_register_all ();
 442 LIBDCP_ENABLE_WARNINGS
 443 #endif
 444
 445 #ifdef DCPOMATIC_OSX
 446         /* Add our library directory to the libltdl search path so that
 447            xmlsec can find xmlsec1-openssl.
 448         */
 449         auto lib = directory_containing_executable().parent_path();
 450         lib /= "Frameworks";
 451         setenv ("LTDL_LIBRARY_PATH", lib.c_str (), 1);
 452 #endif
 453
 454         set_terminate (terminate);
 455
 456 #ifdef DCPOMATIC_WINDOWS
 457         putenv ("PANGOCAIRO_BACKEND=fontconfig");
 458         if (dcp::filesystem::exists(resources_path() / "fonts.conf")) {
 459                 /* The actual application after installation */
 460                 putenv(String::compose("FONTCONFIG_PATH=%1", resources_path().string()).c_str());
 461         } else {
 462                 /* The place where fonts.conf is during tests */
 463                 putenv("FONTCONFIG_PATH=build\\fonts");
 464         }
 465 #endif
 466
 467 #ifdef DCPOMATIC_OSX
 468         setenv ("PANGOCAIRO_BACKEND", "fontconfig", 1);
 469         setenv ("FONTCONFIG_PATH", resources_path().string().c_str(), 1);
 470 #endif
 471
 472         Pango::init ();
 473         dcp::init (libdcp_resources_path());
 474
 475 #if defined(DCPOMATIC_WINDOWS) || defined(DCPOMATIC_OSX)
 476         /* Render something to fontconfig to create its cache */
 477         vector<StringText> subs;
 478         dcp::SubtitleString ss(
 479                 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,
 480                 "Hello dolly", dcp::Effect::NONE, dcp::Colour(), dcp::Time(), dcp::Time(), 0, std::vector<dcp::Ruby>()
 481                 );
 482         subs.push_back(StringText(ss, 0, make_shared<dcpomatic::Font>("foo"), dcp::SubtitleStandard::SMPTE_2014));
 483         render_text (subs, dcp::Size(640, 480), DCPTime(), 24);
 484 #endif
 485
 486         Ratio::setup_ratios ();
 487         PresetColourConversion::setup_colour_conversion_presets ();
 488         DCPContentType::setup_dcp_content_types ();
 489         Filter::setup_filters ();
 490         CinemaSoundProcessor::setup_cinema_sound_processors ();
 491         AudioProcessor::setup_audio_processors ();
 492
 493         curl_global_init (CURL_GLOBAL_ALL);
 494
 495         ui_thread = boost::this_thread::get_id ();
 496
 497         capture_asdcp_logs ();
 498         capture_ffmpeg_logs();
 499 }
 500
 501 #ifdef DCPOMATIC_WINDOWS
 502 boost::filesystem::path
 503 mo_path ()
 504 {
 505         wchar_t buffer[512];
 506         GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
 507         boost::filesystem::path p (buffer);
 508         p = p.parent_path ();
 509         p = p.parent_path ();
 510         p /= "locale";
 511         return p;
 512 }
 513 #endif
 514
 515 #ifdef DCPOMATIC_OSX
 516 boost::filesystem::path
 517 mo_path ()
 518 {
 519         return variant::dcpomatic_app() + "/Contents/Resources";
 520 }
 521 #endif
 522
 523 void
 524 dcpomatic_setup_gettext_i18n (string lang)
 525 {
 526 #ifdef DCPOMATIC_LINUX
 527         lang += ".UTF8";
 528 #endif
 529
 530         if (!lang.empty ()) {
 531                 /* Override our environment language.  Note that the caller must not
 532                    free the string passed into putenv().
 533                 */
 534                 string s = String::compose ("LANGUAGE=%1", lang);
 535                 putenv (strdup (s.c_str ()));
 536                 s = String::compose ("LANG=%1", lang);
 537                 putenv (strdup (s.c_str ()));
 538                 s = String::compose ("LC_ALL=%1", lang);
 539                 putenv (strdup (s.c_str ()));
 540         }
 541
 542         setlocale (LC_ALL, "");
 543         textdomain ("libdcpomatic2");
 544
 545 #if defined(DCPOMATIC_WINDOWS) || defined(DCPOMATIC_OSX)
 546         bindtextdomain ("libdcpomatic2", mo_path().string().c_str());
 547         bind_textdomain_codeset ("libdcpomatic2", "UTF8");
 548 #endif
 549
 550 #ifdef DCPOMATIC_LINUX
 551         bindtextdomain ("libdcpomatic2", LINUX_LOCALE_PREFIX);
 552 #endif
 553 }
 554
 555 /** Compute a digest of the first and last `size' bytes of a set of files. */
 556 string
 557 digest_head_tail (vector<boost::filesystem::path> files, boost::uintmax_t size)
 558 {
 559         boost::scoped_array<char> buffer (new char[size]);
 560         Digester digester;
 561
 562         /* Head */
 563         boost::uintmax_t to_do = size;
 564         char* p = buffer.get ();
 565         int i = 0;
 566         while (i < int64_t (files.size()) && to_do > 0) {
 567                 dcp::File f(files[i], "rb");
 568                 if (!f) {
 569                         throw OpenFileError (files[i].string(), errno, OpenFileError::READ);
 570                 }
 571
 572                 auto this_time = min(to_do, dcp::filesystem::file_size(files[i]));
 573                 f.checked_read(p, this_time);
 574                 p += this_time;
 575                 to_do -= this_time;
 576
 577                 ++i;
 578         }
 579         digester.add (buffer.get(), size - to_do);
 580
 581         /* Tail */
 582         to_do = size;
 583         p = buffer.get ();
 584         i = files.size() - 1;
 585         while (i >= 0 && to_do > 0) {
 586                 dcp::File f(files[i], "rb");
 587                 if (!f) {
 588                         throw OpenFileError (files[i].string(), errno, OpenFileError::READ);
 589                 }
 590
 591                 auto this_time = min(to_do, dcp::filesystem::file_size(files[i]));
 592                 f.seek(-this_time, SEEK_END);
 593                 f.checked_read(p, this_time);
 594                 p += this_time;
 595                 to_do -= this_time;
 596
 597                 --i;
 598         }
 599         digester.add (buffer.get(), size - to_do);
 600
 601         return digester.get ();
 602 }
 603
 604
 605 string
 606 simple_digest (vector<boost::filesystem::path> paths)
 607 {
 608         DCP_ASSERT(!paths.empty());
 609         return digest_head_tail(paths, 1000000) + raw_convert<string>(dcp::filesystem::file_size(paths.front()));
 610 }
 611
 612
 613 /** Trip an assert if the caller is not in the UI thread */
 614 void
 615 ensure_ui_thread ()
 616 {
 617         DCPOMATIC_ASSERT (boost::this_thread::get_id() == ui_thread);
 618 }
 619
 620 string
 621 audio_channel_name (int c)
 622 {
 623         DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
 624
 625         /// TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
 626         /// enhancement channel (sub-woofer).
 627         string const channels[] = {
 628                 _("Left"),
 629                 _("Right"),
 630                 _("Centre"),
 631                 _("Lfe (sub)"),
 632                 _("Left surround"),
 633                 _("Right surround"),
 634                 _("Hearing impaired"),
 635                 _("Visually impaired"),
 636                 _("Left centre"),
 637                 _("Right centre"),
 638                 _("Left rear surround"),
 639                 _("Right rear surround"),
 640                 _("D-BOX primary"),
 641                 _("D-BOX secondary"),
 642                 _("Unused"),
 643                 _("Unused")
 644         };
 645
 646         return channels[c];
 647 }
 648
 649 string
 650 short_audio_channel_name (int c)
 651 {
 652         DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
 653
 654         /// TRANSLATORS: these are short names of audio channels; Lfe is the low-frequency
 655         /// enhancement channel (sub-woofer).  HI is the hearing-impaired audio track and
 656         /// VI is the visually-impaired audio track (audio describe).  DBP is the D-BOX
 657         /// primary channel and DBS is the D-BOX secondary channel.
 658         string const channels[] = {
 659                 _("L"),
 660                 _("R"),
 661                 _("C"),
 662                 _("Lfe"),
 663                 _("Ls"),
 664                 _("Rs"),
 665                 _("HI"),
 666                 _("VI"),
 667                 _("9"),
 668                 _("10"),
 669                 _("BsL"),
 670                 _("BsR"),
 671                 _("DBP"),
 672                 _("DBS"),
 673                 _("Sign"),
 674                 _("16")
 675         };
 676
 677         return channels[c];
 678 }
 679
 680
 681 bool
 682 valid_image_file (boost::filesystem::path f)
 683 {
 684         if (boost::starts_with(f.filename().string(), "._")) {
 685                 return false;
 686         }
 687
 688         auto ext = f.extension().string();
 689         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 690         return (
 691                 ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" ||
 692                 ext == ".png" || ext == ".bmp" || ext == ".tga" || ext == ".dpx" ||
 693                 ext == ".j2c" || ext == ".j2k" || ext == ".jp2" || ext == ".exr" ||
 694                 ext == ".jpf" || ext == ".psd"
 695                 );
 696 }
 697
 698 bool
 699 valid_sound_file (boost::filesystem::path f)
 700 {
 701         if (boost::starts_with(f.filename().string(), "._")) {
 702                 return false;
 703         }
 704
 705         auto ext = f.extension().string();
 706         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 707         return (ext == ".wav" || ext == ".mp3" || ext == ".aif" || ext == ".aiff");
 708 }
 709
 710 bool
 711 valid_j2k_file (boost::filesystem::path f)
 712 {
 713         auto ext = f.extension().string();
 714         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 715         return (ext == ".j2k" || ext == ".j2c" || ext == ".jp2");
 716 }
 717
 718 string
 719 tidy_for_filename (string f)
 720 {
 721         boost::replace_if (f, boost::is_any_of ("\\/:"), '_');
 722         return f;
 723 }
 724
 725 dcp::Size
 726 fit_ratio_within (float ratio, dcp::Size full_frame)
 727 {
 728         if (ratio < full_frame.ratio ()) {
 729                 return dcp::Size (lrintf (full_frame.height * ratio), full_frame.height);
 730         }
 731
 732         return dcp::Size (full_frame.width, lrintf (full_frame.width / ratio));
 733 }
 734
 735 static
 736 string
 737 asset_filename (shared_ptr<dcp::Asset> asset, string type, int reel_index, int reel_count, optional<string> summary, string extension)
 738 {
 739         dcp::NameFormat::Map values;
 740         values['t'] = type;
 741         values['r'] = raw_convert<string>(reel_index + 1);
 742         values['n'] = raw_convert<string>(reel_count);
 743         if (summary) {
 744                 values['c'] = summary.get();
 745         }
 746         return careful_string_filter(Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + extension));
 747 }
 748
 749
 750 string
 751 video_asset_filename(shared_ptr<dcp::PictureAsset> asset, int reel_index, int reel_count, optional<string> summary)
 752 {
 753         string type = dynamic_pointer_cast<dcp::MPEG2PictureAsset>(asset) ? "mpeg2" : "j2c";
 754         return asset_filename(asset, type, reel_index, reel_count, summary, ".mxf");
 755 }
 756
 757
 758 string
 759 audio_asset_filename (shared_ptr<dcp::SoundAsset> asset, int reel_index, int reel_count, optional<string> summary)
 760 {
 761         return asset_filename(asset, "pcm", reel_index, reel_count, summary, ".mxf");
 762 }
 763
 764
 765 string
 766 subtitle_asset_filename (shared_ptr<dcp::SubtitleAsset> asset, int reel_index, int reel_count, optional<string> summary, string extension)
 767 {
 768         return asset_filename(asset, "sub", reel_index, reel_count, summary, extension);
 769 }
 770
 771
 772 string
 773 atmos_asset_filename (shared_ptr<dcp::AtmosAsset> asset, int reel_index, int reel_count, optional<string> summary)
 774 {
 775         return asset_filename(asset, "atmos", reel_index, reel_count, summary, ".mxf");
 776 }
 777
 778
 779 string
 780 careful_string_filter (string s)
 781 {
 782         /* Filter out `bad' characters which `may' cause problems with some systems (either for DCP name or filename).
 783            There's no apparent list of what really is allowed, so this is a guess.
 784            Safety first and all that.
 785         */
 786
 787         /* First transliterate using libicu to try to remove accents in a "nice" way */
 788         auto transliterated = icu::UnicodeString::fromUTF8(icu::StringPiece(s));
 789         auto status = U_ZERO_ERROR;
 790         auto transliterator = icu::Transliterator::createInstance("NFD; [:M:] Remove; NFC", UTRANS_FORWARD, status);
 791         transliterator->transliterate(transliterated);
 792
 793         /* Some things are missed by ICU's transliterator */
 794         std::map<wchar_t, wchar_t> replacements = {
 795                 { L'ł',         L'l' },
 796                 { L'Ł',         L'L' }
 797         };
 798
 799         icu::UnicodeString transliterated_more;
 800         for (int i = 0; i < transliterated.length(); ++i) {
 801                 auto replacement = replacements.find(transliterated[i]);
 802                 if (replacement != replacements.end()) {
 803                         transliterated_more += replacement->second;
 804                 } else {
 805                         transliterated_more += transliterated[i];
 806                 }
 807         }
 808
 809         /* Then remove anything that's not in a very limited character set */
 810         wstring out;
 811         wstring const allowed = L"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_.+";
 812         for (int i = 0; i < transliterated_more.length(); ++i) {
 813                 wchar_t c = transliterated_more[i];
 814                 if (allowed.find(c) != string::npos) {
 815                         out += c;
 816                 }
 817         }
 818
 819         return boost::locale::conv::utf_to_utf<char>(out);
 820 }
 821
 822 /** @param mapped List of mapped audio channels from a Film.
 823  *  @param channels Total number of channels in the Film.
 824  *  @return First: number of non-LFE soundtrack channels (L/R/C/Ls/Rs/Lc/Rc/Bsl/Bsr), second: number of LFE channels.
 825  */
 826 pair<int, int>
 827 audio_channel_types (list<int> mapped, int channels)
 828 {
 829         int non_lfe = 0;
 830         int lfe = 0;
 831
 832         for (auto i: mapped) {
 833                 if (i >= channels) {
 834                         /* This channel is mapped but is not included in the DCP */
 835                         continue;
 836                 }
 837
 838                 switch (static_cast<dcp::Channel>(i)) {
 839                 case dcp::Channel::LFE:
 840                         ++lfe;
 841                         break;
 842                 case dcp::Channel::LEFT:
 843                 case dcp::Channel::RIGHT:
 844                 case dcp::Channel::CENTRE:
 845                 case dcp::Channel::LS:
 846                 case dcp::Channel::RS:
 847                 case dcp::Channel::BSL:
 848                 case dcp::Channel::BSR:
 849                         ++non_lfe;
 850                         break;
 851                 case dcp::Channel::LC:
 852                 case dcp::Channel::RC:
 853                 case dcp::Channel::HI:
 854                 case dcp::Channel::VI:
 855                 case dcp::Channel::MOTION_DATA:
 856                 case dcp::Channel::SYNC_SIGNAL:
 857                 case dcp::Channel::SIGN_LANGUAGE:
 858                 case dcp::Channel::CHANNEL_COUNT:
 859                         break;
 860                 }
 861         }
 862
 863         return make_pair (non_lfe, lfe);
 864 }
 865
 866 shared_ptr<AudioBuffers>
 867 remap (shared_ptr<const AudioBuffers> input, int output_channels, AudioMapping map)
 868 {
 869         auto mapped = make_shared<AudioBuffers>(output_channels, input->frames());
 870         mapped->make_silent ();
 871
 872         int to_do = min (map.input_channels(), input->channels());
 873
 874         for (int i = 0; i < to_do; ++i) {
 875                 for (int j = 0; j < mapped->channels(); ++j) {
 876                         if (map.get(i, j) > 0) {
 877                                 mapped->accumulate_channel(
 878                                         input.get(),
 879                                         i,
 880                                         j,
 881                                         map.get(i, j)
 882                                         );
 883                         }
 884                 }
 885         }
 886
 887         return mapped;
 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(variant::insert_dcpomatic(_("This KDM was not made for %1's decryption certificate.")), e.what());
1026                 } else if (kdm_subject_name != dc->leaf().subject()) {
1027                         throw KDMError(variant::insert_dcpomatic(_("This KDM was made for %1 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 #ifdef DCPOMATIC_GROK
1128 void
1129 setup_grok_library_path()
1130 {
1131         static std::string old_path;
1132         if (old_path.empty()) {
1133                 auto const old = getenv("LD_LIRARY_PATH");
1134                 if (old) {
1135                         old_path = old;
1136                 }
1137         }
1138         auto const grok = Config::instance()->grok();
1139         if (!grok || grok->binary_location.empty()) {
1140                 setenv("LD_LIRARY_PATH", old_path.c_str(), 1);
1141                 return;
1142         }
1143
1144         std::string new_path = old_path;
1145         if (!new_path.empty()) {
1146                 new_path += ":";
1147         }
1148         new_path += grok->binary_location.string();
1149
1150         setenv("LD_LIBRARY_PATH", new_path.c_str(), 1);
1151 }
1152 #endif
1153
1154
1155 string
1156 screen_names_to_string(vector<string> names)
1157 {
1158         if (names.empty()) {
1159                 return {};
1160         }
1161
1162         auto number = [](string const& s) {
1163                 return s.find_first_not_of("0123456789") == string::npos;
1164         };
1165
1166         if (std::find_if(names.begin(), names.end(), [number](string const& s) { return !number(s); }) == names.end()) {
1167                 std::sort(names.begin(), names.end(), [](string const& a, string const& b) {
1168                         return dcp::raw_convert<int>(a) < dcp::raw_convert<int>(b);
1169                 });
1170         } else {
1171                 std::sort(names.begin(), names.end());
1172         }
1173
1174         string result;
1175         for (auto const& name: names) {
1176                 result += name + ", ";
1177         }
1178
1179         return result.substr(0, result.length() - 2);
1180 }
1181
1182
1183 string
1184 report_problem()
1185 {
1186         return String::compose(_("Please report this problem by using Help -> Report a problem or via email to %1"), variant::report_problem_email());
1187 }
1188
1189
1190 string
1191 join_strings(vector<string> const& in, string const& separator)
1192 {
1193         if (in.empty()) {
1194                 return {};
1195         }
1196
1197         return std::accumulate(std::next(in.begin()), in.end(), in.front(), [separator](string a, string b) {
1198                 return a + separator + b;
1199         });
1200 }
1201