| - | Main Release | -LTS Release | -
|---|---|---|
| Android API Level | -24 | -16 | -
| Android Camera Access | -Yes | -- | -
| Android Architectures | -arm-v7a-neon arm64-v8a x86 x86-64 |
- arm-v7a arm-v7a-neon arm64-v8a x86 x86-64 |
-
| Xcode Support | -10.1 | -7.3.1 | -
| iOS SDK | -12.1 | -9.3 | -
| iOS Architectures | -arm64 arm64e x86-64 |
- armv7 arm64 i386 x86-64 |
-
arm64-v8a
x86
x86-64 | arm-v7a
arm-v7a-neon
arm64-v8a
x86
x86-64 | +| Xcode Support | 10.1 | 7.3.1 | +| iOS SDK | 11.0 | 9.3 | +| iOS AVFoundation | Yes | - | +| iOS Architectures | arm64
x86-64
x86-64-mac-catalyst | armv7
arm64
i386
x86-64 | ### 3. Using -1. Execute FFmpeg commands. +1. Execute synchronous FFmpeg commands. - Use execute() method with a single command line ``` @@ -212,8 +230,15 @@ In order to install the `LTS` variant, install the `https-lts` package using ins var arguments = ["-i", "file1.mp4", "-c:v", "mpeg4", "file2.mp4"]; _flutterFFmpeg.executeWithArguments(arguments).then((rc) => print("FFmpeg process exited with rc $rc")); ``` +2. Execute asynchronous FFmpeg commands. -2. Execute FFprobe commands. + ``` + _flutterFFmpeg.executeAsync(ffmpegCommand, (int executionId, int returnCode) { + print("FFmpeg process for executionId $executionId exited with rc $returnCode"); + }).then((executionId) => print("Async FFmpeg process started with executionId $executionId.")); + ``` + +3. Execute FFprobe commands. - Use execute() method with a single command line ``` @@ -235,7 +260,7 @@ In order to install the `LTS` variant, install the `https-lts` package using ins _flutterFFprobe.executeWithArguments(arguments).then((rc) => print("FFprobe process exited with rc $rc")); ``` -3. Check execution output. Zero represents successful execution, non-zero values represent failure. +4. Check execution output. Zero represents successful execution, 255 means user cancel and non-zero values represent failure. ``` final FlutterFFmpegConfig _flutterFFmpegConfig = new FlutterFFmpegConfig(); @@ -245,12 +270,17 @@ In order to install the `LTS` variant, install the `https-lts` package using ins _flutterFFmpegConfig.getLastCommandOutput().then((output) => print("Last command output: $output")); ``` -4. Stop an ongoing operation. Note that this function does not wait for termination to complete and returns immediately. - ``` - _flutterFFmpeg.cancel(); - ``` +5. Stop ongoing FFmpeg operations. Note that these two functions do not wait for termination to complete and return immediately. + - Stop all executions + ``` + _flutterFFmpeg.cancel(); + ``` + - Stop a specific execution + ``` + _flutterFFmpeg.cancelExecution(executionId); + ``` -5. Get media information for a file. +6. Get media information for a file. - Print all fields ``` final FlutterFFprobe _flutterFFprobe = new FlutterFFprobe(); @@ -264,37 +294,43 @@ In order to install the `LTS` variant, install the `https-lts` package using ins _flutterFFprobe.getMediaInformation("
-### 4. Tips
+### 5. Tips
- `flutter_ffmpeg` uses file system paths, it does not know what an `assets` folder or a `project` folder is. So you can't use resources on those folders directly, you need to provide full paths of those resources.
-- `flutter_ffmpeg` requires ios deployment target to be at least `9.3`.
- If you don't specify a deployment target or set a value smaller than `9.3` then your build will fail with the following error.
+- `flutter_ffmpeg` requires ios deployment target to be at least `11.0` for Main releases and `9.3` for LTS releases.
+ If you don't specify a deployment target or set a value smaller than the required one then your build will fail with
+ the following error.
```
Resolving dependencies of `Podfile`
@@ -395,8 +438,13 @@ In order to install the `LTS` variant, install the `https-lts` package using ins
deployment target.
```
- You can fix this issue by adding `platform :ios, '9.3'` definition to your `ios/Podfile` file.
+ You can fix this issue by adding the definition to your `ios/Podfile` file.
+ - `Main` releases
+ ```
+ platform :ios, '11.0'
+ ```
+ - `LTS` releases
```
platform :ios, '9.3'
```
@@ -447,21 +495,35 @@ You can overcome this situation by registering a font using `setFontDirectory` m
}
```
-### 5. Updates
+### 6. Updates
Refer to [Changelog](CHANGELOG.md) for updates.
-### 6. License
+### 7. License
-This project is licensed under the LGPL v3.0. However, if installation is customized to use a package with `-gpl` postfix (min-gpl, https-gpl, full-gpl) then `FlutterFFmpeg` is subject to the GPL v3.0 license.
+This project is licensed under the LGPL v3.0. However, if installation is customized to use a package with `-gpl`
+postfix (min-gpl, https-gpl, full-gpl) then `FlutterFFmpeg` is subject to the GPL v3.0 license.
-Digital assets used in test applications are published in the public domain.
+In test application; embedded fonts are licensed under the
+[SIL Open Font License](https://opensource.org/licenses/OFL-1.1), other digital assets are published in the public
+domain.
-### 7. Contributing
+### 8. Patents
+
+It is not clearly explained in their documentation but it is believed that `FFmpeg`, `kvazaar`, `x264` and `x265`
+include algorithms which are subject to software patents. If you live in a country where software algorithms are
+patentable then you'll probably need to pay royalty fees to patent holders. We are not lawyers though, so we recommend
+that you seek legal advice first. See [FFmpeg Patent Mini-FAQ](https://ffmpeg.org/legal.html).
+
+### 9. Contributing
Feel free to submit issues or pull requests.
-### 8. See Also
+Please note that `master` branch includes only the latest released source code. Changes planned for the next release
+are implemented under the `development` branch. Therefore, if you want to create a pull request, please open it against
+the `development`.
+
+### 10. See Also
- [FFmpeg](https://www.ffmpeg.org)
- [Mobile FFmpeg Wiki](https://github.com/tanersener/mobile-ffmpeg/wiki)
diff --git a/doc/assets/flutter_test_app.gif b/doc/assets/flutter_test_app.gif
new file mode 100644
index 0000000..23779bb
Binary files /dev/null and b/doc/assets/flutter_test_app.gif differ
diff --git a/example/README.md b/example/README.md
index c980e11..1a72536 100644
--- a/example/README.md
+++ b/example/README.md
@@ -4,7 +4,7 @@ Demonstrates how to use the flutter_ffmpeg plugin.
## Getting Started
-1. Execute FFmpeg commands.
+1. Execute synchronous FFmpeg commands.
- Use execute() method with a single command line
```
@@ -25,8 +25,15 @@ Demonstrates how to use the flutter_ffmpeg plugin.
var arguments = ["-i", "file1.mp4", "-c:v", "mpeg4", "file2.mp4"];
_flutterFFmpeg.executeWithArguments(arguments).then((rc) => print("FFmpeg process exited with rc $rc"));
```
+2. Execute asynchronous FFmpeg commands.
-2. Execute FFprobe commands.
+ ```
+ _flutterFFmpeg.executeAsync(ffmpegCommand, (int executionId, int returnCode) {
+ print("FFmpeg process for executionId $executionId exited with rc $returnCode");
+ }).then((executionId) => print("Async FFmpeg process started with executionId $executionId."));
+ ```
+
+3. Execute FFprobe commands.
- Use execute() method with a single command line
```
@@ -48,7 +55,7 @@ Demonstrates how to use the flutter_ffmpeg plugin.
_flutterFFprobe.executeWithArguments(arguments).then((rc) => print("FFprobe process exited with rc $rc"));
```
-3. Check execution output. Zero represents successful execution, non-zero values represent failure.
+4. Check execution output. Zero represents successful execution, 255 means user cancel and non-zero values represent failure.
```
final FlutterFFmpegConfig _flutterFFmpegConfig = new FlutterFFmpegConfig();
@@ -58,12 +65,17 @@ Demonstrates how to use the flutter_ffmpeg plugin.
_flutterFFmpegConfig.getLastCommandOutput().then((output) => print("Last command output: $output"));
```
-4. Stop an ongoing operation. Note that this function does not wait for termination to complete and returns immediately.
- ```
- _flutterFFmpeg.cancel();
- ```
+5. Stop ongoing FFmpeg operations. Note that these two functions do not wait for termination to complete and return immediately.
+ - Stop all executions
+ ```
+ _flutterFFmpeg.cancel();
+ ```
+ - Stop a specific execution
+ ```
+ _flutterFFmpeg.cancelExecution(executionId);
+ ```
-5. Get media information for a file.
+6. Get media information for a file.
- Print all fields
```
final FlutterFFprobe _flutterFFprobe = new FlutterFFprobe();
@@ -77,37 +89,43 @@ Demonstrates how to use the flutter_ffmpeg plugin.
_flutterFFprobe.getMediaInformation("