src/lib/util.cc

   1 /*
   2     Copyright (C) 2012-2016 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 <dcp/locale_convert.h>
  45 #include <dcp/util.h>
  46 #include <dcp/raw_convert.h>
  47 #include <dcp/picture_asset.h>
  48 #include <dcp/sound_asset.h>
  49 #include <dcp/subtitle_asset.h>
  50 extern "C" {
  51 #include <libavfilter/avfilter.h>
  52 #include <libavformat/avformat.h>
  53 #include <libavcodec/avcodec.h>
  54 }
  55 #include <curl/curl.h>
  56 #include <glib.h>
  57 #include <pangomm/init.h>
  58 #include <boost/algorithm/string.hpp>
  59 #include <boost/range/algorithm/replace_if.hpp>
  60 #include <boost/thread.hpp>
  61 #include <boost/filesystem.hpp>
  62 #ifdef DCPOMATIC_WINDOWS
  63 #include <boost/locale.hpp>
  64 #include <dbghelp.h>
  65 #endif
  66 #include <signal.h>
  67 #include <iomanip>
  68 #include <iostream>
  69 #include <fstream>
  70 #include <climits>
  71 #include <stdexcept>
  72 #ifdef DCPOMATIC_POSIX
  73 #include <execinfo.h>
  74 #include <cxxabi.h>
  75 #endif
  76
  77 #include "i18n.h"
  78
  79 using std::string;
  80 using std::setfill;
  81 using std::ostream;
  82 using std::endl;
  83 using std::vector;
  84 using std::min;
  85 using std::max;
  86 using std::map;
  87 using std::list;
  88 using std::multimap;
  89 using std::istream;
  90 using std::pair;
  91 using std::cout;
  92 using std::bad_alloc;
  93 using std::set_terminate;
  94 using std::make_pair;
  95 using boost::shared_ptr;
  96 using boost::thread;
  97 using boost::optional;
  98 using boost::lexical_cast;
  99 using boost::bad_lexical_cast;
 100 using boost::scoped_array;
 101 using dcp::Size;
 102 using dcp::raw_convert;
 103 using dcp::locale_convert;
 104
 105 /** Path to our executable, required by the stacktrace stuff and filled
 106  *  in during App::onInit().
 107  */
 108 string program_name;
 109 bool is_batch_converter = false;
 110 static boost::thread::id ui_thread;
 111 static boost::filesystem::path backtrace_file;
 112
 113 /** Convert some number of seconds to a string representation
 114  *  in hours, minutes and seconds.
 115  *
 116  *  @param s Seconds.
 117  *  @return String of the form H:M:S (where H is hours, M
 118  *  is minutes and S is seconds).
 119  */
 120 string
 121 seconds_to_hms (int s)
 122 {
 123         int m = s / 60;
 124         s -= (m * 60);
 125         int h = m / 60;
 126         m -= (h * 60);
 127
 128         char buffer[64];
 129         snprintf (buffer, sizeof(buffer), "%d:%02d:%02d", h, m, s);
 130         return buffer;
 131 }
 132
 133 string
 134 time_to_hmsf (DCPTime time, Frame rate)
 135 {
 136         Frame f = time.frames_round (rate);
 137         int s = f / rate;
 138         f -= (s * rate);
 139         int m = s / 60;
 140         s -= m * 60;
 141         int h = m / 60;
 142         m -= h * 60;
 143
 144         char buffer[64];
 145         snprintf (buffer, sizeof(buffer), "%d:%02d:%02d.%d", h, m, s, static_cast<int>(f));
 146         return buffer;
 147 }
 148
 149 /** @param s Number of seconds.
 150  *  @return String containing an approximate description of s (e.g. "about 2 hours")
 151  */
 152 string
 153 seconds_to_approximate_hms (int s)
 154 {
 155         int m = s / 60;
 156         s -= (m * 60);
 157         int h = m / 60;
 158         m -= (h * 60);
 159
 160         string ap;
 161
 162         bool hours = h > 0;
 163         bool minutes = h < 6 && m > 0;
 164         bool seconds = h == 0 && m < 10 && s > 0;
 165
 166         if (m > 30 && !minutes) {
 167                 /* round up the hours */
 168                 ++h;
 169         }
 170         if (s > 30 && !seconds) {
 171                 /* round up the minutes */
 172                 ++m;
 173                 if (m == 60) {
 174                         m = 0;
 175                         minutes = false;
 176                         ++h;
 177                 }
 178         }
 179
 180         if (hours) {
 181                 /// TRANSLATORS: h here is an abbreviation for hours
 182                 ap += locale_convert<string>(h) + _("h");
 183
 184                 if (minutes || seconds) {
 185                         ap += N_(" ");
 186                 }
 187         }
 188
 189         if (minutes) {
 190                 /// TRANSLATORS: m here is an abbreviation for minutes
 191                 ap += locale_convert<string>(m) + _("m");
 192
 193                 if (seconds) {
 194                         ap += N_(" ");
 195                 }
 196         }
 197
 198         if (seconds) {
 199                 /* Seconds */
 200                 /// TRANSLATORS: s here is an abbreviation for seconds
 201                 ap += locale_convert<string>(s) + _("s");
 202         }
 203
 204         return ap;
 205 }
 206
 207 double
 208 seconds (struct timeval t)
 209 {
 210         return t.tv_sec + (double (t.tv_usec) / 1e6);
 211 }
 212
 213 #ifdef DCPOMATIC_WINDOWS
 214
 215 /** Resolve symbol name and source location given the path to the executable */
 216 int
 217 addr2line (void const * const addr)
 218 {
 219         char addr2line_cmd[512] = { 0 };
 220         sprintf (addr2line_cmd, "addr2line -f -p -e %.256s %p > %s", program_name.c_str(), addr, backtrace_file.string().c_str());
 221         return system(addr2line_cmd);
 222 }
 223
 224 /** This is called when C signals occur on Windows (e.g. SIGSEGV)
 225  *  (NOT C++ exceptions!).  We write a backtrace to backtrace_file by dark means.
 226  *  Adapted from code here: http://spin.atomicobject.com/2013/01/13/exceptions-stack-traces-c/
 227  */
 228 LONG WINAPI
 229 exception_handler(struct _EXCEPTION_POINTERS * info)
 230 {
 231         FILE* f = fopen_boost (backtrace_file, "w");
 232         fprintf (f, "C-style exception %d\n", info->ExceptionRecord->ExceptionCode);
 233         fclose(f);
 234
 235         if (info->ExceptionRecord->ExceptionCode != EXCEPTION_STACK_OVERFLOW) {
 236                 CONTEXT* context = info->ContextRecord;
 237                 SymInitialize (GetCurrentProcess (), 0, true);
 238
 239                 STACKFRAME frame = { 0 };
 240
 241                 /* setup initial stack frame */
 242 #if _WIN64
 243                 frame.AddrPC.Offset    = context->Rip;
 244                 frame.AddrStack.Offset = context->Rsp;
 245                 frame.AddrFrame.Offset = context->Rbp;
 246 #else
 247                 frame.AddrPC.Offset    = context->Eip;
 248                 frame.AddrStack.Offset = context->Esp;
 249                 frame.AddrFrame.Offset = context->Ebp;
 250 #endif
 251                 frame.AddrPC.Mode      = AddrModeFlat;
 252                 frame.AddrStack.Mode   = AddrModeFlat;
 253                 frame.AddrFrame.Mode   = AddrModeFlat;
 254
 255                 while (
 256                         StackWalk (
 257                                 IMAGE_FILE_MACHINE_I386,
 258                                 GetCurrentProcess (),
 259                                 GetCurrentThread (),
 260                                 &frame,
 261                                 context,
 262                                 0,
 263                                 SymFunctionTableAccess,
 264                                 SymGetModuleBase,
 265                                 0
 266                                 )
 267                         ) {
 268                         addr2line((void *) frame.AddrPC.Offset);
 269                 }
 270         } else {
 271 #ifdef _WIN64
 272                 addr2line ((void *) info->ContextRecord->Rip);
 273 #else
 274                 addr2line ((void *) info->ContextRecord->Eip);
 275 #endif
 276         }
 277
 278         return EXCEPTION_CONTINUE_SEARCH;
 279 }
 280 #endif
 281
 282 void
 283 set_backtrace_file (boost::filesystem::path p)
 284 {
 285         backtrace_file = p;
 286 }
 287
 288 /** This is called when there is an unhandled exception.  Any
 289  *  backtrace in this function is useless on Windows as the stack has
 290  *  already been unwound from the throw; we have the gdb wrap hack to
 291  *  cope with that.
 292  */
 293 void
 294 terminate ()
 295 {
 296         try {
 297                 static bool tried_throw = false;
 298                 // try once to re-throw currently active exception
 299                 if (!tried_throw) {
 300                         tried_throw = true;
 301                         throw;
 302                 }
 303         }
 304         catch (const std::exception &e) {
 305                 std::cerr << __FUNCTION__ << " caught unhandled exception. what(): "
 306                           << e.what() << std::endl;
 307         }
 308         catch (...) {
 309                 std::cerr << __FUNCTION__ << " caught unknown/unhandled exception."
 310                           << std::endl;
 311         }
 312
 313         abort();
 314 }
 315
 316 void
 317 dcpomatic_setup_path_encoding ()
 318 {
 319 #ifdef DCPOMATIC_WINDOWS
 320         /* Dark voodoo which, I think, gets boost::filesystem::path to
 321            correctly convert UTF-8 strings to paths, and also paths
 322            back to UTF-8 strings (on path::string()).
 323
 324            After this, constructing boost::filesystem::paths from strings
 325            converts from UTF-8 to UTF-16 inside the path.  Then
 326            path::string().c_str() gives UTF-8 and
 327            path::c_str()          gives UTF-16.
 328
 329            This is all Windows-only.  AFAICT Linux/OS X use UTF-8 everywhere,
 330            so things are much simpler.
 331         */
 332         std::locale::global (boost::locale::generator().generate (""));
 333         boost::filesystem::path::imbue (std::locale ());
 334 #endif
 335 }
 336
 337 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
 338  *  Must be called from the UI thread, if there is one.
 339  */
 340 void
 341 dcpomatic_setup ()
 342 {
 343 #ifdef DCPOMATIC_WINDOWS
 344         boost::filesystem::path p = g_get_user_config_dir ();
 345         p /= "backtrace.txt";
 346         set_backtrace_file (p);
 347         SetUnhandledExceptionFilter(exception_handler);
 348 #endif
 349
 350         av_register_all ();
 351         avfilter_register_all ();
 352
 353 #ifdef DCPOMATIC_OSX
 354         /* Add our library directory to the libltdl search path so that
 355            xmlsec can find xmlsec1-openssl.
 356         */
 357         boost::filesystem::path lib = app_contents ();
 358         lib /= "Frameworks";
 359         setenv ("LTDL_LIBRARY_PATH", lib.c_str (), 1);
 360 #endif
 361
 362         set_terminate (terminate);
 363
 364 #ifdef DCPOMATIC_WINDOWS
 365         putenv ("PANGOCAIRO_BACKEND=fontconfig");
 366         putenv (String::compose("FONTCONFIG_PATH=%1", shared_path().string()).c_str());
 367 #endif
 368
 369 #ifdef DCPOMATIC_OSX
 370         setenv ("PANGOCAIRO_BACKEND", "fontconfig", 1);
 371         setenv ("FONTCONFIG_PATH", shared_path().string().c_str(), 1);
 372 #endif
 373
 374         Pango::init ();
 375         dcp::init ();
 376
 377 #ifdef DCPOMATIC_WINDOWS
 378         /* Render something to fontconfig to create its cache */
 379         list<StringText> subs;
 380         dcp::SubtitleString ss(
 381                 optional<string>(), false, false, false, dcp::Colour(), 42, 1, dcp::Time(), dcp::Time(), 0, dcp::HALIGN_CENTER, 0, dcp::VALIGN_CENTER, dcp::DIRECTION_LTR,
 382                 "Hello dolly", dcp::NONE, dcp::Colour(), dcp::Time(), dcp::Time()
 383                 );
 384         subs.push_back (StringText(ss, 0));
 385         render_text (subs, list<shared_ptr<Font> >(), dcp::Size(640, 480), DCPTime(), 24);
 386 #endif
 387
 388         Ratio::setup_ratios ();
 389         PresetColourConversion::setup_colour_conversion_presets ();
 390         VideoContentScale::setup_scales ();
 391         DCPContentType::setup_dcp_content_types ();
 392         Filter::setup_filters ();
 393         CinemaSoundProcessor::setup_cinema_sound_processors ();
 394         AudioProcessor::setup_audio_processors ();
 395
 396         curl_global_init (CURL_GLOBAL_ALL);
 397
 398         ui_thread = boost::this_thread::get_id ();
 399 }
 400
 401 #ifdef DCPOMATIC_WINDOWS
 402 boost::filesystem::path
 403 mo_path ()
 404 {
 405         wchar_t buffer[512];
 406         GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
 407         boost::filesystem::path p (buffer);
 408         p = p.parent_path ();
 409         p = p.parent_path ();
 410         p /= "locale";
 411         return p;
 412 }
 413 #endif
 414
 415 #ifdef DCPOMATIC_OSX
 416 boost::filesystem::path
 417 mo_path ()
 418 {
 419         return "DCP-o-matic 2.app/Contents/Resources";
 420 }
 421 #endif
 422
 423 void
 424 dcpomatic_setup_gettext_i18n (string lang)
 425 {
 426 #ifdef DCPOMATIC_LINUX
 427         lang += ".UTF8";
 428 #endif
 429
 430         if (!lang.empty ()) {
 431                 /* Override our environment language.  Note that the caller must not
 432                    free the string passed into putenv().
 433                 */
 434                 string s = String::compose ("LANGUAGE=%1", lang);
 435                 putenv (strdup (s.c_str ()));
 436                 s = String::compose ("LANG=%1", lang);
 437                 putenv (strdup (s.c_str ()));
 438                 s = String::compose ("LC_ALL=%1", lang);
 439                 putenv (strdup (s.c_str ()));
 440         }
 441
 442         setlocale (LC_ALL, "");
 443         textdomain ("libdcpomatic2");
 444
 445 #if defined(DCPOMATIC_WINDOWS) || defined(DCPOMATIC_OSX)
 446         bindtextdomain ("libdcpomatic2", mo_path().string().c_str());
 447         bind_textdomain_codeset ("libdcpomatic2", "UTF8");
 448 #endif
 449
 450 #ifdef DCPOMATIC_LINUX
 451         bindtextdomain ("libdcpomatic2", LINUX_LOCALE_PREFIX);
 452 #endif
 453 }
 454
 455 /** Compute a digest of the first and last `size' bytes of a set of files. */
 456 string
 457 digest_head_tail (vector<boost::filesystem::path> files, boost::uintmax_t size)
 458 {
 459         boost::scoped_array<char> buffer (new char[size]);
 460         Digester digester;
 461
 462         /* Head */
 463         boost::uintmax_t to_do = size;
 464         char* p = buffer.get ();
 465         int i = 0;
 466         while (i < int64_t (files.size()) && to_do > 0) {
 467                 FILE* f = fopen_boost (files[i], "rb");
 468                 if (!f) {
 469                         throw OpenFileError (files[i].string(), errno, true);
 470                 }
 471
 472                 boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i]));
 473                 checked_fread (p, this_time, f, files[i]);
 474                 p += this_time;
 475                 to_do -= this_time;
 476                 fclose (f);
 477
 478                 ++i;
 479         }
 480         digester.add (buffer.get(), size - to_do);
 481
 482         /* Tail */
 483         to_do = size;
 484         p = buffer.get ();
 485         i = files.size() - 1;
 486         while (i >= 0 && to_do > 0) {
 487                 FILE* f = fopen_boost (files[i], "rb");
 488                 if (!f) {
 489                         throw OpenFileError (files[i].string(), errno, true);
 490                 }
 491
 492                 boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i]));
 493                 dcpomatic_fseek (f, -this_time, SEEK_END);
 494                 checked_fread (p, this_time, f, files[i]);
 495                 p += this_time;
 496                 to_do -= this_time;
 497                 fclose (f);
 498
 499                 --i;
 500         }
 501         digester.add (buffer.get(), size - to_do);
 502
 503         return digester.get ();
 504 }
 505
 506 /** Round a number up to the nearest multiple of another number.
 507  *  @param c Index.
 508  *  @param stride Array of numbers to round, indexed by c.
 509  *  @param t Multiple to round to.
 510  *  @return Rounded number.
 511  */
 512 int
 513 stride_round_up (int c, int const * stride, int t)
 514 {
 515         int const a = stride[c] + (t - 1);
 516         return a - (a % t);
 517 }
 518
 519 /** Trip an assert if the caller is not in the UI thread */
 520 void
 521 ensure_ui_thread ()
 522 {
 523         DCPOMATIC_ASSERT (boost::this_thread::get_id() == ui_thread);
 524 }
 525
 526 string
 527 audio_channel_name (int c)
 528 {
 529         DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
 530
 531         /// TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
 532         /// enhancement channel (sub-woofer).
 533         string const channels[] = {
 534                 _("Left"),
 535                 _("Right"),
 536                 _("Centre"),
 537                 _("Lfe (sub)"),
 538                 _("Left surround"),
 539                 _("Right surround"),
 540                 _("Hearing impaired"),
 541                 _("Visually impaired"),
 542                 _("Left centre"),
 543                 _("Right centre"),
 544                 _("Left rear surround"),
 545                 _("Right rear surround"),
 546                 _("D-BOX primary"),
 547                 _("D-BOX secondary"),
 548                 _("Unused"),
 549                 _("Unused")
 550         };
 551
 552         return channels[c];
 553 }
 554
 555 string
 556 short_audio_channel_name (int c)
 557 {
 558         DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
 559
 560         /// TRANSLATORS: these are short names of audio channels; Lfe is the low-frequency
 561         /// enhancement channel (sub-woofer).  HI is the hearing-impaired audio track and
 562         /// VI is the visually-impaired audio track (audio describe).  DBP is the D-BOX
 563         /// primary channel and DBS is the D-BOX secondary channel.
 564         string const channels[] = {
 565                 _("L"),
 566                 _("R"),
 567                 _("C"),
 568                 _("Lfe"),
 569                 _("Ls"),
 570                 _("Rs"),
 571                 _("HI"),
 572                 _("VI"),
 573                 _("Lc"),
 574                 _("Rc"),
 575                 _("BsL"),
 576                 _("BsR"),
 577                 _("DBP"),
 578                 _("DBS"),
 579                 "",
 580                 ""
 581         };
 582
 583         return channels[c];
 584 }
 585
 586
 587 bool
 588 valid_image_file (boost::filesystem::path f)
 589 {
 590         if (boost::starts_with (f.leaf().string(), "._")) {
 591                 return false;
 592         }
 593
 594         string ext = f.extension().string();
 595         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 596         return (
 597                 ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" ||
 598                 ext == ".png" || ext == ".bmp" || ext == ".tga" || ext == ".dpx" ||
 599                 ext == ".j2c" || ext == ".j2k" || ext == ".jp2" || ext == ".exr" ||
 600                 ext == ".jpf"
 601                 );
 602 }
 603
 604 bool
 605 valid_sound_file (boost::filesystem::path f)
 606 {
 607         if (boost::starts_with (f.leaf().string(), "._")) {
 608                 return false;
 609         }
 610
 611         string ext = f.extension().string();
 612         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 613         return (ext == ".wav" || ext == ".mp3" || ext == ".aif" || ext == ".aiff");
 614 }
 615
 616 bool
 617 valid_j2k_file (boost::filesystem::path f)
 618 {
 619         string ext = f.extension().string();
 620         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 621         return (ext == ".j2k" || ext == ".j2c" || ext == ".jp2");
 622 }
 623
 624 string
 625 tidy_for_filename (string f)
 626 {
 627         boost::replace_if (f, boost::is_any_of ("\\/:"), '_');
 628         return f;
 629 }
 630
 631 dcp::Size
 632 fit_ratio_within (float ratio, dcp::Size full_frame)
 633 {
 634         if (ratio < full_frame.ratio ()) {
 635                 return dcp::Size (lrintf (full_frame.height * ratio), full_frame.height);
 636         }
 637
 638         return dcp::Size (full_frame.width, lrintf (full_frame.width / ratio));
 639 }
 640
 641 void *
 642 wrapped_av_malloc (size_t s)
 643 {
 644         void* p = av_malloc (s);
 645         if (!p) {
 646                 throw bad_alloc ();
 647         }
 648         return p;
 649 }
 650
 651 map<string, string>
 652 split_get_request (string url)
 653 {
 654         enum {
 655                 AWAITING_QUESTION_MARK,
 656                 KEY,
 657                 VALUE
 658         } state = AWAITING_QUESTION_MARK;
 659
 660         map<string, string> r;
 661         string k;
 662         string v;
 663         for (size_t i = 0; i < url.length(); ++i) {
 664                 switch (state) {
 665                 case AWAITING_QUESTION_MARK:
 666                         if (url[i] == '?') {
 667                                 state = KEY;
 668                         }
 669                         break;
 670                 case KEY:
 671                         if (url[i] == '=') {
 672                                 v.clear ();
 673                                 state = VALUE;
 674                         } else {
 675                                 k += url[i];
 676                         }
 677                         break;
 678                 case VALUE:
 679                         if (url[i] == '&') {
 680                                 r.insert (make_pair (k, v));
 681                                 k.clear ();
 682                                 state = KEY;
 683                         } else {
 684                                 v += url[i];
 685                         }
 686                         break;
 687                 }
 688         }
 689
 690         if (state == VALUE) {
 691                 r.insert (make_pair (k, v));
 692         }
 693
 694         return r;
 695 }
 696
 697 string
 698 video_asset_filename (shared_ptr<dcp::PictureAsset> asset, int reel_index, int reel_count, optional<string> summary)
 699 {
 700         dcp::NameFormat::Map values;
 701         values['t'] = "j2c";
 702         values['r'] = raw_convert<string> (reel_index + 1);
 703         values['n'] = raw_convert<string> (reel_count);
 704         if (summary) {
 705                 values['c'] = careful_string_filter (summary.get());
 706         }
 707         return Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + ".mxf");
 708 }
 709
 710 string
 711 audio_asset_filename (shared_ptr<dcp::SoundAsset> asset, int reel_index, int reel_count, optional<string> summary)
 712 {
 713         dcp::NameFormat::Map values;
 714         values['t'] = "pcm";
 715         values['r'] = raw_convert<string> (reel_index + 1);
 716         values['n'] = raw_convert<string> (reel_count);
 717         if (summary) {
 718                 values['c'] = careful_string_filter (summary.get());
 719         }
 720         return Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + ".mxf");
 721 }
 722
 723 float
 724 relaxed_string_to_float (string s)
 725 {
 726         try {
 727                 boost::algorithm::replace_all (s, ",", ".");
 728                 return lexical_cast<float> (s);
 729         } catch (bad_lexical_cast &) {
 730                 boost::algorithm::replace_all (s, ".", ",");
 731                 return lexical_cast<float> (s);
 732         }
 733 }
 734
 735 string
 736 careful_string_filter (string s)
 737 {
 738         /* Filter out `bad' characters which `may' cause problems with some systems (either for DCP name or filename).
 739            There's no apparent list of what really is allowed, so this is a guess.
 740            Safety first and all that.
 741         */
 742
 743         string out;
 744         string const allowed = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_%.+";
 745         for (size_t i = 0; i < s.size(); ++i) {
 746                 if (allowed.find (s[i]) != string::npos) {
 747                         out += s[i];
 748                 }
 749         }
 750
 751         return out;
 752 }
 753
 754 /** @param mapped List of mapped audio channels from a Film.
 755  *  @param channels Total number of channels in the Film.
 756  *  @return First: number of non-LFE channels, second: number of LFE channels.
 757  */
 758 pair<int, int>
 759 audio_channel_types (list<int> mapped, int channels)
 760 {
 761         int non_lfe = 0;
 762         int lfe = 0;
 763
 764         BOOST_FOREACH (int i, mapped) {
 765                 if (i >= channels) {
 766                         /* This channel is mapped but is not included in the DCP */
 767                         continue;
 768                 }
 769
 770                 if (static_cast<dcp::Channel> (i) == dcp::LFE) {
 771                         ++lfe;
 772                 } else {
 773                         ++non_lfe;
 774                 }
 775         }
 776
 777         return make_pair (non_lfe, lfe);
 778 }
 779
 780 shared_ptr<AudioBuffers>
 781 remap (shared_ptr<const AudioBuffers> input, int output_channels, AudioMapping map)
 782 {
 783         shared_ptr<AudioBuffers> mapped (new AudioBuffers (output_channels, input->frames()));
 784         mapped->make_silent ();
 785
 786         for (int i = 0; i < map.input_channels(); ++i) {
 787                 for (int j = 0; j < mapped->channels(); ++j) {
 788                         if (map.get (i, static_cast<dcp::Channel> (j)) > 0) {
 789                                 mapped->accumulate_channel (
 790                                         input.get(),
 791                                         i,
 792                                         static_cast<dcp::Channel> (j),
 793                                         map.get (i, static_cast<dcp::Channel> (j))
 794                                         );
 795                         }
 796                 }
 797         }
 798
 799         return mapped;
 800 }
 801
 802 Eyes
 803 increment_eyes (Eyes e)
 804 {
 805         if (e == EYES_LEFT) {
 806                 return EYES_RIGHT;
 807         }
 808
 809         return EYES_LEFT;
 810 }
 811
 812 void
 813 checked_fwrite (void const * ptr, size_t size, FILE* stream, boost::filesystem::path path)
 814 {
 815         size_t N = fwrite (ptr, 1, size, stream);
 816         if (N != size) {
 817                 if (ferror(stream)) {
 818                         fclose (stream);
 819                         throw FileError (String::compose("fwrite error %1", errno), path);
 820                 } else {
 821                         fclose (stream);
 822                         throw FileError ("Unexpected short write", path);
 823                 }
 824         }
 825 }
 826
 827 void
 828 checked_fread (void* ptr, size_t size, FILE* stream, boost::filesystem::path path)
 829 {
 830         size_t N = fread (ptr, 1, size, stream);
 831         if (N != size) {
 832                 if (ferror(stream)) {
 833                         fclose (stream);
 834                         throw FileError (String::compose("fread error %1", errno), path);
 835                 } else {
 836                         fclose (stream);
 837                         throw FileError ("Unexpected short read", path);
 838                 }
 839         }
 840 }
 841
 842 size_t
 843 utf8_strlen (string s)
 844 {
 845         size_t const len = s.length ();
 846         int N = 0;
 847         for (size_t i = 0; i < len; ++i) {
 848                 unsigned char c = s[i];
 849                 if ((c & 0xe0) == 0xc0) {
 850                         ++i;
 851                 } else if ((c & 0xf0) == 0xe0) {
 852                         i += 2;
 853                 } else if ((c & 0xf8) == 0xf0) {
 854                         i += 3;
 855                 }
 856                 ++N;
 857         }
 858         return N;
 859 }
 860
 861 string
 862 day_of_week_to_string (boost::gregorian::greg_weekday d)
 863 {
 864         switch (d.as_enum()) {
 865         case boost::date_time::Sunday:
 866                 return _("Sunday");
 867         case boost::date_time::Monday:
 868                 return _("Monday");
 869         case boost::date_time::Tuesday:
 870                 return _("Tuesday");
 871         case boost::date_time::Wednesday:
 872                 return _("Wednesday");
 873         case boost::date_time::Thursday:
 874                 return _("Thursday");
 875         case boost::date_time::Friday:
 876                 return _("Friday");
 877         case boost::date_time::Saturday:
 878                 return _("Saturday");
 879         }
 880
 881         return d.as_long_string ();
 882 }
 883
 884 #ifdef DCPOMATIC_VARIANT_SWAROOP
 885
 886 /* Make up a key from the machine UUID */
 887 dcp::Data
 888 key_from_uuid ()
 889 {
 890         dcp::Data key (dcpomatic::crypto_key_length());
 891         memset (key.data().get(), 0, key.size());
 892         string const magic = command_and_read ("dcpomatic2_uuid");
 893         strncpy ((char *) key.data().get(), magic.c_str(), dcpomatic::crypto_key_length());
 894         return key;
 895 }
 896
 897 /* swaroop chain file format:
 898  *
 899  *  0 [int16_t] IV length
 900  *  2 [int16_t] cert #1 length, or 0 for none
 901  *  4 [int16_t] cert #2 length, or 0 for none
 902  *  6 [int16_t] cert #3 length, or 0 for none
 903  *  8 [int16_t] cert #4 length, or 0 for none
 904  * 10 [int16_t] cert #5 length, or 0 for none
 905  * 12 [int16_t] cert #6 length, or 0 for none
 906  * 14 [int16_t] cert #7 length, or 0 for none
 907  * 16 [int16_t] cert #8 length, or 0 for none
 908  * 16 [int16_t] private key length
 909  * 20 IV
 910  *    cert #1
 911  *    cert #2
 912  *    cert #3
 913  *    cert #4
 914  *    cert #5
 915  *    cert #6
 916  *    cert #7
 917  *    cert #8
 918  *    private key
 919  */
 920
 921 struct __attribute__ ((packed)) Header_ {
 922         int16_t iv_length;
 923         int16_t cert_length[8];
 924         int16_t private_key_length;
 925 };
 926
 927 typedef struct Header_ Header;
 928
 929 shared_ptr<dcp::CertificateChain>
 930 read_swaroop_chain (boost::filesystem::path path)
 931 {
 932         dcp::Data data (path);
 933         Header* header = (Header *) data.data().get();
 934         uint8_t* p = data.data().get() + sizeof(Header);
 935
 936         dcp::Data iv (p, header->iv_length);
 937         p += iv.size();
 938
 939         shared_ptr<dcp::CertificateChain> cc (new dcp::CertificateChain());
 940         for (int i = 0; i < 8; ++i) {
 941                 if (header->cert_length[i] == 0) {
 942                         break;
 943                 }
 944                 dcp::Data c(p, header->cert_length[i]);
 945                 p += c.size();
 946                 cc->add (dcp::Certificate(dcpomatic::decrypt(c, key_from_uuid(), iv)));
 947         }
 948
 949         dcp::Data k (p, header->private_key_length);
 950         cc->set_key (dcpomatic::decrypt(k, key_from_uuid(), iv));
 951         return cc;
 952 }
 953
 954 void
 955 write_swaroop_chain (shared_ptr<const dcp::CertificateChain> chain, boost::filesystem::path output)
 956 {
 957         scoped_array<uint8_t> buffer (new uint8_t[65536]);
 958         Header* header = (Header *) buffer.get();
 959         memset (header, 0, sizeof(Header));
 960         uint8_t* p = buffer.get() + sizeof(Header);
 961
 962         dcp::Data iv = dcpomatic::random_iv ();
 963         header->iv_length = iv.size ();
 964         memcpy (p, iv.data().get(), iv.size());
 965         p += iv.size();
 966
 967         int N = 0;
 968         BOOST_FOREACH (dcp::Certificate i, chain->root_to_leaf()) {
 969                 dcp::Data e = dcpomatic::encrypt (i.certificate(true), key_from_uuid(), iv);
 970                 memcpy (p, e.data().get(), e.size());
 971                 p += e.size();
 972                 DCPOMATIC_ASSERT (N < 8);
 973                 header->cert_length[N] = e.size ();
 974                 ++N;
 975         }
 976
 977         dcp::Data k = dcpomatic::encrypt (chain->key().get(), key_from_uuid(), iv);
 978         memcpy (p, k.data().get(), k.size());
 979         p += k.size();
 980         header->private_key_length = k.size ();
 981
 982         FILE* f = fopen_boost (output, "wb");
 983         checked_fwrite (buffer.get(), p - buffer.get(), f, output);
 984         fclose (f);
 985 }
 986
 987 #endif