Merge pull request #1 from ts-ffmpeg/jc-0727--chore-add-ts-types-from-definitely-typed

chore: add ts types from definitely typed

Author: Jonham

.npmignore

@@ -1,4 +1,10 @@
 *.md
 .git*
-test/
-examples/
+doc
+examples
+test
+tools
+Makefile
+fluent-ffmpeg-tests.ts
+node_modules
+.github

README.md

@@ -1,8 +1,121 @@
-# (Legacy project) Fluent ffmpeg-API for node.js
+# Fluent FFmpeg-API with types for node.js
 
 [![Coverage Status](https://coveralls.io/repos/github/fluent-ffmpeg/node-fluent-ffmpeg/badge.svg?branch=master)](https://coveralls.io/github/fluent-ffmpeg/node-fluent-ffmpeg?branch=master)
 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Ffluent-ffmpeg%2Fnode-fluent-ffmpeg.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Ffluent-ffmpeg%2Fnode-fluent-ffmpeg?ref=badge_shield)
 
+## What will be done with this legacy project
+I will merge types from https://www.npmjs.com/package/@types/fluent-ffmpeg into this repo, put types and code ready at one place. \
+And later I'm planing to fix [issues from previous repo](https://github.com/fluent-ffmpeg/node-fluent-ffmpeg/issues) and [merge PRs](https://github.com/fluent-ffmpeg/node-fluent-ffmpeg/pulls).
+
+
+## Installation
+
+Via npm:
+
+```sh
+# this lib starts from v2.2.0, which is the same code with `fluent-ffmpeg@2.1`. I just reduce the useless code in npm lib.
+$ npm install @ts-ffmpeg/fluent-ffmpeg
+```
+
+
+### Creating an FFmpeg command
+
+The fluent-ffmpeg module returns a constructor that you can use to instanciate FFmpeg commands.
+
+```ts
+// ts
+import ffmpeg from '@ts-ffmpeg/fluent-ffmpeg'
+const command = ffmpeg();
+```
+
+You may pass an input file name or readable stream, a configuration object, or both to the constructor.
+
+```js
+const command = ffmpeg('/path/to/file.avi');
+const command = ffmpeg(fs.createReadStream('/path/to/file.avi'));
+const command = ffmpeg({ option: "value", ... });
+const command = ffmpeg('/path/to/file.avi', { option: "value", ... });
+```
+
+The following options are available:
+* `source`: input file name or readable stream (ignored if an input file is passed to the constructor)
+* `timeout`: ffmpeg timeout in seconds (defaults to no timeout)
+* `preset` or `presets`: directory to load module presets from (defaults to the `lib/presets` directory in fluent-ffmpeg tree)
+* `niceness` or `priority`: ffmpeg niceness value, between -20 and 20; ignored on Windows platforms (defaults to 0)
+* `logger`: logger object with `debug()`, `info()`, `warn()` and `error()` methods (defaults to no logging)
+* `stdoutLines`: maximum number of lines from ffmpeg stdout/stderr to keep in memory (defaults to 100, use 0 for unlimited storage)
+
+
+### Specifying inputs
+
+You can add any number of inputs to an Ffmpeg command.  An input can be:
+* a file name (eg. `/path/to/file.avi`);
+* an image pattern (eg. `/path/to/frame%03d.png`);
+* a readable stream; only one input stream may be used for a command, but you can use both an input stream and one or several file names.
+
+```js
+// Note that all fluent-ffmpeg methods are chainable
+ffmpeg('/path/to/input1.avi')
+  .input('/path/to/input2.avi')
+  .input(fs.createReadStream('/path/to/input3.avi'));
+
+// Passing an input to the constructor is the same as calling .input()
+ffmpeg()
+  .input('/path/to/input1.avi')
+  .input('/path/to/input2.avi');
+
+// Most methods have several aliases, here you may use addInput or mergeAdd instead
+ffmpeg()
+  .addInput('/path/to/frame%02d.png')
+  .addInput('/path/to/soundtrack.mp3');
+
+ffmpeg()
+  .mergeAdd('/path/to/input1.avi')
+  .mergeAdd('/path/to/input2.avi');
+```
+
+### More
+This lib is currently written in js for code, and a standalone `index.d.ts` for typing. So you can easily import lib by require or import. For more examples, you can explore the doc below. They are all the same with the lib `fluent-ffmpeg`.
+
+
+## Credits 
+### Main contributors from [fluent-ffmpeg/node-fluent-ffmpeg](https://github.com/fluent-ffmpeg/node-fluent-ffmpeg) project
+
+* [enobrev](http://github.com/enobrev)
+* [njoyard](http://github.com/njoyard)
+* [sadikzzz](http://github.com/sadikzzz)
+* [smremde](http://github.com/smremde)
+* [spruce](http://github.com/spruce)
+* [tagedieb](http://github.com/tagedieb)
+* [tommadema](http://github.com/tommadema)
+* [Weltschmerz](http://github.com/Weltschmerz)
+
+[and more others](https://github.com/fluent-ffmpeg/node-fluent-ffmpeg/graphs/contributors)
+
+
+### TS types authors from [@types/fluent-ffmpeg](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/fluent-ffmpeg)
+These definitions were written by KIM Jaesuck a.k.a. gim tcaesvk, DingWeizhe, Mounir Abid, Doyoung Ha, and Prasad Nayak.
+
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2011 Stefan Schaermeli <schaermu@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Ffluent-ffmpeg%2Fnode-fluent-ffmpeg.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Ffluent-ffmpeg%2Fnode-fluent-ffmpeg?ref=badge_large)
+
+
+---
+# Below are doc from legacy project
+
 ## Fluent-ffmpeg is now deprecated
 
 This library is **no longer maintained** and no longer works properly with recent ffmpeg versions. Use it as your own risk, this repository is readonly and does not accept issues or PRs.
@@ -66,14 +179,14 @@ Alternatively, you may set the ffmpeg, ffprobe and flvtool2/flvmeta binary paths
 The fluent-ffmpeg module returns a constructor that you can use to instanciate FFmpeg commands.
 
 ```js
-var FfmpegCommand = require('fluent-ffmpeg');
+var FfmpegCommand = require('@ts-ffmpeg/fluent-ffmpeg');
 var command = new FfmpegCommand();
 ```
 
 You can also use the constructor without the `new` operator.
 
 ```js
-var ffmpeg = require('fluent-ffmpeg');
+var ffmpeg = require('@ts-ffmpeg/fluent-ffmpeg');
 var command = ffmpeg();
 ```
 
@@ -1261,7 +1374,7 @@ fluent-ffmpeg enables you to query your installed ffmpeg version for supported f
 
 ```js
 
-var Ffmpeg = require('fluent-ffmpeg');
+var Ffmpeg = require('@ts-ffmpeg/fluent-ffmpeg');
 
 Ffmpeg.getAvailableFormats(function(err, formats) {
   console.log('Available formats:');

examples/typescript/version-validation/index.ts

@@ -0,0 +1,24 @@
+import ffmpeg from '@ts-ffmpeg/fluent-ffmpeg'
+
+async function getVersion () {
+  return new Promise((resolve, reject) => {
+    ffmpeg().addOption('-hide_banner').on('error', (error, stdout, stderr) => {
+      if (error) return reject(error)
+
+      if (stderr) console.log('stderr:', stderr)
+      if (stdout) console.log('stdout:', stdout)
+    }).on('end', (stdout, stderr) => {
+      if (stderr) console.log('stderr:', stderr)
+      if (stdout) console.log('stdout:', stdout)
+      resolve(stdout || stderr)
+    }).run()
+  })
+}
+
+await getVersion().catch((err: Error) => {
+  if (err.message.includes('No output specified')) {
+    console.log('✅ Pass')
+    return
+  }
+  console.log(err)
+})

examples/typescript/version-validation/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "version-validation",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.ts",
+  "scripts": {
+    "test": "npx vite-node index.ts"
+  },
+  "keywords": [ ],
+  "author": "Jonham <jonhamchen@gmail.com>",
+  "license": "MIT",
+  "packageManager": "pnpm@10.12.3",
+  "dependencies": {
+    "@ts-ffmpeg/fluent-ffmpeg": "2.2.2"
+  },
+  "devDependencies": {
+    "vite-node": "^3.2.4"
+  }
+}