lmms/include/AutomatableModel.h

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

#ifndef _AUTOMATABLE_MODEL_H
#define _AUTOMATABLE_MODEL_H

#include <math.h>

#include "JournallingObject.h"
#include "Model.h"


// simple way to map a property of a view to a model
#define mapPropertyFromModelPtr(type,getfunc,setfunc,modelname)	\
		public:													\
			inline type getfunc() const							\
			{													\
				return (type) modelname->value();				\
			}													\
		public slots:											\
			inline void setfunc( const type val )				\
			{													\
				modelname->setValue( val );						\
			}

#define mapPropertyFromModel(type,getfunc,setfunc,modelname)	\
		public:													\
			inline type getfunc() const							\
			{													\
				return (type) modelname.value();				\
			}													\
		public slots:											\
			inline void setfunc( const type val )				\
			{													\
				modelname.setValue( (float) val );				\
			}



class ControllerConnection;


class EXPORT AutomatableModel : public Model, public JournallingObject
{
	Q_OBJECT
public:
	typedef QVector<AutomatableModel *> AutoModelVector;

	enum DataType
	{
		Float,
		Integer,
		Bool
	} ;

	AutomatableModel( DataType type,
						const float val = 0,
						const float min = 0,
						const float max = 0,
						const float step = 0,
						Model* parent = NULL,
						const QString& display_name = QString(),
						bool default_constructed = false );

	virtual ~AutomatableModel();


	static float copiedValue()
	{
		return s_copiedValue;
	}

	bool isAutomated() const;

	inline ControllerConnection* controllerConnection() const
	{
		return m_controllerConnection;
	}


	void setControllerConnection( ControllerConnection* c );


	template<class T>
	static inline T castValue( const float v )
	{
		return (T)( v );
	}

	template<bool>
	static inline bool castValue( const float v )
	{
		return ( qRound( v ) != 0 );
	}


	template<class T>
	inline T value( int frameOffset = 0 ) const
	{
		if( unlikely( m_hasLinkedModels || m_controllerConnection != NULL ) )
		{
			return castValue<T>( controllerValue( frameOffset ) );
		}

		return castValue<T>( m_value );
	}

	float controllerValue( int frameOffset ) const;


	template<class T>
	inline T initValue() const
	{
		return castValue<T>( m_initValue );
	}

	bool isAtInitValue() const
	{
		return m_value == m_initValue;
	}

	template<class T>
	inline T minValue() const
	{
		return castValue<T>( m_minValue );
	}

	template<class T>
	inline T maxValue() const
	{
		return castValue<T>( m_maxValue );
	}

	template<class T>
	inline T step() const
	{
		return castValue<T>( m_step );
	}


	void setInitValue( const float value );

	void setAutomatedValue( const float value );
	void setValue( const float value );

	inline void incValue( int steps )
	{
		setValue( m_value + steps * m_step );
	}

	inline float range() const
	{
		return m_range;
	}

	void setRange( const float min, const float max, const float step = 1 );

	void setStep( const float step );

	float centerValue() const
	{
		return m_centerValue;
	}

	void setCenterValue( const float centerVal )
	{
		m_centerValue = centerVal;
	}

	static void linkModels( AutomatableModel* m1, AutomatableModel* m2 );
	static void unlinkModels( AutomatableModel* m1, AutomatableModel* m2 );

	void unlinkAllModels();

	virtual void saveSettings( QDomDocument& doc, QDomElement& element,
								const QString& name = QString( "value" ) );

	virtual void loadSettings( const QDomElement& element, const QString& name = QString( "value" ) );

	virtual QString nodeName() const
	{
		return "automatablemodel";
	}

	void prepareJournalEntryFromOldVal();

	void addJournalEntryFromOldToCurVal();


	QString displayValue( const float val ) const
	{
		switch( m_dataType )
		{
			case Float: return QString::number( castValue<float>( val ) );
			case Integer: return QString::number( castValue<int>( val ) );
			case Bool: return QString::number( castValue<bool>( val ) );
		}
		return "0";
	}

	bool hasLinkedModels() const
	{
		return m_hasLinkedModels;
	}


public slots:
	virtual void reset();
	virtual void copyValue();
	virtual void pasteValue();
	void unlinkControllerConnection();


protected:
	virtual void redoStep( JournalEntry& je );
	virtual void undoStep( JournalEntry& je );

	float fittedValue( float value ) const;


private:
	void linkModel( AutomatableModel* model );
	void unlinkModel( AutomatableModel* model );


	DataType m_dataType;
	float m_value;
	float m_initValue;
	float m_minValue;
	float m_maxValue;
	float m_step;
	float m_range;
	float m_centerValue;

	// most objects will need this temporarily (until sampleExact is
	// standard)
	float m_oldValue;
	bool m_journalEntryReady;
	int m_setValueDepth;

	AutoModelVector m_linkedModels;
	bool m_hasLinkedModels;


	ControllerConnection* m_controllerConnection;


	static float s_copiedValue;


signals:
	void initValueChanged( float val );
	void destroyed( jo_id_t id );

} ;





#define defaultTypedMethods(type)								\
	inline type value( int frameOffset = 0 ) const				\
	{															\
		return AutomatableModel::value<type>( frameOffset );	\
	}															\
																\
	inline type initValue() const								\
	{															\
		return AutomatableModel::initValue<type>();				\
	}															\
																\
	inline type minValue() const								\
	{															\
		return AutomatableModel::minValue<type>();				\
	}															\
																\
	inline type maxValue() const								\
	{															\
		return AutomatableModel::maxValue<type>();				\
	}															\


// some typed AutomatableModel-definitions

class FloatModel : public AutomatableModel
{
public:
	FloatModel( float val = 0, float min = 0, float max = 0, float step = 0,
				Model * parent = NULL,
				const QString& displayName = QString(),
				bool defaultConstructed = false ) :
		AutomatableModel( Float, val, min, max, step, parent, displayName, defaultConstructed )
	{
	}

	defaultTypedMethods(float);

} ;


class IntModel : public AutomatableModel
{
public:
	IntModel( int val = 0, int min = 0, int max = 0,
				Model* parent = NULL,
				const QString& displayName = QString(),
				bool defaultConstructed = false ) :
		AutomatableModel( Integer, val, min, max, 1, parent, displayName, defaultConstructed )
	{
	}

	defaultTypedMethods(int);

} ;


class BoolModel : public AutomatableModel
{
public:
	BoolModel( const bool val = false,
				Model* parent = NULL,
				const QString& displayName = QString(),
				bool defaultConstructed = false ) :
		AutomatableModel( Bool, val, false, true, 1, parent, displayName, defaultConstructed )
	{
	}

	defaultTypedMethods(bool);

} ;


#endif