InstrumentSoundShaping.h

/*
 * InstrumentSoundShaping.h - declaration of class InstrumentSoundShaping
 *
 * Copyright (c) 2004-2009 Tobias Doerffel <tobydox/at/users.sourceforge.net>
 *
 * This file is part of LMMS - https://lmms.io
 *
 * 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 (see COPYING); if not, write to the
 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301 USA.
 *
 */

#ifndef LMMS_INSTRUMENT_SOUND_SHAPING_H
#define LMMS_INSTRUMENT_SOUND_SHAPING_H

#include "ComboBoxModel.h"
#include "EnvelopeAndLfoParameters.h"

namespace lmms
{


class InstrumentTrack;
class NotePlayHandle;
class SampleFrame;

namespace gui
{
class InstrumentSoundShapingView;
}


class InstrumentSoundShaping : public Model, public JournallingObject
{
	Q_OBJECT
public:
	InstrumentSoundShaping( InstrumentTrack * _instrument_track );
	~InstrumentSoundShaping() override = default;

	void processAudioBuffer( SampleFrame* _ab, const f_cnt_t _frames,
							NotePlayHandle * _n );

	const EnvelopeAndLfoParameters& getVolumeParameters() const { return m_volumeParameters; }
	EnvelopeAndLfoParameters& getVolumeParameters() { return m_volumeParameters; }

	const EnvelopeAndLfoParameters& getCutoffParameters() const { return m_cutoffParameters; }
	EnvelopeAndLfoParameters& getCutoffParameters() { return m_cutoffParameters; }

	const EnvelopeAndLfoParameters& getResonanceParameters() const { return m_resonanceParameters; }
	EnvelopeAndLfoParameters& getResonanceParameters() { return m_resonanceParameters; }

	BoolModel& getFilterEnabledModel() { return m_filterEnabledModel; }
	ComboBoxModel& getFilterModel() { return m_filterModel; }
	FloatModel& getFilterCutModel() { return m_filterCutModel; }
	FloatModel& getFilterResModel() { return m_filterResModel; }

	f_cnt_t envFrames( const bool _only_vol = false ) const;
	f_cnt_t releaseFrames() const;

	// TODO: Remove? (dead code)
	float volumeLevel( NotePlayHandle * _n, const f_cnt_t _frame );


	void saveSettings( QDomDocument & _doc, QDomElement & _parent ) override;
	void loadSettings( const QDomElement & _this ) override;
	inline QString nodeName() const override
	{
		return "eldata";
	}

private:
	QString getVolumeNodeName() const;
	QString getCutoffNodeName() const;
	QString getResonanceNodeName() const;

private:
	InstrumentTrack * m_instrumentTrack;

	EnvelopeAndLfoParameters m_volumeParameters;
	EnvelopeAndLfoParameters m_cutoffParameters;
	EnvelopeAndLfoParameters m_resonanceParameters;

	BoolModel m_filterEnabledModel;
	ComboBoxModel m_filterModel;
	FloatModel m_filterCutModel;
	FloatModel m_filterResModel;
};


} // namespace lmms

#endif // LMMS_INSTRUMENT_SOUND_SHAPING_H