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 DCPOMATIC_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 std::stringstream;
81 using std::numeric_limits;
83 using boost::shared_ptr;
85 using boost::lexical_cast;
86 using boost::optional;
89 boost::thread::id ui_thread;
91 /** Convert some number of seconds to a string representation
92 * in hours, minutes and seconds.
95 * @return String of the form H:M:S (where H is hours, M
96 * is minutes and S is seconds).
99 seconds_to_hms (int s)
109 hms << std::setfill ('0') << m << N_(":");
111 hms << std::setfill ('0') << s;
116 /** @param s Number of seconds.
117 * @return String containing an approximate description of s (e.g. "about 2 hours")
120 seconds_to_approximate_hms (int s)
131 ap << (h + 1) << N_(" ") << _("hours");
134 ap << N_("1 ") << _("hour");
136 ap << h << N_(" ") << _("hours");
141 ap << N_("1 ") << _("minute");
143 ap << m << N_(" ") << _("minutes");
146 ap << s << N_(" ") << _("seconds");
152 #ifdef DCPOMATIC_POSIX
153 /** @param l Mangled C++ identifier.
154 * @return Demangled version.
159 string::size_type const b = l.find_first_of (N_("("));
160 if (b == string::npos) {
164 string::size_type const p = l.find_last_of (N_("+"));
165 if (p == string::npos) {
173 string const fn = l.substr (b + 1, p - b - 1);
178 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
183 } catch (std::exception) {
190 /** Write a stacktrace to an ostream.
191 * @param out Stream to write to.
192 * @param levels Number of levels to go up the call stack.
195 stacktrace (ostream& out, int levels)
202 size = backtrace (array, 200);
203 strings = backtrace_symbols (array, size);
206 for (i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
207 out << N_(" ") << demangle (strings[i]) << "\n";
215 /** @param v Version as used by FFmpeg.
216 * @return A string representation of v.
219 ffmpeg_version_to_string (int v)
222 s << ((v & 0xff0000) >> 16) << N_(".") << ((v & 0xff00) >> 8) << N_(".") << (v & 0xff);
226 /** Return a user-readable string summarising the versions of our dependencies */
228 dependency_version_summary ()
231 s << N_("libopenjpeg ") << opj_version () << N_(", ")
232 << N_("libavcodec ") << ffmpeg_version_to_string (avcodec_version()) << N_(", ")
233 << N_("libavfilter ") << ffmpeg_version_to_string (avfilter_version()) << N_(", ")
234 << N_("libavformat ") << ffmpeg_version_to_string (avformat_version()) << N_(", ")
235 << N_("libavutil ") << ffmpeg_version_to_string (avutil_version()) << N_(", ")
236 << N_("libpostproc ") << ffmpeg_version_to_string (postproc_version()) << N_(", ")
237 << N_("libswscale ") << ffmpeg_version_to_string (swscale_version()) << N_(", ")
238 << MagickVersion << N_(", ")
239 << N_("libssh ") << ssh_version (0) << N_(", ")
240 << N_("libdcp ") << libdcp::version << N_(" git ") << libdcp::git_commit;
246 seconds (struct timeval t)
248 return t.tv_sec + (double (t.tv_usec) / 1e6);
251 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
252 * Must be called from the UI thread, if there is one.
257 avfilter_register_all ();
259 Format::setup_formats ();
260 DCPContentType::setup_dcp_content_types ();
261 Scaler::setup_scalers ();
262 Filter::setup_filters ();
263 SoundProcessor::setup_sound_processors ();
265 ui_thread = boost::this_thread::get_id ();
268 #ifdef DCPOMATIC_WINDOWS
269 boost::filesystem::path
273 GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
274 boost::filesystem::path p (buffer);
275 p = p.parent_path ();
276 p = p.parent_path ();
283 dcpomatic_setup_i18n (string lang)
285 #ifdef DCPOMATIC_POSIX
289 if (!lang.empty ()) {
290 /* Override our environment language; this is essential on
294 snprintf (cmd, sizeof(cmd), "LANGUAGE=%s", lang.c_str ());
296 snprintf (cmd, sizeof(cmd), "LANG=%s", lang.c_str ());
300 setlocale (LC_ALL, "");
301 textdomain ("libdcpomatic");
303 #ifdef DCPOMATIC_WINDOWS
304 bindtextdomain ("libdcpomatic", mo_path().string().c_str());
305 bind_textdomain_codeset ("libdcpomatic", "UTF8");
308 #ifdef DCPOMATIC_POSIX
309 bindtextdomain ("libdcpomatic", POSIX_LOCALE_PREFIX);
313 /** @param start Start position for the crop within the image.
314 * @param size Size of the cropped area.
315 * @return FFmpeg crop filter string.
318 crop_string (Position start, libdcp::Size size)
321 s << N_("crop=") << size.width << N_(":") << size.height << N_(":") << start.x << N_(":") << start.y;
325 /** @param s A string.
326 * @return Parts of the string split at spaces, except when a space is within quotation marks.
329 split_at_spaces_considering_quotes (string s)
332 bool in_quotes = false;
334 for (string::size_type i = 0; i < s.length(); ++i) {
335 if (s[i] == ' ' && !in_quotes) {
338 } else if (s[i] == '"') {
339 in_quotes = !in_quotes;
350 md5_digest (void const * data, int size)
353 MD5_Init (&md5_context);
354 MD5_Update (&md5_context, data, size);
355 unsigned char digest[MD5_DIGEST_LENGTH];
356 MD5_Final (digest, &md5_context);
359 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
360 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
366 /** @param file File name.
367 * @return MD5 digest of file's contents.
370 md5_digest (boost::filesystem::path file)
372 ifstream f (file.string().c_str(), std::ios::binary);
374 throw OpenFileError (file.string());
377 f.seekg (0, std::ios::end);
378 int bytes = f.tellg ();
379 f.seekg (0, std::ios::beg);
381 int const buffer_size = 64 * 1024;
382 char buffer[buffer_size];
385 MD5_Init (&md5_context);
387 int const t = min (bytes, buffer_size);
389 MD5_Update (&md5_context, buffer, t);
393 unsigned char digest[MD5_DIGEST_LENGTH];
394 MD5_Final (digest, &md5_context);
397 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
398 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
405 about_equal (float a, float b)
407 /* A film of F seconds at f FPS will be Ff frames;
408 Consider some delta FPS d, so if we run the same
409 film at (f + d) FPS it will last F(f + d) seconds.
411 Hence the difference in length over the length of the film will
412 be F(f + d) - Ff frames
413 = Ff + Fd - Ff frames
417 So if we accept a difference of 1 frame, ie 1/f seconds, we can
424 So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
425 FPS error is 1/F ~= 0.0001 ~= 10-e4
428 return (fabs (a - b) < 1e-4);
431 class FrameRateCandidate
434 FrameRateCandidate (float source_, int dcp_)
444 best_dcp_frame_rate (float source_fps)
446 list<int> const allowed_dcp_frame_rates = Config::instance()->allowed_dcp_frame_rates ();
448 /* Work out what rates we could manage, including those achieved by using skip / repeat. */
449 list<FrameRateCandidate> candidates;
451 /* Start with the ones without skip / repeat so they will get matched in preference to skipped/repeated ones */
452 for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
453 candidates.push_back (FrameRateCandidate (*i, *i));
456 /* Then the skip/repeat ones */
457 for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
458 candidates.push_back (FrameRateCandidate (float (*i) / 2, *i));
459 candidates.push_back (FrameRateCandidate (float (*i) * 2, *i));
462 /* Pick the best one, bailing early if we hit an exact match */
463 float error = std::numeric_limits<float>::max ();
464 optional<FrameRateCandidate> best;
465 list<FrameRateCandidate>::iterator i = candidates.begin();
466 while (i != candidates.end()) {
468 if (about_equal (i->source, source_fps)) {
473 float const e = fabs (i->source - source_fps);
486 /** @param An arbitrary sampling rate.
487 * @return The appropriate DCP-approved sampling rate (48kHz or 96kHz).
490 dcp_audio_sample_rate (int fs)
499 /** @param index Colour LUT index.
500 * @return Human-readable name.
503 colour_lut_index_to_name (int index)
516 Socket::Socket (int timeout)
517 : _deadline (_io_service)
518 , _socket (_io_service)
521 _deadline.expires_at (boost::posix_time::pos_infin);
528 if (_deadline.expires_at() <= boost::asio::deadline_timer::traits_type::now ()) {
530 _deadline.expires_at (boost::posix_time::pos_infin);
533 _deadline.async_wait (boost::bind (&Socket::check, this));
536 /** Blocking connect.
537 * @param endpoint End-point to connect to.
540 Socket::connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint)
542 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
543 boost::system::error_code ec = boost::asio::error::would_block;
544 _socket.async_connect (endpoint, boost::lambda::var(ec) = boost::lambda::_1);
546 _io_service.run_one();
547 } while (ec == boost::asio::error::would_block);
549 if (ec || !_socket.is_open ()) {
550 throw NetworkError (_("connect timed out"));
555 * @param data Buffer to write.
556 * @param size Number of bytes to write.
559 Socket::write (uint8_t const * data, int size)
561 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
562 boost::system::error_code ec = boost::asio::error::would_block;
564 boost::asio::async_write (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
567 _io_service.run_one ();
568 } while (ec == boost::asio::error::would_block);
571 throw NetworkError (ec.message ());
576 Socket::write (uint32_t v)
579 write (reinterpret_cast<uint8_t*> (&v), 4);
583 * @param data Buffer to read to.
584 * @param size Number of bytes to read.
587 Socket::read (uint8_t* data, int size)
589 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
590 boost::system::error_code ec = boost::asio::error::would_block;
592 boost::asio::async_read (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
595 _io_service.run_one ();
596 } while (ec == boost::asio::error::would_block);
599 throw NetworkError (ec.message ());
604 Socket::read_uint32 ()
607 read (reinterpret_cast<uint8_t *> (&v), 4);
611 /** @param other A Rect.
612 * @return The intersection of this with `other'.
615 Rect::intersection (Rect const & other) const
617 int const tx = max (x, other.x);
618 int const ty = max (y, other.y);
622 min (x + width, other.x + other.width) - tx,
623 min (y + height, other.y + other.height) - ty
627 /** Round a number up to the nearest multiple of another number.
629 * @param s Array of numbers to round, indexed by c.
630 * @param t Multiple to round to.
631 * @return Rounded number.
634 stride_round_up (int c, int const * stride, int t)
636 int const a = stride[c] + (t - 1);
641 stride_lookup (int c, int const * stride)
646 /** Read a sequence of key / value pairs from a text stream;
647 * the keys are the first words on the line, and the values are
648 * the remainder of the line following the key. Lines beginning
649 * with # are ignored.
650 * @param s Stream to read.
651 * @return key/value pairs.
653 multimap<string, string>
654 read_key_value (istream &s)
656 multimap<string, string> kv;
659 while (getline (s, line)) {
664 if (line[0] == '#') {
668 if (line[line.size() - 1] == '\r') {
669 line = line.substr (0, line.size() - 1);
672 size_t const s = line.find (' ');
673 if (s == string::npos) {
677 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
684 get_required_string (multimap<string, string> const & kv, string k)
686 if (kv.count (k) > 1) {
687 throw StringError (N_("unexpected multiple keys in key-value set"));
690 multimap<string, string>::const_iterator i = kv.find (k);
692 if (i == kv.end ()) {
693 throw StringError (String::compose (_("missing key %1 in key-value set"), k));
700 get_required_int (multimap<string, string> const & kv, string k)
702 string const v = get_required_string (kv, k);
703 return lexical_cast<int> (v);
707 get_required_float (multimap<string, string> const & kv, string k)
709 string const v = get_required_string (kv, k);
710 return lexical_cast<float> (v);
714 get_optional_string (multimap<string, string> const & kv, string k)
716 if (kv.count (k) > 1) {
717 throw StringError (N_("unexpected multiple keys in key-value set"));
720 multimap<string, string>::const_iterator i = kv.find (k);
721 if (i == kv.end ()) {
729 get_optional_int (multimap<string, string> const & kv, string k)
731 if (kv.count (k) > 1) {
732 throw StringError (N_("unexpected multiple keys in key-value set"));
735 multimap<string, string>::const_iterator i = kv.find (k);
736 if (i == kv.end ()) {
740 return lexical_cast<int> (i->second);
743 /** Construct an AudioBuffers. Audio data is undefined after this constructor.
744 * @param channels Number of channels.
745 * @param frames Number of frames to reserve space for.
747 AudioBuffers::AudioBuffers (int channels, int frames)
748 : _channels (channels)
750 , _allocated_frames (frames)
752 _data = new float*[_channels];
753 for (int i = 0; i < _channels; ++i) {
754 _data[i] = new float[frames];
758 /** Copy constructor.
759 * @param other Other AudioBuffers; data is copied.
761 AudioBuffers::AudioBuffers (AudioBuffers const & other)
762 : _channels (other._channels)
763 , _frames (other._frames)
764 , _allocated_frames (other._frames)
766 _data = new float*[_channels];
767 for (int i = 0; i < _channels; ++i) {
768 _data[i] = new float[_frames];
769 memcpy (_data[i], other._data[i], _frames * sizeof (float));
773 /* XXX: it's a shame that this is a copy-and-paste of the above;
774 probably fixable with c++0x.
776 AudioBuffers::AudioBuffers (boost::shared_ptr<const AudioBuffers> other)
777 : _channels (other->_channels)
778 , _frames (other->_frames)
779 , _allocated_frames (other->_frames)
781 _data = new float*[_channels];
782 for (int i = 0; i < _channels; ++i) {
783 _data[i] = new float[_frames];
784 memcpy (_data[i], other->_data[i], _frames * sizeof (float));
788 /** AudioBuffers destructor */
789 AudioBuffers::~AudioBuffers ()
791 for (int i = 0; i < _channels; ++i) {
798 /** @param c Channel index.
799 * @return Buffer for this channel.
802 AudioBuffers::data (int c) const
804 assert (c >= 0 && c < _channels);
808 /** Set the number of frames that these AudioBuffers will report themselves
810 * @param f Frames; must be less than or equal to the number of allocated frames.
813 AudioBuffers::set_frames (int f)
815 assert (f <= _allocated_frames);
819 /** Make all samples on all channels silent */
821 AudioBuffers::make_silent ()
823 for (int i = 0; i < _channels; ++i) {
828 /** Make all samples on a given channel silent.
832 AudioBuffers::make_silent (int c)
834 assert (c >= 0 && c < _channels);
836 for (int i = 0; i < _frames; ++i) {
841 /** Copy data from another AudioBuffers to this one. All channels are copied.
842 * @param from AudioBuffers to copy from; must have the same number of channels as this.
843 * @param frames_to_copy Number of frames to copy.
844 * @param read_offset Offset to read from in `from'.
845 * @param write_offset Offset to write to in `to'.
848 AudioBuffers::copy_from (AudioBuffers* from, int frames_to_copy, int read_offset, int write_offset)
850 assert (from->channels() == channels());
853 assert (read_offset >= 0 && (read_offset + frames_to_copy) <= from->_allocated_frames);
854 assert (write_offset >= 0 && (write_offset + frames_to_copy) <= _allocated_frames);
856 for (int i = 0; i < _channels; ++i) {
857 memcpy (_data[i] + write_offset, from->_data[i] + read_offset, frames_to_copy * sizeof(float));
861 /** Move audio data around.
862 * @param from Offset to move from.
863 * @param to Offset to move to.
864 * @param frames Number of frames to move.
868 AudioBuffers::move (int from, int to, int frames)
875 assert (from < _frames);
877 assert (to < _frames);
879 assert (frames <= _frames);
880 assert ((from + frames) <= _frames);
881 assert ((to + frames) <= _frames);
883 for (int i = 0; i < _channels; ++i) {
884 memmove (_data[i] + to, _data[i] + from, frames * sizeof(float));
888 /** Add data from from `from', `from_channel' to our channel `to_channel' */
890 AudioBuffers::accumulate (shared_ptr<const AudioBuffers> from, int from_channel, int to_channel)
892 int const N = frames ();
893 assert (from->frames() == N);
895 float* s = from->data (from_channel);
896 float* d = _data[to_channel];
898 for (int i = 0; i < N; ++i) {
903 /** Trip an assert if the caller is not in the UI thread */
907 assert (boost::this_thread::get_id() == ui_thread);
910 /** @param v Content video frame.
911 * @param audio_sample_rate Source audio sample rate.
912 * @param frames_per_second Number of video frames per second.
913 * @return Equivalent number of audio frames for `v'.
916 video_frames_to_audio_frames (ContentVideoFrame v, float audio_sample_rate, float frames_per_second)
918 return ((int64_t) v * audio_sample_rate / frames_per_second);
921 /** @return A pair containing CPU model name and the number of processors */
925 pair<string, int> info;
928 #ifdef DCPOMATIC_POSIX
929 ifstream f (N_("/proc/cpuinfo"));
933 if (boost::algorithm::starts_with (l, N_("model name"))) {
934 string::size_type const c = l.find (':');
935 if (c != string::npos) {
936 info.first = l.substr (c + 2);
938 } else if (boost::algorithm::starts_with (l, N_("processor"))) {
948 audio_channel_name (int c)
950 assert (MAX_AUDIO_CHANNELS == 6);
952 /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
953 enhancement channel (sub-woofer)./
955 string const channels[] = {
967 FrameRateConversion::FrameRateConversion (float source, int dcp)
970 , change_speed (false)
972 if (fabs (source / 2.0 - dcp) < (fabs (source - dcp))) {
974 } else if (fabs (source * 2 - dcp) < fabs (source - dcp)) {
978 change_speed = !about_equal (source * factor(), dcp);
980 if (!skip && !repeat && !change_speed) {
981 description = _("DCP and source have the same rate.\n");
984 description = _("DCP will use every other frame of the source.\n");
986 description = _("Each source frame will be doubled in the DCP.\n");
990 float const pc = dcp * 100 / (source * factor());
991 description += String::compose (_("DCP will run at %1%% of the source speed.\n"), pc);
996 LocaleGuard::LocaleGuard ()
999 char const * old = setlocale (LC_NUMERIC, 0);
1002 _old = strdup (old);
1003 if (strcmp (_old, "POSIX")) {
1004 setlocale (LC_NUMERIC, "POSIX");
1009 LocaleGuard::~LocaleGuard ()
1011 setlocale (LC_NUMERIC, _old);