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"
60 #include "dcp_content_type.h"
62 #include "sound_processor.h"
64 #include "container.h"
65 #ifdef DVDOMATIC_WINDOWS
72 using std::stringstream;
86 using std::numeric_limits;
89 using boost::shared_ptr;
91 using boost::lexical_cast;
92 using boost::optional;
95 boost::thread::id ui_thread;
96 boost::filesystem::path backtrace_file;
98 /** Convert some number of seconds to a string representation
99 * in hours, minutes and seconds.
102 * @return String of the form H:M:S (where H is hours, M
103 * is minutes and S is seconds).
106 seconds_to_hms (int s)
116 hms << std::setfill ('0') << m << N_(":");
118 hms << std::setfill ('0') << s;
126 return seconds_to_hms (t / TIME_HZ);
129 /** @param s Number of seconds.
130 * @return String containing an approximate description of s (e.g. "about 2 hours")
133 seconds_to_approximate_hms (int s)
144 ap << (h + 1) << N_(" ") << _("hours");
147 ap << N_("1 ") << _("hour");
149 ap << h << N_(" ") << _("hours");
154 ap << N_("1 ") << _("minute");
156 ap << m << N_(" ") << _("minutes");
159 ap << s << N_(" ") << _("seconds");
165 #ifdef DCPOMATIC_POSIX
166 /** @param l Mangled C++ identifier.
167 * @return Demangled version.
172 string::size_type const b = l.find_first_of (N_("("));
173 if (b == string::npos) {
177 string::size_type const p = l.find_last_of (N_("+"));
178 if (p == string::npos) {
186 string const fn = l.substr (b + 1, p - b - 1);
191 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
196 } catch (std::exception) {
203 /** Write a stacktrace to an ostream.
204 * @param out Stream to write to.
205 * @param levels Number of levels to go up the call stack.
208 stacktrace (ostream& out, int levels)
215 size = backtrace (array, 200);
216 strings = backtrace_symbols (array, size);
219 for (i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
220 out << N_(" ") << demangle (strings[i]) << "\n";
228 /** @param v Version as used by FFmpeg.
229 * @return A string representation of v.
232 ffmpeg_version_to_string (int v)
235 s << ((v & 0xff0000) >> 16) << N_(".") << ((v & 0xff00) >> 8) << N_(".") << (v & 0xff);
239 /** Return a user-readable string summarising the versions of our dependencies */
241 dependency_version_summary ()
244 s << N_("libopenjpeg ") << opj_version () << N_(", ")
245 << N_("libavcodec ") << ffmpeg_version_to_string (avcodec_version()) << N_(", ")
246 << N_("libavfilter ") << ffmpeg_version_to_string (avfilter_version()) << N_(", ")
247 << N_("libavformat ") << ffmpeg_version_to_string (avformat_version()) << N_(", ")
248 << N_("libavutil ") << ffmpeg_version_to_string (avutil_version()) << N_(", ")
249 << N_("libpostproc ") << ffmpeg_version_to_string (postproc_version()) << N_(", ")
250 << N_("libswscale ") << ffmpeg_version_to_string (swscale_version()) << N_(", ")
251 << MagickVersion << N_(", ")
252 << N_("libssh ") << ssh_version (0) << N_(", ")
253 << N_("libdcp ") << libdcp::version << N_(" git ") << libdcp::git_commit;
259 seconds (struct timeval t)
261 return t.tv_sec + (double (t.tv_usec) / 1e6);
264 #ifdef DVDOMATIC_WINDOWS
265 LONG WINAPI exception_handler(struct _EXCEPTION_POINTERS *)
268 ofstream f (backtrace_file.string().c_str());
269 std::copy(s.begin(), s.end(), std::ostream_iterator<dbg::stack_frame>(f, "\n"));
270 return EXCEPTION_CONTINUE_SEARCH;
274 /** Call the required functions to set up DVD-o-matic's static arrays, etc.
275 * Must be called from the UI thread, if there is one.
280 #ifdef DVDOMATIC_WINDOWS
281 backtrace_file /= g_get_user_config_dir ();
282 backtrace_file /= "backtrace.txt";
283 SetUnhandledExceptionFilter(exception_handler);
286 avfilter_register_all ();
288 Format::setup_formats ();
289 Container::setup_containers ();
290 DCPContentType::setup_dcp_content_types ();
291 Scaler::setup_scalers ();
292 Filter::setup_filters ();
293 SoundProcessor::setup_sound_processors ();
295 ui_thread = boost::this_thread::get_id ();
298 #ifdef DCPOMATIC_WINDOWS
299 boost::filesystem::path
303 GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
304 boost::filesystem::path p (buffer);
305 p = p.parent_path ();
306 p = p.parent_path ();
313 dcpomatic_setup_gettext_i18n (string lang)
315 #ifdef DCPOMATIC_POSIX
319 if (!lang.empty ()) {
320 /* Override our environment language; this is essential on
324 snprintf (cmd, sizeof(cmd), "LANGUAGE=%s", lang.c_str ());
326 snprintf (cmd, sizeof(cmd), "LANG=%s", lang.c_str ());
330 setlocale (LC_ALL, "");
331 textdomain ("libdcpomatic");
333 #ifdef DCPOMATIC_WINDOWS
334 bindtextdomain ("libdcpomatic", mo_path().string().c_str());
335 bind_textdomain_codeset ("libdcpomatic", "UTF8");
338 #ifdef DCPOMATIC_POSIX
339 bindtextdomain ("libdcpomatic", POSIX_LOCALE_PREFIX);
343 /** @param start Start position for the crop within the image.
344 * @param size Size of the cropped area.
345 * @return FFmpeg crop filter string.
348 crop_string (Position start, libdcp::Size size)
351 s << N_("crop=") << size.width << N_(":") << size.height << N_(":") << start.x << N_(":") << start.y;
355 /** @param s A string.
356 * @return Parts of the string split at spaces, except when a space is within quotation marks.
359 split_at_spaces_considering_quotes (string s)
362 bool in_quotes = false;
364 for (string::size_type i = 0; i < s.length(); ++i) {
365 if (s[i] == ' ' && !in_quotes) {
368 } else if (s[i] == '"') {
369 in_quotes = !in_quotes;
380 md5_digest (void const * data, int size)
383 MD5_Init (&md5_context);
384 MD5_Update (&md5_context, data, size);
385 unsigned char digest[MD5_DIGEST_LENGTH];
386 MD5_Final (digest, &md5_context);
389 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
390 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
396 /** @param file File name.
397 * @return MD5 digest of file's contents.
400 md5_digest (boost::filesystem::path file)
402 ifstream f (file.string().c_str(), std::ios::binary);
404 throw OpenFileError (file.string());
407 f.seekg (0, std::ios::end);
408 int bytes = f.tellg ();
409 f.seekg (0, std::ios::beg);
411 int const buffer_size = 64 * 1024;
412 char buffer[buffer_size];
415 MD5_Init (&md5_context);
417 int const t = min (bytes, buffer_size);
419 MD5_Update (&md5_context, buffer, t);
423 unsigned char digest[MD5_DIGEST_LENGTH];
424 MD5_Final (digest, &md5_context);
427 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
428 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
435 about_equal (float a, float b)
437 /* A film of F seconds at f FPS will be Ff frames;
438 Consider some delta FPS d, so if we run the same
439 film at (f + d) FPS it will last F(f + d) seconds.
441 Hence the difference in length over the length of the film will
442 be F(f + d) - Ff frames
443 = Ff + Fd - Ff frames
447 So if we accept a difference of 1 frame, ie 1/f seconds, we can
454 So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
455 FPS error is 1/F ~= 0.0001 ~= 10-e4
458 return (fabs (a - b) < 1e-4);
461 /** @param An arbitrary audio frame rate.
462 * @return The appropriate DCP-approved frame rate (48kHz or 96kHz).
465 dcp_audio_frame_rate (int fs)
474 /** @param index Colour LUT index.
475 * @return Human-readable name.
478 colour_lut_index_to_name (int index)
491 Socket::Socket (int timeout)
492 : _deadline (_io_service)
493 , _socket (_io_service)
496 _deadline.expires_at (boost::posix_time::pos_infin);
503 if (_deadline.expires_at() <= boost::asio::deadline_timer::traits_type::now ()) {
505 _deadline.expires_at (boost::posix_time::pos_infin);
508 _deadline.async_wait (boost::bind (&Socket::check, this));
511 /** Blocking connect.
512 * @param endpoint End-point to connect to.
515 Socket::connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint)
517 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
518 boost::system::error_code ec = boost::asio::error::would_block;
519 _socket.async_connect (endpoint, boost::lambda::var(ec) = boost::lambda::_1);
521 _io_service.run_one();
522 } while (ec == boost::asio::error::would_block);
524 if (ec || !_socket.is_open ()) {
525 throw NetworkError (_("connect timed out"));
530 * @param data Buffer to write.
531 * @param size Number of bytes to write.
534 Socket::write (uint8_t const * data, int size)
536 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
537 boost::system::error_code ec = boost::asio::error::would_block;
539 boost::asio::async_write (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
542 _io_service.run_one ();
543 } while (ec == boost::asio::error::would_block);
546 throw NetworkError (ec.message ());
551 Socket::write (uint32_t v)
554 write (reinterpret_cast<uint8_t*> (&v), 4);
558 * @param data Buffer to read to.
559 * @param size Number of bytes to read.
562 Socket::read (uint8_t* data, int size)
564 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
565 boost::system::error_code ec = boost::asio::error::would_block;
567 boost::asio::async_read (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
570 _io_service.run_one ();
571 } while (ec == boost::asio::error::would_block);
574 throw NetworkError (ec.message ());
579 Socket::read_uint32 ()
582 read (reinterpret_cast<uint8_t *> (&v), 4);
586 /** Round a number up to the nearest multiple of another number.
588 * @param s Array of numbers to round, indexed by c.
589 * @param t Multiple to round to.
590 * @return Rounded number.
593 stride_round_up (int c, int const * stride, int t)
595 int const a = stride[c] + (t - 1);
600 stride_lookup (int c, int const * stride)
605 /** Read a sequence of key / value pairs from a text stream;
606 * the keys are the first words on the line, and the values are
607 * the remainder of the line following the key. Lines beginning
608 * with # are ignored.
609 * @param s Stream to read.
610 * @return key/value pairs.
612 multimap<string, string>
613 read_key_value (istream &s)
615 multimap<string, string> kv;
618 while (getline (s, line)) {
623 if (line[0] == '#') {
627 if (line[line.size() - 1] == '\r') {
628 line = line.substr (0, line.size() - 1);
631 size_t const s = line.find (' ');
632 if (s == string::npos) {
636 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
643 get_required_string (multimap<string, string> const & kv, string k)
645 if (kv.count (k) > 1) {
646 throw StringError (N_("unexpected multiple keys in key-value set"));
649 multimap<string, string>::const_iterator i = kv.find (k);
651 if (i == kv.end ()) {
652 throw StringError (String::compose (_("missing key %1 in key-value set"), k));
659 get_required_int (multimap<string, string> const & kv, string k)
661 string const v = get_required_string (kv, k);
662 return lexical_cast<int> (v);
666 get_required_float (multimap<string, string> const & kv, string k)
668 string const v = get_required_string (kv, k);
669 return lexical_cast<float> (v);
673 get_optional_string (multimap<string, string> const & kv, string k)
675 if (kv.count (k) > 1) {
676 throw StringError (N_("unexpected multiple keys in key-value set"));
679 multimap<string, string>::const_iterator i = kv.find (k);
680 if (i == kv.end ()) {
688 get_optional_int (multimap<string, string> const & kv, string k)
690 if (kv.count (k) > 1) {
691 throw StringError (N_("unexpected multiple keys in key-value set"));
694 multimap<string, string>::const_iterator i = kv.find (k);
695 if (i == kv.end ()) {
699 return lexical_cast<int> (i->second);
702 /** Trip an assert if the caller is not in the UI thread */
706 assert (boost::this_thread::get_id() == ui_thread);
709 /** @param v Content video frame.
710 * @param audio_sample_rate Source audio sample rate.
711 * @param frames_per_second Number of video frames per second.
712 * @return Equivalent number of audio frames for `v'.
715 video_frames_to_audio_frames (ContentVideoFrame v, float audio_sample_rate, float frames_per_second)
717 return ((int64_t) v * audio_sample_rate / frames_per_second);
720 /** @return A pair containing CPU model name and the number of processors */
724 pair<string, int> info;
727 #ifdef DCPOMATIC_POSIX
728 ifstream f (N_("/proc/cpuinfo"));
732 if (boost::algorithm::starts_with (l, N_("model name"))) {
733 string::size_type const c = l.find (':');
734 if (c != string::npos) {
735 info.first = l.substr (c + 2);
737 } else if (boost::algorithm::starts_with (l, N_("processor"))) {
747 audio_channel_name (int c)
749 assert (MAX_AUDIO_CHANNELS == 6);
751 /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
752 enhancement channel (sub-woofer)./
754 string const channels[] = {
766 FrameRateConversion::FrameRateConversion (float source, int dcp)
769 , change_speed (false)
771 if (fabs (source / 2.0 - dcp) < (fabs (source - dcp))) {
773 } else if (fabs (source * 2 - dcp) < fabs (source - dcp)) {
777 change_speed = !about_equal (source * factor(), dcp);
779 if (!skip && !repeat && !change_speed) {
780 description = _("DCP and source have the same rate.\n");
783 description = _("DCP will use every other frame of the source.\n");
785 description = _("Each source frame will be doubled in the DCP.\n");
789 float const pc = dcp * 100 / (source * factor());
790 description += String::compose (_("DCP will run at %1%% of the source speed.\n"), pc);
795 LocaleGuard::LocaleGuard ()
798 char const * old = setlocale (LC_NUMERIC, 0);
802 if (strcmp (_old, "C")) {
803 setlocale (LC_NUMERIC, "C");
808 LocaleGuard::~LocaleGuard ()
810 setlocale (LC_NUMERIC, _old);