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