2 * Sonitus - OggVorbisIdentifier.java - Copyright © 2013 David Roden
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.
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.
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/>.
18 package net.pterodactylus.sonitus.io;
20 import java.io.IOException;
21 import java.io.InputStream;
23 import net.pterodactylus.sonitus.data.ContentMetadata;
24 import net.pterodactylus.sonitus.data.FormatMetadata;
25 import net.pterodactylus.sonitus.data.Metadata;
27 import com.google.common.base.Optional;
28 import com.jcraft.jogg.Packet;
29 import com.jcraft.jogg.Page;
30 import com.jcraft.jogg.StreamState;
31 import com.jcraft.jogg.SyncState;
32 import com.jcraft.jorbis.Comment;
33 import com.jcraft.jorbis.Info;
36 * Identifies Ogg Vorbis files. <p> All knowledge used in this class has been
37 * taken from <a href="http://www.jcraft.com/jorbis/tutorial/Tutorial.html">jcraft.com/jorbis/tutorial/Tutorial.html</a>.
40 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
42 public class OggVorbisIdentifier {
44 /** The default size of the read buffer. */
45 private static final int BUFFER_SIZE = 4096;
47 /** Suppress default constructor. */
48 private OggVorbisIdentifier() {
53 * Tries to parse the given stream as Ogg Vorbis file and returns a {@link
54 * Metadata} describing the stream.
57 * The input stream to identify as Ogg Vorbis
58 * @return The identified metadata, or {@link Optional#absent()} if the stream
59 * could not be identified
61 * if an I/O error occurs
63 public static Optional<Metadata> identify(InputStream inputStream) throws IOException {
65 /* stuff needed to decode Ogg. */
66 Packet packet = new Packet();
67 Page page = new Page();
68 StreamState streamState = new StreamState();
69 SyncState syncState = new SyncState();
71 /* stuff needed to decode Vorbis. */
72 Comment comment = new Comment();
73 Info info = new Info();
75 /* initialize jorbis. */
77 int bufferSize = BUFFER_SIZE;
78 int index = syncState.buffer(bufferSize);
79 byte[] buffer = syncState.data;
81 boolean streamStateInitialized = false;
84 /* read until we have read the three packets required to decode the header. */
85 while (packetsRead < 3) {
86 int read = inputStream.read(buffer, index, bufferSize);
87 syncState.wrote(read);
88 switch (syncState.pageout(page)) {
90 return Optional.absent();
92 if (!streamStateInitialized) {
93 /* init stream state. */
94 streamState.init(page.serialno());
98 streamStateInitialized = true;
100 if (streamState.pagein(page) == -1) {
101 return Optional.absent();
103 switch (streamState.packetout(packet)) {
105 return Optional.absent();
107 info.synthesis_headerin(comment, packet);
116 index = syncState.buffer(bufferSize);
117 buffer = syncState.data;
120 FormatMetadata formatMetadata = new FormatMetadata(info.channels, info.rate, "Vorbis");
121 ContentMetadata contentMetadata = new ContentMetadata("");
122 for (int c = 0; c < comment.comments; ++c) {
123 String field = comment.getComment(c);
124 Optional<String> extractedField = extractField(field, "ARTIST");
125 if (extractedField.isPresent()) {
126 contentMetadata = contentMetadata.artist(extractedField.get());
129 extractedField = extractField(field, "TITLE");
130 if (extractedField.isPresent()) {
131 contentMetadata = contentMetadata.name(extractedField.get());
135 return Optional.of(new Metadata(formatMetadata, contentMetadata));
139 * Extracts the content of the field from the comment if the comment contains
143 * The comment to extract the value from
145 * The name of the field to extract
146 * @return The extracted field, or {@link Optional#absent()} if the comment
147 * does not contain the given field
149 private static Optional<String> extractField(String comment, String fieldName) {
150 if (comment.startsWith(fieldName + "=")) {
151 return Optional.of(comment.substring(fieldName.length() + 1));
153 return Optional.absent();