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 #ifdef DVDOMATIC_POSIX
  31 #include <execinfo.h>
  32 #include <cxxabi.h>
  33 #endif
  34 #include <libssh/libssh.h>
  35 #include <signal.h>
  36 #include <boost/algorithm/string.hpp>
  37 #include <boost/bind.hpp>
  38 #include <boost/lambda/lambda.hpp>
  39 #include <boost/lexical_cast.hpp>
  40 #include <boost/thread.hpp>
  41 #include <boost/filesystem.hpp>
  42 #include <openjpeg.h>
  43 #include <openssl/md5.h>
  44 #include <magick/MagickCore.h>
  45 #include <magick/version.h>
  46 #include <libdcp/version.h>
  47 extern "C" {
  48 #include <libavcodec/avcodec.h>
  49 #include <libavformat/avformat.h>
  50 #include <libswscale/swscale.h>
  51 #include <libavfilter/avfiltergraph.h>
  52 #include <libpostproc/postprocess.h>
  53 #include <libavutil/pixfmt.h>
  54 }
  55 #include "util.h"
  56 #include "exceptions.h"
  57 #include "scaler.h"
  58 #include "format.h"
  59 #include "dcp_content_type.h"
  60 #include "filter.h"
  61 #include "sound_processor.h"
  62 #include "config.h"
  63
  64 using namespace std;
  65 using namespace boost;
  66 using libdcp::Size;
  67
  68 thread::id ui_thread;
  69
  70 /** Convert some number of seconds to a string representation
  71  *  in hours, minutes and seconds.
  72  *
  73  *  @param s Seconds.
  74  *  @return String of the form H:M:S (where H is hours, M
  75  *  is minutes and S is seconds).
  76  */
  77 string
  78 seconds_to_hms (int s)
  79 {
  80         int m = s / 60;
  81         s -= (m * 60);
  82         int h = m / 60;
  83         m -= (h * 60);
  84
  85         stringstream hms;
  86         hms << h << ":";
  87         hms.width (2);
  88         hms << setfill ('0') << m << ":";
  89         hms.width (2);
  90         hms << setfill ('0') << s;
  91
  92         return hms.str ();
  93 }
  94
  95 /** @param s Number of seconds.
  96  *  @return String containing an approximate description of s (e.g. "about 2 hours")
  97  */
  98 string
  99 seconds_to_approximate_hms (int s)
 100 {
 101         int m = s / 60;
 102         s -= (m * 60);
 103         int h = m / 60;
 104         m -= (h * 60);
 105
 106         stringstream ap;
 107
 108         if (h > 0) {
 109                 if (m > 30) {
 110                         ap << (h + 1) << " hours";
 111                 } else {
 112                         if (h == 1) {
 113                                 ap << "1 hour";
 114                         } else {
 115                                 ap << h << " hours";
 116                         }
 117                 }
 118         } else if (m > 0) {
 119                 if (m == 1) {
 120                         ap << "1 minute";
 121                 } else {
 122                         ap << m << " minutes";
 123                 }
 124         } else {
 125                 ap << s << " seconds";
 126         }
 127
 128         return ap.str ();
 129 }
 130
 131 #ifdef DVDOMATIC_POSIX
 132 /** @param l Mangled C++ identifier.
 133  *  @return Demangled version.
 134  */
 135 static string
 136 demangle (string l)
 137 {
 138         string::size_type const b = l.find_first_of ("(");
 139         if (b == string::npos) {
 140                 return l;
 141         }
 142
 143         string::size_type const p = l.find_last_of ("+");
 144         if (p == string::npos) {
 145                 return l;
 146         }
 147
 148         if ((p - b) <= 1) {
 149                 return l;
 150         }
 151
 152         string const fn = l.substr (b + 1, p - b - 1);
 153
 154         int status;
 155         try {
 156
 157                 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
 158                 string d (realname);
 159                 free (realname);
 160                 return d;
 161
 162         } catch (std::exception) {
 163
 164         }
 165
 166         return l;
 167 }
 168
 169 /** Write a stacktrace to an ostream.
 170  *  @param out Stream to write to.
 171  *  @param levels Number of levels to go up the call stack.
 172  */
 173 void
 174 stacktrace (ostream& out, int levels)
 175 {
 176         void *array[200];
 177         size_t size;
 178         char **strings;
 179         size_t i;
 180
 181         size = backtrace (array, 200);
 182         strings = backtrace_symbols (array, size);
 183
 184         if (strings) {
 185                 for (i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
 186                         out << "  " << demangle (strings[i]) << endl;
 187                 }
 188
 189                 free (strings);
 190         }
 191 }
 192 #endif
 193
 194 /** @param v Version as used by FFmpeg.
 195  *  @return A string representation of v.
 196  */
 197 static string
 198 ffmpeg_version_to_string (int v)
 199 {
 200         stringstream s;
 201         s << ((v & 0xff0000) >> 16) << "." << ((v & 0xff00) >> 8) << "." << (v & 0xff);
 202         return s.str ();
 203 }
 204
 205 /** Return a user-readable string summarising the versions of our dependencies */
 206 string
 207 dependency_version_summary ()
 208 {
 209         stringstream s;
 210         s << "libopenjpeg " << opj_version () << ", "
 211           << "libavcodec " << ffmpeg_version_to_string (avcodec_version()) << ", "
 212           << "libavfilter " << ffmpeg_version_to_string (avfilter_version()) << ", "
 213           << "libavformat " << ffmpeg_version_to_string (avformat_version()) << ", "
 214           << "libavutil " << ffmpeg_version_to_string (avutil_version()) << ", "
 215           << "libpostproc " << ffmpeg_version_to_string (postproc_version()) << ", "
 216           << "libswscale " << ffmpeg_version_to_string (swscale_version()) << ", "
 217           << MagickVersion << ", "
 218           << "libssh " << ssh_version (0) << ", "
 219           << "libdcp " << libdcp::version << " git " << libdcp::git_commit;
 220
 221         return s.str ();
 222 }
 223
 224 double
 225 seconds (struct timeval t)
 226 {
 227         return t.tv_sec + (double (t.tv_usec) / 1e6);
 228 }
 229
 230 /** Call the required functions to set up DVD-o-matic's static arrays, etc.
 231  *  Must be called from the UI thread, if there is one.
 232  */
 233 void
 234 dvdomatic_setup ()
 235 {
 236         Format::setup_formats ();
 237         DCPContentType::setup_dcp_content_types ();
 238         Scaler::setup_scalers ();
 239         Filter::setup_filters ();
 240         SoundProcessor::setup_sound_processors ();
 241
 242         ui_thread = this_thread::get_id ();
 243 }
 244
 245 /** @param start Start position for the crop within the image.
 246  *  @param size Size of the cropped area.
 247  *  @return FFmpeg crop filter string.
 248  */
 249 string
 250 crop_string (Position start, libdcp::Size size)
 251 {
 252         stringstream s;
 253         s << "crop=" << size.width << ":" << size.height << ":" << start.x << ":" << start.y;
 254         return s.str ();
 255 }
 256
 257 /** @param s A string.
 258  *  @return Parts of the string split at spaces, except when a space is within quotation marks.
 259  */
 260 vector<string>
 261 split_at_spaces_considering_quotes (string s)
 262 {
 263         vector<string> out;
 264         bool in_quotes = false;
 265         string c;
 266         for (string::size_type i = 0; i < s.length(); ++i) {
 267                 if (s[i] == ' ' && !in_quotes) {
 268                         out.push_back (c);
 269                         c = "";
 270                 } else if (s[i] == '"') {
 271                         in_quotes = !in_quotes;
 272                 } else {
 273                         c += s[i];
 274                 }
 275         }
 276
 277         out.push_back (c);
 278         return out;
 279 }
 280
 281 string
 282 md5_digest (void const * data, int size)
 283 {
 284         MD5_CTX md5_context;
 285         MD5_Init (&md5_context);
 286         MD5_Update (&md5_context, data, size);
 287         unsigned char digest[MD5_DIGEST_LENGTH];
 288         MD5_Final (digest, &md5_context);
 289
 290         stringstream s;
 291         for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
 292                 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
 293         }
 294
 295         return s.str ();
 296 }
 297
 298 /** @param file File name.
 299  *  @return MD5 digest of file's contents.
 300  */
 301 string
 302 md5_digest (string file)
 303 {
 304         ifstream f (file.c_str(), ios::binary);
 305         if (!f.good ()) {
 306                 throw OpenFileError (file);
 307         }
 308
 309         f.seekg (0, ios::end);
 310         int bytes = f.tellg ();
 311         f.seekg (0, ios::beg);
 312
 313         int const buffer_size = 64 * 1024;
 314         char buffer[buffer_size];
 315
 316         MD5_CTX md5_context;
 317         MD5_Init (&md5_context);
 318         while (bytes > 0) {
 319                 int const t = min (bytes, buffer_size);
 320                 f.read (buffer, t);
 321                 MD5_Update (&md5_context, buffer, t);
 322                 bytes -= t;
 323         }
 324
 325         unsigned char digest[MD5_DIGEST_LENGTH];
 326         MD5_Final (digest, &md5_context);
 327
 328         stringstream s;
 329         for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
 330                 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
 331         }
 332
 333         return s.str ();
 334 }
 335
 336 static bool about_equal (float a, float b)
 337 {
 338         /* A film of F seconds at f FPS will be Ff frames;
 339            Consider some delta FPS d, so if we run the same
 340            film at (f + d) FPS it will last F(f + d) seconds.
 341
 342            Hence the difference in length over the length of the film will
 343            be F(f + d) - Ff frames
 344             = Ff + Fd - Ff frames
 345             = Fd frames
 346             = Fd/f seconds
 347
 348            So if we accept a difference of 1 frame, ie 1/f seconds, we can
 349            say that
 350
 351            1/f = Fd/f
 352         ie 1 = Fd
 353         ie d = 1/F
 354
 355            So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
 356            FPS error is 1/F ~= 0.0001 ~= 10-e4
 357         */
 358
 359         return (fabs (a - b) < 1e-4);
 360 }
 361
 362 class FrameRateCandidate
 363 {
 364 public:
 365         FrameRateCandidate (float source_, int dcp_)
 366                 : source (source_)
 367                 , dcp (dcp_)
 368         {}
 369
 370         bool skip () const {
 371                 return !about_equal (source, dcp) && source > dcp;
 372         }
 373
 374         bool repeat () const {
 375                 return !about_equal (source, dcp) && source < dcp;
 376         }
 377
 378         float source;
 379         int dcp;
 380 };
 381
 382 /** @param fps Arbitrary source frames-per-second value */
 383 /** XXX: this could be slow-ish */
 384 DCPFrameRate::DCPFrameRate (float source_fps)
 385 {
 386         list<int> const allowed_dcp_frame_rates = Config::instance()->allowed_dcp_frame_rates ();
 387
 388         /* Work out what rates we could manage, including those achieved by using skip / repeat. */
 389         list<FrameRateCandidate> candidates;
 390
 391         /* Start with the ones without skip / repeat so they will get matched in preference to skipped/repeated ones */
 392         for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
 393                 candidates.push_back (FrameRateCandidate (*i, *i));
 394         }
 395
 396         /* Then the skip/repeat ones */
 397         for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
 398                 candidates.push_back (FrameRateCandidate (float (*i) / 2, *i));
 399                 candidates.push_back (FrameRateCandidate (float (*i) * 2, *i));
 400         }
 401
 402         /* Pick the best one, bailing early if we hit an exact match */
 403         float error = numeric_limits<float>::max ();
 404         boost::optional<FrameRateCandidate> best;
 405         list<FrameRateCandidate>::iterator i = candidates.begin();
 406         while (i != candidates.end()) {
 407
 408                 if (about_equal (i->source, source_fps)) {
 409                         best = *i;
 410                         break;
 411                 }
 412
 413                 float const e = fabs (i->source - source_fps);
 414                 if (e < error) {
 415                         error = e;
 416                         best = *i;
 417                 }
 418
 419                 ++i;
 420         }
 421
 422         if (!best) {
 423                 throw EncodeError ("cannot find a suitable DCP frame rate for this source");
 424         }
 425
 426         frames_per_second = best->dcp;
 427         skip = best->skip ();
 428         repeat = best->repeat ();
 429         change_speed = !about_equal (source_fps * factor(), frames_per_second);
 430 }
 431
 432 /** @param An arbitrary sampling rate.
 433  *  @return The appropriate DCP-approved sampling rate (48kHz or 96kHz).
 434  */
 435 int
 436 dcp_audio_sample_rate (int fs)
 437 {
 438         if (fs <= 48000) {
 439                 return 48000;
 440         }
 441
 442         return 96000;
 443 }
 444
 445 int
 446 dcp_audio_channels (int f)
 447 {
 448         if (f == 1) {
 449                 /* The source is mono, so to put the mono channel into
 450                    the centre we need to generate a 5.1 soundtrack.
 451                 */
 452                 return 6;
 453         }
 454
 455         return f;
 456 }
 457
 458 bool operator== (Crop const & a, Crop const & b)
 459 {
 460         return (a.left == b.left && a.right == b.right && a.top == b.top && a.bottom == b.bottom);
 461 }
 462
 463 bool operator!= (Crop const & a, Crop const & b)
 464 {
 465         return !(a == b);
 466 }
 467
 468 /** @param index Colour LUT index.
 469  *  @return Human-readable name.
 470  */
 471 string
 472 colour_lut_index_to_name (int index)
 473 {
 474         switch (index) {
 475         case 0:
 476                 return "sRGB";
 477         case 1:
 478                 return "Rec 709";
 479         }
 480
 481         assert (false);
 482         return "";
 483 }
 484
 485 Socket::Socket ()
 486         : _deadline (_io_service)
 487         , _socket (_io_service)
 488         , _buffer_data (0)
 489 {
 490         _deadline.expires_at (posix_time::pos_infin);
 491         check ();
 492 }
 493
 494 void
 495 Socket::check ()
 496 {
 497         if (_deadline.expires_at() <= asio::deadline_timer::traits_type::now ()) {
 498                 _socket.close ();
 499                 _deadline.expires_at (posix_time::pos_infin);
 500         }
 501
 502         _deadline.async_wait (boost::bind (&Socket::check, this));
 503 }
 504
 505 /** Blocking connect with timeout.
 506  *  @param endpoint End-point to connect to.
 507  *  @param timeout Time-out in seconds.
 508  */
 509 void
 510 Socket::connect (asio::ip::basic_resolver_entry<asio::ip::tcp> const & endpoint, int timeout)
 511 {
 512         _deadline.expires_from_now (posix_time::seconds (timeout));
 513         system::error_code ec = asio::error::would_block;
 514         _socket.async_connect (endpoint, lambda::var(ec) = lambda::_1);
 515         do {
 516                 _io_service.run_one();
 517         } while (ec == asio::error::would_block);
 518
 519         if (ec || !_socket.is_open ()) {
 520                 throw NetworkError ("connect timed out");
 521         }
 522 }
 523
 524 /** Blocking write with timeout.
 525  *  @param data Buffer to write.
 526  *  @param size Number of bytes to write.
 527  *  @param timeout Time-out, in seconds.
 528  */
 529 void
 530 Socket::write (uint8_t const * data, int size, int timeout)
 531 {
 532         _deadline.expires_from_now (posix_time::seconds (timeout));
 533         system::error_code ec = asio::error::would_block;
 534
 535         asio::async_write (_socket, asio::buffer (data, size), lambda::var(ec) = lambda::_1);
 536         do {
 537                 _io_service.run_one ();
 538         } while (ec == asio::error::would_block);
 539
 540         if (ec) {
 541                 throw NetworkError ("write timed out");
 542         }
 543 }
 544
 545 /** Blocking read with timeout.
 546  *  @param data Buffer to read to.
 547  *  @param size Number of bytes to read.
 548  *  @param timeout Time-out, in seconds.
 549  */
 550 int
 551 Socket::read (uint8_t* data, int size, int timeout)
 552 {
 553         _deadline.expires_from_now (posix_time::seconds (timeout));
 554         system::error_code ec = asio::error::would_block;
 555
 556         int amount_read = 0;
 557
 558         _socket.async_read_some (
 559                 asio::buffer (data, size),
 560                 (lambda::var(ec) = lambda::_1, lambda::var(amount_read) = lambda::_2)
 561                 );
 562
 563         do {
 564                 _io_service.run_one ();
 565         } while (ec == asio::error::would_block);
 566
 567         if (ec) {
 568                 amount_read = 0;
 569         }
 570
 571         return amount_read;
 572 }
 573
 574 /** Mark some data as being `consumed', so that it will not be returned
 575  *  as data again.
 576  *  @param size Amount of data to consume, in bytes.
 577  */
 578 void
 579 Socket::consume (int size)
 580 {
 581         assert (_buffer_data >= size);
 582
 583         _buffer_data -= size;
 584         if (_buffer_data > 0) {
 585                 /* Shift still-valid data to the start of the buffer */
 586                 memmove (_buffer, _buffer + size, _buffer_data);
 587         }
 588 }
 589
 590 /** Read a definite amount of data from our socket, and mark
 591  *  it as consumed.
 592  *  @param data Where to put the data.
 593  *  @param size Number of bytes to read.
 594  */
 595 void
 596 Socket::read_definite_and_consume (uint8_t* data, int size, int timeout)
 597 {
 598         int const from_buffer = min (_buffer_data, size);
 599         if (from_buffer > 0) {
 600                 /* Get data from our buffer */
 601                 memcpy (data, _buffer, from_buffer);
 602                 consume (from_buffer);
 603                 /* Update our output state */
 604                 data += from_buffer;
 605                 size -= from_buffer;
 606         }
 607
 608         /* read() the rest */
 609         while (size > 0) {
 610                 int const n = read (data, size, timeout);
 611                 if (n <= 0) {
 612                         throw NetworkError ("could not read");
 613                 }
 614
 615                 data += n;
 616                 size -= n;
 617         }
 618 }
 619
 620 /** Read as much data as is available, up to some limit.
 621  *  @param data Where to put the data.
 622  *  @param size Maximum amount of data to read.
 623  */
 624 void
 625 Socket::read_indefinite (uint8_t* data, int size, int timeout)
 626 {
 627         assert (size < int (sizeof (_buffer)));
 628
 629         /* Amount of extra data we need to read () */
 630         int to_read = size - _buffer_data;
 631         while (to_read > 0) {
 632                 /* read as much of it as we can (into our buffer) */
 633                 int const n = read (_buffer + _buffer_data, to_read, timeout);
 634                 if (n <= 0) {
 635                         throw NetworkError ("could not read");
 636                 }
 637
 638                 to_read -= n;
 639                 _buffer_data += n;
 640         }
 641
 642         assert (_buffer_data >= size);
 643
 644         /* copy data into the output buffer */
 645         assert (size >= _buffer_data);
 646         memcpy (data, _buffer, size);
 647 }
 648
 649 /** @param other A Rect.
 650  *  @return The intersection of this with `other'.
 651  */
 652 Rect
 653 Rect::intersection (Rect const & other) const
 654 {
 655         int const tx = max (x, other.x);
 656         int const ty = max (y, other.y);
 657
 658         return Rect (
 659                 tx, ty,
 660                 min (x + width, other.x + other.width) - tx,
 661                 min (y + height, other.y + other.height) - ty
 662                 );
 663 }
 664
 665 /** Round a number up to the nearest multiple of another number.
 666  *  @param c Index.
 667  *  @param s Array of numbers to round, indexed by c.
 668  *  @param t Multiple to round to.
 669  *  @return Rounded number.
 670  */
 671 int
 672 stride_round_up (int c, int const * stride, int t)
 673 {
 674         int const a = stride[c] + (t - 1);
 675         return a - (a % t);
 676 }
 677
 678 int
 679 stride_lookup (int c, int const * stride)
 680 {
 681         return stride[c];
 682 }
 683
 684 /** Read a sequence of key / value pairs from a text stream;
 685  *  the keys are the first words on the line, and the values are
 686  *  the remainder of the line following the key.  Lines beginning
 687  *  with # are ignored.
 688  *  @param s Stream to read.
 689  *  @return key/value pairs.
 690  */
 691 multimap<string, string>
 692 read_key_value (istream &s)
 693 {
 694         multimap<string, string> kv;
 695
 696         string line;
 697         while (getline (s, line)) {
 698                 if (line.empty ()) {
 699                         continue;
 700                 }
 701
 702                 if (line[0] == '#') {
 703                         continue;
 704                 }
 705
 706                 if (line[line.size() - 1] == '\r') {
 707                         line = line.substr (0, line.size() - 1);
 708                 }
 709
 710                 size_t const s = line.find (' ');
 711                 if (s == string::npos) {
 712                         continue;
 713                 }
 714
 715                 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
 716         }
 717
 718         return kv;
 719 }
 720
 721 string
 722 get_required_string (multimap<string, string> const & kv, string k)
 723 {
 724         if (kv.count (k) > 1) {
 725                 throw StringError ("unexpected multiple keys in key-value set");
 726         }
 727
 728         multimap<string, string>::const_iterator i = kv.find (k);
 729
 730         if (i == kv.end ()) {
 731                 throw StringError (String::compose ("missing key %1 in key-value set", k));
 732         }
 733
 734         return i->second;
 735 }
 736
 737 int
 738 get_required_int (multimap<string, string> const & kv, string k)
 739 {
 740         string const v = get_required_string (kv, k);
 741         return lexical_cast<int> (v);
 742 }
 743
 744 float
 745 get_required_float (multimap<string, string> const & kv, string k)
 746 {
 747         string const v = get_required_string (kv, k);
 748         return lexical_cast<float> (v);
 749 }
 750
 751 string
 752 get_optional_string (multimap<string, string> const & kv, string k)
 753 {
 754         if (kv.count (k) > 1) {
 755                 throw StringError ("unexpected multiple keys in key-value set");
 756         }
 757
 758         multimap<string, string>::const_iterator i = kv.find (k);
 759         if (i == kv.end ()) {
 760                 return "";
 761         }
 762
 763         return i->second;
 764 }
 765
 766 int
 767 get_optional_int (multimap<string, string> const & kv, string k)
 768 {
 769         if (kv.count (k) > 1) {
 770                 throw StringError ("unexpected multiple keys in key-value set");
 771         }
 772
 773         multimap<string, string>::const_iterator i = kv.find (k);
 774         if (i == kv.end ()) {
 775                 return 0;
 776         }
 777
 778         return lexical_cast<int> (i->second);
 779 }
 780
 781 /** Construct an AudioBuffers.  Audio data is undefined after this constructor.
 782  *  @param channels Number of channels.
 783  *  @param frames Number of frames to reserve space for.
 784  */
 785 AudioBuffers::AudioBuffers (int channels, int frames)
 786         : _channels (channels)
 787         , _frames (frames)
 788         , _allocated_frames (frames)
 789 {
 790         _data = new float*[_channels];
 791         for (int i = 0; i < _channels; ++i) {
 792                 _data[i] = new float[frames];
 793         }
 794 }
 795
 796 /** Copy constructor.
 797  *  @param other Other AudioBuffers; data is copied.
 798  */
 799 AudioBuffers::AudioBuffers (AudioBuffers const & other)
 800         : _channels (other._channels)
 801         , _frames (other._frames)
 802         , _allocated_frames (other._frames)
 803 {
 804         _data = new float*[_channels];
 805         for (int i = 0; i < _channels; ++i) {
 806                 _data[i] = new float[_frames];
 807                 memcpy (_data[i], other._data[i], _frames * sizeof (float));
 808         }
 809 }
 810
 811 /** AudioBuffers destructor */
 812 AudioBuffers::~AudioBuffers ()
 813 {
 814         for (int i = 0; i < _channels; ++i) {
 815                 delete[] _data[i];
 816         }
 817
 818         delete[] _data;
 819 }
 820
 821 /** @param c Channel index.
 822  *  @return Buffer for this channel.
 823  */
 824 float*
 825 AudioBuffers::data (int c) const
 826 {
 827         assert (c >= 0 && c < _channels);
 828         return _data[c];
 829 }
 830
 831 /** Set the number of frames that these AudioBuffers will report themselves
 832  *  as having.
 833  *  @param f Frames; must be less than or equal to the number of allocated frames.
 834  */
 835 void
 836 AudioBuffers::set_frames (int f)
 837 {
 838         assert (f <= _allocated_frames);
 839         _frames = f;
 840 }
 841
 842 /** Make all samples on all channels silent */
 843 void
 844 AudioBuffers::make_silent ()
 845 {
 846         for (int i = 0; i < _channels; ++i) {
 847                 make_silent (i);
 848         }
 849 }
 850
 851 /** Make all samples on a given channel silent.
 852  *  @param c Channel.
 853  */
 854 void
 855 AudioBuffers::make_silent (int c)
 856 {
 857         assert (c >= 0 && c < _channels);
 858
 859         for (int i = 0; i < _frames; ++i) {
 860                 _data[c][i] = 0;
 861         }
 862 }
 863
 864 /** Copy data from another AudioBuffers to this one.  All channels are copied.
 865  *  @param from AudioBuffers to copy from; must have the same number of channels as this.
 866  *  @param frames_to_copy Number of frames to copy.
 867  *  @param read_offset Offset to read from in `from'.
 868  *  @param write_offset Offset to write to in `to'.
 869  */
 870 void
 871 AudioBuffers::copy_from (AudioBuffers* from, int frames_to_copy, int read_offset, int write_offset)
 872 {
 873         assert (from->channels() == channels());
 874
 875         assert (from);
 876         assert (read_offset >= 0 && (read_offset + frames_to_copy) <= from->_allocated_frames);
 877         assert (write_offset >= 0 && (write_offset + frames_to_copy) <= _allocated_frames);
 878
 879         for (int i = 0; i < _channels; ++i) {
 880                 memcpy (_data[i] + write_offset, from->_data[i] + read_offset, frames_to_copy * sizeof(float));
 881         }
 882 }
 883
 884 /** Move audio data around.
 885  *  @param from Offset to move from.
 886  *  @param to Offset to move to.
 887  *  @param frames Number of frames to move.
 888  */
 889
 890 void
 891 AudioBuffers::move (int from, int to, int frames)
 892 {
 893         if (frames == 0) {
 894                 return;
 895         }
 896
 897         assert (from >= 0);
 898         assert (from < _frames);
 899         assert (to >= 0);
 900         assert (to < _frames);
 901         assert (frames > 0);
 902         assert (frames <= _frames);
 903         assert ((from + frames) <= _frames);
 904         assert ((to + frames) <= _frames);
 905
 906         for (int i = 0; i < _channels; ++i) {
 907                 memmove (_data[i] + to, _data[i] + from, frames * sizeof(float));
 908         }
 909 }
 910
 911 /** Trip an assert if the caller is not in the UI thread */
 912 void
 913 ensure_ui_thread ()
 914 {
 915         assert (this_thread::get_id() == ui_thread);
 916 }
 917
 918 /** @param v Source video frame.
 919  *  @param audio_sample_rate Source audio sample rate.
 920  *  @param frames_per_second Number of video frames per second.
 921  *  @return Equivalent number of audio frames for `v'.
 922  */
 923 int64_t
 924 video_frames_to_audio_frames (SourceFrame v, float audio_sample_rate, float frames_per_second)
 925 {
 926         return ((int64_t) v * audio_sample_rate / frames_per_second);
 927 }
 928
 929 /** @param f Filename.
 930  *  @return true if this file is a still image, false if it is something else.
 931  */
 932 bool
 933 still_image_file (string f)
 934 {
 935 #if BOOST_FILESYSTEM_VERSION == 3
 936         string ext = boost::filesystem::path(f).extension().string();
 937 #else
 938         string ext = boost::filesystem::path(f).extension();
 939 #endif
 940
 941         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 942
 943         return (ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png");
 944 }
 945
 946 /** @return A pair containing CPU model name and the number of processors */
 947 pair<string, int>
 948 cpu_info ()
 949 {
 950         pair<string, int> info;
 951         info.second = 0;
 952
 953 #ifdef DVDOMATIC_POSIX
 954         ifstream f ("/proc/cpuinfo");
 955         while (f.good ()) {
 956                 string l;
 957                 getline (f, l);
 958                 if (boost::algorithm::starts_with (l, "model name")) {
 959                         string::size_type const c = l.find (':');
 960                         if (c != string::npos) {
 961                                 info.first = l.substr (c + 2);
 962                         }
 963                 } else if (boost::algorithm::starts_with (l, "processor")) {
 964                         ++info.second;
 965                 }
 966         }
 967 #endif
 968
 969         return info;
 970 }