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>
43 #include <openssl/md5.h>
44 #include <magick/MagickCore.h>
45 #include <magick/version.h>
46 #include <libdcp/version.h>
48 #include <libavcodec/avcodec.h>
49 #include <libavformat/avformat.h>
50 #include <libswscale/swscale.h>
51 #include <libavfilter/avfiltergraph.h>
52 #include <libpostproc/postprocess.h>
53 #include <libavutil/pixfmt.h>
56 #include "exceptions.h"
59 #include "dcp_content_type.h"
61 #include "sound_processor.h"
67 using std::stringstream;
81 using std::numeric_limits;
83 using boost::shared_ptr;
85 using boost::lexical_cast;
90 /** Convert some number of seconds to a string representation
91 * in hours, minutes and seconds.
94 * @return String of the form H:M:S (where H is hours, M
95 * is minutes and S is seconds).
98 seconds_to_hms (int s)
108 hms << setfill ('0') << m << N_(":");
110 hms << setfill ('0') << s;
115 /** @param s Number of seconds.
116 * @return String containing an approximate description of s (e.g. "about 2 hours")
119 seconds_to_approximate_hms (int s)
130 ap << (h + 1) << N_(" ") << _("hours");
133 ap << N_("1 ") << _("hour");
135 ap << h << N_(" ") << _("hours");
140 ap << N_("1 ") << _("minute");
142 ap << m << N_(" ") << _("minutes");
145 ap << s << N_(" ") << _("seconds");
151 #ifdef DVDOMATIC_POSIX
152 /** @param l Mangled C++ identifier.
153 * @return Demangled version.
158 string::size_type const b = l.find_first_of (N_("("));
159 if (b == string::npos) {
163 string::size_type const p = l.find_last_of (N_("+"));
164 if (p == string::npos) {
172 string const fn = l.substr (b + 1, p - b - 1);
177 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
182 } catch (std::exception) {
189 /** Write a stacktrace to an ostream.
190 * @param out Stream to write to.
191 * @param levels Number of levels to go up the call stack.
194 stacktrace (ostream& out, int levels)
201 size = backtrace (array, 200);
202 strings = backtrace_symbols (array, size);
205 for (i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
206 out << N_(" ") << demangle (strings[i]) << endl;
214 /** @param v Version as used by FFmpeg.
215 * @return A string representation of v.
218 ffmpeg_version_to_string (int v)
221 s << ((v & 0xff0000) >> 16) << N_(".") << ((v & 0xff00) >> 8) << N_(".") << (v & 0xff);
225 /** Return a user-readable string summarising the versions of our dependencies */
227 dependency_version_summary ()
230 s << N_("libopenjpeg ") << opj_version () << N_(", ")
231 << N_("libavcodec ") << ffmpeg_version_to_string (avcodec_version()) << N_(", ")
232 << N_("libavfilter ") << ffmpeg_version_to_string (avfilter_version()) << N_(", ")
233 << N_("libavformat ") << ffmpeg_version_to_string (avformat_version()) << N_(", ")
234 << N_("libavutil ") << ffmpeg_version_to_string (avutil_version()) << N_(", ")
235 << N_("libpostproc ") << ffmpeg_version_to_string (postproc_version()) << N_(", ")
236 << N_("libswscale ") << ffmpeg_version_to_string (swscale_version()) << N_(", ")
237 << MagickVersion << N_(", ")
238 << N_("libssh ") << ssh_version (0) << N_(", ")
239 << N_("libdcp ") << libdcp::version << N_(" git ") << libdcp::git_commit;
245 seconds (struct timeval t)
247 return t.tv_sec + (double (t.tv_usec) / 1e6);
250 /** Call the required functions to set up DVD-o-matic's static arrays, etc.
251 * Must be called from the UI thread, if there is one.
256 avfilter_register_all ();
258 Format::setup_formats ();
259 DCPContentType::setup_dcp_content_types ();
260 Scaler::setup_scalers ();
261 Filter::setup_filters ();
262 SoundProcessor::setup_sound_processors ();
264 ui_thread = boost::this_thread::get_id ();
267 #ifdef DVDOMATIC_WINDOWS
268 boost::filesystem::path
272 GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
273 boost::filesystem::path p (buffer);
274 p = p.parent_path ();
275 p = p.parent_path ();
282 dvdomatic_setup_i18n (string lang)
284 #ifdef DVDOMATIC_POSIX
288 if (!lang.empty ()) {
289 /* Override our environment language; this is essential on
293 snprintf (cmd, sizeof(cmd), "LANGUAGE=%s", lang.c_str ());
295 snprintf (cmd, sizeof(cmd), "LANG=%s", lang.c_str ());
299 setlocale (LC_ALL, "");
300 textdomain ("libdvdomatic");
302 #ifdef DVDOMATIC_WINDOWS
303 bindtextdomain ("libdvdomatic", mo_path().string().c_str());
304 bind_textdomain_codeset ("libdvdomatic", "UTF8");
307 #ifdef DVDOMATIC_POSIX
308 bindtextdomain ("libdvdomatic", POSIX_LOCALE_PREFIX);
312 /** @param start Start position for the crop within the image.
313 * @param size Size of the cropped area.
314 * @return FFmpeg crop filter string.
317 crop_string (Position start, libdcp::Size size)
320 s << N_("crop=") << size.width << N_(":") << size.height << N_(":") << start.x << N_(":") << start.y;
324 /** @param s A string.
325 * @return Parts of the string split at spaces, except when a space is within quotation marks.
328 split_at_spaces_considering_quotes (string s)
331 bool in_quotes = false;
333 for (string::size_type i = 0; i < s.length(); ++i) {
334 if (s[i] == ' ' && !in_quotes) {
337 } else if (s[i] == '"') {
338 in_quotes = !in_quotes;
349 md5_digest (void const * data, int size)
352 MD5_Init (&md5_context);
353 MD5_Update (&md5_context, data, size);
354 unsigned char digest[MD5_DIGEST_LENGTH];
355 MD5_Final (digest, &md5_context);
358 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
359 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
365 /** @param file File name.
366 * @return MD5 digest of file's contents.
369 md5_digest (boost::filesystem::path file)
371 ifstream f (file.string().c_str(), ios::binary);
373 throw OpenFileError (file.string());
376 f.seekg (0, ios::end);
377 int bytes = f.tellg ();
378 f.seekg (0, ios::beg);
380 int const buffer_size = 64 * 1024;
381 char buffer[buffer_size];
384 MD5_Init (&md5_context);
386 int const t = min (bytes, buffer_size);
388 MD5_Update (&md5_context, buffer, t);
392 unsigned char digest[MD5_DIGEST_LENGTH];
393 MD5_Final (digest, &md5_context);
396 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
397 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
404 about_equal (float a, float b)
406 /* A film of F seconds at f FPS will be Ff frames;
407 Consider some delta FPS d, so if we run the same
408 film at (f + d) FPS it will last F(f + d) seconds.
410 Hence the difference in length over the length of the film will
411 be F(f + d) - Ff frames
412 = Ff + Fd - Ff frames
416 So if we accept a difference of 1 frame, ie 1/f seconds, we can
423 So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
424 FPS error is 1/F ~= 0.0001 ~= 10-e4
427 return (fabs (a - b) < 1e-4);
430 class FrameRateCandidate
433 FrameRateCandidate (float source_, int dcp_)
443 best_dcp_frame_rate (float source_fps)
445 list<int> const allowed_dcp_frame_rates = Config::instance()->allowed_dcp_frame_rates ();
447 /* Work out what rates we could manage, including those achieved by using skip / repeat. */
448 list<FrameRateCandidate> candidates;
450 /* Start with the ones without skip / repeat so they will get matched in preference to skipped/repeated ones */
451 for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
452 candidates.push_back (FrameRateCandidate (*i, *i));
455 /* Then the skip/repeat ones */
456 for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
457 candidates.push_back (FrameRateCandidate (float (*i) / 2, *i));
458 candidates.push_back (FrameRateCandidate (float (*i) * 2, *i));
461 /* Pick the best one, bailing early if we hit an exact match */
462 float error = numeric_limits<float>::max ();
463 boost::optional<FrameRateCandidate> best;
464 list<FrameRateCandidate>::iterator i = candidates.begin();
465 while (i != candidates.end()) {
467 if (about_equal (i->source, source_fps)) {
472 float const e = fabs (i->source - source_fps);
485 /** @param An arbitrary sampling rate.
486 * @return The appropriate DCP-approved sampling rate (48kHz or 96kHz).
489 dcp_audio_sample_rate (int fs)
498 /** @param index Colour LUT index.
499 * @return Human-readable name.
502 colour_lut_index_to_name (int index)
515 Socket::Socket (int timeout)
516 : _deadline (_io_service)
517 , _socket (_io_service)
520 _deadline.expires_at (boost::posix_time::pos_infin);
527 if (_deadline.expires_at() <= boost::asio::deadline_timer::traits_type::now ()) {
529 _deadline.expires_at (boost::posix_time::pos_infin);
532 _deadline.async_wait (boost::bind (&Socket::check, this));
535 /** Blocking connect.
536 * @param endpoint End-point to connect to.
539 Socket::connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint)
541 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
542 boost::system::error_code ec = boost::asio::error::would_block;
543 _socket.async_connect (endpoint, boost::lambda::var(ec) = boost::lambda::_1);
545 _io_service.run_one();
546 } while (ec == boost::asio::error::would_block);
548 if (ec || !_socket.is_open ()) {
549 throw NetworkError (_("connect timed out"));
554 * @param data Buffer to write.
555 * @param size Number of bytes to write.
558 Socket::write (uint8_t const * data, int size)
560 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
561 boost::system::error_code ec = boost::asio::error::would_block;
563 boost::asio::async_write (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
566 _io_service.run_one ();
567 } while (ec == boost::asio::error::would_block);
570 throw NetworkError (ec.message ());
575 Socket::write (uint32_t v)
578 write (reinterpret_cast<uint8_t*> (&v), 4);
582 * @param data Buffer to read to.
583 * @param size Number of bytes to read.
586 Socket::read (uint8_t* 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_read (_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::read_uint32 ()
606 read (reinterpret_cast<uint8_t *> (&v), 4);
610 /** @param other A Rect.
611 * @return The intersection of this with `other'.
614 Rect::intersection (Rect const & other) const
616 int const tx = max (x, other.x);
617 int const ty = max (y, other.y);
621 min (x + width, other.x + other.width) - tx,
622 min (y + height, other.y + other.height) - ty
626 /** Round a number up to the nearest multiple of another number.
628 * @param s Array of numbers to round, indexed by c.
629 * @param t Multiple to round to.
630 * @return Rounded number.
633 stride_round_up (int c, int const * stride, int t)
635 int const a = stride[c] + (t - 1);
640 stride_lookup (int c, int const * stride)
645 /** Read a sequence of key / value pairs from a text stream;
646 * the keys are the first words on the line, and the values are
647 * the remainder of the line following the key. Lines beginning
648 * with # are ignored.
649 * @param s Stream to read.
650 * @return key/value pairs.
652 multimap<string, string>
653 read_key_value (istream &s)
655 multimap<string, string> kv;
658 while (getline (s, line)) {
663 if (line[0] == '#') {
667 if (line[line.size() - 1] == '\r') {
668 line = line.substr (0, line.size() - 1);
671 size_t const s = line.find (' ');
672 if (s == string::npos) {
676 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
683 get_required_string (multimap<string, string> const & kv, string k)
685 if (kv.count (k) > 1) {
686 throw StringError (N_("unexpected multiple keys in key-value set"));
689 multimap<string, string>::const_iterator i = kv.find (k);
691 if (i == kv.end ()) {
692 throw StringError (String::compose (_("missing key %1 in key-value set"), k));
699 get_required_int (multimap<string, string> const & kv, string k)
701 string const v = get_required_string (kv, k);
702 return lexical_cast<int> (v);
706 get_required_float (multimap<string, string> const & kv, string k)
708 string const v = get_required_string (kv, k);
709 return lexical_cast<float> (v);
713 get_optional_string (multimap<string, string> const & kv, string k)
715 if (kv.count (k) > 1) {
716 throw StringError (N_("unexpected multiple keys in key-value set"));
719 multimap<string, string>::const_iterator i = kv.find (k);
720 if (i == kv.end ()) {
728 get_optional_int (multimap<string, string> const & kv, string k)
730 if (kv.count (k) > 1) {
731 throw StringError (N_("unexpected multiple keys in key-value set"));
734 multimap<string, string>::const_iterator i = kv.find (k);
735 if (i == kv.end ()) {
739 return lexical_cast<int> (i->second);
742 /** Construct an AudioBuffers. Audio data is undefined after this constructor.
743 * @param channels Number of channels.
744 * @param frames Number of frames to reserve space for.
746 AudioBuffers::AudioBuffers (int channels, int frames)
747 : _channels (channels)
749 , _allocated_frames (frames)
751 _data = new float*[_channels];
752 for (int i = 0; i < _channels; ++i) {
753 _data[i] = new float[frames];
757 /** Copy constructor.
758 * @param other Other AudioBuffers; data is copied.
760 AudioBuffers::AudioBuffers (AudioBuffers const & other)
761 : _channels (other._channels)
762 , _frames (other._frames)
763 , _allocated_frames (other._frames)
765 _data = new float*[_channels];
766 for (int i = 0; i < _channels; ++i) {
767 _data[i] = new float[_frames];
768 memcpy (_data[i], other._data[i], _frames * sizeof (float));
772 /** AudioBuffers destructor */
773 AudioBuffers::~AudioBuffers ()
775 for (int i = 0; i < _channels; ++i) {
782 /** @param c Channel index.
783 * @return Buffer for this channel.
786 AudioBuffers::data (int c) const
788 assert (c >= 0 && c < _channels);
792 /** Set the number of frames that these AudioBuffers will report themselves
794 * @param f Frames; must be less than or equal to the number of allocated frames.
797 AudioBuffers::set_frames (int f)
799 assert (f <= _allocated_frames);
803 /** Make all samples on all channels silent */
805 AudioBuffers::make_silent ()
807 for (int i = 0; i < _channels; ++i) {
812 /** Make all samples on a given channel silent.
816 AudioBuffers::make_silent (int c)
818 assert (c >= 0 && c < _channels);
820 for (int i = 0; i < _frames; ++i) {
825 /** Copy data from another AudioBuffers to this one. All channels are copied.
826 * @param from AudioBuffers to copy from; must have the same number of channels as this.
827 * @param frames_to_copy Number of frames to copy.
828 * @param read_offset Offset to read from in `from'.
829 * @param write_offset Offset to write to in `to'.
832 AudioBuffers::copy_from (AudioBuffers* from, int frames_to_copy, int read_offset, int write_offset)
834 assert (from->channels() == channels());
837 assert (read_offset >= 0 && (read_offset + frames_to_copy) <= from->_allocated_frames);
838 assert (write_offset >= 0 && (write_offset + frames_to_copy) <= _allocated_frames);
840 for (int i = 0; i < _channels; ++i) {
841 memcpy (_data[i] + write_offset, from->_data[i] + read_offset, frames_to_copy * sizeof(float));
845 /** Move audio data around.
846 * @param from Offset to move from.
847 * @param to Offset to move to.
848 * @param frames Number of frames to move.
852 AudioBuffers::move (int from, int to, int frames)
859 assert (from < _frames);
861 assert (to < _frames);
863 assert (frames <= _frames);
864 assert ((from + frames) <= _frames);
865 assert ((to + frames) <= _frames);
867 for (int i = 0; i < _channels; ++i) {
868 memmove (_data[i] + to, _data[i] + from, frames * sizeof(float));
872 /** Add data from from `from', `from_channel' to our channel `to_channel' */
874 AudioBuffers::accumulate (shared_ptr<AudioBuffers> from, int from_channel, int to_channel)
876 int const N = frames ();
877 assert (from->frames() == N);
879 float* s = from->data (from_channel);
880 float* d = _data[to_channel];
882 for (int i = 0; i < N; ++i) {
887 /** Trip an assert if the caller is not in the UI thread */
891 assert (boost::this_thread::get_id() == ui_thread);
894 /** @param v Content video frame.
895 * @param audio_sample_rate Source audio sample rate.
896 * @param frames_per_second Number of video frames per second.
897 * @return Equivalent number of audio frames for `v'.
900 video_frames_to_audio_frames (ContentVideoFrame v, float audio_sample_rate, float frames_per_second)
902 return ((int64_t) v * audio_sample_rate / frames_per_second);
905 /** @return A pair containing CPU model name and the number of processors */
909 pair<string, int> info;
912 #ifdef DVDOMATIC_POSIX
913 ifstream f (N_("/proc/cpuinfo"));
917 if (boost::algorithm::starts_with (l, N_("model name"))) {
918 string::size_type const c = l.find (':');
919 if (c != string::npos) {
920 info.first = l.substr (c + 2);
922 } else if (boost::algorithm::starts_with (l, N_("processor"))) {
932 audio_channel_name (int c)
934 assert (MAX_AUDIO_CHANNELS == 6);
936 /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
937 enhancement channel (sub-woofer)./
939 string const channels[] = {
951 FrameRateConversion::FrameRateConversion (float source, int dcp)
954 , change_speed (false)
956 if (fabs (source / 2.0 - dcp) < (fabs (source - dcp))) {
958 } else if (fabs (source * 2 - dcp) < fabs (source - dcp)) {
962 change_speed = !about_equal (source * factor(), dcp);
964 if (!skip && !repeat && !change_speed) {
965 description = _("DCP and source have the same rate.\n");
968 description = _("DCP will use every other frame of the source.\n");
970 description = _("Each source frame will be doubled in the DCP.\n");
974 float const pc = dcp * 100 / (source * factor());
975 description += String::compose (_("DCP will run at %1%% of the source speed.\n"), pc);