chameleon.playlist.m3u.M3UProvider Maven / Gradle / Ivy
The newest version!
/*
* Copyright (c) 2008, Christophe Delory
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY CHRISTOPHE DELORY ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL CHRISTOPHE DELORY BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package chameleon.playlist.m3u;
import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.List;
import java.util.Locale;
import org.apache.commons.logging.Log;
import chameleon.content.type.ContentType;
import chameleon.player.PlayerSupport;
import chameleon.playlist.AbstractPlaylistComponent;
import chameleon.playlist.Media;
import chameleon.playlist.Parallel;
import chameleon.playlist.Playlist;
import chameleon.playlist.Sequence;
import chameleon.playlist.SpecificPlaylist;
import chameleon.playlist.SpecificPlaylistProvider;
/**
* A simple text-based list of the locations of the items, with each item on a new line.
* @version $Revision: 91 $
* @author Christophe Delory
*/
public class M3UProvider implements SpecificPlaylistProvider
{
/**
* A list of compatible content types.
*/
private static final ContentType[] FILETYPES =
{
new ContentType(new String[] { ".m3u" },
new String[] { "audio/x-mpegurl", "audio/mpegurl" },
new PlayerSupport[]
{
new PlayerSupport(PlayerSupport.Player.WINAMP, true, null),
new PlayerSupport(PlayerSupport.Player.VLC_MEDIA_PLAYER, true, null),
new PlayerSupport(PlayerSupport.Player.WINDOWS_MEDIA_PLAYER, true, null),
new PlayerSupport(PlayerSupport.Player.MEDIA_PLAYER_CLASSIC, true, null),
new PlayerSupport(PlayerSupport.Player.FOOBAR2000, true, null),
new PlayerSupport(PlayerSupport.Player.MPLAYER, true, null),
new PlayerSupport(PlayerSupport.Player.QUICKTIME, true, null),
new PlayerSupport(PlayerSupport.Player.ITUNES, true, null),
new PlayerSupport(PlayerSupport.Player.REALPLAYER, false, null),
},
"Winamp M3U"),
new ContentType(new String[] { ".m3u8" },
new String[] { "audio/x-mpegurl", "audio/mpegurl" },
new PlayerSupport[]
{
new PlayerSupport(PlayerSupport.Player.WINAMP, true, null),
new PlayerSupport(PlayerSupport.Player.FOOBAR2000, true, null),
},
"Winamp M3U8"),
new ContentType(new String[] { ".m4u" },
new String[] { "video/x-mpegurl" },
new PlayerSupport[]
{
},
"M4U Playlist"),
new ContentType(new String[] { ".ram" },
new String[] { "audio/vnd.rn-realaudio", "audio/x-pn-realaudio" },
new PlayerSupport[]
{
new PlayerSupport(PlayerSupport.Player.MEDIA_PLAYER_CLASSIC, false, null),
new PlayerSupport(PlayerSupport.Player.REALPLAYER, false, null),
},
"Real Audio Metadata (RAM)"),
};
@Override
public String getId()
{
return "m3u";
}
@Override
public ContentType[] getContentTypes()
{
return FILETYPES.clone();
}
@Override
public SpecificPlaylist readFrom(final InputStream in, final String encoding, final Log logger) throws Exception
{
String enc = encoding;
if (enc == null)
{
enc = "UTF-8"; // For the M3U8 case. FIXME US-ASCII?
}
final BufferedReader reader = new BufferedReader(new InputStreamReader(in, enc)); // Throws NullPointerException if in is null. May throw UnsupportedEncodingException, IOException.
final M3U ret = new M3U();
ret.setProvider(this);
String line;
String songName = null;
String songLength = null;
while ((line = reader.readLine()) != null) // May throw IOException.
{
line = line.trim();
if (line.length() > 0)
{
final char firstChar = line.charAt(0); // Shall not throw IndexOutOfBoundsException.
// Exclude what looks like an XML file, or a Windows .ini file.
// Files or URLs "usually" don't begin with such characters.
if ((firstChar == '<') || (firstChar == '['))
{
throw new IllegalArgumentException("Doesn't seem to be a M3U playlist (and related ones)");
}
else if (firstChar == '#')
{
if (line.toUpperCase(Locale.ENGLISH).startsWith("#EXTINF"))
{
final int indA = line.indexOf(',', 0);
if (indA >= 0) // NOPMD Deeply nested if then statement
{
songName = line.substring(indA + 1, line.length());
}
final int indB = line.indexOf(':', 0);
if ((indB >= 0) && (indB < indA)) // NOPMD Deeply nested if then statement
{
songLength = line.substring(indB + 1, indA).trim();
}
}
// Otherwise ignore the comment.
// In particular VLC directives "EXTVLCOPT:=" are ignored.
// The same applies to #EXTART for album artist and #EXTALB for album title.
}
else
{
final Resource resource = new Resource(); // NOPMD Avoid instantiating new objects inside loops
resource.setLocation(line);
resource.setName(songName); // songName may be null.
if (songLength != null)
{
resource.setLength(Long.parseLong(songLength)); // May throw NumberFormatException.
}
ret.getResources().add(resource);
songName = null;
songLength = null;
}
}
}
return ret;
}
@Override
public SpecificPlaylist toSpecificPlaylist(final Playlist playlist) throws Exception
{
final M3U ret = new M3U();
ret.setProvider(this);
addToPlaylist(ret.getResources(), playlist.getRootSequence()); // May throw Exception.
return ret;
}
/**
* Adds the resources referenced in the specified generic playlist component to the input list.
* @param resources the resulting list of resources. Shall not be null.
* @param component the generic playlist component to handle. Shall not be null.
* @throws NullPointerException if resources is null.
* @throws NullPointerException if component is null.
* @throws Exception if this service provider is unable to represent the input playlist.
*/
private void addToPlaylist(final List resources, final AbstractPlaylistComponent component) throws Exception
{
if (component instanceof Sequence)
{
final Sequence seq = (Sequence) component;
if (seq.getRepeatCount() < 0)
{
throw new IllegalArgumentException("A M3U playlist cannot handle a sequence repeated indefinitely");
}
final AbstractPlaylistComponent[] components = seq.getComponents();
for (int iter = 0; iter < seq.getRepeatCount(); iter++)
{
for (AbstractPlaylistComponent c : components)
{
addToPlaylist(resources, c); // May throw Exception.
}
}
}
else if (component instanceof Parallel)
{
throw new IllegalArgumentException("A parallel time container is incompatible with a M3U playlist");
}
else if (component instanceof Media)
{
final Media media = (Media) component;
if (media.getDuration() != null)
{
throw new IllegalArgumentException("A M3U playlist cannot handle a timed media");
}
if (media.getRepeatCount() < 0)
{
throw new IllegalArgumentException("A M3U playlist cannot handle a media repeated indefinitely");
}
if (media.getSource() != null)
{
for (int iter = 0; iter < media.getRepeatCount(); iter++)
{
final Resource resource = new Resource(); // NOPMD Avoid instantiating new objects inside loops
resource.setLocation(media.getSource().toString());
if (media.getSource().getDuration() >= 0L)
{
resource.setLength((media.getSource().getDuration() + 999L) / 1000L);
}
resources.add(resource); // Shall not throw UnsupportedOperationException, ClassCastException, NullPointerException, IllegalArgumentException.
}
}
}
}
}