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