Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jprjr/icecast-hls

A tool to take Icecast streams and re-encode into HLS
https://github.com/jprjr/icecast-hls

hls hls-live-streaming http-live-streaming icecast shoutcast

Last synced: 16 days ago
JSON representation

A tool to take Icecast streams and re-encode into HLS

Awesome Lists containing this project

README

        

# icecast-hls

This is a program that accepts an Icecast stream and re-encodes it
into 1 or more HLS streams.

It's main use is with chained Ogg streams with FLAC audio, which
allows for in-band metadata, images, etc. It can also work with any
other format + codec supported by libavformat/libavcodec - though using
a lossless source like FLAC is preferred.

Everything is implemented as a plugin - decoding can be done
via different plugins, encoding done via plugins, muxing done
via plugins.

The HLS streams can use either packed audio, fragmented MP4, or MPEG-TS.
The main benefit to fragmented MP4 is having a wider range of codecs
available, and the ability to encode loudness metadata. All formats
allow adding timed ID3 metadata.

## Features

* Reads from standard input, files, and URLs via libCURL.
* Parses Icecast/Shoutcast metadata.
* Writes to standard output, files, folders, and URLs,
including [S3-compatible storage](https://github.com/jprjr/icecast-hls/wiki/Plugins:-Output#aws-default-false)
* Special support for chained [Ogg FLAC](https://github.com/jprjr/icecast-hls/wiki/Misc:-Tips#ogg-chaining-with-flac).
* this allows rich in-band metadata and images.
* Apply filters with [libavfilter](https://ffmpeg.org/ffmpeg-filters.html)
* Multi-threaded encoding.
* Customizable [tag mapping](https://github.com/jprjr/icecast-hls/wiki/Configuration-Reference#tagmaps).
* Encoder plugins for:
* [exhale](https://gitlab.com/ecodis/exhale) (USAC Audio)
* [fdk-aac](https://github.com/mstorsjo/fdk-aac) (AAC, HE-AAC/V2)
* [libavcodec](https://ffmpeg.org/ffmpeg-codecs.html) (AAC, MP3, (E)-AC-3, FLAC, ALAC, Opus)
* [libopus](https://www.opus-codec.org/) (Opus audio)
* Output to HLS using packed audio, fragmented MP4, or MPEG-TS.
* Output to Icecast using AAC, MP3, Opus, and FLAC.
* Embed timed ID3 metadata.
* Embed album art (either in-band or as a linked image).

## Documentation

I've tried to write as extensive documentation as possible as
a [wiki](https://github.com/jprjr/icecast-hls/wiki/Documentation).
It includes details on every plugin and its options, as well as tips
on how to produce chained Ogg streams with FLAC audio.

Release tarballs will include an offline copy of the wiki in the `docs`
folder. There will be a pre-generated, standalone HTML file, as well
as the original wiki content in Markdown format.

## License

MIT, see the file `LICENSE`.

Some files are third-party and have their own licensing:

* `src/base64decode.h`: Public Domain.
* `src/base64encode.h`: BSD 3-Clause License
* `src/miniflac.h`: BSD Zero Clause License.
* `src/minifmp4.h`: BSD Zero Clause License.
* `src/miniogg.h`: BSD Zero Clause License.
* `src/ini.h`: New BSD License.
* `src/thread.h`: Public Domain.