src/lib/util.cc

   1 /*
   2     Copyright (C) 2012-2014 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/thread.hpp>
  41 #include <boost/filesystem.hpp>
  42 #ifdef DCPOMATIC_WINDOWS
  43 #include <boost/locale.hpp>
  44 #endif
  45 #include <glib.h>
  46 #include <openjpeg.h>
  47 #include <magick/MagickCore.h>
  48 #include <magick/version.h>
  49 #include <libdcp/version.h>
  50 #include <libdcp/util.h>
  51 #include <libdcp/signer_chain.h>
  52 #include <libdcp/signer.h>
  53 #include <libdcp/raw_convert.h>
  54 extern "C" {
  55 #include <libavcodec/avcodec.h>
  56 #include <libavformat/avformat.h>
  57 #include <libswscale/swscale.h>
  58 #include <libavfilter/avfiltergraph.h>
  59 #include <libavutil/pixfmt.h>
  60 }
  61 #include "util.h"
  62 #include "exceptions.h"
  63 #include "scaler.h"
  64 #include "dcp_content_type.h"
  65 #include "filter.h"
  66 #include "sound_processor.h"
  67 #include "config.h"
  68 #include "ratio.h"
  69 #include "job.h"
  70 #include "cross.h"
  71 #include "video_content.h"
  72 #include "md5_digester.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::optional;
 103 using libdcp::Size;
 104 using libdcp::raw_convert;
 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         fprintf (f, "Exception thrown:");
 270         for (dbg::stack::const_iterator i = s.begin(); i != s.end(); ++i) {
 271                 fprintf (f, "%p %s %d %s\n", i->instruction, i->function.c_str(), i->line, i->module.c_str());
 272         }
 273         fclose (f);
 274         return EXCEPTION_CONTINUE_SEARCH;
 275 }
 276 #endif
 277
 278 /* From http://stackoverflow.com/questions/2443135/how-do-i-find-where-an-exception-was-thrown-in-c */
 279 void
 280 terminate ()
 281 {
 282         static bool tried_throw = false;
 283
 284         try {
 285                 // try once to re-throw currently active exception
 286                 if (!tried_throw++) {
 287                         throw;
 288                 }
 289         }
 290         catch (const std::exception &e) {
 291                 std::cerr << __FUNCTION__ << " caught unhandled exception. what(): "
 292                           << e.what() << std::endl;
 293         }
 294         catch (...) {
 295                 std::cerr << __FUNCTION__ << " caught unknown/unhandled exception."
 296                           << std::endl;
 297         }
 298
 299 #ifdef DCPOMATIC_POSIX
 300         stacktrace (cout, 50);
 301 #endif
 302         abort();
 303 }
 304
 305 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
 306  *  Must be called from the UI thread, if there is one.
 307  */
 308 void
 309 dcpomatic_setup ()
 310 {
 311 #ifdef DCPOMATIC_WINDOWS
 312         backtrace_file /= g_get_user_config_dir ();
 313         backtrace_file /= "backtrace.txt";
 314         SetUnhandledExceptionFilter(exception_handler);
 315
 316         /* Dark voodoo which, I think, gets boost::filesystem::path to
 317            correctly convert UTF-8 strings to paths, and also paths
 318            back to UTF-8 strings (on path::string()).
 319
 320            After this, constructing boost::filesystem::paths from strings
 321            converts from UTF-8 to UTF-16 inside the path.  Then
 322            path::string().c_str() gives UTF-8 and
 323            path::c_str()          gives UTF-16.
 324
 325            This is all Windows-only.  AFAICT Linux/OS X use UTF-8 everywhere,
 326            so things are much simpler.
 327         */
 328         std::locale::global (boost::locale::generator().generate (""));
 329         boost::filesystem::path::imbue (std::locale ());
 330 #endif
 331
 332         avfilter_register_all ();
 333
 334 #ifdef DCPOMATIC_OSX
 335         /* Add our lib directory to the libltdl search path so that
 336            xmlsec can find xmlsec1-openssl.
 337         */
 338         boost::filesystem::path lib = app_contents ();
 339         lib /= "lib";
 340         setenv ("LTDL_LIBRARY_PATH", lib.c_str (), 1);
 341 #endif
 342
 343         set_terminate (terminate);
 344
 345         libdcp::init ();
 346
 347         Ratio::setup_ratios ();
 348         VideoContentScale::setup_scales ();
 349         DCPContentType::setup_dcp_content_types ();
 350         Scaler::setup_scalers ();
 351         Filter::setup_filters ();
 352         SoundProcessor::setup_sound_processors ();
 353
 354         ui_thread = boost::this_thread::get_id ();
 355 }
 356
 357 #ifdef DCPOMATIC_WINDOWS
 358 boost::filesystem::path
 359 mo_path ()
 360 {
 361         wchar_t buffer[512];
 362         GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
 363         boost::filesystem::path p (buffer);
 364         p = p.parent_path ();
 365         p = p.parent_path ();
 366         p /= "locale";
 367         return p;
 368 }
 369 #endif
 370
 371 void
 372 dcpomatic_setup_gettext_i18n (string lang)
 373 {
 374 #ifdef DCPOMATIC_POSIX
 375         lang += ".UTF8";
 376 #endif
 377
 378         if (!lang.empty ()) {
 379                 /* Override our environment language; this is essential on
 380                    Windows.
 381                 */
 382                 char cmd[64];
 383                 snprintf (cmd, sizeof(cmd), "LANGUAGE=%s", lang.c_str ());
 384                 putenv (cmd);
 385                 snprintf (cmd, sizeof(cmd), "LANG=%s", lang.c_str ());
 386                 putenv (cmd);
 387                 snprintf (cmd, sizeof(cmd), "LC_ALL=%s", lang.c_str ());
 388                 putenv (cmd);
 389         }
 390
 391         setlocale (LC_ALL, "");
 392         textdomain ("libdcpomatic");
 393
 394 #ifdef DCPOMATIC_WINDOWS
 395         bindtextdomain ("libdcpomatic", mo_path().string().c_str());
 396         bind_textdomain_codeset ("libdcpomatic", "UTF8");
 397 #endif
 398
 399 #ifdef DCPOMATIC_POSIX
 400         bindtextdomain ("libdcpomatic", POSIX_LOCALE_PREFIX);
 401 #endif
 402 }
 403
 404 /** @param s A string.
 405  *  @return Parts of the string split at spaces, except when a space is within quotation marks.
 406  */
 407 vector<string>
 408 split_at_spaces_considering_quotes (string s)
 409 {
 410         vector<string> out;
 411         bool in_quotes = false;
 412         string c;
 413         for (string::size_type i = 0; i < s.length(); ++i) {
 414                 if (s[i] == ' ' && !in_quotes) {
 415                         out.push_back (c);
 416                         c = N_("");
 417                 } else if (s[i] == '"') {
 418                         in_quotes = !in_quotes;
 419                 } else {
 420                         c += s[i];
 421                 }
 422         }
 423
 424         out.push_back (c);
 425         return out;
 426 }
 427
 428 /** @param job Optional job for which to report progress */
 429 string
 430 md5_digest (vector<boost::filesystem::path> files, shared_ptr<Job> job)
 431 {
 432         boost::uintmax_t const buffer_size = 64 * 1024;
 433         char buffer[buffer_size];
 434
 435         MD5Digester digester;
 436
 437         vector<int64_t> sizes;
 438         for (size_t i = 0; i < files.size(); ++i) {
 439                 sizes.push_back (boost::filesystem::file_size (files[i]));
 440         }
 441
 442         for (size_t i = 0; i < files.size(); ++i) {
 443                 FILE* f = fopen_boost (files[i], "rb");
 444                 if (!f) {
 445                         throw OpenFileError (files[i].string());
 446                 }
 447
 448                 boost::uintmax_t const bytes = boost::filesystem::file_size (files[i]);
 449                 boost::uintmax_t remaining = bytes;
 450
 451                 while (remaining > 0) {
 452                         int const t = min (remaining, buffer_size);
 453                         fread (buffer, 1, t, f);
 454                         digester.add (buffer, t);
 455                         remaining -= t;
 456
 457                         if (job) {
 458                                 job->set_progress ((float (i) + 1 - float(remaining) / bytes) / files.size ());
 459                         }
 460                 }
 461
 462                 fclose (f);
 463         }
 464
 465         return digester.get ();
 466 }
 467
 468 static bool
 469 about_equal (float a, float b)
 470 {
 471         /* A film of F seconds at f FPS will be Ff frames;
 472            Consider some delta FPS d, so if we run the same
 473            film at (f + d) FPS it will last F(f + d) seconds.
 474
 475            Hence the difference in length over the length of the film will
 476            be F(f + d) - Ff frames
 477             = Ff + Fd - Ff frames
 478             = Fd frames
 479             = Fd/f seconds
 480
 481            So if we accept a difference of 1 frame, ie 1/f seconds, we can
 482            say that
 483
 484            1/f = Fd/f
 485         ie 1 = Fd
 486         ie d = 1/F
 487
 488            So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
 489            FPS error is 1/F ~= 0.0001 ~= 10-e4
 490         */
 491
 492         return (fabs (a - b) < 1e-4);
 493 }
 494
 495 /** @param An arbitrary audio frame rate.
 496  *  @return The appropriate DCP-approved frame rate (48kHz or 96kHz).
 497  */
 498 int
 499 dcp_audio_frame_rate (int fs)
 500 {
 501         if (fs <= 48000) {
 502                 return 48000;
 503         }
 504
 505         return 96000;
 506 }
 507
 508 Socket::Socket (int timeout)
 509         : _deadline (_io_service)
 510         , _socket (_io_service)
 511         , _acceptor (0)
 512         , _timeout (timeout)
 513 {
 514         _deadline.expires_at (boost::posix_time::pos_infin);
 515         check ();
 516 }
 517
 518 Socket::~Socket ()
 519 {
 520         delete _acceptor;
 521 }
 522
 523 void
 524 Socket::check ()
 525 {
 526         if (_deadline.expires_at() <= boost::asio::deadline_timer::traits_type::now ()) {
 527                 if (_acceptor) {
 528                         _acceptor->cancel ();
 529                 } else {
 530                         _socket.close ();
 531                 }
 532                 _deadline.expires_at (boost::posix_time::pos_infin);
 533         }
 534
 535         _deadline.async_wait (boost::bind (&Socket::check, this));
 536 }
 537
 538 /** Blocking connect.
 539  *  @param endpoint End-point to connect to.
 540  */
 541 void
 542 Socket::connect (boost::asio::ip::tcp::endpoint endpoint)
 543 {
 544         _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
 545         boost::system::error_code ec = boost::asio::error::would_block;
 546         _socket.async_connect (endpoint, boost::lambda::var(ec) = boost::lambda::_1);
 547         do {
 548                 _io_service.run_one();
 549         } while (ec == boost::asio::error::would_block);
 550
 551         if (ec) {
 552                 throw NetworkError (String::compose (_("error during async_connect (%1)"), ec.value ()));
 553         }
 554
 555         if (!_socket.is_open ()) {
 556                 throw NetworkError (_("connect timed out"));
 557         }
 558 }
 559
 560 void
 561 Socket::accept (int port)
 562 {
 563         _acceptor = new boost::asio::ip::tcp::acceptor (_io_service, boost::asio::ip::tcp::endpoint (boost::asio::ip::tcp::v4(), port));
 564
 565         _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
 566         boost::system::error_code ec = boost::asio::error::would_block;
 567         _acceptor->async_accept (_socket, boost::lambda::var(ec) = boost::lambda::_1);
 568         do {
 569                 _io_service.run_one ();
 570         } while (ec == boost::asio::error::would_block );
 571
 572         delete _acceptor;
 573         _acceptor = 0;
 574
 575         if (ec) {
 576                 throw NetworkError (String::compose (_("error during async_accept (%1)"), ec.value ()));
 577         }
 578 }
 579
 580 /** Blocking write.
 581  *  @param data Buffer to write.
 582  *  @param size Number of bytes to write.
 583  */
 584 void
 585 Socket::write (uint8_t const * data, int size)
 586 {
 587         _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
 588         boost::system::error_code ec = boost::asio::error::would_block;
 589
 590         boost::asio::async_write (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
 591
 592         do {
 593                 _io_service.run_one ();
 594         } while (ec == boost::asio::error::would_block);
 595
 596         if (ec) {
 597                 throw NetworkError (String::compose (_("error during async_write (%1)"), ec.value ()));
 598         }
 599 }
 600
 601 void
 602 Socket::write (uint32_t v)
 603 {
 604         v = htonl (v);
 605         write (reinterpret_cast<uint8_t*> (&v), 4);
 606 }
 607
 608 /** Blocking read.
 609  *  @param data Buffer to read to.
 610  *  @param size Number of bytes to read.
 611  */
 612 void
 613 Socket::read (uint8_t* data, int size)
 614 {
 615         _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
 616         boost::system::error_code ec = boost::asio::error::would_block;
 617
 618         boost::asio::async_read (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
 619
 620         do {
 621                 _io_service.run_one ();
 622         } while (ec == boost::asio::error::would_block);
 623
 624         if (ec) {
 625                 throw NetworkError (String::compose (_("error during async_read (%1)"), ec.value ()));
 626         }
 627 }
 628
 629 uint32_t
 630 Socket::read_uint32 ()
 631 {
 632         uint32_t v;
 633         read (reinterpret_cast<uint8_t *> (&v), 4);
 634         return ntohl (v);
 635 }
 636
 637 /** Round a number up to the nearest multiple of another number.
 638  *  @param c Index.
 639  *  @param s Array of numbers to round, indexed by c.
 640  *  @param t Multiple to round to.
 641  *  @return Rounded number.
 642  */
 643 int
 644 stride_round_up (int c, int const * stride, int t)
 645 {
 646         int const a = stride[c] + (t - 1);
 647         return a - (a % t);
 648 }
 649
 650 /** Read a sequence of key / value pairs from a text stream;
 651  *  the keys are the first words on the line, and the values are
 652  *  the remainder of the line following the key.  Lines beginning
 653  *  with # are ignored.
 654  *  @param s Stream to read.
 655  *  @return key/value pairs.
 656  */
 657 multimap<string, string>
 658 read_key_value (istream &s)
 659 {
 660         multimap<string, string> kv;
 661
 662         string line;
 663         while (getline (s, line)) {
 664                 if (line.empty ()) {
 665                         continue;
 666                 }
 667
 668                 if (line[0] == '#') {
 669                         continue;
 670                 }
 671
 672                 if (line[line.size() - 1] == '\r') {
 673                         line = line.substr (0, line.size() - 1);
 674                 }
 675
 676                 size_t const s = line.find (' ');
 677                 if (s == string::npos) {
 678                         continue;
 679                 }
 680
 681                 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
 682         }
 683
 684         return kv;
 685 }
 686
 687 string
 688 get_required_string (multimap<string, string> const & kv, string k)
 689 {
 690         if (kv.count (k) > 1) {
 691                 throw StringError (N_("unexpected multiple keys in key-value set"));
 692         }
 693
 694         multimap<string, string>::const_iterator i = kv.find (k);
 695
 696         if (i == kv.end ()) {
 697                 throw StringError (String::compose (_("missing key %1 in key-value set"), k));
 698         }
 699
 700         return i->second;
 701 }
 702
 703 int
 704 get_required_int (multimap<string, string> const & kv, string k)
 705 {
 706         string const v = get_required_string (kv, k);
 707         return raw_convert<int> (v);
 708 }
 709
 710 float
 711 get_required_float (multimap<string, string> const & kv, string k)
 712 {
 713         string const v = get_required_string (kv, k);
 714         return raw_convert<float> (v);
 715 }
 716
 717 string
 718 get_optional_string (multimap<string, string> const & kv, string k)
 719 {
 720         if (kv.count (k) > 1) {
 721                 throw StringError (N_("unexpected multiple keys in key-value set"));
 722         }
 723
 724         multimap<string, string>::const_iterator i = kv.find (k);
 725         if (i == kv.end ()) {
 726                 return N_("");
 727         }
 728
 729         return i->second;
 730 }
 731
 732 int
 733 get_optional_int (multimap<string, string> const & kv, string k)
 734 {
 735         if (kv.count (k) > 1) {
 736                 throw StringError (N_("unexpected multiple keys in key-value set"));
 737         }
 738
 739         multimap<string, string>::const_iterator i = kv.find (k);
 740         if (i == kv.end ()) {
 741                 return 0;
 742         }
 743
 744         return raw_convert<int> (i->second);
 745 }
 746
 747 /** Trip an assert if the caller is not in the UI thread */
 748 void
 749 ensure_ui_thread ()
 750 {
 751         assert (boost::this_thread::get_id() == ui_thread);
 752 }
 753
 754 /** @param v Content video frame.
 755  *  @param audio_sample_rate Source audio sample rate.
 756  *  @param frames_per_second Number of video frames per second.
 757  *  @return Equivalent number of audio frames for `v'.
 758  */
 759 int64_t
 760 video_frames_to_audio_frames (VideoContent::Frame v, float audio_sample_rate, float frames_per_second)
 761 {
 762         return ((int64_t) v * audio_sample_rate / frames_per_second);
 763 }
 764
 765 string
 766 audio_channel_name (int c)
 767 {
 768         assert (MAX_DCP_AUDIO_CHANNELS == 12);
 769
 770         /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
 771            enhancement channel (sub-woofer).  HI is the hearing-impaired audio track and
 772            VI is the visually-impaired audio track (audio describe).
 773         */
 774         string const channels[] = {
 775                 _("Left"),
 776                 _("Right"),
 777                 _("Centre"),
 778                 _("Lfe (sub)"),
 779                 _("Left surround"),
 780                 _("Right surround"),
 781                 _("Hearing impaired"),
 782                 _("Visually impaired"),
 783                 _("Left centre"),
 784                 _("Right centre"),
 785                 _("Left rear surround"),
 786                 _("Right rear surround"),
 787         };
 788
 789         return channels[c];
 790 }
 791
 792 bool
 793 valid_image_file (boost::filesystem::path f)
 794 {
 795         string ext = f.extension().string();
 796         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 797         return (ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png" || ext == ".bmp" || ext == ".tga" || ext == ".dpx");
 798 }
 799
 800 string
 801 tidy_for_filename (string f)
 802 {
 803         string t;
 804         for (size_t i = 0; i < f.length(); ++i) {
 805                 if (isalnum (f[i]) || f[i] == '_' || f[i] == '-') {
 806                         t += f[i];
 807                 } else {
 808                         t += '_';
 809                 }
 810         }
 811
 812         return t;
 813 }
 814
 815 shared_ptr<const libdcp::Signer>
 816 make_signer ()
 817 {
 818         boost::filesystem::path const sd = Config::instance()->signer_chain_directory ();
 819
 820         /* Remake the chain if any of it is missing */
 821
 822         list<boost::filesystem::path> files;
 823         files.push_back ("ca.self-signed.pem");
 824         files.push_back ("intermediate.signed.pem");
 825         files.push_back ("leaf.signed.pem");
 826         files.push_back ("leaf.key");
 827
 828         list<boost::filesystem::path>::const_iterator i = files.begin();
 829         while (i != files.end()) {
 830                 boost::filesystem::path p (sd);
 831                 p /= *i;
 832                 if (!boost::filesystem::exists (p)) {
 833                         boost::filesystem::remove_all (sd);
 834                         boost::filesystem::create_directories (sd);
 835                         libdcp::make_signer_chain (sd, openssl_path ());
 836                         break;
 837                 }
 838
 839                 ++i;
 840         }
 841
 842         libdcp::CertificateChain chain;
 843
 844         {
 845                 boost::filesystem::path p (sd);
 846                 p /= "ca.self-signed.pem";
 847                 chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p)));
 848         }
 849
 850         {
 851                 boost::filesystem::path p (sd);
 852                 p /= "intermediate.signed.pem";
 853                 chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p)));
 854         }
 855
 856         {
 857                 boost::filesystem::path p (sd);
 858                 p /= "leaf.signed.pem";
 859                 chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p)));
 860         }
 861
 862         boost::filesystem::path signer_key (sd);
 863         signer_key /= "leaf.key";
 864
 865         return shared_ptr<const libdcp::Signer> (new libdcp::Signer (chain, signer_key));
 866 }
 867
 868 map<string, string>
 869 split_get_request (string url)
 870 {
 871         enum {
 872                 AWAITING_QUESTION_MARK,
 873                 KEY,
 874                 VALUE
 875         } state = AWAITING_QUESTION_MARK;
 876
 877         map<string, string> r;
 878         string k;
 879         string v;
 880         for (size_t i = 0; i < url.length(); ++i) {
 881                 switch (state) {
 882                 case AWAITING_QUESTION_MARK:
 883                         if (url[i] == '?') {
 884                                 state = KEY;
 885                         }
 886                         break;
 887                 case KEY:
 888                         if (url[i] == '=') {
 889                                 v.clear ();
 890                                 state = VALUE;
 891                         } else {
 892                                 k += url[i];
 893                         }
 894                         break;
 895                 case VALUE:
 896                         if (url[i] == '&') {
 897                                 r.insert (make_pair (k, v));
 898                                 k.clear ();
 899                                 state = KEY;
 900                         } else {
 901                                 v += url[i];
 902                         }
 903                         break;
 904                 }
 905         }
 906
 907         if (state == VALUE) {
 908                 r.insert (make_pair (k, v));
 909         }
 910
 911         return r;
 912 }
 913
 914 libdcp::Size
 915 fit_ratio_within (float ratio, libdcp::Size full_frame)
 916 {
 917         if (ratio < full_frame.ratio ()) {
 918                 return libdcp::Size (rint (full_frame.height * ratio), full_frame.height);
 919         }
 920
 921         return libdcp::Size (full_frame.width, rint (full_frame.width / ratio));
 922 }
 923
 924 void *
 925 wrapped_av_malloc (size_t s)
 926 {
 927         void* p = av_malloc (s);
 928         if (!p) {
 929                 throw bad_alloc ();
 930         }
 931         return p;
 932 }
 933
 934 string
 935 entities_to_text (string e)
 936 {
 937         boost::algorithm::replace_all (e, "%3A", ":");
 938         boost::algorithm::replace_all (e, "%2F", "/");
 939         return e;
 940 }
 941
 942 int64_t
 943 divide_with_round (int64_t a, int64_t b)
 944 {
 945         if (a % b >= (b / 2)) {
 946                 return (a + b - 1) / b;
 947         } else {
 948                 return a / b;
 949         }
 950 }
 951
 952 ScopedTemporary::ScopedTemporary ()
 953         : _open (0)
 954 {
 955         _file = boost::filesystem::temp_directory_path() / boost::filesystem::unique_path ();
 956 }
 957
 958 ScopedTemporary::~ScopedTemporary ()
 959 {
 960         close ();
 961         boost::system::error_code ec;
 962         boost::filesystem::remove (_file, ec);
 963 }
 964
 965 char const *
 966 ScopedTemporary::c_str () const
 967 {
 968         return _file.string().c_str ();
 969 }
 970
 971 FILE*
 972 ScopedTemporary::open (char const * params)
 973 {
 974         _open = fopen (c_str(), params);
 975         return _open;
 976 }
 977
 978 void
 979 ScopedTemporary::close ()
 980 {
 981         if (_open) {
 982                 fclose (_open);
 983                 _open = 0;
 984         }
 985 }