Add volume 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 import com.google.common.eventbus.EventBus;
29
30 /**
31  * Internal {@link Filter} implementation that can reduce the volume of the
32  * signal.
33  *
34  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
35  */
36 public class VolumeFilter extends AudioProcessingFilter {
37
38         /** The volume fader. */
39         private final Fader volumeFader;
40
41         /** The mute switch. */
42         private final Switch muteSwitch;
43
44         /**
45          * Creates a new volume filter.
46          *
47          * @param eventBus
48          *              The event bus
49          */
50         public VolumeFilter(EventBus eventBus) {
51                 super(eventBus, "Volume");
52                 volumeFader = new Fader("Volume", 1.0);
53                 muteSwitch = new Switch("Mute", false);
54         }
55
56         //
57         // CONTROLLED METHODS
58         //
59
60         @Override
61         public List<Controller<?>> controllers() {
62                 return Arrays.<Controller<?>>asList(volumeFader, muteSwitch);
63         }
64
65         //
66         // AUDIOPROCESSINGFILTER METHODS
67         //
68
69         @Override
70         protected int[] processSamples(int[] samples) {
71                 int[] processedSamples = new int[samples.length];
72                 double volumeFactor = volumeFader.value();
73                 for (int channel = 0; channel < samples.length; ++channel) {
74                         processedSamples[channel] = muteSwitch.value() ? 0 : (int) (samples[channel] * volumeFactor);
75                 }
76                 return processedSamples;
77         }
78
79 }