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