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 /** Round a number up to the nearest multiple of another number.
 555  *  @param c Index.
 556  *  @param stride Array of numbers to round, indexed by c.
 557  *  @param t Multiple to round to.
 558  *  @return Rounded number.
 559  */
 560 int
 561 stride_round_up (int c, int const * stride, int t)
 562 {
 563         int const a = stride[c] + (t - 1);
 564         return a - (a % t);
 565 }
 566
 567
 568 /** Trip an assert if the caller is not in the UI thread */
 569 void
 570 ensure_ui_thread ()
 571 {
 572         DCPOMATIC_ASSERT (boost::this_thread::get_id() == ui_thread);
 573 }
 574
 575
 576 string
 577 audio_channel_name (int c)
 578 {
 579         DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
 580
 581         /// TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
 582         /// enhancement channel (sub-woofer).
 583         string const channels[] = {
 584                 _("Left"),
 585                 _("Right"),
 586                 _("Centre"),
 587                 _("Lfe (sub)"),
 588                 _("Left surround"),
 589                 _("Right surround"),
 590                 _("Hearing impaired"),
 591                 _("Visually impaired"),
 592                 _("Left centre"),
 593                 _("Right centre"),
 594                 _("Left rear surround"),
 595                 _("Right rear surround"),
 596                 _("D-BOX primary"),
 597                 _("D-BOX secondary"),
 598                 _("Unused"),
 599                 _("Unused")
 600         };
 601
 602         return channels[c];
 603 }
 604
 605
 606 string
 607 short_audio_channel_name (int c)
 608 {
 609         DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
 610
 611         /// TRANSLATORS: these are short names of audio channels; Lfe is the low-frequency
 612         /// enhancement channel (sub-woofer).  HI is the hearing-impaired audio track and
 613         /// VI is the visually-impaired audio track (audio describe).  DBP is the D-BOX
 614         /// primary channel and DBS is the D-BOX secondary channel.
 615         string const channels[] = {
 616                 _("L"),
 617                 _("R"),
 618                 _("C"),
 619                 _("Lfe"),
 620                 _("Ls"),
 621                 _("Rs"),
 622                 _("HI"),
 623                 _("VI"),
 624                 _("Lc"),
 625                 _("Rc"),
 626                 _("BsL"),
 627                 _("BsR"),
 628                 _("DBP"),
 629                 _("DBS"),
 630                 _("Sign"),
 631                 ""
 632         };
 633
 634         return channels[c];
 635 }
 636
 637
 638 bool
 639 valid_image_file (boost::filesystem::path f)
 640 {
 641         if (boost::starts_with (f.leaf().string(), "._")) {
 642                 return false;
 643         }
 644
 645         auto ext = f.extension().string();
 646         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 647         return (
 648                 ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" ||
 649                 ext == ".png" || ext == ".bmp" || ext == ".tga" || ext == ".dpx" ||
 650                 ext == ".j2c" || ext == ".j2k" || ext == ".jp2" || ext == ".exr" ||
 651                 ext == ".jpf" || ext == ".psd"
 652                 );
 653 }
 654
 655
 656 bool
 657 valid_sound_file (boost::filesystem::path f)
 658 {
 659         if (boost::starts_with (f.leaf().string(), "._")) {
 660                 return false;
 661         }
 662
 663         auto ext = f.extension().string();
 664         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 665         return (ext == ".wav" || ext == ".mp3" || ext == ".aif" || ext == ".aiff");
 666 }
 667
 668
 669 bool
 670 valid_j2k_file (boost::filesystem::path f)
 671 {
 672         auto ext = f.extension().string();
 673         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 674         return (ext == ".j2k" || ext == ".j2c" || ext == ".jp2");
 675 }
 676
 677
 678 string
 679 tidy_for_filename (string f)
 680 {
 681         boost::replace_if (f, boost::is_any_of ("\\/:"), '_');
 682         return f;
 683 }
 684
 685
 686 dcp::Size
 687 fit_ratio_within (float ratio, dcp::Size full_frame)
 688 {
 689         if (ratio < full_frame.ratio ()) {
 690                 return dcp::Size (lrintf (full_frame.height * ratio), full_frame.height);
 691         }
 692
 693         return dcp::Size (full_frame.width, lrintf (full_frame.width / ratio));
 694 }
 695
 696
 697 void *
 698 wrapped_av_malloc (size_t s)
 699 {
 700         auto p = av_malloc (s);
 701         if (!p) {
 702                 throw bad_alloc ();
 703         }
 704         return p;
 705 }
 706
 707
 708 map<string, string>
 709 split_get_request (string url)
 710 {
 711         enum {
 712                 AWAITING_QUESTION_MARK,
 713                 KEY,
 714                 VALUE
 715         } state = AWAITING_QUESTION_MARK;
 716
 717         map<string, string> r;
 718         string k;
 719         string v;
 720         for (size_t i = 0; i < url.length(); ++i) {
 721                 switch (state) {
 722                 case AWAITING_QUESTION_MARK:
 723                         if (url[i] == '?') {
 724                                 state = KEY;
 725                         }
 726                         break;
 727                 case KEY:
 728                         if (url[i] == '=') {
 729                                 v.clear ();
 730                                 state = VALUE;
 731                         } else {
 732                                 k += url[i];
 733                         }
 734                         break;
 735                 case VALUE:
 736                         if (url[i] == '&') {
 737                                 r.insert (make_pair (k, v));
 738                                 k.clear ();
 739                                 state = KEY;
 740                         } else {
 741                                 v += url[i];
 742                         }
 743                         break;
 744                 }
 745         }
 746
 747         if (state == VALUE) {
 748                 r.insert (make_pair (k, v));
 749         }
 750
 751         return r;
 752 }
 753
 754
 755 string
 756 video_asset_filename (shared_ptr<dcp::PictureAsset> asset, int reel_index, int reel_count, optional<string> summary)
 757 {
 758         dcp::NameFormat::Map values;
 759         values['t'] = "j2c";
 760         values['r'] = raw_convert<string> (reel_index + 1);
 761         values['n'] = raw_convert<string> (reel_count);
 762         if (summary) {
 763                 values['c'] = careful_string_filter (summary.get());
 764         }
 765         return Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + ".mxf");
 766 }
 767
 768
 769 string
 770 audio_asset_filename (shared_ptr<dcp::SoundAsset> asset, int reel_index, int reel_count, optional<string> summary)
 771 {
 772         dcp::NameFormat::Map values;
 773         values['t'] = "pcm";
 774         values['r'] = raw_convert<string> (reel_index + 1);
 775         values['n'] = raw_convert<string> (reel_count);
 776         if (summary) {
 777                 values['c'] = careful_string_filter (summary.get());
 778         }
 779         return Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + ".mxf");
 780 }
 781
 782
 783 string
 784 atmos_asset_filename (shared_ptr<dcp::AtmosAsset> asset, int reel_index, int reel_count, optional<string> summary)
 785 {
 786         dcp::NameFormat::Map values;
 787         values['t'] = "atmos";
 788         values['r'] = raw_convert<string> (reel_index + 1);
 789         values['n'] = raw_convert<string> (reel_count);
 790         if (summary) {
 791                 values['c'] = careful_string_filter (summary.get());
 792         }
 793         return Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + ".mxf");
 794 }
 795
 796
 797 float
 798 relaxed_string_to_float (string s)
 799 {
 800         try {
 801                 boost::algorithm::replace_all (s, ",", ".");
 802                 return lexical_cast<float> (s);
 803         } catch (bad_lexical_cast &) {
 804                 boost::algorithm::replace_all (s, ".", ",");
 805                 return lexical_cast<float> (s);
 806         }
 807 }
 808
 809 string
 810 careful_string_filter (string s)
 811 {
 812         /* Filter out `bad' characters which `may' cause problems with some systems (either for DCP name or filename).
 813            There's no apparent list of what really is allowed, so this is a guess.
 814            Safety first and all that.
 815         */
 816
 817         /* First transliterate using libicu to try to remove accents in a "nice" way */
 818         auto icu_utf16 = icu::UnicodeString::fromUTF8(icu::StringPiece(s));
 819         auto status = U_ZERO_ERROR;
 820         auto transliterator = icu::Transliterator::createInstance("NFD; [:M:] Remove; NFC", UTRANS_FORWARD, status);
 821         transliterator->transliterate(icu_utf16);
 822         s.clear ();
 823         icu_utf16.toUTF8String(s);
 824
 825         /* Then remove anything that's not in a very limited character set */
 826         wstring ws = boost::locale::conv::utf_to_utf<wchar_t>(s);
 827         string out;
 828         string const allowed = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_%.+";
 829         for (size_t i = 0; i < ws.size(); ++i) {
 830                 wchar_t c = ws[i];
 831                 if (allowed.find(c) != string::npos) {
 832                         out += c;
 833                 }
 834         }
 835
 836         return boost::locale::conv::utf_to_utf<char>(out);
 837 }
 838
 839
 840 /** @param mapped List of mapped audio channels from a Film.
 841  *  @param channels Total number of channels in the Film.
 842  *  @return First: number of non-LFE soundtrack channels (L/R/C/Ls/Rs/Lc/Rc/Bsl/Bsr), second: number of LFE channels.
 843  */
 844 pair<int, int>
 845 audio_channel_types (list<int> mapped, int channels)
 846 {
 847         int non_lfe = 0;
 848         int lfe = 0;
 849
 850         for (auto i: mapped) {
 851                 if (i >= channels) {
 852                         /* This channel is mapped but is not included in the DCP */
 853                         continue;
 854                 }
 855
 856                 switch (static_cast<dcp::Channel>(i)) {
 857                 case dcp::Channel::LFE:
 858                         ++lfe;
 859                         break;
 860                 case dcp::Channel::LEFT:
 861                 case dcp::Channel::RIGHT:
 862                 case dcp::Channel::CENTRE:
 863                 case dcp::Channel::LS:
 864                 case dcp::Channel::RS:
 865                 case dcp::Channel::BSL:
 866                 case dcp::Channel::BSR:
 867                         ++non_lfe;
 868                         break;
 869                 case dcp::Channel::HI:
 870                 case dcp::Channel::VI:
 871                 case dcp::Channel::MOTION_DATA:
 872                 case dcp::Channel::SYNC_SIGNAL:
 873                 case dcp::Channel::SIGN_LANGUAGE:
 874                 case dcp::Channel::CHANNEL_COUNT:
 875                         break;
 876                 }
 877         }
 878
 879         return make_pair (non_lfe, lfe);
 880 }
 881
 882
 883 shared_ptr<AudioBuffers>
 884 remap (shared_ptr<const AudioBuffers> input, int output_channels, AudioMapping map)
 885 {
 886         auto mapped = make_shared<AudioBuffers>(output_channels, input->frames());
 887         mapped->make_silent ();
 888
 889         int to_do = min (map.input_channels(), input->channels());
 890
 891         for (int i = 0; i < to_do; ++i) {
 892                 for (int j = 0; j < mapped->channels(); ++j) {
 893                         if (map.get(i, j) > 0) {
 894                                 mapped->accumulate_channel(
 895                                         input.get(),
 896                                         i,
 897                                         j,
 898                                         map.get(i, j)
 899                                         );
 900                         }
 901                 }
 902         }
 903
 904         return mapped;
 905 }
 906
 907
 908 Eyes
 909 increment_eyes (Eyes e)
 910 {
 911         if (e == Eyes::LEFT) {
 912                 return Eyes::RIGHT;
 913         }
 914
 915         return Eyes::LEFT;
 916 }
 917
 918
 919 void
 920 checked_fwrite (void const * ptr, size_t size, FILE* stream, boost::filesystem::path path)
 921 {
 922         size_t N = fwrite (ptr, 1, size, stream);
 923         if (N != size) {
 924                 if (ferror(stream)) {
 925                         fclose (stream);
 926                         throw FileError (String::compose("fwrite error %1", errno), path);
 927                 } else {
 928                         fclose (stream);
 929                         throw FileError ("Unexpected short write", path);
 930                 }
 931         }
 932 }
 933
 934
 935 void
 936 checked_fread (void* ptr, size_t size, FILE* stream, boost::filesystem::path path)
 937 {
 938         size_t N = fread (ptr, 1, size, stream);
 939         if (N != size) {
 940                 if (ferror(stream)) {
 941                         fclose (stream);
 942                         throw FileError (String::compose("fread error %1", errno), path);
 943                 } else {
 944                         fclose (stream);
 945                         throw FileError ("Unexpected short read", path);
 946                 }
 947         }
 948 }
 949
 950
 951 size_t
 952 utf8_strlen (string s)
 953 {
 954         size_t const len = s.length ();
 955         int N = 0;
 956         for (size_t i = 0; i < len; ++i) {
 957                 unsigned char c = s[i];
 958                 if ((c & 0xe0) == 0xc0) {
 959                         ++i;
 960                 } else if ((c & 0xf0) == 0xe0) {
 961                         i += 2;
 962                 } else if ((c & 0xf8) == 0xf0) {
 963                         i += 3;
 964                 }
 965                 ++N;
 966         }
 967         return N;
 968 }
 969
 970
 971 string
 972 day_of_week_to_string (boost::gregorian::greg_weekday d)
 973 {
 974         switch (d.as_enum()) {
 975         case boost::date_time::Sunday:
 976                 return _("Sunday");
 977         case boost::date_time::Monday:
 978                 return _("Monday");
 979         case boost::date_time::Tuesday:
 980                 return _("Tuesday");
 981         case boost::date_time::Wednesday:
 982                 return _("Wednesday");
 983         case boost::date_time::Thursday:
 984                 return _("Thursday");
 985         case boost::date_time::Friday:
 986                 return _("Friday");
 987         case boost::date_time::Saturday:
 988                 return _("Saturday");
 989         }
 990
 991         return d.as_long_string ();
 992 }
 993
 994
 995 /** @param size Size of picture that the subtitle will be overlaid onto */
 996 void
 997 emit_subtitle_image (ContentTimePeriod period, dcp::SubtitleImage sub, dcp::Size size, shared_ptr<TextDecoder> decoder)
 998 {
 999         /* XXX: this is rather inefficient; decoding the image just to get its size */
1000         FFmpegImageProxy proxy (sub.png_image());
1001         auto image = proxy.image(Image::Alignment::PADDED).image;
1002         /* set up rect with height and width */
1003         dcpomatic::Rect<double> rect(0, 0, image->size().width / double(size.width), image->size().height / double(size.height));
1004
1005         /* add in position */
1006
1007         switch (sub.h_align()) {
1008         case dcp::HAlign::LEFT:
1009                 rect.x += sub.h_position();
1010                 break;
1011         case dcp::HAlign::CENTER:
1012                 rect.x += 0.5 + sub.h_position() - rect.width / 2;
1013                 break;
1014         case dcp::HAlign::RIGHT:
1015                 rect.x += 1 - sub.h_position() - rect.width;
1016                 break;
1017         }
1018
1019         switch (sub.v_align()) {
1020         case dcp::VAlign::TOP:
1021                 rect.y += sub.v_position();
1022                 break;
1023         case dcp::VAlign::CENTER:
1024                 rect.y += 0.5 + sub.v_position() - rect.height / 2;
1025                 break;
1026         case dcp::VAlign::BOTTOM:
1027                 rect.y += 1 - sub.v_position() - rect.height;
1028                 break;
1029         }
1030
1031         decoder->emit_bitmap (period, image, rect);
1032 }
1033
1034
1035 bool
1036 show_jobs_on_console (bool progress)
1037 {
1038         bool first = true;
1039         bool error = false;
1040         while (true) {
1041
1042                 dcpomatic_sleep_seconds (5);
1043
1044                 auto jobs = JobManager::instance()->get();
1045
1046                 if (!first && progress) {
1047                         for (size_t i = 0; i < jobs.size(); ++i) {
1048                                 cout << "\033[1A\033[2K";
1049                         }
1050                         cout.flush ();
1051                 }
1052
1053                 first = false;
1054
1055                 for (auto i: jobs) {
1056                         if (progress) {
1057                                 cout << i->name();
1058                                 if (!i->sub_name().empty()) {
1059                                         cout << "; " << i->sub_name();
1060                                 }
1061                                 cout << ": ";
1062
1063                                 if (i->progress ()) {
1064                                         cout << i->status() << "                            \n";
1065                                 } else {
1066                                         cout << ": Running           \n";
1067                                 }
1068                         }
1069
1070                         if (!progress && i->finished_in_error()) {
1071                                 /* We won't see this error if we haven't been showing progress,
1072                                    so show it now.
1073                                 */
1074                                 cout << i->status() << "\n";
1075                         }
1076
1077                         if (i->finished_in_error()) {
1078                                 error = true;
1079                         }
1080                 }
1081
1082                 if (!JobManager::instance()->work_to_do()) {
1083                         break;
1084                 }
1085         }
1086
1087         return error;
1088 }
1089
1090
1091 /** XXX: could use mmap? */
1092 void
1093 copy_in_bits (boost::filesystem::path from, boost::filesystem::path to, std::function<void (float)> progress)
1094 {
1095         auto f = fopen_boost (from, "rb");
1096         if (!f) {
1097                 throw OpenFileError (from, errno, OpenFileError::READ);
1098         }
1099         auto t = fopen_boost (to, "wb");
1100         if (!t) {
1101                 fclose (f);
1102                 throw OpenFileError (to, errno, OpenFileError::WRITE);
1103         }
1104
1105         /* on the order of a second's worth of copying */
1106         boost::uintmax_t const chunk = 20 * 1024 * 1024;
1107
1108         auto buffer = static_cast<uint8_t*> (malloc(chunk));
1109         if (!buffer) {
1110                 throw std::bad_alloc ();
1111         }
1112
1113         boost::uintmax_t const total = boost::filesystem::file_size (from);
1114         boost::uintmax_t remaining = total;
1115
1116         while (remaining) {
1117                 boost::uintmax_t this_time = min (chunk, remaining);
1118                 size_t N = fread (buffer, 1, chunk, f);
1119                 if (N < this_time) {
1120                         fclose (f);
1121                         fclose (t);
1122                         free (buffer);
1123                         throw ReadFileError (from, errno);
1124                 }
1125
1126                 N = fwrite (buffer, 1, this_time, t);
1127                 if (N < this_time) {
1128                         fclose (f);
1129                         fclose (t);
1130                         free (buffer);
1131                         throw WriteFileError (to, errno);
1132                 }
1133
1134                 progress (1 - float(remaining) / total);
1135                 remaining -= this_time;
1136         }
1137
1138         fclose (f);
1139         fclose (t);
1140         free (buffer);
1141 }
1142
1143
1144 dcp::Size
1145 scale_for_display (dcp::Size s, dcp::Size display_container, dcp::Size film_container, PixelQuanta quanta)
1146 {
1147         /* Now scale it down if the display container is smaller than the film container */
1148         if (display_container != film_container) {
1149                 float const scale = min (
1150                         float (display_container.width) / film_container.width,
1151                         float (display_container.height) / film_container.height
1152                         );
1153
1154                 s.width = lrintf (s.width * scale);
1155                 s.height = lrintf (s.height * scale);
1156                 s = quanta.round (s);
1157         }
1158
1159         return s;
1160 }
1161
1162
1163 dcp::DecryptedKDM
1164 decrypt_kdm_with_helpful_error (dcp::EncryptedKDM kdm)
1165 {
1166         try {
1167                 return dcp::DecryptedKDM (kdm, Config::instance()->decryption_chain()->key().get());
1168         } catch (dcp::KDMDecryptionError& e) {
1169                 /* Try to flesh out the error a bit */
1170                 auto const kdm_subject_name = kdm.recipient_x509_subject_name();
1171                 bool on_chain = false;
1172                 auto dc = Config::instance()->decryption_chain();
1173                 for (auto i: dc->root_to_leaf()) {
1174                         if (i.subject() == kdm_subject_name) {
1175                                 on_chain = true;
1176                         }
1177                 }
1178                 if (!on_chain) {
1179                         throw KDMError (_("This KDM was not made for DCP-o-matic's decryption certificate."), e.what());
1180                 } else if (kdm_subject_name != dc->leaf().subject()) {
1181                         throw KDMError (_("This KDM was made for DCP-o-matic but not for its leaf certificate."), e.what());
1182                 } else {
1183                         throw;
1184                 }
1185         }
1186 }
1187
1188
1189 boost::filesystem::path
1190 default_font_file ()
1191 {
1192         boost::filesystem::path liberation_normal;
1193         try {
1194                 liberation_normal = resources_path() / "LiberationSans-Regular.ttf";
1195                 if (!boost::filesystem::exists (liberation_normal)) {
1196                         /* Hack for unit tests */
1197                         liberation_normal = resources_path() / "fonts" / "LiberationSans-Regular.ttf";
1198                 }
1199         } catch (boost::filesystem::filesystem_error& e) {
1200
1201         }
1202
1203         if (!boost::filesystem::exists(liberation_normal)) {
1204                 liberation_normal = "/usr/share/fonts/truetype/liberation/LiberationSans-Regular.ttf";
1205         }
1206
1207         return liberation_normal;
1208 }
1209
1210
1211 string
1212 to_upper (string s)
1213 {
1214         transform (s.begin(), s.end(), s.begin(), ::toupper);
1215         return s;
1216 }
1217
1218
1219 /* Set to 1 to print the IDs of some of our threads to stdout on creation */
1220 #define DCPOMATIC_DEBUG_THREADS 0
1221
1222 #if DCPOMATIC_DEBUG_THREADS
1223 void
1224 start_of_thread (string name)
1225 {
1226         std::cout << "THREAD:" << name << ":" << std::hex << pthread_self() << "\n";
1227 }
1228 #else
1229 void
1230 start_of_thread (string)
1231 {
1232
1233 }
1234 #endif
1235