Pull all interfaces into a single interface: Filter.
[sonitus.git] / src / main / java / net / pterodactylus / sonitus / data / filter / VolumeFilter.java
1 /*
2  * Sonitus - VolumeFilter.java - Copyright © 2013 David Roden
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
16  */
17
18 package net.pterodactylus.sonitus.data.filter;
19
20 import java.util.Arrays;
21 import java.util.List;
22
23 import net.pterodactylus.sonitus.data.Controller;
24 import net.pterodactylus.sonitus.data.Filter;
25 import net.pterodactylus.sonitus.data.controller.Fader;
26 import net.pterodactylus.sonitus.data.controller.Switch;
27
28 /**
29  * Internal {@link Filter} implementation that can reduce the volume of the
30  * signal.
31  *
32  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
33  */
34 public class VolumeFilter extends AudioProcessingFilter {
35
36         /** The volume fader. */
37         private final Fader volumeFader;
38
39         /** The mute switch. */
40         private final Switch muteSwitch;
41
42         /** Creates a new volume filter. */
43         public VolumeFilter() {
44                 super("Volume");
45                 volumeFader = new Fader("Volume", 1.0);
46                 muteSwitch = new Switch("Mute", false);
47         }
48
49         //
50         // FILTER METHODS
51         //
52
53         @Override
54         public List<Controller<?>> controllers() {
55                 return Arrays.<Controller<?>>asList(volumeFader, muteSwitch);
56         }
57
58         @Override
59         protected int[] processSamples(int[] samples) {
60                 int[] processedSamples = new int[samples.length];
61                 double volumeFactor = volumeFader.value();
62                 for (int channel = 0; channel < samples.length; ++channel) {
63                         processedSamples[channel] = muteSwitch.value() ? 0 : (int) (samples[channel] * volumeFactor);
64                 }
65                 return processedSamples;
66         }
67
68 }