Add name to all controlled components.
[sonitus.git] / src / main / java / net / pterodactylus / sonitus / data / filter / ExternalMp3Encoder.java
1 /*
2  * Sonitus - ExternalMp3Encoder.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.checkNotNull;
21 import static com.google.common.base.Preconditions.checkState;
22
23 import java.io.IOException;
24
25 import net.pterodactylus.sonitus.data.Metadata;
26
27 /**
28  * Basic {@link net.pterodactylus.sonitus.data.filter.ExternalFilter}
29  * implementation that verifies that the connected source is PCM-encoded and
30  * that returns an MP3-encoded metadata.
31  *
32  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
33  */
34 public abstract class ExternalMp3Encoder extends ExternalFilter {
35
36         /**
37          * Creates a new external MP3 encoder.
38          *
39          * @param name
40          *              The name of the filter
41          */
42         protected ExternalMp3Encoder(String name) {
43                 super(name);
44         }
45
46         @Override
47         public Metadata metadata() {
48                 return super.metadata().encoding("MP3");
49         }
50
51         @Override
52         public void open(Metadata metadata) throws IOException {
53                 checkNotNull(metadata, "metadata must not be null");
54                 checkState(metadata.encoding().equalsIgnoreCase("PCM"), "source must be PCM-encoded");
55
56                 super.open(metadata);
57         }
58
59 }