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"
65 #ifdef DCPOMATIC_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 static boost::thread::id ui_thread;
96 static 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;
123 /** @param s Number of seconds.
124 * @return String containing an approximate description of s (e.g. "about 2 hours")
127 seconds_to_approximate_hms (int s)
138 ap << (h + 1) << N_(" ") << _("hours");
141 ap << N_("1 ") << _("hour");
143 ap << h << N_(" ") << _("hours");
148 ap << N_("1 ") << _("minute");
150 ap << m << N_(" ") << _("minutes");
153 ap << s << N_(" ") << _("seconds");
159 #ifdef DCPOMATIC_POSIX
160 /** @param l Mangled C++ identifier.
161 * @return Demangled version.
166 string::size_type const b = l.find_first_of (N_("("));
167 if (b == string::npos) {
171 string::size_type const p = l.find_last_of (N_("+"));
172 if (p == string::npos) {
180 string const fn = l.substr (b + 1, p - b - 1);
185 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
190 } catch (std::exception) {
197 /** Write a stacktrace to an ostream.
198 * @param out Stream to write to.
199 * @param levels Number of levels to go up the call stack.
202 stacktrace (ostream& out, int levels)
205 size_t size = backtrace (array, 200);
206 char** strings = backtrace_symbols (array, size);
209 for (size_t i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
210 out << N_(" ") << demangle (strings[i]) << "\n";
218 /** @param v Version as used by FFmpeg.
219 * @return A string representation of v.
222 ffmpeg_version_to_string (int v)
225 s << ((v & 0xff0000) >> 16) << N_(".") << ((v & 0xff00) >> 8) << N_(".") << (v & 0xff);
229 /** Return a user-readable string summarising the versions of our dependencies */
231 dependency_version_summary ()
234 s << N_("libopenjpeg ") << opj_version () << N_(", ")
235 << N_("libavcodec ") << ffmpeg_version_to_string (avcodec_version()) << N_(", ")
236 << N_("libavfilter ") << ffmpeg_version_to_string (avfilter_version()) << N_(", ")
237 << N_("libavformat ") << ffmpeg_version_to_string (avformat_version()) << N_(", ")
238 << N_("libavutil ") << ffmpeg_version_to_string (avutil_version()) << N_(", ")
239 << N_("libpostproc ") << ffmpeg_version_to_string (postproc_version()) << N_(", ")
240 << N_("libswscale ") << ffmpeg_version_to_string (swscale_version()) << N_(", ")
241 << MagickVersion << N_(", ")
242 << N_("libssh ") << ssh_version (0) << N_(", ")
243 << N_("libdcp ") << libdcp::version << N_(" git ") << libdcp::git_commit;
249 seconds (struct timeval t)
251 return t.tv_sec + (double (t.tv_usec) / 1e6);
254 #ifdef DCPOMATIC_WINDOWS
255 LONG WINAPI exception_handler(struct _EXCEPTION_POINTERS *)
258 ofstream f (backtrace_file.string().c_str());
259 std::copy(s.begin(), s.end(), std::ostream_iterator<dbg::stack_frame>(f, "\n"));
260 return EXCEPTION_CONTINUE_SEARCH;
264 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
265 * Must be called from the UI thread, if there is one.
270 #ifdef DCPOMATIC_WINDOWS
271 backtrace_file /= g_get_user_config_dir ();
272 backtrace_file /= "backtrace.txt";
273 SetUnhandledExceptionFilter(exception_handler);
276 avfilter_register_all ();
278 Ratio::setup_ratios ();
279 DCPContentType::setup_dcp_content_types ();
280 Scaler::setup_scalers ();
281 Filter::setup_filters ();
282 SoundProcessor::setup_sound_processors ();
284 ui_thread = boost::this_thread::get_id ();
287 #ifdef DCPOMATIC_WINDOWS
288 boost::filesystem::path
292 GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
293 boost::filesystem::path p (buffer);
294 p = p.parent_path ();
295 p = p.parent_path ();
302 dcpomatic_setup_gettext_i18n (string lang)
304 #ifdef DCPOMATIC_POSIX
308 if (!lang.empty ()) {
309 /* Override our environment language; this is essential on
313 snprintf (cmd, sizeof(cmd), "LANGUAGE=%s", lang.c_str ());
315 snprintf (cmd, sizeof(cmd), "LANG=%s", lang.c_str ());
319 setlocale (LC_ALL, "");
320 textdomain ("libdcpomatic");
322 #ifdef DCPOMATIC_WINDOWS
323 bindtextdomain ("libdcpomatic", mo_path().string().c_str());
324 bind_textdomain_codeset ("libdcpomatic", "UTF8");
327 #ifdef DCPOMATIC_POSIX
328 bindtextdomain ("libdcpomatic", POSIX_LOCALE_PREFIX);
332 /** @param s A string.
333 * @return Parts of the string split at spaces, except when a space is within quotation marks.
336 split_at_spaces_considering_quotes (string s)
339 bool in_quotes = false;
341 for (string::size_type i = 0; i < s.length(); ++i) {
342 if (s[i] == ' ' && !in_quotes) {
345 } else if (s[i] == '"') {
346 in_quotes = !in_quotes;
357 md5_digest (void const * data, int size)
360 MD5_Init (&md5_context);
361 MD5_Update (&md5_context, data, size);
362 unsigned char digest[MD5_DIGEST_LENGTH];
363 MD5_Final (digest, &md5_context);
366 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
367 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
373 /** @param file File name.
374 * @return MD5 digest of file's contents.
377 md5_digest (boost::filesystem::path file)
379 ifstream f (file.string().c_str(), std::ios::binary);
381 throw OpenFileError (file.string());
384 f.seekg (0, std::ios::end);
385 int bytes = f.tellg ();
386 f.seekg (0, std::ios::beg);
388 int const buffer_size = 64 * 1024;
389 char buffer[buffer_size];
392 MD5_Init (&md5_context);
394 int const t = min (bytes, buffer_size);
396 MD5_Update (&md5_context, buffer, t);
400 unsigned char digest[MD5_DIGEST_LENGTH];
401 MD5_Final (digest, &md5_context);
404 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
405 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
411 /** @param job Optional job for which to report progress */
413 md5_digest_directory (boost::filesystem::path directory, shared_ptr<Job> job)
415 int const buffer_size = 64 * 1024;
416 char buffer[buffer_size];
419 MD5_Init (&md5_context);
423 for (boost::filesystem::directory_iterator i(directory); i != boost::filesystem::directory_iterator(); ++i) {
429 for (boost::filesystem::directory_iterator i(directory); i != boost::filesystem::directory_iterator(); ++i) {
430 ifstream f (i->path().string().c_str(), std::ios::binary);
432 throw OpenFileError (i->path().string());
435 f.seekg (0, std::ios::end);
436 int bytes = f.tellg ();
437 f.seekg (0, std::ios::beg);
440 int const t = min (bytes, buffer_size);
442 MD5_Update (&md5_context, buffer, t);
447 job->set_progress (float (j) / files);
452 unsigned char digest[MD5_DIGEST_LENGTH];
453 MD5_Final (digest, &md5_context);
456 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
457 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
464 about_equal (float a, float b)
466 /* A film of F seconds at f FPS will be Ff frames;
467 Consider some delta FPS d, so if we run the same
468 film at (f + d) FPS it will last F(f + d) seconds.
470 Hence the difference in length over the length of the film will
471 be F(f + d) - Ff frames
472 = Ff + Fd - Ff frames
476 So if we accept a difference of 1 frame, ie 1/f seconds, we can
483 So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
484 FPS error is 1/F ~= 0.0001 ~= 10-e4
487 return (fabs (a - b) < 1e-4);
490 /** @param An arbitrary audio frame rate.
491 * @return The appropriate DCP-approved frame rate (48kHz or 96kHz).
494 dcp_audio_frame_rate (int fs)
503 Socket::Socket (int timeout)
504 : _deadline (_io_service)
505 , _socket (_io_service)
508 _deadline.expires_at (boost::posix_time::pos_infin);
515 if (_deadline.expires_at() <= boost::asio::deadline_timer::traits_type::now ()) {
517 _deadline.expires_at (boost::posix_time::pos_infin);
520 _deadline.async_wait (boost::bind (&Socket::check, this));
523 /** Blocking connect.
524 * @param endpoint End-point to connect to.
527 Socket::connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint)
529 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
530 boost::system::error_code ec = boost::asio::error::would_block;
531 _socket.async_connect (endpoint, boost::lambda::var(ec) = boost::lambda::_1);
533 _io_service.run_one();
534 } while (ec == boost::asio::error::would_block);
536 if (ec || !_socket.is_open ()) {
537 throw NetworkError (_("connect timed out"));
542 * @param data Buffer to write.
543 * @param size Number of bytes to write.
546 Socket::write (uint8_t const * data, int size)
548 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
549 boost::system::error_code ec = boost::asio::error::would_block;
551 boost::asio::async_write (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
554 _io_service.run_one ();
555 } while (ec == boost::asio::error::would_block);
558 throw NetworkError (ec.message ());
563 Socket::write (uint32_t v)
566 write (reinterpret_cast<uint8_t*> (&v), 4);
570 * @param data Buffer to read to.
571 * @param size Number of bytes to read.
574 Socket::read (uint8_t* data, int size)
576 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
577 boost::system::error_code ec = boost::asio::error::would_block;
579 boost::asio::async_read (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
582 _io_service.run_one ();
583 } while (ec == boost::asio::error::would_block);
586 throw NetworkError (ec.message ());
591 Socket::read_uint32 ()
594 read (reinterpret_cast<uint8_t *> (&v), 4);
598 /** Round a number up to the nearest multiple of another number.
600 * @param s Array of numbers to round, indexed by c.
601 * @param t Multiple to round to.
602 * @return Rounded number.
605 stride_round_up (int c, int const * stride, int t)
607 int const a = stride[c] + (t - 1);
611 /** Read a sequence of key / value pairs from a text stream;
612 * the keys are the first words on the line, and the values are
613 * the remainder of the line following the key. Lines beginning
614 * with # are ignored.
615 * @param s Stream to read.
616 * @return key/value pairs.
618 multimap<string, string>
619 read_key_value (istream &s)
621 multimap<string, string> kv;
624 while (getline (s, line)) {
629 if (line[0] == '#') {
633 if (line[line.size() - 1] == '\r') {
634 line = line.substr (0, line.size() - 1);
637 size_t const s = line.find (' ');
638 if (s == string::npos) {
642 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
649 get_required_string (multimap<string, string> const & kv, string k)
651 if (kv.count (k) > 1) {
652 throw StringError (N_("unexpected multiple keys in key-value set"));
655 multimap<string, string>::const_iterator i = kv.find (k);
657 if (i == kv.end ()) {
658 throw StringError (String::compose (_("missing key %1 in key-value set"), k));
665 get_required_int (multimap<string, string> const & kv, string k)
667 string const v = get_required_string (kv, k);
668 return lexical_cast<int> (v);
672 get_required_float (multimap<string, string> const & kv, string k)
674 string const v = get_required_string (kv, k);
675 return lexical_cast<float> (v);
679 get_optional_string (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 ()) {
694 get_optional_int (multimap<string, string> const & kv, string k)
696 if (kv.count (k) > 1) {
697 throw StringError (N_("unexpected multiple keys in key-value set"));
700 multimap<string, string>::const_iterator i = kv.find (k);
701 if (i == kv.end ()) {
705 return lexical_cast<int> (i->second);
708 /** Trip an assert if the caller is not in the UI thread */
712 assert (boost::this_thread::get_id() == ui_thread);
715 /** @param v Content video frame.
716 * @param audio_sample_rate Source audio sample rate.
717 * @param frames_per_second Number of video frames per second.
718 * @return Equivalent number of audio frames for `v'.
721 video_frames_to_audio_frames (VideoContent::Frame v, float audio_sample_rate, float frames_per_second)
723 return ((int64_t) v * audio_sample_rate / frames_per_second);
727 audio_channel_name (int c)
729 assert (MAX_AUDIO_CHANNELS == 6);
731 /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
732 enhancement channel (sub-woofer)./
734 string const channels[] = {
746 FrameRateConversion::FrameRateConversion (float source, int dcp)
749 , change_speed (false)
751 if (fabs (source / 2.0 - dcp) < (fabs (source - dcp))) {
753 } else if (fabs (source * 2 - dcp) < fabs (source - dcp)) {
757 change_speed = !about_equal (source * factor(), dcp);
759 if (!skip && !repeat && !change_speed) {
760 description = _("Content and DCP have the same rate.\n");
763 description = _("DCP will use every other frame of the content.\n");
765 description = _("Each content frame will be doubled in the DCP.\n");
769 float const pc = dcp * 100 / (source * factor());
770 description += String::compose (_("DCP will run at %1%% of the content speed.\n"), pc);
775 LocaleGuard::LocaleGuard ()
778 char const * old = setlocale (LC_NUMERIC, 0);
782 if (strcmp (_old, "C")) {
783 setlocale (LC_NUMERIC, "C");
788 LocaleGuard::~LocaleGuard ()
790 setlocale (LC_NUMERIC, _old);
795 valid_image_file (boost::filesystem::path f)
797 string ext = f.extension().string();
798 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
799 return (ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png" || ext == ".bmp" || ext == ".tga");