89a930c36c2a25416808f98da8289ca27797cd68
[sonitus.git] / src / main / java / net / pterodactylus / sonitus / data / sink / Icecast2Sink.java
1 /*
2  * Sonitus - Icecast2Sink.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.sink;
19
20 import java.io.IOException;
21 import java.io.InputStream;
22 import java.io.OutputStream;
23 import java.io.UnsupportedEncodingException;
24 import java.net.Socket;
25 import java.net.URLEncoder;
26 import java.util.Arrays;
27 import java.util.Collections;
28 import java.util.List;
29 import java.util.logging.Level;
30 import java.util.logging.Logger;
31
32 import net.pterodactylus.sonitus.data.Controller;
33 import net.pterodactylus.sonitus.data.Metadata;
34 import net.pterodactylus.sonitus.data.Sink;
35 import net.pterodactylus.sonitus.io.InputStreamDrainer;
36
37 import com.google.common.base.Function;
38 import com.google.common.base.Joiner;
39 import com.google.common.base.Optional;
40 import com.google.common.collect.FluentIterable;
41 import com.google.common.io.BaseEncoding;
42 import com.google.common.io.Closeables;
43
44 /**
45  * {@link net.pterodactylus.sonitus.data.Sink} implementation that delivers all
46  * incoming data to an Icecast2 server.
47  *
48  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
49  */
50 public class Icecast2Sink implements Sink {
51
52         /** The logger. */
53         private static final Logger logger = Logger.getLogger(Icecast2Sink.class.getName());
54
55         /** The server name. */
56         private final String server;
57
58         /** The port number on the server. */
59         private final int port;
60
61         /** The source password. */
62         private final String password;
63
64         /** The stream mount point (without leading slash). */
65         private final String mountPoint;
66
67         /** The name of the server. */
68         private final String serverName;
69
70         /** The description of the server. */
71         private final String serverDescription;
72
73         /** The genre of the server. */
74         private final String genre;
75
76         /** Whether to publish the server. */
77         private final boolean publishServer;
78
79         private OutputStream socketOutputStream;
80
81         /**
82          * Creates a new Icecast2 sink.
83          *
84          * @param server
85          *              The hostname of the server
86          * @param port
87          *              The port number of the server
88          * @param password
89          *              The source password
90          * @param mountPoint
91          *              The stream mount point
92          * @param serverName
93          *              The name of the server
94          * @param serverDescription
95          *              The description of the server
96          * @param genre
97          *              The genre of the server
98          * @param publishServer
99          *              {@code true} to publish the server in a public directory, {@code false} to
100          *              not publish it
101          */
102         public Icecast2Sink(String server, int port, String password, String mountPoint, String serverName, String serverDescription, String genre, boolean publishServer) {
103                 this.server = server;
104                 this.port = port;
105                 this.password = password;
106                 this.mountPoint = mountPoint;
107                 this.serverName = serverName;
108                 this.serverDescription = serverDescription;
109                 this.genre = genre;
110                 this.publishServer = publishServer;
111         }
112
113         //
114         // CONTROLLED METHODS
115         //
116
117         @Override
118         public List<Controller<?>> controllers() {
119                 return Collections.emptyList();
120         }
121
122         //
123         // SINK METHODS
124         //
125
126         @Override
127         public void open(Metadata metadata) throws IOException {
128                 logger.info(String.format("Connecting to %s:%d...", server, port));
129                 Socket socket = new Socket(server, port);
130                 logger.info("Connected.");
131                 socketOutputStream = socket.getOutputStream();
132                 InputStream socketInputStream = socket.getInputStream();
133
134                 sendLine(socketOutputStream, String.format("SOURCE /%s ICE/1.0", mountPoint));
135                 sendLine(socketOutputStream, String.format("Authorization: Basic %s", generatePassword(password)));
136                 sendLine(socketOutputStream, String.format("Content-Type: %s", getContentType(metadata)));
137                 sendLine(socketOutputStream, String.format("ICE-Name: %s", serverName));
138                 sendLine(socketOutputStream, String.format("ICE-Description: %s", serverDescription));
139                 sendLine(socketOutputStream, String.format("ICE-Genre: %s", genre));
140                 sendLine(socketOutputStream, String.format("ICE-Public: %d", publishServer ? 1 : 0));
141                 sendLine(socketOutputStream, "");
142                 socketOutputStream.flush();
143
144                 new Thread(new InputStreamDrainer(socketInputStream)).start();
145
146                 metadataUpdated(metadata);
147         }
148
149         @Override
150         public void close() {
151                 try {
152                         Closeables.close(socketOutputStream, true);
153                 } catch (IOException e) {
154                         /* will never throw. */
155                 }
156         }
157
158         @Override
159         public void metadataUpdated(final Metadata metadata) {
160                 new Thread(new Runnable() {
161
162                         @Override
163                         public void run() {
164                                 String metadataString = String.format("%s (%s)", Joiner.on(" - ").skipNulls().join(FluentIterable.from(Arrays.asList(metadata.artist(), metadata.name())).transform(new Function<Optional<String>, Object>() {
165
166                                         @Override
167                                         public Object apply(Optional<String> input) {
168                                                 return input.orNull();
169                                         }
170                                 })), "Sonitus");
171                                 logger.info(String.format("Updating metadata to %s", metadataString));
172
173                                 Socket socket = null;
174                                 OutputStream socketOutputStream = null;
175                                 try {
176                                         socket = new Socket(server, port);
177                                         socketOutputStream = socket.getOutputStream();
178
179                                         sendLine(socketOutputStream, String.format("GET /admin/metadata?pass=%s&mode=updinfo&mount=/%s&song=%s HTTP/1.0", password, mountPoint, URLEncoder.encode(metadataString, "UTF-8")));
180                                         sendLine(socketOutputStream, String.format("Authorization: Basic %s", generatePassword(password)));
181                                         sendLine(socketOutputStream, String.format("User-Agent: Mozilla/Sonitus"));
182                                         sendLine(socketOutputStream, "");
183                                         socketOutputStream.flush();
184
185                                         new InputStreamDrainer(socket.getInputStream()).run();
186                                 } catch (IOException ioe1) {
187                                         logger.log(Level.WARNING, "Could not update metadata!", ioe1);
188                                 } finally {
189                                         try {
190                                                 Closeables.close(socketOutputStream, true);
191                                                 if (socket != null) {
192                                                         socket.close();
193                                                 }
194                                         } catch (IOException ioe1) {
195                                                 /* ignore. */
196                                         }
197                                 }
198                         }
199                 }).start();
200         }
201
202         @Override
203         public void process(byte[] buffer) throws IOException {
204                 socketOutputStream.write(buffer);
205                 socketOutputStream.flush();
206         }
207
208         //
209         // PRIVATE METHODS
210         //
211
212         /**
213          * Sends the given line, followed by CR+LF, to the given output stream,
214          * encoding the complete line as UTF-8.
215          *
216          * @param outputStream
217          *              The output stream to send the line to
218          * @param line
219          *              The line to send
220          * @throws java.io.IOException
221          *              if an I/O error occurs
222          */
223         private static void sendLine(OutputStream outputStream, String line) throws IOException {
224                 outputStream.write((line + "\r\n").getBytes("UTF-8"));
225         }
226
227         /**
228          * Generates the Base64-encoded authorization information from the given
229          * password. A fixed username of “source” is used.
230          *
231          * @param password
232          *              The password to encode
233          * @return The encoded password
234          * @throws java.io.UnsupportedEncodingException
235          *              if the UTF-8 encoding is not supported (which can never happen)
236          */
237         private static String generatePassword(String password) throws UnsupportedEncodingException {
238                 return BaseEncoding.base64().encode(("source:" + password).getBytes("UTF-8"));
239         }
240
241         /**
242          * Returns a MIME type for the given metadata. Currently only Vorbis, MP3, PCM,
243          * Ogg Vorbis, Opus, and FLAC formats are recognized.
244          *
245          * @param metadata
246          *              The metadata to get a MIME type for
247          * @return The MIME type of the metadata
248          */
249         private static String getContentType(Metadata metadata) {
250                 String encoding = metadata.encoding();
251                 if ("Vorbis".equalsIgnoreCase(encoding)) {
252                         return "audio/ogg";
253                 }
254                 if ("MP3".equalsIgnoreCase(encoding)) {
255                         return "audio/mpeg";
256                 }
257                 if ("PCM".equalsIgnoreCase(encoding)) {
258                         return "audio/vnd.wave";
259                 }
260                 if ("Vorbis".equalsIgnoreCase(encoding)) {
261                         return "application/ogg";
262                 }
263                 if ("Opus".equalsIgnoreCase(encoding)) {
264                         return "audio/ogg; codecs=opus";
265                 }
266                 if ("FLAC".equalsIgnoreCase(encoding)) {
267                         return "audio/flac";
268                 }
269                 return "application/octet-stream";
270         }
271
272 }