path: root/src/lib/ffmpeg_content.cc

/*
    Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>

    This file is part of DCP-o-matic.

    DCP-o-matic is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    DCP-o-matic is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.


*/

#include "audio_content.h"
#include "config.h"
#include "constants.h"
#include "exceptions.h"
#include "ffmpeg_audio_stream.h"
#include "ffmpeg_content.h"
#include "ffmpeg_examiner.h"
#include "ffmpeg_subtitle_stream.h"
#include "film.h"
#include "filter.h"
#include "frame_rate_change.h"
#include "job.h"
#include "log.h"
#include "text_content.h"
#include "variant.h"
#include "video_content.h"
#include <libcxml/cxml.h>
extern "C" {
#include <libavformat/avformat.h>
#include <libavutil/pixdesc.h>
}
#include <libxml++/libxml++.h>
#include <fmt/format.h>
#include <iostream>

#include "i18n.h"


using std::string;
using std::vector;
using std::list;
using std::cout;
using std::pair;
using std::make_pair;
using std::max;
using std::make_shared;
using std::shared_ptr;
using std::dynamic_pointer_cast;
using boost::optional;
using namespace dcpomatic;


FFmpegContent::FFmpegContent (boost::filesystem::path p)
	: Content (p)
{

}


template <class T>
optional<T>
get_optional_enum (cxml::ConstNodePtr node, string name)
{
	auto const v = node->optional_number_child<int>(name);
	if (!v) {
		return optional<T>();
	}
	return static_cast<T>(*v);
}


FFmpegContent::FFmpegContent(cxml::ConstNodePtr node, boost::optional<boost::filesystem::path> film_directory, int version, list<string>& notes)
	: Content(node, film_directory)
{
	_color_range = get_optional_enum<AVColorRange>(node, "ColorRange");

	VideoRange const video_range_hint = (_color_range && *_color_range == AVCOL_RANGE_JPEG) ? VideoRange::FULL : VideoRange::VIDEO;

	video = VideoContent::from_xml (this, node, version, video_range_hint);
	audio = AudioContent::from_xml (this, node, version);
	text = TextContent::from_xml (this, node, version, notes);

	for (auto i: node->node_children("SubtitleStream")) {
		_subtitle_streams.push_back (make_shared<FFmpegSubtitleStream>(i, version));
		if (i->optional_number_child<int>("Selected")) {
			_subtitle_stream = _subtitle_streams.back ();
		}
	}

	for (auto i: node->node_children("AudioStream")) {
		auto as = make_shared<FFmpegAudioStream>(i, version);
		audio->add_stream (as);
		if (version < 11 && !i->optional_node_child ("Selected")) {
			/* This is an old file and this stream is not selected, so un-map it */
			as->set_mapping (AudioMapping (as->channels (), MAX_DCP_AUDIO_CHANNELS));
		}
	}

	for (auto i: node->node_children("Filter")) {
		if (auto filter = Filter::from_id(i->content())) {
			_filters.push_back(*filter);
		} else {
			notes.push_back(fmt::format(_("{} no longer supports the `{}' filter, so it has been turned off."), variant::dcpomatic(), i->content()));
		}
	}

	auto const f = node->optional_number_child<ContentTime::Type> ("FirstVideo");
	if (f) {
		_first_video = ContentTime (f.get ());
	}

	_color_primaries = get_optional_enum<AVColorPrimaries>(node, "ColorPrimaries");
	_color_trc = get_optional_enum<AVColorTransferCharacteristic>(node, "ColorTransferCharacteristic");
	_colorspace = get_optional_enum<AVColorSpace>(node, "Colorspace");
	_bits_per_pixel = node->optional_number_child<int> ("BitsPerPixel");
}


FFmpegContent::FFmpegContent (vector<shared_ptr<Content>> c)
	: Content (c)
{
	auto i = c.begin ();

	bool need_video = false;
	bool need_audio = false;
	bool need_text = false;

	if (i != c.end ()) {
		need_video = static_cast<bool> ((*i)->video);
		need_audio = static_cast<bool> ((*i)->audio);
		need_text = !(*i)->text.empty();
	}

	while (i != c.end ()) {
		if (need_video != static_cast<bool> ((*i)->video)) {
			throw JoinError (_("Content to be joined must all have or not have video"));
		}
		if (need_audio != static_cast<bool> ((*i)->audio)) {
			throw JoinError (_("Content to be joined must all have or not have audio"));
		}
		if (need_text != !(*i)->text.empty()) {
			throw JoinError (_("Content to be joined must all have or not have subtitles or captions"));
		}
		++i;
	}

	if (need_video) {
		video = make_shared<VideoContent>(this, c);
	}
	if (need_audio) {
		audio = make_shared<AudioContent>(this, c);
	}
	if (need_text) {
		text.push_back (make_shared<TextContent>(this, c));
	}

	auto ref = dynamic_pointer_cast<FFmpegContent> (c[0]);
	DCPOMATIC_ASSERT (ref);

	for (size_t i = 0; i < c.size(); ++i) {
		auto fc = dynamic_pointer_cast<FFmpegContent>(c[i]);
		if (fc->only_text() && fc->only_text()->use() && *(fc->_subtitle_stream.get()) != *(ref->_subtitle_stream.get())) {
			throw JoinError (_("Content to be joined must use the same subtitle stream."));
		}
	}

	/* 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 ();
	_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
FFmpegContent::as_xml(xmlpp::Element* element, bool with_paths, PathBehaviour path_behaviour, optional<boost::filesystem::path> film_directory) const
{
	cxml::add_text_child(element, "Type", "FFmpeg");
	Content::as_xml(element, with_paths, path_behaviour, film_directory);

	if (video) {
		video->as_xml(element);
	}

	if (audio) {
		audio->as_xml(element);

		for (auto i: audio->streams()) {
			auto f = dynamic_pointer_cast<FFmpegAudioStream> (i);
			DCPOMATIC_ASSERT (f);
			f->as_xml(cxml::add_child(element, "AudioStream"));
		}
	}

	if (only_text()) {
		only_text()->as_xml(element);
	}

	boost::mutex::scoped_lock lm (_mutex);

	for (auto i: _subtitle_streams) {
		auto t = cxml::add_child(element, "SubtitleStream");
		if (_subtitle_stream && i == _subtitle_stream) {
			cxml::add_text_child(t, "Selected", "1");
		}
		i->as_xml (t);
	}

	for (auto i: _filters) {
		cxml::add_text_child(element, "Filter", i.id());
	}

	if (_first_video) {
		cxml::add_text_child(element, "FirstVideo", fmt::to_string(_first_video.get().get()));
	}

	if (_color_range) {
		cxml::add_text_child(element, "ColorRange", fmt::to_string(static_cast<int>(*_color_range)));
	}
	if (_color_primaries) {
		cxml::add_text_child(element, "ColorPrimaries", fmt::to_string(static_cast<int>(*_color_primaries)));
	}
	if (_color_trc) {
		cxml::add_text_child(element, "ColorTransferCharacteristic", fmt::to_string(static_cast<int>(*_color_trc)));
	}
	if (_colorspace) {
		cxml::add_text_child(element, "Colorspace", fmt::to_string(static_cast<int>(*_colorspace)));
	}
	if (_bits_per_pixel) {
		cxml::add_text_child(element, "BitsPerPixel", fmt::to_string(*_bits_per_pixel));
	}
}


void
FFmpegContent::examine(shared_ptr<const Film> film, shared_ptr<Job> job, bool tolerant)
{
	ContentChangeSignaller cc1 (this, FFmpegContentProperty::SUBTITLE_STREAMS);
	ContentChangeSignaller cc2 (this, FFmpegContentProperty::SUBTITLE_STREAM);

	if (job) {
		job->set_progress_unknown ();
	}

	Content::examine(film, job, tolerant);

	auto examiner = make_shared<FFmpegExaminer>(shared_from_this (), job);

	if (examiner->has_video ()) {
		video.reset (new VideoContent (this));
		video->take_from_examiner(film, examiner);
	}

	auto first_path = path (0);

	{
		boost::mutex::scoped_lock lm (_mutex);

		if (examiner->has_video ()) {
			_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 ();

			if (examiner->rotation()) {
				auto rot = *examiner->rotation ();
				if (fabs (rot - 180) < 1.0) {
					_filters.push_back(*Filter::from_id("vflip"));
					_filters.push_back(*Filter::from_id("hflip"));
				} else if (fabs (rot - 90) < 1.0) {
					_filters.push_back(*Filter::from_id("90clock"));
					video->rotate_size();
				} else if (fabs (rot - 270) < 1.0) {
					_filters.push_back(*Filter::from_id("90anticlock"));
					video->rotate_size();
				}
			}
			if (examiner->has_alpha()) {
				_filters.push_back(*Filter::from_id("premultiply"));
			}
		}

		if (!examiner->audio_streams().empty()) {
			audio = make_shared<AudioContent>(this);

			for (auto i: examiner->audio_streams()) {
				audio->add_stream (i);
			}

			auto as = audio->streams().front();
			auto m = as->mapping ();
			m.make_default (film ? film->audio_processor() : 0, first_path);
			as->set_mapping (m);
		}

		_subtitle_streams = examiner->subtitle_streams ();
		if (!_subtitle_streams.empty ()) {
			text.clear ();
			text.push_back (make_shared<TextContent>(this, TextType::OPEN_SUBTITLE, TextType::UNKNOWN));
			_subtitle_stream = _subtitle_streams.front ();
			text.front()->add_font(make_shared<dcpomatic::Font>(""));
		}
	}

	if (examiner->has_video ()) {
		set_default_colour_conversion ();
	}

	if (examiner->has_video() && examiner->pulldown() && video_frame_rate() && fabs(*video_frame_rate() - 29.97) < 0.001) {
		/* FFmpeg has detected this file as 29.97 and the examiner thinks it is using "soft" 2:3 pulldown (telecine).
		 * This means we can treat it as a 23.976fps file.
		 */
		set_video_frame_rate(film, 24000.0 / 1001);
		video->set_length (video->length() * 24.0 / 30);
	}
}


string
FFmpegContent::summary () const
{
	if (video && audio) {
		return fmt::format(_("{} [movie]"), path_summary());
	} else if (video) {
		return fmt::format(_("{} [video]"), path_summary());
	} else if (audio) {
		return fmt::format(_("{} [audio]"), path_summary());
	}

	return path_summary ();
}


string
FFmpegContent::technical_summary () const
{
	string as = "";
	for (auto i: ffmpeg_audio_streams ()) {
		as += i->technical_summary () + " " ;
	}

	if (as.empty ()) {
		as = "none";
	}

	string ss = "none";
	if (_subtitle_stream) {
		ss = _subtitle_stream->technical_summary ();
	}

	auto filt = Filter::ffmpeg_string (_filters);

	auto s = Content::technical_summary ();

	if (video) {
		s += " - " + video->technical_summary ();
	}

	if (audio) {
		s += " - " + audio->technical_summary ();
	}

	return s + fmt::format(
		"ffmpeg: audio {} subtitle {} filters {}", as, ss, filt
		);
}


void
FFmpegContent::set_subtitle_stream (shared_ptr<FFmpegSubtitleStream> s)
{
	ContentChangeSignaller cc (this, FFmpegContentProperty::SUBTITLE_STREAM);

	{
		boost::mutex::scoped_lock lm (_mutex);
		_subtitle_stream = s;
	}
}


bool
operator== (FFmpegStream const & a, FFmpegStream const & b)
{
	return a._id == b._id && b._index == b._index;
}


bool
operator!= (FFmpegStream const & a, FFmpegStream const & b)
{
	return a._id != b._id || a._index != b._index;
}


DCPTime
FFmpegContent::full_length (shared_ptr<const Film> film) const
{
	FrameRateChange const frc (film, shared_from_this());
	if (video) {
		return DCPTime::from_frames (llrint (video->length_after_3d_combine() * frc.factor()), film->video_frame_rate());
	}

	if (audio) {
		DCPTime longest;
		for (auto i: audio->streams()) {
			longest = max (longest, DCPTime::from_frames(llrint(i->length() / frc.speed_up), i->frame_rate()));
		}
		return longest;
	}

	/* XXX: subtitle content? */

	return {};
}


DCPTime
FFmpegContent::approximate_length () const
{
	if (video) {
		return DCPTime::from_frames (video->length_after_3d_combine(), 24);
	}

	DCPOMATIC_ASSERT (audio);

	Frame longest = 0;
	for (auto i: audio->streams()) {
		longest = max (longest, Frame(llrint(i->length())));
	}

	return DCPTime::from_frames (longest, 24);
}


void
FFmpegContent::set_filters(vector<Filter> const& filters)
{
	ContentChangeSignaller cc (this, FFmpegContentProperty::FILTERS);

	{
		boost::mutex::scoped_lock lm (_mutex);
		_filters = filters;
	}
}


string
FFmpegContent::identifier () const
{
	string s = Content::identifier();

	if (video) {
		s += "_" + video->identifier();
	}

	if (only_text() && only_text()->use() && only_text()->burn()) {
		s += "_" + only_text()->identifier();
	}

	boost::mutex::scoped_lock lm (_mutex);

	if (_subtitle_stream) {
		s += "_" + _subtitle_stream->identifier ();
	}

	for (auto i: _filters) {
		s += "_" + i.id();
	}

	return s;
}


void
FFmpegContent::set_default_colour_conversion ()
{
	DCPOMATIC_ASSERT (video);

	auto const s = video->size ();

	boost::mutex::scoped_lock lm (_mutex);

	switch (_colorspace.get_value_or(AVCOL_SPC_UNSPECIFIED)) {
	case AVCOL_SPC_RGB:
		video->set_colour_conversion (PresetColourConversion::from_id ("srgb").conversion);
		break;
	case AVCOL_SPC_BT709:
		video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
		break;
	case AVCOL_SPC_BT470BG:
	case AVCOL_SPC_SMPTE170M:
	case AVCOL_SPC_SMPTE240M:
		video->set_colour_conversion (PresetColourConversion::from_id ("rec601").conversion);
		break;
	case AVCOL_SPC_BT2020_CL:
	case AVCOL_SPC_BT2020_NCL:
		video->set_colour_conversion (PresetColourConversion::from_id ("rec2020").conversion);
		break;
	default:
		if (s && s->width < 1080) {
			video->set_colour_conversion (PresetColourConversion::from_id ("rec601").conversion);
		} else {
			video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
		}
		break;
	}
}


void
FFmpegContent::add_properties (shared_ptr<const Film> film, list<UserProperty>& p) const
{
	Content::add_properties (film, p);

	if (video) {
		video->add_properties (p);

		if (_bits_per_pixel) {
			auto pixel_quanta_product = video->pixel_quanta().x * video->pixel_quanta().y;
			auto bits_per_main_pixel = pixel_quanta_product * _bits_per_pixel.get() / (pixel_quanta_product + 2);

			int const lim_start = pow(2, bits_per_main_pixel - 4);
			int const lim_end = 235 * pow(2, bits_per_main_pixel - 8);
			int const total = pow(2, bits_per_main_pixel);

			switch (_color_range.get_value_or(AVCOL_RANGE_UNSPECIFIED)) {
			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 (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 (
						UserProperty::VIDEO, _("Colour range"), fmt::format(_("Limited / video ({}-{})"), lim_start, lim_end)
						)
					);
				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(UserProperty::VIDEO, _("Colour range"), fmt::format(_("Full (0-{})"), total - 1)));
				break;
			default:
				DCPOMATIC_ASSERT (false);
			}
		} else {
			switch (_color_range.get_value_or(AVCOL_RANGE_UNSPECIFIED)) {
			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 (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 (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 (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"),
			_("SMPTE ST 428-1 (CIE 1931 XYZ)"),
			_("SMPTE ST 431-2 (2011)"),
			_("SMPTE ST 432-1 D65 (2010)"), // 12
			"", // 13
			"", // 14
			"", // 15
			"", // 16
			"", // 17
			"", // 18
			"", // 19
			"", // 20
			"", // 21
			_("JEDEC P22")
		};

		DCPOMATIC_ASSERT (AVCOL_PRI_NB <= 23);
		p.push_back (UserProperty (UserProperty::VIDEO, _("Colour primaries"), primaries[_color_primaries.get_value_or(AVCOL_PRI_UNSPECIFIED)]));

		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"),
			_("SMPTE ST 2084 for 10, 12, 14 and 16 bit systems"),
			_("SMPTE ST 428-1"),
			_("ARIB STD-B67 ('Hybrid log-gamma')")
		};

		DCPOMATIC_ASSERT (AVCOL_TRC_NB <= 19);
		p.push_back (UserProperty (UserProperty::VIDEO, _("Colour transfer characteristic"), transfers[_color_trc.get_value_or(AVCOL_TRC_UNSPECIFIED)]));

		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"),
			_("SMPTE 2085, Y'D'zD'x"),
			_("Chroma-derived non-constant luminance"),
			_("Chroma-derived constant luminance"),
#ifdef DCPOMATIC_FFMPEG_8
                        _("BT2100"),
                        _("SMPTE ST 2128, IPT-C2"),
                        _("YCgCo-R, even addition"),
                        _("YCgCo-R, odd addition")
#else
			_("BT2100")
#endif
		};

#ifdef DCPOMATIC_FFMPEG_8
		DCPOMATIC_ASSERT(AVCOL_SPC_NB == 18);
#else
		DCPOMATIC_ASSERT (AVCOL_SPC_NB == 15);
#endif

		p.push_back (UserProperty (UserProperty::VIDEO, _("Colourspace"), spaces[_colorspace.get_value_or(AVCOL_SPC_UNSPECIFIED)]));

		if (_bits_per_pixel) {
			p.push_back (UserProperty (UserProperty::VIDEO, _("Bits per pixel"), *_bits_per_pixel));
		}
	}

	if (audio) {
		audio->add_properties (film, p);
	}
}


/** 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 ()
{
	/* XXX: this is too late; really it should be before the change */
	ContentChangeSignaller cc (this, FFmpegContentProperty::SUBTITLE_STREAM);
}


vector<shared_ptr<FFmpegAudioStream>>
FFmpegContent::ffmpeg_audio_streams () const
{
	vector<shared_ptr<FFmpegAudioStream>> fa;

	if (audio) {
		for (auto i: audio->streams()) {
			fa.push_back (dynamic_pointer_cast<FFmpegAudioStream>(i));
		}
	}

	return fa;
}


void
FFmpegContent::take_settings_from (shared_ptr<const Content> c)
{
	auto fc = dynamic_pointer_cast<const FFmpegContent> (c);
	if (!fc) {
		return;
		}

	Content::take_settings_from (c);
	_filters = fc->_filters;
}