src/lib/util.cc

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3     Copyright (C) 2000-2007 Paul Davis
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 /** @file src/lib/util.cc
  22  *  @brief Some utility functions and classes.
  23  */
  24
  25 #include <sstream>
  26 #include <iomanip>
  27 #include <iostream>
  28 #include <fstream>
  29 #include <climits>
  30 #include <stdexcept>
  31 #ifdef DCPOMATIC_POSIX
  32 #include <execinfo.h>
  33 #include <cxxabi.h>
  34 #endif
  35 #include <libssh/libssh.h>
  36 #include <signal.h>
  37 #include <boost/algorithm/string.hpp>
  38 #include <boost/bind.hpp>
  39 #include <boost/lambda/lambda.hpp>
  40 #include <boost/lexical_cast.hpp>
  41 #include <boost/thread.hpp>
  42 #include <boost/filesystem.hpp>
  43 #ifdef DCPOMATIC_WINDOWS
  44 #include <boost/locale.hpp>
  45 #endif
  46 #include <glib.h>
  47 #include <openjpeg.h>
  48 #include <openssl/md5.h>
  49 #include <magick/MagickCore.h>
  50 #include <magick/version.h>
  51 #include <libdcp/version.h>
  52 #include <libdcp/util.h>
  53 #include <libdcp/signer_chain.h>
  54 #include <libdcp/signer.h>
  55 extern "C" {
  56 #include <libavcodec/avcodec.h>
  57 #include <libavformat/avformat.h>
  58 #include <libswscale/swscale.h>
  59 #include <libavfilter/avfiltergraph.h>
  60 #include <libavutil/pixfmt.h>
  61 }
  62 #include "util.h"
  63 #include "exceptions.h"
  64 #include "scaler.h"
  65 #include "dcp_content_type.h"
  66 #include "filter.h"
  67 #include "sound_processor.h"
  68 #include "config.h"
  69 #include "ratio.h"
  70 #include "job.h"
  71 #include "cross.h"
  72 #include "video_content.h"
  73 #ifdef DCPOMATIC_WINDOWS
  74 #include "stack.hpp"
  75 #endif
  76
  77 #include "i18n.h"
  78
  79 using std::string;
  80 using std::stringstream;
  81 using std::setfill;
  82 using std::ostream;
  83 using std::endl;
  84 using std::vector;
  85 using std::hex;
  86 using std::setw;
  87 using std::ios;
  88 using std::min;
  89 using std::max;
  90 using std::list;
  91 using std::multimap;
  92 using std::map;
  93 using std::istream;
  94 using std::numeric_limits;
  95 using std::pair;
  96 using std::cout;
  97 using std::bad_alloc;
  98 using std::streampos;
  99 using std::set_terminate;
 100 using boost::shared_ptr;
 101 using boost::thread;
 102 using boost::lexical_cast;
 103 using boost::optional;
 104 using libdcp::Size;
 105
 106 static boost::thread::id ui_thread;
 107 static boost::filesystem::path backtrace_file;
 108
 109 /** Convert some number of seconds to a string representation
 110  *  in hours, minutes and seconds.
 111  *
 112  *  @param s Seconds.
 113  *  @return String of the form H:M:S (where H is hours, M
 114  *  is minutes and S is seconds).
 115  */
 116 string
 117 seconds_to_hms (int s)
 118 {
 119         int m = s / 60;
 120         s -= (m * 60);
 121         int h = m / 60;
 122         m -= (h * 60);
 123
 124         stringstream hms;
 125         hms << h << N_(":");
 126         hms.width (2);
 127         hms << std::setfill ('0') << m << N_(":");
 128         hms.width (2);
 129         hms << std::setfill ('0') << s;
 130
 131         return hms.str ();
 132 }
 133
 134 /** @param s Number of seconds.
 135  *  @return String containing an approximate description of s (e.g. "about 2 hours")
 136  */
 137 string
 138 seconds_to_approximate_hms (int s)
 139 {
 140         int m = s / 60;
 141         s -= (m * 60);
 142         int h = m / 60;
 143         m -= (h * 60);
 144
 145         stringstream ap;
 146
 147         if (h > 0) {
 148                 if (m > 30) {
 149                         ap << (h + 1) << N_(" ") << _("hours");
 150                 } else {
 151                         if (h == 1) {
 152                                 ap << N_("1 ") << _("hour");
 153                         } else {
 154                                 ap << h << N_(" ") << _("hours");
 155                         }
 156                 }
 157         } else if (m > 0) {
 158                 if (m == 1) {
 159                         ap << N_("1 ") << _("minute");
 160                 } else {
 161                         ap << m << N_(" ") << _("minutes");
 162                 }
 163         } else {
 164                 ap << s << N_(" ") << _("seconds");
 165         }
 166
 167         return ap.str ();
 168 }
 169
 170 #ifdef DCPOMATIC_POSIX
 171 /** @param l Mangled C++ identifier.
 172  *  @return Demangled version.
 173  */
 174 static string
 175 demangle (string l)
 176 {
 177         string::size_type const b = l.find_first_of (N_("("));
 178         if (b == string::npos) {
 179                 return l;
 180         }
 181
 182         string::size_type const p = l.find_last_of (N_("+"));
 183         if (p == string::npos) {
 184                 return l;
 185         }
 186
 187         if ((p - b) <= 1) {
 188                 return l;
 189         }
 190
 191         string const fn = l.substr (b + 1, p - b - 1);
 192
 193         int status;
 194         try {
 195
 196                 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
 197                 string d (realname);
 198                 free (realname);
 199                 return d;
 200
 201         } catch (std::exception) {
 202
 203         }
 204
 205         return l;
 206 }
 207
 208 /** Write a stacktrace to an ostream.
 209  *  @param out Stream to write to.
 210  *  @param levels Number of levels to go up the call stack.
 211  */
 212 void
 213 stacktrace (ostream& out, int levels)
 214 {
 215         void *array[200];
 216         size_t size = backtrace (array, 200);
 217         char** strings = backtrace_symbols (array, size);
 218
 219         if (strings) {
 220                 for (size_t i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
 221                         out << N_("  ") << demangle (strings[i]) << "\n";
 222                 }
 223
 224                 free (strings);
 225         }
 226 }
 227 #endif
 228
 229 /** @param v Version as used by FFmpeg.
 230  *  @return A string representation of v.
 231  */
 232 static string
 233 ffmpeg_version_to_string (int v)
 234 {
 235         stringstream s;
 236         s << ((v & 0xff0000) >> 16) << N_(".") << ((v & 0xff00) >> 8) << N_(".") << (v & 0xff);
 237         return s.str ();
 238 }
 239
 240 /** Return a user-readable string summarising the versions of our dependencies */
 241 string
 242 dependency_version_summary ()
 243 {
 244         stringstream s;
 245         s << N_("libopenjpeg ") << opj_version () << N_(", ")
 246           << N_("libavcodec ") << ffmpeg_version_to_string (avcodec_version()) << N_(", ")
 247           << N_("libavfilter ") << ffmpeg_version_to_string (avfilter_version()) << N_(", ")
 248           << N_("libavformat ") << ffmpeg_version_to_string (avformat_version()) << N_(", ")
 249           << N_("libavutil ") << ffmpeg_version_to_string (avutil_version()) << N_(", ")
 250           << N_("libswscale ") << ffmpeg_version_to_string (swscale_version()) << N_(", ")
 251           << MagickVersion << N_(", ")
 252           << N_("libssh ") << ssh_version (0) << N_(", ")
 253           << N_("libdcp ") << libdcp::version << N_(" git ") << libdcp::git_commit;
 254
 255         return s.str ();
 256 }
 257
 258 double
 259 seconds (struct timeval t)
 260 {
 261         return t.tv_sec + (double (t.tv_usec) / 1e6);
 262 }
 263
 264 #ifdef DCPOMATIC_WINDOWS
 265 LONG WINAPI exception_handler(struct _EXCEPTION_POINTERS *)
 266 {
 267         dbg::stack s;
 268         FILE* f = fopen_boost (backtrace_file, "w");
 269         for (dbg::stack::const_iterator i = s.begin(); i != s.end(); ++i) {
 270                 fprintf (f, "%p %s %d %s", i->instruction, i->function.c_str(), i->line, i->module.c_str());
 271         }
 272         fclose (f);
 273         return EXCEPTION_CONTINUE_SEARCH;
 274 }
 275 #endif
 276
 277 /* From http://stackoverflow.com/questions/2443135/how-do-i-find-where-an-exception-was-thrown-in-c */
 278 void
 279 terminate ()
 280 {
 281         static bool tried_throw = false;
 282
 283         try {
 284                 // try once to re-throw currently active exception
 285                 if (!tried_throw++) {
 286                         throw;
 287                 }
 288         }
 289         catch (const std::exception &e) {
 290                 std::cerr << __FUNCTION__ << " caught unhandled exception. what(): "
 291                           << e.what() << std::endl;
 292         }
 293         catch (...) {
 294                 std::cerr << __FUNCTION__ << " caught unknown/unhandled exception."
 295                           << std::endl;
 296         }
 297
 298 #ifdef DCPOMATIC_POSIX
 299         stacktrace (cout, 50);
 300 #endif
 301         abort();
 302 }
 303
 304 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
 305  *  Must be called from the UI thread, if there is one.
 306  */
 307 void
 308 dcpomatic_setup ()
 309 {
 310 #ifdef DCPOMATIC_WINDOWS
 311         backtrace_file /= g_get_user_config_dir ();
 312         backtrace_file /= "backtrace.txt";
 313         SetUnhandledExceptionFilter(exception_handler);
 314
 315         /* Dark voodoo which, I think, gets boost::filesystem::path to
 316            correctly convert UTF-8 strings to paths, and also paths
 317            back to UTF-8 strings (on path::string()).
 318
 319            After this, constructing boost::filesystem::paths from strings
 320            converts from UTF-8 to UTF-16 inside the path.  Then
 321            path::string().c_str() gives UTF-8 and
 322            path::c_str()          gives UTF-16.
 323
 324            This is all Windows-only.  AFAICT Linux/OS X use UTF-8 everywhere,
 325            so things are much simpler.
 326         */
 327         std::locale::global (boost::locale::generator().generate (""));
 328         boost::filesystem::path::imbue (std::locale ());
 329 #endif
 330
 331         avfilter_register_all ();
 332
 333 #ifdef DCPOMATIC_OSX
 334         /* Add our lib directory to the libltdl search path so that
 335            xmlsec can find xmlsec1-openssl.
 336         */
 337         boost::filesystem::path lib = app_contents ();
 338         lib /= "lib";
 339         setenv ("LTDL_LIBRARY_PATH", lib.c_str (), 1);
 340 #endif
 341
 342         set_terminate (terminate);
 343
 344         libdcp::init ();
 345
 346         Ratio::setup_ratios ();
 347         VideoContentScale::setup_scales ();
 348         DCPContentType::setup_dcp_content_types ();
 349         Scaler::setup_scalers ();
 350         Filter::setup_filters ();
 351         SoundProcessor::setup_sound_processors ();
 352
 353         ui_thread = boost::this_thread::get_id ();
 354 }
 355
 356 #ifdef DCPOMATIC_WINDOWS
 357 boost::filesystem::path
 358 mo_path ()
 359 {
 360         wchar_t buffer[512];
 361         GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
 362         boost::filesystem::path p (buffer);
 363         p = p.parent_path ();
 364         p = p.parent_path ();
 365         p /= "locale";
 366         return p;
 367 }
 368 #endif
 369
 370 void
 371 dcpomatic_setup_gettext_i18n (string lang)
 372 {
 373 #ifdef DCPOMATIC_POSIX
 374         lang += ".UTF8";
 375 #endif
 376
 377         if (!lang.empty ()) {
 378                 /* Override our environment language; this is essential on
 379                    Windows.
 380                 */
 381                 char cmd[64];
 382                 snprintf (cmd, sizeof(cmd), "LANGUAGE=%s", lang.c_str ());
 383                 putenv (cmd);
 384                 snprintf (cmd, sizeof(cmd), "LANG=%s", lang.c_str ());
 385                 putenv (cmd);
 386                 snprintf (cmd, sizeof(cmd), "LC_ALL=%s", lang.c_str ());
 387                 putenv (cmd);
 388         }
 389
 390         setlocale (LC_ALL, "");
 391         textdomain ("libdcpomatic");
 392
 393 #ifdef DCPOMATIC_WINDOWS
 394         bindtextdomain ("libdcpomatic", mo_path().string().c_str());
 395         bind_textdomain_codeset ("libdcpomatic", "UTF8");
 396 #endif
 397
 398 #ifdef DCPOMATIC_POSIX
 399         bindtextdomain ("libdcpomatic", POSIX_LOCALE_PREFIX);
 400 #endif
 401 }
 402
 403 /** @param s A string.
 404  *  @return Parts of the string split at spaces, except when a space is within quotation marks.
 405  */
 406 vector<string>
 407 split_at_spaces_considering_quotes (string s)
 408 {
 409         vector<string> out;
 410         bool in_quotes = false;
 411         string c;
 412         for (string::size_type i = 0; i < s.length(); ++i) {
 413                 if (s[i] == ' ' && !in_quotes) {
 414                         out.push_back (c);
 415                         c = N_("");
 416                 } else if (s[i] == '"') {
 417                         in_quotes = !in_quotes;
 418                 } else {
 419                         c += s[i];
 420                 }
 421         }
 422
 423         out.push_back (c);
 424         return out;
 425 }
 426
 427 string
 428 md5_digest (void const * data, int size)
 429 {
 430         MD5_CTX md5_context;
 431         MD5_Init (&md5_context);
 432         MD5_Update (&md5_context, data, size);
 433         unsigned char digest[MD5_DIGEST_LENGTH];
 434         MD5_Final (digest, &md5_context);
 435
 436         stringstream s;
 437         for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
 438                 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
 439         }
 440
 441         return s.str ();
 442 }
 443
 444 /** @param job Optional job for which to report progress */
 445 string
 446 md5_digest (vector<boost::filesystem::path> files, shared_ptr<Job> job)
 447 {
 448         boost::uintmax_t const buffer_size = 64 * 1024;
 449         char buffer[buffer_size];
 450
 451         MD5_CTX md5_context;
 452         MD5_Init (&md5_context);
 453
 454         vector<int64_t> sizes;
 455         for (size_t i = 0; i < files.size(); ++i) {
 456                 sizes.push_back (boost::filesystem::file_size (files[i]));
 457         }
 458
 459         for (size_t i = 0; i < files.size(); ++i) {
 460                 FILE* f = fopen_boost (files[i], "rb");
 461                 if (!f) {
 462                         throw OpenFileError (files[i].string());
 463                 }
 464
 465                 boost::uintmax_t const bytes = boost::filesystem::file_size (files[i]);
 466                 boost::uintmax_t remaining = bytes;
 467
 468                 while (remaining > 0) {
 469                         int const t = min (remaining, buffer_size);
 470                         fread (buffer, 1, t, f);
 471                         MD5_Update (&md5_context, buffer, t);
 472                         remaining -= t;
 473
 474                         if (job) {
 475                                 job->set_progress ((float (i) + 1 - float(remaining) / bytes) / files.size ());
 476                         }
 477                 }
 478
 479                 fclose (f);
 480         }
 481
 482         unsigned char digest[MD5_DIGEST_LENGTH];
 483         MD5_Final (digest, &md5_context);
 484
 485         stringstream s;
 486         for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
 487                 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
 488         }
 489
 490         return s.str ();
 491 }
 492
 493 static bool
 494 about_equal (float a, float b)
 495 {
 496         /* A film of F seconds at f FPS will be Ff frames;
 497            Consider some delta FPS d, so if we run the same
 498            film at (f + d) FPS it will last F(f + d) seconds.
 499
 500            Hence the difference in length over the length of the film will
 501            be F(f + d) - Ff frames
 502             = Ff + Fd - Ff frames
 503             = Fd frames
 504             = Fd/f seconds
 505
 506            So if we accept a difference of 1 frame, ie 1/f seconds, we can
 507            say that
 508
 509            1/f = Fd/f
 510         ie 1 = Fd
 511         ie d = 1/F
 512
 513            So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
 514            FPS error is 1/F ~= 0.0001 ~= 10-e4
 515         */
 516
 517         return (fabs (a - b) < 1e-4);
 518 }
 519
 520 /** @param An arbitrary audio frame rate.
 521  *  @return The appropriate DCP-approved frame rate (48kHz or 96kHz).
 522  */
 523 int
 524 dcp_audio_frame_rate (int fs)
 525 {
 526         if (fs <= 48000) {
 527                 return 48000;
 528         }
 529
 530         return 96000;
 531 }
 532
 533 Socket::Socket (int timeout)
 534         : _deadline (_io_service)
 535         , _socket (_io_service)
 536         , _acceptor (0)
 537         , _timeout (timeout)
 538 {
 539         _deadline.expires_at (boost::posix_time::pos_infin);
 540         check ();
 541 }
 542
 543 Socket::~Socket ()
 544 {
 545         delete _acceptor;
 546 }
 547
 548 void
 549 Socket::check ()
 550 {
 551         if (_deadline.expires_at() <= boost::asio::deadline_timer::traits_type::now ()) {
 552                 if (_acceptor) {
 553                         _acceptor->cancel ();
 554                 } else {
 555                         _socket.close ();
 556                 }
 557                 _deadline.expires_at (boost::posix_time::pos_infin);
 558         }
 559
 560         _deadline.async_wait (boost::bind (&Socket::check, this));
 561 }
 562
 563 /** Blocking connect.
 564  *  @param endpoint End-point to connect to.
 565  */
 566 void
 567 Socket::connect (boost::asio::ip::tcp::endpoint endpoint)
 568 {
 569         _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
 570         boost::system::error_code ec = boost::asio::error::would_block;
 571         _socket.async_connect (endpoint, boost::lambda::var(ec) = boost::lambda::_1);
 572         do {
 573                 _io_service.run_one();
 574         } while (ec == boost::asio::error::would_block);
 575
 576         if (ec) {
 577                 throw NetworkError (String::compose (_("error during async_connect (%1)"), ec.value ()));
 578         }
 579
 580         if (!_socket.is_open ()) {
 581                 throw NetworkError (_("connect timed out"));
 582         }
 583 }
 584
 585 void
 586 Socket::accept (int port)
 587 {
 588         _acceptor = new boost::asio::ip::tcp::acceptor (_io_service, boost::asio::ip::tcp::endpoint (boost::asio::ip::tcp::v4(), port));
 589
 590         _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
 591         boost::system::error_code ec = boost::asio::error::would_block;
 592         _acceptor->async_accept (_socket, boost::lambda::var(ec) = boost::lambda::_1);
 593         do {
 594                 _io_service.run_one ();
 595         } while (ec == boost::asio::error::would_block );
 596
 597         delete _acceptor;
 598         _acceptor = 0;
 599
 600         if (ec) {
 601                 throw NetworkError (String::compose (_("error during async_accept (%1)"), ec.value ()));
 602         }
 603 }
 604
 605 /** Blocking write.
 606  *  @param data Buffer to write.
 607  *  @param size Number of bytes to write.
 608  */
 609 void
 610 Socket::write (uint8_t const * data, int size)
 611 {
 612         _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
 613         boost::system::error_code ec = boost::asio::error::would_block;
 614
 615         boost::asio::async_write (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
 616
 617         do {
 618                 _io_service.run_one ();
 619         } while (ec == boost::asio::error::would_block);
 620
 621         if (ec) {
 622                 throw NetworkError (String::compose (_("error during async_write (%1)"), ec.value ()));
 623         }
 624 }
 625
 626 void
 627 Socket::write (uint32_t v)
 628 {
 629         v = htonl (v);
 630         write (reinterpret_cast<uint8_t*> (&v), 4);
 631 }
 632
 633 /** Blocking read.
 634  *  @param data Buffer to read to.
 635  *  @param size Number of bytes to read.
 636  */
 637 void
 638 Socket::read (uint8_t* data, int size)
 639 {
 640         _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
 641         boost::system::error_code ec = boost::asio::error::would_block;
 642
 643         boost::asio::async_read (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
 644
 645         do {
 646                 _io_service.run_one ();
 647         } while (ec == boost::asio::error::would_block);
 648
 649         if (ec) {
 650                 throw NetworkError (String::compose (_("error during async_read (%1)"), ec.value ()));
 651         }
 652 }
 653
 654 uint32_t
 655 Socket::read_uint32 ()
 656 {
 657         uint32_t v;
 658         read (reinterpret_cast<uint8_t *> (&v), 4);
 659         return ntohl (v);
 660 }
 661
 662 /** Round a number up to the nearest multiple of another number.
 663  *  @param c Index.
 664  *  @param s Array of numbers to round, indexed by c.
 665  *  @param t Multiple to round to.
 666  *  @return Rounded number.
 667  */
 668 int
 669 stride_round_up (int c, int const * stride, int t)
 670 {
 671         int const a = stride[c] + (t - 1);
 672         return a - (a % t);
 673 }
 674
 675 /** Read a sequence of key / value pairs from a text stream;
 676  *  the keys are the first words on the line, and the values are
 677  *  the remainder of the line following the key.  Lines beginning
 678  *  with # are ignored.
 679  *  @param s Stream to read.
 680  *  @return key/value pairs.
 681  */
 682 multimap<string, string>
 683 read_key_value (istream &s)
 684 {
 685         multimap<string, string> kv;
 686
 687         string line;
 688         while (getline (s, line)) {
 689                 if (line.empty ()) {
 690                         continue;
 691                 }
 692
 693                 if (line[0] == '#') {
 694                         continue;
 695                 }
 696
 697                 if (line[line.size() - 1] == '\r') {
 698                         line = line.substr (0, line.size() - 1);
 699                 }
 700
 701                 size_t const s = line.find (' ');
 702                 if (s == string::npos) {
 703                         continue;
 704                 }
 705
 706                 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
 707         }
 708
 709         return kv;
 710 }
 711
 712 string
 713 get_required_string (multimap<string, string> const & kv, string k)
 714 {
 715         if (kv.count (k) > 1) {
 716                 throw StringError (N_("unexpected multiple keys in key-value set"));
 717         }
 718
 719         multimap<string, string>::const_iterator i = kv.find (k);
 720
 721         if (i == kv.end ()) {
 722                 throw StringError (String::compose (_("missing key %1 in key-value set"), k));
 723         }
 724
 725         return i->second;
 726 }
 727
 728 int
 729 get_required_int (multimap<string, string> const & kv, string k)
 730 {
 731         string const v = get_required_string (kv, k);
 732         return lexical_cast<int> (v);
 733 }
 734
 735 float
 736 get_required_float (multimap<string, string> const & kv, string k)
 737 {
 738         string const v = get_required_string (kv, k);
 739         return lexical_cast<float> (v);
 740 }
 741
 742 string
 743 get_optional_string (multimap<string, string> const & kv, string k)
 744 {
 745         if (kv.count (k) > 1) {
 746                 throw StringError (N_("unexpected multiple keys in key-value set"));
 747         }
 748
 749         multimap<string, string>::const_iterator i = kv.find (k);
 750         if (i == kv.end ()) {
 751                 return N_("");
 752         }
 753
 754         return i->second;
 755 }
 756
 757 int
 758 get_optional_int (multimap<string, string> const & kv, string k)
 759 {
 760         if (kv.count (k) > 1) {
 761                 throw StringError (N_("unexpected multiple keys in key-value set"));
 762         }
 763
 764         multimap<string, string>::const_iterator i = kv.find (k);
 765         if (i == kv.end ()) {
 766                 return 0;
 767         }
 768
 769         return lexical_cast<int> (i->second);
 770 }
 771
 772 /** Trip an assert if the caller is not in the UI thread */
 773 void
 774 ensure_ui_thread ()
 775 {
 776         assert (boost::this_thread::get_id() == ui_thread);
 777 }
 778
 779 /** @param v Content video frame.
 780  *  @param audio_sample_rate Source audio sample rate.
 781  *  @param frames_per_second Number of video frames per second.
 782  *  @return Equivalent number of audio frames for `v'.
 783  */
 784 int64_t
 785 video_frames_to_audio_frames (VideoContent::Frame v, float audio_sample_rate, float frames_per_second)
 786 {
 787         return ((int64_t) v * audio_sample_rate / frames_per_second);
 788 }
 789
 790 string
 791 audio_channel_name (int c)
 792 {
 793         assert (MAX_AUDIO_CHANNELS == 12);
 794
 795         /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
 796            enhancement channel (sub-woofer).  HI is the hearing-impaired audio track and
 797            VI is the visually-impaired audio track (audio describe).
 798         */
 799         string const channels[] = {
 800                 _("Left"),
 801                 _("Right"),
 802                 _("Centre"),
 803                 _("Lfe (sub)"),
 804                 _("Left surround"),
 805                 _("Right surround"),
 806                 _("Hearing impaired"),
 807                 _("Visually impaired"),
 808                 _("Left centre"),
 809                 _("Right centre"),
 810                 _("Left rear surround"),
 811                 _("Right rear surround"),
 812         };
 813
 814         return channels[c];
 815 }
 816
 817 FrameRateConversion::FrameRateConversion (float source, int dcp)
 818         : skip (false)
 819         , repeat (1)
 820         , change_speed (false)
 821 {
 822         if (fabs (source / 2.0 - dcp) < fabs (source - dcp)) {
 823                 /* The difference between source and DCP frame rate will be lower
 824                    (i.e. better) if we skip.
 825                 */
 826                 skip = true;
 827         } else if (fabs (source * 2 - dcp) < fabs (source - dcp)) {
 828                 /* The difference between source and DCP frame rate would be better
 829                    if we repeated each frame once; it may be better still if we
 830                    repeated more than once.  Work out the required repeat.
 831                 */
 832                 repeat = round (dcp / source);
 833         }
 834
 835         change_speed = !about_equal (source * factor(), dcp);
 836
 837         if (!skip && repeat == 1 && !change_speed) {
 838                 description = _("Content and DCP have the same rate.\n");
 839         } else {
 840                 if (skip) {
 841                         description = _("DCP will use every other frame of the content.\n");
 842                 } else if (repeat == 2) {
 843                         description = _("Each content frame will be doubled in the DCP.\n");
 844                 } else if (repeat > 2) {
 845                         description = String::compose (_("Each content frame will be repeated %1 more times in the DCP.\n"), repeat - 1);
 846                 }
 847
 848                 if (change_speed) {
 849                         float const pc = dcp * 100 / (source * factor());
 850                         description += String::compose (_("DCP will run at %1%% of the content speed.\n"), pc);
 851                 }
 852         }
 853 }
 854
 855 LocaleGuard::LocaleGuard ()
 856         : _old (0)
 857 {
 858         char const * old = setlocale (LC_NUMERIC, 0);
 859
 860         if (old) {
 861                 _old = strdup (old);
 862                 if (strcmp (_old, "C")) {
 863                         setlocale (LC_NUMERIC, "C");
 864                 }
 865         }
 866 }
 867
 868 LocaleGuard::~LocaleGuard ()
 869 {
 870         setlocale (LC_NUMERIC, _old);
 871         free (_old);
 872 }
 873
 874 bool
 875 valid_image_file (boost::filesystem::path f)
 876 {
 877         string ext = f.extension().string();
 878         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 879         return (ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png" || ext == ".bmp" || ext == ".tga");
 880 }
 881
 882 string
 883 tidy_for_filename (string f)
 884 {
 885         string t;
 886         for (size_t i = 0; i < f.length(); ++i) {
 887                 if (isalnum (f[i]) || f[i] == '_' || f[i] == '-') {
 888                         t += f[i];
 889                 } else {
 890                         t += '_';
 891                 }
 892         }
 893
 894         return t;
 895 }
 896
 897 shared_ptr<const libdcp::Signer>
 898 make_signer ()
 899 {
 900         boost::filesystem::path const sd = Config::instance()->signer_chain_directory ();
 901
 902         /* Remake the chain if any of it is missing */
 903
 904         list<boost::filesystem::path> files;
 905         files.push_back ("ca.self-signed.pem");
 906         files.push_back ("intermediate.signed.pem");
 907         files.push_back ("leaf.signed.pem");
 908         files.push_back ("leaf.key");
 909
 910         list<boost::filesystem::path>::const_iterator i = files.begin();
 911         while (i != files.end()) {
 912                 boost::filesystem::path p (sd);
 913                 p /= *i;
 914                 if (!boost::filesystem::exists (p)) {
 915                         boost::filesystem::remove_all (sd);
 916                         boost::filesystem::create_directories (sd);
 917                         libdcp::make_signer_chain (sd, openssl_path ());
 918                         break;
 919                 }
 920
 921                 ++i;
 922         }
 923
 924         libdcp::CertificateChain chain;
 925
 926         {
 927                 boost::filesystem::path p (sd);
 928                 p /= "ca.self-signed.pem";
 929                 chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p)));
 930         }
 931
 932         {
 933                 boost::filesystem::path p (sd);
 934                 p /= "intermediate.signed.pem";
 935                 chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p)));
 936         }
 937
 938         {
 939                 boost::filesystem::path p (sd);
 940                 p /= "leaf.signed.pem";
 941                 chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p)));
 942         }
 943
 944         boost::filesystem::path signer_key (sd);
 945         signer_key /= "leaf.key";
 946
 947         return shared_ptr<const libdcp::Signer> (new libdcp::Signer (chain, signer_key));
 948 }
 949
 950 map<string, string>
 951 split_get_request (string url)
 952 {
 953         enum {
 954                 AWAITING_QUESTION_MARK,
 955                 KEY,
 956                 VALUE
 957         } state = AWAITING_QUESTION_MARK;
 958
 959         map<string, string> r;
 960         string k;
 961         string v;
 962         for (size_t i = 0; i < url.length(); ++i) {
 963                 switch (state) {
 964                 case AWAITING_QUESTION_MARK:
 965                         if (url[i] == '?') {
 966                                 state = KEY;
 967                         }
 968                         break;
 969                 case KEY:
 970                         if (url[i] == '=') {
 971                                 v.clear ();
 972                                 state = VALUE;
 973                         } else {
 974                                 k += url[i];
 975                         }
 976                         break;
 977                 case VALUE:
 978                         if (url[i] == '&') {
 979                                 r.insert (make_pair (k, v));
 980                                 k.clear ();
 981                                 state = KEY;
 982                         } else {
 983                                 v += url[i];
 984                         }
 985                         break;
 986                 }
 987         }
 988
 989         if (state == VALUE) {
 990                 r.insert (make_pair (k, v));
 991         }
 992
 993         return r;
 994 }
 995
 996 libdcp::Size
 997 fit_ratio_within (float ratio, libdcp::Size full_frame)
 998 {
 999         if (ratio < full_frame.ratio ()) {
1000                 return libdcp::Size (rint (full_frame.height * ratio), full_frame.height);
1001         }
1002
1003         return libdcp::Size (full_frame.width, rint (full_frame.width / ratio));
1004 }
1005
1006 void *
1007 wrapped_av_malloc (size_t s)
1008 {
1009         void* p = av_malloc (s);
1010         if (!p) {
1011                 throw bad_alloc ();
1012         }
1013         return p;
1014 }
1015
1016 string
1017 entities_to_text (string e)
1018 {
1019         boost::algorithm::replace_all (e, "%3A", ":");
1020         boost::algorithm::replace_all (e, "%2F", "/");
1021         return e;
1022 }
1023
1024 int64_t
1025 divide_with_round (int64_t a, int64_t b)
1026 {
1027         if (a % b >= (b / 2)) {
1028                 return (a + b - 1) / b;
1029         } else {
1030                 return a / b;
1031         }
1032 }
1033
1034 ScopedTemporary::ScopedTemporary ()
1035         : _open (0)
1036 {
1037         _file = boost::filesystem::temp_directory_path() / boost::filesystem::unique_path ();
1038 }
1039
1040 ScopedTemporary::~ScopedTemporary ()
1041 {
1042         close ();
1043         boost::system::error_code ec;
1044         boost::filesystem::remove (_file, ec);
1045 }
1046
1047 char const *
1048 ScopedTemporary::c_str () const
1049 {
1050         return _file.string().c_str ();
1051 }
1052
1053 FILE*
1054 ScopedTemporary::open (char const * params)
1055 {
1056         _open = fopen (c_str(), params);
1057         return _open;
1058 }
1059
1060 void
1061 ScopedTemporary::close ()
1062 {
1063         if (_open) {
1064                 fclose (_open);
1065                 _open = 0;
1066         }
1067 }