#30 - WIP on the shoutcast v2 protocol

This commit is contained in:
Denny
2016-09-14 06:07:21 -04:00
parent 2537a71375
commit 6138838d60
18 changed files with 302 additions and 39 deletions

View File

@@ -0,0 +1,183 @@
/*******************************************************************************
* sdrtrunk
* Copyright (C) 2014-2016 Dennis Sheirer
*
* This program 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.
*
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>
*
******************************************************************************/
package audio.broadcast.shoutcast.v2;
import audio.broadcast.BroadcastConfiguration;
import audio.broadcast.BroadcastFormat;
import audio.broadcast.BroadcastServerType;
public class ShoutcastV2Configuration extends BroadcastConfiguration
{
private String mMountPoint;
private String mStreamName;
private String mSongTitle;
private String mGenre;
private boolean mPublic;
private int mChannels;
private int mBitRate;
private String mURL;
public ShoutcastV2Configuration(BroadcastFormat format)
{
super(format);
}
@Override
public BroadcastServerType getBroadcastServerType()
{
return BroadcastServerType.SHOUTCAST_V1;
}
public String getMountPoint()
{
return mMountPoint;
}
/**
* Sets the optional mount point. Shoutcast v1.x servers don't require a mount point, but v2.x servers do require
* the mount point.
*
* Note: if the supplied mount point contains a leading slash (/) it will be removed.
*
* @param mountPoint
*/
public void setMountPoint(String mountPoint)
{
//Strip the leading slash from the mount point if the user supplies it
mMountPoint = mountPoint.replace("/", "");
}
/**
* Stream name
*/
public String getStreamName()
{
return mStreamName;
}
/**
* Sets the stream name
* @param name
*/
public void setStreamName(String name)
{
mStreamName = name;
}
/**
* Song title
*/
public String getSongTitle()
{
return mSongTitle;
}
/**
* Set the song title
*/
public void setSongTitle(String title)
{
mSongTitle = title;
}
/**
* Stream genre
*/
public String getGenre()
{
return mGenre;
}
/**
* Stream genre
* @param genre
*/
public void setGenre(String genre)
{
mGenre = genre;
}
/**
* Public visibility of the broadcast
*/
public boolean isPublic()
{
return mPublic;
}
/**
* Sets public visibility of the broadcast
* @param isPublic indicates if the broadcast should be visible to the public
*/
public void setPublic(boolean isPublic)
{
mPublic = isPublic;
}
/**
* Number of audio channels in the broadcast
*/
public int getChannels()
{
return mChannels;
}
/**
* Sets the number of audio channels in the broadcast
*/
public void setChannels(int channels)
{
mChannels = channels;
}
/**
* Bit rate in bits per second
*/
public int getBitRate()
{
return mBitRate;
}
/**
* Bit rate
* @param bitRate in samples per second
*/
public void setBitRate(int bitRate)
{
mBitRate = bitRate;
}
/**
* URL associated with the broadcast where users can find additional details.
*/
public String getURL()
{
return mURL;
}
/**
* URL associated with the broadcast where users can find additional details.
* @param url
*/
public void setURL(String url)
{
mURL = url;
}
}

View File

@@ -0,0 +1,157 @@
/*******************************************************************************
* sdrtrunk
* Copyright (C) 2014-2016 Dennis Sheirer
*
* This program 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.
*
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>
*
******************************************************************************/
package audio.broadcast.shoutcast.v2;
import bits.BinaryMessage;
import com.sun.org.apache.regexp.internal.RE;
public abstract class UltravoxMessage
{
public static final int[] SYNC = {0,1,2,3,4,5,6,7};
public static final int[] RESERVED = {8,9,10,11};
public static final int REQUIRED_DELIVERY = 12;
public static final int[] SEND_QUEUE_PRIORITY = {13,14,15};
public static final int[] MESSAGE_CLASS = {16,17,18,19};
public static final int[] MESSAGE_CLASS_AND_TYPE = {16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31};
public static final int[] PAYLOAD_LENGTH = {32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47};
private BinaryMessage mMessage;
/**
* Constructs a message from the byte array
*/
public UltravoxMessage(byte[] data)
{
mMessage = new BinaryMessage(data);
}
/**
* Constructs an empty message of the specified length
*
* @param ultravoxMessageType type of message
* @param length of message in bits (64 minimum)
*/
public UltravoxMessage(UltravoxMessageType ultravoxMessageType, int length)
{
assert(length >= 64);
mMessage = new BinaryMessage(length);
setSync();
setMessageType(ultravoxMessageType);
}
/**
* Sets the message sync bits to the predefined sync pattern: 01011010 (0x5A)
*/
private void setSync()
{
mMessage.setInt(0x5A, SYNC);
}
/**
* Ultravox message class
*/
public UltravoxMessageClass getMessageClass()
{
return UltravoxMessageClass.fromValue(mMessage.getInt(MESSAGE_CLASS));
}
/**
* Ultravox message type
* @return
*/
public UltravoxMessageType getMessageType()
{
return UltravoxMessageType.fromValue(mMessage.getInt(MESSAGE_CLASS_AND_TYPE));
}
/**
* Sets the message bits according to the message class and type
* @param messageType of ultravox message
*/
private void setMessageType(UltravoxMessageType messageType)
{
mMessage.setInt(messageType.getValue(), MESSAGE_CLASS_AND_TYPE);
}
/**
* Indicates if this message has the required delivery flag set
*/
public boolean isRequiredDelivery()
{
return mMessage.get(REQUIRED_DELIVERY);
}
/**
* Sets the required delivery flag according to the argument
*/
public void setRequiredDelivery(boolean required)
{
if(required)
{
mMessage.set(REQUIRED_DELIVERY);
}
else
{
mMessage.clear(REQUIRED_DELIVERY);
}
}
/**
* Send queue priority (0 - 7) for this message
*/
public int getSendQueuePriority()
{
return mMessage.getInt(SEND_QUEUE_PRIORITY);
}
/**
* Sets send queue priority for this message
* @param priority 0 - 7
*/
public void setSendQueuePriority(int priority)
{
assert(0 <= priority && priority <= 7);
mMessage.setInt(priority, SEND_QUEUE_PRIORITY);
}
/**
* Message payload
*/
public String getPayload()
{
//TODO: parse payload field
return null;
}
/**
* Sets the message payload, updates the message length field, and appends a trailing 0x00 byte after the payload.
*/
public void setPayload(String payload)
{
//TODO: implement payload, along with trailing 0x00 byte and update overall payload size field.
}
private void setPayloadLength(int length)
{
//TODO: correctly size the message to payload + 1 byte and set the payload length field
}
}

View File

@@ -0,0 +1,57 @@
/*******************************************************************************
* sdrtrunk
* Copyright (C) 2014-2016 Dennis Sheirer
*
* This program 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.
*
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>
*
******************************************************************************/
package audio.broadcast.shoutcast.v2;
public enum UltravoxMessageClass
{
OPERATIONS(0x0),
BROADCASTER(0x1),
LISTENER(0x2),
CACHEABLE_METADATA_1(0x3),
CACHEABLE_METADATA_2(0x4),
PASS_THROUGH_METADATA_1(0x5),
PASS_THROUGH_METADATA_2(0x6),
ENCODED_DATA(0x7),
ADVANCED_ENCODED_DATA(0x8),
FRAMED_DATA(0x9),
CACHEABLE_BINARY_METADATA(0xA),
UNKNOWN(0xF);
private int mValue;
private UltravoxMessageClass(int value)
{
mValue = value;
}
public int getValue()
{
return mValue;
}
public static UltravoxMessageClass fromValue(int value)
{
if(0x0 <= value && value <= 0xA)
{
return values()[value];
}
return UNKNOWN;
}
}

View File

@@ -0,0 +1,49 @@
/*******************************************************************************
* sdrtrunk
* Copyright (C) 2014-2016 Dennis Sheirer
*
* This program 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.
*
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>
*
******************************************************************************/
package audio.broadcast.shoutcast.v2;
public enum UltravoxMessageType
{
AUTHENTICATE_BROADCAST(0x1001),
UNKNOWN(0x0000);
private int mValue;
private UltravoxMessageType(int value)
{
mValue = value;
}
public int getValue()
{
return mValue;
}
public static UltravoxMessageType fromValue(int value)
{
switch(value)
{
case 0x1001:
return AUTHENTICATE_BROADCAST;
default:
return UNKNOWN;
}
}
}