Allow changes to colours of FFmpeg subtitles (#795).
[dcpomatic.git] / src / lib / ffmpeg_content.cc
index 8feb7df5728e6bff53b2f23dbfeed4d1aabcc5c8..789fd735fd42f46a24aed8488d13480389391545 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 #include <libcxml/cxml.h>
 extern "C" {
 #include <libavformat/avformat.h>
+#include <libavutil/pixdesc.h>
 }
+#include <libxml++/libxml++.h>
 #include <boost/foreach.hpp>
+#include <iostream>
 
 #include "i18n.h"
 
-#define LOG_GENERAL(...) film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
+#define LOG_GENERAL(...) film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
 
 using std::string;
 using std::vector;
 using std::list;
 using std::cout;
 using std::pair;
+using std::make_pair;
 using boost::shared_ptr;
 using boost::dynamic_pointer_cast;
+using boost::optional;
 
 int const FFmpegContentProperty::SUBTITLE_STREAMS = 100;
 int const FFmpegContentProperty::SUBTITLE_STREAM = 101;
@@ -70,7 +75,7 @@ FFmpegContent::FFmpegContent (shared_ptr<const Film> film, cxml::ConstNodePtr no
 {
        list<cxml::NodePtr> c = node->node_children ("SubtitleStream");
        for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
-               _subtitle_streams.push_back (shared_ptr<FFmpegSubtitleStream> (new FFmpegSubtitleStream (*i)));
+               _subtitle_streams.push_back (shared_ptr<FFmpegSubtitleStream> (new FFmpegSubtitleStream (*i, version)));
                if ((*i)->optional_number_child<int> ("Selected")) {
                        _subtitle_stream = _subtitle_streams.back ();
                }
@@ -95,7 +100,19 @@ FFmpegContent::FFmpegContent (shared_ptr<const Film> film, cxml::ConstNodePtr no
                }
        }
 
-       _first_video = node->optional_number_child<double> ("FirstVideo");
+       optional<ContentTime::Type> const f = node->optional_number_child<ContentTime::Type> ("FirstVideo");
+       if (f) {
+               _first_video = ContentTime (f.get ());
+       }
+
+       _color_range = static_cast<AVColorRange> (node->optional_number_child<int>("ColorRange").get_value_or (AVCOL_RANGE_UNSPECIFIED));
+       _color_primaries = static_cast<AVColorPrimaries> (node->optional_number_child<int>("ColorPrimaries").get_value_or (AVCOL_PRI_UNSPECIFIED));
+       _color_trc = static_cast<AVColorTransferCharacteristic> (
+               node->optional_number_child<int>("ColorTransferCharacteristic").get_value_or (AVCOL_TRC_UNSPECIFIED)
+               );
+       _colorspace = static_cast<AVColorSpace> (node->optional_number_child<int>("Colorspace").get_value_or (AVCOL_SPC_UNSPECIFIED));
+       _bits_per_pixel = node->optional_number_child<int> ("BitsPerPixel");
+
 }
 
 FFmpegContent::FFmpegContent (shared_ptr<const Film> film, vector<boost::shared_ptr<Content> > c)
@@ -114,10 +131,18 @@ FFmpegContent::FFmpegContent (shared_ptr<const Film> film, vector<boost::shared_
                }
        }
 
+       /* XXX: should probably check that more of the stuff below is the same in *this and ref */
+
        _subtitle_streams = ref->subtitle_streams ();
        _subtitle_stream = ref->subtitle_stream ();
        _audio_streams = ref->ffmpeg_audio_streams ();
        _first_video = ref->_first_video;
+       _filters = ref->_filters;
+       _color_range = ref->_color_range;
+       _color_primaries = ref->_color_primaries;
+       _color_trc = ref->_color_trc;
+       _colorspace = ref->_colorspace;
+       _bits_per_pixel = ref->_bits_per_pixel;
 }
 
 void
@@ -150,6 +175,14 @@ FFmpegContent::as_xml (xmlpp::Node* node) const
        if (_first_video) {
                node->add_child("FirstVideo")->add_child_text (raw_convert<string> (_first_video.get().get()));
        }
+
+       node->add_child("ColorRange")->add_child_text (raw_convert<string> (_color_range));
+       node->add_child("ColorPrimaries")->add_child_text (raw_convert<string> (_color_primaries));
+       node->add_child("ColorTransferCharacteristic")->add_child_text (raw_convert<string> (_color_trc));
+       node->add_child("Colorspace")->add_child_text (raw_convert<string> (_colorspace));
+       if (_bits_per_pixel) {
+               node->add_child("BitsPerPixel")->add_child_text (raw_convert<string> (_bits_per_pixel.get ()));
+       }
 }
 
 void
@@ -162,9 +195,6 @@ FFmpegContent::examine (shared_ptr<Job> job)
        shared_ptr<FFmpegExaminer> examiner (new FFmpegExaminer (shared_from_this (), job));
        take_from_video_examiner (examiner);
 
-       shared_ptr<const Film> film = _film.lock ();
-       DCPOMATIC_ASSERT (film);
-
        {
                boost::mutex::scoped_lock lm (_mutex);
 
@@ -177,11 +207,17 @@ FFmpegContent::examine (shared_ptr<Job> job)
 
                if (!_audio_streams.empty ()) {
                        AudioMapping m = _audio_streams.front()->mapping ();
-                       film->make_audio_mapping_default (m);
+                       film()->make_audio_mapping_default (m);
                        _audio_streams.front()->set_mapping (m);
                }
 
                _first_video = examiner->first_video ();
+
+               _color_range = examiner->color_range ();
+               _color_primaries = examiner->color_primaries ();
+               _color_trc = examiner->color_trc ();
+               _colorspace = examiner->colorspace ();
+               _bits_per_pixel = examiner->bits_per_pixel ();
        }
 
        signal_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
@@ -249,10 +285,8 @@ operator!= (FFmpegStream const & a, FFmpegStream const & b)
 DCPTime
 FFmpegContent::full_length () const
 {
-       shared_ptr<const Film> film = _film.lock ();
-       DCPOMATIC_ASSERT (film);
-       FrameRateChange const frc (video_frame_rate (), film->video_frame_rate ());
-       return DCPTime::from_frames (rint (video_length_after_3d_combine() * frc.factor()), film->video_frame_rate());
+       FrameRateChange const frc (video_frame_rate (), film()->video_frame_rate ());
+       return DCPTime::from_frames (llrint (video_length_after_3d_combine() * frc.factor()), film()->video_frame_rate());
 }
 
 void
@@ -271,7 +305,8 @@ FFmpegContent::identifier () const
 {
        SafeStringStream s;
 
-       s << VideoContent::identifier();
+       s << VideoContent::identifier() << "_"
+         << SubtitleContent::identifier();
 
        boost::mutex::scoped_lock lm (_mutex);
 
@@ -287,26 +322,49 @@ FFmpegContent::identifier () const
 }
 
 list<ContentTimePeriod>
-FFmpegContent::subtitles_during (ContentTimePeriod period, bool starting) const
+FFmpegContent::image_subtitles_during (ContentTimePeriod period, bool starting) const
+{
+       shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
+       if (!stream) {
+               return list<ContentTimePeriod> ();
+       }
+
+       return stream->image_subtitles_during (period, starting);
+}
+
+list<ContentTimePeriod>
+FFmpegContent::text_subtitles_during (ContentTimePeriod period, bool starting) const
 {
        shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
        if (!stream) {
                return list<ContentTimePeriod> ();
        }
 
-       return stream->subtitles_during (period, starting);
+       return stream->text_subtitles_during (period, starting);
 }
 
 bool
-FFmpegContent::has_text_subtitles () const
+FFmpegContent::has_image_subtitles () const
 {
+       BOOST_FOREACH (shared_ptr<FFmpegSubtitleStream> i, subtitle_streams()) {
+               if (i->has_image_subtitles()) {
+                       return true;
+               }
+       }
+
        return false;
 }
 
 bool
-FFmpegContent::has_image_subtitles () const
+FFmpegContent::has_text_subtitles () const
 {
-       return !subtitle_streams().empty ();
+       BOOST_FOREACH (shared_ptr<FFmpegSubtitleStream> i, subtitle_streams()) {
+               if (i->has_text_subtitles()) {
+                       return true;
+               }
+       }
+
+       return false;
 }
 
 void
@@ -332,3 +390,129 @@ FFmpegContent::audio_streams () const
        copy (_audio_streams.begin(), _audio_streams.end(), back_inserter (s));
        return s;
 }
+
+void
+FFmpegContent::add_properties (list<UserProperty>& p) const
+{
+       VideoContent::add_properties (p);
+       AudioContent::add_properties (p);
+
+       if (_bits_per_pixel) {
+               int const sub = 219 * pow (2, _bits_per_pixel.get() - 8);
+               int const total = pow (2, _bits_per_pixel.get());
+
+               switch (_color_range) {
+               case AVCOL_RANGE_UNSPECIFIED:
+                       /// TRANSLATORS: this means that the range of pixel values used in this
+                       /// file is unknown (not specified in the file).
+                       p.push_back (UserProperty (_("Video"), _("Colour range"), _("Unspecified")));
+                       break;
+               case AVCOL_RANGE_MPEG:
+                       /// TRANSLATORS: this means that the range of pixel values used in this
+                       /// file is limited, so that not all possible values are valid.
+                       p.push_back (
+                               UserProperty (
+                                       _("Video"), _("Colour range"), String::compose (_("Limited (%1-%2)"), (total - sub) / 2, (total + sub) / 2)
+                                       )
+                               );
+                       break;
+               case AVCOL_RANGE_JPEG:
+                       /// TRANSLATORS: this means that the range of pixel values used in this
+                       /// file is full, so that all possible pixel values are valid.
+                       p.push_back (UserProperty (_("Video"), _("Colour range"), String::compose (_("Full (0-%1)"), total)));
+                       break;
+               default:
+                       DCPOMATIC_ASSERT (false);
+               }
+       } else {
+               switch (_color_range) {
+               case AVCOL_RANGE_UNSPECIFIED:
+                       /// TRANSLATORS: this means that the range of pixel values used in this
+                       /// file is unknown (not specified in the file).
+                       p.push_back (UserProperty (_("Video"), _("Colour range"), _("Unspecified")));
+                       break;
+               case AVCOL_RANGE_MPEG:
+                       /// TRANSLATORS: this means that the range of pixel values used in this
+                       /// file is limited, so that not all possible values are valid.
+                       p.push_back (UserProperty (_("Video"), _("Colour range"), _("Limited")));
+                       break;
+               case AVCOL_RANGE_JPEG:
+                       /// TRANSLATORS: this means that the range of pixel values used in this
+                       /// file is full, so that all possible pixel values are valid.
+                       p.push_back (UserProperty (_("Video"), _("Colour range"), _("Full")));
+                       break;
+               default:
+                       DCPOMATIC_ASSERT (false);
+               }
+       }
+
+       char const * primaries[] = {
+               _("Unspecified"),
+               _("BT709"),
+               _("Unspecified"),
+               _("Unspecified"),
+               _("BT470M"),
+               _("BT470BG"),
+               _("SMPTE 170M (BT601)"),
+               _("SMPTE 240M"),
+               _("Film"),
+               _("BT2020")
+       };
+
+       DCPOMATIC_ASSERT (AVCOL_PRI_NB == 10);
+       p.push_back (UserProperty (_("Video"), _("Colour primaries"), primaries[_color_primaries]));
+
+       char const * transfers[] = {
+               _("Unspecified"),
+               _("BT709"),
+               _("Unspecified"),
+               _("Unspecified"),
+               _("Gamma 22 (BT470M)"),
+               _("Gamma 28 (BT470BG)"),
+               _("SMPTE 170M (BT601)"),
+               _("SMPTE 240M"),
+               _("Linear"),
+               _("Logarithmic (100:1 range)"),
+               _("Logarithmic (316:1 range)"),
+               _("IEC61966-2-4"),
+               _("BT1361 extended colour gamut"),
+               _("IEC61966-2-1 (sRGB or sYCC)"),
+               _("BT2020 for a 10-bit system"),
+               _("BT2020 for a 12-bit system")
+       };
+
+       DCPOMATIC_ASSERT (AVCOL_TRC_NB == 16);
+       p.push_back (UserProperty (_("Video"), _("Colour transfer characteristic"), transfers[_color_trc]));
+
+       char const * spaces[] = {
+               _("RGB / sRGB (IEC61966-2-1)"),
+               _("BT709"),
+               _("Unspecified"),
+               _("Unspecified"),
+               _("FCC"),
+               _("BT470BG (BT601-6)"),
+               _("SMPTE 170M (BT601-6)"),
+               _("SMPTE 240M"),
+               _("YCOCG"),
+               _("BT2020 non-constant luminance"),
+               _("BT2020 constant luminance"),
+       };
+
+       DCPOMATIC_ASSERT (AVCOL_SPC_NB == 11);
+       p.push_back (UserProperty (_("Video"), _("Colourspace"), spaces[_colorspace]));
+
+       if (_bits_per_pixel) {
+               p.push_back (UserProperty (_("Video"), _("Bits per pixel"), raw_convert<string> (_bits_per_pixel.get ())));
+       }
+}
+
+/** Our subtitle streams have colour maps, which can be changed, but
+ *  they have no way of signalling that change.  As a hack, we have this
+ *  method which callers can use when they've modified one of our subtitle
+ *  streams.
+ */
+void
+FFmpegContent::signal_subtitle_stream_changed ()
+{
+       signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
+}