X-Git-Url: https://git.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Futil.cc;h=7d0d2bf606c698d3a2a4881f2336c4e156456899;hp=0ce538cdff2429fbd4f571a57e14e292faddef8e;hb=1a721b82d4094c00ee89574e17c58c23c0de8cdd;hpb=fc4956d144ed0869fe2fa1737adc21104bb47836 diff --git a/src/lib/util.cc b/src/lib/util.cc index 0ce538cdf..7d0d2bf60 100644 --- a/src/lib/util.cc +++ b/src/lib/util.cc @@ -1,5 +1,5 @@ /* - Copyright (C) 2012-2016 Carl Hetherington + Copyright (C) 2012-2021 Carl Hetherington This file is part of DCP-o-matic. @@ -22,41 +22,62 @@ * @brief Some utility functions and classes. */ -#include "util.h" -#include "exceptions.h" -#include "dcp_content_type.h" -#include "filter.h" + +#define UNICODE 1 + + +#include "audio_buffers.h" +#include "audio_processor.h" #include "cinema_sound_processor.h" +#include "compose.hpp" #include "config.h" -#include "ratio.h" -#include "job.h" #include "cross.h" -#include "video_content.h" -#include "rect.h" +#include "crypto.h" +#include "dcp_content_type.h" #include "digester.h" -#include "audio_processor.h" -#include "compose.hpp" +#include "exceptions.h" +#include "ffmpeg_image_proxy.h" +#include "filter.h" +#include "font.h" +#include "image.h" +#include "job.h" +#include "job_manager.h" +#include "ratio.h" +#include "rect.h" +#include "render_text.h" +#include "string_text.h" +#include "text_decoder.h" +#include "util.h" +#include "video_content.h" +#include +#include #include -#include -#include #include +#include #include #include +#include +#include +LIBDCP_DISABLE_WARNINGS extern "C" { #include #include #include } +LIBDCP_ENABLE_WARNINGS #include -#ifdef DCPOMATIC_GRAPHICS_MAGICK -#include -#endif #include #include +#include +#include +#include #include #include #include #include +LIBDCP_DISABLE_WARNINGS +#include +LIBDCP_ENABLE_WARNINGS #ifdef DCPOMATIC_WINDOWS #include #include @@ -74,35 +95,39 @@ extern "C" { #include "i18n.h" -using std::string; -using std::setfill; -using std::ostream; + +using std::bad_alloc; +using std::cout; using std::endl; -using std::vector; -using std::min; -using std::max; -using std::map; -using std::list; -using std::multimap; using std::istream; +using std::list; +using std::make_pair; +using std::make_shared; +using std::map; +using std::min; +using std::ostream; using std::pair; -using std::cout; -using std::bad_alloc; using std::set_terminate; -using std::make_pair; -using boost::shared_ptr; +using std::shared_ptr; +using std::string; +using std::vector; +using std::wstring; using boost::thread; using boost::optional; using boost::lexical_cast; using boost::bad_lexical_cast; +using boost::scoped_array; using dcp::Size; using dcp::raw_convert; using dcp::locale_convert; +using namespace dcpomatic; + /** Path to our executable, required by the stacktrace stuff and filled * in during App::onInit(). */ string program_name; +bool is_batch_converter = false; static boost::thread::id ui_thread; static boost::filesystem::path backtrace_file; @@ -126,6 +151,22 @@ seconds_to_hms (int s) return buffer; } +string +time_to_hmsf (DCPTime time, Frame rate) +{ + Frame f = time.frames_round (rate); + int s = f / rate; + f -= (s * rate); + int m = s / 60; + s -= m * 60; + int h = m / 60; + m -= h * 60; + + char buffer[64]; + snprintf (buffer, sizeof(buffer), "%d:%02d:%02d.%d", h, m, s, static_cast(f)); + return buffer; +} + /** @param s Number of seconds. * @return String containing an approximate description of s (e.g. "about 2 hours") */ @@ -139,18 +180,27 @@ seconds_to_approximate_hms (int s) string ap; - bool const hours = h > 0; - bool const minutes = h < 6 && m > 0; - bool const seconds = h == 0 && m < 10 && s > 0; + bool hours = h > 0; + bool minutes = h < 6 && m > 0; + bool seconds = h == 0 && m < 10 && s > 0; - if (hours) { - if (m > 30 && !minutes) { - /// TRANSLATORS: h here is an abbreviation for hours - ap += locale_convert(h + 1) + _("h"); - } else { - /// TRANSLATORS: h here is an abbreviation for hours - ap += locale_convert(h) + _("h"); + if (m > 30 && !minutes) { + /* round up the hours */ + ++h; + } + if (s > 30 && !seconds) { + /* round up the minutes */ + ++m; + if (m == 60) { + m = 0; + minutes = false; + ++h; } + } + + if (hours) { + /// TRANSLATORS: h here is an abbreviation for hours + ap += locale_convert(h) + _("h"); if (minutes || seconds) { ap += N_(" "); @@ -158,14 +208,8 @@ seconds_to_approximate_hms (int s) } if (minutes) { - /* Minutes */ - if (s > 30 && !seconds) { - /// TRANSLATORS: m here is an abbreviation for minutes - ap += locale_convert(m + 1) + _("m"); - } else { - /// TRANSLATORS: m here is an abbreviation for minutes - ap += locale_convert(m) + _("m"); - } + /// TRANSLATORS: m here is an abbreviation for minutes + ap += locale_convert(m) + _("m"); if (seconds) { ap += N_(" "); @@ -198,6 +242,7 @@ addr2line (void const * const addr) return system(addr2line_cmd); } +LIBDCP_DISABLE_WARNINGS /** This is called when C signals occur on Windows (e.g. SIGSEGV) * (NOT C++ exceptions!). We write a backtrace to backtrace_file by dark means. * Adapted from code here: http://spin.atomicobject.com/2013/01/13/exceptions-stack-traces-c/ @@ -205,9 +250,11 @@ addr2line (void const * const addr) LONG WINAPI exception_handler(struct _EXCEPTION_POINTERS * info) { - FILE* f = fopen_boost (backtrace_file, "w"); - fprintf (f, "C-style exception %d\n", info->ExceptionRecord->ExceptionCode); - fclose(f); + dcp::File f(backtrace_file, "w"); + if (f) { + fprintf(f.get(), "C-style exception %d\n", info->ExceptionRecord->ExceptionCode); + f.close(); + } if (info->ExceptionRecord->ExceptionCode != EXCEPTION_STACK_OVERFLOW) { CONTEXT* context = info->ContextRecord; @@ -254,6 +301,7 @@ exception_handler(struct _EXCEPTION_POINTERS * info) return EXCEPTION_CONTINUE_SEARCH; } +LIBDCP_ENABLE_WARNINGS #endif void @@ -324,26 +372,50 @@ dcpomatic_setup () SetUnhandledExceptionFilter(exception_handler); #endif +#ifdef DCPOMATIC_HAVE_AVREGISTER +LIBDCP_DISABLE_WARNINGS av_register_all (); avfilter_register_all (); +LIBDCP_ENABLE_WARNINGS +#endif #ifdef DCPOMATIC_OSX - /* Add our lib directory to the libltdl search path so that + /* Add our library directory to the libltdl search path so that xmlsec can find xmlsec1-openssl. */ - boost::filesystem::path lib = app_contents (); - lib /= "lib"; + auto lib = directory_containing_executable().parent_path(); + lib /= "Frameworks"; setenv ("LTDL_LIBRARY_PATH", lib.c_str (), 1); #endif set_terminate (terminate); +#ifdef DCPOMATIC_WINDOWS + putenv ("PANGOCAIRO_BACKEND=fontconfig"); + putenv (String::compose("FONTCONFIG_PATH=%1", resources_path().string()).c_str()); +#endif + +#ifdef DCPOMATIC_OSX + setenv ("PANGOCAIRO_BACKEND", "fontconfig", 1); + setenv ("FONTCONFIG_PATH", resources_path().string().c_str(), 1); +#endif + Pango::init (); - dcp::init (); + dcp::init (libdcp_resources_path()); + +#if defined(DCPOMATIC_WINDOWS) || defined(DCPOMATIC_OSX) + /* Render something to fontconfig to create its cache */ + list subs; + dcp::SubtitleString ss( + optional(), false, false, false, dcp::Colour(), 42, 1, dcp::Time(), dcp::Time(), 0, dcp::HAlign::CENTER, 0, dcp::VAlign::CENTER, dcp::Direction::LTR, + "Hello dolly", dcp::Effect::NONE, dcp::Colour(), dcp::Time(), dcp::Time(), 0 + ); + subs.push_back (StringText(ss, 0)); + render_text (subs, list>(), dcp::Size(640, 480), DCPTime(), 24); +#endif Ratio::setup_ratios (); PresetColourConversion::setup_colour_conversion_presets (); - VideoContentScale::setup_scales (); DCPContentType::setup_dcp_content_types (); Filter::setup_filters (); CinemaSoundProcessor::setup_cinema_sound_processors (); @@ -351,10 +423,6 @@ dcpomatic_setup () curl_global_init (CURL_GLOBAL_ALL); -#ifdef DCPOMATIC_GRAPHICS_MAGICK - Magick::InitializeMagick (0); -#endif - ui_thread = boost::this_thread::get_id (); } @@ -424,16 +492,15 @@ digest_head_tail (vector files, boost::uintmax_t size) char* p = buffer.get (); int i = 0; while (i < int64_t (files.size()) && to_do > 0) { - FILE* f = fopen_boost (files[i], "rb"); + dcp::File f(files[i], "rb"); if (!f) { - throw OpenFileError (files[i].string(), errno, true); + throw OpenFileError (files[i].string(), errno, OpenFileError::READ); } boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i])); - fread (p, 1, this_time, f); + f.checked_read(p, this_time); p += this_time; to_do -= this_time; - fclose (f); ++i; } @@ -444,17 +511,16 @@ digest_head_tail (vector files, boost::uintmax_t size) p = buffer.get (); i = files.size() - 1; while (i >= 0 && to_do > 0) { - FILE* f = fopen_boost (files[i], "rb"); + dcp::File f(files[i], "rb"); if (!f) { - throw OpenFileError (files[i].string(), errno, true); + throw OpenFileError (files[i].string(), errno, OpenFileError::READ); } boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i])); - dcpomatic_fseek (f, -this_time, SEEK_END); - fread (p, 1, this_time, f); + f.seek(-this_time, SEEK_END); + f.checked_read(p, this_time); p += this_time; to_do -= this_time; - fclose (f); --i; } @@ -463,19 +529,14 @@ digest_head_tail (vector files, boost::uintmax_t size) return digester.get (); } -/** Round a number up to the nearest multiple of another number. - * @param c Index. - * @param stride Array of numbers to round, indexed by c. - * @param t Multiple to round to. - * @return Rounded number. - */ -int -stride_round_up (int c, int const * stride, int t) + +string +simple_digest (vector paths) { - int const a = stride[c] + (t - 1); - return a - (a % t); + return digest_head_tail(paths, 1000000) + raw_convert(boost::filesystem::file_size(paths.front())); } + /** Trip an assert if the caller is not in the UI thread */ void ensure_ui_thread () @@ -536,7 +597,7 @@ short_audio_channel_name (int c) _("BsR"), _("DBP"), _("DBS"), - "", + _("Sign"), "" }; @@ -551,12 +612,13 @@ valid_image_file (boost::filesystem::path f) return false; } - string ext = f.extension().string(); + auto ext = f.extension().string(); transform (ext.begin(), ext.end(), ext.begin(), ::tolower); return ( ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png" || ext == ".bmp" || ext == ".tga" || ext == ".dpx" || - ext == ".j2c" || ext == ".j2k" || ext == ".jp2" + ext == ".j2c" || ext == ".j2k" || ext == ".jp2" || ext == ".exr" || + ext == ".jpf" || ext == ".psd" ); } @@ -567,7 +629,7 @@ valid_sound_file (boost::filesystem::path f) return false; } - string ext = f.extension().string(); + auto ext = f.extension().string(); transform (ext.begin(), ext.end(), ext.begin(), ::tolower); return (ext == ".wav" || ext == ".mp3" || ext == ".aif" || ext == ".aiff"); } @@ -575,7 +637,7 @@ valid_sound_file (boost::filesystem::path f) bool valid_j2k_file (boost::filesystem::path f) { - string ext = f.extension().string(); + auto ext = f.extension().string(); transform (ext.begin(), ext.end(), ext.begin(), ::tolower); return (ext == ".j2k" || ext == ".j2c" || ext == ".jp2"); } @@ -597,16 +659,6 @@ fit_ratio_within (float ratio, dcp::Size full_frame) return dcp::Size (full_frame.width, lrintf (full_frame.width / ratio)); } -void * -wrapped_av_malloc (size_t s) -{ - void* p = av_malloc (s); - if (!p) { - throw bad_alloc (); - } - return p; -} - map split_get_request (string url) { @@ -679,13 +731,28 @@ audio_asset_filename (shared_ptr asset, int reel_index, int ree return Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + ".mxf"); } + +string +atmos_asset_filename (shared_ptr asset, int reel_index, int reel_count, optional summary) +{ + dcp::NameFormat::Map values; + values['t'] = "atmos"; + values['r'] = raw_convert (reel_index + 1); + values['n'] = raw_convert (reel_count); + if (summary) { + values['c'] = careful_string_filter (summary.get()); + } + return Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + ".mxf"); +} + + float relaxed_string_to_float (string s) { try { boost::algorithm::replace_all (s, ",", "."); return lexical_cast (s); - } catch (bad_lexical_cast) { + } catch (bad_lexical_cast &) { boost::algorithm::replace_all (s, ".", ","); return lexical_cast (s); } @@ -699,20 +766,44 @@ careful_string_filter (string s) Safety first and all that. */ - string out; - string const allowed = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_%."; - for (size_t i = 0; i < s.size(); ++i) { - if (allowed.find (s[i]) != string::npos) { - out += s[i]; + /* First transliterate using libicu to try to remove accents in a "nice" way */ + auto transliterated = icu::UnicodeString::fromUTF8(icu::StringPiece(s)); + auto status = U_ZERO_ERROR; + auto transliterator = icu::Transliterator::createInstance("NFD; [:M:] Remove; NFC", UTRANS_FORWARD, status); + transliterator->transliterate(transliterated); + + /* Some things are missed by ICU's transliterator */ + std::map replacements = { + { L'ł', L'l' }, + { L'Ł', L'L' } + }; + + icu::UnicodeString transliterated_more; + for (int i = 0; i < transliterated.length(); ++i) { + auto replacement = replacements.find(transliterated[i]); + if (replacement != replacements.end()) { + transliterated_more += replacement->second; + } else { + transliterated_more += transliterated[i]; + } + } + + /* Then remove anything that's not in a very limited character set */ + wstring out; + wstring const allowed = L"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_%.+"; + for (size_t i = 0; i < transliterated_more.length(); ++i) { + wchar_t c = transliterated_more[i]; + if (allowed.find(c) != string::npos) { + out += c; } } - return out; + return boost::locale::conv::utf_to_utf(out); } /** @param mapped List of mapped audio channels from a Film. * @param channels Total number of channels in the Film. - * @return First: number of non-LFE channels, second: number of LFE channels. + * @return First: number of non-LFE soundtrack channels (L/R/C/Ls/Rs/Lc/Rc/Bsl/Bsr), second: number of LFE channels. */ pair audio_channel_types (list mapped, int channels) @@ -720,18 +811,337 @@ audio_channel_types (list mapped, int channels) int non_lfe = 0; int lfe = 0; - BOOST_FOREACH (int i, mapped) { + for (auto i: mapped) { if (i >= channels) { /* This channel is mapped but is not included in the DCP */ continue; } - if (static_cast (i) == dcp::LFE) { + switch (static_cast(i)) { + case dcp::Channel::LFE: ++lfe; - } else { + break; + case dcp::Channel::LEFT: + case dcp::Channel::RIGHT: + case dcp::Channel::CENTRE: + case dcp::Channel::LS: + case dcp::Channel::RS: + case dcp::Channel::BSL: + case dcp::Channel::BSR: ++non_lfe; + break; + case dcp::Channel::HI: + case dcp::Channel::VI: + case dcp::Channel::MOTION_DATA: + case dcp::Channel::SYNC_SIGNAL: + case dcp::Channel::SIGN_LANGUAGE: + case dcp::Channel::CHANNEL_COUNT: + break; } } return make_pair (non_lfe, lfe); } + +shared_ptr +remap (shared_ptr input, int output_channels, AudioMapping map) +{ + auto mapped = make_shared(output_channels, input->frames()); + mapped->make_silent (); + + int to_do = min (map.input_channels(), input->channels()); + + for (int i = 0; i < to_do; ++i) { + for (int j = 0; j < mapped->channels(); ++j) { + if (map.get(i, j) > 0) { + mapped->accumulate_channel( + input.get(), + i, + j, + map.get(i, j) + ); + } + } + } + + return mapped; +} + +Eyes +increment_eyes (Eyes e) +{ + if (e == Eyes::LEFT) { + return Eyes::RIGHT; + } + + return Eyes::LEFT; +} + + +size_t +utf8_strlen (string s) +{ + size_t const len = s.length (); + int N = 0; + for (size_t i = 0; i < len; ++i) { + unsigned char c = s[i]; + if ((c & 0xe0) == 0xc0) { + ++i; + } else if ((c & 0xf0) == 0xe0) { + i += 2; + } else if ((c & 0xf8) == 0xf0) { + i += 3; + } + ++N; + } + return N; +} + +string +day_of_week_to_string (boost::gregorian::greg_weekday d) +{ + switch (d.as_enum()) { + case boost::date_time::Sunday: + return _("Sunday"); + case boost::date_time::Monday: + return _("Monday"); + case boost::date_time::Tuesday: + return _("Tuesday"); + case boost::date_time::Wednesday: + return _("Wednesday"); + case boost::date_time::Thursday: + return _("Thursday"); + case boost::date_time::Friday: + return _("Friday"); + case boost::date_time::Saturday: + return _("Saturday"); + } + + return d.as_long_string (); +} + +/** @param size Size of picture that the subtitle will be overlaid onto */ +void +emit_subtitle_image (ContentTimePeriod period, dcp::SubtitleImage sub, dcp::Size size, shared_ptr decoder) +{ + /* XXX: this is rather inefficient; decoding the image just to get its size */ + FFmpegImageProxy proxy (sub.png_image()); + auto image = proxy.image(Image::Alignment::PADDED).image; + /* set up rect with height and width */ + dcpomatic::Rect rect(0, 0, image->size().width / double(size.width), image->size().height / double(size.height)); + + /* add in position */ + + switch (sub.h_align()) { + case dcp::HAlign::LEFT: + rect.x += sub.h_position(); + break; + case dcp::HAlign::CENTER: + rect.x += 0.5 + sub.h_position() - rect.width / 2; + break; + case dcp::HAlign::RIGHT: + rect.x += 1 - sub.h_position() - rect.width; + break; + } + + switch (sub.v_align()) { + case dcp::VAlign::TOP: + rect.y += sub.v_position(); + break; + case dcp::VAlign::CENTER: + rect.y += 0.5 + sub.v_position() - rect.height / 2; + break; + case dcp::VAlign::BOTTOM: + rect.y += 1 - sub.v_position() - rect.height; + break; + } + + decoder->emit_bitmap (period, image, rect); +} + +bool +show_jobs_on_console (bool progress) +{ + bool first = true; + bool error = false; + while (true) { + + dcpomatic_sleep_seconds (5); + + auto jobs = JobManager::instance()->get(); + + if (!first && progress) { + for (size_t i = 0; i < jobs.size(); ++i) { + cout << "\033[1A\033[2K"; + } + cout.flush (); + } + + first = false; + + for (auto i: jobs) { + if (progress) { + cout << i->name(); + if (!i->sub_name().empty()) { + cout << "; " << i->sub_name(); + } + cout << ": "; + + if (i->progress ()) { + cout << i->status() << " \n"; + } else { + cout << ": Running \n"; + } + } + + if (!progress && i->finished_in_error()) { + /* We won't see this error if we haven't been showing progress, + so show it now. + */ + cout << i->status() << "\n"; + } + + if (i->finished_in_error()) { + error = true; + } + } + + if (!JobManager::instance()->work_to_do()) { + break; + } + } + + return error; +} + +/** XXX: could use mmap? */ +void +copy_in_bits (boost::filesystem::path from, boost::filesystem::path to, std::function progress) +{ + dcp::File f(from, "rb"); + if (!f) { + throw OpenFileError (from, errno, OpenFileError::READ); + } + dcp::File t(to, "wb"); + if (!t) { + throw OpenFileError (to, errno, OpenFileError::WRITE); + } + + /* on the order of a second's worth of copying */ + boost::uintmax_t const chunk = 20 * 1024 * 1024; + + std::vector buffer(chunk); + + boost::uintmax_t const total = boost::filesystem::file_size (from); + boost::uintmax_t remaining = total; + + while (remaining) { + boost::uintmax_t this_time = min (chunk, remaining); + size_t N = f.read(buffer.data(), 1, chunk); + if (N < this_time) { + throw ReadFileError (from, errno); + } + + N = t.write(buffer.data(), 1, this_time); + if (N < this_time) { + throw WriteFileError (to, errno); + } + + progress (1 - float(remaining) / total); + remaining -= this_time; + } +} + + +dcp::Size +scale_for_display (dcp::Size s, dcp::Size display_container, dcp::Size film_container, PixelQuanta quanta) +{ + /* Now scale it down if the display container is smaller than the film container */ + if (display_container != film_container) { + float const scale = min ( + float (display_container.width) / film_container.width, + float (display_container.height) / film_container.height + ); + + s.width = lrintf (s.width * scale); + s.height = lrintf (s.height * scale); + s = quanta.round (s); + } + + return s; +} + + +dcp::DecryptedKDM +decrypt_kdm_with_helpful_error (dcp::EncryptedKDM kdm) +{ + try { + return dcp::DecryptedKDM (kdm, Config::instance()->decryption_chain()->key().get()); + } catch (dcp::KDMDecryptionError& e) { + /* Try to flesh out the error a bit */ + auto const kdm_subject_name = kdm.recipient_x509_subject_name(); + bool on_chain = false; + auto dc = Config::instance()->decryption_chain(); + for (auto i: dc->root_to_leaf()) { + if (i.subject() == kdm_subject_name) { + on_chain = true; + } + } + if (!on_chain) { + throw KDMError (_("This KDM was not made for DCP-o-matic's decryption certificate."), e.what()); + } else if (kdm_subject_name != dc->leaf().subject()) { + throw KDMError (_("This KDM was made for DCP-o-matic but not for its leaf certificate."), e.what()); + } else { + throw; + } + } +} + + +boost::filesystem::path +default_font_file () +{ + boost::filesystem::path liberation_normal; + try { + liberation_normal = resources_path() / "LiberationSans-Regular.ttf"; + if (!boost::filesystem::exists (liberation_normal)) { + /* Hack for unit tests */ + liberation_normal = resources_path() / "fonts" / "LiberationSans-Regular.ttf"; + } + } catch (boost::filesystem::filesystem_error& e) { + + } + + if (!boost::filesystem::exists(liberation_normal)) { + liberation_normal = "/usr/share/fonts/truetype/liberation/LiberationSans-Regular.ttf"; + } + + return liberation_normal; +} + + +string +to_upper (string s) +{ + transform (s.begin(), s.end(), s.begin(), ::toupper); + return s; +} + + +/* Set to 1 to print the IDs of some of our threads to stdout on creation */ +#define DCPOMATIC_DEBUG_THREADS 0 + +#if DCPOMATIC_DEBUG_THREADS +void +start_of_thread (string name) +{ + std::cout << "THREAD:" << name << ":" << std::hex << pthread_self() << "\n"; +} +#else +void +start_of_thread (string) +{ + +} +#endif +