path: root/src/lib/playlist.cc

/*
    Copyright (C) 2013 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
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program 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 this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#include <libcxml/cxml.h>
#include <boost/shared_ptr.hpp>
#include <boost/lexical_cast.hpp>
#include "playlist.h"
#include "sndfile_content.h"
#include "sndfile_decoder.h"
#include "video_content.h"
#include "ffmpeg_decoder.h"
#include "ffmpeg_content.h"
#include "imagemagick_decoder.h"
#include "imagemagick_content.h"
#include "job.h"

#include "i18n.h"

using std::list;
using std::cout;
using std::vector;
using std::min;
using std::max;
using std::string;
using std::stringstream;
using boost::shared_ptr;
using boost::weak_ptr;
using boost::dynamic_pointer_cast;
using boost::lexical_cast;

Playlist::Playlist ()
	: _audio_from (AUDIO_FFMPEG)
	, _loop (1)
{

}

Playlist::Playlist (shared_ptr<const Playlist> other)
	: _audio_from (other->_audio_from)
	, _loop (other->_loop)
{
	for (ContentList::const_iterator i = other->_content.begin(); i != other->_content.end(); ++i) {
		_content.push_back ((*i)->clone ());
	}

	setup ();
}

void
Playlist::setup ()
{
	_audio_from = AUDIO_FFMPEG;

	_video.clear ();
	_audio.clear ();

	for (list<boost::signals2::connection>::iterator i = _content_connections.begin(); i != _content_connections.end(); ++i) {
		i->disconnect ();
	}
	
	_content_connections.clear ();

	for (ContentList::const_iterator i = _content.begin(); i != _content.end(); ++i) {

		/* Video is video */
		shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (*i);
		if (vc) {
			_video.push_back (vc);
		}

		/* FFmpegContent is audio if we are doing AUDIO_FFMPEG */
		shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (*i);
		if (fc && _audio_from == AUDIO_FFMPEG) {
			_audio.push_back (fc);
		}

		/* SndfileContent trumps FFmpegContent for audio */
		shared_ptr<SndfileContent> sc = dynamic_pointer_cast<SndfileContent> (*i);
		if (sc) {
			if (_audio_from == AUDIO_FFMPEG) {
				/* This is our fist SndfileContent; clear any FFmpegContent and
				   say that we are using Sndfile.
				*/
				_audio.clear ();
				_audio_from = AUDIO_SNDFILE;
			}
			
			_audio.push_back (sc);
		}

		_content_connections.push_back ((*i)->Changed.connect (bind (&Playlist::content_changed, this, _1, _2)));
	}
}

/** @return Length of our audio */
ContentAudioFrame
Playlist::audio_length () const
{
	ContentAudioFrame len = 0;

	switch (_audio_from) {
	case AUDIO_FFMPEG:
		/* FFmpeg content is sequential */
		for (list<shared_ptr<const AudioContent> >::const_iterator i = _audio.begin(); i != _audio.end(); ++i) {
			len += (*i)->audio_length ();
		}
		break;
	case AUDIO_SNDFILE:
		/* Sndfile content is simultaneous */
		for (list<shared_ptr<const AudioContent> >::const_iterator i = _audio.begin(); i != _audio.end(); ++i) {
			len = max (len, (*i)->audio_length ());
		}
		break;
	}

	return len * _loop;
}

/** @return number of audio channels */
int
Playlist::audio_channels () const
{
	int channels = 0;
	
	switch (_audio_from) {
	case AUDIO_FFMPEG:
		/* FFmpeg audio is sequential, so use the maximum channel count */
		for (list<shared_ptr<const AudioContent> >::const_iterator i = _audio.begin(); i != _audio.end(); ++i) {
			channels = max (channels, (*i)->audio_channels ());
		}
		break;
	case AUDIO_SNDFILE:
		/* Sndfile audio is simultaneous, so it's the sum of the channel counts */
		for (list<shared_ptr<const AudioContent> >::const_iterator i = _audio.begin(); i != _audio.end(); ++i) {
			channels += (*i)->audio_channels ();
		}
		break;
	}

	return channels;
}

int
Playlist::audio_frame_rate () const
{
	if (_audio.empty ()) {
		return 0;
	}

	/* XXX: assuming that all content has the same rate */
	return _audio.front()->audio_frame_rate ();
}

float
Playlist::video_frame_rate () const
{
	if (_video.empty ()) {
		return 0;
	}
	
	/* XXX: assuming all the same */
	return _video.front()->video_frame_rate ();
}

libdcp::Size
Playlist::video_size () const
{
	if (_video.empty ()) {
		return libdcp::Size ();
	}

	/* XXX: assuming all the same */
	return _video.front()->video_size ();
}

ContentVideoFrame
Playlist::video_length () const
{
	ContentVideoFrame len = 0;
	for (list<shared_ptr<const VideoContent> >::const_iterator i = _video.begin(); i != _video.end(); ++i) {
		len += (*i)->video_length ();
	}
	
	return len * _loop;
}

bool
Playlist::has_audio () const
{
	return !_audio.empty ();
}

void
Playlist::content_changed (weak_ptr<Content> c, int p)
{
	ContentChanged (c, p);
}

AudioMapping
Playlist::default_audio_mapping () const
{
	AudioMapping m;
	if (_audio.empty ()) {
		return m;
	}

	switch (_audio_from) {
	case AUDIO_FFMPEG:
	{
		/* XXX: assumes all the same */
		if (_audio.front()->audio_channels() == 1) {
			/* Map mono sources to centre */
			m.add (AudioMapping::Channel (_audio.front(), 0), libdcp::CENTRE);
		} else {
			int const N = min (_audio.front()->audio_channels (), MAX_AUDIO_CHANNELS);
			/* Otherwise just start with a 1:1 mapping */
			for (int i = 0; i < N; ++i) {
				m.add (AudioMapping::Channel (_audio.front(), i), (libdcp::Channel) i);
			}
		}
		break;
	}

	case AUDIO_SNDFILE:
	{
		int n = 0;
		for (list<shared_ptr<const AudioContent> >::const_iterator i = _audio.begin(); i != _audio.end(); ++i) {
			for (int j = 0; j < (*i)->audio_channels(); ++j) {
				m.add (AudioMapping::Channel (*i, j), (libdcp::Channel) n);
				++n;
				if (n >= MAX_AUDIO_CHANNELS) {
					break;
				}
			}
			if (n >= MAX_AUDIO_CHANNELS) {
				break;
			}
		}
		break;
	}
	}

	return m;
}

string
Playlist::audio_digest () const
{
	string t;
	
	for (list<shared_ptr<const AudioContent> >::const_iterator i = _audio.begin(); i != _audio.end(); ++i) {
		t += (*i)->digest ();

		shared_ptr<const FFmpegContent> fc = dynamic_pointer_cast<const FFmpegContent> (*i);
		if (fc) {
			t += lexical_cast<string> (fc->audio_stream()->id);
		}
	}

	t += lexical_cast<string> (_loop);

	return md5_digest (t.c_str(), t.length());
}

string
Playlist::video_digest () const
{
	string t;
	
	for (list<shared_ptr<const VideoContent> >::const_iterator i = _video.begin(); i != _video.end(); ++i) {
		t += (*i)->digest ();
		shared_ptr<const FFmpegContent> fc = dynamic_pointer_cast<const FFmpegContent> (*i);
		if (fc && fc->subtitle_stream()) {
			t += fc->subtitle_stream()->id;
		}
	}

	t += lexical_cast<string> (_loop);

	return md5_digest (t.c_str(), t.length());
}

ContentVideoFrame
Playlist::content_length () const
{
	float const vfr = video_frame_rate() > 0 ? video_frame_rate() : 24;
	int const afr = audio_frame_rate() > 0 ? audio_frame_rate() : 48000;

        return max (
		video_length(),
		ContentVideoFrame (audio_length() * vfr / afr)
		);
}

void
Playlist::set_from_xml (shared_ptr<const cxml::Node> node)
{
	list<shared_ptr<cxml::Node> > c = node->node_children ("Content");
	for (list<shared_ptr<cxml::Node> >::iterator i = c.begin(); i != c.end(); ++i) {

		string const type = (*i)->string_child ("Type");
		boost::shared_ptr<Content> c;
		
		if (type == "FFmpeg") {
			c.reset (new FFmpegContent (*i));
		} else if (type == "ImageMagick") {
			c.reset (new ImageMagickContent (*i));
		} else if (type == "Sndfile") {
			c.reset (new SndfileContent (*i));
		}

		_content.push_back (c);
	}

	_loop = node->number_child<int> ("Loop");

	setup ();
}

void
Playlist::as_xml (xmlpp::Node* node)
{
	for (ContentList::iterator i = _content.begin(); i != _content.end(); ++i) {
		(*i)->as_xml (node->add_child ("Content"));
	}

	node->add_child("Loop")->add_child_text(lexical_cast<string> (_loop));
}

void
Playlist::add (shared_ptr<Content> c)
{
	_content.push_back (c);
	setup ();
	Changed ();
}

void
Playlist::remove (shared_ptr<Content> c)
{
	ContentList::iterator i = find (_content.begin(), _content.end(), c);
	if (i != _content.end ()) {
		_content.erase (i);
	}

	setup ();
	Changed ();
}

void
Playlist::move_earlier (shared_ptr<Content> c)
{
	ContentList::iterator i = find (_content.begin(), _content.end(), c);
	if (i == _content.begin () || i == _content.end()) {
		return;
	}

	ContentList::iterator j = i;
	--j;

	swap (*i, *j);

	setup ();
	Changed ();
}

void
Playlist::move_later (shared_ptr<Content> c)
{
	ContentList::iterator i = find (_content.begin(), _content.end(), c);
	if (i == _content.end()) {
		return;
	}

	ContentList::iterator j = i;
	++j;
	if (j == _content.end ()) {
		return;
	}

	swap (*i, *j);

	setup ();
	Changed ();
}

void
Playlist::set_loop (int l)
{
	_loop = l;
	Changed ();
}
		
shared_ptr<FFmpegContent>
Playlist::ffmpeg () const
{
	for (ContentList::const_iterator i = _content.begin(); i != _content.end(); ++i) {
		shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (*i);
		if (fc) {
			return fc;
		}
	}

	return shared_ptr<FFmpegContent> ();
}

bool
Playlist::has_subtitles () const
{
	shared_ptr<FFmpegContent> fc = ffmpeg ();
	if (!fc) {
		return false;
	}
	
	return !fc->subtitle_streams().empty();
}

string
Playlist::description () const
{
	stringstream s;

	if (_video.empty ()) {
		s << _("There is no video.") << "\n";
	} else {
		s << _("Video will come from ");
		list<shared_ptr<const VideoContent> >::const_iterator i = _video.begin();
		while (i != _video.end ()) {
			s << (*i)->file().filename().string();
			++i;
			if (i != _video.end ()) {
				s << ", ";
			}
		}
		if (_video.size() > 1) {
			s << " " << _("in sequence.");
		}
		s << "\n";
	}

	if (_audio.empty ()) {
		s << _("There is no audio.") << "\n";
	} else {
		if (_audio_from == AUDIO_FFMPEG) {
			s << _("Audio will come from the video files.") << "\n";
		} else {
			s << _("Audio will come from ");
			list<shared_ptr<const AudioContent> >::const_iterator i = _audio.begin();
			while (i != _audio.end ()) {
				s << (*i)->file().filename().string();
				++i;
				if (i != _audio.end ()) {
					s << ", ";
				}
			}
			if (_audio.size() > 1) {
				s << _(" run simultaneously.");
			}
			s << "\n";
		}
	}
			
	return s.str ();
}