Package Exports

beamengine

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (beamengine) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Aerostat Beam Engine

Redis-backed highly-scale-able and cloud-fit media beam engine. Aerostat Beam Engine provides the following:

A resilient media-aware cache of media data structured ready for processing by FFmpeg libraries that can be backed by file or object stores;
Stateless clients providing access to the cache through the Content Beam API, an HTTP/S API for transporting media data, pushed and pulled, compressed or uncompressed;
Job queues allowing multiple worker clients to carry out media transformations just-in-time, on the local systems, distributed across other nodes or via serverless compute like AWS Lambda.

The engine comes in the form of a web server application that provides access to read and write data stored in the underlying Redis cache, which may be a single Redia instance or a cluster of master/slave Redis instances. Also included are some extendible worker clients, supporting clients and the ability to trigger work based on some simple rules.

This is an implementation of the core of the Agile Media Blueprint.

Work in progress. For Node.js FFmpeg native bindings, please see Aerostat Beam Coder.

Installation

Configuration

Configuration of an Aerostat Beam Engine is achieved by editing the config.json file.

Content Beam API

The content beam API allows FFmpeg-style media data structures to be transported over HTTP and HTTPS protocols. This allows streams of related media - a virtual format or logical cable - to be moved for processing, storage or presentation, either streamed in order or worked on in parallel. Assuming backing by a cache, live streams can be stored and retrieved with little delay - recorded and played back - with a mechanism to start streaming at the latest frame. Endpoints can host the content they represent as content beams through a pull-based mechanism or push media to other endpoints.

All content beam API requests start with /beams/. The content beam API for HTTP breaks down as:

/beams/⟨content_name⟩/⟨stream_name⟩/⟨media_ref⟩/⟨data_ref⟩

content_name: a reference to the source of the content and is set be default to the url property of the underlying format context (encoded to safe representation for use in the path part of a URL). This is a unique name for the content that can be beamed from this endpoint.
stream_name: .
media_ref: .
data_ref: .

Listing available content

Format - the logical cable

Workers

Setting up a rule

Pre-built workers

Writing a worker

Status, support and further development

Although the architecture of the aerostat beam engine is such that it could be used at scale in production environments, development is not yet complete. In its current state, it is recommended that this software is used in development environments and for building prototypes. Future development will make this more appropriate for production use.

Contributions can be made via pull requests and will be considered by the author on their merits. Enhancement requests and bug reports should be raised as github issues. For support, please contact Streampunk Media.

License

This software links to libraries from the FFmpeg project, including optional parts and optimizations covered by the GPL v2.0 or later. Your attention is drawn to the FFmpeg project's page FFmpeg License and Legal Considerations.