SHOUTcast 2 (Ultravox 2.1) Protocol Details - Revision history

DrO at 22:57, 28 October 2014

2014-10-28T22:57:21Z

DrO: Add Stream Moved as a response from the standby message (makes it easier for clients to know they've been rejected when the stream is marked as having been moved)

2012-08-27T16:28:12Z

Add Stream Moved as a response from the standby message (makes it easier for clients to know they've been rejected when the stream is marked as having been moved)

DrO: Add Stream In Use as a response from the standby message (makes it easier for clients to know they've been rejected)

2012-01-12T17:09:08Z

Add Stream In Use as a response from the standby message (makes it easier for clients to know they've been rejected)

DrO: Missing spaces

2011-12-18T23:56:58Z

Missing spaces

DrO: Clarify limits of Metadata ID

2011-12-18T23:31:09Z

Clarify limits of Metadata ID

DrO: Protected "SHOUTcast 2 (Ultravox 2.1) Protocol Details" [edit=sysop:move=sysop]

2011-08-22T22:42:03Z

Protected "SHOUTcast 2 (Ultravox 2.1) Protocol Details" [edit=sysop:move=sysop]

DrO: Tweaked information about the “server” aspect for listener responses so it is clearer what information can be returned

2011-07-31T12:22:39Z

Tweaked information about the “server” aspect for listener responses so it is clearer what information can be returned

Newacct at 04:16, 9 June 2011

2011-06-09T04:16:52Z

DrO: Fixed / being in the wrong place with the listen request example

2011-04-12T16:55:11Z

Fixed / being in the wrong place with the listen request example

DrO: Added changes relating to stream id auth handling

2011-03-25T19:00:40Z

Added changes relating to stream id auth handling

← Older revision		Revision as of 22:57, 28 October 2014
Line 1:		Line 1:
		+	{{Template:NavBarSC}}
		+
		+
	==Overview==		==Overview==

@@ Line 379: / Line 379: @@
 |-
 | “Stream ID Error” || The stream identifier is out of the supported range (1 - 2147483647).
 |}

@@ Line 634: / Line 634: @@
 |-
 | “Configuration Error” || The configuration is not complete.
 |}

@@ Line 781: / Line 781: @@
    Message Class – 0x3 or 0x4
    Message Type - <metadata type>
-   Payload–[Metadata ID][Metadata Span][Metadata Index][metadata]
+   Payload – [Metadata ID][Metadata Span][Metadata Index][metadata]
    [Metadata ID] (16bits) - Used to identify a metadata set for when metadata is split across multiple Ultravox messages (numeric, minimum 1, maximum 32).
    [Metadata Span] (16 bits) - the number of messages comprising the complete metadata package (numeric, minimum 1, maximum 32).

@@ Line 782: / Line 782: @@
    Message Type - <metadata type>
    Payload–[Metadata ID][Metadata Span][Metadata Index][metadata]
-   [Metadata ID] (16bits) - Used to identify a metadata set for when metadata is split across multiple Ultravox messages.
+   [Metadata ID] (16bits) - Used to identify a metadata set for when metadata is split across multiple Ultravox messages (numeric, minimum 1, maximum 32).
    [Metadata Span] (16 bits) - the number of messages comprising the complete metadata package (numeric, minimum 1, maximum 32).
    [Metadata Index] (16 bits) - the ordinal identification of this message within the metadata package (numeric, minimum 1, maximum 32).

← Older revision	Revision as of 22:42, 22 August 2011
(No difference)

@@ Line 846: / Line 846: @@
    HTTP/1.1 200 OK\r\n
-   Server: Ultravox/2.1 SHOUTcast 2.0\r\n
+   Server:Ultravox/2.1 SHOUTcast v2.0.0.29\r\n
-   ContentType: misc/ultravox\r\n
+   ContentType:misc/ultravox\r\n
-   icy-pub: <public flag>\r\n
+   icy-pub:<public flag>\r\n
-   Ultravox-Bitrate: <stream bitrate>\r\n
+   Ultravox-Bitrate:<stream bitrate>\r\n
-   Ultravox-Title: <stream title>\r\n
+   Ultravox-Title:<stream title>\r\n
    Ultravox-Genre:<stream genre>\r\n
    Ultravox-URL:<broadcaster url>\r\n
-   Ultravox-Max-Msg: <negotiated max payload size>\r\n
+   Ultravox-Max-Msg:<negotiated max payload size>\r\n
-   Ultravox-Class-Type: <class-type>\r\n
+   Ultravox-Class-Type:<class-type>\r\n
 where the “negotiated max payload size”, “stream title”, “stream bitrate”, and “class-type” are populated based on the values provided during broadcast negotiation.
 class-type is a hexadecimal representation like “7000” for an MP3 (audio/mpeg) stream.

@@ Line 258: / Line 258: @@
    // key is always 128 bits
-   while(key.size() < 16) key.push_back(XTEA_KEY_PAD); // pad key with zero
+   if(key.size() < 16) key.resize(16, XTEA_KEY_PAD); // pad key with zero
    __uint32 k[4] = { fourCharsToLong(&key[0]),fourCharsToLong(&key[4]),
                      fourCharsToLong(&key[8]),fourCharsToLong(&key[12])
@@ Line 265: / Line 265: @@
    // data is multiple of 64 bits
    size_t siz = data.size();
-   while(siz % 8) { siz+=1; data.push_back(XTEA_DATA_PAD);} // pad data with zero
+   if(siz % 8) { siz+= 8 - siz % 8; data.resize(siz, XTEA_DATA_PAD);} // pad data with zero
    for(size_t x = 0; x < siz; x+=8)
@@ Line 275: / Line 275: @@
      oss << setw(8) << setfill('0') << hex << v[0];
      oss << setw(8) << setfill('0') << hex << v[1]; // hex values.
-     // uvox uses colon as seperator so we can't use chars for fear of collision
+     // uvox uses colon as separator so we can't use chars for fear of collision
+   }
    return oss.str();
@@ Line 289: / Line 289: @@
    // key is always 128 bits
-   while(key.size() < 16) key.push_back(XTEA_KEY_PAD); // pad key with zero
+   if(key.size() < 16) key.resize(16, XTEA_KEY_PAD); // pad key with zero
    __uint32 k[4] = { fourCharsToLong(&key[0]),fourCharsToLong(&key[4]),
                      fourCharsToLong(&key[8]),fourCharsToLong(&key[12])
@@ Line 297: / Line 297: @@
    size_t siz = data.size();
    assert(!(siz % 16)); // should never happen if data is good
-   while(siz % 16) { siz+=1; data.push_back('0');} // pad data with zero
+   if(siz % 16) { siz+= 8 - siz % 8; data.resize(siz, '0');} // pad data with zero
    for(size_t x = 0; x < siz; x+=16)

@@ Line 347: / Line 347: @@
    Payload – <Version>:<SID>:<UID>:<AuthBlob><NUL>
    <Version> - protocol version number (required, numeric, non-zero, maximum 255).  The current version is 2.1.
-   <SID> - stream identifier (required, numeric, non-zero, maximum 4294967295).
+   <SID> - stream identifier (required, numeric, non-zero, maximum 2147483647).
    <UID> - user identifier (required, XTEA encoded).
    <AuthBlob> - authentication information (required, XTEA encoded).
@@ Line 377: / Line 377: @@
 |-
 | “Version Error” || The version is greater than what is supported.
 |}