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 <pangomm/init.h>
  52 #include <dcp/version.h>
  53 #include <dcp/util.h>
  54 #include <dcp/signer_chain.h>
  55 #include <dcp/signer.h>
  56 extern "C" {
  57 #include <libavcodec/avcodec.h>
  58 #include <libavformat/avformat.h>
  59 #include <libswscale/swscale.h>
  60 #include <libavfilter/avfiltergraph.h>
  61 #include <libavutil/pixfmt.h>
  62 }
  63 #include "util.h"
  64 #include "exceptions.h"
  65 #include "scaler.h"
  66 #include "dcp_content_type.h"
  67 #include "filter.h"
  68 #include "sound_processor.h"
  69 #include "config.h"
  70 #include "ratio.h"
  71 #include "job.h"
  72 #include "cross.h"
  73 #include "video_content.h"
  74 #ifdef DCPOMATIC_WINDOWS
  75 #include "stack.hpp"
  76 #endif
  77
  78 #include "i18n.h"
  79
  80 using std::string;
  81 using std::stringstream;
  82 using std::setfill;
  83 using std::ostream;
  84 using std::endl;
  85 using std::vector;
  86 using std::hex;
  87 using std::setw;
  88 using std::ios;
  89 using std::min;
  90 using std::max;
  91 using std::list;
  92 using std::multimap;
  93 using std::map;
  94 using std::istream;
  95 using std::numeric_limits;
  96 using std::pair;
  97 using std::cout;
  98 using std::bad_alloc;
  99 using std::streampos;
 100 using std::set_terminate;
 101 using boost::shared_ptr;
 102 using boost::thread;
 103 using boost::lexical_cast;
 104 using boost::optional;
 105 using dcp::Size;
 106
 107 static boost::thread::id ui_thread;
 108 static boost::filesystem::path backtrace_file;
 109
 110 /** Convert some number of seconds to a string representation
 111  *  in hours, minutes and seconds.
 112  *
 113  *  @param s Seconds.
 114  *  @return String of the form H:M:S (where H is hours, M
 115  *  is minutes and S is seconds).
 116  */
 117 string
 118 seconds_to_hms (int s)
 119 {
 120         int m = s / 60;
 121         s -= (m * 60);
 122         int h = m / 60;
 123         m -= (h * 60);
 124
 125         stringstream hms;
 126         hms << h << N_(":");
 127         hms.width (2);
 128         hms << std::setfill ('0') << m << N_(":");
 129         hms.width (2);
 130         hms << std::setfill ('0') << s;
 131
 132         return hms.str ();
 133 }
 134
 135 /** @param s Number of seconds.
 136  *  @return String containing an approximate description of s (e.g. "about 2 hours")
 137  */
 138 string
 139 seconds_to_approximate_hms (int s)
 140 {
 141         int m = s / 60;
 142         s -= (m * 60);
 143         int h = m / 60;
 144         m -= (h * 60);
 145
 146         stringstream ap;
 147
 148         if (h > 0) {
 149                 if (m > 30) {
 150                         ap << (h + 1) << N_(" ") << _("hours");
 151                 } else {
 152                         if (h == 1) {
 153                                 ap << N_("1 ") << _("hour");
 154                         } else {
 155                                 ap << h << N_(" ") << _("hours");
 156                         }
 157                 }
 158         } else if (m > 0) {
 159                 if (m == 1) {
 160                         ap << N_("1 ") << _("minute");
 161                 } else {
 162                         ap << m << N_(" ") << _("minutes");
 163                 }
 164         } else {
 165                 ap << s << N_(" ") << _("seconds");
 166         }
 167
 168         return ap.str ();
 169 }
 170
 171 #ifdef DCPOMATIC_POSIX
 172 /** @param l Mangled C++ identifier.
 173  *  @return Demangled version.
 174  */
 175 static string
 176 demangle (string l)
 177 {
 178         string::size_type const b = l.find_first_of (N_("("));
 179         if (b == string::npos) {
 180                 return l;
 181         }
 182
 183         string::size_type const p = l.find_last_of (N_("+"));
 184         if (p == string::npos) {
 185                 return l;
 186         }
 187
 188         if ((p - b) <= 1) {
 189                 return l;
 190         }
 191
 192         string const fn = l.substr (b + 1, p - b - 1);
 193
 194         int status;
 195         try {
 196
 197                 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
 198                 string d (realname);
 199                 free (realname);
 200                 return d;
 201
 202         } catch (std::exception) {
 203
 204         }
 205
 206         return l;
 207 }
 208
 209 /** Write a stacktrace to an ostream.
 210  *  @param out Stream to write to.
 211  *  @param levels Number of levels to go up the call stack.
 212  */
 213 void
 214 stacktrace (ostream& out, int levels)
 215 {
 216         void *array[200];
 217         size_t size = backtrace (array, 200);
 218         char** strings = backtrace_symbols (array, size);
 219
 220         if (strings) {
 221                 for (size_t i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
 222                         out << N_("  ") << demangle (strings[i]) << "\n";
 223                 }
 224
 225                 free (strings);
 226         }
 227 }
 228 #endif
 229
 230 /** @param v Version as used by FFmpeg.
 231  *  @return A string representation of v.
 232  */
 233 static string
 234 ffmpeg_version_to_string (int v)
 235 {
 236         stringstream s;
 237         s << ((v & 0xff0000) >> 16) << N_(".") << ((v & 0xff00) >> 8) << N_(".") << (v & 0xff);
 238         return s.str ();
 239 }
 240
 241 /** Return a user-readable string summarising the versions of our dependencies */
 242 string
 243 dependency_version_summary ()
 244 {
 245         stringstream s;
 246         s << N_("libopenjpeg ") << opj_version () << N_(", ")
 247           << N_("libavcodec ") << ffmpeg_version_to_string (avcodec_version()) << N_(", ")
 248           << N_("libavfilter ") << ffmpeg_version_to_string (avfilter_version()) << N_(", ")
 249           << N_("libavformat ") << ffmpeg_version_to_string (avformat_version()) << N_(", ")
 250           << N_("libavutil ") << ffmpeg_version_to_string (avutil_version()) << N_(", ")
 251           << N_("libswscale ") << ffmpeg_version_to_string (swscale_version()) << N_(", ")
 252           << MagickVersion << N_(", ")
 253           << N_("libssh ") << ssh_version (0) << N_(", ")
 254           << N_("libdcp ") << dcp::version << N_(" git ") << dcp::git_commit;
 255
 256         return s.str ();
 257 }
 258
 259 double
 260 seconds (struct timeval t)
 261 {
 262         return t.tv_sec + (double (t.tv_usec) / 1e6);
 263 }
 264
 265 #ifdef DCPOMATIC_WINDOWS
 266 LONG WINAPI exception_handler(struct _EXCEPTION_POINTERS *)
 267 {
 268         dbg::stack s;
 269         FILE* f = fopen_boost (backtrace_file, "w");
 270         for (dbg::stack::const_iterator i = s.begin(); i != s.end(); ++i) {
 271                 fprintf (f, "%p %s %d %s", 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         Pango::init ();
 346         dcp::init ();
 347
 348         Ratio::setup_ratios ();
 349         VideoContentScale::setup_scales ();
 350         DCPContentType::setup_dcp_content_types ();
 351         Scaler::setup_scalers ();
 352         Filter::setup_filters ();
 353         SoundProcessor::setup_sound_processors ();
 354
 355         ui_thread = boost::this_thread::get_id ();
 356 }
 357
 358 #ifdef DCPOMATIC_WINDOWS
 359 boost::filesystem::path
 360 mo_path ()
 361 {
 362         wchar_t buffer[512];
 363         GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
 364         boost::filesystem::path p (buffer);
 365         p = p.parent_path ();
 366         p = p.parent_path ();
 367         p /= "locale";
 368         return p;
 369 }
 370 #endif
 371
 372 void
 373 dcpomatic_setup_gettext_i18n (string lang)
 374 {
 375 #ifdef DCPOMATIC_POSIX
 376         lang += ".UTF8";
 377 #endif
 378
 379         if (!lang.empty ()) {
 380                 /* Override our environment language; this is essential on
 381                    Windows.
 382                 */
 383                 char cmd[64];
 384                 snprintf (cmd, sizeof(cmd), "LANGUAGE=%s", lang.c_str ());
 385                 putenv (cmd);
 386                 snprintf (cmd, sizeof(cmd), "LANG=%s", lang.c_str ());
 387                 putenv (cmd);
 388                 snprintf (cmd, sizeof(cmd), "LC_ALL=%s", lang.c_str ());
 389                 putenv (cmd);
 390         }
 391
 392         setlocale (LC_ALL, "");
 393         textdomain ("libdcpomatic");
 394
 395 #ifdef DCPOMATIC_WINDOWS
 396         bindtextdomain ("libdcpomatic", mo_path().string().c_str());
 397         bind_textdomain_codeset ("libdcpomatic", "UTF8");
 398 #endif
 399
 400 #ifdef DCPOMATIC_POSIX
 401         bindtextdomain ("libdcpomatic", POSIX_LOCALE_PREFIX);
 402 #endif
 403 }
 404
 405 /** @param s A string.
 406  *  @return Parts of the string split at spaces, except when a space is within quotation marks.
 407  */
 408 vector<string>
 409 split_at_spaces_considering_quotes (string s)
 410 {
 411         vector<string> out;
 412         bool in_quotes = false;
 413         string c;
 414         for (string::size_type i = 0; i < s.length(); ++i) {
 415                 if (s[i] == ' ' && !in_quotes) {
 416                         out.push_back (c);
 417                         c = N_("");
 418                 } else if (s[i] == '"') {
 419                         in_quotes = !in_quotes;
 420                 } else {
 421                         c += s[i];
 422                 }
 423         }
 424
 425         out.push_back (c);
 426         return out;
 427 }
 428
 429 string
 430 md5_digest (void const * data, int size)
 431 {
 432         MD5_CTX md5_context;
 433         MD5_Init (&md5_context);
 434         MD5_Update (&md5_context, data, size);
 435         unsigned char digest[MD5_DIGEST_LENGTH];
 436         MD5_Final (digest, &md5_context);
 437
 438         stringstream s;
 439         for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
 440                 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
 441         }
 442
 443         return s.str ();
 444 }
 445
 446 /** @param job Optional job for which to report progress */
 447 string
 448 md5_digest (vector<boost::filesystem::path> files, shared_ptr<Job> job)
 449 {
 450         boost::uintmax_t const buffer_size = 64 * 1024;
 451         char buffer[buffer_size];
 452
 453         MD5_CTX md5_context;
 454         MD5_Init (&md5_context);
 455
 456         vector<int64_t> sizes;
 457         for (size_t i = 0; i < files.size(); ++i) {
 458                 sizes.push_back (boost::filesystem::file_size (files[i]));
 459         }
 460
 461         for (size_t i = 0; i < files.size(); ++i) {
 462                 FILE* f = fopen_boost (files[i], "rb");
 463                 if (!f) {
 464                         throw OpenFileError (files[i].string());
 465                 }
 466
 467                 boost::uintmax_t const bytes = boost::filesystem::file_size (files[i]);
 468                 boost::uintmax_t remaining = bytes;
 469
 470                 while (remaining > 0) {
 471                         int const t = min (remaining, buffer_size);
 472                         fread (buffer, 1, t, f);
 473                         MD5_Update (&md5_context, buffer, t);
 474                         remaining -= t;
 475
 476                         if (job) {
 477                                 job->set_progress ((float (i) + 1 - float(remaining) / bytes) / files.size ());
 478                         }
 479                 }
 480
 481                 fclose (f);
 482         }
 483
 484         unsigned char digest[MD5_DIGEST_LENGTH];
 485         MD5_Final (digest, &md5_context);
 486
 487         stringstream s;
 488         for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
 489                 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
 490         }
 491
 492         return s.str ();
 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 lexical_cast<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 lexical_cast<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 lexical_cast<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 string
 755 audio_channel_name (int c)
 756 {
 757         assert (MAX_AUDIO_CHANNELS == 12);
 758
 759         /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
 760            enhancement channel (sub-woofer).  HI is the hearing-impaired audio track and
 761            VI is the visually-impaired audio track (audio describe).
 762         */
 763         string const channels[] = {
 764                 _("Left"),
 765                 _("Right"),
 766                 _("Centre"),
 767                 _("Lfe (sub)"),
 768                 _("Left surround"),
 769                 _("Right surround"),
 770                 _("Hearing impaired"),
 771                 _("Visually impaired"),
 772                 _("Left centre"),
 773                 _("Right centre"),
 774                 _("Left rear surround"),
 775                 _("Right rear surround"),
 776         };
 777
 778         return channels[c];
 779 }
 780
 781 LocaleGuard::LocaleGuard ()
 782         : _old (0)
 783 {
 784         char const * old = setlocale (LC_NUMERIC, 0);
 785
 786         if (old) {
 787                 _old = strdup (old);
 788                 if (strcmp (_old, "C")) {
 789                         setlocale (LC_NUMERIC, "C");
 790                 }
 791         }
 792 }
 793
 794 LocaleGuard::~LocaleGuard ()
 795 {
 796         setlocale (LC_NUMERIC, _old);
 797         free (_old);
 798 }
 799
 800 bool
 801 valid_image_file (boost::filesystem::path f)
 802 {
 803         string ext = f.extension().string();
 804         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 805         return (ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png" || ext == ".bmp" || ext == ".tga");
 806 }
 807
 808 string
 809 tidy_for_filename (string f)
 810 {
 811         string t;
 812         for (size_t i = 0; i < f.length(); ++i) {
 813                 if (isalnum (f[i]) || f[i] == '_' || f[i] == '-') {
 814                         t += f[i];
 815                 } else {
 816                         t += '_';
 817                 }
 818         }
 819
 820         return t;
 821 }
 822
 823 shared_ptr<const dcp::Signer>
 824 make_signer ()
 825 {
 826         boost::filesystem::path const sd = Config::instance()->signer_chain_directory ();
 827
 828         /* Remake the chain if any of it is missing */
 829
 830         list<boost::filesystem::path> files;
 831         files.push_back ("ca.self-signed.pem");
 832         files.push_back ("intermediate.signed.pem");
 833         files.push_back ("leaf.signed.pem");
 834         files.push_back ("leaf.key");
 835
 836         list<boost::filesystem::path>::const_iterator i = files.begin();
 837         while (i != files.end()) {
 838                 boost::filesystem::path p (sd);
 839                 p /= *i;
 840                 if (!boost::filesystem::exists (p)) {
 841                         boost::filesystem::remove_all (sd);
 842                         boost::filesystem::create_directories (sd);
 843                         dcp::make_signer_chain (sd, openssl_path ());
 844                         break;
 845                 }
 846
 847                 ++i;
 848         }
 849
 850         dcp::CertificateChain chain;
 851
 852         {
 853                 boost::filesystem::path p (sd);
 854                 p /= "ca.self-signed.pem";
 855                 chain.add (shared_ptr<dcp::Certificate> (new dcp::Certificate (p)));
 856         }
 857
 858         {
 859                 boost::filesystem::path p (sd);
 860                 p /= "intermediate.signed.pem";
 861                 chain.add (shared_ptr<dcp::Certificate> (new dcp::Certificate (p)));
 862         }
 863
 864         {
 865                 boost::filesystem::path p (sd);
 866                 p /= "leaf.signed.pem";
 867                 chain.add (shared_ptr<dcp::Certificate> (new dcp::Certificate (p)));
 868         }
 869
 870         boost::filesystem::path signer_key (sd);
 871         signer_key /= "leaf.key";
 872
 873         return shared_ptr<const dcp::Signer> (new dcp::Signer (chain, signer_key));
 874 }
 875
 876 map<string, string>
 877 split_get_request (string url)
 878 {
 879         enum {
 880                 AWAITING_QUESTION_MARK,
 881                 KEY,
 882                 VALUE
 883         } state = AWAITING_QUESTION_MARK;
 884
 885         map<string, string> r;
 886         string k;
 887         string v;
 888         for (size_t i = 0; i < url.length(); ++i) {
 889                 switch (state) {
 890                 case AWAITING_QUESTION_MARK:
 891                         if (url[i] == '?') {
 892                                 state = KEY;
 893                         }
 894                         break;
 895                 case KEY:
 896                         if (url[i] == '=') {
 897                                 v.clear ();
 898                                 state = VALUE;
 899                         } else {
 900                                 k += url[i];
 901                         }
 902                         break;
 903                 case VALUE:
 904                         if (url[i] == '&') {
 905                                 r.insert (make_pair (k, v));
 906                                 k.clear ();
 907                                 state = KEY;
 908                         } else {
 909                                 v += url[i];
 910                         }
 911                         break;
 912                 }
 913         }
 914
 915         if (state == VALUE) {
 916                 r.insert (make_pair (k, v));
 917         }
 918
 919         return r;
 920 }
 921
 922 dcp::Size
 923 fit_ratio_within (float ratio, dcp::Size full_frame)
 924 {
 925         if (ratio < full_frame.ratio ()) {
 926                 return dcp::Size (rint (full_frame.height * ratio), full_frame.height);
 927         }
 928
 929         return dcp::Size (full_frame.width, rint (full_frame.width / ratio));
 930 }
 931
 932 void *
 933 wrapped_av_malloc (size_t s)
 934 {
 935         void* p = av_malloc (s);
 936         if (!p) {
 937                 throw bad_alloc ();
 938         }
 939         return p;
 940 }
 941
 942 string
 943 entities_to_text (string e)
 944 {
 945         boost::algorithm::replace_all (e, "%3A", ":");
 946         boost::algorithm::replace_all (e, "%2F", "/");
 947         return e;
 948 }
 949
 950 int64_t
 951 divide_with_round (int64_t a, int64_t b)
 952 {
 953         if (a % b >= (b / 2)) {
 954                 return (a + b - 1) / b;
 955         } else {
 956                 return a / b;
 957         }
 958 }