src/lib/util.cc

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