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>
44 #include <openssl/md5.h>
45 #include <magick/MagickCore.h>
46 #include <magick/version.h>
47 #include <libdcp/version.h>
49 #include <libavcodec/avcodec.h>
50 #include <libavformat/avformat.h>
51 #include <libswscale/swscale.h>
52 #include <libavfilter/avfiltergraph.h>
53 #include <libpostproc/postprocess.h>
54 #include <libavutil/pixfmt.h>
57 #include "exceptions.h"
60 #include "dcp_content_type.h"
62 #include "sound_processor.h"
65 #ifdef DVDOMATIC_WINDOWS
73 using std::stringstream;
84 using boost::shared_ptr;
85 using boost::lexical_cast;
86 using boost::optional;
89 boost::thread::id ui_thread;
90 boost::filesystem::path backtrace_file;
92 /** Convert some number of seconds to a string representation
93 * in hours, minutes and seconds.
96 * @return String of the form H:M:S (where H is hours, M
97 * is minutes and S is seconds).
100 seconds_to_hms (int s)
110 hms << std::setfill ('0') << m << N_(":");
112 hms << std::setfill ('0') << s;
117 /** @param s Number of seconds.
118 * @return String containing an approximate description of s (e.g. "about 2 hours")
121 seconds_to_approximate_hms (int s)
132 ap << (h + 1) << N_(" ") << _("hours");
135 ap << N_("1 ") << _("hour");
137 ap << h << N_(" ") << _("hours");
142 ap << N_("1 ") << _("minute");
144 ap << m << N_(" ") << _("minutes");
147 ap << s << N_(" ") << _("seconds");
153 #ifdef DVDOMATIC_POSIX
154 /** @param l Mangled C++ identifier.
155 * @return Demangled version.
160 string::size_type const b = l.find_first_of (N_("("));
161 if (b == string::npos) {
165 string::size_type const p = l.find_last_of (N_("+"));
166 if (p == string::npos) {
174 string const fn = l.substr (b + 1, p - b - 1);
179 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
184 } catch (std::exception) {
191 /** Write a stacktrace to an ostream.
192 * @param out Stream to write to.
193 * @param levels Number of levels to go up the call stack.
196 stacktrace (ostream& out, int levels)
203 size = backtrace (array, 200);
204 strings = backtrace_symbols (array, size);
207 for (i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
208 out << N_(" ") << demangle (strings[i]) << "\n";
216 /** @param v Version as used by FFmpeg.
217 * @return A string representation of v.
220 ffmpeg_version_to_string (int v)
223 s << ((v & 0xff0000) >> 16) << N_(".") << ((v & 0xff00) >> 8) << N_(".") << (v & 0xff);
227 /** Return a user-readable string summarising the versions of our dependencies */
229 dependency_version_summary ()
232 s << N_("libopenjpeg ") << opj_version () << N_(", ")
233 << N_("libavcodec ") << ffmpeg_version_to_string (avcodec_version()) << N_(", ")
234 << N_("libavfilter ") << ffmpeg_version_to_string (avfilter_version()) << N_(", ")
235 << N_("libavformat ") << ffmpeg_version_to_string (avformat_version()) << N_(", ")
236 << N_("libavutil ") << ffmpeg_version_to_string (avutil_version()) << N_(", ")
237 << N_("libpostproc ") << ffmpeg_version_to_string (postproc_version()) << N_(", ")
238 << N_("libswscale ") << ffmpeg_version_to_string (swscale_version()) << N_(", ")
239 << MagickVersion << N_(", ")
240 << N_("libssh ") << ssh_version (0) << N_(", ")
241 << N_("libdcp ") << libdcp::version << N_(" git ") << libdcp::git_commit;
247 seconds (struct timeval t)
249 return t.tv_sec + (double (t.tv_usec) / 1e6);
252 #ifdef DVDOMATIC_WINDOWS
253 LONG WINAPI exception_handler(struct _EXCEPTION_POINTERS *)
256 ofstream f (backtrace_file.string().c_str());
257 std::copy(s.begin(), s.end(), std::ostream_iterator<dbg::stack_frame>(f, "\n"));
258 return EXCEPTION_CONTINUE_SEARCH;
262 /** Call the required functions to set up DVD-o-matic's static arrays, etc.
263 * Must be called from the UI thread, if there is one.
268 #ifdef DVDOMATIC_WINDOWS
269 backtrace_file /= g_get_user_config_dir ();
270 backtrace_file /= "backtrace.txt";
271 SetUnhandledExceptionFilter(exception_handler);
274 avfilter_register_all ();
276 Format::setup_formats ();
277 DCPContentType::setup_dcp_content_types ();
278 Scaler::setup_scalers ();
279 Filter::setup_filters ();
280 SoundProcessor::setup_sound_processors ();
282 ui_thread = boost::this_thread::get_id ();
285 #ifdef DVDOMATIC_WINDOWS
286 boost::filesystem::path
290 GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
291 boost::filesystem::path p (buffer);
292 p = p.parent_path ();
293 p = p.parent_path ();
300 dvdomatic_setup_gettext_i18n (string lang)
302 #ifdef DVDOMATIC_POSIX
306 if (!lang.empty ()) {
307 /* Override our environment language; this is essential on
311 snprintf (cmd, sizeof(cmd), "LANGUAGE=%s", lang.c_str ());
313 snprintf (cmd, sizeof(cmd), "LANG=%s", lang.c_str ());
317 setlocale (LC_ALL, "");
318 textdomain ("libdvdomatic");
320 #ifdef DVDOMATIC_WINDOWS
321 bindtextdomain ("libdvdomatic", mo_path().string().c_str());
322 bind_textdomain_codeset ("libdvdomatic", "UTF8");
325 #ifdef DVDOMATIC_POSIX
326 bindtextdomain ("libdvdomatic", POSIX_LOCALE_PREFIX);
330 /** @param start Start position for the crop within the image.
331 * @param size Size of the cropped area.
332 * @return FFmpeg crop filter string.
335 crop_string (Position start, libdcp::Size size)
338 s << N_("crop=") << size.width << N_(":") << size.height << N_(":") << start.x << N_(":") << start.y;
342 /** @param s A string.
343 * @return Parts of the string split at spaces, except when a space is within quotation marks.
346 split_at_spaces_considering_quotes (string s)
349 bool in_quotes = false;
351 for (string::size_type i = 0; i < s.length(); ++i) {
352 if (s[i] == ' ' && !in_quotes) {
355 } else if (s[i] == '"') {
356 in_quotes = !in_quotes;
367 md5_digest (void const * data, int size)
370 MD5_Init (&md5_context);
371 MD5_Update (&md5_context, data, size);
372 unsigned char digest[MD5_DIGEST_LENGTH];
373 MD5_Final (digest, &md5_context);
376 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
377 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
383 /** @param file File name.
384 * @return MD5 digest of file's contents.
387 md5_digest (string file)
389 ifstream f (file.c_str(), std::ios::binary);
391 throw OpenFileError (file);
394 f.seekg (0, std::ios::end);
395 int bytes = f.tellg ();
396 f.seekg (0, std::ios::beg);
398 int const buffer_size = 64 * 1024;
399 char buffer[buffer_size];
402 MD5_Init (&md5_context);
404 int const t = min (bytes, buffer_size);
406 MD5_Update (&md5_context, buffer, t);
410 unsigned char digest[MD5_DIGEST_LENGTH];
411 MD5_Final (digest, &md5_context);
414 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
415 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
422 about_equal (float a, float b)
424 /* A film of F seconds at f FPS will be Ff frames;
425 Consider some delta FPS d, so if we run the same
426 film at (f + d) FPS it will last F(f + d) seconds.
428 Hence the difference in length over the length of the film will
429 be F(f + d) - Ff frames
430 = Ff + Fd - Ff frames
434 So if we accept a difference of 1 frame, ie 1/f seconds, we can
441 So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
442 FPS error is 1/F ~= 0.0001 ~= 10-e4
445 return (fabs (a - b) < 1e-4);
448 class FrameRateCandidate
451 FrameRateCandidate (float source_, int dcp_)
461 best_dcp_frame_rate (float source_fps)
463 list<int> const allowed_dcp_frame_rates = Config::instance()->allowed_dcp_frame_rates ();
465 /* Work out what rates we could manage, including those achieved by using skip / repeat. */
466 list<FrameRateCandidate> candidates;
468 /* Start with the ones without skip / repeat so they will get matched in preference to skipped/repeated ones */
469 for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
470 candidates.push_back (FrameRateCandidate (*i, *i));
473 /* Then the skip/repeat ones */
474 for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
475 candidates.push_back (FrameRateCandidate (float (*i) / 2, *i));
476 candidates.push_back (FrameRateCandidate (float (*i) * 2, *i));
479 /* Pick the best one, bailing early if we hit an exact match */
480 float error = std::numeric_limits<float>::max ();
481 optional<FrameRateCandidate> best;
482 list<FrameRateCandidate>::iterator i = candidates.begin();
483 while (i != candidates.end()) {
485 if (about_equal (i->source, source_fps)) {
490 float const e = fabs (i->source - source_fps);
503 /** @param An arbitrary sampling rate.
504 * @return The appropriate DCP-approved sampling rate (48kHz or 96kHz).
507 dcp_audio_sample_rate (int fs)
516 bool operator== (Crop const & a, Crop const & b)
518 return (a.left == b.left && a.right == b.right && a.top == b.top && a.bottom == b.bottom);
521 bool operator!= (Crop const & a, Crop const & b)
526 /** @param index Colour LUT index.
527 * @return Human-readable name.
530 colour_lut_index_to_name (int index)
543 Socket::Socket (int timeout)
544 : _deadline (_io_service)
545 , _socket (_io_service)
548 _deadline.expires_at (boost::posix_time::pos_infin);
555 if (_deadline.expires_at() <= boost::asio::deadline_timer::traits_type::now ()) {
557 _deadline.expires_at (boost::posix_time::pos_infin);
560 _deadline.async_wait (boost::bind (&Socket::check, this));
563 /** Blocking connect.
564 * @param endpoint End-point to connect to.
567 Socket::connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint)
569 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
570 boost::system::error_code ec = boost::asio::error::would_block;
571 _socket.async_connect (endpoint, boost::lambda::var(ec) = boost::lambda::_1);
573 _io_service.run_one();
574 } while (ec == boost::asio::error::would_block);
576 if (ec || !_socket.is_open ()) {
577 throw NetworkError (_("connect timed out"));
582 * @param data Buffer to write.
583 * @param size Number of bytes to write.
586 Socket::write (uint8_t const * data, int size)
588 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
589 boost::system::error_code ec = boost::asio::error::would_block;
591 boost::asio::async_write (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
594 _io_service.run_one ();
595 } while (ec == boost::asio::error::would_block);
598 throw NetworkError (ec.message ());
603 Socket::write (uint32_t v)
606 write (reinterpret_cast<uint8_t*> (&v), 4);
610 * @param data Buffer to read to.
611 * @param size Number of bytes to read.
614 Socket::read (uint8_t* data, int size)
616 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
617 boost::system::error_code ec = boost::asio::error::would_block;
619 boost::asio::async_read (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
622 _io_service.run_one ();
623 } while (ec == boost::asio::error::would_block);
626 throw NetworkError (ec.message ());
631 Socket::read_uint32 ()
634 read (reinterpret_cast<uint8_t *> (&v), 4);
638 /** @param other A Rect.
639 * @return The intersection of this with `other'.
642 dvdomatic::Rect::intersection (Rect const & other) const
644 int const tx = max (x, other.x);
645 int const ty = max (y, other.y);
649 min (x + width, other.x + other.width) - tx,
650 min (y + height, other.y + other.height) - ty
654 /** Round a number up to the nearest multiple of another number.
656 * @param s Array of numbers to round, indexed by c.
657 * @param t Multiple to round to.
658 * @return Rounded number.
661 stride_round_up (int c, int const * stride, int t)
663 int const a = stride[c] + (t - 1);
668 stride_lookup (int c, int const * stride)
673 /** Read a sequence of key / value pairs from a text stream;
674 * the keys are the first words on the line, and the values are
675 * the remainder of the line following the key. Lines beginning
676 * with # are ignored.
677 * @param s Stream to read.
678 * @return key/value pairs.
680 multimap<string, string>
681 read_key_value (istream &s)
683 multimap<string, string> kv;
686 while (getline (s, line)) {
691 if (line[0] == '#') {
695 if (line[line.size() - 1] == '\r') {
696 line = line.substr (0, line.size() - 1);
699 size_t const s = line.find (' ');
700 if (s == string::npos) {
704 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
711 get_required_string (multimap<string, string> const & kv, string k)
713 if (kv.count (k) > 1) {
714 throw StringError (N_("unexpected multiple keys in key-value set"));
717 multimap<string, string>::const_iterator i = kv.find (k);
719 if (i == kv.end ()) {
720 throw StringError (String::compose (_("missing key %1 in key-value set"), k));
727 get_required_int (multimap<string, string> const & kv, string k)
729 string const v = get_required_string (kv, k);
730 return lexical_cast<int> (v);
734 get_required_float (multimap<string, string> const & kv, string k)
736 string const v = get_required_string (kv, k);
737 return lexical_cast<float> (v);
741 get_optional_string (multimap<string, string> const & kv, string k)
743 if (kv.count (k) > 1) {
744 throw StringError (N_("unexpected multiple keys in key-value set"));
747 multimap<string, string>::const_iterator i = kv.find (k);
748 if (i == kv.end ()) {
756 get_optional_int (multimap<string, string> const & kv, string k)
758 if (kv.count (k) > 1) {
759 throw StringError (N_("unexpected multiple keys in key-value set"));
762 multimap<string, string>::const_iterator i = kv.find (k);
763 if (i == kv.end ()) {
767 return lexical_cast<int> (i->second);
770 /** Construct an AudioBuffers. Audio data is undefined after this constructor.
771 * @param channels Number of channels.
772 * @param frames Number of frames to reserve space for.
774 AudioBuffers::AudioBuffers (int channels, int frames)
775 : _channels (channels)
777 , _allocated_frames (frames)
779 _data = new float*[_channels];
780 for (int i = 0; i < _channels; ++i) {
781 _data[i] = new float[frames];
785 /** Copy constructor.
786 * @param other Other AudioBuffers; data is copied.
788 AudioBuffers::AudioBuffers (AudioBuffers const & other)
789 : _channels (other._channels)
790 , _frames (other._frames)
791 , _allocated_frames (other._frames)
793 _data = new float*[_channels];
794 for (int i = 0; i < _channels; ++i) {
795 _data[i] = new float[_frames];
796 memcpy (_data[i], other._data[i], _frames * sizeof (float));
800 /* XXX: it's a shame that this is a copy-and-paste of the above;
801 probably fixable with c++0x.
803 AudioBuffers::AudioBuffers (boost::shared_ptr<const AudioBuffers> other)
804 : _channels (other->_channels)
805 , _frames (other->_frames)
806 , _allocated_frames (other->_frames)
808 _data = new float*[_channels];
809 for (int i = 0; i < _channels; ++i) {
810 _data[i] = new float[_frames];
811 memcpy (_data[i], other->_data[i], _frames * sizeof (float));
815 /** AudioBuffers destructor */
816 AudioBuffers::~AudioBuffers ()
818 for (int i = 0; i < _channels; ++i) {
825 /** @param c Channel index.
826 * @return Buffer for this channel.
829 AudioBuffers::data (int c) const
831 assert (c >= 0 && c < _channels);
835 /** Set the number of frames that these AudioBuffers will report themselves
837 * @param f Frames; must be less than or equal to the number of allocated frames.
840 AudioBuffers::set_frames (int f)
842 assert (f <= _allocated_frames);
846 /** Make all samples on all channels silent */
848 AudioBuffers::make_silent ()
850 for (int i = 0; i < _channels; ++i) {
855 /** Make all samples on a given channel silent.
859 AudioBuffers::make_silent (int c)
861 assert (c >= 0 && c < _channels);
863 for (int i = 0; i < _frames; ++i) {
868 /** Copy data from another AudioBuffers to this one. All channels are copied.
869 * @param from AudioBuffers to copy from; must have the same number of channels as this.
870 * @param frames_to_copy Number of frames to copy.
871 * @param read_offset Offset to read from in `from'.
872 * @param write_offset Offset to write to in `to'.
875 AudioBuffers::copy_from (AudioBuffers* from, int frames_to_copy, int read_offset, int write_offset)
877 assert (from->channels() == channels());
880 assert (read_offset >= 0 && (read_offset + frames_to_copy) <= from->_allocated_frames);
881 assert (write_offset >= 0 && (write_offset + frames_to_copy) <= _allocated_frames);
883 for (int i = 0; i < _channels; ++i) {
884 memcpy (_data[i] + write_offset, from->_data[i] + read_offset, frames_to_copy * sizeof(float));
888 /** Move audio data around.
889 * @param from Offset to move from.
890 * @param to Offset to move to.
891 * @param frames Number of frames to move.
895 AudioBuffers::move (int from, int to, int frames)
902 assert (from < _frames);
904 assert (to < _frames);
906 assert (frames <= _frames);
907 assert ((from + frames) <= _frames);
908 assert ((to + frames) <= _frames);
910 for (int i = 0; i < _channels; ++i) {
911 memmove (_data[i] + to, _data[i] + from, frames * sizeof(float));
915 /** Trip an assert if the caller is not in the UI thread */
919 assert (boost::this_thread::get_id() == ui_thread);
922 /** @param v Source video frame.
923 * @param audio_sample_rate Source audio sample rate.
924 * @param frames_per_second Number of video frames per second.
925 * @return Equivalent number of audio frames for `v'.
928 video_frames_to_audio_frames (SourceFrame v, float audio_sample_rate, float frames_per_second)
930 return ((int64_t) v * audio_sample_rate / frames_per_second);
933 /** @param f Filename.
934 * @return true if this file is a still image, false if it is something else.
937 still_image_file (string f)
939 string ext = boost::filesystem::path(f).extension().string();
941 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
943 return (ext == N_(".tif") || ext == N_(".tiff") || ext == N_(".jpg") || ext == N_(".jpeg") || ext == N_(".png") || ext == N_(".bmp"));
947 audio_channel_name (int c)
949 assert (MAX_AUDIO_CHANNELS == 6);
951 /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
952 enhancement channel (sub-woofer)./
954 string const channels[] = {
966 AudioMapping::AudioMapping (shared_ptr<const Film> f)
967 : _source_channels (f->audio_stream() ? f->audio_stream()->channels() : 0)
968 , _minimum_channels (f->minimum_audio_channels ())
973 optional<libdcp::Channel>
974 AudioMapping::source_to_dcp (int c) const
976 if (c >= _source_channels) {
977 return optional<libdcp::Channel> ();
980 if (_source_channels == 1) {
981 /* mono sources to centre */
982 return libdcp::CENTRE;
985 return static_cast<libdcp::Channel> (c);
989 AudioMapping::dcp_to_source (libdcp::Channel c) const
991 if (_source_channels == 1) {
992 if (c == libdcp::CENTRE) {
995 return optional<int> ();
999 if (static_cast<int> (c) >= _source_channels) {
1000 return optional<int> ();
1003 return static_cast<int> (c);
1006 /** @return minimum number of DCP channels that we can allow in this
1007 DCP, given the nature of the source.
1010 AudioMapping::minimum_dcp_channels () const
1012 if (_source_channels == 1) {
1013 /* The source is mono, so to put the mono channel into
1014 the centre we need to generate a 5.1 soundtrack.
1019 return _source_channels;
1022 /** @return number of channels that there should be in the DCP, including
1023 * any silent padded ones.
1026 AudioMapping::dcp_channels () const
1028 return max (_source_channels, _minimum_channels);
1031 FrameRateConversion::FrameRateConversion (float source, int dcp)
1034 , change_speed (false)
1036 if (fabs (source / 2.0 - dcp) < (fabs (source - dcp))) {
1038 } else if (fabs (source * 2 - dcp) < fabs (source - dcp)) {
1042 change_speed = !about_equal (source * factor(), dcp);
1044 if (!skip && !repeat && !change_speed) {
1045 description = _("DCP and source have the same rate.\n");
1048 description = _("DCP will use every other frame of the source.\n");
1049 } else if (repeat) {
1050 description = _("Each source frame will be doubled in the DCP.\n");
1054 float const pc = dcp * 100 / (source * factor());
1055 description += String::compose (_("DCP will run at %1%% of the source speed.\n"), pc);
1060 LocaleGuard::LocaleGuard ()
1063 char const * old = setlocale (LC_NUMERIC, 0);
1066 _old = strdup (old);
1067 if (strcmp (_old, "C")) {
1068 setlocale (LC_NUMERIC, "C");
1073 LocaleGuard::~LocaleGuard ()
1075 setlocale (LC_NUMERIC, _old);