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 "warnings.h"
  53 #include <dcp/decrypted_kdm.h>
  54 #include <dcp/locale_convert.h>
  55 #include <dcp/util.h>
  56 #include <dcp/raw_convert.h>
  57 #include <dcp/picture_asset.h>
  58 #include <dcp/sound_asset.h>
  59 #include <dcp/subtitle_asset.h>
  60 #include <dcp/atmos_asset.h>
  61 DCPOMATIC_DISABLE_WARNINGS
  62 extern "C" {
  63 #include <libavfilter/avfilter.h>
  64 #include <libavformat/avformat.h>
  65 #include <libavcodec/avcodec.h>
  66 }
  67 DCPOMATIC_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 DCPOMATIC_DISABLE_WARNINGS
  79 #include <boost/locale.hpp>
  80 DCPOMATIC_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 DCPOMATIC_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 DCPOMATIC_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 DCPOMATIC_DISABLE_WARNINGS
 375         av_register_all ();
 376         avfilter_register_all ();
 377 DCPOMATIC_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 /** Trip an assert if the caller is not in the UI thread */
 534 void
 535 ensure_ui_thread ()
 536 {
 537         DCPOMATIC_ASSERT (boost::this_thread::get_id() == ui_thread);
 538 }
 539
 540 string
 541 audio_channel_name (int c)
 542 {
 543         DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
 544
 545         /// TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
 546         /// enhancement channel (sub-woofer).
 547         string const channels[] = {
 548                 _("Left"),
 549                 _("Right"),
 550                 _("Centre"),
 551                 _("Lfe (sub)"),
 552                 _("Left surround"),
 553                 _("Right surround"),
 554                 _("Hearing impaired"),
 555                 _("Visually impaired"),
 556                 _("Left centre"),
 557                 _("Right centre"),
 558                 _("Left rear surround"),
 559                 _("Right rear surround"),
 560                 _("D-BOX primary"),
 561                 _("D-BOX secondary"),
 562                 _("Unused"),
 563                 _("Unused")
 564         };
 565
 566         return channels[c];
 567 }
 568
 569 string
 570 short_audio_channel_name (int c)
 571 {
 572         DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
 573
 574         /// TRANSLATORS: these are short names of audio channels; Lfe is the low-frequency
 575         /// enhancement channel (sub-woofer).  HI is the hearing-impaired audio track and
 576         /// VI is the visually-impaired audio track (audio describe).  DBP is the D-BOX
 577         /// primary channel and DBS is the D-BOX secondary channel.
 578         string const channels[] = {
 579                 _("L"),
 580                 _("R"),
 581                 _("C"),
 582                 _("Lfe"),
 583                 _("Ls"),
 584                 _("Rs"),
 585                 _("HI"),
 586                 _("VI"),
 587                 _("Lc"),
 588                 _("Rc"),
 589                 _("BsL"),
 590                 _("BsR"),
 591                 _("DBP"),
 592                 _("DBS"),
 593                 _("Sign"),
 594                 ""
 595         };
 596
 597         return channels[c];
 598 }
 599
 600
 601 bool
 602 valid_image_file (boost::filesystem::path f)
 603 {
 604         if (boost::starts_with (f.leaf().string(), "._")) {
 605                 return false;
 606         }
 607
 608         auto ext = f.extension().string();
 609         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 610         return (
 611                 ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" ||
 612                 ext == ".png" || ext == ".bmp" || ext == ".tga" || ext == ".dpx" ||
 613                 ext == ".j2c" || ext == ".j2k" || ext == ".jp2" || ext == ".exr" ||
 614                 ext == ".jpf" || ext == ".psd"
 615                 );
 616 }
 617
 618 bool
 619 valid_sound_file (boost::filesystem::path f)
 620 {
 621         if (boost::starts_with (f.leaf().string(), "._")) {
 622                 return false;
 623         }
 624
 625         auto ext = f.extension().string();
 626         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 627         return (ext == ".wav" || ext == ".mp3" || ext == ".aif" || ext == ".aiff");
 628 }
 629
 630 bool
 631 valid_j2k_file (boost::filesystem::path f)
 632 {
 633         auto ext = f.extension().string();
 634         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 635         return (ext == ".j2k" || ext == ".j2c" || ext == ".jp2");
 636 }
 637
 638 string
 639 tidy_for_filename (string f)
 640 {
 641         boost::replace_if (f, boost::is_any_of ("\\/:"), '_');
 642         return f;
 643 }
 644
 645 dcp::Size
 646 fit_ratio_within (float ratio, dcp::Size full_frame)
 647 {
 648         if (ratio < full_frame.ratio ()) {
 649                 return dcp::Size (lrintf (full_frame.height * ratio), full_frame.height);
 650         }
 651
 652         return dcp::Size (full_frame.width, lrintf (full_frame.width / ratio));
 653 }
 654
 655 map<string, string>
 656 split_get_request (string url)
 657 {
 658         enum {
 659                 AWAITING_QUESTION_MARK,
 660                 KEY,
 661                 VALUE
 662         } state = AWAITING_QUESTION_MARK;
 663
 664         map<string, string> r;
 665         string k;
 666         string v;
 667         for (size_t i = 0; i < url.length(); ++i) {
 668                 switch (state) {
 669                 case AWAITING_QUESTION_MARK:
 670                         if (url[i] == '?') {
 671                                 state = KEY;
 672                         }
 673                         break;
 674                 case KEY:
 675                         if (url[i] == '=') {
 676                                 v.clear ();
 677                                 state = VALUE;
 678                         } else {
 679                                 k += url[i];
 680                         }
 681                         break;
 682                 case VALUE:
 683                         if (url[i] == '&') {
 684                                 r.insert (make_pair (k, v));
 685                                 k.clear ();
 686                                 state = KEY;
 687                         } else {
 688                                 v += url[i];
 689                         }
 690                         break;
 691                 }
 692         }
 693
 694         if (state == VALUE) {
 695                 r.insert (make_pair (k, v));
 696         }
 697
 698         return r;
 699 }
 700
 701 string
 702 video_asset_filename (shared_ptr<dcp::PictureAsset> asset, int reel_index, int reel_count, optional<string> summary)
 703 {
 704         dcp::NameFormat::Map values;
 705         values['t'] = "j2c";
 706         values['r'] = raw_convert<string> (reel_index + 1);
 707         values['n'] = raw_convert<string> (reel_count);
 708         if (summary) {
 709                 values['c'] = careful_string_filter (summary.get());
 710         }
 711         return Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + ".mxf");
 712 }
 713
 714 string
 715 audio_asset_filename (shared_ptr<dcp::SoundAsset> asset, int reel_index, int reel_count, optional<string> summary)
 716 {
 717         dcp::NameFormat::Map values;
 718         values['t'] = "pcm";
 719         values['r'] = raw_convert<string> (reel_index + 1);
 720         values['n'] = raw_convert<string> (reel_count);
 721         if (summary) {
 722                 values['c'] = careful_string_filter (summary.get());
 723         }
 724         return Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + ".mxf");
 725 }
 726
 727
 728 string
 729 atmos_asset_filename (shared_ptr<dcp::AtmosAsset> asset, int reel_index, int reel_count, optional<string> summary)
 730 {
 731         dcp::NameFormat::Map values;
 732         values['t'] = "atmos";
 733         values['r'] = raw_convert<string> (reel_index + 1);
 734         values['n'] = raw_convert<string> (reel_count);
 735         if (summary) {
 736                 values['c'] = careful_string_filter (summary.get());
 737         }
 738         return Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + ".mxf");
 739 }
 740
 741
 742 float
 743 relaxed_string_to_float (string s)
 744 {
 745         try {
 746                 boost::algorithm::replace_all (s, ",", ".");
 747                 return lexical_cast<float> (s);
 748         } catch (bad_lexical_cast &) {
 749                 boost::algorithm::replace_all (s, ".", ",");
 750                 return lexical_cast<float> (s);
 751         }
 752 }
 753
 754 string
 755 careful_string_filter (string s)
 756 {
 757         /* Filter out `bad' characters which `may' cause problems with some systems (either for DCP name or filename).
 758            There's no apparent list of what really is allowed, so this is a guess.
 759            Safety first and all that.
 760         */
 761
 762         /* First transliterate using libicu to try to remove accents in a "nice" way */
 763         auto icu_utf16 = icu::UnicodeString::fromUTF8(icu::StringPiece(s));
 764         auto status = U_ZERO_ERROR;
 765         auto transliterator = icu::Transliterator::createInstance("NFD; [:M:] Remove; NFC", UTRANS_FORWARD, status);
 766         transliterator->transliterate(icu_utf16);
 767         s.clear ();
 768         icu_utf16.toUTF8String(s);
 769
 770         /* Then remove anything that's not in a very limited character set */
 771         wstring ws = boost::locale::conv::utf_to_utf<wchar_t>(s);
 772         string out;
 773         string const allowed = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_%.+";
 774         for (size_t i = 0; i < ws.size(); ++i) {
 775                 wchar_t c = ws[i];
 776                 if (allowed.find(c) != string::npos) {
 777                         out += c;
 778                 }
 779         }
 780
 781         return boost::locale::conv::utf_to_utf<char>(out);
 782 }
 783
 784 /** @param mapped List of mapped audio channels from a Film.
 785  *  @param channels Total number of channels in the Film.
 786  *  @return First: number of non-LFE soundtrack channels (L/R/C/Ls/Rs/Lc/Rc/Bsl/Bsr), second: number of LFE channels.
 787  */
 788 pair<int, int>
 789 audio_channel_types (list<int> mapped, int channels)
 790 {
 791         int non_lfe = 0;
 792         int lfe = 0;
 793
 794         for (auto i: mapped) {
 795                 if (i >= channels) {
 796                         /* This channel is mapped but is not included in the DCP */
 797                         continue;
 798                 }
 799
 800                 switch (static_cast<dcp::Channel>(i)) {
 801                 case dcp::Channel::LFE:
 802                         ++lfe;
 803                         break;
 804                 case dcp::Channel::LEFT:
 805                 case dcp::Channel::RIGHT:
 806                 case dcp::Channel::CENTRE:
 807                 case dcp::Channel::LS:
 808                 case dcp::Channel::RS:
 809                 case dcp::Channel::BSL:
 810                 case dcp::Channel::BSR:
 811                         ++non_lfe;
 812                         break;
 813                 case dcp::Channel::HI:
 814                 case dcp::Channel::VI:
 815                 case dcp::Channel::MOTION_DATA:
 816                 case dcp::Channel::SYNC_SIGNAL:
 817                 case dcp::Channel::SIGN_LANGUAGE:
 818                 case dcp::Channel::CHANNEL_COUNT:
 819                         break;
 820                 }
 821         }
 822
 823         return make_pair (non_lfe, lfe);
 824 }
 825
 826 shared_ptr<AudioBuffers>
 827 remap (shared_ptr<const AudioBuffers> input, int output_channels, AudioMapping map)
 828 {
 829         auto mapped = make_shared<AudioBuffers>(output_channels, input->frames());
 830         mapped->make_silent ();
 831
 832         int to_do = min (map.input_channels(), input->channels());
 833
 834         for (int i = 0; i < to_do; ++i) {
 835                 for (int j = 0; j < mapped->channels(); ++j) {
 836                         if (map.get(i, j) > 0) {
 837                                 mapped->accumulate_channel(
 838                                         input.get(),
 839                                         i,
 840                                         j,
 841                                         map.get(i, j)
 842                                         );
 843                         }
 844                 }
 845         }
 846
 847         return mapped;
 848 }
 849
 850 Eyes
 851 increment_eyes (Eyes e)
 852 {
 853         if (e == Eyes::LEFT) {
 854                 return Eyes::RIGHT;
 855         }
 856
 857         return Eyes::LEFT;
 858 }
 859
 860 void
 861 checked_fwrite (void const * ptr, size_t size, FILE* stream, boost::filesystem::path path)
 862 {
 863         size_t N = fwrite (ptr, 1, size, stream);
 864         if (N != size) {
 865                 if (ferror(stream)) {
 866                         fclose (stream);
 867                         throw FileError (String::compose("fwrite error %1", errno), path);
 868                 } else {
 869                         fclose (stream);
 870                         throw FileError ("Unexpected short write", path);
 871                 }
 872         }
 873 }
 874
 875 void
 876 checked_fread (void* ptr, size_t size, FILE* stream, boost::filesystem::path path)
 877 {
 878         size_t N = fread (ptr, 1, size, stream);
 879         if (N != size) {
 880                 if (ferror(stream)) {
 881                         fclose (stream);
 882                         throw FileError (String::compose("fread error %1", errno), path);
 883                 } else {
 884                         fclose (stream);
 885                         throw FileError ("Unexpected short read", path);
 886                 }
 887         }
 888 }
 889
 890 size_t
 891 utf8_strlen (string s)
 892 {
 893         size_t const len = s.length ();
 894         int N = 0;
 895         for (size_t i = 0; i < len; ++i) {
 896                 unsigned char c = s[i];
 897                 if ((c & 0xe0) == 0xc0) {
 898                         ++i;
 899                 } else if ((c & 0xf0) == 0xe0) {
 900                         i += 2;
 901                 } else if ((c & 0xf8) == 0xf0) {
 902                         i += 3;
 903                 }
 904                 ++N;
 905         }
 906         return N;
 907 }
 908
 909 string
 910 day_of_week_to_string (boost::gregorian::greg_weekday d)
 911 {
 912         switch (d.as_enum()) {
 913         case boost::date_time::Sunday:
 914                 return _("Sunday");
 915         case boost::date_time::Monday:
 916                 return _("Monday");
 917         case boost::date_time::Tuesday:
 918                 return _("Tuesday");
 919         case boost::date_time::Wednesday:
 920                 return _("Wednesday");
 921         case boost::date_time::Thursday:
 922                 return _("Thursday");
 923         case boost::date_time::Friday:
 924                 return _("Friday");
 925         case boost::date_time::Saturday:
 926                 return _("Saturday");
 927         }
 928
 929         return d.as_long_string ();
 930 }
 931
 932 /** @param size Size of picture that the subtitle will be overlaid onto */
 933 void
 934 emit_subtitle_image (ContentTimePeriod period, dcp::SubtitleImage sub, dcp::Size size, shared_ptr<TextDecoder> decoder)
 935 {
 936         /* XXX: this is rather inefficient; decoding the image just to get its size */
 937         FFmpegImageProxy proxy (sub.png_image());
 938         auto image = proxy.image(Image::Alignment::PADDED).image;
 939         /* set up rect with height and width */
 940         dcpomatic::Rect<double> rect(0, 0, image->size().width / double(size.width), image->size().height / double(size.height));
 941
 942         /* add in position */
 943
 944         switch (sub.h_align()) {
 945         case dcp::HAlign::LEFT:
 946                 rect.x += sub.h_position();
 947                 break;
 948         case dcp::HAlign::CENTER:
 949                 rect.x += 0.5 + sub.h_position() - rect.width / 2;
 950                 break;
 951         case dcp::HAlign::RIGHT:
 952                 rect.x += 1 - sub.h_position() - rect.width;
 953                 break;
 954         }
 955
 956         switch (sub.v_align()) {
 957         case dcp::VAlign::TOP:
 958                 rect.y += sub.v_position();
 959                 break;
 960         case dcp::VAlign::CENTER:
 961                 rect.y += 0.5 + sub.v_position() - rect.height / 2;
 962                 break;
 963         case dcp::VAlign::BOTTOM:
 964                 rect.y += 1 - sub.v_position() - rect.height;
 965                 break;
 966         }
 967
 968         decoder->emit_bitmap (period, image, rect);
 969 }
 970
 971 bool
 972 show_jobs_on_console (bool progress)
 973 {
 974         bool first = true;
 975         bool error = false;
 976         while (true) {
 977
 978                 dcpomatic_sleep_seconds (5);
 979
 980                 auto jobs = JobManager::instance()->get();
 981
 982                 if (!first && progress) {
 983                         for (size_t i = 0; i < jobs.size(); ++i) {
 984                                 cout << "\033[1A\033[2K";
 985                         }
 986                         cout.flush ();
 987                 }
 988
 989                 first = false;
 990
 991                 for (auto i: jobs) {
 992                         if (progress) {
 993                                 cout << i->name();
 994                                 if (!i->sub_name().empty()) {
 995                                         cout << "; " << i->sub_name();
 996                                 }
 997                                 cout << ": ";
 998
 999                                 if (i->progress ()) {
1000                                         cout << i->status() << "                            \n";
1001                                 } else {
1002                                         cout << ": Running           \n";
1003                                 }
1004                         }
1005
1006                         if (!progress && i->finished_in_error()) {
1007                                 /* We won't see this error if we haven't been showing progress,
1008                                    so show it now.
1009                                 */
1010                                 cout << i->status() << "\n";
1011                         }
1012
1013                         if (i->finished_in_error()) {
1014                                 error = true;
1015                         }
1016                 }
1017
1018                 if (!JobManager::instance()->work_to_do()) {
1019                         break;
1020                 }
1021         }
1022
1023         return error;
1024 }
1025
1026 /** XXX: could use mmap? */
1027 void
1028 copy_in_bits (boost::filesystem::path from, boost::filesystem::path to, std::function<void (float)> progress)
1029 {
1030         auto f = fopen_boost (from, "rb");
1031         if (!f) {
1032                 throw OpenFileError (from, errno, OpenFileError::READ);
1033         }
1034         auto t = fopen_boost (to, "wb");
1035         if (!t) {
1036                 fclose (f);
1037                 throw OpenFileError (to, errno, OpenFileError::WRITE);
1038         }
1039
1040         /* on the order of a second's worth of copying */
1041         boost::uintmax_t const chunk = 20 * 1024 * 1024;
1042
1043         auto buffer = static_cast<uint8_t*> (malloc(chunk));
1044         if (!buffer) {
1045                 throw std::bad_alloc ();
1046         }
1047
1048         boost::uintmax_t const total = boost::filesystem::file_size (from);
1049         boost::uintmax_t remaining = total;
1050
1051         while (remaining) {
1052                 boost::uintmax_t this_time = min (chunk, remaining);
1053                 size_t N = fread (buffer, 1, chunk, f);
1054                 if (N < this_time) {
1055                         fclose (f);
1056                         fclose (t);
1057                         free (buffer);
1058                         throw ReadFileError (from, errno);
1059                 }
1060
1061                 N = fwrite (buffer, 1, this_time, t);
1062                 if (N < this_time) {
1063                         fclose (f);
1064                         fclose (t);
1065                         free (buffer);
1066                         throw WriteFileError (to, errno);
1067                 }
1068
1069                 progress (1 - float(remaining) / total);
1070                 remaining -= this_time;
1071         }
1072
1073         fclose (f);
1074         fclose (t);
1075         free (buffer);
1076 }
1077
1078
1079 dcp::Size
1080 scale_for_display (dcp::Size s, dcp::Size display_container, dcp::Size film_container, PixelQuanta quanta)
1081 {
1082         /* Now scale it down if the display container is smaller than the film container */
1083         if (display_container != film_container) {
1084                 float const scale = min (
1085                         float (display_container.width) / film_container.width,
1086                         float (display_container.height) / film_container.height
1087                         );
1088
1089                 s.width = lrintf (s.width * scale);
1090                 s.height = lrintf (s.height * scale);
1091                 s = quanta.round (s);
1092         }
1093
1094         return s;
1095 }
1096
1097
1098 dcp::DecryptedKDM
1099 decrypt_kdm_with_helpful_error (dcp::EncryptedKDM kdm)
1100 {
1101         try {
1102                 return dcp::DecryptedKDM (kdm, Config::instance()->decryption_chain()->key().get());
1103         } catch (dcp::KDMDecryptionError& e) {
1104                 /* Try to flesh out the error a bit */
1105                 auto const kdm_subject_name = kdm.recipient_x509_subject_name();
1106                 bool on_chain = false;
1107                 auto dc = Config::instance()->decryption_chain();
1108                 for (auto i: dc->root_to_leaf()) {
1109                         if (i.subject() == kdm_subject_name) {
1110                                 on_chain = true;
1111                         }
1112                 }
1113                 if (!on_chain) {
1114                         throw KDMError (_("This KDM was not made for DCP-o-matic's decryption certificate."), e.what());
1115                 } else if (kdm_subject_name != dc->leaf().subject()) {
1116                         throw KDMError (_("This KDM was made for DCP-o-matic but not for its leaf certificate."), e.what());
1117                 } else {
1118                         throw;
1119                 }
1120         }
1121 }
1122
1123
1124 boost::filesystem::path
1125 default_font_file ()
1126 {
1127         boost::filesystem::path liberation_normal;
1128         try {
1129                 liberation_normal = resources_path() / "LiberationSans-Regular.ttf";
1130                 if (!boost::filesystem::exists (liberation_normal)) {
1131                         /* Hack for unit tests */
1132                         liberation_normal = resources_path() / "fonts" / "LiberationSans-Regular.ttf";
1133                 }
1134         } catch (boost::filesystem::filesystem_error& e) {
1135
1136         }
1137
1138         if (!boost::filesystem::exists(liberation_normal)) {
1139                 liberation_normal = "/usr/share/fonts/truetype/liberation/LiberationSans-Regular.ttf";
1140         }
1141
1142         return liberation_normal;
1143 }
1144
1145
1146 string
1147 to_upper (string s)
1148 {
1149         transform (s.begin(), s.end(), s.begin(), ::toupper);
1150         return s;
1151 }
1152
1153
1154 /* Set to 1 to print the IDs of some of our threads to stdout on creation */
1155 #define DCPOMATIC_DEBUG_THREADS 0
1156
1157 #if DCPOMATIC_DEBUG_THREADS
1158 void
1159 start_of_thread (string name)
1160 {
1161         std::cout << "THREAD:" << name << ":" << std::hex << pthread_self() << "\n";
1162 }
1163 #else
1164 void
1165 start_of_thread (string)
1166 {
1167
1168 }
1169 #endif
1170