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.
31 #include <sys/types.h>
32 #include <sys/socket.h>
33 #include <boost/algorithm/string.hpp>
35 #include <magick/MagickCore.h>
36 #include <magick/version.h>
37 #include <libssh/libssh.h>
39 #include <libavcodec/avcodec.h>
40 #include <libavformat/avformat.h>
41 #include <libswscale/swscale.h>
42 #include <libavfilter/avfiltergraph.h>
43 #include <libpostproc/postprocess.h>
44 #include <libavutil/pixfmt.h>
47 #include "exceptions.h"
50 #include "dcp_content_type.h"
53 #include "film_state.h"
54 #include "player_manager.h"
61 using namespace boost;
63 /** Convert some number of seconds to a string representation
64 * in hours, minutes and seconds.
67 * @return String of the form H:M:S (where H is hours, M
68 * is minutes and S is seconds).
71 seconds_to_hms (int s)
81 hms << setfill ('0') << m << ":";
83 hms << setfill ('0') << s;
88 /** @param s Number of seconds.
89 * @return String containing an approximate description of s (e.g. "about 2 hours")
92 seconds_to_approximate_hms (int s)
103 ap << (h + 1) << " hours";
115 ap << m << " minutes";
118 ap << s << " seconds";
124 /** @param l Mangled C++ identifier.
125 * @return Demangled version.
130 string::size_type const b = l.find_first_of ("(");
131 if (b == string::npos) {
135 string::size_type const p = l.find_last_of ("+");
136 if (p == string::npos) {
144 string const fn = l.substr (b + 1, p - b - 1);
149 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
154 } catch (std::exception) {
161 /** Write a stacktrace to an ostream.
162 * @param out Stream to write to.
163 * @param levels Number of levels to go up the call stack.
166 stacktrace (ostream& out, int levels)
173 size = backtrace (array, 200);
174 strings = backtrace_symbols (array, size);
177 for (i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
178 out << " " << demangle (strings[i]) << endl;
185 /** @param s Sample format.
186 * @return String representation.
189 audio_sample_format_to_string (AVSampleFormat s)
191 /* Our sample format handling is not exactly complete */
194 case AV_SAMPLE_FMT_S16:
203 /** @param s String representation of a sample format, as returned from audio_sample_format_to_string().
204 * @return Sample format.
207 audio_sample_format_from_string (string s)
210 return AV_SAMPLE_FMT_S16;
213 return AV_SAMPLE_FMT_NONE;
216 /** @return Version of vobcopy that is on the path (and hence that we will use) */
220 FILE* f = popen ("vobcopy -V 2>&1", "r");
222 throw EncodeError ("could not run vobcopy to check version");
225 string version = "unknown";
230 ssize_t const r = getline (&buf, &n, f);
234 split (b, s, is_any_of (" "));
235 if (b.size() >= 2 && b[0] == "Vobcopy") {
247 /** @param v Version as used by FFmpeg.
248 * @return A string representation of v.
251 ffmpeg_version_to_string (int v)
254 s << ((v & 0xff0000) >> 16) << "." << ((v & 0xff00) >> 8) << "." << (v & 0xff);
258 /** Return a user-readable string summarising the versions of our dependencies */
260 dependency_version_summary ()
263 s << "libopenjpeg " << opj_version () << ", "
264 << "vobcopy " << vobcopy_version() << ", "
265 << "libavcodec " << ffmpeg_version_to_string (avcodec_version()) << ", "
266 << "libavfilter " << ffmpeg_version_to_string (avfilter_version()) << ", "
267 << "libavformat " << ffmpeg_version_to_string (avformat_version()) << ", "
268 << "libavutil " << ffmpeg_version_to_string (avutil_version()) << ", "
269 << "libpostproc " << ffmpeg_version_to_string (postproc_version()) << ", "
270 << "libswscale " << ffmpeg_version_to_string (swscale_version()) << ", "
271 << MagickVersion << ", "
272 << "libssh " << ssh_version (0);
277 /** Write some data to a socket.
278 * @param fd Socket file descriptor.
280 * @param size Amount to write, in bytes.
283 socket_write (int fd, uint8_t const * data, int size)
285 uint8_t const * p = data;
287 int const n = send (fd, p, size, MSG_NOSIGNAL);
290 s << "could not write (" << strerror (errno) << ")";
291 throw NetworkError (s.str ());
300 seconds (struct timeval t)
302 return t.tv_sec + (double (t.tv_usec) / 1e6);
305 /** @param fd File descriptor to read from */
306 SocketReader::SocketReader (int fd)
313 /** Mark some data as being `consumed', so that it will not be returned
315 * @param size Amount of data to consume, in bytes.
318 SocketReader::consume (int size)
320 assert (_buffer_data >= size);
322 _buffer_data -= size;
323 if (_buffer_data > 0) {
324 /* Shift still-valid data to the start of the buffer */
325 memmove (_buffer, _buffer + size, _buffer_data);
329 /** Read a definite amount of data from our socket, and mark
331 * @param data Where to put the data.
332 * @param size Number of bytes to read.
335 SocketReader::read_definite_and_consume (uint8_t* data, int size)
337 int const from_buffer = min (_buffer_data, size);
338 if (from_buffer > 0) {
339 /* Get data from our buffer */
340 memcpy (data, _buffer, from_buffer);
341 consume (from_buffer);
342 /* Update our output state */
347 /* read() the rest */
349 int const n = ::read (_fd, data, size);
351 throw NetworkError ("could not read");
359 /** Read as much data as is available, up to some limit.
360 * @param data Where to put the data.
361 * @param size Maximum amount of data to read.
364 SocketReader::read_indefinite (uint8_t* data, int size)
366 assert (size < int (sizeof (_buffer)));
368 /* Amount of extra data we need to read () */
369 int to_read = size - _buffer_data;
370 while (to_read > 0) {
371 /* read as much of it as we can (into our buffer) */
372 int const n = ::read (_fd, _buffer + _buffer_data, to_read);
374 throw NetworkError ("could not read");
381 assert (_buffer_data >= size);
383 /* copy data into the output buffer */
384 assert (size >= _buffer_data);
385 memcpy (data, _buffer, size);
389 sigchld_handler (int, siginfo_t* info, void *)
391 PlayerManager::instance()->child_exited (info->si_pid);
394 /** Call the required functions to set up DVD-o-matic's static arrays, etc. */
398 Format::setup_formats ();
399 DCPContentType::setup_dcp_content_types ();
400 Scaler::setup_scalers ();
401 Filter::setup_filters ();
404 sa.sa_flags = SA_SIGINFO;
405 sigemptyset (&sa.sa_mask);
406 sa.sa_sigaction = sigchld_handler;
407 sigaction (SIGCHLD, &sa, 0);
411 crop_string (Position start, Size size)
414 s << "crop=" << size.width << ":" << size.height << ":" << start.x << ":" << start.y;
419 split_at_spaces_considering_quotes (string s)
422 bool in_quotes = false;
424 for (string::size_type i = 0; i < s.length(); ++i) {
425 if (s[i] == ' ' && !in_quotes) {
428 } else if (s[i] == '"') {
429 in_quotes = !in_quotes;
441 md5_data (string title, void const * data, int size)
443 MHASH ht = mhash_init (MHASH_MD5);
444 if (ht == MHASH_FAILED) {
445 throw EncodeError ("could not create hash thread");
448 mhash (ht, data, size);
451 mhash_deinit (ht, hash);
453 printf ("%s [%d]: ", title.c_str (), size);
454 for (int i = 0; i < int (mhash_get_block_size (MHASH_MD5)); ++i) {
455 printf ("%.2x", hash[i]);