src/lib/util.cc

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