encoder

A simple microservice for encoding raw audio to MP3.

Dependencies

This project must have ffmpeg install on the machine to run.

https://www.ffmpeg.org/

API

Endpoint

POST /encode BASE_URL https://encoder.bespoken.io

Headers - information to be sent to the encoder

sourceURL: The source audio to be encoded
targetBucket: The S3 bucket to write to
targetKey: The S3 key to stored this files as in the bucket
accessKeyID: [Optional] The AWS Access Key that has privileges to write to this bucket
accessSecretKey: [Optional] The AWS Secret Key that has privileges to write to this bucket

The accessKeyID and accessSecretKey are options if the bucket being uplaoded is public.

Outputs

Success

Response Code: 200 Body: URL to encoded audio (as plain text)

Failure

Response Code: 4xx Body: Error message

Example Curl

curl -X POST \  
  https://encoder.bespoken.io/encode \  
  -H 'accesskeyid: AWS_ACCESS_KEY_ID' \  
  -H 'accesssecretkey: AWS_SECRET_ACCESS_KEY' \  
  -H 'cache-control: no-cache' \  
  -H 'sourceurl: https://s3.amazonaws.com/xapp-alexa/UnitTestOutput.mp3' \  
  -H 'targetbucket: bespoken-encoding-test' \  
  -H 'targetkey: UnitTestOutput-encoded.mp3'

Building

The project is written in TypeScript and node. With NPM installed, building the project is simply:

cd ./server
npm install
./node_modules/typescript/bin/tsc -p .

Or if typescript is installed globally just:

cd ./server
npm install
tsc -p .

The output will be in:

./server/outputs/source/main/

Docker

The top-level ./dockerbuild directory contains a more lightweight docker file that uses the baseline docker image as a base. The baseline Dockerfile is in ./dockerbuild/baseline which is responsible for installing all the necessary components needed to install the server on a Docker image. It will also pull he current Master repo from git, install, and build it which will make it ready to run for any image that uses it. The baseline is pointing to the repo xappmedia/bespoken-encoder and can be built with the command

docker build -t xappmedia/bespoken-encoder ./dockerbuild/baseline