File: FaustPlugin_template.cs

package info (click to toggle)
faust 2.79.3%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 397,496 kB
  • sloc: cpp: 278,433; ansic: 116,164; javascript: 18,529; vhdl: 14,052; sh: 13,884; java: 5,900; objc: 3,852; python: 3,222; makefile: 2,655; cs: 1,672; lisp: 1,146; ruby: 954; yacc: 586; xml: 471; lex: 247; awk: 110; tcl: 26
file content (124 lines) | stat: -rw-r--r-- 5,003 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
/************************************************************************
 FAUST Architecture File
 Copyright (C) 2003-2019 GRAME, Centre National de Creation Musicale
 ---------------------------------------------------------------------
 This Architecture section 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 3 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, see <http://www.gnu.org/licenses/>.
 
 EXCEPTION : As a special exception, you may create a larger work
 that contains this FAUST architecture section and distribute
 that work under terms of your choice, so long as this FAUST
 architecture section is not modified.
 
 ************************************************************************
 ************************************************************************/

// @notes MODEL and VARIABLES are replaced during processing
using UnityEngine;
using FaustUtilities_MODEL;

/* @brief How To Use
* Attached this script to a game object.
* It will create an Audio source, attach the dsp to it and display the plugin interface in the inspector
*/

/* @brief This class supports parameter access in the plugin
* In the plugin, each parameter is accessed using an ID.
* IDs are integers starting at 0. They are assigned following the order they have been implemented in the Faust program.
* To access the parameter, use the GetParameter() and SetParameter() methods, passing the parameter ID.
* IDs are displayed as tooltips in the inspector, mouse over the parameter (e.g., a slider) to display the tooltip.
* Passive parameters (bargraphs) cannot be set.
*/

[RequireComponent(typeof(AudioSource))] // Automatically attached the script to an Audiosource
public class FaustPlugin_MODEL: MonoBehaviour {
    // Array containing the value of each parameter, has to be public to be serialized by the Unity engine
    public float[] parameters = new float[VARIABLES];
    private Faust_Context ctx;

    // Initializes the interface between the plugin and Unity
    public Faust_Context context {
        get {
           return ctx;
        }
    }

    /* @brief Returns true if the plugin is instantiated (the plugin is instantiated when play mode button is pressed)
     */
    public bool IsInstantiated() {
        return (ctx != null);
    }

    /* @brief Gets a parameter value from the plugin
     * @param param Use the parameter number available in the parameter inspector (tooltip)
     * @return The parameter value 
     */
    public float getParameter(int param) {
        if (IsInstantiated()) { // if the the plugin is instantiated, the parameter value is changed directly in the plugin
            return ctx.getParameterValue(param);
        } else {                // if not, the value is stored in parameters[]
            return parameters[param];
        }
    }

    /* @brief Sets a parameter value in the plugin
     * @param param Use the parameter number available in the parameter inspector (tooltip)
     * @param x New parameter value 
     */
    public void setParameter(int param, float x) {
        if (IsInstantiated()) {
            ctx.setParameterValue(param, x);
        } else {
            parameters[param] = x;
        }
    }

    /* @brief Instantiates the plugin and the interface between the plugin and Unity
     * @brief And sets the new parameter values changed while in pause mode 
     */
    private void Start() {
        ctx = new Faust_Context(getBufferSize());
        ctx.context_init(AudioSettings.outputSampleRate);
        for (int i = 0; i < parameters.Length; i++) {
            setParameter(i, parameters[i]);
        }
    }

    /* @brief Fills the Unity audio buffer with the audio data computed by the plugin
    */
    private void OnAudioFilterRead(float[] buffer, int numchannels) {
        if (IsInstantiated()) ctx.process(buffer, buffer.Length / numchannels, numchannels);
    }

    private int getBufferSize() {
        int bufferlength,
        numbuffers;
        AudioSettings.GetDSPBufferSize(out bufferlength, out numbuffers);
        return bufferlength;
    }

    /* @brief Gets the min value of a parameter
     * @param Use the parameter number available in the parameter inspector (tooltip) 
     */
    public float getParameterMin(int param) {
        return ctx.getParamMin(param);
    }

    /* @brief Gets the max value of a parameter
     * @param Use the parameter number available in the parameter inspector (tooltip) 
     */
    public float getParameterMax(int param) {
        return ctx.getParamMax(param);
    }

}