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 #ifdef DVDOMATIC_POSIX
  30 #include <execinfo.h>
  31 #include <cxxabi.h>
  32 #endif
  33 #include <libssh/libssh.h>
  34 #include <signal.h>
  35 #include <boost/algorithm/string.hpp>
  36 #include <boost/bind.hpp>
  37 #include <boost/lambda/lambda.hpp>
  38 #include <boost/lexical_cast.hpp>
  39 #include <openjpeg.h>
  40 #include <openssl/md5.h>
  41 #include <magick/MagickCore.h>
  42 #include <magick/version.h>
  43 #include <libdcp/version.h>
  44 extern "C" {
  45 #include <libavcodec/avcodec.h>
  46 #include <libavformat/avformat.h>
  47 #include <libswscale/swscale.h>
  48 #include <libavfilter/avfiltergraph.h>
  49 #include <libpostproc/postprocess.h>
  50 #include <libavutil/pixfmt.h>
  51 }
  52 #include "util.h"
  53 #include "exceptions.h"
  54 #include "scaler.h"
  55 #include "format.h"
  56 #include "dcp_content_type.h"
  57 #include "filter.h"
  58 #include "screen.h"
  59 #include "film_state.h"
  60 #include "sound_processor.h"
  61 #ifndef DVDOMATIC_DISABLE_PLAYER
  62 #include "player_manager.h"
  63 #endif
  64
  65 using namespace std;
  66 using namespace boost;
  67
  68 /** Convert some number of seconds to a string representation
  69  *  in hours, minutes and seconds.
  70  *
  71  *  @param s Seconds.
  72  *  @return String of the form H:M:S (where H is hours, M
  73  *  is minutes and S is seconds).
  74  */
  75 string
  76 seconds_to_hms (int s)
  77 {
  78         int m = s / 60;
  79         s -= (m * 60);
  80         int h = m / 60;
  81         m -= (h * 60);
  82
  83         stringstream hms;
  84         hms << h << ":";
  85         hms.width (2);
  86         hms << setfill ('0') << m << ":";
  87         hms.width (2);
  88         hms << setfill ('0') << s;
  89
  90         return hms.str ();
  91 }
  92
  93 /** @param s Number of seconds.
  94  *  @return String containing an approximate description of s (e.g. "about 2 hours")
  95  */
  96 string
  97 seconds_to_approximate_hms (int s)
  98 {
  99         int m = s / 60;
 100         s -= (m * 60);
 101         int h = m / 60;
 102         m -= (h * 60);
 103
 104         stringstream ap;
 105
 106         if (h > 0) {
 107                 if (m > 30) {
 108                         ap << (h + 1) << " hours";
 109                 } else {
 110                         if (h == 1) {
 111                                 ap << "1 hour";
 112                         } else {
 113                                 ap << h << " hours";
 114                         }
 115                 }
 116         } else if (m > 0) {
 117                 if (m == 1) {
 118                         ap << "1 minute";
 119                 } else {
 120                         ap << m << " minutes";
 121                 }
 122         } else {
 123                 ap << s << " seconds";
 124         }
 125
 126         return ap.str ();
 127 }
 128
 129 #ifdef DVDOMATIC_POSIX
 130 /** @param l Mangled C++ identifier.
 131  *  @return Demangled version.
 132  */
 133 static string
 134 demangle (string l)
 135 {
 136         string::size_type const b = l.find_first_of ("(");
 137         if (b == string::npos) {
 138                 return l;
 139         }
 140
 141         string::size_type const p = l.find_last_of ("+");
 142         if (p == string::npos) {
 143                 return l;
 144         }
 145
 146         if ((p - b) <= 1) {
 147                 return l;
 148         }
 149
 150         string const fn = l.substr (b + 1, p - b - 1);
 151
 152         int status;
 153         try {
 154
 155                 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
 156                 string d (realname);
 157                 free (realname);
 158                 return d;
 159
 160         } catch (std::exception) {
 161
 162         }
 163
 164         return l;
 165 }
 166
 167 /** Write a stacktrace to an ostream.
 168  *  @param out Stream to write to.
 169  *  @param levels Number of levels to go up the call stack.
 170  */
 171 void
 172 stacktrace (ostream& out, int levels)
 173 {
 174         void *array[200];
 175         size_t size;
 176         char **strings;
 177         size_t i;
 178
 179         size = backtrace (array, 200);
 180         strings = backtrace_symbols (array, size);
 181
 182         if (strings) {
 183                 for (i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
 184                         out << "  " << demangle (strings[i]) << endl;
 185                 }
 186
 187                 free (strings);
 188         }
 189 }
 190 #endif
 191
 192 /** @param s Sample format.
 193  *  @return String representation.
 194  */
 195 string
 196 audio_sample_format_to_string (AVSampleFormat s)
 197 {
 198         /* Our sample format handling is not exactly complete */
 199
 200         switch (s) {
 201         case AV_SAMPLE_FMT_S16:
 202                 return "S16";
 203         default:
 204                 assert (false);
 205         }
 206 }
 207
 208 /** @param s String representation of a sample format, as returned from audio_sample_format_to_string().
 209  *  @return Sample format.
 210  */
 211 AVSampleFormat
 212 audio_sample_format_from_string (string s)
 213 {
 214         if (s == "S16") {
 215                 return AV_SAMPLE_FMT_S16;
 216         }
 217
 218         assert (false);
 219 }
 220
 221 /** @return Version of vobcopy that is on the path (and hence that we will use) */
 222 static string
 223 vobcopy_version ()
 224 {
 225         FILE* f = popen ("vobcopy -V 2>&1", "r");
 226         if (f == 0) {
 227                 throw EncodeError ("could not run vobcopy to check version");
 228         }
 229
 230         string version = "unknown";
 231
 232         while (!feof (f)) {
 233                 char buf[256];
 234                 if (fgets (buf, sizeof (buf), f)) {
 235                         string s (buf);
 236                         vector<string> b;
 237                         split (b, s, is_any_of (" "));
 238                         if (b.size() >= 2 && b[0] == "Vobcopy") {
 239                                 version = b[1];
 240                         }
 241                 }
 242         }
 243
 244         pclose (f);
 245
 246         return version;
 247 }
 248
 249 /** @param v Version as used by FFmpeg.
 250  *  @return A string representation of v.
 251  */
 252 static string
 253 ffmpeg_version_to_string (int v)
 254 {
 255         stringstream s;
 256         s << ((v & 0xff0000) >> 16) << "." << ((v & 0xff00) >> 8) << "." << (v & 0xff);
 257         return s.str ();
 258 }
 259
 260 /** Return a user-readable string summarising the versions of our dependencies */
 261 string
 262 dependency_version_summary ()
 263 {
 264         stringstream s;
 265         s << "libopenjpeg " << opj_version () << ", "
 266           << "vobcopy " << vobcopy_version() << ", "
 267           << "libavcodec " << ffmpeg_version_to_string (avcodec_version()) << ", "
 268           << "libavfilter " << ffmpeg_version_to_string (avfilter_version()) << ", "
 269           << "libavformat " << ffmpeg_version_to_string (avformat_version()) << ", "
 270           << "libavutil " << ffmpeg_version_to_string (avutil_version()) << ", "
 271           << "libpostproc " << ffmpeg_version_to_string (postproc_version()) << ", "
 272           << "libswscale " << ffmpeg_version_to_string (swscale_version()) << ", "
 273           << MagickVersion << ", "
 274           << "libssh " << ssh_version (0) << ", "
 275           << "libdcp " << libdcp::version << " git " << libdcp::git_commit;
 276
 277         return s.str ();
 278 }
 279
 280 double
 281 seconds (struct timeval t)
 282 {
 283         return t.tv_sec + (double (t.tv_usec) / 1e6);
 284 }
 285
 286
 287 #ifdef DVDOMATIC_POSIX
 288 void
 289 sigchld_handler (int, siginfo_t* info, void *)
 290 {
 291 #ifndef DVDOMATIC_DISABLE_PLAYER
 292         PlayerManager::instance()->child_exited (info->si_pid);
 293 #endif
 294 }
 295 #endif
 296
 297 /** Call the required functions to set up DVD-o-matic's static arrays, etc. */
 298 void
 299 dvdomatic_setup ()
 300 {
 301         Format::setup_formats ();
 302         DCPContentType::setup_dcp_content_types ();
 303         Scaler::setup_scalers ();
 304         Filter::setup_filters ();
 305         SoundProcessor::setup_sound_processors ();
 306
 307 #ifdef DVDOMATIC_POSIX
 308         struct sigaction sa;
 309         sa.sa_flags = SA_SIGINFO;
 310         sigemptyset (&sa.sa_mask);
 311         sa.sa_sigaction = sigchld_handler;
 312         sigaction (SIGCHLD, &sa, 0);
 313 #endif
 314 }
 315
 316 string
 317 crop_string (Position start, Size size)
 318 {
 319         stringstream s;
 320         s << "crop=" << size.width << ":" << size.height << ":" << start.x << ":" << start.y;
 321         return s.str ();
 322 }
 323
 324 vector<string>
 325 split_at_spaces_considering_quotes (string s)
 326 {
 327         vector<string> out;
 328         bool in_quotes = false;
 329         string c;
 330         for (string::size_type i = 0; i < s.length(); ++i) {
 331                 if (s[i] == ' ' && !in_quotes) {
 332                         out.push_back (c);
 333                         c = "";
 334                 } else if (s[i] == '"') {
 335                         in_quotes = !in_quotes;
 336                 } else {
 337                         c += s[i];
 338                 }
 339         }
 340
 341         out.push_back (c);
 342         return out;
 343 }
 344
 345 string
 346 md5_digest (void const * data, int size)
 347 {
 348         MD5_CTX md5_context;
 349         MD5_Init (&md5_context);
 350         MD5_Update (&md5_context, data, size);
 351         unsigned char digest[MD5_DIGEST_LENGTH];
 352         MD5_Final (digest, &md5_context);
 353
 354         stringstream s;
 355         for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
 356                 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
 357         }
 358
 359         return s.str ();
 360 }
 361
 362 /** @param file File name.
 363  *  @return MD5 digest of file's contents.
 364  */
 365 string
 366 md5_digest (string file)
 367 {
 368         ifstream f (file.c_str(), ios::binary);
 369         if (!f.good ()) {
 370                 throw OpenFileError (file);
 371         }
 372
 373         f.seekg (0, ios::end);
 374         int bytes = f.tellg ();
 375         f.seekg (0, ios::beg);
 376
 377         int const buffer_size = 64 * 1024;
 378         char buffer[buffer_size];
 379
 380         MD5_CTX md5_context;
 381         MD5_Init (&md5_context);
 382         while (bytes > 0) {
 383                 int const t = min (bytes, buffer_size);
 384                 f.read (buffer, t);
 385                 MD5_Update (&md5_context, buffer, t);
 386                 bytes -= t;
 387         }
 388
 389         unsigned char digest[MD5_DIGEST_LENGTH];
 390         MD5_Final (digest, &md5_context);
 391
 392         stringstream s;
 393         for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
 394                 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
 395         }
 396
 397         return s.str ();
 398 }
 399
 400 /** @param An arbitrary sampling rate.
 401  *  @return The appropriate DCP-approved sampling rate (48kHz or 96kHz).
 402  */
 403 int
 404 dcp_audio_sample_rate (int fs)
 405 {
 406         if (fs <= 48000) {
 407                 return 48000;
 408         }
 409
 410         return 96000;
 411 }
 412
 413 bool operator== (Crop const & a, Crop const & b)
 414 {
 415         return (a.left == b.left && a.right == b.right && a.top == b.top && a.bottom == b.bottom);
 416 }
 417
 418 bool operator!= (Crop const & a, Crop const & b)
 419 {
 420         return !(a == b);
 421 }
 422
 423 /** @param index Colour LUT index.
 424  *  @return Human-readable name.
 425  */
 426 string
 427 colour_lut_index_to_name (int index)
 428 {
 429         switch (index) {
 430         case 0:
 431                 return "sRGB";
 432         case 1:
 433                 return "Rec 709";
 434         }
 435
 436         assert (false);
 437         return "";
 438 }
 439
 440 Socket::Socket ()
 441         : _deadline (_io_service)
 442         , _socket (_io_service)
 443         , _buffer_data (0)
 444 {
 445         _deadline.expires_at (posix_time::pos_infin);
 446         check ();
 447 }
 448
 449 void
 450 Socket::check ()
 451 {
 452         if (_deadline.expires_at() <= asio::deadline_timer::traits_type::now ()) {
 453                 _socket.close ();
 454                 _deadline.expires_at (posix_time::pos_infin);
 455         }
 456
 457         _deadline.async_wait (boost::bind (&Socket::check, this));
 458 }
 459
 460 /** Blocking connect with timeout.
 461  *  @param endpoint End-point to connect to.
 462  *  @param timeout Time-out in seconds.
 463  */
 464 void
 465 Socket::connect (asio::ip::basic_resolver_entry<asio::ip::tcp> const & endpoint, int timeout)
 466 {
 467         system::error_code ec = asio::error::would_block;
 468         _socket.async_connect (endpoint, lambda::var(ec) = lambda::_1);
 469         do {
 470                 _io_service.run_one();
 471         } while (ec == asio::error::would_block);
 472
 473         if (ec || !_socket.is_open ()) {
 474                 throw NetworkError ("connect timed out");
 475         }
 476 }
 477
 478 /** Blocking write with timeout.
 479  *  @param data Buffer to write.
 480  *  @param size Number of bytes to write.
 481  *  @param timeout Time-out, in seconds.
 482  */
 483 void
 484 Socket::write (uint8_t const * data, int size, int timeout)
 485 {
 486         _deadline.expires_from_now (posix_time::seconds (timeout));
 487         system::error_code ec = asio::error::would_block;
 488
 489         asio::async_write (_socket, asio::buffer (data, size), lambda::var(ec) = lambda::_1);
 490         do {
 491                 _io_service.run_one ();
 492         } while (ec == asio::error::would_block);
 493
 494         if (ec) {
 495                 throw NetworkError ("write timed out");
 496         }
 497 }
 498
 499 /** Blocking read with timeout.
 500  *  @param data Buffer to read to.
 501  *  @param size Number of bytes to read.
 502  *  @param timeout Time-out, in seconds.
 503  */
 504 int
 505 Socket::read (uint8_t* data, int size, int timeout)
 506 {
 507         _deadline.expires_from_now (posix_time::seconds (timeout));
 508         system::error_code ec = asio::error::would_block;
 509
 510         int amount_read = 0;
 511
 512         _socket.async_read_some (
 513                 asio::buffer (data, size),
 514                 (lambda::var(ec) = lambda::_1, lambda::var(amount_read) = lambda::_2)
 515                 );
 516
 517         do {
 518                 _io_service.run_one ();
 519         } while (ec == asio::error::would_block);
 520
 521         if (ec) {
 522                 amount_read = 0;
 523         }
 524
 525         return amount_read;
 526 }
 527
 528 /** Mark some data as being `consumed', so that it will not be returned
 529  *  as data again.
 530  *  @param size Amount of data to consume, in bytes.
 531  */
 532 void
 533 Socket::consume (int size)
 534 {
 535         assert (_buffer_data >= size);
 536
 537         _buffer_data -= size;
 538         if (_buffer_data > 0) {
 539                 /* Shift still-valid data to the start of the buffer */
 540                 memmove (_buffer, _buffer + size, _buffer_data);
 541         }
 542 }
 543
 544 /** Read a definite amount of data from our socket, and mark
 545  *  it as consumed.
 546  *  @param data Where to put the data.
 547  *  @param size Number of bytes to read.
 548  */
 549 void
 550 Socket::read_definite_and_consume (uint8_t* data, int size, int timeout)
 551 {
 552         int const from_buffer = min (_buffer_data, size);
 553         if (from_buffer > 0) {
 554                 /* Get data from our buffer */
 555                 memcpy (data, _buffer, from_buffer);
 556                 consume (from_buffer);
 557                 /* Update our output state */
 558                 data += from_buffer;
 559                 size -= from_buffer;
 560         }
 561
 562         /* read() the rest */
 563         while (size > 0) {
 564                 int const n = read (data, size, timeout);
 565                 if (n <= 0) {
 566                         throw NetworkError ("could not read");
 567                 }
 568
 569                 data += n;
 570                 size -= n;
 571         }
 572 }
 573
 574 /** Read as much data as is available, up to some limit.
 575  *  @param data Where to put the data.
 576  *  @param size Maximum amount of data to read.
 577  */
 578 void
 579 Socket::read_indefinite (uint8_t* data, int size, int timeout)
 580 {
 581         assert (size < int (sizeof (_buffer)));
 582
 583         /* Amount of extra data we need to read () */
 584         int to_read = size - _buffer_data;
 585         while (to_read > 0) {
 586                 /* read as much of it as we can (into our buffer) */
 587                 int const n = read (_buffer + _buffer_data, to_read, timeout);
 588                 if (n <= 0) {
 589                         throw NetworkError ("could not read");
 590                 }
 591
 592                 to_read -= n;
 593                 _buffer_data += n;
 594         }
 595
 596         assert (_buffer_data >= size);
 597
 598         /* copy data into the output buffer */
 599         assert (size >= _buffer_data);
 600         memcpy (data, _buffer, size);
 601 }
 602
 603 Rect
 604 Rect::intersection (Rect const & other) const
 605 {
 606         int const tx = max (x, other.x);
 607         int const ty = max (y, other.y);
 608
 609         return Rect (
 610                 tx, ty,
 611                 min (x + width, other.x + other.width) - tx,
 612                 min (y + height, other.y + other.height) - ty
 613                 );
 614 }
 615
 616 /** Round a number up to the nearest multiple of another number.
 617  *  @param a Number to round.
 618  *  @param t Multiple to round to.
 619  *  @return Rounded number.
 620  */
 621
 622 int
 623 round_up (int a, int t)
 624 {
 625         a += (t - 1);
 626         return a - (a % t);
 627 }
 628
 629 /** Read a sequence of key / value pairs from a text stream;
 630  *  the keys are the first words on the line, and the values are
 631  *  the remainder of the line following the key.  Lines beginning
 632  *  with # are ignored.
 633  *  @param s Stream to read.
 634  *  @return key/value pairs.
 635  */
 636 multimap<string, string>
 637 read_key_value (istream &s)
 638 {
 639         multimap<string, string> kv;
 640
 641         string line;
 642         while (getline (s, line)) {
 643                 if (line.empty ()) {
 644                         continue;
 645                 }
 646
 647                 if (line[0] == '#') {
 648                         continue;
 649                 }
 650
 651                 if (line[line.size() - 1] == '\r') {
 652                         line = line.substr (0, line.size() - 1);
 653                 }
 654
 655                 size_t const s = line.find (' ');
 656                 if (s == string::npos) {
 657                         continue;
 658                 }
 659
 660                 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
 661         }
 662
 663         return kv;
 664 }
 665
 666 string
 667 get_required_string (multimap<string, string> const & kv, string k)
 668 {
 669         if (kv.count (k) > 1) {
 670                 throw StringError ("unexpected multiple keys in key-value set");
 671         }
 672
 673         multimap<string, string>::const_iterator i = kv.find (k);
 674
 675         if (i == kv.end ()) {
 676                 throw StringError (String::compose ("missing key %1 in key-value set", k));
 677         }
 678
 679         return i->second;
 680 }
 681
 682 int
 683 get_required_int (multimap<string, string> const & kv, string k)
 684 {
 685         string const v = get_required_string (kv, k);
 686         return lexical_cast<int> (v);
 687 }
 688
 689 float
 690 get_required_float (multimap<string, string> const & kv, string k)
 691 {
 692         string const v = get_required_string (kv, k);
 693         return lexical_cast<float> (v);
 694 }
 695
 696 string
 697 get_optional_string (multimap<string, string> const & kv, string k)
 698 {
 699         if (kv.count (k) > 1) {
 700                 throw StringError ("unexpected multiple keys in key-value set");
 701         }
 702
 703         multimap<string, string>::const_iterator i = kv.find (k);
 704         if (i == kv.end ()) {
 705                 return "";
 706         }
 707
 708         return i->second;
 709 }
 710
 711 int
 712 get_optional_int (multimap<string, string> const & kv, string k)
 713 {
 714         if (kv.count (k) > 1) {
 715                 throw StringError ("unexpected multiple keys in key-value set");
 716         }
 717
 718         multimap<string, string>::const_iterator i = kv.find (k);
 719         if (i == kv.end ()) {
 720                 return 0;
 721         }
 722
 723         return lexical_cast<int> (i->second);
 724 }