WhatsSidServlet.java

package server.restful.servlets.whatssid;

import com.beust.jcommander.Parameters;
import jakarta.persistence.EntityManager;
import jakarta.persistence.QueryTimeoutException;
import jakarta.servlet.AsyncContext;
import jakarta.servlet.annotation.HttpConstraint;
import jakarta.servlet.annotation.MultipartConfig;
import jakarta.servlet.annotation.ServletSecurity;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.HttpFilter;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import libsidutils.fingerprinting.FingerPrinting;
import libsidutils.fingerprinting.ini.IniFingerprintConfig;
import libsidutils.fingerprinting.rest.beans.MusicInfoBean;
import libsidutils.fingerprinting.rest.beans.MusicInfoWithConfidenceBean;
import libsidutils.fingerprinting.rest.beans.WAVBean;
import server.restful.common.JSIDPlay2Servlet;
import server.restful.common.LRUCache;
import server.restful.common.async.DefaultThreadFactory;
import server.restful.common.async.HttpAsyncContextRunnable;
import server.restful.common.filters.RTMPBasedRateLimiterFilter;
import server.restful.common.parameter.RequestResponseBodyParameter;
import server.restful.common.parameter.ServletParameterParser;
import server.restful.common.parameter.UsageParameter;
import ui.entities.whatssid.service.WhatsSidService;

import java.io.IOException;
import java.util.Collections;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;

import static jakarta.servlet.http.HttpServletResponse.SC_INTERNAL_SERVER_ERROR;
import static jakarta.servlet.http.HttpServletResponse.SC_SERVICE_UNAVAILABLE;
import static java.lang.String.valueOf;
import static org.apache.tomcat.util.http.fileupload.FileUploadBase.MULTIPART;
import static server.restful.JSIDPlay2Server.*;
import static server.restful.common.IServletSystemProperties.WhatsSIDServlet.*;
import static server.restful.common.ServletUtil.*;
import static server.restful.common.filters.RTMPBasedRateLimiterFilter.FILTER_PARAMETER_MAX_RTMP_PER_SERVLET;

@WebServlet(name = "WhatsSidServlet", displayName = "WhatsSidServlet", asyncSupported = true, urlPatterns = CONTEXT_ROOT_SERVLET
        + "/whatssid", description = "WhatsSID tune recognition. What's this tune?")
@ServletSecurity(value = @HttpConstraint(rolesAllowed = {ROLE_USER, ROLE_ADMIN}))
@MultipartConfig(maxFileSize = WHATSSIDSERVLET_MAX_FILE_SIZE, maxRequestSize = WHATSSIDSERVLET_MAX_REQUEST_SIZE, fileSizeThreshold = WHATSSIDSERVLET_FILE_SIZE_THRESHOLD)
public class WhatsSidServlet extends JSIDPlay2Servlet {

    @Parameters(resourceBundle = "server.restful.servlets.whatssid.WhatsSidServletParameters")
    public static class WhatsSidServletParameters extends UsageParameter
            implements RequestResponseBodyParameter<WAVBean, MusicInfoWithConfidenceBean> {

        @Override
        public WAVBean getRequestBodyExample() {
            return new WAVBean(new byte[]{0x52, 0x49, 0x46, 0x46, 0x2C, 0x00, 0x00, 0x00, 0x57, 0x41, 0x56, 0x45,
                    0x66, 0x6D, 0x74, 0x20, 0x10, 0x00, 0x00, 0x00, 0x01, 0x00, 0x01, 0x00, 0x40, 0x1F, 0x00, 0x00,
                    (byte) 0x80, 0x3E, 0x00, 0x00, 0x02, 0x00, 0x10, 0x00, 0x64, 0x61, 0x74, 0x61, 0x02, 0x00, 0x00,
                    0x00, 0x00, 0x00});
        }

        @Override
        public MusicInfoWithConfidenceBean getResponseBodyExample() {
            MusicInfoWithConfidenceBean musicInfoWithConfidenceBean = new MusicInfoWithConfidenceBean();
            MusicInfoBean musicInfoBean = new MusicInfoBean();
            musicInfoBean.setTitle("Lightspeed");
            musicInfoBean.setArtist("Ari Yliaho (Agemixer)");
            musicInfoBean.setAlbum("2001 Scallop");
            musicInfoBean.setFileDir("/media/nas2/Ken/C64/C64Music/MUSICIANS/A/Agemixer/Lightspeed.sid");
            musicInfoBean.setInfoDir("/C64Music/MUSICIANS/A/Agemixer/Lightspeed.sid");
            musicInfoBean.setAudioLength(332.0562438964844);
            musicInfoWithConfidenceBean.setMusicInfo(musicInfoBean);
            musicInfoWithConfidenceBean.setRelativeConfidence(18.2648401826484);
            musicInfoWithConfidenceBean.setOffsetSeconds(72.12903225806451);
            musicInfoWithConfidenceBean.setConfidence(80);
            musicInfoWithConfidenceBean.setOffset(2236);
            return musicInfoWithConfidenceBean;
        }
    }

    private static final Map<Integer, MusicInfoWithConfidenceBean> MUSIC_INFO_WITH_CONFIDENCE_BEAN_MAP = Collections
            .synchronizedMap(new LRUCache<>(CACHE_SIZE));

    private ExecutorService executorService;

    @Override
    public void init() {
        executorService = Executors.newFixedThreadPool(MAX_WHATSIDS_IN_PARALLEL, new DefaultThreadFactory("/whatssid"));
    }

    @Override
    public void destroy() {
        executorService.shutdown();
    }

    @Override
    public Map<Class<? extends HttpFilter>, Map<String, String>> getServletFiltersParameterMap() {
        Map<Class<? extends HttpFilter>, Map<String, String>> result = new HashMap<>();

        Map<String, String> rtmpBasedRateLimiterFilterParameters = new HashMap<>();
        rtmpBasedRateLimiterFilterParameters.put(FILTER_PARAMETER_MAX_RTMP_PER_SERVLET,
                String.valueOf(WHATSID_MAINTENANCE ? 0 : String.valueOf(WHATSID_LOW_PRIO ? 1 : Integer.MAX_VALUE)));
        result.put(RTMPBasedRateLimiterFilter.class, rtmpBasedRateLimiterFilterParameters);

        return result;
    }

    /**
     * WhatsSID? (SID tune recognition).
     * <p>
     * E.g. {@code http://haendel.ddns.net:8080/jsidplay2service/JSIDPlay2REST/whatssid }
     */
    @Override
    protected void doPost(HttpServletRequest request, HttpServletResponse response) {

        AsyncContext asyncContext = request.startAsync(request, response);
        asyncContext.setTimeout(WHATSSID_ASYNC_TIMEOUT);

        executorService.execute(new HttpAsyncContextRunnable(asyncContext, getServletContext()) {

            public void run(HttpServletRequest request, HttpServletResponse response) throws IOException {
                try {
                    final WhatsSidServletParameters servletParameters = new WhatsSidServletParameters();

                    ServletParameterParser parser = new ServletParameterParser(request, response, servletParameters);

                    if (servletParameters.getHelp() || parser.hasException()) {
                        parser.usage();
                        return;
                    }
                    WAVBean wavBean = getInput(request, WAVBean.class);
                    boolean isMultipart = request.getContentType().toLowerCase(Locale.US).startsWith(MULTIPART);
                    wavBean.setMaxSeconds(isMultipart ? UPLOAD_MAX_SECONDS : MAX_SECONDS);

                    int hashCode = request.getRemoteAddr().hashCode() ^ wavBean.hashCode();
                    MusicInfoWithConfidenceBean musicInfoWithConfidence;
                    if (MUSIC_INFO_WITH_CONFIDENCE_BEAN_MAP.containsKey(hashCode)) {
                        musicInfoWithConfidence = MUSIC_INFO_WITH_CONFIDENCE_BEAN_MAP.get(hashCode);
                        info(getServletContext(), musicInfoWithConfidence + " (cached)", parentThread);
                    } else {
                        musicInfoWithConfidence = match(getEntityManager(), wavBean);
                        MUSIC_INFO_WITH_CONFIDENCE_BEAN_MAP.put(hashCode, musicInfoWithConfidence);
                        info(getServletContext(), valueOf(musicInfoWithConfidence), parentThread);
                    }
                    if (!isComplete()) {
                        setOutput(request, response, musicInfoWithConfidence);
                    }
                } catch (QueryTimeoutException qte) {
                    warn(getServletContext(), qte.getClass().getName(), parentThread);
                    if (!isComplete()) {
                        response.sendError(SC_SERVICE_UNAVAILABLE, qte.getClass().getName());
                    }
                } catch (Throwable t) {
                    error(getServletContext(), t, parentThread);
                    if (!isComplete()) {
                        response.setStatus(SC_INTERNAL_SERVER_ERROR);
                        setOutput(response, t);
                    }
                } finally {
                    freeEntityManager();
                }
            }

            private MusicInfoWithConfidenceBean match(EntityManager entityManager, WAVBean wavBean) throws IOException {
                WhatsSidService whatsSidService = new WhatsSidService(entityManager);
                FingerPrinting fingerPrinting = new FingerPrinting(new IniFingerprintConfig(), whatsSidService);
                return fingerPrinting.match(wavBean);
            }

        });
    }

}