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