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"
67 using namespace boost;
72 /** Convert some number of seconds to a string representation
73 * in hours, minutes and seconds.
76 * @return String of the form H:M:S (where H is hours, M
77 * is minutes and S is seconds).
80 seconds_to_hms (int s)
90 hms << setfill ('0') << m << N_(":");
92 hms << setfill ('0') << s;
97 /** @param s Number of seconds.
98 * @return String containing an approximate description of s (e.g. "about 2 hours")
101 seconds_to_approximate_hms (int s)
112 ap << (h + 1) << N_(" ") << _("hours");
115 ap << N_("1 ") << _("hour");
117 ap << h << N_(" ") << _("hours");
122 ap << N_("1 ") << _("minute");
124 ap << m << N_(" ") << _("minutes");
127 ap << s << N_(" ") << _("seconds");
133 #ifdef DVDOMATIC_POSIX
134 /** @param l Mangled C++ identifier.
135 * @return Demangled version.
140 string::size_type const b = l.find_first_of (N_("("));
141 if (b == string::npos) {
145 string::size_type const p = l.find_last_of (N_("+"));
146 if (p == string::npos) {
154 string const fn = l.substr (b + 1, p - b - 1);
159 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
164 } catch (std::exception) {
171 /** Write a stacktrace to an ostream.
172 * @param out Stream to write to.
173 * @param levels Number of levels to go up the call stack.
176 stacktrace (ostream& out, int levels)
183 size = backtrace (array, 200);
184 strings = backtrace_symbols (array, size);
187 for (i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
188 out << N_(" ") << demangle (strings[i]) << endl;
196 /** @param v Version as used by FFmpeg.
197 * @return A string representation of v.
200 ffmpeg_version_to_string (int v)
203 s << ((v & 0xff0000) >> 16) << N_(".") << ((v & 0xff00) >> 8) << N_(".") << (v & 0xff);
207 /** Return a user-readable string summarising the versions of our dependencies */
209 dependency_version_summary ()
212 s << N_("libopenjpeg ") << opj_version () << N_(", ")
213 << N_("libavcodec ") << ffmpeg_version_to_string (avcodec_version()) << N_(", ")
214 << N_("libavfilter ") << ffmpeg_version_to_string (avfilter_version()) << N_(", ")
215 << N_("libavformat ") << ffmpeg_version_to_string (avformat_version()) << N_(", ")
216 << N_("libavutil ") << ffmpeg_version_to_string (avutil_version()) << N_(", ")
217 << N_("libpostproc ") << ffmpeg_version_to_string (postproc_version()) << N_(", ")
218 << N_("libswscale ") << ffmpeg_version_to_string (swscale_version()) << N_(", ")
219 << MagickVersion << N_(", ")
220 << N_("libssh ") << ssh_version (0) << N_(", ")
221 << N_("libdcp ") << libdcp::version << N_(" git ") << libdcp::git_commit;
227 seconds (struct timeval t)
229 return t.tv_sec + (double (t.tv_usec) / 1e6);
232 /** Call the required functions to set up DVD-o-matic's static arrays, etc.
233 * Must be called from the UI thread, if there is one.
238 bindtextdomain ("libdvdomatic", LOCALE_PREFIX);
239 setlocale (LC_ALL, "");
241 avfilter_register_all ();
243 Format::setup_formats ();
244 DCPContentType::setup_dcp_content_types ();
245 Scaler::setup_scalers ();
246 Filter::setup_filters ();
247 SoundProcessor::setup_sound_processors ();
249 ui_thread = this_thread::get_id ();
252 /** @param start Start position for the crop within the image.
253 * @param size Size of the cropped area.
254 * @return FFmpeg crop filter string.
257 crop_string (Position start, libdcp::Size size)
260 s << N_("crop=") << size.width << N_(":") << size.height << N_(":") << start.x << N_(":") << start.y;
264 /** @param s A string.
265 * @return Parts of the string split at spaces, except when a space is within quotation marks.
268 split_at_spaces_considering_quotes (string s)
271 bool in_quotes = false;
273 for (string::size_type i = 0; i < s.length(); ++i) {
274 if (s[i] == ' ' && !in_quotes) {
277 } else if (s[i] == '"') {
278 in_quotes = !in_quotes;
289 md5_digest (void const * data, int size)
292 MD5_Init (&md5_context);
293 MD5_Update (&md5_context, data, size);
294 unsigned char digest[MD5_DIGEST_LENGTH];
295 MD5_Final (digest, &md5_context);
298 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
299 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
305 /** @param file File name.
306 * @return MD5 digest of file's contents.
309 md5_digest (string file)
311 ifstream f (file.c_str(), ios::binary);
313 throw OpenFileError (file);
316 f.seekg (0, ios::end);
317 int bytes = f.tellg ();
318 f.seekg (0, ios::beg);
320 int const buffer_size = 64 * 1024;
321 char buffer[buffer_size];
324 MD5_Init (&md5_context);
326 int const t = min (bytes, buffer_size);
328 MD5_Update (&md5_context, buffer, t);
332 unsigned char digest[MD5_DIGEST_LENGTH];
333 MD5_Final (digest, &md5_context);
336 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
337 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
344 about_equal (float a, float b)
346 /* A film of F seconds at f FPS will be Ff frames;
347 Consider some delta FPS d, so if we run the same
348 film at (f + d) FPS it will last F(f + d) seconds.
350 Hence the difference in length over the length of the film will
351 be F(f + d) - Ff frames
352 = Ff + Fd - Ff frames
356 So if we accept a difference of 1 frame, ie 1/f seconds, we can
363 So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
364 FPS error is 1/F ~= 0.0001 ~= 10-e4
367 return (fabs (a - b) < 1e-4);
370 class FrameRateCandidate
373 FrameRateCandidate (float source_, int dcp_)
379 return !about_equal (source, dcp) && source > dcp;
382 bool repeat () const {
383 return !about_equal (source, dcp) && source < dcp;
390 /** @param fps Arbitrary source frames-per-second value */
391 /** XXX: this could be slow-ish */
392 DCPFrameRate::DCPFrameRate (float source_fps)
394 list<int> const allowed_dcp_frame_rates = Config::instance()->allowed_dcp_frame_rates ();
396 /* Work out what rates we could manage, including those achieved by using skip / repeat. */
397 list<FrameRateCandidate> candidates;
399 /* Start with the ones without skip / repeat so they will get matched in preference to skipped/repeated 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 (*i, *i));
404 /* Then the skip/repeat ones */
405 for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
406 candidates.push_back (FrameRateCandidate (float (*i) / 2, *i));
407 candidates.push_back (FrameRateCandidate (float (*i) * 2, *i));
410 /* Pick the best one, bailing early if we hit an exact match */
411 float error = numeric_limits<float>::max ();
412 boost::optional<FrameRateCandidate> best;
413 list<FrameRateCandidate>::iterator i = candidates.begin();
414 while (i != candidates.end()) {
416 if (about_equal (i->source, source_fps)) {
421 float const e = fabs (i->source - source_fps);
431 throw EncodeError (_("cannot find a suitable DCP frame rate for this source"));
434 frames_per_second = best->dcp;
435 skip = best->skip ();
436 repeat = best->repeat ();
437 change_speed = !about_equal (source_fps * factor(), frames_per_second);
440 /** @param An arbitrary sampling rate.
441 * @return The appropriate DCP-approved sampling rate (48kHz or 96kHz).
444 dcp_audio_sample_rate (int fs)
453 bool operator== (Crop const & a, Crop const & b)
455 return (a.left == b.left && a.right == b.right && a.top == b.top && a.bottom == b.bottom);
458 bool operator!= (Crop const & a, Crop const & b)
463 /** @param index Colour LUT index.
464 * @return Human-readable name.
467 colour_lut_index_to_name (int index)
480 Socket::Socket (int timeout)
481 : _deadline (_io_service)
482 , _socket (_io_service)
485 _deadline.expires_at (posix_time::pos_infin);
492 if (_deadline.expires_at() <= asio::deadline_timer::traits_type::now ()) {
494 _deadline.expires_at (posix_time::pos_infin);
497 _deadline.async_wait (boost::bind (&Socket::check, this));
500 /** Blocking connect.
501 * @param endpoint End-point to connect to.
504 Socket::connect (asio::ip::basic_resolver_entry<asio::ip::tcp> const & endpoint)
506 _deadline.expires_from_now (posix_time::seconds (_timeout));
507 system::error_code ec = asio::error::would_block;
508 _socket.async_connect (endpoint, lambda::var(ec) = lambda::_1);
510 _io_service.run_one();
511 } while (ec == asio::error::would_block);
513 if (ec || !_socket.is_open ()) {
514 throw NetworkError (_("connect timed out"));
519 * @param data Buffer to write.
520 * @param size Number of bytes to write.
523 Socket::write (uint8_t const * data, int size)
525 _deadline.expires_from_now (posix_time::seconds (_timeout));
526 system::error_code ec = asio::error::would_block;
528 asio::async_write (_socket, asio::buffer (data, size), lambda::var(ec) = lambda::_1);
531 _io_service.run_one ();
532 } while (ec == asio::error::would_block);
535 throw NetworkError (ec.message ());
540 Socket::write (uint32_t v)
543 write (reinterpret_cast<uint8_t*> (&v), 4);
547 * @param data Buffer to read to.
548 * @param size Number of bytes to read.
551 Socket::read (uint8_t* data, int size)
553 _deadline.expires_from_now (posix_time::seconds (_timeout));
554 system::error_code ec = asio::error::would_block;
556 asio::async_read (_socket, asio::buffer (data, size), lambda::var(ec) = lambda::_1);
559 _io_service.run_one ();
560 } while (ec == asio::error::would_block);
563 throw NetworkError (ec.message ());
568 Socket::read_uint32 ()
571 read (reinterpret_cast<uint8_t *> (&v), 4);
575 /** @param other A Rect.
576 * @return The intersection of this with `other'.
579 Rect::intersection (Rect const & other) const
581 int const tx = max (x, other.x);
582 int const ty = max (y, other.y);
586 min (x + width, other.x + other.width) - tx,
587 min (y + height, other.y + other.height) - ty
591 /** Round a number up to the nearest multiple of another number.
593 * @param s Array of numbers to round, indexed by c.
594 * @param t Multiple to round to.
595 * @return Rounded number.
598 stride_round_up (int c, int const * stride, int t)
600 int const a = stride[c] + (t - 1);
605 stride_lookup (int c, int const * stride)
610 /** Read a sequence of key / value pairs from a text stream;
611 * the keys are the first words on the line, and the values are
612 * the remainder of the line following the key. Lines beginning
613 * with # are ignored.
614 * @param s Stream to read.
615 * @return key/value pairs.
617 multimap<string, string>
618 read_key_value (istream &s)
620 multimap<string, string> kv;
623 while (getline (s, line)) {
628 if (line[0] == '#') {
632 if (line[line.size() - 1] == '\r') {
633 line = line.substr (0, line.size() - 1);
636 size_t const s = line.find (' ');
637 if (s == string::npos) {
641 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
648 get_required_string (multimap<string, string> const & kv, string k)
650 if (kv.count (k) > 1) {
651 throw StringError (N_("unexpected multiple keys in key-value set"));
654 multimap<string, string>::const_iterator i = kv.find (k);
656 if (i == kv.end ()) {
657 throw StringError (String::compose (_("missing key %1 in key-value set"), k));
664 get_required_int (multimap<string, string> const & kv, string k)
666 string const v = get_required_string (kv, k);
667 return lexical_cast<int> (v);
671 get_required_float (multimap<string, string> const & kv, string k)
673 string const v = get_required_string (kv, k);
674 return lexical_cast<float> (v);
678 get_optional_string (multimap<string, string> const & kv, string k)
680 if (kv.count (k) > 1) {
681 throw StringError (N_("unexpected multiple keys in key-value set"));
684 multimap<string, string>::const_iterator i = kv.find (k);
685 if (i == kv.end ()) {
693 get_optional_int (multimap<string, string> const & kv, string k)
695 if (kv.count (k) > 1) {
696 throw StringError (N_("unexpected multiple keys in key-value set"));
699 multimap<string, string>::const_iterator i = kv.find (k);
700 if (i == kv.end ()) {
704 return lexical_cast<int> (i->second);
707 /** Construct an AudioBuffers. Audio data is undefined after this constructor.
708 * @param channels Number of channels.
709 * @param frames Number of frames to reserve space for.
711 AudioBuffers::AudioBuffers (int channels, int frames)
712 : _channels (channels)
714 , _allocated_frames (frames)
716 _data = new float*[_channels];
717 for (int i = 0; i < _channels; ++i) {
718 _data[i] = new float[frames];
722 /** Copy constructor.
723 * @param other Other AudioBuffers; data is copied.
725 AudioBuffers::AudioBuffers (AudioBuffers const & other)
726 : _channels (other._channels)
727 , _frames (other._frames)
728 , _allocated_frames (other._frames)
730 _data = new float*[_channels];
731 for (int i = 0; i < _channels; ++i) {
732 _data[i] = new float[_frames];
733 memcpy (_data[i], other._data[i], _frames * sizeof (float));
737 /** AudioBuffers destructor */
738 AudioBuffers::~AudioBuffers ()
740 for (int i = 0; i < _channels; ++i) {
747 /** @param c Channel index.
748 * @return Buffer for this channel.
751 AudioBuffers::data (int c) const
753 assert (c >= 0 && c < _channels);
757 /** Set the number of frames that these AudioBuffers will report themselves
759 * @param f Frames; must be less than or equal to the number of allocated frames.
762 AudioBuffers::set_frames (int f)
764 assert (f <= _allocated_frames);
768 /** Make all samples on all channels silent */
770 AudioBuffers::make_silent ()
772 for (int i = 0; i < _channels; ++i) {
777 /** Make all samples on a given channel silent.
781 AudioBuffers::make_silent (int c)
783 assert (c >= 0 && c < _channels);
785 for (int i = 0; i < _frames; ++i) {
790 /** Copy data from another AudioBuffers to this one. All channels are copied.
791 * @param from AudioBuffers to copy from; must have the same number of channels as this.
792 * @param frames_to_copy Number of frames to copy.
793 * @param read_offset Offset to read from in `from'.
794 * @param write_offset Offset to write to in `to'.
797 AudioBuffers::copy_from (AudioBuffers* from, int frames_to_copy, int read_offset, int write_offset)
799 assert (from->channels() == channels());
802 assert (read_offset >= 0 && (read_offset + frames_to_copy) <= from->_allocated_frames);
803 assert (write_offset >= 0 && (write_offset + frames_to_copy) <= _allocated_frames);
805 for (int i = 0; i < _channels; ++i) {
806 memcpy (_data[i] + write_offset, from->_data[i] + read_offset, frames_to_copy * sizeof(float));
810 /** Move audio data around.
811 * @param from Offset to move from.
812 * @param to Offset to move to.
813 * @param frames Number of frames to move.
817 AudioBuffers::move (int from, int to, int frames)
824 assert (from < _frames);
826 assert (to < _frames);
828 assert (frames <= _frames);
829 assert ((from + frames) <= _frames);
830 assert ((to + frames) <= _frames);
832 for (int i = 0; i < _channels; ++i) {
833 memmove (_data[i] + to, _data[i] + from, frames * sizeof(float));
837 /** Trip an assert if the caller is not in the UI thread */
841 assert (this_thread::get_id() == ui_thread);
844 /** @param v Source video frame.
845 * @param audio_sample_rate Source audio sample rate.
846 * @param frames_per_second Number of video frames per second.
847 * @return Equivalent number of audio frames for `v'.
850 video_frames_to_audio_frames (SourceFrame v, float audio_sample_rate, float frames_per_second)
852 return ((int64_t) v * audio_sample_rate / frames_per_second);
855 /** @param f Filename.
856 * @return true if this file is a still image, false if it is something else.
859 still_image_file (string f)
861 string ext = boost::filesystem::path(f).extension().string();
863 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
865 return (ext == N_(".tif") || ext == N_(".tiff") || ext == N_(".jpg") || ext == N_(".jpeg") || ext == N_(".png") || ext == N_(".bmp"));
868 /** @return A pair containing CPU model name and the number of processors */
872 pair<string, int> info;
875 #ifdef DVDOMATIC_POSIX
876 ifstream f (N_("/proc/cpuinfo"));
880 if (boost::algorithm::starts_with (l, N_("model name"))) {
881 string::size_type const c = l.find (':');
882 if (c != string::npos) {
883 info.first = l.substr (c + 2);
885 } else if (boost::algorithm::starts_with (l, N_("processor"))) {
895 audio_channel_name (int c)
897 assert (MAX_AUDIO_CHANNELS == 6);
899 /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
900 enhancement channel (sub-woofer)./
902 string const channels[] = {
914 AudioMapping::AudioMapping (int c)
915 : _source_channels (c)
920 optional<libdcp::Channel>
921 AudioMapping::source_to_dcp (int c) const
923 if (c >= _source_channels) {
924 return optional<libdcp::Channel> ();
927 if (_source_channels == 1) {
928 /* mono sources to centre */
929 return libdcp::CENTRE;
932 return static_cast<libdcp::Channel> (c);
936 AudioMapping::dcp_to_source (libdcp::Channel c) const
938 if (_source_channels == 1) {
939 if (c == libdcp::CENTRE) {
942 return optional<int> ();
946 if (static_cast<int> (c) >= _source_channels) {
947 return optional<int> ();
950 return static_cast<int> (c);
954 AudioMapping::dcp_channels () const
956 if (_source_channels == 1) {
957 /* The source is mono, so to put the mono channel into
958 the centre we need to generate a 5.1 soundtrack.
963 return _source_channels;