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>
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"
59 #include "dcp_content_type.h"
61 #include "sound_processor.h"
64 #ifdef DCPOMATIC_WINDOWS
71 using std::stringstream;
85 using std::numeric_limits;
88 using boost::shared_ptr;
90 using boost::lexical_cast;
91 using boost::optional;
94 static boost::thread::id ui_thread;
95 static boost::filesystem::path backtrace_file;
97 /** Convert some number of seconds to a string representation
98 * in hours, minutes and seconds.
101 * @return String of the form H:M:S (where H is hours, M
102 * is minutes and S is seconds).
105 seconds_to_hms (int s)
115 hms << std::setfill ('0') << m << N_(":");
117 hms << std::setfill ('0') << s;
122 /** @param s Number of seconds.
123 * @return String containing an approximate description of s (e.g. "about 2 hours")
126 seconds_to_approximate_hms (int s)
137 ap << (h + 1) << N_(" ") << _("hours");
140 ap << N_("1 ") << _("hour");
142 ap << h << N_(" ") << _("hours");
147 ap << N_("1 ") << _("minute");
149 ap << m << N_(" ") << _("minutes");
152 ap << s << N_(" ") << _("seconds");
158 #ifdef DCPOMATIC_POSIX
159 /** @param l Mangled C++ identifier.
160 * @return Demangled version.
165 string::size_type const b = l.find_first_of (N_("("));
166 if (b == string::npos) {
170 string::size_type const p = l.find_last_of (N_("+"));
171 if (p == string::npos) {
179 string const fn = l.substr (b + 1, p - b - 1);
184 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
189 } catch (std::exception) {
196 /** Write a stacktrace to an ostream.
197 * @param out Stream to write to.
198 * @param levels Number of levels to go up the call stack.
201 stacktrace (ostream& out, int levels)
204 size_t size = backtrace (array, 200);
205 char** strings = backtrace_symbols (array, size);
208 for (size_t i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
209 out << N_(" ") << demangle (strings[i]) << "\n";
217 /** @param v Version as used by FFmpeg.
218 * @return A string representation of v.
221 ffmpeg_version_to_string (int v)
224 s << ((v & 0xff0000) >> 16) << N_(".") << ((v & 0xff00) >> 8) << N_(".") << (v & 0xff);
228 /** Return a user-readable string summarising the versions of our dependencies */
230 dependency_version_summary ()
233 s << N_("libopenjpeg ") << opj_version () << N_(", ")
234 << N_("libavcodec ") << ffmpeg_version_to_string (avcodec_version()) << N_(", ")
235 << N_("libavfilter ") << ffmpeg_version_to_string (avfilter_version()) << N_(", ")
236 << N_("libavformat ") << ffmpeg_version_to_string (avformat_version()) << N_(", ")
237 << N_("libavutil ") << ffmpeg_version_to_string (avutil_version()) << N_(", ")
238 << N_("libpostproc ") << ffmpeg_version_to_string (postproc_version()) << N_(", ")
239 << N_("libswscale ") << ffmpeg_version_to_string (swscale_version()) << N_(", ")
240 << MagickVersion << N_(", ")
241 << N_("libssh ") << ssh_version (0) << N_(", ")
242 << N_("libdcp ") << libdcp::version << N_(" git ") << libdcp::git_commit;
248 seconds (struct timeval t)
250 return t.tv_sec + (double (t.tv_usec) / 1e6);
253 #ifdef DCPOMATIC_WINDOWS
254 LONG WINAPI exception_handler(struct _EXCEPTION_POINTERS *)
257 ofstream f (backtrace_file.string().c_str());
258 std::copy(s.begin(), s.end(), std::ostream_iterator<dbg::stack_frame>(f, "\n"));
259 return EXCEPTION_CONTINUE_SEARCH;
263 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
264 * Must be called from the UI thread, if there is one.
269 #ifdef DCPOMATIC_WINDOWS
270 backtrace_file /= g_get_user_config_dir ();
271 backtrace_file /= "backtrace.txt";
272 SetUnhandledExceptionFilter(exception_handler);
275 avfilter_register_all ();
277 Ratio::setup_ratios ();
278 DCPContentType::setup_dcp_content_types ();
279 Scaler::setup_scalers ();
280 Filter::setup_filters ();
281 SoundProcessor::setup_sound_processors ();
283 ui_thread = boost::this_thread::get_id ();
286 #ifdef DCPOMATIC_WINDOWS
287 boost::filesystem::path
291 GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
292 boost::filesystem::path p (buffer);
293 p = p.parent_path ();
294 p = p.parent_path ();
301 dcpomatic_setup_gettext_i18n (string lang)
303 #ifdef DCPOMATIC_POSIX
307 if (!lang.empty ()) {
308 /* Override our environment language; this is essential on
312 snprintf (cmd, sizeof(cmd), "LANGUAGE=%s", lang.c_str ());
314 snprintf (cmd, sizeof(cmd), "LANG=%s", lang.c_str ());
318 setlocale (LC_ALL, "");
319 textdomain ("libdcpomatic");
321 #ifdef DCPOMATIC_WINDOWS
322 bindtextdomain ("libdcpomatic", mo_path().string().c_str());
323 bind_textdomain_codeset ("libdcpomatic", "UTF8");
326 #ifdef DCPOMATIC_POSIX
327 bindtextdomain ("libdcpomatic", POSIX_LOCALE_PREFIX);
331 /** @param s A string.
332 * @return Parts of the string split at spaces, except when a space is within quotation marks.
335 split_at_spaces_considering_quotes (string s)
338 bool in_quotes = false;
340 for (string::size_type i = 0; i < s.length(); ++i) {
341 if (s[i] == ' ' && !in_quotes) {
344 } else if (s[i] == '"') {
345 in_quotes = !in_quotes;
356 md5_digest (void const * data, int size)
359 MD5_Init (&md5_context);
360 MD5_Update (&md5_context, data, size);
361 unsigned char digest[MD5_DIGEST_LENGTH];
362 MD5_Final (digest, &md5_context);
365 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
366 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
372 /** @param file File name.
373 * @return MD5 digest of file's contents.
376 md5_digest (boost::filesystem::path file)
378 ifstream f (file.string().c_str(), std::ios::binary);
380 throw OpenFileError (file.string());
383 f.seekg (0, std::ios::end);
384 int bytes = f.tellg ();
385 f.seekg (0, std::ios::beg);
387 int const buffer_size = 64 * 1024;
388 char buffer[buffer_size];
391 MD5_Init (&md5_context);
393 int const t = min (bytes, buffer_size);
395 MD5_Update (&md5_context, buffer, t);
399 unsigned char digest[MD5_DIGEST_LENGTH];
400 MD5_Final (digest, &md5_context);
403 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
404 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
411 md5_digest_directory (boost::filesystem::path directory)
413 int const buffer_size = 64 * 1024;
414 char buffer[buffer_size];
417 MD5_Init (&md5_context);
419 for (boost::filesystem::directory_iterator i(directory); i != boost::filesystem::directory_iterator(); ++i) {
420 ifstream f (i->path().string().c_str(), std::ios::binary);
422 throw OpenFileError (i->path().string());
425 f.seekg (0, std::ios::end);
426 int bytes = f.tellg ();
427 f.seekg (0, std::ios::beg);
430 int const t = min (bytes, buffer_size);
432 MD5_Update (&md5_context, buffer, t);
437 unsigned char digest[MD5_DIGEST_LENGTH];
438 MD5_Final (digest, &md5_context);
441 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
442 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
449 about_equal (float a, float b)
451 /* A film of F seconds at f FPS will be Ff frames;
452 Consider some delta FPS d, so if we run the same
453 film at (f + d) FPS it will last F(f + d) seconds.
455 Hence the difference in length over the length of the film will
456 be F(f + d) - Ff frames
457 = Ff + Fd - Ff frames
461 So if we accept a difference of 1 frame, ie 1/f seconds, we can
468 So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
469 FPS error is 1/F ~= 0.0001 ~= 10-e4
472 return (fabs (a - b) < 1e-4);
475 /** @param An arbitrary audio frame rate.
476 * @return The appropriate DCP-approved frame rate (48kHz or 96kHz).
479 dcp_audio_frame_rate (int fs)
488 Socket::Socket (int timeout)
489 : _deadline (_io_service)
490 , _socket (_io_service)
493 _deadline.expires_at (boost::posix_time::pos_infin);
500 if (_deadline.expires_at() <= boost::asio::deadline_timer::traits_type::now ()) {
502 _deadline.expires_at (boost::posix_time::pos_infin);
505 _deadline.async_wait (boost::bind (&Socket::check, this));
508 /** Blocking connect.
509 * @param endpoint End-point to connect to.
512 Socket::connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint)
514 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
515 boost::system::error_code ec = boost::asio::error::would_block;
516 _socket.async_connect (endpoint, boost::lambda::var(ec) = boost::lambda::_1);
518 _io_service.run_one();
519 } while (ec == boost::asio::error::would_block);
521 if (ec || !_socket.is_open ()) {
522 throw NetworkError (_("connect timed out"));
527 * @param data Buffer to write.
528 * @param size Number of bytes to write.
531 Socket::write (uint8_t const * data, int size)
533 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
534 boost::system::error_code ec = boost::asio::error::would_block;
536 boost::asio::async_write (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
539 _io_service.run_one ();
540 } while (ec == boost::asio::error::would_block);
543 throw NetworkError (ec.message ());
548 Socket::write (uint32_t v)
551 write (reinterpret_cast<uint8_t*> (&v), 4);
555 * @param data Buffer to read to.
556 * @param size Number of bytes to read.
559 Socket::read (uint8_t* 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_read (_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::read_uint32 ()
579 read (reinterpret_cast<uint8_t *> (&v), 4);
583 /** Round a number up to the nearest multiple of another number.
585 * @param s Array of numbers to round, indexed by c.
586 * @param t Multiple to round to.
587 * @return Rounded number.
590 stride_round_up (int c, int const * stride, int t)
592 int const a = stride[c] + (t - 1);
596 /** Read a sequence of key / value pairs from a text stream;
597 * the keys are the first words on the line, and the values are
598 * the remainder of the line following the key. Lines beginning
599 * with # are ignored.
600 * @param s Stream to read.
601 * @return key/value pairs.
603 multimap<string, string>
604 read_key_value (istream &s)
606 multimap<string, string> kv;
609 while (getline (s, line)) {
614 if (line[0] == '#') {
618 if (line[line.size() - 1] == '\r') {
619 line = line.substr (0, line.size() - 1);
622 size_t const s = line.find (' ');
623 if (s == string::npos) {
627 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
634 get_required_string (multimap<string, string> const & kv, string k)
636 if (kv.count (k) > 1) {
637 throw StringError (N_("unexpected multiple keys in key-value set"));
640 multimap<string, string>::const_iterator i = kv.find (k);
642 if (i == kv.end ()) {
643 throw StringError (String::compose (_("missing key %1 in key-value set"), k));
650 get_required_int (multimap<string, string> const & kv, string k)
652 string const v = get_required_string (kv, k);
653 return lexical_cast<int> (v);
657 get_required_float (multimap<string, string> const & kv, string k)
659 string const v = get_required_string (kv, k);
660 return lexical_cast<float> (v);
664 get_optional_string (multimap<string, string> const & kv, string k)
666 if (kv.count (k) > 1) {
667 throw StringError (N_("unexpected multiple keys in key-value set"));
670 multimap<string, string>::const_iterator i = kv.find (k);
671 if (i == kv.end ()) {
679 get_optional_int (multimap<string, string> const & kv, string k)
681 if (kv.count (k) > 1) {
682 throw StringError (N_("unexpected multiple keys in key-value set"));
685 multimap<string, string>::const_iterator i = kv.find (k);
686 if (i == kv.end ()) {
690 return lexical_cast<int> (i->second);
693 /** Trip an assert if the caller is not in the UI thread */
697 assert (boost::this_thread::get_id() == ui_thread);
700 /** @param v Content video frame.
701 * @param audio_sample_rate Source audio sample rate.
702 * @param frames_per_second Number of video frames per second.
703 * @return Equivalent number of audio frames for `v'.
706 video_frames_to_audio_frames (VideoContent::Frame v, float audio_sample_rate, float frames_per_second)
708 return ((int64_t) v * audio_sample_rate / frames_per_second);
712 audio_channel_name (int c)
714 assert (MAX_AUDIO_CHANNELS == 6);
716 /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
717 enhancement channel (sub-woofer)./
719 string const channels[] = {
731 FrameRateConversion::FrameRateConversion (float source, int dcp)
734 , change_speed (false)
736 if (fabs (source / 2.0 - dcp) < (fabs (source - dcp))) {
738 } else if (fabs (source * 2 - dcp) < fabs (source - dcp)) {
742 change_speed = !about_equal (source * factor(), dcp);
744 if (!skip && !repeat && !change_speed) {
745 description = _("Content and DCP have the same rate.\n");
748 description = _("DCP will use every other frame of the content.\n");
750 description = _("Each content frame will be doubled in the DCP.\n");
754 float const pc = dcp * 100 / (source * factor());
755 description += String::compose (_("DCP will run at %1%% of the content speed.\n"), pc);
760 LocaleGuard::LocaleGuard ()
763 char const * old = setlocale (LC_NUMERIC, 0);
767 if (strcmp (_old, "C")) {
768 setlocale (LC_NUMERIC, "C");
773 LocaleGuard::~LocaleGuard ()
775 setlocale (LC_NUMERIC, _old);