openradio

A simple live streaming library written in JavaScript with ffmpeg.

This library require ffmpeg to be installed in your system/container.

Documentation

module(options)

A function to create a new broadcaster. Return stream.Duplex.

Options

• format The radio audio format. Default is mp3.
• rate Radio audio samplerate. Default is 44100.
• channels Radio audio channels. Default is 2.
• bitrate Radio audio bitrate. Default is 192.
• acodec Radio audio codec. Default is mp3.

Functions

• play(ReadableStream) A function to play audio from ReadableStream or "string". A string could be a URL, or file path.
• playPCM(ReadableStream, options) A function to play PCM audio from ReadableStream or "string". A string could be a URL, or Filepath. A options include:

1. rate The PCM audio bitrate. The default is 44100.
2. channels The PCM audio channels. The default is 2.

Objects

• stream The source of current audio. Return ReadableStream.
• header The radio buffer header.

Events

Some of events from stream.Duplex also included here.

• error A event that emit some error when occured.
• finish A event that emit when finished playing the current song.

module.video(options, rtmp_url)

Just like the main function, But instead of audio, It's for broadcasting Video.

• rtmp_url RTMP url to stream.

Options

• format Radio video format. Default is mpegts.
• vcodec Radio video codec. This is different from format option. Default is mpeg2video.
• arate Radio video audio samplerate. Default is 44100.
• achannels Radio video audio channels. Default is 2.
• abitrate Radio video audio bitrate. Default is 192.
• acodec Radio video audio codec. Default is aac.
• scale Radio video scale. Default is -1:720 means the output video will have a width of 720px and the height will be set based on the ratio of the original video.

Functions

• play(ReadableStream) A function to play video from ReadableStream or "string". A string could be a URL, or file path.

Events

Some of events from stream.Duplex also included here.

• error A event that emit some error when occured.
• finish A event that emit when finished playing the current video.

Objects

Same as the main function.

module.repeater(radio)

Simply a repeater for ReadableStream. Suitable when you face some performance issue in single duplex. Return a function.

const fs = require("fs");
const openradio = require("openradio");
const radio = openradio(); // Broadcaster
const repeater = openradio.repeater(radio); // Create a repeater of "radio" duplex.

// The repeater is responsible in writting incomming buffer from "radio" duplex
// for multiple WriteableStream at the same time without decreasing the duplex performance.

let r1 = repeater(fs.createWriteStream("stream1.mp3"));
let r2 = repeater(fs.createWriteStream("stream2.mp3"));
let r3 = repeater(fs.createWriteStream("stream3.mp3"));

// Assume that we're enough writting buffers to fs.createWriteStream("stream2.mp3")
// And so we're gonna stop writting.
r2();

// Even though the repeater stop writting, It's WriteableStream is not ended.
// So you need to end them manually.

Example

See example folder

Community

• Telegram
• #yonle at irc.lecturify.net.

License

Copyright 2023 Yonle [e-mail]

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.