/*
    Copyright (C) 2012 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.

*/

#ifndef LIBDCP_SOUND_ASSET_H
#define LIBDCP_SOUND_ASSET_H

/** @file  src/sound_asset.h
 *  @brief An asset made up of WAV files
 */

#include "asset.h"
#include "types.h"

namespace libdcp
{

/** @brief An asset made up of WAV files */
class SoundAsset : public Asset
{
public:
	/** Construct a SoundAsset, generating the MXF from the WAV files.
	 *  This may take some time; progress is indicated by emission of the Progress signal.
	 *  @param files Pathnames of sound files, in the order Left, Right, Centre, Lfe (sub), Left surround, Right surround.
	 *  @param directory Directory in which to create MXF file.
	 *  @param mxf_name Name of MXF file to create.
	 *  @param progress Signal to inform of progress.
	 *  @param fps Frames per second.
	 *  @param length Length in frames.
	 */
	SoundAsset (
		std::vector<std::string> const & files,
		std::string directory,
		std::string mxf_name,
		sigc::signal1<void, float>* progress,
		int fps,
		int length
		);

	/** Construct a SoundAsset, generating the MXF from the WAV files.
	 *  This may take some time; progress is indicated by emission of the Progress signal.
	 *  @param get_path Functor which returns a WAV file path for a given channel.
	 *  @param directory Directory in which to create MXF file.
	 *  @param mxf_name Name of MXF file to create.
	 *  @param progress Signal to inform of progress.
	 *  @param fps Frames per second.
	 *  @param length Length in frames.
	 *  @param channels Number of audio channels.
	 */
	SoundAsset (
		sigc::slot<std::string, Channel> get_path,
		std::string directory,
		std::string mxf_name,
		sigc::signal1<void, float>* progress,
		int fps,
		int length,
		int channels
		);

	SoundAsset (
		std::string directory,
		std::string mxf_name,
		int fps,
		int length
		);
	
	/** Write details of this asset to a CPL stream.
	 *  @param s Stream.
	 */
	void write_to_cpl (std::ostream& s) const;

	std::list<std::string> equals (boost::shared_ptr<const Asset> other, EqualityFlags flags) const;
	
private:
	void construct (sigc::slot<std::string, Channel> get_path);
	std::string path_from_channel (Channel channel, std::vector<std::string> const & files);

	/** Number of channels in the asset */
	int _channels;
};

}

#endif