ok, finally this will be @mmomtchev/ffmpeg

mmomtchev · Dec 8, 2023 · 5a4ac2d · 5a4ac2d
1 parent ad3d1e3
commit 5a4ac2d
Show file tree

Hide file tree

Showing 22 changed files with 49 additions and 49 deletions.
diff --git a/.github/workflows/test-npm.yml b/.github/workflows/test-npm.yml
@@ -31,12 +31,12 @@ jobs:
         python-version: "3.11"
     - name: Set up the unit tests
       run: |
-        curl https://codeload.github.com/mmomtchev/ffmpeg.js/zip/refs/tags/v${{ github.event.inputs.version }} --output repo.zip
+        curl https://codeload.github.com/mmomtchev/ffmpeg/zip/refs/tags/v${{ github.event.inputs.version }} --output repo.zip
         unzip repo.zip
-        mv ffmpeg.js-${{ github.event.inputs.version }}/test .
+        mv ffmpeg-${{ github.event.inputs.version }}/test .
         npm install @types/chai @types/mocha @types/node chai magickwand.js mocha ts-node tsconfig-paths
     - name: Install from npm
-      run: npm i ffmpeg.js@${{ github.event.inputs.version }}
+      run: npm i @mmomtchev/ffmpeg@${{ github.event.inputs.version }}
     - name: Run the unit tests
       run: |
         cd test

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,4 @@
-# `ffmpeg.js` Changelog
+# `@mmomtchev/ffmpeg` Changelog
 
 All notable changes to this project will be documented in this file.
 

diff --git a/README.md b/README.md
@@ -1,12 +1,12 @@
 # ffmpeg (w/avcpp) bindings for Node.js
 
-`ffmpeg.js` is a JavaScript wrapper around [`avcpp`](https://github.com/h4tr3d/avcpp) which is a C++ wrapper around the low-level C API of [`ffmpeg`](https://ffmpeg.org/).
+`ffmpeg` is a JavaScript wrapper around [`avcpp`](https://github.com/h4tr3d/avcpp) which is a C++ wrapper around the low-level C API of [`ffmpeg`](https://ffmpeg.org/).
 
 # Current status
 
 The project has an alpha version published to `npm` and basic video and audio demultiplexing, transcoding and multiplexing are functional.
 
-You should be aware that `ffmpeg` is a low-level C API and it is very unsafe to use - trying to interpret 720p as 1080p will always end up with a segfault. `avcpp` adds a semi-safe layer on top of it, but mismatching stream parameters will still lead to a segfault. `ffmpeg.js` should never segfault if all the parameters are correctly checked and set up - but may easily segfault if these are mismatched - or if the asynchronous methods are reentered.
+You should be aware that `ffmpeg` is a low-level C API and it is very unsafe to use - trying to interpret 720p as 1080p will always end up with a segfault. `avcpp` adds a semi-safe layer on top of it, but mismatching stream parameters will still lead to a segfault. `ffmpeg` should never segfault if all the parameters are correctly checked and set up - but may easily segfault if these are mismatched - or if the asynchronous methods are reentered.
 
 Producing a completely safe wrapper that never segfaults, no matter what the user does, is a gargantuan task that is currently not planned.
 
@@ -22,20 +22,20 @@ If you need to access the actual pixel data or audio samples, then, depending on
 
 ## Install
 
-`ffmpeg.js` comes with prebuilt binaries for Windows, Linux and macOS on x64 platforms.
+`ffmpeg` comes with prebuilt binaries for Windows, Linux and macOS on x64 platforms.
 
 You can rebuild it from source using `node-pre-gyp` which will be automatically called by `npm install`. This will pull and build `ffmpeg` using `conan` which will leave a very large directory `${HOME}/.conan` which can be safely deleted.
 
 ## Streams API
 
-The easiest way to use `ffmpeg.js` is the high-level streams API.
+The easiest way to use `ffmpeg` is the high-level streams API.
 
 ### Quickstart
 
 A quick example for generalized video transcoding using the streams API.
 
 ```ts
-import { Muxer, Demuxer, VideoDecoder, VideoEncoder, Discarder, VideoTransform, VideoStreamDefinition } from 'ffmpeg.js/stream';
+import { Muxer, Demuxer, VideoDecoder, VideoEncoder, Discarder, VideoTransform, VideoStreamDefinition } from '@mmomtchev/ffmpeg/stream';
 
 // Create a Demuxer - a Demuxer is an object that has multiple ReadableStream,
 // it decodes the input container format and emits compressed data
@@ -104,11 +104,11 @@ input.on('ready', () => {
 ### More examples
 
 You should start by looking at the unit tests:
-  * [`transcode.test.ts`](https://github.com/mmomtchev/ffmpeg.js/blob/main/test/transcode.test.ts) contains simple examples for transcoding audio and video
-  * [`extract.test.ts`](https://github.com/mmomtchev/ffmpeg.js/blob/main/test/extract.test.ts) contains a simple example for extracting a still from a video and importing it in ImageMagick
-  * [`encode.test.ts`](https://github.com/mmomtchev/ffmpeg.js/blob/main/test/encode.test.ts) contains a simple example for producing a video from stills using ImageMagick
-  * [`rescale.test.ts`](https://github.com/mmomtchev/ffmpeg.js/blob/main/test/rescale.test.ts) contains a simple example for rescaling/resampling a video using ffmpeg's built-in `libswscale`
-  * [`resample.test.ts`](https://github.com/mmomtchev/ffmpeg.js/blob/main/test/resample.test.ts) contains a simple example for resampling audio using ffmpeg's built-in `libswresample`
+  * [`transcode.test.ts`](https://github.com/mmomtchev/ffmpeg/blob/main/test/transcode.test.ts) contains simple examples for transcoding audio and video
+  * [`extract.test.ts`](https://github.com/mmomtchev/ffmpeg/blob/main/test/extract.test.ts) contains a simple example for extracting a still from a video and importing it in ImageMagick
+  * [`encode.test.ts`](https://github.com/mmomtchev/ffmpeg/blob/main/test/encode.test.ts) contains a simple example for producing a video from stills using ImageMagick
+  * [`rescale.test.ts`](https://github.com/mmomtchev/ffmpeg/blob/main/test/rescale.test.ts) contains a simple example for rescaling/resampling a video using ffmpeg's built-in `libswscale`
+  * [`resample.test.ts`](https://github.com/mmomtchev/ffmpeg/blob/main/test/resample.test.ts) contains a simple example for resampling audio using ffmpeg's built-in `libswresample`
 
 ## Supported pixel and audio formats
 

diff --git a/binding.gyp b/binding.gyp
@@ -22,7 +22,7 @@
       'copies': [
         {
           'files': [
-            '<(PRODUCT_DIR)/ffmpeg.js.node'
+            '<(PRODUCT_DIR)/ffmpeg.node'
           ],
           'destination': '<(module_path)'
         }

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
-  "name": "ffmpeg.js",
+  "name": "@mmomtchev/ffmpeg",
   "version": "0.9.0",
-  "description": "avcpp (ffmpeg) bindings for Node.js",
+  "description": "Full native ffmpeg bindings for Node.js with Streams support",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "scripts": {
@@ -15,7 +15,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/mmomtchev/ffmpeg.js.git"
+    "url": "git+https://github.com/mmomtchev/ffmpeg.git"
   },
   "keywords": [
     "node.js",
@@ -25,26 +25,26 @@
     "codec"
   ],
   "binary": {
-    "module_name": "ffmpeg.js",
+    "module_name": "ffmpeg",
     "module_path": "./lib/binding/{platform}-{arch}",
     "remote_path": "v{version}",
-    "host": "https://github.com/mmomtchev/ffmpeg.js/releases/download/",
+    "host": "https://github.com/mmomtchev/ffmpeg/releases/download/",
     "package_name": "{platform}-{arch}.tar.gz",
     "hosting": {
       "provider": "github",
-      "repo": "mmomtchev/ffmpeg.js"
+      "repo": "mmomtchev/ffmpeg"
     }
   },
   "author": "Momtchil Momtchev <[email protected]>",
   "license": "ISC",
   "bugs": {
-    "url": "https://github.com/mmomtchev/ffmpeg.js/issues"
+    "url": "https://github.com/mmomtchev/ffmpeg/issues"
   },
   "exports": {
     ".": "./lib/index.js",
     "./stream": "./lib/Stream.js"
   },
-  "homepage": "https://github.com/mmomtchev/ffmpeg.js#readme",
+  "homepage": "https://github.com/mmomtchev/ffmpeg#readme",
   "dependencies": {
     "@mapbox/node-pre-gyp": "^1.0.11",
     "nobind17": "^1.1.1",

diff --git a/src/lib/AudioDecoder.ts b/src/lib/AudioDecoder.ts
@@ -1,5 +1,5 @@
 import { Transform } from 'node:stream';
-import ffmpeg from 'ffmpeg.js';
+import ffmpeg from '@mmomtchev/ffmpeg';
 import { AudioStreamDefinition, MediaStream } from './MediaStream';
 import { TransformCallback } from 'stream';
 

diff --git a/src/lib/AudioEncoder.ts b/src/lib/AudioEncoder.ts
@@ -1,5 +1,5 @@
 import { Transform } from 'node:stream';
-import ffmpeg from 'ffmpeg.js';
+import ffmpeg from '@mmomtchev/ffmpeg';
 import { AudioStreamDefinition, MediaStream } from './MediaStream';
 import { TransformCallback } from 'stream';
 

diff --git a/src/lib/AudioTransform.ts b/src/lib/AudioTransform.ts
@@ -1,5 +1,5 @@
 import { Transform, TransformOptions, TransformCallback } from 'node:stream';
-import ffmpeg from 'ffmpeg.js';
+import ffmpeg from '@mmomtchev/ffmpeg';
 import { AudioStreamDefinition } from './MediaStream';
 
 export const verbose = (process.env.DEBUG_AUDIO_TRANSFORM || process.env.DEBUG_ALL) ? console.debug.bind(console) : () => undefined;

diff --git a/src/lib/Demuxer.ts b/src/lib/Demuxer.ts
@@ -1,5 +1,5 @@
 import { EventEmitter, ReadableOptions } from 'node:stream';
-import ffmpeg from 'ffmpeg.js';
+import ffmpeg from '@mmomtchev/ffmpeg';
 import { EncodedMediaReadable } from './MediaStream';
 
 const { FormatContext } = ffmpeg;

diff --git a/src/lib/Muxer.ts b/src/lib/Muxer.ts
@@ -1,6 +1,6 @@
 import { EventEmitter, WritableOptions } from 'node:stream';
 import { EncodedMediaWritable, MediaEncoder, isAudioDefinition, isVideoDefinition } from './MediaStream';
-import ffmpeg from 'ffmpeg.js';
+import ffmpeg from '@mmomtchev/ffmpeg';
 
 const { FormatContext, OutputFormat } = ffmpeg;
 

diff --git a/src/lib/VideoDecoder.ts b/src/lib/VideoDecoder.ts
@@ -1,5 +1,5 @@
 import { Transform } from 'node:stream';
-import ffmpeg from 'ffmpeg.js';
+import ffmpeg from '@mmomtchev/ffmpeg';
 import { VideoStreamDefinition, MediaStream } from './MediaStream';
 import { TransformCallback } from 'stream';
 

diff --git a/src/lib/VideoEncoder.ts b/src/lib/VideoEncoder.ts
@@ -1,5 +1,5 @@
 import { Transform } from 'node:stream';
-import ffmpeg from 'ffmpeg.js';
+import ffmpeg from '@mmomtchev/ffmpeg';
 import { VideoStreamDefinition, MediaStream } from './MediaStream';
 import { TransformCallback } from 'stream';
 

diff --git a/src/lib/VideoTransform.ts b/src/lib/VideoTransform.ts
@@ -1,5 +1,5 @@
 import { Transform, TransformOptions, TransformCallback } from 'node:stream';
-import ffmpeg from 'ffmpeg.js';
+import ffmpeg from '@mmomtchev/ffmpeg';
 import { VideoStreamDefinition } from './MediaStream';
 
 export interface VideoTransformOptions extends TransformOptions {

diff --git a/test/demuxer.test.ts b/test/demuxer.test.ts
@@ -2,8 +2,8 @@ import * as path from 'node:path';
 
 import { assert } from 'chai';
 
-import ffmpeg from 'ffmpeg.js';
-import { Demuxer, AudioDecoder, VideoDecoder } from 'ffmpeg.js/stream';
+import ffmpeg from '@mmomtchev/ffmpeg';
+import { Demuxer, AudioDecoder, VideoDecoder } from '@mmomtchev/ffmpeg/stream';
 
 ffmpeg.setLogLevel(process.env.DEBUG_FFMPEG ? ffmpeg.AV_LOG_DEBUG : ffmpeg.AV_LOG_ERROR);
 

diff --git a/test/encode.test.ts b/test/encode.test.ts
@@ -2,8 +2,8 @@ import * as path from 'node:path';
 import * as fs from 'node:fs';
 import { Magick } from 'magickwand.js';
 
-import ffmpeg from 'ffmpeg.js';
-import { VideoEncoder, Muxer } from 'ffmpeg.js/stream';
+import ffmpeg from '@mmomtchev/ffmpeg';
+import { VideoEncoder, Muxer } from '@mmomtchev/ffmpeg/stream';
 
 ffmpeg.setLogLevel(process.env.DEBUG_FFMPEG ? ffmpeg.AV_LOG_DEBUG : ffmpeg.AV_LOG_ERROR);
 

diff --git a/test/extract.test.ts b/test/extract.test.ts
@@ -4,8 +4,8 @@ import { Magick } from 'magickwand.js';
 
 import { assert } from 'chai';
 
-import ffmpeg from 'ffmpeg.js';
-import { Demuxer, VideoDecoder, Discarder } from 'ffmpeg.js/stream';
+import ffmpeg from '@mmomtchev/ffmpeg';
+import { Demuxer, VideoDecoder, Discarder } from '@mmomtchev/ffmpeg/stream';
 
 ffmpeg.setLogLevel(process.env.DEBUG_FFMPEG ? ffmpeg.AV_LOG_DEBUG : ffmpeg.AV_LOG_ERROR);
 

diff --git a/test/resample.test.ts b/test/resample.test.ts
@@ -3,8 +3,8 @@ import * as fs from 'node:fs';
 
 import { assert } from 'chai';
 
-import ffmpeg from 'ffmpeg.js';
-import { Muxer, Demuxer, AudioDecoder, AudioEncoder, AudioTransform, Discarder, AudioStreamDefinition } from 'ffmpeg.js/stream';
+import ffmpeg from '@mmomtchev/ffmpeg';
+import { Muxer, Demuxer, AudioDecoder, AudioEncoder, AudioTransform, Discarder, AudioStreamDefinition } from '@mmomtchev/ffmpeg/stream';
 
 ffmpeg.setLogLevel(process.env.DEBUG_FFMPEG ? ffmpeg.AV_LOG_DEBUG : ffmpeg.AV_LOG_ERROR);
 

diff --git a/test/rescale.test.ts b/test/rescale.test.ts
@@ -3,8 +3,8 @@ import * as fs from 'node:fs';
 
 import { assert } from 'chai';
 
-import ffmpeg from 'ffmpeg.js';
-import { Muxer, Demuxer, VideoDecoder, VideoEncoder, Discarder, VideoTransform, VideoStreamDefinition } from 'ffmpeg.js/stream';
+import ffmpeg from '@mmomtchev/ffmpeg';
+import { Muxer, Demuxer, VideoDecoder, VideoEncoder, Discarder, VideoTransform, VideoStreamDefinition } from '@mmomtchev/ffmpeg/stream';
 
 ffmpeg.setLogLevel(process.env.DEBUG_FFMPEG ? ffmpeg.AV_LOG_DEBUG : ffmpeg.AV_LOG_ERROR);
 

diff --git a/test/transcode.test.ts b/test/transcode.test.ts
@@ -3,8 +3,8 @@ import * as fs from 'node:fs';
 
 import { assert } from 'chai';
 
-import ffmpeg from 'ffmpeg.js';
-import { Muxer, Demuxer, VideoDecoder, VideoEncoder, AudioDecoder, AudioEncoder, Discarder } from 'ffmpeg.js/stream';
+import ffmpeg from '@mmomtchev/ffmpeg';
+import { Muxer, Demuxer, VideoDecoder, VideoEncoder, AudioDecoder, AudioEncoder, Discarder } from '@mmomtchev/ffmpeg/stream';
 
 ffmpeg.setLogLevel(process.env.DEBUG_FFMPEG ? ffmpeg.AV_LOG_DEBUG : ffmpeg.AV_LOG_ERROR);
 

diff --git a/test/tsconfig.json b/test/tsconfig.json
@@ -9,10 +9,10 @@
     "outDir": "lib",
     "declaration": true,
     "paths": {
-      "ffmpeg.js": [
+      "@mmomtchev/ffmpeg": [
         "../lib"
       ],
-      "ffmpeg.js/stream": [
+      "@mmomtchev/ffmpeg/stream": [
         "../lib/Stream"
       ]
     }

diff --git a/tsconfig.json b/tsconfig.json
@@ -9,10 +9,10 @@
     "outDir": "lib",
     "declaration": true,
     "paths": {
-      "ffmpeg.js": [
+      "@mmomtchev/ffmpeg": [
         "./lib"
       ],
-      "ffmpeg.js/stream": [
+      "@mmomtchev/ffmpeg/stream": [
         "./lib/Stream"
       ]
     }