2 Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
3 Copyright (C) 2000-2007 Paul Davis
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.
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.
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.
21 /** @file src/lib/util.cc
22 * @brief Some utility functions and classes.
29 #ifdef DVDOMATIC_POSIX
33 #include <libssh/libssh.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 <boost/filesystem.hpp>
42 #include <openssl/md5.h>
43 #include <magick/MagickCore.h>
44 #include <magick/version.h>
45 #include <libdcp/version.h>
46 #include <libdcp/util.h>
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>
56 #include "exceptions.h"
59 #include "dcp_content_type.h"
61 #include "sound_processor.h"
64 using namespace boost;
68 /** Convert some number of seconds to a string representation
69 * in hours, minutes and seconds.
72 * @return String of the form H:M:S (where H is hours, M
73 * is minutes and S is seconds).
76 seconds_to_hms (int s)
86 hms << setfill ('0') << m << ":";
88 hms << setfill ('0') << s;
93 /** @param s Number of seconds.
94 * @return String containing an approximate description of s (e.g. "about 2 hours")
97 seconds_to_approximate_hms (int s)
108 ap << (h + 1) << " hours";
120 ap << m << " minutes";
123 ap << s << " seconds";
129 #ifdef DVDOMATIC_POSIX
130 /** @param l Mangled C++ identifier.
131 * @return Demangled version.
136 string::size_type const b = l.find_first_of ("(");
137 if (b == string::npos) {
141 string::size_type const p = l.find_last_of ("+");
142 if (p == string::npos) {
150 string const fn = l.substr (b + 1, p - b - 1);
155 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
160 } catch (std::exception) {
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.
172 stacktrace (ostream& out, int levels)
179 size = backtrace (array, 200);
180 strings = backtrace_symbols (array, size);
183 for (i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
184 out << " " << demangle (strings[i]) << endl;
192 /** @param v Version as used by FFmpeg.
193 * @return A string representation of v.
196 ffmpeg_version_to_string (int v)
199 s << ((v & 0xff0000) >> 16) << "." << ((v & 0xff00) >> 8) << "." << (v & 0xff);
203 /** Return a user-readable string summarising the versions of our dependencies */
205 dependency_version_summary ()
208 s << "libopenjpeg " << opj_version () << ", "
209 << "libavcodec " << ffmpeg_version_to_string (avcodec_version()) << ", "
210 << "libavfilter " << ffmpeg_version_to_string (avfilter_version()) << ", "
211 << "libavformat " << ffmpeg_version_to_string (avformat_version()) << ", "
212 << "libavutil " << ffmpeg_version_to_string (avutil_version()) << ", "
213 << "libpostproc " << ffmpeg_version_to_string (postproc_version()) << ", "
214 << "libswscale " << ffmpeg_version_to_string (swscale_version()) << ", "
215 << MagickVersion << ", "
216 << "libssh " << ssh_version (0) << ", "
217 << "libdcp " << libdcp::version << " git " << libdcp::git_commit;
223 seconds (struct timeval t)
225 return t.tv_sec + (double (t.tv_usec) / 1e6);
228 /** Call the required functions to set up DVD-o-matic's static arrays, etc.
229 * Must be called from the UI thread, if there is one.
236 Format::setup_formats ();
237 DCPContentType::setup_dcp_content_types ();
238 Scaler::setup_scalers ();
239 Filter::setup_filters ();
240 SoundProcessor::setup_sound_processors ();
242 ui_thread = this_thread::get_id ();
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.
250 crop_string (Position start, Size size)
253 s << "crop=" << size.width << ":" << size.height << ":" << start.x << ":" << start.y;
257 /** @param s A string.
258 * @return Parts of the string split at spaces, except when a space is within quotation marks.
261 split_at_spaces_considering_quotes (string s)
264 bool in_quotes = false;
266 for (string::size_type i = 0; i < s.length(); ++i) {
267 if (s[i] == ' ' && !in_quotes) {
270 } else if (s[i] == '"') {
271 in_quotes = !in_quotes;
282 md5_digest (void const * data, int size)
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);
291 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
292 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
298 /** @param file File name.
299 * @return MD5 digest of file's contents.
302 md5_digest (string file)
304 ifstream f (file.c_str(), ios::binary);
306 throw OpenFileError (file);
309 f.seekg (0, ios::end);
310 int bytes = f.tellg ();
311 f.seekg (0, ios::beg);
313 int const buffer_size = 64 * 1024;
314 char buffer[buffer_size];
317 MD5_Init (&md5_context);
319 int const t = min (bytes, buffer_size);
321 MD5_Update (&md5_context, buffer, t);
325 unsigned char digest[MD5_DIGEST_LENGTH];
326 MD5_Final (digest, &md5_context);
329 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
330 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
336 /** @param fps Arbitrary frames-per-second value.
337 * @return DCPFrameRate for this frames-per-second.
340 dcp_frame_rate (float fps)
344 dfr.run_fast = (fps != rint (fps));
345 dfr.frames_per_second = rint (fps);
348 /* XXX: somewhat arbitrary */
350 dfr.frames_per_second = 25;
357 /** @param An arbitrary sampling rate.
358 * @return The appropriate DCP-approved sampling rate (48kHz or 96kHz).
361 dcp_audio_sample_rate (int fs)
371 dcp_audio_channels (int f)
374 /* The source is mono, so to put the mono channel into
375 the centre we need to generate a 5.1 soundtrack.
384 bool operator== (Size const & a, Size const & b)
386 return (a.width == b.width && a.height == b.height);
389 bool operator!= (Size const & a, Size const & b)
394 bool operator== (Crop const & a, Crop const & b)
396 return (a.left == b.left && a.right == b.right && a.top == b.top && a.bottom == b.bottom);
399 bool operator!= (Crop const & a, Crop const & b)
404 /** @param index Colour LUT index.
405 * @return Human-readable name.
408 colour_lut_index_to_name (int index)
422 : _deadline (_io_service)
423 , _socket (_io_service)
426 _deadline.expires_at (posix_time::pos_infin);
433 if (_deadline.expires_at() <= asio::deadline_timer::traits_type::now ()) {
435 _deadline.expires_at (posix_time::pos_infin);
438 _deadline.async_wait (boost::bind (&Socket::check, this));
441 /** Blocking connect with timeout.
442 * @param endpoint End-point to connect to.
443 * @param timeout Time-out in seconds.
446 Socket::connect (asio::ip::basic_resolver_entry<asio::ip::tcp> const & endpoint, int timeout)
448 _deadline.expires_from_now (posix_time::seconds (timeout));
449 system::error_code ec = asio::error::would_block;
450 _socket.async_connect (endpoint, lambda::var(ec) = lambda::_1);
452 _io_service.run_one();
453 } while (ec == asio::error::would_block);
455 if (ec || !_socket.is_open ()) {
456 throw NetworkError ("connect timed out");
460 /** Blocking write with timeout.
461 * @param data Buffer to write.
462 * @param size Number of bytes to write.
463 * @param timeout Time-out, in seconds.
466 Socket::write (uint8_t const * data, int size, int timeout)
468 _deadline.expires_from_now (posix_time::seconds (timeout));
469 system::error_code ec = asio::error::would_block;
471 asio::async_write (_socket, asio::buffer (data, size), lambda::var(ec) = lambda::_1);
473 _io_service.run_one ();
474 } while (ec == asio::error::would_block);
477 throw NetworkError ("write timed out");
481 /** Blocking read with timeout.
482 * @param data Buffer to read to.
483 * @param size Number of bytes to read.
484 * @param timeout Time-out, in seconds.
487 Socket::read (uint8_t* data, int size, int timeout)
489 _deadline.expires_from_now (posix_time::seconds (timeout));
490 system::error_code ec = asio::error::would_block;
494 _socket.async_read_some (
495 asio::buffer (data, size),
496 (lambda::var(ec) = lambda::_1, lambda::var(amount_read) = lambda::_2)
500 _io_service.run_one ();
501 } while (ec == asio::error::would_block);
510 /** Mark some data as being `consumed', so that it will not be returned
512 * @param size Amount of data to consume, in bytes.
515 Socket::consume (int size)
517 assert (_buffer_data >= size);
519 _buffer_data -= size;
520 if (_buffer_data > 0) {
521 /* Shift still-valid data to the start of the buffer */
522 memmove (_buffer, _buffer + size, _buffer_data);
526 /** Read a definite amount of data from our socket, and mark
528 * @param data Where to put the data.
529 * @param size Number of bytes to read.
532 Socket::read_definite_and_consume (uint8_t* data, int size, int timeout)
534 int const from_buffer = min (_buffer_data, size);
535 if (from_buffer > 0) {
536 /* Get data from our buffer */
537 memcpy (data, _buffer, from_buffer);
538 consume (from_buffer);
539 /* Update our output state */
544 /* read() the rest */
546 int const n = read (data, size, timeout);
548 throw NetworkError ("could not read");
556 /** Read as much data as is available, up to some limit.
557 * @param data Where to put the data.
558 * @param size Maximum amount of data to read.
561 Socket::read_indefinite (uint8_t* data, int size, int timeout)
563 assert (size < int (sizeof (_buffer)));
565 /* Amount of extra data we need to read () */
566 int to_read = size - _buffer_data;
567 while (to_read > 0) {
568 /* read as much of it as we can (into our buffer) */
569 int const n = read (_buffer + _buffer_data, to_read, timeout);
571 throw NetworkError ("could not read");
578 assert (_buffer_data >= size);
580 /* copy data into the output buffer */
581 assert (size >= _buffer_data);
582 memcpy (data, _buffer, size);
585 /** @param other A Rect.
586 * @return The intersection of this with `other'.
589 Rect::intersection (Rect const & other) const
591 int const tx = max (x, other.x);
592 int const ty = max (y, other.y);
596 min (x + width, other.x + other.width) - tx,
597 min (y + height, other.y + other.height) - ty
601 /** Round a number up to the nearest multiple of another number.
603 * @param s Array of numbers to round, indexed by c.
604 * @param t Multiple to round to.
605 * @return Rounded number.
608 stride_round_up (int c, int const * stride, int t)
610 int const a = stride[c] + (t - 1);
615 stride_lookup (int c, int const * stride)
620 /** Read a sequence of key / value pairs from a text stream;
621 * the keys are the first words on the line, and the values are
622 * the remainder of the line following the key. Lines beginning
623 * with # are ignored.
624 * @param s Stream to read.
625 * @return key/value pairs.
627 multimap<string, string>
628 read_key_value (istream &s)
630 multimap<string, string> kv;
633 while (getline (s, line)) {
638 if (line[0] == '#') {
642 if (line[line.size() - 1] == '\r') {
643 line = line.substr (0, line.size() - 1);
646 size_t const s = line.find (' ');
647 if (s == string::npos) {
651 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
658 get_required_string (multimap<string, string> const & kv, string k)
660 if (kv.count (k) > 1) {
661 throw StringError ("unexpected multiple keys in key-value set");
664 multimap<string, string>::const_iterator i = kv.find (k);
666 if (i == kv.end ()) {
667 throw StringError (String::compose ("missing key %1 in key-value set", k));
674 get_required_int (multimap<string, string> const & kv, string k)
676 string const v = get_required_string (kv, k);
677 return lexical_cast<int> (v);
681 get_required_float (multimap<string, string> const & kv, string k)
683 string const v = get_required_string (kv, k);
684 return lexical_cast<float> (v);
688 get_optional_string (multimap<string, string> const & kv, string k)
690 if (kv.count (k) > 1) {
691 throw StringError ("unexpected multiple keys in key-value set");
694 multimap<string, string>::const_iterator i = kv.find (k);
695 if (i == kv.end ()) {
703 get_optional_int (multimap<string, string> const & kv, string k)
705 if (kv.count (k) > 1) {
706 throw StringError ("unexpected multiple keys in key-value set");
709 multimap<string, string>::const_iterator i = kv.find (k);
710 if (i == kv.end ()) {
714 return lexical_cast<int> (i->second);
717 /** Construct an AudioBuffers. Audio data is undefined after this constructor.
718 * @param channels Number of channels.
719 * @param frames Number of frames to reserve space for.
721 AudioBuffers::AudioBuffers (int channels, int frames)
722 : _channels (channels)
724 , _allocated_frames (frames)
726 _data = new float*[_channels];
727 for (int i = 0; i < _channels; ++i) {
728 _data[i] = new float[frames];
732 /** Copy constructor.
733 * @param other Other AudioBuffers; data is copied.
735 AudioBuffers::AudioBuffers (AudioBuffers const & other)
736 : _channels (other._channels)
737 , _frames (other._frames)
738 , _allocated_frames (other._frames)
740 _data = new float*[_channels];
741 for (int i = 0; i < _channels; ++i) {
742 _data[i] = new float[_frames];
743 memcpy (_data[i], other._data[i], _frames * sizeof (float));
747 /** AudioBuffers destructor */
748 AudioBuffers::~AudioBuffers ()
750 for (int i = 0; i < _channels; ++i) {
757 /** @param c Channel index.
758 * @return Buffer for this channel.
761 AudioBuffers::data (int c) const
763 assert (c >= 0 && c < _channels);
767 /** Set the number of frames that these AudioBuffers will report themselves
769 * @param f Frames; must be less than or equal to the number of allocated frames.
772 AudioBuffers::set_frames (int f)
774 assert (f <= _allocated_frames);
778 /** Make all samples on all channels silent */
780 AudioBuffers::make_silent ()
782 for (int i = 0; i < _channels; ++i) {
787 /** Make all samples on a given channel silent.
791 AudioBuffers::make_silent (int c)
793 assert (c >= 0 && c < _channels);
795 for (int i = 0; i < _frames; ++i) {
800 /** Copy data from another AudioBuffers to this one. All channels are copied.
801 * @param from AudioBuffers to copy from; must have the same number of channels as this.
802 * @param frames_to_copy Number of frames to copy.
803 * @param read_offset Offset to read from in `from'.
804 * @param write_offset Offset to write to in `to'.
807 AudioBuffers::copy_from (AudioBuffers* from, int frames_to_copy, int read_offset, int write_offset)
809 assert (from->channels() == channels());
812 assert (read_offset >= 0 && (read_offset + frames_to_copy) <= from->_allocated_frames);
813 assert (write_offset >= 0 && (write_offset + frames_to_copy) <= _allocated_frames);
815 for (int i = 0; i < _channels; ++i) {
816 memcpy (_data[i] + write_offset, from->_data[i] + read_offset, frames_to_copy * sizeof(float));
820 /** Move audio data around.
821 * @param from Offset to move from.
822 * @param to Offset to move to.
823 * @param frames Number of frames to move.
827 AudioBuffers::move (int from, int to, int frames)
834 assert (from < _frames);
836 assert (to < _frames);
838 assert (frames <= _frames);
839 assert ((from + frames) <= _frames);
840 assert ((to + frames) <= _frames);
842 for (int i = 0; i < _channels; ++i) {
843 memmove (_data[i] + to, _data[i] + from, frames * sizeof(float));
847 /** Trip an assert if the caller is not in the UI thread */
851 assert (this_thread::get_id() == ui_thread);
854 /** @param v Source video frame.
855 * @param audio_sample_rate Source audio sample rate.
856 * @param frames_per_second Number of video frames per second.
857 * @return Equivalent number of audio frames for `v'.
860 video_frames_to_audio_frames (SourceFrame v, float audio_sample_rate, float frames_per_second)
862 return ((int64_t) v * audio_sample_rate / frames_per_second);
865 /** @param f Filename.
866 * @return true if this file is a still image, false if it is something else.
869 still_image_file (string f)
871 #if BOOST_FILESYSTEM_VERSION == 3
872 string ext = boost::filesystem::path(f).extension().string();
874 string ext = boost::filesystem::path(f).extension();
877 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
879 return (ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png");
882 /** @return A pair containing CPU model name and the number of processors */
886 pair<string, int> info;
889 #ifdef DVDOMATIC_POSIX
890 ifstream f ("/proc/cpuinfo");
894 if (boost::algorithm::starts_with (l, "model name")) {
895 string::size_type const c = l.find (':');
896 if (c != string::npos) {
897 info.first = l.substr (c + 2);
899 } else if (boost::algorithm::starts_with (l, "processor")) {