@lumen5/beamcoder 0.0.1

package/binding.gyp

@@ -0,0 +1,103 @@
+{
+  "targets": [{
+    "target_name" : "beamcoder",
+    "sources" : [ "src/beamcoder.cc", "src/beamcoder_util.cc",
+                  "src/log.cc" ,
+                  "src/governor.cc", "src/demux.cc",
+                  "src/decode.cc", "src/filter.cc",
+                  "src/encode.cc", "src/mux.cc",
+                  "src/packet.cc", "src/frame.cc",
+                  "src/codec_par.cc", "src/format.cc",
+                  "src/codec.cc", "src/hwcontext.cc"],
+    "conditions": [
+      ['OS!="win"', {
+        "defines": [
+          "__STDC_CONSTANT_MACROS"
+        ],
+        "cflags_cc!": [
+          "-fno-rtti",
+          "-fno-exceptions"
+        ],
+        "cflags_cc": [
+          "-std=c++11",
+          "-fexceptions"
+        ]
+      }],
+      ['OS!="win" and OS!="linux"', {
+        "link_settings": {
+          "libraries": [
+            "-lavcodec",
+            "-lavdevice",
+            "-lavfilter",
+            "-lavformat",
+            "-lavutil",
+            "-lpostproc",
+            "-lswresample",
+            "-lswscale"
+          ]
+        }
+      }],
+      ['OS=="win"', {
+        "configurations": {
+          "Release": {
+            "msvs_settings": {
+              "VCCLCompilerTool": {
+                "RuntimeTypeInfo": "true"
+              }
+            }
+          }
+        },
+        "include_dirs" : [
+          "ffmpeg/ffmpeg-5.x-win64-shared/include"
+        ],
+        "libraries": [
+          "-l../ffmpeg/ffmpeg-5.x-win64-shared/lib/avcodec",
+          "-l../ffmpeg/ffmpeg-5.x-win64-shared/lib/avdevice",
+          "-l../ffmpeg/ffmpeg-5.x-win64-shared/lib/avfilter",
+          "-l../ffmpeg/ffmpeg-5.x-win64-shared/lib/avformat",
+          "-l../ffmpeg/ffmpeg-5.x-win64-shared/lib/avutil",
+          "-l../ffmpeg/ffmpeg-5.x-win64-shared/lib/postproc",
+          "-l../ffmpeg/ffmpeg-5.x-win64-shared/lib/swresample",
+          "-l../ffmpeg/ffmpeg-5.x-win64-shared/lib/swscale"
+        ],
+        "copies": [
+            {
+              "destination": "build/Release/",
+              "files": [
+                "ffmpeg/ffmpeg-5.x-win64-shared/bin/avcodec-59.dll",
+                "ffmpeg/ffmpeg-5.x-win64-shared/bin/avdevice-59.dll",
+                "ffmpeg/ffmpeg-5.x-win64-shared/bin/avfilter-8.dll",
+                "ffmpeg/ffmpeg-5.x-win64-shared/bin/avformat-59.dll",
+                "ffmpeg/ffmpeg-5.x-win64-shared/bin/avutil-57.dll",
+                "ffmpeg/ffmpeg-5.x-win64-shared/bin/postproc-56.dll",
+                "ffmpeg/ffmpeg-5.x-win64-shared/bin/swresample-4.dll",
+                "ffmpeg/ffmpeg-5.x-win64-shared/bin/swscale-6.dll"
+              ]
+            }
+          ]
+    }],
+    ['OS=="linux"', {
+      "libraries": [
+        "<!(pkg-config --libs libavcodec)",
+        "<!(pkg-config --libs libavdevice)",
+        "<!(pkg-config --libs libavfilter)",
+        "<!(pkg-config --libs libavformat)",
+        "<!(pkg-config --libs libavutil)",
+        "<!(pkg-config --libs libpostproc)",
+        "<!(pkg-config --libs libswresample)",
+        "<!(pkg-config --libs libswscale)"
+      ]
+    }],
+    ['OS=="mac"', {
+      "include_dirs" : [
+        "/usr/local/Cellar/ffmpeg@5/5.1.3/include/",
+        "/opt/homebrew/Cellar/ffmpeg@5/5.1.3/include/",
+      ],
+      "library_dirs": [
+        "/usr/local/Cellar/ffmpeg@5/5.1.3/lib/",
+        "/opt/homebrew/Cellar/ffmpeg@5/5.1.3/lib/",
+      ]
+    }],
+  ]
+}]
+}

package/examples/encode_h264.js

@@ -0,0 +1,92 @@
+/*
+  Aerostat Beam Coder - Node.js native bindings for FFmpeg.
+  Copyright (C) 2019  Streampunk Media Ltd.
+
+  This program is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+  https://www.streampunk.media/ mailto:furnace@streampunk.media
+  14 Ormiscaig, Aultbea, Achnasheen, IV22 2JJ  U.K.
+*/
+
+/* Generate a 200 frame test pattern and encode it as a raw H.264 file.
+
+  Usage: node encode_h264.js <filename.h264>
+
+  Output can be viewed in VLC. Make sure "All Files" is selected to see the file.
+*/
+
+const beamcoder = require('../index.js'); // Use require('beamcoder') externally
+const fs = require('fs');
+
+let endcode = Buffer.from([0, 0, 1, 0xb7]);
+
+async function run() {
+  let start = process.hrtime();
+  let encParams = {
+    name: 'libx264',
+    width: 1920,
+    height: 1080,
+    bit_rate: 2000000,
+    time_base: [1, 25],
+    framerate: [25, 1],
+    gop_size: 10,
+    max_b_frames: 1,
+    pix_fmt: 'yuv420p',
+    priv_data: { preset: 'slow' }
+  };
+
+  let encoder = beamcoder.encoder(encParams);
+  console.log('Encoder', encoder);
+
+  let outFile = fs.createWriteStream(process.argv[2]);
+
+  for ( let i = 0 ; i < 200 ; i++ ) {
+    let frame = beamcoder.frame({
+      width: encParams.width,
+      height: encParams.height,
+      format: encParams.pix_fmt
+    }).alloc();
+
+    let linesize = frame.linesize;
+    let [ ydata, bdata, cdata ] = frame.data;
+    frame.pts = i;
+
+    for ( let y = 0 ; y < frame.height ; y++ ) {
+      for ( let x = 0 ; x < linesize[0] ; x++ ) {
+        ydata[y * linesize[0] + x] =  x + y + i * 3;
+      }
+    }
+
+    for ( let y = 0 ; y < frame.height / 2 ; y++) {
+      for ( let x = 0; x < linesize[1] ; x++) {
+        bdata[y * linesize[1] + x] = 128 + y + i * 2;
+        cdata[y * linesize[1] + x] = 64 + x + i * 5;
+      }
+    }
+
+    let packets = await encoder.encode(frame);
+    if ( i % 10 === 0) console.log('Encoding frame', i);
+    packets.packets.forEach(x => outFile.write(x.data));
+  }
+
+  let p2 = await encoder.flush();
+  console.log('Flushing', p2.packets.length, 'frames.');
+  p2.packets.forEach(x => outFile.write(x.data));
+  outFile.end(endcode);
+
+  console.log('Total time ', process.hrtime(start));
+}
+
+if (typeof process.argv[2] === 'string') { run(); }
+else { console.error('Error: Please provide a file name.'); }

package/examples/jpeg_app.js

@@ -0,0 +1,55 @@
+/*
+  Aerostat Beam Coder - Node.js native bindings for FFmpeg.
+  Copyright (C) 2019  Streampunk Media Ltd.
+
+  This program is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+  https://www.streampunk.media/ mailto:furnace@streampunk.media
+  14 Ormiscaig, Aultbea, Achnasheen, IV22 2JJ  U.K.
+*/
+
+/* Main example from the README.md. Run in a folder of media files.
+
+   Only supports 8-bit YUV 4:2:2 or 4:2:0 pixel formats.
+*/
+
+const beamcoder = require('../index.js'); // Use require('beamcoder') externally
+const Koa = require('koa'); // Add koa to package.json dependencies
+const app = new Koa();
+
+app.use(async (ctx) => { // Assume HTTP GET with path /<file_name>/<time_in_s>
+  let parts = ctx.path.split('/'); // Split the path into filename and time
+  if ((parts.length < 3) || (isNaN(+parts[2]))) return; // Ignore favicon etc..
+  let dm = await beamcoder.demuxer('file:' + parts[1]); // Probe the file
+  await dm.seek({ time: +parts[2] }); // Seek to the closest keyframe to time
+  let packet = await dm.read(); // Find the next video packet (assumes stream 0)
+  for ( ; packet.stream_index !== 0 ; packet = await dm.read() );
+  let dec = beamcoder.decoder({ demuxer: dm, stream_index: 0 }); // Create a decoder
+  let decResult = await dec.decode(packet); // Decode the frame
+  if (decResult.frames.length === 0) // Frame may be buffered, so flush it out
+    decResult = await dec.flush();
+  // Filtering could be used to transform the picture here, e.g. scaling
+  let enc = beamcoder.encoder({ // Create an encoder for JPEG data
+    name : 'mjpeg', // FFmpeg does not have an encoder called 'jpeg'
+    width : dec.width,
+    height: dec.height,
+    pix_fmt: dec.pix_fmt.indexOf('422') >= 0 ? 'yuvj422p' : 'yuvj420p',
+    time_base: [1, 1] });
+  let jpegResult = await enc.encode(decResult.frames[0]); // Encode the frame
+  await enc.flush(); // Tidy the encoder
+  ctx.type = 'image/jpeg'; // Set the Content-Type of the data
+  ctx.body = jpegResult.packets[0].data; // Return the JPEG image data
+});
+
+app.listen(3000); // Start the server on port 3000

package/examples/jpeg_filter_app.js

@@ -0,0 +1,101 @@
+/*
+  Aerostat Beam Coder - Node.js native bindings for FFmpeg.
+  Copyright (C) 2019  Streampunk Media Ltd.
+
+  This program is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+  https://www.streampunk.media/ mailto:furnace@streampunk.media
+  14 Ormiscaig, Aultbea, Achnasheen, IV22 2JJ  U.K.
+*/
+
+/* Main example from the README.md with added filtering. Run in a folder of media files.
+
+   Will convert source pixel formats to 8-bit YUV 4:2:2
+*/
+
+const beamcoder = require('../index.js'); // Use require('beamcoder') externally
+const Koa = require('koa'); // Add koa to package.json dependencies
+const app = new Koa();
+
+app.use(async (ctx) => { // Assume HTTP GET with path /<file_name>/<time_in_s>
+  let parts = ctx.path.split('/'); // Split the path into filename and time
+  if ((parts.length < 3) || (isNaN(+parts[2]))) return; // Ignore favicon etc..
+  let dm = await beamcoder.demuxer('file:' + parts[1]); // Probe the file
+  await dm.seek({ time: +parts[2] }); // Seek to the closest keyframe to time
+  let packet = await dm.read(); // Find the next video packet (assumes stream 0)
+  for ( ; packet.stream_index !== 0 ; packet = await dm.read() );
+  let dec = beamcoder.decoder({ demuxer: dm, stream_index: 0 }); // Create a decoder
+  let decResult = await dec.decode(packet); // Decode the frame
+  if (decResult.frames.length === 0) // Frame may be buffered, so flush it out
+    decResult = await dec.flush();
+
+  // audio test
+  const aindex = 2;
+  const audStr = dm.streams[aindex];
+  // console.log(audStr);
+  let adec = beamcoder.decoder({ demuxer: dm, stream_index: aindex }); // Create a decoder
+  // console.log(adec);
+  let apkt = await dm.read();
+  let afrm = await adec.decode(apkt);
+  console.log(afrm.frames);
+  const audEnc = beamcoder.encoder({
+    name: 'aac',
+    sample_fmt: 'fltp',
+    sample_rate: 48000,
+    channels: 1,
+    channel_layout: 'mono', });
+
+  const audFilt = await beamcoder.filterer({ // Create a filterer for audio
+    filterType: 'audio',
+    inputParams: [{
+      sampleRate: audStr.codecpar.sample_rate,
+      sampleFormat: adec.sample_fmt,
+      channelLayout: audStr.codecpar.channel_layout,
+      timeBase: audStr.time_base }],
+    outputParams: [{
+      sampleRate: 1024,
+      sampleFormat: 'fltp',
+      channelLayout: 'mono' }],
+    filterSpec: 'aresample=1024' });
+
+  const audFiltPkt = await audFilt.filter([{ frames: afrm }]);
+  const encPkt = await audEnc.encode(audFiltPkt[0].frames[0]);
+  console.log(encPkt);
+
+  let vstr = dm.streams[0]; // Select the video stream (assumes stream 0)
+  let filt = await beamcoder.filterer({ // Create a filterer for video
+    filterType: 'video',
+    inputParams: [{
+      width: vstr.codecpar.width,
+      height: vstr.codecpar.height,
+      pixelFormat: vstr.codecpar.format,
+      timeBase: vstr.time_base,
+      pixelAspect: vstr.sample_aspect_ratio }],
+    outputParams: [{ pixelFormat: 'yuv422p' }],
+    filterSpec: 'scale=640:360, colorspace=range=jpeg:all=bt709' });
+  let filtResult = await filt.filter([{ frames: decResult }]); // Filter the frame
+  let filtFrame = filtResult[0].frames[0];
+  let enc = beamcoder.encoder({ // Create an encoder for JPEG data
+    name : 'mjpeg', // FFmpeg does not have an encoder called 'jpeg'
+    width : filtFrame.width,
+    height: filtFrame.height,
+    pix_fmt: 'yuvj422p',
+    time_base: [1, 1] });
+  let jpegResult = await enc.encode(filtFrame); // Encode the filtered frame
+  await enc.flush(); // Tidy the encoder
+  ctx.type = 'image/jpeg'; // Set the Content-Type of the data
+  ctx.body = jpegResult.packets[0].data; // Return the JPEG image data
+});
+
+app.listen(3000); // Start the server on port 3000

package/examples/make_mp4.js

@@ -0,0 +1,123 @@
+/*
+  Aerostat Beam Coder - Node.js native bindings for FFmpeg.
+  Copyright (C) 2019  Streampunk Media Ltd.
+
+  This program is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+  https://www.streampunk.media/ mailto:furnace@streampunk.media
+  14 Ormiscaig, Aultbea, Achnasheen, IV22 2JJ  U.K.
+*/
+
+/* Generate a 200 frame test pattern and encode it as a raw H.264 file.
+
+  Usage: node encode_h264.js <filename.h264>
+
+  Output can be viewed in VLC. Make sure "All Files" is selected to see the file.
+*/
+
+const beamcoder = require('../index.js'); // Use require('beamcoder') externally
+const fs = require('fs');
+
+let endcode = Buffer.from([0, 0, 1, 0xb7]);
+
+async function run() {
+  let start = process.hrtime();
+  let encParams = {
+    name: 'libx264',
+    width: 1920,
+    height: 1080,
+    bit_rate: 2000000,
+    time_base: [1, 25],
+    framerate: [25, 1],
+    gop_size: 10,
+    max_b_frames: 1,
+    pix_fmt: 'yuv420p',
+    priv_data: { preset: 'slow' }
+  };
+
+  let encoder = await beamcoder.encoder(encParams);
+  console.log('Encoder', encoder);
+
+  const mux = beamcoder.muxer({ format_name: 'mp4' });
+  let vstr = mux.newStream({
+    name: 'h264',
+    time_base: [1, 90000],
+    interleaved: true }); // Set to false for manual interleaving, true for automatic
+  Object.assign(vstr.codecpar, {
+    width: 1920,
+    height: 1080,
+    format: 'yuv420p'
+  });
+  console.log(vstr);
+  await mux.openIO({
+    url: 'file:test.mp4'
+  });
+  await mux.writeHeader();
+
+  let outFile = fs.createWriteStream(process.argv[2]);
+
+  for ( let i = 0 ; i < 200 ; i++ ) {
+    let frame = beamcoder.frame({
+      width: encParams.width,
+      height: encParams.height,
+      format: encParams.pix_fmt
+    }).alloc();
+
+    let linesize = frame.linesize;
+    let [ ydata, bdata, cdata ] = frame.data;
+    frame.pts = i+100;
+
+    for ( let y = 0 ; y < frame.height ; y++ ) {
+      for ( let x = 0 ; x < linesize[0] ; x++ ) {
+        ydata[y * linesize[0] + x] =  x + y + i * 3;
+      }
+    }
+
+    for ( let y = 0 ; y < frame.height / 2 ; y++) {
+      for ( let x = 0; x < linesize[1] ; x++) {
+        bdata[y * linesize[1] + x] = 128 + y + i * 2;
+        cdata[y * linesize[1] + x] = 64 + x + i * 5;
+      }
+    }
+
+    let packets = await encoder.encode(frame);
+    if ( i % 10 === 0) console.log('Encoding frame', i);
+    for (const pkt of packets.packets) {
+      pkt.duration = 1;
+      pkt.stream_index = vstr.index;
+      pkt.pts = pkt.pts * 90000/25;
+      pkt.dts = pkt.dts * 90000/25;
+      await mux.writeFrame(pkt);
+      outFile.write(pkt.data);
+    }
+  }
+
+  let p2 = await encoder.flush();
+  console.log('Flushing', p2.packets.length, 'frames.');
+  for (const pkt of p2.packets) {
+    pkt.duration = 1;
+    pkt.stream_index = vstr.index;
+    pkt.pts = pkt.pts * 90000/25;
+    pkt.dts = pkt.dts * 90000/25;
+    await mux.writeFrame(pkt);
+    outFile.write(pkt.data);
+  }
+  await mux.writeTrailer();
+  outFile.end(endcode);
+
+  console.log('Total time ', process.hrtime(start));
+}
+
+if (typeof process.argv[2] === 'string') { run(); }
+else { console.error('Error: Please provide a file name.'); }

package/index.d.ts

@@ -0,0 +1,83 @@
+export * from "./types/CodecPar"
+export * from "./types/Packet"
+export * from "./types/Frame"
+export * from "./types/Stream"
+export * from "./types/Codec"
+export * from "./types/FormatContext"
+export * from "./types/Demuxer"
+export * from "./types/Decoder"
+export * from "./types/Filter"
+export * from "./types/Encoder"
+export * from "./types/Muxer"
+export * from "./types/Beamstreams"
+export * from "./types/HWContext"
+
+export const AV_NOPTS_VALUE: number
+
+/** The LIBAV**_VERSION_INT for each FFmpeg library */
+export function versions(): {
+  avcodec: number
+  avdevice: number
+  avfilter: number
+  avformat: number
+  avutil: number
+  postproc: number
+  swresample: number
+  swscale: number
+}
+/**
+ * FFmpeg version string. This usually is the actual release
+ * version number or a git commit description. This string has no fixed format
+ * and can change any time. It should never be parsed by code.
+ */
+export function avVersionInfo(): string
+/** Informative version strings for each FFmpeg library */
+export function versionStrings(): {
+  avcodec: string
+  avdevice: string
+  avfilter: string
+  avformat: string
+  avutil: string
+  postproc: string
+  swresample: string
+  swscale: string
+}
+/** Build configuration strings for each FFmpeg library */
+export function configurations(): {
+  avcodec: string
+  avdevice: string
+  avfilter: string
+  avformat: string
+  avutil: string
+  postproc: string
+  swresample: string
+  swscale: string
+}
+/** License strings for each FFmpeg library */
+export function licenses(): {
+  avcodec: string
+  avdevice: string
+  avfilter: string
+  avformat: string
+  avutil: string
+  postproc: string
+  swresample: string
+  swscale: string
+}
+/** List the available protocols */
+export function protocols(): { inputs: Array<string>, outputs: Array<string> }
+
+/** Read or set the logging level
+ * `quiet` - print no output.
+ * `panic` - something went really wrong - crash will follow
+ * `fatal` - recovery not possible
+ * `error` - lossless recovery not possible
+ * `warning` - something doesn't look correct
+ * `info` - standard information - the default
+ * `verbose` - detailed information
+ * `debug` - stuff which is only useful for libav* developers
+ * `trace` - extremely verbose debugging for libav* developers
+ */
+export function logging(level?: string): string | undefined
+
+export as namespace Beamcoder

package/index.js

@@ -0,0 +1,44 @@
+/*
+  Aerostat Beam Coder - Node.js native bindings to FFmpeg
+  Copyright (C) 2019 Streampunk Media Ltd.
+
+  This program is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+  https://www.streampunk.media/ mailto:furnace@streampunk.media
+  14 Ormiscaig, Aultbea, Achnasheen, IV22 2JJ  U.K.
+*/
+
+const beamcoder = require('bindings')('beamcoder');
+const beamstreams = require('./beamstreams.js');
+
+// Provide useful debug on segfault-related crash
+const SegfaultHandler = require('segfault-handler');
+SegfaultHandler.registerHandler('crash.log');
+
+const splash = `Aerostat Beam Coder  Copyright (C) 2019  Streampunk Media Ltd
+GPL v3.0 or later license. This program comes with ABSOLUTELY NO WARRANTY.
+This is free software, and you are welcome to redistribute it
+under certain conditions. Conditions and warranty at:
+https://github.com/Streampunk/beamcoder/blob/master/LICENSE`;
+
+console.log(splash);
+console.log('Using FFmpeg version', beamcoder.avVersionInfo());
+
+beamcoder.demuxerStream = beamstreams.demuxerStream;
+beamcoder.muxerStream = beamstreams.muxerStream;
+
+beamcoder.makeSources = beamstreams.makeSources;
+beamcoder.makeStreams = beamstreams.makeStreams;
+
+module.exports = beamcoder;