2 Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 /** @file src/lib/util.cc
21 * @brief Some utility functions and classes.
25 #include "exceptions.h"
26 #include "dcp_content_type.h"
28 #include "cinema_sound_processor.h"
33 #include "video_content.h"
35 #include "md5_digester.h"
36 #include "audio_processor.h"
37 #include "safe_stringstream.h"
39 #include <dcp/signer.h>
40 #include <dcp/picture_mxf.h>
41 #include <dcp/sound_mxf.h>
42 #include <dcp/subtitle_content.h>
44 #include <pangomm/init.h>
45 #include <boost/algorithm/string.hpp>
46 #include <boost/bind.hpp>
47 #include <boost/lambda/lambda.hpp>
48 #include <boost/thread.hpp>
49 #include <boost/filesystem.hpp>
50 #ifdef DCPOMATIC_WINDOWS
51 #include <boost/locale.hpp>
60 #ifdef DCPOMATIC_POSIX
81 using std::set_terminate;
82 using boost::shared_ptr;
84 using boost::optional;
87 /** Path to our executable, required by the stacktrace stuff and filled
88 * in during App::onInit().
91 static boost::thread::id ui_thread;
92 static boost::filesystem::path backtrace_file;
94 /** Convert some number of seconds to a string representation
95 * in hours, minutes and seconds.
98 * @return String of the form H:M:S (where H is hours, M
99 * is minutes and S is seconds).
102 seconds_to_hms (int s)
109 SafeStringStream hms;
112 hms << setfill ('0') << m << N_(":");
114 hms << setfill ('0') << s;
119 /** @param s Number of seconds.
120 * @return String containing an approximate description of s (e.g. "about 2 hours")
123 seconds_to_approximate_hms (int s)
132 bool const hours = h > 0;
133 bool const minutes = h < 10 && m > 0;
134 bool const seconds = m < 10 && s > 0;
137 if (m > 30 && !minutes) {
138 /// TRANSLATORS: h here is an abbreviation for hours
139 ap << (h + 1) << _("h");
141 /// TRANSLATORS: h here is an abbreviation for hours
145 if (minutes | seconds) {
152 if (s > 30 && !seconds) {
153 /// TRANSLATORS: m here is an abbreviation for minutes
154 ap << (m + 1) << _("m");
156 /// TRANSLATORS: m here is an abbreviation for minutes
167 /// TRANSLATORS: s here is an abbreviation for seconds
175 seconds (struct timeval t)
177 return t.tv_sec + (double (t.tv_usec) / 1e6);
180 #ifdef DCPOMATIC_WINDOWS
182 /** Resolve symbol name and source location given the path to the executable */
184 addr2line (void const * const addr)
186 char addr2line_cmd[512] = { 0 };
187 sprintf (addr2line_cmd, "addr2line -f -p -e %.256s %p > %s", program_name.c_str(), addr, backtrace_file.string().c_str());
188 return system(addr2line_cmd);
191 /** This is called when C signals occur on Windows (e.g. SIGSEGV)
192 * (NOT C++ exceptions!). We write a backtrace to backtrace_file by dark means.
193 * Adapted from code here: http://spin.atomicobject.com/2013/01/13/exceptions-stack-traces-c/
196 exception_handler(struct _EXCEPTION_POINTERS * info)
198 FILE* f = fopen_boost (backtrace_file, "w");
199 fprintf (f, "C-style exception %d\n", info->ExceptionRecord->ExceptionCode);
202 if (info->ExceptionRecord->ExceptionCode != EXCEPTION_STACK_OVERFLOW) {
203 CONTEXT* context = info->ContextRecord;
204 SymInitialize (GetCurrentProcess (), 0, true);
206 STACKFRAME frame = { 0 };
208 /* setup initial stack frame */
210 frame.AddrPC.Offset = context->Rip;
211 frame.AddrStack.Offset = context->Rsp;
212 frame.AddrFrame.Offset = context->Rbp;
214 frame.AddrPC.Offset = context->Eip;
215 frame.AddrStack.Offset = context->Esp;
216 frame.AddrFrame.Offset = context->Ebp;
218 frame.AddrPC.Mode = AddrModeFlat;
219 frame.AddrStack.Mode = AddrModeFlat;
220 frame.AddrFrame.Mode = AddrModeFlat;
224 IMAGE_FILE_MACHINE_I386,
225 GetCurrentProcess (),
230 SymFunctionTableAccess,
235 addr2line((void *) frame.AddrPC.Offset);
239 addr2line ((void *) info->ContextRecord->Rip);
241 addr2line ((void *) info->ContextRecord->Eip);
245 return EXCEPTION_CONTINUE_SEARCH;
250 set_backtrace_file (boost::filesystem::path p)
255 /** This is called when there is an unhandled exception. Any
256 * backtrace in this function is useless on Windows as the stack has
257 * already been unwound from the throw; we have the gdb wrap hack to
264 static bool tried_throw = false;
265 // try once to re-throw currently active exception
271 catch (const std::exception &e) {
272 std::cerr << __FUNCTION__ << " caught unhandled exception. what(): "
273 << e.what() << std::endl;
276 std::cerr << __FUNCTION__ << " caught unknown/unhandled exception."
283 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
284 * Must be called from the UI thread, if there is one.
289 #ifdef DCPOMATIC_WINDOWS
290 boost::filesystem::path p = g_get_user_config_dir ();
291 p /= "backtrace.txt";
292 set_backtrace_file (p);
293 SetUnhandledExceptionFilter(exception_handler);
295 /* Dark voodoo which, I think, gets boost::filesystem::path to
296 correctly convert UTF-8 strings to paths, and also paths
297 back to UTF-8 strings (on path::string()).
299 After this, constructing boost::filesystem::paths from strings
300 converts from UTF-8 to UTF-16 inside the path. Then
301 path::string().c_str() gives UTF-8 and
302 path::c_str() gives UTF-16.
304 This is all Windows-only. AFAICT Linux/OS X use UTF-8 everywhere,
305 so things are much simpler.
307 std::locale::global (boost::locale::generator().generate (""));
308 boost::filesystem::path::imbue (std::locale ());
311 avfilter_register_all ();
314 /* Add our lib directory to the libltdl search path so that
315 xmlsec can find xmlsec1-openssl.
317 boost::filesystem::path lib = app_contents ();
319 setenv ("LTDL_LIBRARY_PATH", lib.c_str (), 1);
322 set_terminate (terminate);
327 Ratio::setup_ratios ();
328 VideoContentScale::setup_scales ();
329 DCPContentType::setup_dcp_content_types ();
330 Filter::setup_filters ();
331 CinemaSoundProcessor::setup_cinema_sound_processors ();
332 AudioProcessor::setup_audio_processors ();
334 ui_thread = boost::this_thread::get_id ();
337 #ifdef DCPOMATIC_WINDOWS
338 boost::filesystem::path
342 GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
343 boost::filesystem::path p (buffer);
344 p = p.parent_path ();
345 p = p.parent_path ();
352 boost::filesystem::path
355 return "DCP-o-matic 2.app/Contents/Resources";
360 dcpomatic_setup_gettext_i18n (string lang)
362 #ifdef DCPOMATIC_LINUX
366 if (!lang.empty ()) {
367 /* Override our environment language. Note that the caller must not
368 free the string passed into putenv().
370 string s = String::compose ("LANGUAGE=%1", lang);
371 putenv (strdup (s.c_str ()));
372 s = String::compose ("LANG=%1", lang);
373 putenv (strdup (s.c_str ()));
374 s = String::compose ("LC_ALL=%1", lang);
375 putenv (strdup (s.c_str ()));
378 setlocale (LC_ALL, "");
379 textdomain ("libdcpomatic");
381 #if defined(DCPOMATIC_WINDOWS) || defined(DCPOMATIC_OSX)
382 bindtextdomain ("libdcpomatic", mo_path().string().c_str());
383 bind_textdomain_codeset ("libdcpomatic", "UTF8");
386 #ifdef DCPOMATIC_LINUX
387 bindtextdomain ("libdcpomatic", LINUX_LOCALE_PREFIX);
391 /** Compute a digest of the first and last `size' bytes of a set of files. */
393 md5_digest_head_tail (vector<boost::filesystem::path> files, boost::uintmax_t size)
395 boost::scoped_array<char> buffer (new char[size]);
396 MD5Digester digester;
399 boost::uintmax_t to_do = size;
400 char* p = buffer.get ();
402 while (i < int64_t (files.size()) && to_do > 0) {
403 FILE* f = fopen_boost (files[i], "rb");
405 throw OpenFileError (files[i].string());
408 boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i]));
409 fread (p, 1, this_time, f);
416 digester.add (buffer.get(), size - to_do);
421 i = files.size() - 1;
422 while (i >= 0 && to_do > 0) {
423 FILE* f = fopen_boost (files[i], "rb");
425 throw OpenFileError (files[i].string());
428 boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i]));
429 dcpomatic_fseek (f, -this_time, SEEK_END);
430 fread (p, 1, this_time, f);
437 digester.add (buffer.get(), size - to_do);
439 return digester.get ();
442 /** @param An arbitrary audio frame rate.
443 * @return The appropriate DCP-approved frame rate (48kHz or 96kHz).
446 dcp_audio_frame_rate (int fs)
455 /** Round a number up to the nearest multiple of another number.
457 * @param s Array of numbers to round, indexed by c.
458 * @param t Multiple to round to.
459 * @return Rounded number.
462 stride_round_up (int c, int const * stride, int t)
464 int const a = stride[c] + (t - 1);
468 /** @param n A number.
469 * @param r Rounding `boundary' (must be a power of 2)
470 * @return n rounded to the nearest r
473 round_to (float n, int r)
475 DCPOMATIC_ASSERT (r == 1 || r == 2 || r == 4);
476 return int (n + float(r) / 2) &~ (r - 1);
479 /** Trip an assert if the caller is not in the UI thread */
483 DCPOMATIC_ASSERT (boost::this_thread::get_id() == ui_thread);
487 audio_channel_name (int c)
489 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 12);
491 /// TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
492 /// enhancement channel (sub-woofer). HI is the hearing-impaired audio track and
493 /// VI is the visually-impaired audio track (audio describe).
494 string const channels[] = {
501 _("Hearing impaired"),
502 _("Visually impaired"),
505 _("Left rear surround"),
506 _("Right rear surround"),
513 valid_image_file (boost::filesystem::path f)
515 if (boost::starts_with (f.leaf().string(), "._")) {
519 string ext = f.extension().string();
520 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
522 ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" ||
523 ext == ".png" || ext == ".bmp" || ext == ".tga" || ext == ".dpx" ||
524 ext == ".j2c" || ext == ".j2k"
529 valid_j2k_file (boost::filesystem::path f)
531 string ext = f.extension().string();
532 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
533 return (ext == ".j2k" || ext == ".j2c");
537 tidy_for_filename (string f)
540 for (size_t i = 0; i < f.length(); ++i) {
541 if (isalnum (f[i]) || f[i] == '_' || f[i] == '-') {
552 fit_ratio_within (float ratio, dcp::Size full_frame)
554 if (ratio < full_frame.ratio ()) {
555 return dcp::Size (rint (full_frame.height * ratio), full_frame.height);
558 return dcp::Size (full_frame.width, rint (full_frame.width / ratio));
562 wrapped_av_malloc (size_t s)
564 void* p = av_malloc (s);
572 subtitle_period (AVSubtitle const & sub)
574 ContentTime const packet_time = ContentTime::from_seconds (static_cast<double> (sub.pts) / AV_TIME_BASE);
576 if (sub.end_display_time == static_cast<uint32_t> (-1)) {
577 /* End time is not known */
578 return FFmpegSubtitlePeriod (packet_time + ContentTime::from_seconds (sub.start_display_time / 1e3));
581 return FFmpegSubtitlePeriod (
582 packet_time + ContentTime::from_seconds (sub.start_display_time / 1e3),
583 packet_time + ContentTime::from_seconds (sub.end_display_time / 1e3)
588 split_get_request (string url)
591 AWAITING_QUESTION_MARK,
594 } state = AWAITING_QUESTION_MARK;
596 map<string, string> r;
599 for (size_t i = 0; i < url.length(); ++i) {
601 case AWAITING_QUESTION_MARK:
616 r.insert (make_pair (k, v));
626 if (state == VALUE) {
627 r.insert (make_pair (k, v));
634 frame_info_position (int frame, Eyes eyes)
636 static int const info_size = 48;
640 return frame * info_size;
642 return frame * info_size * 2;
644 return frame * info_size * 2 + info_size;
646 DCPOMATIC_ASSERT (false);
649 DCPOMATIC_ASSERT (false);
653 read_frame_info (FILE* file, int frame, Eyes eyes)
656 dcpomatic_fseek (file, frame_info_position (frame, eyes), SEEK_SET);
657 fread (&info.offset, sizeof (info.offset), 1, file);
658 fread (&info.size, sizeof (info.size), 1, file);
660 char hash_buffer[33];
661 fread (hash_buffer, 1, 32, file);
662 hash_buffer[32] = '\0';
663 info.hash = hash_buffer;
669 write_frame_info (FILE* file, int frame, Eyes eyes, dcp::FrameInfo info)
671 dcpomatic_fseek (file, frame_info_position (frame, eyes), SEEK_SET);
672 fwrite (&info.offset, sizeof (info.offset), 1, file);
673 fwrite (&info.size, sizeof (info.size), 1, file);
674 fwrite (info.hash.c_str(), 1, info.hash.size(), file);
678 video_mxf_filename (shared_ptr<dcp::PictureMXF> mxf)
680 return "j2c_" + mxf->id() + ".mxf";
684 audio_mxf_filename (shared_ptr<dcp::SoundMXF> mxf)
686 return "pcm_" + mxf->id() + ".mxf";
690 subtitle_content_filename (shared_ptr<dcp::SubtitleContent> content)
692 return "sub_" + content->id() + ".xml";