initial v3 setup

fluent-ffmpeg · Nov 13, 2023 · f5cc5ee · f5cc5ee
1 parent b092615
commit f5cc5ee
Show file tree

Hide file tree

Showing 100 changed files with 997 additions and 35,165 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -5,26 +5,34 @@ on:
     branches:
       - master
 jobs:
-  test:
-    name: Run tests
+  build:
+    name: Build fluent-ffmpeg
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node: [18, 20, 21]
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-      - name: Install flvtool2
-        run: sudo gem install flvtool2
-      - name: Install ffmpeg
-        run: sudo apt install -y ffmpeg
       - name: Setup node
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node }}
           cache: yarn
       - name: Install dependencies
         run: yarn
+      - name: Build
+        run: yarn build
+
+  test:
+    name: Run tests
+    needs: build
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: [18, 20, 21]
+    steps:
+      - name: Install flvtool2
+        run: sudo gem install flvtool2
+      - name: Install ffmpeg
+        run: sudo apt install -y ffmpeg
       - name: Run tests
         run: yarn test
       - name: Generate coverage report

diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,5 @@
-*.project
+coverage
+lib
 node_modules
 .nyc_output
-*.swp
-.idea
-*.iml
-coverage
+types
diff --git a/.npmignore b/.npmignore
@@ -1,4 +1,3 @@
-*.md
 .git*
 test/
-examples/
+src/
diff --git a/Makefile b/Makefile
diff --git a/README.md b/README.md
@@ -39,12 +39,8 @@ fluent-ffmpeg requires ffmpeg >= 0.9 to work.  It may work with previous version
 
 If the `FFMPEG_PATH` environment variable is set, fluent-ffmpeg will use it as the full path to the `ffmpeg` executable.  Otherwise, it will attempt to call `ffmpeg` directly (so it should be in your `PATH`).  You must also have ffprobe installed (it comes with ffmpeg in most distributions).  Similarly, fluent-ffmpeg will use the `FFPROBE_PATH` environment variable if it is set, otherwise it will attempt to call it in the `PATH`.
 
-Most features should work when using avconv and avprobe instead of ffmpeg and ffprobe, but they are not officially supported at the moment.
-
 **Windows users**: most probably ffmpeg and ffprobe will _not_ be in your `%PATH`, so you _must_ set `%FFMPEG_PATH` and `%FFPROBE_PATH`.
 
-**Debian/Ubuntu users**: the official repositories have the ffmpeg/ffprobe executable in the `libav-tools` package, and they are actually rebranded avconv/avprobe executables (avconv is a fork of ffmpeg).  They should be mostly compatible, but should you encounter any issue, you may want to use the real ffmpeg instead.  You can either compile it from source or find a pre-built .deb package at https://ffmpeg.org/download.html (For Ubuntu, the `ppa:mc3man/trusty-media` PPA provides recent builds).
-
 #### flvtool2 or flvmeta
 
 If you intend to encode FLV videos, you must have either flvtool2 or flvmeta installed and in your `PATH` or fluent-ffmpeg won't be able to produce streamable output files.  If you set either the `FLVTOOL2_PATH` or `FLVMETA_PATH`, fluent-ffmpeg will try to use it instead of searching in the `PATH`.