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.
30 #ifdef DVDOMATIC_POSIX
34 #include <libssh/libssh.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>
43 #include <openssl/md5.h>
44 #include <magick/MagickCore.h>
45 #include <magick/version.h>
46 #include <libdcp/version.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"
65 using namespace boost;
70 /** Convert some number of seconds to a string representation
71 * in hours, minutes and seconds.
74 * @return String of the form H:M:S (where H is hours, M
75 * is minutes and S is seconds).
78 seconds_to_hms (int s)
88 hms << setfill ('0') << m << ":";
90 hms << setfill ('0') << s;
95 /** @param s Number of seconds.
96 * @return String containing an approximate description of s (e.g. "about 2 hours")
99 seconds_to_approximate_hms (int s)
110 ap << (h + 1) << " hours";
122 ap << m << " minutes";
125 ap << s << " seconds";
131 #ifdef DVDOMATIC_POSIX
132 /** @param l Mangled C++ identifier.
133 * @return Demangled version.
138 string::size_type const b = l.find_first_of ("(");
139 if (b == string::npos) {
143 string::size_type const p = l.find_last_of ("+");
144 if (p == string::npos) {
152 string const fn = l.substr (b + 1, p - b - 1);
157 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
162 } catch (std::exception) {
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.
174 stacktrace (ostream& out, int levels)
181 size = backtrace (array, 200);
182 strings = backtrace_symbols (array, size);
185 for (i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
186 out << " " << demangle (strings[i]) << endl;
194 /** @param v Version as used by FFmpeg.
195 * @return A string representation of v.
198 ffmpeg_version_to_string (int v)
201 s << ((v & 0xff0000) >> 16) << "." << ((v & 0xff00) >> 8) << "." << (v & 0xff);
205 /** Return a user-readable string summarising the versions of our dependencies */
207 dependency_version_summary ()
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;
225 seconds (struct timeval t)
227 return t.tv_sec + (double (t.tv_usec) / 1e6);
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.
236 avfilter_register_all ();
238 Format::setup_formats ();
239 DCPContentType::setup_dcp_content_types ();
240 Scaler::setup_scalers ();
241 Filter::setup_filters ();
242 SoundProcessor::setup_sound_processors ();
244 ui_thread = this_thread::get_id ();
247 /** @param start Start position for the crop within the image.
248 * @param size Size of the cropped area.
249 * @return FFmpeg crop filter string.
252 crop_string (Position start, libdcp::Size size)
255 s << "crop=" << size.width << ":" << size.height << ":" << start.x << ":" << start.y;
259 /** @param s A string.
260 * @return Parts of the string split at spaces, except when a space is within quotation marks.
263 split_at_spaces_considering_quotes (string s)
266 bool in_quotes = false;
268 for (string::size_type i = 0; i < s.length(); ++i) {
269 if (s[i] == ' ' && !in_quotes) {
272 } else if (s[i] == '"') {
273 in_quotes = !in_quotes;
284 md5_digest (void const * data, int size)
287 MD5_Init (&md5_context);
288 MD5_Update (&md5_context, data, size);
289 unsigned char digest[MD5_DIGEST_LENGTH];
290 MD5_Final (digest, &md5_context);
293 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
294 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
300 /** @param file File name.
301 * @return MD5 digest of file's contents.
304 md5_digest (string file)
306 ifstream f (file.c_str(), ios::binary);
308 throw OpenFileError (file);
311 f.seekg (0, ios::end);
312 int bytes = f.tellg ();
313 f.seekg (0, ios::beg);
315 int const buffer_size = 64 * 1024;
316 char buffer[buffer_size];
319 MD5_Init (&md5_context);
321 int const t = min (bytes, buffer_size);
323 MD5_Update (&md5_context, buffer, t);
327 unsigned char digest[MD5_DIGEST_LENGTH];
328 MD5_Final (digest, &md5_context);
331 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
332 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
339 about_equal (float a, float b)
341 /* A film of F seconds at f FPS will be Ff frames;
342 Consider some delta FPS d, so if we run the same
343 film at (f + d) FPS it will last F(f + d) seconds.
345 Hence the difference in length over the length of the film will
346 be F(f + d) - Ff frames
347 = Ff + Fd - Ff frames
351 So if we accept a difference of 1 frame, ie 1/f seconds, we can
358 So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
359 FPS error is 1/F ~= 0.0001 ~= 10-e4
362 return (fabs (a - b) < 1e-4);
365 class FrameRateCandidate
368 FrameRateCandidate (float source_, int dcp_)
374 return !about_equal (source, dcp) && source > dcp;
377 bool repeat () const {
378 return !about_equal (source, dcp) && source < dcp;
385 /** @param fps Arbitrary source frames-per-second value */
386 /** XXX: this could be slow-ish */
387 DCPFrameRate::DCPFrameRate (float source_fps)
389 list<int> const allowed_dcp_frame_rates = Config::instance()->allowed_dcp_frame_rates ();
391 /* Work out what rates we could manage, including those achieved by using skip / repeat. */
392 list<FrameRateCandidate> candidates;
394 /* Start with the ones without skip / repeat so they will get matched in preference to skipped/repeated ones */
395 for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
396 candidates.push_back (FrameRateCandidate (*i, *i));
399 /* Then the skip/repeat ones */
400 for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
401 candidates.push_back (FrameRateCandidate (float (*i) / 2, *i));
402 candidates.push_back (FrameRateCandidate (float (*i) * 2, *i));
405 /* Pick the best one, bailing early if we hit an exact match */
406 float error = numeric_limits<float>::max ();
407 boost::optional<FrameRateCandidate> best;
408 list<FrameRateCandidate>::iterator i = candidates.begin();
409 while (i != candidates.end()) {
411 if (about_equal (i->source, source_fps)) {
416 float const e = fabs (i->source - source_fps);
426 throw EncodeError ("cannot find a suitable DCP frame rate for this source");
429 frames_per_second = best->dcp;
430 skip = best->skip ();
431 repeat = best->repeat ();
432 change_speed = !about_equal (source_fps * factor(), frames_per_second);
435 /** @param An arbitrary sampling rate.
436 * @return The appropriate DCP-approved sampling rate (48kHz or 96kHz).
439 dcp_audio_sample_rate (int fs)
448 bool operator== (Crop const & a, Crop const & b)
450 return (a.left == b.left && a.right == b.right && a.top == b.top && a.bottom == b.bottom);
453 bool operator!= (Crop const & a, Crop const & b)
458 /** @param index Colour LUT index.
459 * @return Human-readable name.
462 colour_lut_index_to_name (int index)
475 Socket::Socket (int timeout)
476 : _deadline (_io_service)
477 , _socket (_io_service)
480 _deadline.expires_at (posix_time::pos_infin);
487 if (_deadline.expires_at() <= asio::deadline_timer::traits_type::now ()) {
489 _deadline.expires_at (posix_time::pos_infin);
492 _deadline.async_wait (boost::bind (&Socket::check, this));
495 /** Blocking connect.
496 * @param endpoint End-point to connect to.
499 Socket::connect (asio::ip::basic_resolver_entry<asio::ip::tcp> const & endpoint)
501 _deadline.expires_from_now (posix_time::seconds (_timeout));
502 system::error_code ec = asio::error::would_block;
503 _socket.async_connect (endpoint, lambda::var(ec) = lambda::_1);
505 _io_service.run_one();
506 } while (ec == asio::error::would_block);
508 if (ec || !_socket.is_open ()) {
509 throw NetworkError ("connect timed out");
514 * @param data Buffer to write.
515 * @param size Number of bytes to write.
518 Socket::write (uint8_t const * data, int size)
520 _deadline.expires_from_now (posix_time::seconds (_timeout));
521 system::error_code ec = asio::error::would_block;
523 asio::async_write (_socket, asio::buffer (data, size), lambda::var(ec) = lambda::_1);
526 _io_service.run_one ();
527 } while (ec == asio::error::would_block);
530 throw NetworkError (ec.message ());
535 Socket::write (uint32_t v)
538 write (reinterpret_cast<uint8_t*> (&v), 4);
542 * @param data Buffer to read to.
543 * @param size Number of bytes to read.
546 Socket::read (uint8_t* data, int size)
548 _deadline.expires_from_now (posix_time::seconds (_timeout));
549 system::error_code ec = asio::error::would_block;
551 asio::async_read (_socket, asio::buffer (data, size), lambda::var(ec) = lambda::_1);
554 _io_service.run_one ();
555 } while (ec == asio::error::would_block);
558 throw NetworkError (ec.message ());
563 Socket::read_uint32 ()
566 read (reinterpret_cast<uint8_t *> (&v), 4);
570 /** @param other A Rect.
571 * @return The intersection of this with `other'.
574 Rect::intersection (Rect const & other) const
576 int const tx = max (x, other.x);
577 int const ty = max (y, other.y);
581 min (x + width, other.x + other.width) - tx,
582 min (y + height, other.y + other.height) - ty
586 /** Round a number up to the nearest multiple of another number.
588 * @param s Array of numbers to round, indexed by c.
589 * @param t Multiple to round to.
590 * @return Rounded number.
593 stride_round_up (int c, int const * stride, int t)
595 int const a = stride[c] + (t - 1);
600 stride_lookup (int c, int const * stride)
605 /** Read a sequence of key / value pairs from a text stream;
606 * the keys are the first words on the line, and the values are
607 * the remainder of the line following the key. Lines beginning
608 * with # are ignored.
609 * @param s Stream to read.
610 * @return key/value pairs.
612 multimap<string, string>
613 read_key_value (istream &s)
615 multimap<string, string> kv;
618 while (getline (s, line)) {
623 if (line[0] == '#') {
627 if (line[line.size() - 1] == '\r') {
628 line = line.substr (0, line.size() - 1);
631 size_t const s = line.find (' ');
632 if (s == string::npos) {
636 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
643 get_required_string (multimap<string, string> const & kv, string k)
645 if (kv.count (k) > 1) {
646 throw StringError ("unexpected multiple keys in key-value set");
649 multimap<string, string>::const_iterator i = kv.find (k);
651 if (i == kv.end ()) {
652 throw StringError (String::compose ("missing key %1 in key-value set", k));
659 get_required_int (multimap<string, string> const & kv, string k)
661 string const v = get_required_string (kv, k);
662 return lexical_cast<int> (v);
666 get_required_float (multimap<string, string> const & kv, string k)
668 string const v = get_required_string (kv, k);
669 return lexical_cast<float> (v);
673 get_optional_string (multimap<string, string> const & kv, string k)
675 if (kv.count (k) > 1) {
676 throw StringError ("unexpected multiple keys in key-value set");
679 multimap<string, string>::const_iterator i = kv.find (k);
680 if (i == kv.end ()) {
688 get_optional_int (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 ()) {
699 return lexical_cast<int> (i->second);
702 /** Construct an AudioBuffers. Audio data is undefined after this constructor.
703 * @param channels Number of channels.
704 * @param frames Number of frames to reserve space for.
706 AudioBuffers::AudioBuffers (int channels, int frames)
707 : _channels (channels)
709 , _allocated_frames (frames)
711 _data = new float*[_channels];
712 for (int i = 0; i < _channels; ++i) {
713 _data[i] = new float[frames];
717 /** Copy constructor.
718 * @param other Other AudioBuffers; data is copied.
720 AudioBuffers::AudioBuffers (AudioBuffers const & other)
721 : _channels (other._channels)
722 , _frames (other._frames)
723 , _allocated_frames (other._frames)
725 _data = new float*[_channels];
726 for (int i = 0; i < _channels; ++i) {
727 _data[i] = new float[_frames];
728 memcpy (_data[i], other._data[i], _frames * sizeof (float));
732 /** AudioBuffers destructor */
733 AudioBuffers::~AudioBuffers ()
735 for (int i = 0; i < _channels; ++i) {
742 /** @param c Channel index.
743 * @return Buffer for this channel.
746 AudioBuffers::data (int c) const
748 assert (c >= 0 && c < _channels);
752 /** Set the number of frames that these AudioBuffers will report themselves
754 * @param f Frames; must be less than or equal to the number of allocated frames.
757 AudioBuffers::set_frames (int f)
759 assert (f <= _allocated_frames);
763 /** Make all samples on all channels silent */
765 AudioBuffers::make_silent ()
767 for (int i = 0; i < _channels; ++i) {
772 /** Make all samples on a given channel silent.
776 AudioBuffers::make_silent (int c)
778 assert (c >= 0 && c < _channels);
780 for (int i = 0; i < _frames; ++i) {
785 /** Copy data from another AudioBuffers to this one. All channels are copied.
786 * @param from AudioBuffers to copy from; must have the same number of channels as this.
787 * @param frames_to_copy Number of frames to copy.
788 * @param read_offset Offset to read from in `from'.
789 * @param write_offset Offset to write to in `to'.
792 AudioBuffers::copy_from (AudioBuffers* from, int frames_to_copy, int read_offset, int write_offset)
794 assert (from->channels() == channels());
797 assert (read_offset >= 0 && (read_offset + frames_to_copy) <= from->_allocated_frames);
798 assert (write_offset >= 0 && (write_offset + frames_to_copy) <= _allocated_frames);
800 for (int i = 0; i < _channels; ++i) {
801 memcpy (_data[i] + write_offset, from->_data[i] + read_offset, frames_to_copy * sizeof(float));
805 /** Move audio data around.
806 * @param from Offset to move from.
807 * @param to Offset to move to.
808 * @param frames Number of frames to move.
812 AudioBuffers::move (int from, int to, int frames)
819 assert (from < _frames);
821 assert (to < _frames);
823 assert (frames <= _frames);
824 assert ((from + frames) <= _frames);
825 assert ((to + frames) <= _frames);
827 for (int i = 0; i < _channels; ++i) {
828 memmove (_data[i] + to, _data[i] + from, frames * sizeof(float));
832 /** Trip an assert if the caller is not in the UI thread */
836 assert (this_thread::get_id() == ui_thread);
839 /** @param v Source video frame.
840 * @param audio_sample_rate Source audio sample rate.
841 * @param frames_per_second Number of video frames per second.
842 * @return Equivalent number of audio frames for `v'.
845 video_frames_to_audio_frames (SourceFrame v, float audio_sample_rate, float frames_per_second)
847 return ((int64_t) v * audio_sample_rate / frames_per_second);
850 /** @param f Filename.
851 * @return true if this file is a still image, false if it is something else.
854 still_image_file (string f)
856 string ext = boost::filesystem::path(f).extension().string();
858 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
860 return (ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png" || ext == ".bmp");
863 /** @return A pair containing CPU model name and the number of processors */
867 pair<string, int> info;
870 #ifdef DVDOMATIC_POSIX
871 ifstream f ("/proc/cpuinfo");
875 if (boost::algorithm::starts_with (l, "model name")) {
876 string::size_type const c = l.find (':');
877 if (c != string::npos) {
878 info.first = l.substr (c + 2);
880 } else if (boost::algorithm::starts_with (l, "processor")) {
890 audio_channel_name (int c)
892 assert (MAX_AUDIO_CHANNELS == 6);
894 /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
895 enhancement channel (sub-woofer)./
897 string const channels[] = {
909 AudioMapping::AudioMapping (int c)
910 : _source_channels (c)
915 optional<libdcp::Channel>
916 AudioMapping::source_to_dcp (int c) const
918 if (c >= _source_channels) {
919 return optional<libdcp::Channel> ();
922 if (_source_channels == 1) {
923 /* mono sources to centre */
924 return libdcp::CENTRE;
927 return static_cast<libdcp::Channel> (c);
931 AudioMapping::dcp_to_source (libdcp::Channel c) const
933 if (_source_channels == 1) {
934 if (c == libdcp::CENTRE) {
937 return optional<int> ();
941 if (static_cast<int> (c) >= _source_channels) {
942 return optional<int> ();
945 return static_cast<int> (c);
949 AudioMapping::dcp_channels () const
951 if (_source_channels == 1) {
952 /* The source is mono, so to put the mono channel into
953 the centre we need to generate a 5.1 soundtrack.
958 return _source_channels;