Allowing programmatic registration of new decoders (#343)

Author: devgianlu

player/src/main/java/xyz/gianlu/librespot/player/codecs/Codecs.java

@@ -0,0 +1,76 @@
+/*
+ * Copyright 2021 devgianlu
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package xyz.gianlu.librespot.player.codecs;
+
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import xyz.gianlu.librespot.audio.GeneralAudioStream;
+import xyz.gianlu.librespot.audio.NormalizationData;
+import xyz.gianlu.librespot.audio.format.SuperAudioFormat;
+import xyz.gianlu.librespot.player.PlayerConfiguration;
+
+import java.util.*;
+
+/**
+ * @author devgianlu
+ */
+public final class Codecs {
+    private static final Map<SuperAudioFormat, HashSet<Class<? extends Codec>>> codecs = new EnumMap<>(SuperAudioFormat.class);
+    private static final Logger LOGGER = LoggerFactory.getLogger(Codecs.class);
+
+    static {
+        registerCodec(SuperAudioFormat.VORBIS, VorbisCodec.class);
+        registerCodec(SuperAudioFormat.MP3, Mp3Codec.class);
+    }
+
+    private Codecs() {
+    }
+
+    @Nullable
+    public static Codec initCodec(@NotNull SuperAudioFormat format, @NotNull GeneralAudioStream audioFile, @Nullable NormalizationData normalizationData, @NotNull PlayerConfiguration conf, int duration) {
+        Set<Class<? extends Codec>> set = codecs.get(format);
+        if (set == null) return null;
+
+        Optional<Class<? extends Codec>> opt = set.stream().findFirst();
+        if (!opt.isPresent()) return null;
+
+        try {
+            Class<? extends Codec> clazz = opt.get();
+            return clazz.getConstructor(GeneralAudioStream.class, NormalizationData.class, PlayerConfiguration.class, int.class).newInstance(audioFile, normalizationData, conf, duration);
+        } catch (ReflectiveOperationException ex) {
+            LOGGER.error("Failed initializing Codec instance for {}", format, ex);
+            return null;
+        }
+    }
+
+    public static void registerCodec(@NotNull SuperAudioFormat format, @NotNull Class<? extends Codec> clazz) {
+        codecs.computeIfAbsent(format, (key) -> new HashSet<>(5)).add(clazz);
+    }
+
+    public static void replaceCodecs(@NotNull SuperAudioFormat format, @NotNull Class<? extends Codec> clazz) {
+        Set<Class<? extends Codec>> set = codecs.get(format);
+        if (set != null) set.clear();
+        registerCodec(format, clazz);
+    }
+
+    public static void unregisterCodec(@NotNull Class<? extends Codec> clazz) {
+        for (Set<Class<? extends Codec>> set : codecs.values())
+            set.remove(clazz);
+    }
+}

player/src/main/java/xyz/gianlu/librespot/player/playback/PlayerQueueEntry.java

@@ -16,7 +16,6 @@
 
 package xyz.gianlu.librespot.player.playback;
 
-import javazoom.jl.decoder.BitstreamException;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.slf4j.Logger;
@@ -33,8 +32,7 @@
 import xyz.gianlu.librespot.player.PlayerConfiguration;
 import xyz.gianlu.librespot.player.StateWrapper;
 import xyz.gianlu.librespot.player.codecs.Codec;
-import xyz.gianlu.librespot.player.codecs.Mp3Codec;
-import xyz.gianlu.librespot.player.codecs.VorbisCodec;
+import xyz.gianlu.librespot.player.codecs.Codecs;
 import xyz.gianlu.librespot.player.codecs.VorbisOnlyAudioQuality;
 import xyz.gianlu.librespot.player.crossfade.CrossfadeController;
 import xyz.gianlu.librespot.player.metrics.PlaybackMetrics;
@@ -132,20 +130,9 @@ private void load(boolean preload) throws IOException, Codec.CodecException, Mer
         if (crossfade.hasAnyFadeOut() || conf.preloadEnabled)
             notifyInstant(INSTANT_PRELOAD, (int) (crossfade.fadeOutStartTimeMin() - TimeUnit.SECONDS.toMillis(20)));
 
-        switch (stream.in.codec()) {
-            case VORBIS:
-                codec = new VorbisCodec(stream.in, stream.normalizationData, conf, metadata.duration());
-                break;
-            case MP3:
-                try {
-                    codec = new Mp3Codec(stream.in, stream.normalizationData, conf, metadata.duration());
-                } catch (BitstreamException ex) {
-                    throw new IOException(ex);
-                }
-                break;
-            default:
-                throw new UnsupportedEncodingException(stream.in.codec().toString());
-        }
+        codec = Codecs.initCodec(stream.in.codec(), stream.in, stream.normalizationData, conf, metadata.duration());
+        if (codec == null)
+            throw new UnsupportedEncodingException(stream.in.codec().toString());
 
         LOGGER.trace("Loaded {} codec. {of: {}, format: {}, playbackId: {}}", stream.in.codec(), stream.in.describe(), codec.getAudioFormat(), playbackId);
     }