engines/sfz/EGADSR.h

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *
 *   Copyright (C) 2005 - 2012 Christian Schoenebeck                       *
 *                                                                         *
 *   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 St, Fifth Floor, Boston,                *
 *   MA  02110-1301  USA                                                   *
 ***************************************************************************/

#ifndef LS_SFZ_EGADSR_H
#define LS_SFZ_EGADSR_H

#include "../common/EG.h"

namespace LinuxSampler { namespace sfz {

/**
 * ADSR Envelope Generator
 *
 * SFZ v1 envelope generator with 'Attack', 'Hold', 'Decay', 'Sustain'
 * and 'Release' stages for modulating arbitrary synthesis parameters.
 */
class EGADSR : public ::LinuxSampler::EG {
    public:

        /**
         * Will be called by the voice when the key / voice was triggered.
         *
         * @param PreAttack       - Preattack value for the envelope
         *                          (0 - 1000 permille)
         * @param AttackTime      - Attack time for the envelope
         * @param HoldTime        - Hold time for the envelope
         * @param DecayTime       - Decay1 time of the sample amplitude EG
         * @param SustainLevel    - Sustain level of the sample amplitude EG
         *                          (0 - 1000 permille)
         * @param ReleaseTIme     - Release time for the envelope
         * @param SampleRate      - sample rate of used audio output driver
         * @param LinearRelease   - true if decay and release is linear
         */
    void trigger(uint PreAttack, float AttackTime, float HoldTime, float DecayTime, uint SustainLevel, float ReleaseTime, uint SampleRate, bool LinearRelease); //FIXME: we should better use 'float' for SampleRate

        /**
         * Should be called to inform the EG about an external event and
         * also whenever an envelope stage is completed. This will handle
         * the envelope's transition to the respective next stage.
         *
         * @param Event        - what happened
         * @param SampleRate   - sample rate of used audio output driver
         */
        void update(event_t Event, uint SampleRate);

    private:

        enum stage_t {
            stage_attack,
            stage_attack_hold,
            stage_decay,
            stage_sustain,
            stage_release,
            stage_fadeout,
            stage_end
        };

        stage_t   Stage;
        int       HoldSteps;
        float     DecayTime;
        float     SustainLevel;
        float     ReleaseTime;
        bool      LinearRelease;

        void enterAttackStage(const uint PreAttack, const float AttackTime, const uint SampleRate);
        void enterAttackHoldStage();
        void enterDecayStage(const uint SampleRate);
        void enterSustainStage();
        void enterReleaseStage();
};

}} // namespace LinuxSampler::sfz

#endif // LS_SFZ_EGADSR_H
1	persson	2055	/***************************************************************************
2			* *
3			* LinuxSampler - modular, streaming capable sampler *
4			* *
5			* Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck *
6	persson	2311	* Copyright (C) 2005 - 2012 Christian Schoenebeck *
7	persson	2055	* *
8			* This program is free software; you can redistribute it and/or modify *
9			* it under the terms of the GNU General Public License as published by *
10			* the Free Software Foundation; either version 2 of the License, or *
11			* (at your option) any later version. *
12			* *
13			* This program is distributed in the hope that it will be useful, *
14			* but WITHOUT ANY WARRANTY; without even the implied warranty of *
15			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16			* GNU General Public License for more details. *
17			* *
18			* You should have received a copy of the GNU General Public License *
19			* along with this program; if not, write to the Free Software *
20			* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
21			* MA 02110-1301 USA *
22			***************************************************************************/
23
24			#ifndef LS_SFZ_EGADSR_H
25			#define LS_SFZ_EGADSR_H
26
27			#include "../common/EG.h"
28
29			namespace LinuxSampler { namespace sfz {
30
31			/**
32			* ADSR Envelope Generator
33			*
34			* SFZ v1 envelope generator with 'Attack', 'Hold', 'Decay', 'Sustain'
35			* and 'Release' stages for modulating arbitrary synthesis parameters.
36			*/
37			class EGADSR : public ::LinuxSampler::EG {
38			public:
39
40			/**
41			* Will be called by the voice when the key / voice was triggered.
42			*
43			* @param PreAttack - Preattack value for the envelope
44			* (0 - 1000 permille)
45			* @param AttackTime - Attack time for the envelope
46	persson	2203	* @param HoldTime - Hold time for the envelope
47	persson	2055	* @param DecayTime - Decay1 time of the sample amplitude EG
48			* @param SustainLevel - Sustain level of the sample amplitude EG
49			* (0 - 1000 permille)
50			* @param ReleaseTIme - Release time for the envelope
51			* @param SampleRate - sample rate of used audio output driver
52	persson	2311	* @param LinearRelease - true if decay and release is linear
53	persson	2055	*/
54	persson	2311	void trigger(uint PreAttack, float AttackTime, float HoldTime, float DecayTime, uint SustainLevel, float ReleaseTime, uint SampleRate, bool LinearRelease); //FIXME: we should better use 'float' for SampleRate
55	persson	2055
56			/**
57			* Should be called to inform the EG about an external event and
58			* also whenever an envelope stage is completed. This will handle
59			* the envelope's transition to the respective next stage.
60			*
61			* @param Event - what happened
62			* @param SampleRate - sample rate of used audio output driver
63			*/
64			void update(event_t Event, uint SampleRate);
65
66			private:
67
68			enum stage_t {
69			stage_attack,
70			stage_attack_hold,
71			stage_decay,
72			stage_sustain,
73			stage_release,
74			stage_fadeout,
75			stage_end
76			};
77
78			stage_t Stage;
79	persson	2203	int HoldSteps;
80	persson	2055	float DecayTime;
81			float SustainLevel;
82	persson	2311	float ReleaseTime;
83			bool LinearRelease;
84	persson	2055
85			void enterAttackStage(const uint PreAttack, const float AttackTime, const uint SampleRate);
86			void enterAttackHoldStage();
87			void enterDecayStage(const uint SampleRate);
88			void enterSustainStage();
89			void enterReleaseStage();
90			};
91
92			}} // namespace LinuxSampler::sfz
93
94			#endif // LS_SFZ_EGADSR_H