mpd/src/pcm/ChannelsConverter.hxx
Max Kellermann 71f0ed8b74 *: add "noexcept" to many, many function prototypes
This eliminates some overhead, because the compiler doesn't need to
consider these functions throwing.
2017-05-08 14:44:49 +02:00

82 lines
2.0 KiB
C++

/*
* Copyright 2003-2017 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.
*/
#ifndef MPD_PCM_CHANNELS_CONVERTER_HXX
#define MPD_PCM_CHANNELS_CONVERTER_HXX
#include "check.h"
#include "SampleFormat.hxx"
#include "PcmBuffer.hxx"
#ifndef NDEBUG
#include <assert.h>
#endif
template<typename T> struct ConstBuffer;
/**
* A class that converts samples from one format to another.
*/
class PcmChannelsConverter {
SampleFormat format;
unsigned src_channels, dest_channels;
PcmBuffer buffer;
public:
#ifndef NDEBUG
PcmChannelsConverter()
:format(SampleFormat::UNDEFINED) {}
~PcmChannelsConverter() {
assert(format == SampleFormat::UNDEFINED);
}
#endif
/**
* Opens the object, prepare for Convert().
*
* Throws std::runtime_error on error.
*
* @param format the sample format
* @param src_channels the number of source channels
* @param dest_channels the number of destination channels
*/
void Open(SampleFormat format,
unsigned src_channels, unsigned dest_channels);
/**
* Closes the object. After that, you may call Open() again.
*/
void Close();
/**
* Convert a block of PCM data.
*
* Throws std::runtime_error on error.
*
* @param src the input buffer
* @return the destination buffer
*/
gcc_pure
ConstBuffer<void> Convert(ConstBuffer<void> src) noexcept;
};
#endif