src/lib/util.cc

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