2 Copyright (C) 2012-2014 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/thread.hpp>
40 #include <boost/filesystem.hpp>
41 #ifdef DCPOMATIC_WINDOWS
42 #include <boost/locale.hpp>
46 #include <pangomm/init.h>
47 #ifdef DCPOMATIC_IMAGE_MAGICK
48 #include <magick/MagickCore.h>
50 #include <magick/common.h>
51 #include <magick/magick_config.h>
53 #include <magick/version.h>
54 #include <dcp/version.h>
56 #include <dcp/signer.h>
57 #include <dcp/raw_convert.h>
59 #include <libavcodec/avcodec.h>
60 #include <libavformat/avformat.h>
61 #include <libswscale/swscale.h>
62 #include <libavfilter/avfiltergraph.h>
63 #include <libavutil/pixfmt.h>
66 #include "exceptions.h"
68 #include "dcp_content_type.h"
70 #include "cinema_sound_processor.h"
75 #include "video_content.h"
77 #include "md5_digester.h"
78 #include "audio_processor.h"
79 #include "safe_stringstream.h"
80 #ifdef DCPOMATIC_WINDOWS
100 using std::numeric_limits;
103 using std::bad_alloc;
104 using std::streampos;
105 using std::set_terminate;
106 using boost::shared_ptr;
108 using boost::optional;
110 using dcp::raw_convert;
112 static boost::thread::id ui_thread;
113 static boost::filesystem::path backtrace_file;
115 /** Convert some number of seconds to a string representation
116 * in hours, minutes and seconds.
119 * @return String of the form H:M:S (where H is hours, M
120 * is minutes and S is seconds).
123 seconds_to_hms (int s)
130 SafeStringStream hms;
133 hms << std::setfill ('0') << m << N_(":");
135 hms << std::setfill ('0') << s;
140 /** @param s Number of seconds.
141 * @return String containing an approximate description of s (e.g. "about 2 hours")
144 seconds_to_approximate_hms (int s)
153 bool const hours = h > 0;
154 bool const minutes = h < 10 && m > 0;
155 bool const seconds = m < 10 && s > 0;
158 if (m > 30 && !minutes) {
159 ap << (h + 1) << N_(" ") << _("hours");
169 if (minutes | seconds) {
176 if (s > 30 && !seconds) {
177 ap << (m + 1) << N_(" ") << _("minutes");
205 #ifdef DCPOMATIC_POSIX
206 /** @param l Mangled C++ identifier.
207 * @return Demangled version.
212 string::size_type const b = l.find_first_of (N_("("));
213 if (b == string::npos) {
217 string::size_type const p = l.find_last_of (N_("+"));
218 if (p == string::npos) {
226 string const fn = l.substr (b + 1, p - b - 1);
231 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
236 } catch (std::exception) {
243 /** Write a stacktrace to an ostream.
244 * @param out Stream to write to.
245 * @param levels Number of levels to go up the call stack.
248 stacktrace (ostream& out, int levels)
251 size_t size = backtrace (array, 200);
252 char** strings = backtrace_symbols (array, size);
255 for (size_t i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
256 out << N_(" ") << demangle (strings[i]) << "\n";
264 /** @param v Version as used by FFmpeg.
265 * @return A string representation of v.
268 ffmpeg_version_to_string (int v)
271 s << ((v & 0xff0000) >> 16) << N_(".") << ((v & 0xff00) >> 8) << N_(".") << (v & 0xff);
276 seconds (struct timeval t)
278 return t.tv_sec + (double (t.tv_usec) / 1e6);
281 #ifdef DCPOMATIC_WINDOWS
282 LONG WINAPI exception_handler(struct _EXCEPTION_POINTERS *)
285 FILE* f = fopen_boost (backtrace_file, "w");
286 fprintf (f, "Exception thrown:");
287 for (dbg::stack::const_iterator i = s.begin(); i != s.end(); ++i) {
288 fprintf (f, "%p %s %d %s\n", i->instruction, i->function.c_str(), i->line, i->module.c_str());
291 return EXCEPTION_CONTINUE_SEARCH;
295 /* From http://stackoverflow.com/questions/2443135/how-do-i-find-where-an-exception-was-thrown-in-c */
299 static bool tried_throw = false;
302 // try once to re-throw currently active exception
308 catch (const std::exception &e) {
309 std::cerr << __FUNCTION__ << " caught unhandled exception. what(): "
310 << e.what() << std::endl;
313 std::cerr << __FUNCTION__ << " caught unknown/unhandled exception."
317 #ifdef DCPOMATIC_POSIX
318 stacktrace (cout, 50);
323 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
324 * Must be called from the UI thread, if there is one.
329 #ifdef DCPOMATIC_WINDOWS
330 backtrace_file /= g_get_user_config_dir ();
331 backtrace_file /= "backtrace.txt";
332 SetUnhandledExceptionFilter(exception_handler);
334 /* Dark voodoo which, I think, gets boost::filesystem::path to
335 correctly convert UTF-8 strings to paths, and also paths
336 back to UTF-8 strings (on path::string()).
338 After this, constructing boost::filesystem::paths from strings
339 converts from UTF-8 to UTF-16 inside the path. Then
340 path::string().c_str() gives UTF-8 and
341 path::c_str() gives UTF-16.
343 This is all Windows-only. AFAICT Linux/OS X use UTF-8 everywhere,
344 so things are much simpler.
346 std::locale::global (boost::locale::generator().generate (""));
347 boost::filesystem::path::imbue (std::locale ());
350 avfilter_register_all ();
353 /* Add our lib directory to the libltdl search path so that
354 xmlsec can find xmlsec1-openssl.
356 boost::filesystem::path lib = app_contents ();
358 setenv ("LTDL_LIBRARY_PATH", lib.c_str (), 1);
361 set_terminate (terminate);
366 Ratio::setup_ratios ();
367 VideoContentScale::setup_scales ();
368 DCPContentType::setup_dcp_content_types ();
369 Scaler::setup_scalers ();
370 Filter::setup_filters ();
371 CinemaSoundProcessor::setup_cinema_sound_processors ();
372 AudioProcessor::setup_audio_processors ();
374 ui_thread = boost::this_thread::get_id ();
377 #ifdef DCPOMATIC_WINDOWS
378 boost::filesystem::path
382 GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
383 boost::filesystem::path p (buffer);
384 p = p.parent_path ();
385 p = p.parent_path ();
392 boost::filesystem::path
395 return "DCP-o-matic 2.app/Contents/Resources";
400 dcpomatic_setup_gettext_i18n (string lang)
402 #ifdef DCPOMATIC_LINUX
406 if (!lang.empty ()) {
407 /* Override our environment language. Note that the caller must not
408 free the string passed into putenv().
410 string s = String::compose ("LANGUAGE=%1", lang);
411 putenv (strdup (s.c_str ()));
412 s = String::compose ("LANG=%1", lang);
413 putenv (strdup (s.c_str ()));
414 s = String::compose ("LC_ALL=%1", lang);
415 putenv (strdup (s.c_str ()));
418 setlocale (LC_ALL, "");
419 textdomain ("libdcpomatic");
421 #if defined(DCPOMATIC_WINDOWS) || defined(DCPOMATIC_OSX)
422 bindtextdomain ("libdcpomatic", mo_path().string().c_str());
423 bind_textdomain_codeset ("libdcpomatic", "UTF8");
426 #ifdef DCPOMATIC_LINUX
427 bindtextdomain ("libdcpomatic", POSIX_LOCALE_PREFIX);
431 /** @param s A string.
432 * @return Parts of the string split at spaces, except when a space is within quotation marks.
435 split_at_spaces_considering_quotes (string s)
438 bool in_quotes = false;
440 for (string::size_type i = 0; i < s.length(); ++i) {
441 if (s[i] == ' ' && !in_quotes) {
444 } else if (s[i] == '"') {
445 in_quotes = !in_quotes;
455 /** @param job Optional job for which to report progress */
457 md5_digest (vector<boost::filesystem::path> files, shared_ptr<Job> job)
459 boost::uintmax_t const buffer_size = 64 * 1024;
460 char buffer[buffer_size];
462 MD5Digester digester;
464 vector<int64_t> sizes;
465 for (size_t i = 0; i < files.size(); ++i) {
466 sizes.push_back (boost::filesystem::file_size (files[i]));
469 for (size_t i = 0; i < files.size(); ++i) {
470 FILE* f = fopen_boost (files[i], "rb");
472 throw OpenFileError (files[i].string());
475 boost::uintmax_t const bytes = boost::filesystem::file_size (files[i]);
476 boost::uintmax_t remaining = bytes;
478 while (remaining > 0) {
479 int const t = min (remaining, buffer_size);
480 int const r = fread (buffer, 1, t, f);
482 throw ReadFileError (files[i], errno);
484 digester.add (buffer, t);
488 job->set_progress ((float (i) + 1 - float(remaining) / bytes) / files.size ());
495 return digester.get ();
498 /** @param An arbitrary audio frame rate.
499 * @return The appropriate DCP-approved frame rate (48kHz or 96kHz).
502 dcp_audio_frame_rate (int fs)
511 Socket::Socket (int timeout)
512 : _deadline (_io_service)
513 , _socket (_io_service)
517 _deadline.expires_at (boost::posix_time::pos_infin);
529 if (_deadline.expires_at() <= boost::asio::deadline_timer::traits_type::now ()) {
531 _acceptor->cancel ();
535 _deadline.expires_at (boost::posix_time::pos_infin);
538 _deadline.async_wait (boost::bind (&Socket::check, this));
541 /** Blocking connect.
542 * @param endpoint End-point to connect to.
545 Socket::connect (boost::asio::ip::tcp::endpoint endpoint)
547 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
548 boost::system::error_code ec = boost::asio::error::would_block;
549 _socket.async_connect (endpoint, boost::lambda::var(ec) = boost::lambda::_1);
551 _io_service.run_one();
552 } while (ec == boost::asio::error::would_block);
555 throw NetworkError (String::compose (_("error during async_connect (%1)"), ec.value ()));
558 if (!_socket.is_open ()) {
559 throw NetworkError (_("connect timed out"));
564 Socket::accept (int port)
566 _acceptor = new boost::asio::ip::tcp::acceptor (_io_service, boost::asio::ip::tcp::endpoint (boost::asio::ip::tcp::v4(), port));
568 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
569 boost::system::error_code ec = boost::asio::error::would_block;
570 _acceptor->async_accept (_socket, boost::lambda::var(ec) = boost::lambda::_1);
572 _io_service.run_one ();
573 } while (ec == boost::asio::error::would_block);
579 throw NetworkError (String::compose (_("error during async_accept (%1)"), ec.value ()));
584 * @param data Buffer to write.
585 * @param size Number of bytes to write.
588 Socket::write (uint8_t const * data, int size)
590 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
591 boost::system::error_code ec = boost::asio::error::would_block;
593 boost::asio::async_write (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
596 _io_service.run_one ();
597 } while (ec == boost::asio::error::would_block);
600 throw NetworkError (String::compose (_("error during async_write (%1)"), ec.value ()));
605 Socket::write (uint32_t v)
608 write (reinterpret_cast<uint8_t*> (&v), 4);
612 * @param data Buffer to read to.
613 * @param size Number of bytes to read.
616 Socket::read (uint8_t* data, int size)
618 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
619 boost::system::error_code ec = boost::asio::error::would_block;
621 boost::asio::async_read (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
624 _io_service.run_one ();
625 } while (ec == boost::asio::error::would_block);
628 throw NetworkError (String::compose (_("error during async_read (%1)"), ec.value ()));
633 Socket::read_uint32 ()
636 read (reinterpret_cast<uint8_t *> (&v), 4);
640 /** Round a number up to the nearest multiple of another number.
642 * @param s Array of numbers to round, indexed by c.
643 * @param t Multiple to round to.
644 * @return Rounded number.
647 stride_round_up (int c, int const * stride, int t)
649 int const a = stride[c] + (t - 1);
653 /** @param n A number.
654 * @param r Rounding `boundary' (must be a power of 2)
655 * @return n rounded to the nearest r
658 round_to (float n, int r)
660 assert (r == 1 || r == 2 || r == 4);
661 return int (n + float(r) / 2) &~ (r - 1);
664 /** Read a sequence of key / value pairs from a text stream;
665 * the keys are the first words on the line, and the values are
666 * the remainder of the line following the key. Lines beginning
667 * with # are ignored.
668 * @param s Stream to read.
669 * @return key/value pairs.
671 multimap<string, string>
672 read_key_value (istream &s)
674 multimap<string, string> kv;
677 while (getline (s, line)) {
682 if (line[0] == '#') {
686 if (line[line.size() - 1] == '\r') {
687 line = line.substr (0, line.size() - 1);
690 size_t const s = line.find (' ');
691 if (s == string::npos) {
695 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
702 get_required_string (multimap<string, string> const & kv, string k)
704 if (kv.count (k) > 1) {
705 throw StringError (N_("unexpected multiple keys in key-value set"));
708 multimap<string, string>::const_iterator i = kv.find (k);
710 if (i == kv.end ()) {
711 throw StringError (String::compose (_("missing key %1 in key-value set"), k));
718 get_required_int (multimap<string, string> const & kv, string k)
720 string const v = get_required_string (kv, k);
721 return raw_convert<int> (v);
725 get_required_float (multimap<string, string> const & kv, string k)
727 string const v = get_required_string (kv, k);
728 return raw_convert<float> (v);
732 get_optional_string (multimap<string, string> const & kv, string k)
734 if (kv.count (k) > 1) {
735 throw StringError (N_("unexpected multiple keys in key-value set"));
738 multimap<string, string>::const_iterator i = kv.find (k);
739 if (i == kv.end ()) {
747 get_optional_int (multimap<string, string> const & kv, string k)
749 if (kv.count (k) > 1) {
750 throw StringError (N_("unexpected multiple keys in key-value set"));
753 multimap<string, string>::const_iterator i = kv.find (k);
754 if (i == kv.end ()) {
758 return raw_convert<int> (i->second);
761 /** Trip an assert if the caller is not in the UI thread */
765 assert (boost::this_thread::get_id() == ui_thread);
769 audio_channel_name (int c)
771 assert (MAX_DCP_AUDIO_CHANNELS == 12);
773 /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
774 enhancement channel (sub-woofer). HI is the hearing-impaired audio track and
775 VI is the visually-impaired audio track (audio describe).
777 string const channels[] = {
784 _("Hearing impaired"),
785 _("Visually impaired"),
788 _("Left rear surround"),
789 _("Right rear surround"),
796 valid_image_file (boost::filesystem::path f)
798 string ext = f.extension().string();
799 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
800 return (ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png" || ext == ".bmp" || ext == ".tga" || ext == ".dpx");
804 tidy_for_filename (string f)
807 for (size_t i = 0; i < f.length(); ++i) {
808 if (isalnum (f[i]) || f[i] == '_' || f[i] == '-') {
819 split_get_request (string url)
822 AWAITING_QUESTION_MARK,
825 } state = AWAITING_QUESTION_MARK;
827 map<string, string> r;
830 for (size_t i = 0; i < url.length(); ++i) {
832 case AWAITING_QUESTION_MARK:
847 r.insert (make_pair (k, v));
857 if (state == VALUE) {
858 r.insert (make_pair (k, v));
865 fit_ratio_within (float ratio, dcp::Size full_frame, int round)
867 if (ratio < full_frame.ratio ()) {
868 return dcp::Size (round_to (full_frame.height * ratio, round), full_frame.height);
871 return dcp::Size (full_frame.width, round_to (full_frame.width / ratio, round));
875 wrapped_av_malloc (size_t s)
877 void* p = av_malloc (s);
885 entities_to_text (string e)
887 boost::algorithm::replace_all (e, "%3A", ":");
888 boost::algorithm::replace_all (e, "%2F", "/");
893 divide_with_round (int64_t a, int64_t b)
895 if (a % b >= (b / 2)) {
896 return (a + b - 1) / b;
902 /** Return a user-readable string summarising the versions of our dependencies */
904 dependency_version_summary ()
907 s << N_("libopenjpeg ") << opj_version () << N_(", ")
908 << N_("libavcodec ") << ffmpeg_version_to_string (avcodec_version()) << N_(", ")
909 << N_("libavfilter ") << ffmpeg_version_to_string (avfilter_version()) << N_(", ")
910 << N_("libavformat ") << ffmpeg_version_to_string (avformat_version()) << N_(", ")
911 << N_("libavutil ") << ffmpeg_version_to_string (avutil_version()) << N_(", ")
912 << N_("libswscale ") << ffmpeg_version_to_string (swscale_version()) << N_(", ")
913 << MagickVersion << N_(", ")
914 << N_("libssh ") << ssh_version (0) << N_(", ")
915 << N_("libdcp ") << dcp::version << N_(" git ") << dcp::git_commit;
920 /** Construct a ScopedTemporary. A temporary filename is decided but the file is not opened
921 * until ::open() is called.
923 ScopedTemporary::ScopedTemporary ()
926 _file = boost::filesystem::temp_directory_path() / boost::filesystem::unique_path ();
929 /** Close and delete the temporary file */
930 ScopedTemporary::~ScopedTemporary ()
933 boost::system::error_code ec;
934 boost::filesystem::remove (_file, ec);
937 /** @return temporary filename */
939 ScopedTemporary::c_str () const
941 return _file.string().c_str ();
944 /** Open the temporary file.
945 * @return File's FILE pointer.
948 ScopedTemporary::open (char const * params)
950 _open = fopen (c_str(), params);
954 /** Close the file */
956 ScopedTemporary::close ()
965 subtitle_period (AVSubtitle const & sub)
967 ContentTime const packet_time = ContentTime::from_seconds (static_cast<double> (sub.pts) / AV_TIME_BASE);
969 ContentTimePeriod period (
970 packet_time + ContentTime::from_seconds (sub.start_display_time / 1e3),
971 packet_time + ContentTime::from_seconds (sub.end_display_time / 1e3)