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