Fix subtitle font handling with in-memory fonts from SMPTE (#2509).
[dcpomatic.git] / src / lib / util.cc
index 6e2a1ad642c9d2b7a945abf32314879438b233c2..8c570059821d35ca3290dd250524d3f682b2c6f9 100644 (file)
 #include "cinema_sound_processor.h"
 #include "compose.hpp"
 #include "config.h"
+#include "constants.h"
 #include "cross.h"
 #include "crypto.h"
 #include "dcp_content_type.h"
+#include "dcpomatic_log.h"
 #include "digester.h"
 #include "exceptions.h"
 #include "ffmpeg_image_proxy.h"
@@ -45,6 +47,7 @@
 #include "ratio.h"
 #include "rect.h"
 #include "render_text.h"
+#include "scope_guard.h"
 #include "string_text.h"
 #include "text_decoder.h"
 #include "util.h"
@@ -71,6 +74,7 @@ LIBDCP_ENABLE_WARNINGS
 #include <unicode/utypes.h>
 #include <unicode/unistr.h>
 #include <unicode/translit.h>
+#include <unicode/brkiter.h>
 #include <boost/algorithm/string.hpp>
 #include <boost/range/algorithm/replace_if.hpp>
 #include <boost/thread.hpp>
@@ -79,7 +83,6 @@ LIBDCP_DISABLE_WARNINGS
 #include <boost/locale.hpp>
 LIBDCP_ENABLE_WARNINGS
 #ifdef DCPOMATIC_WINDOWS
-#include <boost/locale.hpp>
 #include <dbghelp.h>
 #endif
 #include <signal.h>
@@ -250,9 +253,11 @@ LIBDCP_DISABLE_WARNINGS
 LONG WINAPI
 exception_handler(struct _EXCEPTION_POINTERS * info)
 {
-       auto 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;
@@ -357,6 +362,59 @@ dcpomatic_setup_path_encoding ()
 #endif
 }
 
+
+class LogSink : public Kumu::ILogSink
+{
+public:
+       LogSink () {}
+       LogSink (LogSink const&) = delete;
+       LogSink& operator= (LogSink const&) = delete;
+
+       void WriteEntry(const Kumu::LogEntry& entry) override {
+               Kumu::AutoMutex L(m_lock);
+               WriteEntryToListeners(entry);
+               if (entry.TestFilter(m_filter)) {
+                       string buffer;
+                       entry.CreateStringWithOptions(buffer, m_options);
+                       LOG_GENERAL("asdcplib: %1", buffer);
+               }
+       }
+};
+
+
+void
+capture_asdcp_logs ()
+{
+       static LogSink log_sink;
+       Kumu::SetDefaultLogSink(&log_sink);
+}
+
+
+static
+void
+ffmpeg_log_callback(void* ptr, int level, const char* fmt, va_list vl)
+{
+       if (level > AV_LOG_WARNING) {
+               return;
+       }
+
+       char line[1024];
+       static int prefix = 0;
+       av_log_format_line(ptr, level, fmt, vl, line, sizeof (line), &prefix);
+       string str(line);
+       boost::algorithm::trim(str);
+       dcpomatic_log->log(String::compose("FFmpeg: %1", str), LogEntry::TYPE_GENERAL);
+}
+
+
+static
+void
+capture_ffmpeg_logs()
+{
+       av_log_set_callback(ffmpeg_log_callback);
+}
+
+
 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
  *  Must be called from the UI thread, if there is one.
  */
@@ -405,11 +463,11 @@ LIBDCP_ENABLE_WARNINGS
        /* Render something to fontconfig to create its cache */
        list<StringText> subs;
        dcp::SubtitleString ss(
-               optional<string>(), false, false, false, dcp::Colour(), 42, 1, dcp::Time(), dcp::Time(), 0, dcp::HAlign::CENTER, 0, dcp::VAlign::CENTER, dcp::Direction::LTR,
+               optional<string>(), false, false, false, dcp::Colour(), 42, 1, dcp::Time(), dcp::Time(), 0, dcp::HAlign::CENTER, 0, dcp::VAlign::CENTER, 0, 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<shared_ptr<Font>>(), dcp::Size(640, 480), DCPTime(), 24);
+       subs.push_back(StringText(ss, 0, make_shared<dcpomatic::Font>("foo"), dcp::SubtitleStandard::SMPTE_2014));
+       render_text (subs, dcp::Size(640, 480), DCPTime(), 24);
 #endif
 
        Ratio::setup_ratios ();
@@ -422,6 +480,9 @@ LIBDCP_ENABLE_WARNINGS
        curl_global_init (CURL_GLOBAL_ALL);
 
        ui_thread = boost::this_thread::get_id ();
+
+       capture_asdcp_logs ();
+       capture_ffmpeg_logs();
 }
 
 #ifdef DCPOMATIC_WINDOWS
@@ -490,16 +551,15 @@ digest_head_tail (vector<boost::filesystem::path> files, boost::uintmax_t size)
        char* p = buffer.get ();
        int i = 0;
        while (i < int64_t (files.size()) && to_do > 0) {
-               auto f = fopen_boost (files[i], "rb");
+               dcp::File f(files[i], "rb");
                if (!f) {
                        throw OpenFileError (files[i].string(), errno, OpenFileError::READ);
                }
 
                boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i]));
-               checked_fread (p, this_time, f, files[i]);
+               f.checked_read(p, this_time);
                p += this_time;
                to_do -= this_time;
-               fclose (f);
 
                ++i;
        }
@@ -510,17 +570,16 @@ digest_head_tail (vector<boost::filesystem::path> files, boost::uintmax_t size)
        p = buffer.get ();
        i = files.size() - 1;
        while (i >= 0 && to_do > 0) {
-               auto f = fopen_boost (files[i], "rb");
+               dcp::File f(files[i], "rb");
                if (!f) {
                        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);
-               checked_fread (p, this_time, f, files[i]);
+               f.seek(-this_time, SEEK_END);
+               f.checked_read(p, this_time);
                p += this_time;
                to_do -= this_time;
-               fclose (f);
 
                --i;
        }
@@ -591,14 +650,14 @@ short_audio_channel_name (int c)
                _("Rs"),
                _("HI"),
                _("VI"),
-               _("Lc"),
-               _("Rc"),
+               _("9"),
+               _("10"),
                _("BsL"),
                _("BsR"),
                _("DBP"),
                _("DBS"),
                _("Sign"),
-               ""
+               _("16")
        };
 
        return channels[c];
@@ -659,105 +718,49 @@ fit_ratio_within (float ratio, dcp::Size full_frame)
        return dcp::Size (full_frame.width, lrintf (full_frame.width / ratio));
 }
 
-map<string, string>
-split_get_request (string url)
+static
+string
+asset_filename (shared_ptr<dcp::Asset> asset, string type, int reel_index, int reel_count, optional<string> summary, string extension)
 {
-       enum {
-               AWAITING_QUESTION_MARK,
-               KEY,
-               VALUE
-       } state = AWAITING_QUESTION_MARK;
-
-       map<string, string> r;
-       string k;
-       string v;
-       for (size_t i = 0; i < url.length(); ++i) {
-               switch (state) {
-               case AWAITING_QUESTION_MARK:
-                       if (url[i] == '?') {
-                               state = KEY;
-                       }
-                       break;
-               case KEY:
-                       if (url[i] == '=') {
-                               v.clear ();
-                               state = VALUE;
-                       } else {
-                               k += url[i];
-                       }
-                       break;
-               case VALUE:
-                       if (url[i] == '&') {
-                               r.insert (make_pair (k, v));
-                               k.clear ();
-                               state = KEY;
-                       } else {
-                               v += url[i];
-                       }
-                       break;
-               }
-       }
-
-       if (state == VALUE) {
-               r.insert (make_pair (k, v));
+       dcp::NameFormat::Map values;
+       values['t'] = type;
+       values['r'] = raw_convert<string>(reel_index + 1);
+       values['n'] = raw_convert<string>(reel_count);
+       if (summary) {
+               values['c'] = careful_string_filter(summary.get());
        }
-
-       return r;
+       return Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + extension);
 }
 
+
 string
 video_asset_filename (shared_ptr<dcp::PictureAsset> asset, int reel_index, int reel_count, optional<string> summary)
 {
-       dcp::NameFormat::Map values;
-       values['t'] = "j2c";
-       values['r'] = raw_convert<string> (reel_index + 1);
-       values['n'] = raw_convert<string> (reel_count);
-       if (summary) {
-               values['c'] = careful_string_filter (summary.get());
-       }
-       return Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + ".mxf");
+       return asset_filename(asset, "j2c", reel_index, reel_count, summary, ".mxf");
 }
 
+
 string
 audio_asset_filename (shared_ptr<dcp::SoundAsset> asset, int reel_index, int reel_count, optional<string> summary)
 {
-       dcp::NameFormat::Map values;
-       values['t'] = "pcm";
-       values['r'] = raw_convert<string> (reel_index + 1);
-       values['n'] = raw_convert<string> (reel_count);
-       if (summary) {
-               values['c'] = careful_string_filter (summary.get());
-       }
-       return Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + ".mxf");
+       return asset_filename(asset, "pcm", reel_index, reel_count, summary, ".mxf");
 }
 
 
 string
-atmos_asset_filename (shared_ptr<dcp::AtmosAsset> asset, int reel_index, int reel_count, optional<string> summary)
+subtitle_asset_filename (shared_ptr<dcp::SubtitleAsset> asset, int reel_index, int reel_count, optional<string> summary, string extension)
 {
-       dcp::NameFormat::Map values;
-       values['t'] = "atmos";
-       values['r'] = raw_convert<string> (reel_index + 1);
-       values['n'] = raw_convert<string> (reel_count);
-       if (summary) {
-               values['c'] = careful_string_filter (summary.get());
-       }
-       return Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + ".mxf");
+       return asset_filename(asset, "sub", reel_index, reel_count, summary, extension);
 }
 
 
-float
-relaxed_string_to_float (string s)
+string
+atmos_asset_filename (shared_ptr<dcp::AtmosAsset> asset, int reel_index, int reel_count, optional<string> summary)
 {
-       try {
-               boost::algorithm::replace_all (s, ",", ".");
-               return lexical_cast<float> (s);
-       } catch (bad_lexical_cast &) {
-               boost::algorithm::replace_all (s, ".", ",");
-               return lexical_cast<float> (s);
-       }
+       return asset_filename(asset, "atmos", reel_index, reel_count, summary, ".mxf");
 }
 
+
 string
 careful_string_filter (string s)
 {
@@ -767,19 +770,32 @@ careful_string_filter (string s)
        */
 
        /* First transliterate using libicu to try to remove accents in a "nice" way */
-       auto icu_utf16 = icu::UnicodeString::fromUTF8(icu::StringPiece(s));
+       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(icu_utf16);
-       s.clear ();
-       icu_utf16.toUTF8String(s);
+       transliterator->transliterate(transliterated);
+
+       /* Some things are missed by ICU's transliterator */
+       std::map<wchar_t, wchar_t> 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 ws = boost::locale::conv::utf_to_utf<wchar_t>(s);
-       string out;
-       string const allowed = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_%.+";
-       for (size_t i = 0; i < ws.size(); ++i) {
-               wchar_t c = ws[i];
+       wstring out;
+       wstring const allowed = L"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_%.+";
+       for (int i = 0; i < transliterated_more.length(); ++i) {
+               wchar_t c = transliterated_more[i];
                if (allowed.find(c) != string::npos) {
                        out += c;
                }
@@ -864,35 +880,6 @@ increment_eyes (Eyes e)
        return Eyes::LEFT;
 }
 
-void
-checked_fwrite (void const * ptr, size_t size, FILE* stream, boost::filesystem::path path)
-{
-       size_t N = fwrite (ptr, 1, size, stream);
-       if (N != size) {
-               if (ferror(stream)) {
-                       fclose (stream);
-                       throw FileError (String::compose("fwrite error %1", errno), path);
-               } else {
-                       fclose (stream);
-                       throw FileError ("Unexpected short write", path);
-               }
-       }
-}
-
-void
-checked_fread (void* ptr, size_t size, FILE* stream, boost::filesystem::path path)
-{
-       size_t N = fread (ptr, 1, size, stream);
-       if (N != size) {
-               if (ferror(stream)) {
-                       fclose (stream);
-                       throw FileError (String::compose("fread error %1", errno), path);
-               } else {
-                       fclose (stream);
-                       throw FileError ("Unexpected short read", path);
-               }
-       }
-}
 
 size_t
 utf8_strlen (string s)
@@ -913,28 +900,6 @@ utf8_strlen (string s)
        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
@@ -975,111 +940,43 @@ emit_subtitle_image (ContentTimePeriod period, dcp::SubtitleImage sub, dcp::Size
        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<void (float)> progress)
 {
-       auto f = fopen_boost (from, "rb");
+       dcp::File f(from, "rb");
        if (!f) {
                throw OpenFileError (from, errno, OpenFileError::READ);
        }
-       auto t = fopen_boost (to, "wb");
+       dcp::File t(to, "wb");
        if (!t) {
-               fclose (f);
                throw OpenFileError (to, errno, OpenFileError::WRITE);
        }
 
        /* on the order of a second's worth of copying */
        boost::uintmax_t const chunk = 20 * 1024 * 1024;
 
-       auto buffer = static_cast<uint8_t*> (malloc(chunk));
-       if (!buffer) {
-               throw std::bad_alloc ();
-       }
+       std::vector<uint8_t> 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 = fread (buffer, 1, chunk, f);
+               size_t N = f.read(buffer.data(), 1, chunk);
                if (N < this_time) {
-                       fclose (f);
-                       fclose (t);
-                       free (buffer);
                        throw ReadFileError (from, errno);
                }
 
-               N = fwrite (buffer, 1, this_time, t);
+               N = t.write(buffer.data(), 1, this_time);
                if (N < this_time) {
-                       fclose (f);
-                       fclose (t);
-                       free (buffer);
                        throw WriteFileError (to, errno);
                }
 
                progress (1 - float(remaining) / total);
                remaining -= this_time;
        }
-
-       fclose (f);
-       fclose (t);
-       free (buffer);
 }
 
 
@@ -1145,19 +1042,14 @@ default_font_file ()
        if (!boost::filesystem::exists(liberation_normal)) {
                liberation_normal = "/usr/share/fonts/truetype/liberation/LiberationSans-Regular.ttf";
        }
+       if (!boost::filesystem::exists(liberation_normal)) {
+               liberation_normal = "/usr/share/fonts/liberation-sans/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
 
@@ -1175,3 +1067,52 @@ start_of_thread (string)
 }
 #endif
 
+
+string
+error_details(boost::system::error_code ec)
+{
+       return String::compose("%1:%2:%3", ec.category().name(), ec.value(), ec.message());
+}
+
+
+bool
+contains_assetmap(boost::filesystem::path dir)
+{
+       return boost::filesystem::is_regular_file(dir / "ASSETMAP") || boost::filesystem::is_regular_file(dir / "ASSETMAP.xml");
+}
+
+
+string
+word_wrap(string input, int columns)
+{
+       icu::Locale locale;
+       UErrorCode status = U_ZERO_ERROR;
+       auto iter = icu::BreakIterator::createLineInstance(locale, status);
+       ScopeGuard sg = [iter]() { delete iter; };
+       if (U_FAILURE(status)) {
+               return input;
+       }
+
+       auto input_icu = icu::UnicodeString::fromUTF8(icu::StringPiece(input));
+       iter->setText(input_icu);
+
+       int position = 0;
+       string output;
+       while (position < input_icu.length()) {
+               int end_of_line = iter->preceding(position + columns + 1);
+               icu::UnicodeString line;
+               if (end_of_line <= position) {
+                       /* There's no good line-break position; just break in the middle of a word */
+                       line = input_icu.tempSubString(position, columns);
+                       position += columns;
+               } else {
+                       line = input_icu.tempSubString(position, end_of_line - position);
+                       position = end_of_line;
+               }
+               line.toUTF8String(output);
+               output += "\n";
+       }
+
+       return output;
+}
+