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.
29 #ifdef DVDOMATIC_POSIX
33 #include <libssh/libssh.h>
35 #include <boost/algorithm/string.hpp>
36 #include <boost/bind.hpp>
37 #include <boost/lambda/lambda.hpp>
39 #include <openssl/md5.h>
40 #include <magick/MagickCore.h>
41 #include <magick/version.h>
42 #include <libdcp/version.h>
44 #include <libavcodec/avcodec.h>
45 #include <libavformat/avformat.h>
46 #include <libswscale/swscale.h>
47 #include <libavfilter/avfiltergraph.h>
48 #include <libpostproc/postprocess.h>
49 #include <libavutil/pixfmt.h>
52 #include "exceptions.h"
55 #include "dcp_content_type.h"
58 #include "film_state.h"
59 #include "sound_processor.h"
60 #ifndef DVDOMATIC_DISABLE_PLAYER
61 #include "player_manager.h"
65 using namespace boost;
67 /** Convert some number of seconds to a string representation
68 * in hours, minutes and seconds.
71 * @return String of the form H:M:S (where H is hours, M
72 * is minutes and S is seconds).
75 seconds_to_hms (int s)
85 hms << setfill ('0') << m << ":";
87 hms << setfill ('0') << s;
92 /** @param s Number of seconds.
93 * @return String containing an approximate description of s (e.g. "about 2 hours")
96 seconds_to_approximate_hms (int s)
107 ap << (h + 1) << " hours";
119 ap << m << " minutes";
122 ap << s << " seconds";
128 #ifdef DVDOMATIC_POSIX
129 /** @param l Mangled C++ identifier.
130 * @return Demangled version.
135 string::size_type const b = l.find_first_of ("(");
136 if (b == string::npos) {
140 string::size_type const p = l.find_last_of ("+");
141 if (p == string::npos) {
149 string const fn = l.substr (b + 1, p - b - 1);
154 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
159 } catch (std::exception) {
166 /** Write a stacktrace to an ostream.
167 * @param out Stream to write to.
168 * @param levels Number of levels to go up the call stack.
171 stacktrace (ostream& out, int levels)
178 size = backtrace (array, 200);
179 strings = backtrace_symbols (array, size);
182 for (i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
183 out << " " << demangle (strings[i]) << endl;
191 /** @param s Sample format.
192 * @return String representation.
195 audio_sample_format_to_string (AVSampleFormat s)
197 /* Our sample format handling is not exactly complete */
200 case AV_SAMPLE_FMT_S16:
209 /** @param s String representation of a sample format, as returned from audio_sample_format_to_string().
210 * @return Sample format.
213 audio_sample_format_from_string (string s)
216 return AV_SAMPLE_FMT_S16;
219 return AV_SAMPLE_FMT_NONE;
222 /** @return Version of vobcopy that is on the path (and hence that we will use) */
226 FILE* f = popen ("vobcopy -V 2>&1", "r");
228 throw EncodeError ("could not run vobcopy to check version");
231 string version = "unknown";
235 if (fgets (buf, sizeof (buf), f)) {
238 split (b, s, is_any_of (" "));
239 if (b.size() >= 2 && b[0] == "Vobcopy") {
250 /** @param v Version as used by FFmpeg.
251 * @return A string representation of v.
254 ffmpeg_version_to_string (int v)
257 s << ((v & 0xff0000) >> 16) << "." << ((v & 0xff00) >> 8) << "." << (v & 0xff);
261 /** Return a user-readable string summarising the versions of our dependencies */
263 dependency_version_summary ()
266 s << "libopenjpeg " << opj_version () << ", "
267 << "vobcopy " << vobcopy_version() << ", "
268 << "libavcodec " << ffmpeg_version_to_string (avcodec_version()) << ", "
269 << "libavfilter " << ffmpeg_version_to_string (avfilter_version()) << ", "
270 << "libavformat " << ffmpeg_version_to_string (avformat_version()) << ", "
271 << "libavutil " << ffmpeg_version_to_string (avutil_version()) << ", "
272 << "libpostproc " << ffmpeg_version_to_string (postproc_version()) << ", "
273 << "libswscale " << ffmpeg_version_to_string (swscale_version()) << ", "
274 << MagickVersion << ", "
275 << "libssh " << ssh_version (0) << ", "
276 << "libdcp " << libdcp::version << " git " << libdcp::git_commit;
282 seconds (struct timeval t)
284 return t.tv_sec + (double (t.tv_usec) / 1e6);
288 #ifdef DVDOMATIC_POSIX
290 sigchld_handler (int, siginfo_t* info, void *)
292 #ifndef DVDOMATIC_DISABLE_PLAYER
293 PlayerManager::instance()->child_exited (info->si_pid);
298 /** Call the required functions to set up DVD-o-matic's static arrays, etc. */
302 Format::setup_formats ();
303 DCPContentType::setup_dcp_content_types ();
304 Scaler::setup_scalers ();
305 Filter::setup_filters ();
306 SoundProcessor::setup_sound_processors ();
308 #ifdef DVDOMATIC_POSIX
310 sa.sa_flags = SA_SIGINFO;
311 sigemptyset (&sa.sa_mask);
312 sa.sa_sigaction = sigchld_handler;
313 sigaction (SIGCHLD, &sa, 0);
318 crop_string (Position start, Size size)
321 s << "crop=" << size.width << ":" << size.height << ":" << start.x << ":" << start.y;
326 split_at_spaces_considering_quotes (string s)
329 bool in_quotes = false;
331 for (string::size_type i = 0; i < s.length(); ++i) {
332 if (s[i] == ' ' && !in_quotes) {
335 } else if (s[i] == '"') {
336 in_quotes = !in_quotes;
347 md5_digest (void const * data, int size)
350 MD5_Init (&md5_context);
351 MD5_Update (&md5_context, data, size);
352 unsigned char digest[MD5_DIGEST_LENGTH];
353 MD5_Final (digest, &md5_context);
356 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
357 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
363 /** @param file File name.
364 * @return MD5 digest of file's contents.
367 md5_digest (string file)
369 ifstream f (file.c_str(), ios::binary);
371 throw OpenFileError (file);
374 f.seekg (0, ios::end);
375 int bytes = f.tellg ();
376 f.seekg (0, ios::beg);
378 int const buffer_size = 64 * 1024;
379 char buffer[buffer_size];
382 MD5_Init (&md5_context);
384 int const t = min (bytes, buffer_size);
386 MD5_Update (&md5_context, buffer, t);
390 unsigned char digest[MD5_DIGEST_LENGTH];
391 MD5_Final (digest, &md5_context);
394 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
395 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
401 /** @param An arbitrary sampling rate.
402 * @return The appropriate DCP-approved sampling rate (48kHz or 96kHz).
405 dcp_audio_sample_rate (int fs)
414 bool operator== (Crop const & a, Crop const & b)
416 return (a.left == b.left && a.right == b.right && a.top == b.top && a.bottom == b.bottom);
419 bool operator!= (Crop const & a, Crop const & b)
424 /** @param index Colour LUT index.
425 * @return Human-readable name.
428 colour_lut_index_to_name (int index)
442 : _deadline (_io_service)
443 , _socket (_io_service)
446 _deadline.expires_at (posix_time::pos_infin);
453 if (_deadline.expires_at() <= asio::deadline_timer::traits_type::now ()) {
455 _deadline.expires_at (posix_time::pos_infin);
458 _deadline.async_wait (boost::bind (&Socket::check, this));
461 /** Blocking connect with timeout.
462 * @param endpoint End-point to connect to.
463 * @param timeout Time-out in seconds.
466 Socket::connect (asio::ip::basic_resolver_entry<asio::ip::tcp> const & endpoint, int timeout)
468 system::error_code ec = asio::error::would_block;
469 _socket.async_connect (endpoint, lambda::var(ec) = lambda::_1);
471 _io_service.run_one();
472 } while (ec == asio::error::would_block);
474 if (ec || !_socket.is_open ()) {
475 throw NetworkError ("connect timed out");
479 /** Blocking write with timeout.
480 * @param data Buffer to write.
481 * @param size Number of bytes to write.
482 * @param timeout Time-out, in seconds.
485 Socket::write (uint8_t const * data, int size, int timeout)
487 _deadline.expires_from_now (posix_time::seconds (timeout));
488 system::error_code ec = asio::error::would_block;
490 asio::async_write (_socket, asio::buffer (data, size), lambda::var(ec) = lambda::_1);
492 _io_service.run_one ();
493 } while (ec == asio::error::would_block);
496 throw NetworkError ("write timed out");
500 /** Blocking read with timeout.
501 * @param data Buffer to read to.
502 * @param size Number of bytes to read.
503 * @param timeout Time-out, in seconds.
506 Socket::read (uint8_t* data, int size, int timeout)
508 _deadline.expires_from_now (posix_time::seconds (timeout));
509 system::error_code ec = asio::error::would_block;
513 _socket.async_read_some (
514 asio::buffer (data, size),
515 (lambda::var(ec) = lambda::_1, lambda::var(amount_read) = lambda::_2)
519 _io_service.run_one ();
520 } while (ec == asio::error::would_block);
529 /** Mark some data as being `consumed', so that it will not be returned
531 * @param size Amount of data to consume, in bytes.
534 Socket::consume (int size)
536 assert (_buffer_data >= size);
538 _buffer_data -= size;
539 if (_buffer_data > 0) {
540 /* Shift still-valid data to the start of the buffer */
541 memmove (_buffer, _buffer + size, _buffer_data);
545 /** Read a definite amount of data from our socket, and mark
547 * @param data Where to put the data.
548 * @param size Number of bytes to read.
551 Socket::read_definite_and_consume (uint8_t* data, int size, int timeout)
553 int const from_buffer = min (_buffer_data, size);
554 if (from_buffer > 0) {
555 /* Get data from our buffer */
556 memcpy (data, _buffer, from_buffer);
557 consume (from_buffer);
558 /* Update our output state */
563 /* read() the rest */
565 int const n = read (data, size, timeout);
567 throw NetworkError ("could not read");
575 /** Read as much data as is available, up to some limit.
576 * @param data Where to put the data.
577 * @param size Maximum amount of data to read.
580 Socket::read_indefinite (uint8_t* data, int size, int timeout)
582 assert (size < int (sizeof (_buffer)));
584 /* Amount of extra data we need to read () */
585 int to_read = size - _buffer_data;
586 while (to_read > 0) {
587 /* read as much of it as we can (into our buffer) */
588 int const n = read (_buffer + _buffer_data, to_read, timeout);
590 throw NetworkError ("could not read");
597 assert (_buffer_data >= size);
599 /* copy data into the output buffer */
600 assert (size >= _buffer_data);
601 memcpy (data, _buffer, size);