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