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]);
338 static bool about_equal (float a, float b)
340 /* A film of F seconds at f FPS will be Ff frames;
341 Consider some delta FPS d, so if we run the same
342 film at (f + d) FPS it will last F(f + d) seconds.
344 Hence the difference in length over the length of the film will
345 be F(f + d) - Ff frames
346 = Ff + Fd - Ff frames
350 So if we accept a difference of 1 frame, ie 1/f seconds, we can
357 So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
358 FPS error is 1/F ~= 0.0001 ~= 10-e4
361 return (fabs (a - b) < 1e-4);
364 class FrameRateCandidate
367 FrameRateCandidate (float source_, int dcp_)
373 return !about_equal (source, dcp) && source > dcp;
376 bool repeat () const {
377 return !about_equal (source, dcp) && source < dcp;
384 /** @param fps Arbitrary source frames-per-second value */
385 /** XXX: this could be slow-ish */
386 DCPFrameRate::DCPFrameRate (float source_fps)
388 list<int> const allowed_dcp_frame_rates = Config::instance()->allowed_dcp_frame_rates ();
390 /* Work out what rates we could manage, including those achieved by using skip / repeat. */
391 list<FrameRateCandidate> candidates;
393 /* Start with the ones without skip / repeat so they will get matched in preference to skipped/repeated ones */
394 for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
395 candidates.push_back (FrameRateCandidate (*i, *i));
398 /* Then the skip/repeat ones */
399 for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
400 candidates.push_back (FrameRateCandidate (float (*i) / 2, *i));
401 candidates.push_back (FrameRateCandidate (float (*i) * 2, *i));
404 /* Pick the best one, bailing early if we hit an exact match */
405 float error = numeric_limits<float>::max ();
406 boost::optional<FrameRateCandidate> best;
407 list<FrameRateCandidate>::iterator i = candidates.begin();
408 while (i != candidates.end()) {
410 if (about_equal (i->source, source_fps)) {
415 float const e = fabs (i->source - source_fps);
425 throw EncodeError ("cannot find a suitable DCP frame rate for this source");
428 frames_per_second = best->dcp;
429 skip = best->skip ();
430 repeat = best->repeat ();
431 change_speed = !about_equal (source_fps * factor(), frames_per_second);
434 /** @param An arbitrary sampling rate.
435 * @return The appropriate DCP-approved sampling rate (48kHz or 96kHz).
438 dcp_audio_sample_rate (int fs)
448 dcp_audio_channels (int f)
451 /* The source is mono, so to put the mono channel into
452 the centre we need to generate a 5.1 soundtrack.
460 bool operator== (Crop const & a, Crop const & b)
462 return (a.left == b.left && a.right == b.right && a.top == b.top && a.bottom == b.bottom);
465 bool operator!= (Crop const & a, Crop const & b)
470 /** @param index Colour LUT index.
471 * @return Human-readable name.
474 colour_lut_index_to_name (int index)
488 : _deadline (_io_service)
489 , _socket (_io_service)
492 _deadline.expires_at (posix_time::pos_infin);
499 if (_deadline.expires_at() <= asio::deadline_timer::traits_type::now ()) {
501 _deadline.expires_at (posix_time::pos_infin);
504 _deadline.async_wait (boost::bind (&Socket::check, this));
507 /** Blocking connect with timeout.
508 * @param endpoint End-point to connect to.
509 * @param timeout Time-out in seconds.
512 Socket::connect (asio::ip::basic_resolver_entry<asio::ip::tcp> const & endpoint, int timeout)
514 _deadline.expires_from_now (posix_time::seconds (timeout));
515 system::error_code ec = asio::error::would_block;
516 _socket.async_connect (endpoint, lambda::var(ec) = lambda::_1);
518 _io_service.run_one();
519 } while (ec == asio::error::would_block);
521 if (ec || !_socket.is_open ()) {
522 throw NetworkError ("connect timed out");
526 /** Blocking write with timeout.
527 * @param data Buffer to write.
528 * @param size Number of bytes to write.
529 * @param timeout Time-out, in seconds.
532 Socket::write (uint8_t const * data, int size, int timeout)
534 _deadline.expires_from_now (posix_time::seconds (timeout));
535 system::error_code ec = asio::error::would_block;
537 asio::async_write (_socket, asio::buffer (data, size), lambda::var(ec) = lambda::_1);
539 _io_service.run_one ();
540 } while (ec == asio::error::would_block);
543 throw NetworkError ("write timed out");
547 /** Blocking read with timeout.
548 * @param data Buffer to read to.
549 * @param size Number of bytes to read.
550 * @param timeout Time-out, in seconds.
553 Socket::read (uint8_t* data, int size, int timeout)
555 _deadline.expires_from_now (posix_time::seconds (timeout));
556 system::error_code ec = asio::error::would_block;
560 _socket.async_read_some (
561 asio::buffer (data, size),
562 (lambda::var(ec) = lambda::_1, lambda::var(amount_read) = lambda::_2)
566 _io_service.run_one ();
567 } while (ec == asio::error::would_block);
576 /** Mark some data as being `consumed', so that it will not be returned
578 * @param size Amount of data to consume, in bytes.
581 Socket::consume (int size)
583 assert (_buffer_data >= size);
585 _buffer_data -= size;
586 if (_buffer_data > 0) {
587 /* Shift still-valid data to the start of the buffer */
588 memmove (_buffer, _buffer + size, _buffer_data);
592 /** Read a definite amount of data from our socket, and mark
594 * @param data Where to put the data.
595 * @param size Number of bytes to read.
598 Socket::read_definite_and_consume (uint8_t* data, int size, int timeout)
600 int const from_buffer = min (_buffer_data, size);
601 if (from_buffer > 0) {
602 /* Get data from our buffer */
603 memcpy (data, _buffer, from_buffer);
604 consume (from_buffer);
605 /* Update our output state */
610 /* read() the rest */
612 int const n = read (data, size, timeout);
614 throw NetworkError ("could not read");
622 /** Read as much data as is available, up to some limit.
623 * @param data Where to put the data.
624 * @param size Maximum amount of data to read.
626 * XXX This method assumes that there is always lots of data to read();
627 * if there isn't, it will hang waiting for data that will never arrive.
630 Socket::read_indefinite (uint8_t* data, int size, int timeout)
632 assert (size < int (sizeof (_buffer)));
634 /* Amount of extra data we need to read () */
635 int to_read = size - _buffer_data;
636 while (to_read > 0) {
637 /* read as much of it as we can (into our buffer) */
638 int const n = read (_buffer + _buffer_data, to_read, timeout);
640 throw NetworkError ("could not read");
647 assert (_buffer_data >= size);
649 /* copy data into the output buffer */
650 assert (size >= _buffer_data);
651 memcpy (data, _buffer, size);
654 /** @param other A Rect.
655 * @return The intersection of this with `other'.
658 Rect::intersection (Rect const & other) const
660 int const tx = max (x, other.x);
661 int const ty = max (y, other.y);
665 min (x + width, other.x + other.width) - tx,
666 min (y + height, other.y + other.height) - ty
670 /** Round a number up to the nearest multiple of another number.
672 * @param s Array of numbers to round, indexed by c.
673 * @param t Multiple to round to.
674 * @return Rounded number.
677 stride_round_up (int c, int const * stride, int t)
679 int const a = stride[c] + (t - 1);
684 stride_lookup (int c, int const * stride)
689 /** Read a sequence of key / value pairs from a text stream;
690 * the keys are the first words on the line, and the values are
691 * the remainder of the line following the key. Lines beginning
692 * with # are ignored.
693 * @param s Stream to read.
694 * @return key/value pairs.
696 multimap<string, string>
697 read_key_value (istream &s)
699 multimap<string, string> kv;
702 while (getline (s, line)) {
707 if (line[0] == '#') {
711 if (line[line.size() - 1] == '\r') {
712 line = line.substr (0, line.size() - 1);
715 size_t const s = line.find (' ');
716 if (s == string::npos) {
720 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
727 get_required_string (multimap<string, string> const & kv, string k)
729 if (kv.count (k) > 1) {
730 throw StringError ("unexpected multiple keys in key-value set");
733 multimap<string, string>::const_iterator i = kv.find (k);
735 if (i == kv.end ()) {
736 throw StringError (String::compose ("missing key %1 in key-value set", k));
743 get_required_int (multimap<string, string> const & kv, string k)
745 string const v = get_required_string (kv, k);
746 return lexical_cast<int> (v);
750 get_required_float (multimap<string, string> const & kv, string k)
752 string const v = get_required_string (kv, k);
753 return lexical_cast<float> (v);
757 get_optional_string (multimap<string, string> const & kv, string k)
759 if (kv.count (k) > 1) {
760 throw StringError ("unexpected multiple keys in key-value set");
763 multimap<string, string>::const_iterator i = kv.find (k);
764 if (i == kv.end ()) {
772 get_optional_int (multimap<string, string> const & kv, string k)
774 if (kv.count (k) > 1) {
775 throw StringError ("unexpected multiple keys in key-value set");
778 multimap<string, string>::const_iterator i = kv.find (k);
779 if (i == kv.end ()) {
783 return lexical_cast<int> (i->second);
786 /** Construct an AudioBuffers. Audio data is undefined after this constructor.
787 * @param channels Number of channels.
788 * @param frames Number of frames to reserve space for.
790 AudioBuffers::AudioBuffers (int channels, int frames)
791 : _channels (channels)
793 , _allocated_frames (frames)
795 _data = new float*[_channels];
796 for (int i = 0; i < _channels; ++i) {
797 _data[i] = new float[frames];
801 /** Copy constructor.
802 * @param other Other AudioBuffers; data is copied.
804 AudioBuffers::AudioBuffers (AudioBuffers const & other)
805 : _channels (other._channels)
806 , _frames (other._frames)
807 , _allocated_frames (other._frames)
809 _data = new float*[_channels];
810 for (int i = 0; i < _channels; ++i) {
811 _data[i] = new float[_frames];
812 memcpy (_data[i], other._data[i], _frames * sizeof (float));
816 /** AudioBuffers destructor */
817 AudioBuffers::~AudioBuffers ()
819 for (int i = 0; i < _channels; ++i) {
826 /** @param c Channel index.
827 * @return Buffer for this channel.
830 AudioBuffers::data (int c) const
832 assert (c >= 0 && c < _channels);
836 /** Set the number of frames that these AudioBuffers will report themselves
838 * @param f Frames; must be less than or equal to the number of allocated frames.
841 AudioBuffers::set_frames (int f)
843 assert (f <= _allocated_frames);
847 /** Make all samples on all channels silent */
849 AudioBuffers::make_silent ()
851 for (int i = 0; i < _channels; ++i) {
856 /** Make all samples on a given channel silent.
860 AudioBuffers::make_silent (int c)
862 assert (c >= 0 && c < _channels);
864 for (int i = 0; i < _frames; ++i) {
869 /** Copy data from another AudioBuffers to this one. All channels are copied.
870 * @param from AudioBuffers to copy from; must have the same number of channels as this.
871 * @param frames_to_copy Number of frames to copy.
872 * @param read_offset Offset to read from in `from'.
873 * @param write_offset Offset to write to in `to'.
876 AudioBuffers::copy_from (AudioBuffers* from, int frames_to_copy, int read_offset, int write_offset)
878 assert (from->channels() == channels());
881 assert (read_offset >= 0 && (read_offset + frames_to_copy) <= from->_allocated_frames);
882 assert (write_offset >= 0 && (write_offset + frames_to_copy) <= _allocated_frames);
884 for (int i = 0; i < _channels; ++i) {
885 memcpy (_data[i] + write_offset, from->_data[i] + read_offset, frames_to_copy * sizeof(float));
889 /** Move audio data around.
890 * @param from Offset to move from.
891 * @param to Offset to move to.
892 * @param frames Number of frames to move.
896 AudioBuffers::move (int from, int to, int frames)
903 assert (from < _frames);
905 assert (to < _frames);
907 assert (frames <= _frames);
908 assert ((from + frames) <= _frames);
909 assert ((to + frames) <= _frames);
911 for (int i = 0; i < _channels; ++i) {
912 memmove (_data[i] + to, _data[i] + from, frames * sizeof(float));
916 /** Trip an assert if the caller is not in the UI thread */
920 assert (this_thread::get_id() == ui_thread);
923 /** @param v Source video frame.
924 * @param audio_sample_rate Source audio sample rate.
925 * @param frames_per_second Number of video frames per second.
926 * @return Equivalent number of audio frames for `v'.
929 video_frames_to_audio_frames (SourceFrame v, float audio_sample_rate, float frames_per_second)
931 return ((int64_t) v * audio_sample_rate / frames_per_second);
934 /** @param f Filename.
935 * @return true if this file is a still image, false if it is something else.
938 still_image_file (string f)
940 string ext = boost::filesystem::path(f).extension().string();
942 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
944 return (ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png");
947 /** @return A pair containing CPU model name and the number of processors */
951 pair<string, int> info;
954 #ifdef DVDOMATIC_POSIX
955 ifstream f ("/proc/cpuinfo");
959 if (boost::algorithm::starts_with (l, "model name")) {
960 string::size_type const c = l.find (':');
961 if (c != string::npos) {
962 info.first = l.substr (c + 2);
964 } else if (boost::algorithm::starts_with (l, "processor")) {