src/lib/util.cc

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