<commit_before>node-icecast
============
### NodeJS module for parsing and/or injecting metadata into SHOUTcast/Icecast radio streams

This module offers a `Reader` classe for retrieving the raw audio data and
parsing the metadata from a [SHOUTcast][] or [Icecast][] broadcast.

There's also a `Writer` class that allows you to inject your own metadata into a
data stream, which can then be displayed by another Icecast client (like VLC).

But you'll probably be most interested in the `Client` class that builds off of
node's core `http` module, except this version works with servers that return
an **ICY** HTTP version, and automatically sends an "Icy-MetaData: 1" HTTP header
to notify the server that we want metadata, and finally it returns a `Reader`
instance in the "response" event, therefore the "res" object also emits "metadata"
events. See the example below to see how it works.

A good use case for this module is for HTML5 web apps that host to radio streams;
the `<audio>` tag doesn't know how to deal with the extra metadata and it is
impossible to extract (on the client-side). But a WebSocket connection could be
used in conjunction with this module to provide those `metadata` events to a
web browser, for instance.

Installation
------------

Install with `npm`:

``` bash
$ npm install icecast
```


Example<commit_msg>README++<commit_after>node-icecast
============
### NodeJS module for parsing and/or injecting metadata into SHOUTcast/Icecast radio streams

This module offers a `Reader` class for retrieving the raw audio data and
parsing the metadata from a [SHOUTcast][] or [Icecast][] broadcast.

There's also a `Writer` class that allows you to inject your own metadata into a
data stream, which can then be displayed by another Icecast client (like VLC).

But you'll probably be most interested in the `Client` class that builds off of
node's core `http` module, except this version works with servers that return
an **ICY** HTTP version, and automatically sends an "Icy-MetaData: 1" HTTP header
to notify the server that we want metadata, and finally it returns a `Reader`
instance in the "response" event, therefore the "res" object also emits "metadata"
events. See the example below to see how it works.

A good use case for this module is for HTML5 web apps that host to radio streams;
the `<audio>` tag doesn't know how to deal with the extra metadata and it is
impossible to extract (on the client-side). But a WebSocket connection could be
used in conjunction with this module to provide those `metadata` events to a
web browser, for instance.

Installation
------------

Install with `npm`:

``` bash
$ npm install icecast
```


Example
{'fraction_non_alphanumeric': 0.07772795216741404, 'fraction_numerical': 0.0014947683109118087, 'mean_word_length': 4.496919917864476, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1806172', 'n_tokens_mistral': 709, 'n_tokens_neox': 673, 'n_words': 411}