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