mpd/src/output/plugins/RecorderOutputPlugin.cxx

/*
 * Copyright (C) 2003-2015 The Music Player Daemon Project
 * http://www.musicpd.org
 *
 * 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.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#include "config.h"
#include "RecorderOutputPlugin.hxx"
#include "../OutputAPI.hxx"
#include "../Wrapper.hxx"
#include "tag/Format.hxx"
#include "encoder/ToOutputStream.hxx"
#include "encoder/EncoderInterface.hxx"
#include "encoder/EncoderPlugin.hxx"
#include "encoder/EncoderList.hxx"
#include "config/ConfigError.hxx"
#include "config/ConfigPath.hxx"
#include "Log.hxx"
#include "fs/AllocatedPath.hxx"
#include "fs/io/FileOutputStream.hxx"
#include "util/Error.hxx"
#include "util/Domain.hxx"

#include <assert.h>
#include <stdlib.h>

static constexpr Domain recorder_domain("recorder");

class RecorderOutput {
	friend struct AudioOutputWrapper<RecorderOutput>;

	AudioOutput base;

	/**
	 * The configured encoder plugin.
	 */
	Encoder *encoder;

	/**
	 * The destination file name.
	 */
	AllocatedPath path;

	/**
	 * A string that will be used with FormatTag() to build the
	 * destination path.
	 */
	std::string format_path;

	/**
	 * The #AudioFormat that is currently active.  This is used
	 * for switching to another file.
	 */
	AudioFormat effective_audio_format;

	/**
	 * The destination file.
	 */
	FileOutputStream *file;

	RecorderOutput()
		:base(recorder_output_plugin),
		 encoder(nullptr),
		 path(AllocatedPath::Null()) {}

	~RecorderOutput() {
		if (encoder != nullptr)
			encoder->Dispose();
	}

	bool Initialize(const ConfigBlock &block, Error &error_r) {
		return base.Configure(block, error_r);
	}

	static RecorderOutput *Create(const ConfigBlock &block, Error &error);

	bool Configure(const ConfigBlock &block, Error &error);

	bool Open(AudioFormat &audio_format, Error &error);
	void Close();

	/**
	 * Writes pending data from the encoder to the output file.
	 */
	void EncoderToFile();

	void SendTag(const Tag &tag);

	size_t Play(const void *chunk, size_t size, Error &error);

private:
	gcc_pure
	bool HasDynamicPath() const {
		return !format_path.empty();
	}

	/**
	 * Finish the encoder and commit the file.
	 */
	bool Commit(Error &error);

	void FinishFormat();
	bool ReopenFormat(AllocatedPath &&new_path, Error &error);
};

inline bool
RecorderOutput::Configure(const ConfigBlock &block, Error &error)
{
	/* read configuration */

	const char *encoder_name =
		block.GetBlockValue("encoder", "vorbis");
	const auto encoder_plugin = encoder_plugin_get(encoder_name);
	if (encoder_plugin == nullptr) {
		error.Format(config_domain,
			     "No such encoder: %s", encoder_name);
		return false;
	}

	path = block.GetBlockPath("path", error);
	if (error.IsDefined())
		return false;

	const char *fmt = block.GetBlockValue("format_path", nullptr);
	if (fmt != nullptr)
		format_path = fmt;

	if (path.IsNull() && fmt == nullptr) {
		error.Set(config_domain, "'path' not configured");
		return false;
	}

	if (!path.IsNull() && fmt != nullptr) {
		error.Set(config_domain, "Cannot have both 'path' and 'format_path'");
		return false;
	}

	/* initialize encoder */

	encoder = encoder_init(*encoder_plugin, block, error);
	if (encoder == nullptr)
		return false;

	return true;
}

RecorderOutput *
RecorderOutput::Create(const ConfigBlock &block, Error &error)
{
	RecorderOutput *recorder = new RecorderOutput();

	if (!recorder->Initialize(block, error)) {
		delete recorder;
		return nullptr;
	}

	if (!recorder->Configure(block, error)) {
		delete recorder;
		return nullptr;
	}

	return recorder;
}

inline void
RecorderOutput::EncoderToFile()
{
	assert(file != nullptr);

	EncoderToOutputStream(*file, *encoder);
}

inline bool
RecorderOutput::Open(AudioFormat &audio_format, Error &error)
{
	/* create the output file */

	if (!HasDynamicPath()) {
		assert(!path.IsNull());

		try {
			file = new FileOutputStream(path);
		} catch (const std::exception &e) {
			error.Set(recorder_domain, e.what());
			return false;
		}
	} else {
		/* don't open the file just yet; wait until we have
		   a tag that we can use to build the path */
		assert(path.IsNull());

		file = nullptr;
	}

	/* open the encoder */

	if (!encoder->Open(audio_format, error)) {
		delete file;
		return false;
	}

	if (!HasDynamicPath()) {
		try {
			EncoderToFile();
		} catch (const std::exception &e) {
			encoder->Close();
			error.Set(recorder_domain, e.what());
			return false;
		}
	} else {
		/* remember the AudioFormat for ReopenFormat() */
		effective_audio_format = audio_format;

		/* close the encoder for now; it will be opened as
		   soon as we have received a tag */
		encoder->Close();
	}

	return true;
}

inline bool
RecorderOutput::Commit(Error &error)
{
	assert(!path.IsNull());

	/* flush the encoder and write the rest to the file */

	bool success = encoder_end(encoder, error);
	if (success) {
		try {
			EncoderToFile();
		} catch (...) {
			encoder->Close();
			throw;
		}
	}

	/* now really close everything */

	encoder->Close();

	if (success) {
		try {
			file->Commit();
		} catch (...) {
			delete file;
			throw;
		}
	}

	delete file;

	return success;
}

inline void
RecorderOutput::Close()
{
	if (file == nullptr) {
		/* not currently encoding to a file; nothing needs to
		   be done now */
		assert(HasDynamicPath());
		assert(path.IsNull());
		return;
	}

	try {
		Error error;
		if (!Commit(error))
			LogError(error);
	} catch (const std::exception &e) {
		LogError(e);
	}

	if (HasDynamicPath()) {
		assert(!path.IsNull());
		path.SetNull();
	}
}

void
RecorderOutput::FinishFormat()
{
	assert(HasDynamicPath());

	if (file == nullptr)
		return;

	try {
		Error error;
		if (!Commit(error))
			LogError(error);
	} catch (const std::exception &e) {
		LogError(e);
	}

	file = nullptr;
	path.SetNull();
}

inline bool
RecorderOutput::ReopenFormat(AllocatedPath &&new_path, Error &error)
{
	assert(HasDynamicPath());
	assert(path.IsNull());
	assert(file == nullptr);

	FileOutputStream *new_file;
	try {
		new_file = new FileOutputStream(path);
	} catch (const std::exception &e) {
		error.Set(recorder_domain, e.what());
		return false;
	}

	AudioFormat new_audio_format = effective_audio_format;
	if (!encoder->Open(new_audio_format, error)) {
		delete new_file;
		return false;
	}

	/* reopening the encoder must always result in the same
	   AudioFormat as before */
	assert(new_audio_format == effective_audio_format);

	try {
		EncoderToOutputStream(*new_file, *encoder);
	} catch (const std::exception &e) {
		encoder->Close();
		delete new_file;
		error.Set(recorder_domain, e.what());
		return false;
	}

	path = std::move(new_path);
	file = new_file;

	FormatDebug(recorder_domain, "Recording to \"%s\"",
		    path.ToUTF8().c_str());

	return true;
}

inline void
RecorderOutput::SendTag(const Tag &tag)
{
	if (HasDynamicPath()) {
		char *p = FormatTag(tag, format_path.c_str());
		if (p == nullptr || *p == 0) {
			/* no path could be composed with this tag:
			   don't write a file */
			free(p);
			FinishFormat();
			return;
		}

		Error error;
		AllocatedPath new_path = ParsePath(p, error);
		free(p);
		if (new_path.IsNull()) {
			LogError(error);
			FinishFormat();
			return;
		}

		if (new_path != path) {
			FinishFormat();

			if (!ReopenFormat(std::move(new_path), error)) {
				LogError(error);
				return;
			}
		}
	}

	Error error;
	if (!encoder_pre_tag(encoder, error)) {
		LogError(error);
		return;
	}

	try {
		EncoderToFile();
	} catch (const std::exception &e) {
		LogError(e);
		return;
	}

	if (!encoder_tag(encoder, tag, error))
		LogError(error);
}

inline size_t
RecorderOutput::Play(const void *chunk, size_t size, Error &error)
{
	if (file == nullptr) {
		/* not currently encoding to a file; discard incoming
		   data */
		assert(HasDynamicPath());
		assert(path.IsNull());
		return size;
	}

	if (!encoder_write(encoder, chunk, size, error))
		return 0;

	try {
		EncoderToFile();
	} catch (const std::exception &e) {
		error.Set(recorder_domain, e.what());
		return 0;
	}

	return size;
}

typedef AudioOutputWrapper<RecorderOutput> Wrapper;

const struct AudioOutputPlugin recorder_output_plugin = {
	"recorder",
	nullptr,
	&Wrapper::Init,
	&Wrapper::Finish,
	nullptr,
	nullptr,
	&Wrapper::Open,
	&Wrapper::Close,
	nullptr,
	&Wrapper::SendTag,
	&Wrapper::Play,
	nullptr,
	nullptr,
	nullptr,
	nullptr,
};