aboutsummaryrefslogtreecommitdiffstats
path: root/src/main/java/com/jsyn/unitgen/Circuit.java
blob: db516a752991a7a457683acd3647505c99dff01d (plain)
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
125
126
127
128
129
130
131
/*
 * Copyright 2009 Phil Burk, Mobileer Inc
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.jsyn.unitgen;

import java.util.ArrayList;
import java.util.LinkedHashMap;

import com.jsyn.engine.SynthesisEngine;
import com.jsyn.ports.UnitPort;

/**
 * Contains a list of units that are executed together.
 *
 * @author Phil Burk (C) 2009 Mobileer Inc
 */
public class Circuit extends UnitGenerator {
    private ArrayList<UnitGenerator> units = new ArrayList<UnitGenerator>();

    private final LinkedHashMap<String, UnitPort> portAliases = new LinkedHashMap<String, UnitPort>();

    @Override
    public void generate(int start, int limit) {
        for (UnitGenerator unit : units) {
            unit.generate(start, limit);
        }
    }

    /**
     * Call flattenOutputs on subunits. Flatten output ports so we don't output a changing signal
     * when stopped.
     */
    @Override
    public void flattenOutputs() {
        for (UnitGenerator unit : units) {
            unit.flattenOutputs();
        }
    }

    /**
     * Call setEnabled on subunits.
     */
    @Override
    public void setEnabled(boolean enabled) {
        super.setEnabled(enabled);
        for (UnitGenerator unit : units) {
            unit.setEnabled(enabled);
        }
    }

    /**
     * @deprecated ignored, frameRate comes from the SynthesisEngine
     * @param frameRate
     */
    @Deprecated
    @Override
    public void setFrameRate(int frameRate) {
        super.setFrameRate(frameRate);
        for (UnitGenerator unit : units) {
            unit.setFrameRate(frameRate);
        }
    }

    @Override
    public void setSynthesisEngine(SynthesisEngine engine) {
        super.setSynthesisEngine(engine);
        for (UnitGenerator unit : units) {
            unit.setSynthesisEngine(engine);
        }
    }

    /** Add a unit to the circuit. */
    public void add(UnitGenerator unit) {
        units.add(unit);
        unit.setCircuit(this);
        // Propagate circuit properties down into subunits.
        unit.setEnabled(isEnabled());
    }

    public void usePreset(int presetIndex) {
    }


    /**
     * Add an alternate name for looking up a port.
     * @param port
     * @param alias
     */
    public void addPortAlias(UnitPort port, String alias) {
        // Store in a hash table by an alternate name.
        portAliases.put(alias.toLowerCase(), port);
    }


    /**
     * Case-insensitive search for a port by its name or alias.
     * @param portName
     * @return matching port or null
     */
    @Override
    public UnitPort getPortByName(String portName) {
        UnitPort port = super.getPortByName(portName);
        if (port == null) {
            port = portAliases.get(portName.toLowerCase());
        }
        return port;
    }

    /**
     * The units are guaranteed to be in the same order
     * as they were added.
     *
     * @return an array of units that have been added to this circuit.
     */
    UnitGenerator[] getUnits() {
        return units.toArray(new UnitGenerator[0]);
    }
}