aboutsummaryrefslogtreecommitdiff
path: root/subsonic-main/src/main/java/net/sourceforge/subsonic/controller/StreamController.java
diff options
context:
space:
mode:
Diffstat (limited to 'subsonic-main/src/main/java/net/sourceforge/subsonic/controller/StreamController.java')
-rw-r--r--subsonic-main/src/main/java/net/sourceforge/subsonic/controller/StreamController.java419
1 files changed, 419 insertions, 0 deletions
diff --git a/subsonic-main/src/main/java/net/sourceforge/subsonic/controller/StreamController.java b/subsonic-main/src/main/java/net/sourceforge/subsonic/controller/StreamController.java
new file mode 100644
index 00000000..a40f5da4
--- /dev/null
+++ b/subsonic-main/src/main/java/net/sourceforge/subsonic/controller/StreamController.java
@@ -0,0 +1,419 @@
+/*
+ This file is part of Subsonic.
+
+ Subsonic is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ Subsonic is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with Subsonic. If not, see <http://www.gnu.org/licenses/>.
+
+ Copyright 2009 (C) Sindre Mehus
+ */
+package net.sourceforge.subsonic.controller;
+
+import java.awt.Dimension;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.util.Arrays;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+import net.sourceforge.subsonic.domain.MediaFile;
+import net.sourceforge.subsonic.service.MediaFileService;
+import net.sourceforge.subsonic.service.SearchService;
+import org.apache.commons.io.IOUtils;
+import org.apache.commons.lang.math.LongRange;
+import org.springframework.web.bind.ServletRequestBindingException;
+import org.springframework.web.bind.ServletRequestUtils;
+import org.springframework.web.servlet.ModelAndView;
+import org.springframework.web.servlet.mvc.Controller;
+
+import net.sourceforge.subsonic.Logger;
+import net.sourceforge.subsonic.domain.Player;
+import net.sourceforge.subsonic.domain.PlayQueue;
+import net.sourceforge.subsonic.domain.TransferStatus;
+import net.sourceforge.subsonic.domain.User;
+import net.sourceforge.subsonic.domain.VideoTranscodingSettings;
+import net.sourceforge.subsonic.io.PlayQueueInputStream;
+import net.sourceforge.subsonic.io.RangeOutputStream;
+import net.sourceforge.subsonic.io.ShoutCastOutputStream;
+import net.sourceforge.subsonic.service.AudioScrobblerService;
+import net.sourceforge.subsonic.service.PlayerService;
+import net.sourceforge.subsonic.service.PlaylistService;
+import net.sourceforge.subsonic.service.SecurityService;
+import net.sourceforge.subsonic.service.SettingsService;
+import net.sourceforge.subsonic.service.StatusService;
+import net.sourceforge.subsonic.service.TranscodingService;
+import net.sourceforge.subsonic.util.StringUtil;
+import net.sourceforge.subsonic.util.Util;
+
+/**
+ * A controller which streams the content of a {@link net.sourceforge.subsonic.domain.PlayQueue} to a remote
+ * {@link Player}.
+ *
+ * @author Sindre Mehus
+ */
+public class StreamController implements Controller {
+
+ private static final Logger LOG = Logger.getLogger(StreamController.class);
+
+ private StatusService statusService;
+ private PlayerService playerService;
+ private PlaylistService playlistService;
+ private SecurityService securityService;
+ private SettingsService settingsService;
+ private TranscodingService transcodingService;
+ private AudioScrobblerService audioScrobblerService;
+ private MediaFileService mediaFileService;
+ private SearchService searchService;
+
+ public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception {
+
+ TransferStatus status = null;
+ PlayQueueInputStream in = null;
+ Player player = playerService.getPlayer(request, response, false, true);
+ User user = securityService.getUserByName(player.getUsername());
+
+ try {
+
+ if (!user.isStreamRole()) {
+ response.sendError(HttpServletResponse.SC_FORBIDDEN, "Streaming is forbidden for user " + user.getUsername());
+ return null;
+ }
+
+ // If "playlist" request parameter is set, this is a Podcast request. In that case, create a separate
+ // play queue (in order to support multiple parallel Podcast streams).
+ Integer playlistId = ServletRequestUtils.getIntParameter(request, "playlist");
+ boolean isPodcast = playlistId != null;
+ if (isPodcast) {
+ PlayQueue playQueue = new PlayQueue();
+ playQueue.addFiles(false, playlistService.getFilesInPlaylist(playlistId));
+ player.setPlayQueue(playQueue);
+ Util.setContentLength(response, playQueue.length());
+ LOG.info("Incoming Podcast request for playlist " + playlistId);
+ }
+
+ String contentType = StringUtil.getMimeType(request.getParameter("suffix"));
+ response.setContentType(contentType);
+
+ String preferredTargetFormat = request.getParameter("format");
+ Integer maxBitRate = ServletRequestUtils.getIntParameter(request, "maxBitRate");
+ if (Integer.valueOf(0).equals(maxBitRate)) {
+ maxBitRate = null;
+ }
+
+ VideoTranscodingSettings videoTranscodingSettings = null;
+
+ // Is this a request for a single file (typically from the embedded Flash player)?
+ // In that case, create a separate playlist (in order to support multiple parallel streams).
+ // Also, enable partial download (HTTP byte range).
+ MediaFile file = getSingleFile(request);
+ boolean isSingleFile = file != null;
+ LongRange range = null;
+
+ if (isSingleFile) {
+ PlayQueue playQueue = new PlayQueue();
+ playQueue.addFiles(true, file);
+ player.setPlayQueue(playQueue);
+
+ if (!file.isVideo()) {
+ response.setIntHeader("ETag", file.getId());
+ response.setHeader("Accept-Ranges", "bytes");
+ }
+
+ TranscodingService.Parameters parameters = transcodingService.getParameters(file, player, maxBitRate, preferredTargetFormat, videoTranscodingSettings);
+ long fileLength = getFileLength(parameters);
+ boolean isConversion = parameters.isDownsample() || parameters.isTranscode();
+ boolean estimateContentLength = ServletRequestUtils.getBooleanParameter(request, "estimateContentLength", false);
+
+ range = getRange(request, file);
+ if (range != null) {
+ LOG.info("Got range: " + range);
+ response.setStatus(HttpServletResponse.SC_PARTIAL_CONTENT);
+ Util.setContentLength(response, fileLength - range.getMinimumLong());
+ long firstBytePos = range.getMinimumLong();
+ long lastBytePos = fileLength - 1;
+ response.setHeader("Content-Range", "bytes " + firstBytePos + "-" + lastBytePos + "/" + fileLength);
+ } else if (!isConversion || estimateContentLength) {
+ Util.setContentLength(response, fileLength);
+ }
+
+ String transcodedSuffix = transcodingService.getSuffix(player, file, preferredTargetFormat);
+ response.setContentType(StringUtil.getMimeType(transcodedSuffix));
+
+ if (file.isVideo()) {
+ videoTranscodingSettings = createVideoTranscodingSettings(file, request);
+ }
+ }
+
+ if (request.getMethod().equals("HEAD")) {
+ return null;
+ }
+
+ // Terminate any other streams to this player.
+ if (!isPodcast && !isSingleFile) {
+ for (TransferStatus streamStatus : statusService.getStreamStatusesForPlayer(player)) {
+ if (streamStatus.isActive()) {
+ streamStatus.terminate();
+ }
+ }
+ }
+
+ status = statusService.createStreamStatus(player);
+
+ in = new PlayQueueInputStream(player, status, maxBitRate, preferredTargetFormat, videoTranscodingSettings, transcodingService,
+ audioScrobblerService, mediaFileService, searchService);
+ OutputStream out = RangeOutputStream.wrap(response.getOutputStream(), range);
+
+ // Enabled SHOUTcast, if requested.
+ boolean isShoutCastRequested = "1".equals(request.getHeader("icy-metadata"));
+ if (isShoutCastRequested && !isSingleFile) {
+ response.setHeader("icy-metaint", "" + ShoutCastOutputStream.META_DATA_INTERVAL);
+ response.setHeader("icy-notice1", "This stream is served using Subsonic");
+ response.setHeader("icy-notice2", "Subsonic - Free media streamer - subsonic.org");
+ response.setHeader("icy-name", "Subsonic");
+ response.setHeader("icy-genre", "Mixed");
+ response.setHeader("icy-url", "http://subsonic.org/");
+ out = new ShoutCastOutputStream(out, player.getPlayQueue(), settingsService);
+ }
+
+ final int BUFFER_SIZE = 2048;
+ byte[] buf = new byte[BUFFER_SIZE];
+
+ while (true) {
+
+ // Check if stream has been terminated.
+ if (status.terminated()) {
+ return null;
+ }
+
+ if (player.getPlayQueue().getStatus() == PlayQueue.Status.STOPPED) {
+ if (isPodcast || isSingleFile) {
+ break;
+ } else {
+ sendDummy(buf, out);
+ }
+ } else {
+
+ int n = in.read(buf);
+ if (n == -1) {
+ if (isPodcast || isSingleFile) {
+ break;
+ } else {
+ sendDummy(buf, out);
+ }
+ } else {
+ out.write(buf, 0, n);
+ }
+ }
+ }
+
+ } finally {
+ if (status != null) {
+ securityService.updateUserByteCounts(user, status.getBytesTransfered(), 0L, 0L);
+ statusService.removeStreamStatus(status);
+ }
+ IOUtils.closeQuietly(in);
+ }
+ return null;
+ }
+
+ private MediaFile getSingleFile(HttpServletRequest request) throws ServletRequestBindingException {
+ String path = request.getParameter("path");
+ if (path != null) {
+ return mediaFileService.getMediaFile(path);
+ }
+ Integer id = ServletRequestUtils.getIntParameter(request, "id");
+ if (id != null) {
+ return mediaFileService.getMediaFile(id);
+ }
+ return null;
+ }
+
+ private long getFileLength(TranscodingService.Parameters parameters) {
+ MediaFile file = parameters.getMediaFile();
+
+ if (!parameters.isDownsample() && !parameters.isTranscode()) {
+ return file.getFileSize();
+ }
+ Integer duration = file.getDurationSeconds();
+ Integer maxBitRate = parameters.getMaxBitRate();
+
+ if (duration == null) {
+ LOG.warn("Unknown duration for " + file + ". Unable to estimate transcoded size.");
+ return file.getFileSize();
+ }
+
+ if (maxBitRate == null) {
+ LOG.error("Unknown bit rate for " + file + ". Unable to estimate transcoded size.");
+ return file.getFileSize();
+ }
+
+ return duration * maxBitRate * 1000L / 8L;
+ }
+
+ private LongRange getRange(HttpServletRequest request, MediaFile file) {
+
+ // First, look for "Range" HTTP header.
+ LongRange range = StringUtil.parseRange(request.getHeader("Range"));
+ if (range != null) {
+ return range;
+ }
+
+ // Second, look for "offsetSeconds" request parameter.
+ String offsetSeconds = request.getParameter("offsetSeconds");
+ range = parseAndConvertOffsetSeconds(offsetSeconds, file);
+ if (range != null) {
+ return range;
+ }
+
+ return null;
+ }
+
+ private LongRange parseAndConvertOffsetSeconds(String offsetSeconds, MediaFile file) {
+ if (offsetSeconds == null) {
+ return null;
+ }
+
+ try {
+ Integer duration = file.getDurationSeconds();
+ Long fileSize = file.getFileSize();
+ if (duration == null || fileSize == null) {
+ return null;
+ }
+ float offset = Float.parseFloat(offsetSeconds);
+
+ // Convert from time offset to byte offset.
+ long byteOffset = (long) (fileSize * (offset / duration));
+ return new LongRange(byteOffset, Long.MAX_VALUE);
+
+ } catch (Exception x) {
+ LOG.error("Failed to parse and convert time offset: " + offsetSeconds, x);
+ return null;
+ }
+ }
+
+ private VideoTranscodingSettings createVideoTranscodingSettings(MediaFile file, HttpServletRequest request) throws ServletRequestBindingException {
+ Integer existingWidth = file.getWidth();
+ Integer existingHeight = file.getHeight();
+ Integer maxBitRate = ServletRequestUtils.getIntParameter(request, "maxBitRate");
+ int timeOffset = ServletRequestUtils.getIntParameter(request, "timeOffset", 0);
+
+ Dimension dim = getRequestedVideoSize(request.getParameter("size"));
+ if (dim == null) {
+ dim = getSuitableVideoSize(existingWidth, existingHeight, maxBitRate);
+ }
+
+ return new VideoTranscodingSettings(dim.width, dim.height, timeOffset);
+ }
+
+ protected Dimension getRequestedVideoSize(String sizeSpec) {
+ if (sizeSpec == null) {
+ return null;
+ }
+
+ Pattern pattern = Pattern.compile("^(\\d+)x(\\d+)$");
+ Matcher matcher = pattern.matcher(sizeSpec);
+ if (matcher.find()) {
+ int w = Integer.parseInt(matcher.group(1));
+ int h = Integer.parseInt(matcher.group(2));
+ if (w >= 0 && h >= 0 && w <= 2000 && h <= 2000) {
+ return new Dimension(w, h);
+ }
+ }
+ return null;
+ }
+
+ protected Dimension getSuitableVideoSize(Integer existingWidth, Integer existingHeight, Integer maxBitRate) {
+ if (maxBitRate == null) {
+ return new Dimension(320, 240);
+ }
+
+ int w, h;
+ if (maxBitRate <= 600) {
+ w = 320; h = 240;
+ } else if (maxBitRate <= 1000) {
+ w = 480; h = 360;
+ } else {
+ w = 640; h = 480;
+ }
+
+ if (existingWidth == null || existingHeight == null) {
+ return new Dimension(w, h);
+ }
+
+ if (existingWidth < w || existingHeight < h) {
+ return new Dimension(even(existingWidth), even(existingHeight));
+ }
+
+ double aspectRate = existingWidth.doubleValue() / existingHeight.doubleValue();
+ w = (int) Math.round(h * aspectRate);
+
+ return new Dimension(even(w), even(h));
+ }
+
+ // Make sure width and height are multiples of two, as some versions of ffmpeg require it.
+ private int even(int size) {
+ return size + (size % 2);
+ }
+
+ /**
+ * Feed the other end with some dummy data to keep it from reconnecting.
+ */
+ private void sendDummy(byte[] buf, OutputStream out) throws IOException {
+ try {
+ Thread.sleep(2000);
+ } catch (InterruptedException x) {
+ LOG.warn("Interrupted in sleep.", x);
+ }
+ Arrays.fill(buf, (byte) 0xFF);
+ out.write(buf);
+ out.flush();
+ }
+
+ public void setStatusService(StatusService statusService) {
+ this.statusService = statusService;
+ }
+
+ public void setPlayerService(PlayerService playerService) {
+ this.playerService = playerService;
+ }
+
+ public void setPlaylistService(PlaylistService playlistService) {
+ this.playlistService = playlistService;
+ }
+
+ public void setSecurityService(SecurityService securityService) {
+ this.securityService = securityService;
+ }
+
+ public void setSettingsService(SettingsService settingsService) {
+ this.settingsService = settingsService;
+ }
+
+ public void setTranscodingService(TranscodingService transcodingService) {
+ this.transcodingService = transcodingService;
+ }
+
+ public void setAudioScrobblerService(AudioScrobblerService audioScrobblerService) {
+ this.audioScrobblerService = audioScrobblerService;
+ }
+
+ public void setMediaFileService(MediaFileService mediaFileService) {
+ this.mediaFileService = mediaFileService;
+ }
+
+ public void setSearchService(SearchService searchService) {
+ this.searchService = searchService;
+ }
+}