85810c92b534578544fb686a555387e96d1cd863
[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 import com.google.common.eventbus.EventBus;
28
29 /**
30  * Basic {@link net.pterodactylus.sonitus.data.filter.ExternalFilter}
31  * implementation that verifies that the connected source is PCM-encoded and
32  * that returns an MP3-encoded metadata.
33  *
34  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
35  */
36 public abstract class ExternalMp3Encoder extends ExternalFilter {
37
38         /**
39          * Creates a new external MP3 encoder.
40          *
41          * @param eventBus
42          *              The event bus
43          * @param name
44          *              The name of the filter
45          */
46         protected ExternalMp3Encoder(EventBus eventBus, String name) {
47                 super(eventBus, name);
48         }
49
50         @Override
51         public Metadata metadata() {
52                 return super.metadata().encoding("MP3");
53         }
54
55         @Override
56         public void open(Metadata metadata) throws IOException {
57                 checkNotNull(metadata, "metadata must not be null");
58                 checkState(metadata.encoding().equalsIgnoreCase("PCM"), "source must be PCM-encoded");
59
60                 super.open(metadata);
61         }
62
63 }