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>
47 #include <libavcodec/avcodec.h>
48 #include <libavformat/avformat.h>
49 #include <libswscale/swscale.h>
50 #include <libavfilter/avfiltergraph.h>
51 #include <libpostproc/postprocess.h>
52 #include <libavutil/pixfmt.h>
55 #include "exceptions.h"
58 #include "dcp_content_type.h"
60 #include "sound_processor.h"
63 using namespace boost;
67 /** Convert some number of seconds to a string representation
68 * in hours, minutes and seconds.
71 * @return String of the form H:M:S (where H is hours, M
72 * is minutes and S is seconds).
75 seconds_to_hms (int s)
85 hms << setfill ('0') << m << ":";
87 hms << setfill ('0') << s;
92 /** @param s Number of seconds.
93 * @return String containing an approximate description of s (e.g. "about 2 hours")
96 seconds_to_approximate_hms (int s)
107 ap << (h + 1) << " hours";
119 ap << m << " minutes";
122 ap << s << " seconds";
128 #ifdef DVDOMATIC_POSIX
129 /** @param l Mangled C++ identifier.
130 * @return Demangled version.
135 string::size_type const b = l.find_first_of ("(");
136 if (b == string::npos) {
140 string::size_type const p = l.find_last_of ("+");
141 if (p == string::npos) {
149 string const fn = l.substr (b + 1, p - b - 1);
154 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
159 } catch (std::exception) {
166 /** Write a stacktrace to an ostream.
167 * @param out Stream to write to.
168 * @param levels Number of levels to go up the call stack.
171 stacktrace (ostream& out, int levels)
178 size = backtrace (array, 200);
179 strings = backtrace_symbols (array, size);
182 for (i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
183 out << " " << demangle (strings[i]) << endl;
191 /** @param v Version as used by FFmpeg.
192 * @return A string representation of v.
195 ffmpeg_version_to_string (int v)
198 s << ((v & 0xff0000) >> 16) << "." << ((v & 0xff00) >> 8) << "." << (v & 0xff);
202 /** Return a user-readable string summarising the versions of our dependencies */
204 dependency_version_summary ()
207 s << "libopenjpeg " << opj_version () << ", "
208 << "libavcodec " << ffmpeg_version_to_string (avcodec_version()) << ", "
209 << "libavfilter " << ffmpeg_version_to_string (avfilter_version()) << ", "
210 << "libavformat " << ffmpeg_version_to_string (avformat_version()) << ", "
211 << "libavutil " << ffmpeg_version_to_string (avutil_version()) << ", "
212 << "libpostproc " << ffmpeg_version_to_string (postproc_version()) << ", "
213 << "libswscale " << ffmpeg_version_to_string (swscale_version()) << ", "
214 << MagickVersion << ", "
215 << "libssh " << ssh_version (0) << ", "
216 << "libdcp " << libdcp::version << " git " << libdcp::git_commit;
222 seconds (struct timeval t)
224 return t.tv_sec + (double (t.tv_usec) / 1e6);
227 /** Call the required functions to set up DVD-o-matic's static arrays, etc.
228 * Must be called from the UI thread, if there is one.
233 Format::setup_formats ();
234 DCPContentType::setup_dcp_content_types ();
235 Scaler::setup_scalers ();
236 Filter::setup_filters ();
237 SoundProcessor::setup_sound_processors ();
239 ui_thread = this_thread::get_id ();
242 /** @param start Start position for the crop within the image.
243 * @param size Size of the cropped area.
244 * @return FFmpeg crop filter string.
247 crop_string (Position start, Size size)
250 s << "crop=" << size.width << ":" << size.height << ":" << start.x << ":" << start.y;
254 /** @param s A string.
255 * @return Parts of the string split at spaces, except when a space is within quotation marks.
258 split_at_spaces_considering_quotes (string s)
261 bool in_quotes = false;
263 for (string::size_type i = 0; i < s.length(); ++i) {
264 if (s[i] == ' ' && !in_quotes) {
267 } else if (s[i] == '"') {
268 in_quotes = !in_quotes;
279 md5_digest (void const * data, int size)
282 MD5_Init (&md5_context);
283 MD5_Update (&md5_context, data, size);
284 unsigned char digest[MD5_DIGEST_LENGTH];
285 MD5_Final (digest, &md5_context);
288 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
289 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
295 /** @param file File name.
296 * @return MD5 digest of file's contents.
299 md5_digest (string file)
301 ifstream f (file.c_str(), ios::binary);
303 throw OpenFileError (file);
306 f.seekg (0, ios::end);
307 int bytes = f.tellg ();
308 f.seekg (0, ios::beg);
310 int const buffer_size = 64 * 1024;
311 char buffer[buffer_size];
314 MD5_Init (&md5_context);
316 int const t = min (bytes, buffer_size);
318 MD5_Update (&md5_context, buffer, t);
322 unsigned char digest[MD5_DIGEST_LENGTH];
323 MD5_Final (digest, &md5_context);
326 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
327 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
333 /** @param fps Arbitrary frames-per-second value.
334 * @return DCPFrameRate for this frames-per-second.
337 dcp_frame_rate (float fps)
341 dfr.run_fast = (fps != rint (fps));
342 dfr.frames_per_second = rint (fps);
345 /* XXX: somewhat arbitrary */
347 dfr.frames_per_second = 25;
354 /** @param An arbitrary sampling rate.
355 * @return The appropriate DCP-approved sampling rate (48kHz or 96kHz).
358 dcp_audio_sample_rate (int fs)
368 dcp_audio_channels (int f)
371 /* The source is mono, so to put the mono channel into
372 the centre we need to generate a 5.1 soundtrack.
381 bool operator== (Size const & a, Size const & b)
383 return (a.width == b.width && a.height == b.height);
386 bool operator!= (Size const & a, Size const & b)
391 bool operator== (Crop const & a, Crop const & b)
393 return (a.left == b.left && a.right == b.right && a.top == b.top && a.bottom == b.bottom);
396 bool operator!= (Crop const & a, Crop const & b)
401 /** @param index Colour LUT index.
402 * @return Human-readable name.
405 colour_lut_index_to_name (int index)
419 : _deadline (_io_service)
420 , _socket (_io_service)
423 _deadline.expires_at (posix_time::pos_infin);
430 if (_deadline.expires_at() <= asio::deadline_timer::traits_type::now ()) {
432 _deadline.expires_at (posix_time::pos_infin);
435 _deadline.async_wait (boost::bind (&Socket::check, this));
438 /** Blocking connect with timeout.
439 * @param endpoint End-point to connect to.
440 * @param timeout Time-out in seconds.
443 Socket::connect (asio::ip::basic_resolver_entry<asio::ip::tcp> const & endpoint, int timeout)
445 _deadline.expires_from_now (posix_time::seconds (timeout));
446 system::error_code ec = asio::error::would_block;
447 _socket.async_connect (endpoint, lambda::var(ec) = lambda::_1);
449 _io_service.run_one();
450 } while (ec == asio::error::would_block);
452 if (ec || !_socket.is_open ()) {
453 throw NetworkError ("connect timed out");
457 /** Blocking write with timeout.
458 * @param data Buffer to write.
459 * @param size Number of bytes to write.
460 * @param timeout Time-out, in seconds.
463 Socket::write (uint8_t const * data, int size, int timeout)
465 _deadline.expires_from_now (posix_time::seconds (timeout));
466 system::error_code ec = asio::error::would_block;
468 asio::async_write (_socket, asio::buffer (data, size), lambda::var(ec) = lambda::_1);
470 _io_service.run_one ();
471 } while (ec == asio::error::would_block);
474 throw NetworkError ("write timed out");
478 /** Blocking read with timeout.
479 * @param data Buffer to read to.
480 * @param size Number of bytes to read.
481 * @param timeout Time-out, in seconds.
484 Socket::read (uint8_t* data, int size, int timeout)
486 _deadline.expires_from_now (posix_time::seconds (timeout));
487 system::error_code ec = asio::error::would_block;
491 _socket.async_read_some (
492 asio::buffer (data, size),
493 (lambda::var(ec) = lambda::_1, lambda::var(amount_read) = lambda::_2)
497 _io_service.run_one ();
498 } while (ec == asio::error::would_block);
507 /** Mark some data as being `consumed', so that it will not be returned
509 * @param size Amount of data to consume, in bytes.
512 Socket::consume (int size)
514 assert (_buffer_data >= size);
516 _buffer_data -= size;
517 if (_buffer_data > 0) {
518 /* Shift still-valid data to the start of the buffer */
519 memmove (_buffer, _buffer + size, _buffer_data);
523 /** Read a definite amount of data from our socket, and mark
525 * @param data Where to put the data.
526 * @param size Number of bytes to read.
529 Socket::read_definite_and_consume (uint8_t* data, int size, int timeout)
531 int const from_buffer = min (_buffer_data, size);
532 if (from_buffer > 0) {
533 /* Get data from our buffer */
534 memcpy (data, _buffer, from_buffer);
535 consume (from_buffer);
536 /* Update our output state */
541 /* read() the rest */
543 int const n = read (data, size, timeout);
545 throw NetworkError ("could not read");
553 /** Read as much data as is available, up to some limit.
554 * @param data Where to put the data.
555 * @param size Maximum amount of data to read.
558 Socket::read_indefinite (uint8_t* data, int size, int timeout)
560 assert (size < int (sizeof (_buffer)));
562 /* Amount of extra data we need to read () */
563 int to_read = size - _buffer_data;
564 while (to_read > 0) {
565 /* read as much of it as we can (into our buffer) */
566 int const n = read (_buffer + _buffer_data, to_read, timeout);
568 throw NetworkError ("could not read");
575 assert (_buffer_data >= size);
577 /* copy data into the output buffer */
578 assert (size >= _buffer_data);
579 memcpy (data, _buffer, size);
582 /** @param other A Rect.
583 * @return The intersection of this with `other'.
586 Rect::intersection (Rect const & other) const
588 int const tx = max (x, other.x);
589 int const ty = max (y, other.y);
593 min (x + width, other.x + other.width) - tx,
594 min (y + height, other.y + other.height) - ty
598 /** Round a number up to the nearest multiple of another number.
600 * @param s Array of numbers to round, indexed by c.
601 * @param t Multiple to round to.
602 * @return Rounded number.
605 stride_round_up (int c, int const * stride, int t)
607 int const a = stride[c] + (t - 1);
612 stride_lookup (int c, int const * stride)
617 /** Read a sequence of key / value pairs from a text stream;
618 * the keys are the first words on the line, and the values are
619 * the remainder of the line following the key. Lines beginning
620 * with # are ignored.
621 * @param s Stream to read.
622 * @return key/value pairs.
624 multimap<string, string>
625 read_key_value (istream &s)
627 multimap<string, string> kv;
630 while (getline (s, line)) {
635 if (line[0] == '#') {
639 if (line[line.size() - 1] == '\r') {
640 line = line.substr (0, line.size() - 1);
643 size_t const s = line.find (' ');
644 if (s == string::npos) {
648 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
655 get_required_string (multimap<string, string> const & kv, string k)
657 if (kv.count (k) > 1) {
658 throw StringError ("unexpected multiple keys in key-value set");
661 multimap<string, string>::const_iterator i = kv.find (k);
663 if (i == kv.end ()) {
664 throw StringError (String::compose ("missing key %1 in key-value set", k));
671 get_required_int (multimap<string, string> const & kv, string k)
673 string const v = get_required_string (kv, k);
674 return lexical_cast<int> (v);
678 get_required_float (multimap<string, string> const & kv, string k)
680 string const v = get_required_string (kv, k);
681 return lexical_cast<float> (v);
685 get_optional_string (multimap<string, string> const & kv, string k)
687 if (kv.count (k) > 1) {
688 throw StringError ("unexpected multiple keys in key-value set");
691 multimap<string, string>::const_iterator i = kv.find (k);
692 if (i == kv.end ()) {
700 get_optional_int (multimap<string, string> const & kv, string k)
702 if (kv.count (k) > 1) {
703 throw StringError ("unexpected multiple keys in key-value set");
706 multimap<string, string>::const_iterator i = kv.find (k);
707 if (i == kv.end ()) {
711 return lexical_cast<int> (i->second);
714 /** Construct an AudioBuffers. Audio data is undefined after this constructor.
715 * @param channels Number of channels.
716 * @param frames Number of frames to reserve space for.
718 AudioBuffers::AudioBuffers (int channels, int frames)
719 : _channels (channels)
721 , _allocated_frames (frames)
723 _data = new float*[_channels];
724 for (int i = 0; i < _channels; ++i) {
725 _data[i] = new float[frames];
729 /** Copy constructor.
730 * @param other Other AudioBuffers; data is copied.
732 AudioBuffers::AudioBuffers (AudioBuffers const & other)
733 : _channels (other._channels)
734 , _frames (other._frames)
735 , _allocated_frames (other._frames)
737 _data = new float*[_channels];
738 for (int i = 0; i < _channels; ++i) {
739 _data[i] = new float[_frames];
740 memcpy (_data[i], other._data[i], _frames * sizeof (float));
744 /** AudioBuffers destructor */
745 AudioBuffers::~AudioBuffers ()
747 for (int i = 0; i < _channels; ++i) {
754 /** @param c Channel index.
755 * @return Buffer for this channel.
758 AudioBuffers::data (int c) const
760 assert (c >= 0 && c < _channels);
764 /** Set the number of frames that these AudioBuffers will report themselves
766 * @param f Frames; must be less than or equal to the number of allocated frames.
769 AudioBuffers::set_frames (int f)
771 assert (f <= _allocated_frames);
775 /** Make all samples on all channels silent */
777 AudioBuffers::make_silent ()
779 for (int i = 0; i < _channels; ++i) {
784 /** Make all samples on a given channel silent.
788 AudioBuffers::make_silent (int c)
790 assert (c >= 0 && c < _channels);
792 for (int i = 0; i < _frames; ++i) {
797 /** Copy data from another AudioBuffers to this one. All channels are copied.
798 * @param from AudioBuffers to copy from; must have the same number of channels as this.
799 * @param frames_to_copy Number of frames to copy.
800 * @param read_offset Offset to read from in `from'.
801 * @param write_offset Offset to write to in `to'.
804 AudioBuffers::copy_from (AudioBuffers* from, int frames_to_copy, int read_offset, int write_offset)
806 assert (from->channels() == channels());
809 assert (read_offset >= 0 && (read_offset + frames_to_copy) <= from->_allocated_frames);
810 assert (write_offset >= 0 && (write_offset + frames_to_copy) <= _allocated_frames);
812 for (int i = 0; i < _channels; ++i) {
813 memcpy (_data[i] + write_offset, from->_data[i] + read_offset, frames_to_copy * sizeof(float));
817 /** Move audio data around.
818 * @param from Offset to move from.
819 * @param to Offset to move to.
820 * @param frames Number of frames to move.
824 AudioBuffers::move (int from, int to, int frames)
831 assert (from < _frames);
833 assert (to < _frames);
835 assert (frames <= _frames);
836 assert ((from + frames) <= _frames);
837 assert ((to + frames) <= _frames);
839 for (int i = 0; i < _channels; ++i) {
840 memmove (_data[i] + to, _data[i] + from, frames * sizeof(float));
844 /** Trip an assert if the caller is not in the UI thread */
848 assert (this_thread::get_id() == ui_thread);
851 /** @param v Source video frame.
852 * @param audio_sample_rate Source audio sample rate.
853 * @param frames_per_second Number of video frames per second.
854 * @return Equivalent number of audio frames for `v'.
857 video_frames_to_audio_frames (SourceFrame v, float audio_sample_rate, float frames_per_second)
859 return ((int64_t) v * audio_sample_rate / frames_per_second);
862 /** @param f Filename.
863 * @return true if this file is a still image, false if it is something else.
866 still_image_file (string f)
868 #if BOOST_FILESYSTEM_VERSION == 3
869 string ext = boost::filesystem::path(f).extension().string();
871 string ext = boost::filesystem::path(f).extension();
874 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
876 return (ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png");