Skip to content

Instantly share code, notes, and snippets.

@niko
Forked from ePirat/spec.md
Last active February 28, 2026 11:42
Show Gist options
  • Select an option

  • Save niko/2a1d7b2d109ebe7f7ca2f860c3505ef0 to your computer and use it in GitHub Desktop.

Select an option

Save niko/2a1d7b2d109ebe7f7ca2f860c3505ef0 to your computer and use it in GitHub Desktop.
Icecast Protocol specification

Icecast protocol specification

What is the Icecast protocol?

When speaking of the Icecast protocol here, actually it's just the HTTP protocol, and this document will explain further how source clients need to send data to Icecast.

HTTP PUT based protocol

Since Icecast version 2.4.0 there is support for the standard HTTP PUT method. The mountpoint to which to send the data is specified by the URL path.

Authentication

The authentication is done using HTTP Basic auth. To quickly sum it up how it works: The client needs to send the Authorization header to Icecast, with a value of Basic (for basic authentication) followed by a whitespace and then the username and password separated by a colon : encoded as Base64.

Specifying mountpoint information

The mountpoint itself is specified as the path part of the URL.
Additional mountpoint information can be set using specific (non-standard) HTTP headers:

ice-public : For a mountpoint that doesn't has <public> configured, this influences if the mountpoint shoult be advertised to a YP directory or not. Value can either be 0 (not public) or 1 (public).

ice-name : For a mountpoint that doesn't has <stream-name> configure, this sets the name of the stream.

ice-description : For a mountpoint that doesn't has <stream-description> configure, this sets the description of the stream.

ice-url : For a mountpoint that doesn't has <stream-url> configure, this sets the URL to the Website of the stream. (This should not be the Server or mountpoint URL)

ice-genre : For a mountpoint that doesn't has <genre> configure, this sets the genre of the stream.

ice-bitrate : This sets the bitrate of the stream.

ice-audio-info : A Key-Value list of audio information about the stream, using = as separator between key and value and ; as separator of the Key-Value pairs. Values must be URL-encoded if necessary. Example: samplerate=44100;quality=10%2e0;channels=2

Content-Type : Indicates the content type of the stream, this must be set.

Sending data

Data is sent as usual in the body of the request, but it has to be sent at the right timing. This means if the source client sends data to Icecast that is already completely avaliable, it may not sent all the data right away, else Icecast will not be able to keep up. The source client is expected to sent the data as if it is live. Another important thing to note is that Icecast currently doesn't support chunked transfer encoding!

Error codes

Icecast reponds with valid HTTP Status codes, and a message, indicating what was wrong in case of error. In case of success it sends status code 200 with message OK. Below there is a full list of status codes and possible errors.

200 OK : Everything ok

100 Continue : This is sent in case a Request: 100-continue header was sent by the client and everything is ok. It indicates that the client can go on and send data.

401 You need to authenticate : No auth information sent or credentials wrong.

403 Content-type not supported : The supplied Content-Type is not supported by Icecast.

403 No Content-type given : There was no Content-Type given. The source client is required to send a Content-Type.

403 internal format allocation problem : There was a problem allocating the format handler, this is an internal Icecast problem.

403 too many sources connected : The configured source client connection limit was reached and no more source clients can connect at the moment.

403 Mountpoint in use : The mountpoint the client tried to connect too is already used by another client.

500 Internal Server Error : An internal Icecast error happened, there is nothing that the client can do about it.

If anything goes wrong, the source client should show a helpful error message to the user, so that he knows what happened. Do not shows generic messages like "An error has occured" or "Connection to Icecast failed" if it is possible to provide more details. For example, a good error message for 403 Mountpoint in use would be: "Couldn't connect to Icecast, because the specified mountpoint is already in use."

HTTP SOURCE based protocol

Older Icecast servers prior to 2.4.0 used a custom HTTP method for source clients, called SOURCE. It is nearly equal to the above described PUT method, but doesn't has support for the 100-continue header. The SOURCE method is deprecated since 2.4.0 and should not be used anymore. It will propably be removed in a future version.

Which method to use

Since the old SOURCE method is deprecated, a client should try both, first PUT and then fall back to SOURCE if the PUT method doesn't work. In case of the PUT method being used with older Icecast versions that do not support it (< 2.4.0), Icecast will return an empty reply, this means, no status code or headers or body is sent.

@norohind
Copy link

norohind commented Jan 7, 2023

Thanks for code example!

@angrycoding
Copy link

Thank you very much for it :)

Copy link

ghost commented May 8, 2023

Thank you for this!

@MrJake222
Copy link

best!

@vvvin333
Copy link

I think there is an error:

02StreamTitle='A nice song';StreamUrl=''00000       <- padded with 0-bytes<- padded with 0-bytes up to 2*32 bytes of metadata

should be

... 2*16 bytes of metadata

@niko
Copy link
Author

niko commented Oct 31, 2024

I think you're right. I'll correct it.

@vvvin333
Copy link

vvvin333 commented Nov 12, 2024

@niko I have slightly reverse goal: to write streamed data (audio bytes with meta data inserted) in this format for standard audio player (for React Native). https://stackoverflow.com/a/79147248/15080117
Are there any hidden logic I am missing?
In particular, should meta with 0 length (00 byte) be included in the 16-bytes block length or no (in your explanation: we place zero byte and 16k audio just after it)?
And I have some doubts if we should include length-byte into 16n-padded block (see). Even on your sample it looks like there is additional 00 byte in the next row:

00000020  56 69 65 72 20 2d 20 52  65 69 63 68 27 3b 00 00  |Vier - Reich';..|
00000030  00 <---

If so, it would be better to picture the schema in the following way:

02
StreamTitle='A nice song';000000 <--- 16*2 zero-padded meta

@niko
Copy link
Author

niko commented Nov 12, 2024

Thanks for the image. That's also the answer to your question: The length byte has to be included in any case. If it's 0 the next audio block follows right after.

I wish I could include the image here. Where did you find it?

The additional 00 in the next line seems to be part of the audio in that case as StreamTitle='Die Fantastischen Vier - Reich'; is 46 bytes, so only two zero-bytes are needed for padding to fill up to 48 bytes which the 03 length byte indicates.

@vvvin333
Copy link

I wish I could include the image here. Where did you find it?

https://thecodeartist.blogspot.com/2013/02/shoutcast-internet-radio-protocol.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment