Add name to all controlled components.
[sonitus.git] / src / main / java / net / pterodactylus / sonitus / data / filter / SoxResampleFilter.java
1 /*
2  * Sonitus - ResampleFilter.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 static com.google.common.base.Preconditions.checkArgument;
21 import static com.google.common.base.Preconditions.checkNotNull;
22
23 import java.io.IOException;
24
25 import net.pterodactylus.sonitus.data.Metadata;
26
27 import com.google.common.collect.ImmutableList;
28
29 /**
30  * {@link net.pterodactylus.sonitus.data.Filter} implementation that uses {@code
31  * sox} to resample a PCM-encoded source.
32  *
33  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
34  */
35 public class SoxResampleFilter extends ExternalFilter {
36
37         /** The location of the binary. */
38         private final String binary;
39
40         /** The final sampling rate. */
41         private final int rate;
42
43         /**
44          * Creates a new resample filter.
45          *
46          * @param binary
47          *              The location of the binary
48          * @param rate
49          *              The new sampling rate
50          */
51         public SoxResampleFilter(String binary, int rate) {
52                 super(String.format("Resample to %s kHz", rate / 1000.0));
53                 this.binary = binary;
54                 this.rate = rate;
55         }
56
57         //
58         // FILTER METHODS
59         //
60
61         @Override
62         public Metadata metadata() {
63                 return super.metadata().frequency(rate);
64         }
65
66         @Override
67         public void open(Metadata metadata) throws IOException {
68                 checkNotNull(metadata, "metadata must not be null");
69                 checkArgument(metadata.encoding().equalsIgnoreCase("PCM"), "source must be PCM-encoded");
70
71                 super.open(metadata);
72         }
73
74         //
75         // EXTERNALFILTER METHODS
76         //
77
78         @Override
79         protected String binary(Metadata metadata) {
80                 return binary;
81         }
82
83         @Override
84         protected Iterable<String> parameters(Metadata metadata) {
85                 ImmutableList.Builder<String> parameters = ImmutableList.builder();
86                 /* the input file. */
87                 parameters.add("--bits").add("16");
88                 parameters.add("--channels").add(String.valueOf(metadata.channels()));
89                 parameters.add("--encoding").add("signed-integer");
90                 parameters.add("--rate").add(String.valueOf(metadata.frequency()));
91                 parameters.add("--type").add("raw");
92                 parameters.add("--endian").add("little");
93                 parameters.add("-");
94                 /* the output file. */
95                 parameters.add("--bits").add("16");
96                 parameters.add("--channels").add(String.valueOf(metadata.channels()));
97                 parameters.add("--encoding").add("signed-integer");
98                 parameters.add("--type").add("raw");
99                 parameters.add("--endian").add("little");
100                 parameters.add("-");
101                 /* rate effect. */
102                 parameters.add("rate").add("-h").add(String.valueOf(rate));
103                 return parameters.build();
104         }
105
106 }