antonlyap/ffmpeg-kit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

implement the flutter plugin

Browse Source
This commit is contained in:
Taner Sener 2021-03-06 21:52:37 +00:00
parent 2ee5414365
commit 3bc1844b7c
63 changed files with 9327 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/FUNDING.yml vendored
View File

@ -1,2 +1,2 @@
patreon: tanersener
custom: ['https://buymeacoff.ee/tanersener','https://paypal.me/teodosiyminchev']
custom: [ 'https://www.patreon.com/tanersener','https://opencollective.com/ffmpeg-kit','https://buymeacoff.ee/tanersener','https://paypal.me/teodosiyminchev' ]

1
.gitignore vendored
View File

@ -2,3 +2,4 @@
/*.log
/prebuilt/
.DS_Store
.idea

54
README.md
View File

@ -1,16 +1,20 @@
# FFmpegKit ![GitHub release](https://img.shields.io/badge/release-v4.5-blue.svg) ![Maven Central](https://img.shields.io/maven-central/v/com.arthenica/ffmpeg-kit-min) ![CocoaPods](https://img.shields.io/cocoapods/v/ffmpeg-kit-ios-min) [![npm](https://img.shields.io/npm/v/ffmpeg-kit-react-native.svg)](ffmpeg-kit-react-native)
# FFmpegKit ![GitHub release](https://img.shields.io/badge/release-v4.5-blue.svg) ![Maven Central](https://img.shields.io/maven-central/v/com.arthenica/ffmpeg-kit-min) ![CocoaPods](https://img.shields.io/cocoapods/v/ffmpeg-kit-ios-min) ![pub](https://img.shields.io/pub/v/ffmpeg_kit_flutter.svg) ![npm](https://img.shields.io/npm/v/ffmpeg-kit-react-native.svg)
FFmpeg Kit for applications.
`FFmpegKit` is a collection of tools to use `FFmpeg` in `Android`, `iOS`, `macOS`, `tvOS`, `Flutter` and `React Native` applications.
It includes scripts to build `FFmpeg` libraries natively, a wrapper library to run `FFmpeg`/`FFprobe` commands in
applications and 8 prebuilt binary packages available at [Github](https://github.com/tanersener/ffmpeg-kit/releases),
[Maven Central](https://search.maven.org), [CocoaPods](https://cocoapods.org), [pub](https://pub.dev) and [npm](https://www.npmjs.com).
<img src="https://github.com/tanersener/ffmpeg-kit/blob/development/docs/assets/ffmpeg-kit-icon-v9.png" width="240">
### 1. Features
- Scripts to build FFmpeg libraries
- Scripts to build FFmpeg libraries natively
- `FFmpegKit` wrapper library to run `FFmpeg`/`FFprobe` commands in applications
- Supports native platforms: Android, iOS, macOS and tvOS
- Supports hybrid platforms: React Native
- Supports hybrid platforms: Flutter, React Native
- Based on FFmpeg `v4.5-dev` with optional system and external libraries
- 8 prebuilt binary packages available at [Github](https://github.com/tanersener/ffmpeg-kit/releases), [Maven Central](https://search.maven.org), [CocoaPods](https://cocoapods.org) and [npm](https://www.npmjs.com)
- 8 prebuilt binary packages available at [Github](https://github.com/tanersener/ffmpeg-kit/releases), [Maven Central](https://search.maven.org), [CocoaPods](https://cocoapods.org), [pub](https://pub.dev) and [npm](https://www.npmjs.com)
- Licensed under `LGPL 3.0`, or `GPL v3.0` if GPL licensed libraries are enabled
### 2. Android
@ -23,31 +27,38 @@ See [Android](https://github.com/tanersener/ffmpeg-kit/tree/main/android) to lea
See [Apple](https://github.com/tanersener/ffmpeg-kit/tree/main/apple) to use `FFmpegKit` on `Apple` platforms
(`iOS`, `macOS`, `tvOS`).
### 4. React Native
### 4. Flutter
See [Flutter](https://github.com/tanersener/ffmpeg-kit/tree/main/flutter/flutter) to learn more about `FFmpegKit` for
`Flutter`.
### 5. React Native
See [React Native](https://github.com/tanersener/ffmpeg-kit/tree/main/react-native) to learn more about `FFmpegKit` for
`React Native`.
### 5. Build Scripts
### 6. Build Scripts
Use `android.sh`, `ios.sh`, `macos.sh` and `tvos.sh` to build `FFmpegKit` for each native platform.
All scripts support additional options to enable optional libraries and disable platform architectures.
### 6. FFmpegKit Library
### 7. FFmpegKit Library
`FFmpegKit` is a wrapper library that allows you to easily run `FFmpeg`/`FFprobe` commands in applications. It
provides additional features on top of `FFmpeg` to enable platform specific resources, control how commands are
executed and how the results are handled.
`Android` library of `FFmpegKit` has a `Java` API, `Apple` libraries (`iOS`, `macOS`, `tvOS`) have an `Objective-C`
API and `React Native` library provides a `JavaScript` API, which are identical in terms of features and capabilities.
API, `Flutter`library comes with a `Dart` API and `React Native` library provides a `JavaScript` API, which are
identical in terms of features and capabilities.
### 7. Packages
### 8. Packages
There are eight different `ffmpeg-kit` packages distributed on
[Github](https://github.com/tanersener/ffmpeg-kit/releases),
[Maven Central](https://search.maven.org), [CocoaPods](https://cocoapods.org) and [npm](https://www.npmjs.com).
[Maven Central](https://search.maven.org), [CocoaPods](https://cocoapods.org), [pub](https://pub.dev) and
[npm](https://www.npmjs.com).
Below you can see which system libraries and external libraries are enabled in each one of them.
Please remember that some parts of `FFmpeg` are licensed under the `GPL` and only `GPL` licensed `ffmpeg-kit` packages
@ -102,7 +113,7 @@ include them.
- `AVFoundation` is not available on `tvOS`
- `VideoToolbox` is not available on LTS releases of `iOS` and `tvOS`
### 8. Versions
### 9. Versions
`FFmpegKit` binaries generated use the same major and minor version numbers as the upstream `FFmpeg` project.
@ -111,13 +122,15 @@ indicates that `FFmpeg` source code is cloned from the `FFmpeg` `master` branch.
| Platforms | FFmpegKit Version | FFmpeg Version | Release Date |
| :----: | :----: | :----: | :----: |
| Flutter | [4.5.0](https://github.com/tanersener/ffmpeg-kit/releases/tag/flutter.v4.5.0) | 4.5-dev-2008 | Oct 05, 2021 |
| Flutter | [4.5.0-LTS](https://github.com/tanersener/ffmpeg-kit/releases/tag/flutter.v4.5.0.LTS) | 4.5-dev-2008 | Oct 05, 2021 |
| React Native | [4.5.0](https://github.com/tanersener/ffmpeg-kit/releases/tag/react.native.v4.5.0) | 4.5-dev-2008 | Oct 01, 2021 |
| Android<br>Apple | [4.5](https://github.com/tanersener/ffmpeg-kit/releases/tag/v4.5) | 4.5-dev-2008 | Sep 18, 2021 |
| Android<br>Apple | [4.5.LTS](https://github.com/tanersener/ffmpeg-kit/releases/tag/v4.5.LTS) | 4.5-dev-2008 | Sep 18, 2021 |
| Android<br>Apple | [4.4](https://github.com/tanersener/ffmpeg-kit/releases/tag/v4.4) | 4.4-dev-3015 | Mar 03, 2021 |
| Android<br>Apple | [4.4.LTS](https://github.com/tanersener/ffmpeg-kit/releases/tag/v4.4.LTS) | 4.4-dev-3015 | Mar 03, 2021 |
### 9. LTS Releases
### 10. LTS Releases
`FFmpegKit` binaries are published in two release variants: `Main Release` and `LTS Release`.
@ -146,11 +159,11 @@ This table shows the differences between two variants.
| tvOS Architectures | arm64<br/>x86-64<br/>arm64-simulator | arm64<br/>x86-64 |
| tvOS Bundle Format | XCFrameworks | Frameworks |
### 10. Documentation
### 11. Documentation
A more detailed documentation is available under [Wiki](https://github.com/tanersener/ffmpeg-kit/wiki).
### 11. Test Applications
### 12. Test Applications
You can see how `FFmpegKit` is used inside an application by running test applications created under
[FFmpegKit Test](https://github.com/tanersener/ffmpeg-kit-test) project.
@ -158,12 +171,12 @@ You can see how `FFmpegKit` is used inside an application by running test applic
All applications are identical and supports command execution, video encoding, accessing https urls, encoding audio,
burning subtitles, video stabilisation, pipe operations and concurrent command execution.
### 12. License
### 13. License
`FFmpegKit` is licensed under the `LGPL v3.0`. However, if source code is built using the optional `--enable-gpl` flag
or prebuilt binaries with `-gpl` postfix are used, then `FFmpegKit` is subject to the `GPL v3.0` license.
### 13. Patents
### 14. 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
@ -174,15 +187,16 @@ that you seek legal advice first. See [FFmpeg Patent Mini-FAQ](https://ffmpeg.or
distribute that library, then you are subject to pay MPEG LA licensing fees. Refer to
[OpenH264 FAQ](https://www.openh264.org/faq.html) page for the details.
### 14. Contributing
### 15. Contributing
Feel free to submit issues or pull requests.
Please note that `main` includes only the latest released source code. Changes planned for the next release are
developed under the `development` branches (`development` for native platforms, `development-react-native` for
`react-native`). Therefore, if you want to create a pull request, please open it against them.
`react-native`, `development-flutter` for `flutter`). Therefore, if you want to create a pull request, please open it
against them.
### 15. See Also
### 16. See Also
- [FFmpeg API Documentation](https://ffmpeg.org/doxygen/4.0/index.html)
- [FFmpeg Wiki](https://trac.ffmpeg.org/wiki/WikiStart)

52
docs/index.md
View File

@ -1,6 +1,10 @@
# FFmpegKit
FFmpeg Kit for applications.
`FFmpegKit` is a collection of tools to use `FFmpeg` in `Android`, `iOS`, `macOS`, `tvOS`, `Flutter` and `React Native` applications.
It includes scripts to build `FFmpeg` libraries natively, a wrapper library to run `FFmpeg`/`FFprobe` commands in
applications and 8 prebuilt binary packages available at [Github](https://github.com/tanersener/ffmpeg-kit/releases),
[Maven Central](https://search.maven.org), [CocoaPods](https://cocoapods.org), [pub](https://pub.dev) and [npm](https://www.npmjs.com).
<img src="https://github.com/tanersener/ffmpeg-kit/raw/main/docs/assets/ffmpeg-kit-icon-v9.png" width="180">
@ -8,9 +12,9 @@ FFmpeg Kit for applications.
- Scripts to build FFmpeg libraries
- `FFmpegKit` wrapper library to run `FFmpeg`/`FFprobe` commands in applications
- Supports native platforms: Android, iOS, macOS and tvOS
- Supports hybrid platforms: React Native
- Supports hybrid platforms: Flutter, React Native
- Based on FFmpeg `v4.5-dev` with optional system and external libraries
- 8 prebuilt binary packages available at [Github](https://github.com/tanersener/ffmpeg-kit/releases), [Maven Central](https://search.maven.org), [CocoaPods](https://cocoapods.org) and [npm](https://www.npmjs.com)
- 8 prebuilt binary packages available at [Github](https://github.com/tanersener/ffmpeg-kit/releases), [Maven Central](https://search.maven.org), [CocoaPods](https://cocoapods.org), [pub](https://pub.dev) and [npm](https://www.npmjs.com)
- Licensed under `LGPL 3.0`, or `GPL v3.0` if GPL licensed libraries are enabled
### 2. Android
@ -23,31 +27,38 @@ See [Android](https://github.com/tanersener/ffmpeg-kit/tree/development/android)
See [Apple](https://github.com/tanersener/ffmpeg-kit/tree/development/apple) to use `FFmpegKit` on `Apple` platforms
(`iOS`, `macOS`, `tvOS`).
### 4. React Native
### 4. Flutter
See [Flutter](https://github.com/tanersener/ffmpeg-kit/tree/main/flutter/flutter) to learn more about `FFmpegKit` for
`Flutter`.
### 5. React Native
See [React Native](https://github.com/tanersener/ffmpeg-kit/tree/main/react-native) to learn more about `FFmpegKit` for
`React Native`.
### 5. Build Scripts
### 6. Build Scripts
Use `android.sh`, `ios.sh`, `macos.sh` and `tvos.sh` to build `FFmpegKit` for each native platform.
All scripts support additional options to enable optional libraries and disable platform architectures.
### 6. FFmpegKit Library
### 7. FFmpegKit Library
`FFmpegKit` is a wrapper library that allows you to easily run `FFmpeg`/`FFprobe` commands in applications. It
provides additional features on top of `FFmpeg` to enable platform specific resources, control how commands are
executed and how the results are handled.
`Android` library of `FFmpegKit` has a `Java` API, `Apple` libraries (`iOS`, `macOS`, `tvOS`) have an `Objective-C`
API and `React Native` library provides a `JavaScript` API, which are identical in terms of features and capabilities.
API, `Flutter`library comes with a `Dart` API and `React Native` library provides a `JavaScript` API, which are
identical in terms of features and capabilities.
### 7. Packages
### 8. Packages
There are eight different `ffmpeg-kit` packages distributed on
[Github](https://github.com/tanersener/ffmpeg-kit/releases),
[Maven Central](https://search.maven.org), [CocoaPods](https://cocoapods.org) and [npm](https://www.npmjs.com).
[Maven Central](https://search.maven.org), [CocoaPods](https://cocoapods.org), [pub](https://pub.dev) and
[npm](https://www.npmjs.com).
Below you can see which system libraries and external libraries are enabled in each one of them.
Please remember that some parts of `FFmpeg` are licensed under the `GPL` and only `GPL` licensed `ffmpeg-kit` packages
@ -94,13 +105,15 @@ indicates that `FFmpeg` source code is cloned from the `FFmpeg` `master` branch.
| Platforms | FFmpegKit Version | FFmpeg Version | Release Date |
| :----: | :----: | :----: | :----: |
| Flutter | [4.5.0](https://github.com/tanersener/ffmpeg-kit/releases/tag/flutter.v4.5.0) | 4.5-dev-2008 | Oct 05, 2021 |
| Flutter | [4.5.0-LTS](https://github.com/tanersener/ffmpeg-kit/releases/tag/flutter.v4.5.0.LTS) | 4.5-dev-2008 | Oct 05, 2021 |
| React Native | [4.5.0](https://github.com/tanersener/ffmpeg-kit/releases/tag/react.native.v4.5.0) | 4.5-dev-2008 | Oct 01, 2021 |
| Android<br>Apple | [4.5](https://github.com/tanersener/ffmpeg-kit/releases/tag/v4.5) | 4.5-dev-2008 | Sep 18, 2021 |
| Android<br>Apple | [4.5.LTS](https://github.com/tanersener/ffmpeg-kit/releases/tag/v4.5.LTS) | 4.5-dev-2008 | Sep 18, 2021 |
| Android<br>Apple | [4.4](https://github.com/tanersener/ffmpeg-kit/releases/tag/v4.4) | 4.4-dev-3015 | Mar 03, 2021 |
| Android<br>Apple | [4.4.LTS](https://github.com/tanersener/ffmpeg-kit/releases/tag/v4.4.LTS) | 4.4-dev-3015 | Mar 03, 2021 |
### 9. LTS Releases
### 10. LTS Releases
`FFmpegKit` binaries are published in two release variants: `Main Release` and `LTS Release`.
@ -129,24 +142,24 @@ This table shows the differences between two variants.
| tvOS Architectures | arm64<br/>x86-64<br/>arm64-simulator | arm64<br/>x86-64 |
| tvOS Bundle Format | XCFrameworks | Frameworks |
### 10. Documentation
### 11. Documentation
A more detailed documentation is available under [Wiki](https://github.com/tanersener/ffmpeg-kit/wiki).
### 11. Test Applications
### 12. Test Applications
You can see how `FFmpegKit` is used inside an application by running test applications created under
[FFmpegKit Test](https://github.com/tanersener/ffmpeg-kit-test) project.
All applications are identical and supports command execution, video encoding, accessing https urls, encoding audio,
burning subtitles, video stabilisation, pipe operations, concurrent command execution.
burning subtitles, video stabilisation, pipe operations and concurrent command execution.
### 12. License
### 13. License
`FFmpegKit` is licensed under the `LGPL v3.0`. However, if source code is built using the optional `--enable-gpl` flag
or prebuilt binaries with `-gpl` postfix are used, then `FFmpegKit` is subject to the `GPL v3.0` license.
### 13. Patents
### 14. 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
@ -157,15 +170,16 @@ that you seek legal advice first. See [FFmpeg Patent Mini-FAQ](https://ffmpeg.or
distribute that library, then you are subject to pay MPEG LA licensing fees. Refer to
[OpenH264 FAQ](https://www.openh264.org/faq.html) page for the details.
### 14. Contributing
### 15. Contributing
Feel free to submit issues or pull requests.
Please note that `main` includes only the latest released source code. Changes planned for the next release are
developed under the `development` branches (`development` for native platforms, `development-react-native` for
`react-native`). Therefore, if you want to create a pull request, please open it against them.
developed under the `development` branches (`development` for native platforms, `development-react-native` for
`react-native`, `development-flutter` for `flutter`). Therefore, if you want to create a pull request, please open it
against them.
### 15. See Also
### 16. See Also
- [FFmpeg API Documentation](https://ffmpeg.org/doxygen/4.0/index.html)
- [FFmpeg Wiki](https://trac.ffmpeg.org/wiki/WikiStart)

5
flutter/flutter/.gitignore vendored Normal file
View File

@ -0,0 +1,5 @@
.DS_Store
.dart_tool/
.packages
.pub/
build/

10
flutter/flutter/.metadata Normal file
View File

@ -0,0 +1,10 @@
# This file tracks properties of this Flutter project.
# Used by Flutter tool to assess capabilities and perform upgrades etc.
#
# This file should be version controlled and should not be manually edited.
version:
revision: c5a4b4029c0798f37c4a39b479d7cb75daa7b05c
channel: stable
project_type: plugin

5
flutter/flutter/CHANGELOG.md Normal file
View File

@ -0,0 +1,5 @@
## 4.5.0
- Initial release
## 4.5.0-LTS
- Initial LTS release

165
flutter/flutter/LICENSE Normal file
View File

@ -0,0 +1,165 @@
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.
0. Additional Definitions.
As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.
"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.
An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.
A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".
The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.
The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.
1. Exception to Section 3 of the GNU GPL.
You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.
2. Conveying Modified Versions.
If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:
a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or
b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.
3. Object Code Incorporating Material from Library Header Files.
The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:
a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the object code with a copy of the GNU GPL and this license
document.
4. Combined Works.
You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:
a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.
c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.
d) Do one of the following:
0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.
1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.
e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)
5. Combined Libraries.
You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:
a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.
b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.
6. Revised Versions of the GNU Lesser General Public License.
The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.
If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.

674
flutter/flutter/LICENSE.GPLv3 Normal file
View File

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
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 <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.

276
flutter/flutter/README.md Normal file
View File

@ -0,0 +1,276 @@
# FFmpegKit for Flutter
### 1. Features
- Includes both `FFmpeg` and `FFprobe`
- Supports
- `Android`, `iOS` and `macOS`
- FFmpeg `v4.5-dev` releases
- `arm-v7a`, `arm-v7a-neon`, `arm64-v8a`, `x86` and `x86_64` architectures on Android
- `Android API Level 16` or later
- `armv7`, `armv7s`, `arm64`, `arm64-simulator`, `i386`, `x86_64`, `x86_64-mac-catalyst` and `arm64-mac-catalyst`
architectures on iOS
- `iOS SDK 9.3` or later
- `arm64` and `x86_64` architectures on macOS
- `macOS SDK 10.11+` or later
- Can process Storage Access Framework (SAF) Uris on Android
- 24 external libraries
`dav1d`, `fontconfig`, `freetype`, `fribidi`, `gmp`, `gnutls`, `kvazaar`, `lame`, `libass`, `libiconv`, `libilbc`
, `libtheora`, `libvorbis`, `libvpx`, `libwebp`, `libxml2`, `opencore-amr`, `opus`, `shine`, `snappy`, `soxr`
, `speex`, `twolame`, `vo-amrwbenc`
- 4 external libraries with GPL license
`vid.stab`, `x264`, `x265`, `xvidcore`
- Licensed under LGPL 3.0, can be customized to support GPL v3.0
### 2. Installation
Add `ffmpeg_kit_flutter` as a dependency in your `pubspec.yaml file`.
```yaml
dependencies:
ffmpeg_kit_flutter: ^4.5.0
```
#### 2.1 Packages
`ffmpeg` includes built-in encoders for some popular formats. However, there are certain external libraries that needs
to be enabled in order to encode specific formats/codecs. For example, to encode an `mp3` file you need `lame` or
`shine` library enabled. You have to install a `ffmpeg_kit_flutter` package that has at least one of them inside. To
encode an `h264` video, you need to install a package with `x264` inside. To encode `vp8` or `vp9` videos, you need
a `ffmpeg_kit_flutter` package with `libvpx` inside.
`ffmpeg-kit` provides eight packages that include different sets of external libraries. These packages are named
according to the external libraries included in them. Refer to
[Packages](https://github.com/tanersener/ffmpeg-kit#8-packages) section of the project README to see the names of those
packages and external libraries included in each of them.
#### 2.2 Installing Packages
Installing `ffmpeg_kit_flutter` enables the `https` package by default. It is possible to install the other packages
using the following dependency format.
```yaml
dependencies:
ffmpeg_kit_flutter_<package name>: ^4.5.0
```
Note that hyphens in the package name must be replaced with underscores. Additionally, do not forget to use the package
name in the import statements if you install a package.
#### 2.3 Installing LTS Releases
In order to install the `LTS` variant, append `-LTS` to the version you have for the `ffmpeg_kit_flutter` dependency.
```yaml
dependencies:
ffmpeg_kit_flutter: ^4.5.0-LTS
```
#### 2.4 LTS Releases
`ffmpeg_kit_flutter` is published in two different variants: `Main Release` and `LTS Release`. Both releases share the
same source code but is built with different settings (Architectures, API Level, iOS Min SDK, etc.). Refer to
[LTS Releases](https://github.com/tanersener/ffmpeg-kit#10-lts-releases) section of the project README to see how they
compare to each other.
### 3. Using
1. Execute FFmpeg commands.
```dart
import 'package:ffmpeg_kit_flutter/ffmpeg_kit.dart';
FFmpegKit.executeAsync('-i file1.mp4 -c:v mpeg4 file2.mp4', (session) async {
final returnCode = await session.getReturnCode();
if (ReturnCode.isSuccess(returnCode)) {
// SUCCESS
} else if (ReturnCode.isCancel(returnCode)) {
// CANCEL
} else {
// ERROR
}
});
```
2. Each `execute` call creates a new session. Access every detail about your execution from the session created.
```dart
FFmpegKit.executeAsync('-i file1.mp4 -c:v mpeg4 file2.mp4', (session) async {
// Unique session id created for this execution
final sessionId = session.getSessionId();
// Command arguments as a single string
final command = session.getCommand();
// Command arguments
final commandArguments = session.getArguments();
// State of the execution. Shows whether it is still running or completed
final state = await session.getState();
// Return code for completed sessions. Will be undefined if session is still running or FFmpegKit fails to run it
final returnCode = await session.getReturnCode();
final startTime = session.getStartTime();
final endTime = await session.getEndTime();
final duration = await session.getDuration();
// Console output generated for this execution
final output = await session.getOutput();
// The stack trace if FFmpegKit fails to run a command
final failStackTrace = await session.getFailStackTrace();
// The list of logs generated for this execution
final logs = await session.getLogs();
// The list of statistics generated for this execution (only available on FFmpegSession)
final statistics = await (session as FFmpegSession).getStatistics();
});
```
3. Execute `FFmpeg` commands by providing session specific `execute`/`log`/`session` callbacks.
```dart
FFmpegKit.executeAsync('-i file1.mp4 -c:v mpeg4 file2.mp4', (Session session) async {
// CALLED WHEN SESSION IS EXECUTED
}, (Log log) {
// CALLED WHEN SESSION PRINTS LOGS
}, (Statistics statistics) {
// CALLED WHEN SESSION GENERATES STATISTICS
});
```
4. Execute `FFprobe` commands.
```dart
FFprobeKit.executeAsync(ffprobeCommand, (session) {
// CALLED WHEN SESSION IS EXECUTED
});
```
5. Get media information for a file/url.
```dart
FFprobeKit.getMediaInformationAsync('<file path or url>', (session) async {
final information = await (session as MediaInformationSession).getMediaInformation();
});
```
6. Stop ongoing FFmpeg operations.
- Stop all sessions
```dart
FFmpegKit.cancel();
```
- Stop a specific session
```dart
FFmpegKit.cancel(sessionId);
```
7. (Android) Convert Storage Access Framework (SAF) Uris into paths that can be read or written by
`FFmpegKit` and `FFprobeKit`.
- Reading a file:
```dart
FFmpegKitConfig.selectDocumentForRead('*/*').then((uri) {
FFmpegKitConfig.getSafParameterForRead(uri!).then((safUrl) {
FFmpegKit.executeAsync("-i ${safUrl!} -c:v mpeg4 file2.mp4");
});
});
```
- Writing to a file:
```dart
FFmpegKitConfig.selectDocumentForWrite('video.mp4', 'video/*').then((uri) {
FFmpegKitConfig.getSafParameterForWrite(uri!).then((safUrl) {
FFmpegKit.executeAsync("-i file1.mp4 -c:v mpeg4 ${safUrl}");
});
});
```
8. Get previous `FFmpeg` and `FFprobe` sessions from the session history.
```dart
FFmpegKit.listSessions().then((sessionList) {
sessionList.forEach((session) {
final sessionId = session.getSessionId();
});
});
FFprobeKit.listSessions().then((sessionList) {
sessionList.forEach((session) {
final sessionId = session.getSessionId();
});
});
```
9. Enable global callbacks.
- Execute Callback, called when an async execution is ended
```dart
FFmpegKitConfig.enableExecuteCallback((session) {
final sessionId = session.getSessionId();
});
```
- Log Callback, called when a session generates logs
```dart
FFmpegKitConfig.enableLogCallback((log) {
final message = log.getMessage();
});
```
- Statistics Callback, called when a session generates statistics
```dart
FFmpegKitConfig.enableStatisticsCallback((statistics) {
final size = statistics.getSize();
});
```
10. Register system fonts and custom font directories.
```dart
FFmpegKitConfig.setFontDirectoryList(["/system/fonts", "/System/Library/Fonts", "<folder with fonts>"]);
```
### 4. Test Application
You can see how `FFmpegKit` is used inside an application by running `flutter` test applications developed under
the [FFmpegKit Test](https://github.com/tanersener/ffmpeg-kit-test) project.
### 5. Tips
See [Tips](https://github.com/tanersener/ffmpeg-kit/wiki/Tips) wiki page.
### 6. License
See [License](https://github.com/tanersener/ffmpeg-kit/wiki/License) wiki page.
### 7. Patents
See [Patents](https://github.com/tanersener/ffmpeg-kit/wiki/Patents) wiki page.

68
flutter/flutter/analysis_options.yaml Normal file
View File

@ -0,0 +1,68 @@
analyzer:
enable-experiment:
- non-nullable
strong-mode:
implicit-dynamic: false
errors:
missing_required_param: warning
missing_return: warning
linter:
rules:
- avoid_catching_errors
- avoid_function_literals_in_foreach_calls
- avoid_private_typedef_functions
- avoid_renaming_method_parameters
- avoid_returning_null_for_void
- avoid_unused_constructor_parameters
- avoid_void_async
- await_only_futures
- camel_case_types
- cancel_subscriptions
- comment_references
- constant_identifier_names
- control_flow_in_finally
- directives_ordering
- empty_statements
- file_names
- hash_and_equals
- implementation_imports
- iterable_contains_unrelated_type
- join_return_with_assignment
- lines_longer_than_80_chars
- list_remove_unrelated_type
- missing_whitespace_between_adjacent_strings
- no_runtimeType_toString
- non_constant_identifier_names
- only_throw_errors
- overridden_fields
- package_api_docs
- package_names
- package_prefixed_library_names
- prefer_asserts_in_initializer_lists
- prefer_const_constructors
- prefer_const_declarations
- prefer_expression_function_bodies
- prefer_final_locals
- prefer_function_declarations_over_variables
- prefer_initializing_formals
- prefer_inlined_adds
- prefer_interpolation_to_compose_strings
- prefer_is_not_operator
- prefer_null_aware_operators
- prefer_relative_imports
- prefer_typing_uninitialized_variables
- prefer_void_to_null
- provide_deprecation_message
- sort_pub_dependencies
- test_types_in_equals
- throw_in_finally
- unnecessary_brace_in_string_interps
- unnecessary_lambdas
- unnecessary_null_aware_assignments
- unnecessary_overrides
- unnecessary_parenthesis
- unnecessary_statements
- unnecessary_string_interpolations
- use_string_buffers
- void_checks

9
flutter/flutter/android/.gitignore vendored Normal file
View File

@ -0,0 +1,9 @@
*.iml
.gradle
/local.properties
/.idea/workspace.xml
/.idea/libraries
.DS_Store
/build
/captures
gradle

48
flutter/flutter/android/build.gradle Normal file
View File

@ -0,0 +1,48 @@
buildscript {
repositories {
google()
jcenter()
}
dependencies {
classpath 'com.android.tools.build:gradle:4.2.2'
}
}
apply plugin: 'com.android.library'
android {
compileSdkVersion 30
defaultConfig {
minSdkVersion 24
targetSdkVersion 30
versionCode 450
versionName "4.5.0"
}
buildTypes {
release {
minifyEnabled false
}
}
lintOptions {
disable 'GradleCompatible'
}
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}
repositories {
mavenCentral()
jcenter()
google()
}
dependencies {
implementation 'androidx.annotation:annotation:1.2.0'
implementation 'com.arthenica:ffmpeg-kit-https:4.5'
}

3
flutter/flutter/android/gradle.properties Normal file
View File

@ -0,0 +1,3 @@
org.gradle.jvmargs=-Xmx1536M
android.useAndroidX=true
android.enableJetifier=true

1
flutter/flutter/android/settings.gradle Normal file
View File

@ -0,0 +1 @@
rootProject.name = 'ffmpeg-kit-flutter-android'

3
flutter/flutter/android/src/main/AndroidManifest.xml Normal file
View File

@ -0,0 +1,3 @@
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.arthenica.ffmpegkit.flutter">
</manifest>

70
flutter/flutter/android/src/main/java/com/arthenica/ffmpegkit/flutter/AsyncWriteToPipeTask.java Normal file
View File

@ -0,0 +1,70 @@
/*
* Copyright (c) 2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
package com.arthenica.ffmpegkit.flutter;
import static com.arthenica.ffmpegkit.flutter.FFmpegKitFlutterPlugin.LIBRARY_NAME;
import android.util.Log;
import androidx.annotation.NonNull;
import java.io.IOException;
import io.flutter.plugin.common.MethodChannel;
public class AsyncWriteToPipeTask implements Runnable {
private final String inputPath;
private final String namedPipePath;
private final FFmpegKitFlutterMethodResultHandler resultHandler;
private final MethodChannel.Result result;
public AsyncWriteToPipeTask(@NonNull final String inputPath, @NonNull final String namedPipePath, @NonNull final FFmpegKitFlutterMethodResultHandler resultHandler, @NonNull final MethodChannel.Result result) {
this.inputPath = inputPath;
this.namedPipePath = namedPipePath;
this.resultHandler = resultHandler;
this.result = result;
}
@Override
public void run() {
final int rc;
try {
final String asyncCommand = "cat " + inputPath + " > " + namedPipePath;
Log.d(LIBRARY_NAME, String.format("Starting copy %s to pipe %s operation.", inputPath, namedPipePath));
final long startTime = System.currentTimeMillis();
final Process process = Runtime.getRuntime().exec(new String[]{"sh", "-c", asyncCommand});
rc = process.waitFor();
final long endTime = System.currentTimeMillis();
Log.d(LIBRARY_NAME, String.format("Copying %s to pipe %s operation completed with rc %d in %d seconds.", inputPath, namedPipePath, rc, (endTime - startTime) / 1000));
resultHandler.successAsync(result, rc);
} catch (final IOException | InterruptedException e) {
Log.e(LIBRARY_NAME, String.format("Copy %s to pipe %s failed with error.", inputPath, namedPipePath), e);
resultHandler.errorAsync(result, "WRITE_TO_PIPE_FAILED", e.getMessage());
}
}
}

82
flutter/flutter/android/src/main/java/com/arthenica/ffmpegkit/flutter/FFmpegKitFlutterMethodResultHandler.java Normal file
View File

@ -0,0 +1,82 @@
/*
* Copyright (c) 2018-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
package com.arthenica.ffmpegkit.flutter;
import static com.arthenica.ffmpegkit.flutter.FFmpegKitFlutterPlugin.LIBRARY_NAME;
import android.os.Handler;
import android.os.Looper;
import android.util.Log;
import io.flutter.plugin.common.EventChannel;
import io.flutter.plugin.common.MethodChannel;
public class FFmpegKitFlutterMethodResultHandler {
private final Handler handler;
FFmpegKitFlutterMethodResultHandler() {
handler = new Handler(Looper.getMainLooper());
}
void successAsync(final MethodChannel.Result result, final Object object) {
handler.post(() -> {
if (result != null) {
result.success(object);
} else {
Log.w(LIBRARY_NAME, String.format("ResultHandler can not send successful response %s on a null method call result.", object));
}
});
}
void successAsync(final EventChannel.EventSink eventSink, final Object object) {
handler.post(() -> {
if (eventSink != null) {
eventSink.success(object);
} else {
Log.w(LIBRARY_NAME, String.format("ResultHandler can not send event %s on a null event sink.", object));
}
});
}
void errorAsync(final MethodChannel.Result result, final String errorCode, final String errorMessage) {
errorAsync(result, errorCode, errorMessage, null);
}
void errorAsync(final MethodChannel.Result result, final String errorCode, final String errorMessage, final Object errorDetails) {
handler.post(() -> {
if (result != null) {
result.error(errorCode, errorMessage, errorDetails);
} else {
Log.w(LIBRARY_NAME, String.format("ResultHandler can not send failure response %s:%s on a null method call result.", errorCode, errorMessage));
}
});
}
void notImplementedAsync(final MethodChannel.Result result) {
handler.post(() -> {
if (result != null) {
result.notImplemented();
} else {
Log.w(LIBRARY_NAME, "ResultHandler can not send not implemented response on a null method call result.");
}
});
}
}

1429
flutter/flutter/android/src/main/java/com/arthenica/ffmpegkit/flutter/FFmpegKitFlutterPlugin.java Normal file
View File

File diff suppressed because it is too large Load Diff

37
flutter/flutter/ios/.gitignore vendored Normal file
View File

@ -0,0 +1,37 @@
.idea/
.vagrant/
.sconsign.dblite
.svn/
.DS_Store
*.swp
profile
DerivedData/
build/
GeneratedPluginRegistrant.h
GeneratedPluginRegistrant.m
.generated/
*.pbxuser
*.mode1v3
*.mode2v3
*.perspectivev3
!default.pbxuser
!default.mode1v3
!default.mode2v3
!default.perspectivev3
xcuserdata
*.moved-aside
*.pyc
*sync/
Icon?
.tags*
/Flutter/Generated.xcconfig
/Flutter/flutter_export_environment.sh

0
flutter/flutter/ios/Assets/.gitkeep Normal file
View File

23
flutter/flutter/ios/Classes/FFmpegKitFlutterPlugin.h Normal file
View File

@ -0,0 +1,23 @@
/*
* Copyright (c) 2018-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
#import <Flutter/Flutter.h>
@interface FFmpegKitFlutterPlugin : NSObject<FlutterPlugin,FlutterStreamHandler>
@end

1120
flutter/flutter/ios/Classes/FFmpegKitFlutterPlugin.m Normal file
View File

File diff suppressed because it is too large Load Diff

135
flutter/flutter/ios/ffmpeg_kit_flutter.podspec Normal file
View File

@ -0,0 +1,135 @@
Pod::Spec.new do |s|
s.name = 'ffmpeg_kit_flutter'
s.version = '4.5.0'
s.summary = 'FFmpeg Kit for Flutter'
s.description = 'A Flutter plugin for running FFmpeg and FFprobe commands.'
s.homepage = 'https://github.com/tanersener/ffmpeg-kit'
s.license = { :file => '../LICENSE' }
s.author = { 'Taner Sener' => 'tanersener@gmail.com' }
s.platform = :ios
s.requires_arc = true
s.static_framework = true
s.source = { :path => '.' }
s.source_files = 'Classes/**/*'
s.public_header_files = 'Classes/**/*.h'
s.default_subspec = 'https'
s.dependency 'Flutter'
s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES', 'EXCLUDED_ARCHS[sdk=iphonesimulator*]' => 'i386' }
s.subspec 'min' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-ios-min', "4.5"
ss.ios.deployment_target = '12.1'
end
s.subspec 'min-lts' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-ios-min', "4.5.LTS"
ss.ios.deployment_target = '9.3'
end
s.subspec 'min-gpl' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-ios-min-gpl', "4.5"
ss.ios.deployment_target = '12.1'
end
s.subspec 'min-gpl-lts' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-ios-min-gpl', "4.5.LTS"
ss.ios.deployment_target = '9.3'
end
s.subspec 'https' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-ios-https', "4.5"
ss.ios.deployment_target = '12.1'
end
s.subspec 'https-lts' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-ios-https', "4.5.LTS"
ss.ios.deployment_target = '9.3'
end
s.subspec 'https-gpl' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-ios-https-gpl', "4.5"
ss.ios.deployment_target = '12.1'
end
s.subspec 'https-gpl-lts' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-ios-https-gpl', "4.5.LTS"
ss.ios.deployment_target = '9.3'
end
s.subspec 'audio' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-ios-audio', "4.5"
ss.ios.deployment_target = '12.1'
end
s.subspec 'audio-lts' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-ios-audio', "4.5.LTS"
ss.ios.deployment_target = '9.3'
end
s.subspec 'video' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-ios-video', "4.5"
ss.ios.deployment_target = '12.1'
end
s.subspec 'video-lts' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-ios-video', "4.5.LTS"
ss.ios.deployment_target = '9.3'
end
s.subspec 'full' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-ios-full', "4.5"
ss.ios.deployment_target = '12.1'
end
s.subspec 'full-lts' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-ios-full', "4.5.LTS"
ss.ios.deployment_target = '9.3'
end
s.subspec 'full-gpl' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-ios-full-gpl', "4.5"
ss.ios.deployment_target = '12.1'
end
s.subspec 'full-gpl-lts' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-ios-full-gpl', "4.5.LTS"
ss.ios.deployment_target = '9.3'
end
end

434
flutter/flutter/lib/abstract_session.dart Normal file
View File

@ -0,0 +1,434 @@
/*
* Copyright (c) 2019-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
import 'package:ffmpeg_kit_flutter_platform_interface/ffmpeg_kit_flutter_platform_interface.dart';
import 'package:flutter/services.dart';
import 'execute_callback.dart';
import 'ffmpeg_kit_config.dart';
import 'ffmpeg_session.dart';
import 'ffprobe_session.dart';
import 'log.dart';
import 'log_callback.dart';
import 'log_redirection_strategy.dart';
import 'media_information.dart';
import 'media_information_session.dart';
import 'return_code.dart';
import 'session.dart';
import 'session_state.dart';
import 'src/ffmpeg_kit_factory.dart';
/// Abstract session implementation which includes common features shared by
/// "FFmpeg" and "FFprobe" sessions.
class AbstractSession extends Session {
static FFmpegKitPlatform _platform = FFmpegKitPlatform.instance;
/// Defines how long default "getAll" methods wait, in milliseconds.
static const defaultTimeoutForAsynchronousMessagesInTransmit = 5000;
/// Session identifier.
int? _sessionId;
/// Date and time the session was created.
DateTime? _createTime;
/// Date and time the session was started.
DateTime? _startTime;
/// Command string.
String? _command;
/// Command arguments as an array.
List<String>? _argumentsArray;
/// Session specific log redirection strategy.
LogRedirectionStrategy? _logRedirectionStrategy;
/// Creates a new FFmpeg session using [argumentsArray] and
/// [logRedirectionStrategy].
///
/// Returns FFmpeg session created.
static Future<FFmpegSession> createFFmpegSession(List<String> argumentsArray,
[LogRedirectionStrategy? logRedirectionStrategy = null]) async {
try {
await FFmpegKitConfig.init();
final Map<dynamic, dynamic>? nativeSession =
await _platform.abstractSessionCreateFFmpegSession(argumentsArray);
final session = new FFmpegSession();
session._sessionId = nativeSession?["sessionId"];
session._createTime =
FFmpegKitFactory.validDate(nativeSession?["createTime"]);
session._startTime =
FFmpegKitFactory.validDate(nativeSession?["startTime"]);
session._command = nativeSession?["command"];
session._argumentsArray = argumentsArray;
session._logRedirectionStrategy =
logRedirectionStrategy ?? FFmpegKitConfig.getLogRedirectionStrategy();
FFmpegKitFactory.setLogRedirectionStrategy(
session._sessionId, logRedirectionStrategy);
return session;
} on PlatformException catch (e, stack) {
print("Plugin createFFmpegSession error: ${e.message}");
return Future.error("createFFmpegSession failed.", stack);
}
}
/// Creates a new FFmpeg session from [sessionMap], which includes session
/// fields as map keys.
///
/// Returns FFmpeg session created.
static FFmpegSession createFFmpegSessionFromMap(
Map<dynamic, dynamic> sessionMap) {
final session = new FFmpegSession();
session._sessionId = sessionMap["sessionId"];
session._createTime = FFmpegKitFactory.validDate(sessionMap["createTime"]);
session._startTime = FFmpegKitFactory.validDate(sessionMap["startTime"]);
session._command = sessionMap["command"];
session._argumentsArray =
FFmpegKitConfig.parseArguments(sessionMap["command"]);
session._logRedirectionStrategy =
FFmpegKitFactory.getLogRedirectionStrategy(session._sessionId);
return session;
}
/// Creates a new FFprobe session using [argumentsArray] and
/// [logRedirectionStrategy].
///
/// Returns FFprobe session created.
static Future<FFprobeSession> createFFprobeSession(
List<String> argumentsArray,
[LogRedirectionStrategy? logRedirectionStrategy = null]) async {
try {
await FFmpegKitConfig.init();
final Map<dynamic, dynamic>? nativeSession =
await _platform.abstractSessionCreateFFprobeSession(argumentsArray);
final session = new FFprobeSession();
session._sessionId = nativeSession?["sessionId"];
session._createTime =
FFmpegKitFactory.validDate(nativeSession?["createTime"]);
session._startTime =
FFmpegKitFactory.validDate(nativeSession?["startTime"]);
session._command = nativeSession?["command"];
session._argumentsArray = argumentsArray;
session._logRedirectionStrategy =
logRedirectionStrategy ?? FFmpegKitConfig.getLogRedirectionStrategy();
FFmpegKitFactory.setLogRedirectionStrategy(
session._sessionId, logRedirectionStrategy);
return session;
} on PlatformException catch (e, stack) {
print("Plugin createFFprobeSession error: ${e.message}");
return Future.error("createFFprobeSession failed.", stack);
}
}
/// Creates a new FFprobe session from [sessionMap], which includes session
/// fields as map keys.
///
/// Returns FFprobe session created.
static FFprobeSession createFFprobeSessionFromMap(
Map<dynamic, dynamic> sessionMap) {
final session = new FFprobeSession();
session._sessionId = sessionMap["sessionId"];
session._createTime = FFmpegKitFactory.validDate(sessionMap["createTime"]);
session._startTime = FFmpegKitFactory.validDate(sessionMap["startTime"]);
session._command = sessionMap["command"];
session._argumentsArray =
FFmpegKitConfig.parseArguments(sessionMap["command"]);
session._logRedirectionStrategy =
FFmpegKitFactory.getLogRedirectionStrategy(session._sessionId);
return session;
}
/// Creates a new MediaInformation session using [argumentsArray].
///
/// Returns MediaInformation session created.
static Future<MediaInformationSession> createMediaInformationSession(
List<String> argumentsArray) async {
try {
await FFmpegKitConfig.init();
final Map<dynamic, dynamic>? nativeSession = await _platform
.abstractSessionCreateMediaInformationSession(argumentsArray);
final session = new MediaInformationSession();
session._sessionId = nativeSession?["sessionId"];
session._createTime =
FFmpegKitFactory.validDate(nativeSession?["createTime"]);
session._startTime =
FFmpegKitFactory.validDate(nativeSession?["startTime"]);
session._command = nativeSession?["command"];
session._argumentsArray = argumentsArray;
session._logRedirectionStrategy = LogRedirectionStrategy.neverPrintLogs;
FFmpegKitFactory.setLogRedirectionStrategy(
session._sessionId, LogRedirectionStrategy.neverPrintLogs);
return session;
} on PlatformException catch (e, stack) {
print("Plugin createMediaInformationSession error: ${e.message}");
return Future.error("createMediaInformationSession failed.", stack);
}
}
/// Creates a new MediaInformation session from [sessionMap], which includes
/// session fields as map keys.
///
/// Returns MediaInformation session created.
static MediaInformationSession createMediaInformationSessionFromMap(
Map<dynamic, dynamic> sessionMap) {
final session = new MediaInformationSession();
session._sessionId = sessionMap["sessionId"];
session._createTime = FFmpegKitFactory.validDate(sessionMap["createTime"]);
session._startTime = FFmpegKitFactory.validDate(sessionMap["startTime"]);
session._command = sessionMap["command"];
session._argumentsArray =
FFmpegKitConfig.parseArguments(sessionMap["command"]);
session._logRedirectionStrategy = LogRedirectionStrategy.neverPrintLogs;
if (sessionMap.containsKey("mediaInformation")) {
session.setMediaInformation(
new MediaInformation(sessionMap["mediaInformation"]));
}
return session;
}
/// Returns the session specific execute callback function.
ExecuteCallback? getExecuteCallback() =>
FFmpegKitFactory.getExecuteCallback(this.getSessionId());
/// Returns the session specific log callback function.
LogCallback? getLogCallback() =>
FFmpegKitFactory.getLogCallback(this.getSessionId());
/// Returns the session identifier.
int? getSessionId() => this._sessionId;
/// Returns session create time.
DateTime? getCreateTime() => this._createTime;
/// Returns session start time.
DateTime? getStartTime() => this._startTime;
/// Returns session end time.
Future<DateTime?> getEndTime() async {
try {
return _platform
.abstractSessionGetEndTime(this.getSessionId())
.then(FFmpegKitFactory.validDate);
} on PlatformException catch (e, stack) {
print("Plugin getEndTime error: ${e.message}");
return Future.error("getEndTime failed.", stack);
}
}
/// Returns time taken to execute this session in milliseconds or zero (0)
/// if the session is not over yet.
Future<int> getDuration() async {
try {
return _platform
.abstractSessionGetDuration(this.getSessionId())
.then((duration) => duration ?? 0);
} on PlatformException catch (e, stack) {
print("Plugin getDuration error: ${e.message}");
return Future.error("getDuration failed.", stack);
}
}
/// Returns command arguments as an array.
List<String>? getArguments() => this._argumentsArray;
/// Returns command arguments as a concatenated string.
String? getCommand() => this._command;
/// Returns all log entries generated for this session. If there are
/// asynchronous logs that are not delivered yet, this method waits for
/// them until [waitTimeout].
Future<List<Log>> getAllLogs([int? waitTimeout = null]) async {
try {
return _platform
.abstractSessionGetAllLogs(this.getSessionId(), waitTimeout)
.then((allLogs) {
if (allLogs == null) {
return List.empty();
} else {
return allLogs
.map((dynamic logObject) =>
FFmpegKitFactory.mapToLog(logObject as Map<dynamic, dynamic>))
.toList();
}
});
} on PlatformException catch (e, stack) {
print("Plugin getAllLogs error: ${e.message}");
return Future.error("getAllLogs failed.", stack);
}
}
/// Returns all log entries delivered for this session. Note that if there
/// are asynchronous logs that are not delivered yet, this method
/// will not wait for them and will return immediately.
Future<List<Log>> getLogs() async {
try {
return _platform
.abstractSessionGetLogs(this.getSessionId())
.then((allLogs) {
if (allLogs == null) {
return List.empty();
} else {
return allLogs
.map((dynamic logObject) =>
FFmpegKitFactory.mapToLog(logObject as Map<dynamic, dynamic>))
.toList();
}
});
} on PlatformException catch (e, stack) {
print("Plugin getLogs error: ${e.message}");
return Future.error("getLogs failed.", stack);
}
}
/// Returns all log entries generated for this session as a concatenated
/// string. If there are asynchronous logs that are not delivered yet,
/// this method waits for them until [waitTimeout].
Future<String?> getAllLogsAsString([int? waitTimeout = null]) async {
try {
return _platform.abstractSessionGetAllLogsAsString(
this.getSessionId(), waitTimeout);
} on PlatformException catch (e, stack) {
print("Plugin getAllLogsAsString error: ${e.message}");
return Future.error("getAllLogsAsString failed.", stack);
}
}
/// Returns all log entries delivered for this session as a concatenated
/// string. Note that if there are asynchronous logs that are not
/// delivered yet, this method will not wait for them and will return
/// immediately.
Future<String> getLogsAsString() async {
final StringBuffer concatenatedString = new StringBuffer();
void concatLog(Log log) => concatenatedString.write(log.getMessage());
final List<Log> logs = await this.getLogs();
logs.forEach(concatLog);
return concatenatedString.toString();
}
/// Returns the log output generated while running the session.
Future<String?> getOutput() async => this.getAllLogsAsString();
/// Returns the state of the session.
Future<SessionState> getState() async {
try {
return _platform
.abstractSessionGetState(this.getSessionId())
.then((state) {
switch (state) {
case 0:
return SessionState.created;
case 1:
return SessionState.running;
case 2:
return SessionState.failed;
case 3:
default:
return SessionState.completed;
}
});
} on PlatformException catch (e, stack) {
print("Plugin getState error: ${e.message}");
return Future.error("getState failed.", stack);
}
}
/// Returns the return code for this session. Note that return code is only
/// set for sessions that end with COMPLETED state. If a session is not
/// started, still running or failed then this method returns null.
Future<ReturnCode?> getReturnCode() async {
try {
return _platform
.abstractSessionGetReturnCode(this.getSessionId())
.then((returnCode) {
if (returnCode == null) {
return null;
} else {
return new ReturnCode(returnCode);
}
});
} on PlatformException catch (e, stack) {
print("Plugin getReturnCode error: ${e.message}");
return Future.error("getReturnCode failed.", stack);
}
}
/// Returns the stack trace of the exception received while executing this
/// session.
///
/// The stack trace is only set for sessions that end with FAILED state. For
/// sessions that has COMPLETED state this method returns null.
Future<String?> getFailStackTrace() async {
try {
return _platform.abstractSessionGetFailStackTrace(this.getSessionId());
} on PlatformException catch (e, stack) {
print("Plugin getFailStackTrace error: ${e.message}");
return Future.error("getFailStackTrace failed.", stack);
}
}
/// Returns session specific log redirection strategy.
LogRedirectionStrategy? getLogRedirectionStrategy() =>
this._logRedirectionStrategy;
/// Returns whether there are still asynchronous messages being transmitted
/// for this session or not.
Future<bool> thereAreAsynchronousMessagesInTransmit() async {
try {
return _platform.abstractSessionThereAreAsynchronousMessagesInTransmit(
this.getSessionId());
} on PlatformException catch (e, stack) {
print(
"Plugin thereAreAsynchronousMessagesInTransmit error: ${e.message}");
return Future.error(
"thereAreAsynchronousMessagesInTransmit failed.", stack);
}
}
/// Returns whether it is an "FFmpeg" session or not.
bool isFFmpeg() => false;
/// Returns whether it is an "FFprobe" session or not.
bool isFFprobe() => false;
/// Cancels running the session.
void cancel() {}
}

39
flutter/flutter/lib/arch_detect.dart Normal file
View File

@ -0,0 +1,39 @@
/*
* Copyright (c) 2019-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
import 'package:ffmpeg_kit_flutter_platform_interface/ffmpeg_kit_flutter_platform_interface.dart';
import 'package:flutter/services.dart';
import 'ffmpeg_kit_config.dart';
/// Detects the running architecture.
class ArchDetect {
static FFmpegKitPlatform _platform = FFmpegKitPlatform.instance;
/// Returns architecture name loaded.
static Future<String> getArch() async {
try {
await FFmpegKitConfig.init();
return _platform.archDetectGetArch();
} on PlatformException catch (e, stack) {
print("Plugin getArch error: ${e.message}");
return Future.error("getArch failed.", stack);
}
}
}

29
flutter/flutter/lib/execute_callback.dart Normal file
View File

@ -0,0 +1,29 @@
/*
* Copyright (c) 2019-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
import 'session.dart';
/// Callback function invoked when a session ends running.
/// Session has either SessionState.completed or SessionState.failed state when
/// the callback is invoked.
/// If it has SessionState.completed state, "ReturnCode" should be checked to
/// see the execution result.
/// If "getState" returns SessionState.failed then "getFailStackTrace" should
/// be used to get the failure reason.
typedef ExecuteCallback = void Function(Session session);

94
flutter/flutter/lib/ffmpeg_kit.dart Normal file
View File

@ -0,0 +1,94 @@
/*
* Copyright (c) 2019-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
import 'package:ffmpeg_kit_flutter_platform_interface/ffmpeg_kit_flutter_platform_interface.dart';
import 'package:flutter/services.dart';
import 'execute_callback.dart';
import 'ffmpeg_kit_config.dart';
import 'ffmpeg_session.dart';
import 'log_callback.dart';
import 'src/ffmpeg_kit_factory.dart';
import 'statistics_callback.dart';
/// Main class to run "FFmpeg" commands.
class FFmpegKit {
static FFmpegKitPlatform _platform = FFmpegKitPlatform.instance;
/// Asynchronously executes FFmpeg with command provided.
static Future<FFmpegSession> executeAsync(String command,
[ExecuteCallback? executeCallback = null,
LogCallback? logCallback = null,
StatisticsCallback? statisticsCallback = null]) async =>
FFmpegKit.executeWithArgumentsAsync(
FFmpegKitConfig.parseArguments(command),
executeCallback,
logCallback,
statisticsCallback);
/// Asynchronously executes FFmpeg with arguments provided.
static Future<FFmpegSession> executeWithArgumentsAsync(
List<String> commandArguments,
[ExecuteCallback? executeCallback = null,
LogCallback? logCallback = null,
StatisticsCallback? statisticsCallback = null]) async {
final session = await FFmpegSession.create(commandArguments,
executeCallback, logCallback, statisticsCallback, null);
await FFmpegKitConfig.asyncFFmpegExecute(session);
return session;
}
/// Cancels the session specified with [sessionId].
static Future<void> cancel([int? sessionId = null]) async {
try {
await FFmpegKitConfig.init();
if (sessionId == null) {
return _platform.ffmpegKitCancel();
} else {
return _platform.ffmpegKitCancelSession(sessionId);
}
} on PlatformException catch (e, stack) {
print("Plugin cancel error: ${e.message}");
return Future.error("cancel failed.", stack);
}
}
/// Lists all FFmpeg sessions in the session history.
static Future<List<FFmpegSession>> listSessions() async {
try {
await FFmpegKitConfig.init();
return _platform.ffmpegKitListSessions().then((sessions) {
if (sessions == null) {
return List.empty();
} else {
return sessions
.map((dynamic sessionObject) => FFmpegKitFactory.mapToSession(
sessionObject as Map<dynamic, dynamic>))
.map((session) => session as FFmpegSession)
.toList();
}
});
} on PlatformException catch (e, stack) {
print("Plugin listSessions error: ${e.message}");
return Future.error("listSessions failed.", stack);
}
}
}

650
flutter/flutter/lib/ffmpeg_kit_config.dart Normal file
View File

@ -0,0 +1,650 @@
/*
* Copyright (c) 2019-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
import 'package:ffmpeg_kit_flutter_platform_interface/ffmpeg_kit_flutter_platform_interface.dart';
import 'package:flutter/services.dart';
import 'execute_callback.dart';
import 'ffmpeg_session.dart';
import 'ffprobe_session.dart';
import 'level.dart';
import 'log_callback.dart';
import 'log_redirection_strategy.dart';
import 'media_information_session.dart';
import 'session.dart';
import 'session_state.dart';
import 'signal.dart';
import 'src/ffmpeg_kit_factory.dart';
import 'src/ffmpeg_kit_flutter_initializer.dart';
import 'statistics_callback.dart';
/// Configuration class of "FFmpegKit" library.
class FFmpegKitConfig {
static FFmpegKitPlatform _platform = FFmpegKitPlatform.instance;
static LogRedirectionStrategy _globalLogRedirectionStrategy =
LogRedirectionStrategy.printLogsWhenNoCallbacksDefined;
static int _activeLogLevel = Level.avLogTrace;
/// Initializes the library asynchronously.
static Future<void> init() async {
await FFmpegKitInitializer.initialize();
}
/// Enables log and statistics redirection.
///
/// When redirection is enabled FFmpeg/FFprobe logs are redirected to console
/// and sessions collect log and statistics entries for the executions. It
/// is possible to define global or session specific log/statistics callbacks
/// as well.
///
/// Note that redirection is enabled by default. If you do not want to use
/// its functionality please use [disableRedirection] to disable it.
static Future<void> enableRedirection() async {
try {
await init();
return _platform.ffmpegKitConfigEnableRedirection();
} on PlatformException catch (e, stack) {
print("Plugin enableRedirection error: ${e.message}");
return Future.error("enableRedirection failed.", stack);
}
}
/// Disables log and statistics redirection.
///
/// When redirection is disabled logs are printed to stderr, all logs and
/// statistics callbacks are disabled and "FFprobeKit.getMediaInformation"
/// methods do not work.
static Future<void> disableRedirection() async {
try {
await init();
return _platform.ffmpegKitConfigDisableRedirection();
} on PlatformException catch (e, stack) {
print("Plugin disableRedirection error: ${e.message}");
return Future.error("disableRedirection failed.", stack);
}
}
/// Sets and overrides "fontconfig" configuration directory.
static Future<void> setFontconfigConfigurationPath(String path) async {
try {
await init();
return _platform.ffmpegKitConfigSetFontconfigConfigurationPath(path);
} on PlatformException catch (e, stack) {
print("Plugin setFontconfigConfigurationPath error: ${e.message}");
return Future.error("setFontconfigConfigurationPath failed.", stack);
}
}
/// Registers the fonts inside the given path, so they become available to
/// use in FFmpeg filters.
///
/// Note that you need to use a package with "fontconfig" inside to be able
/// to use fonts in "FFmpeg".
static Future<void> setFontDirectory(String path,
[Map<String, String>? mapping = null]) async {
try {
await init();
return _platform.ffmpegKitConfigSetFontDirectory(path, mapping);
} on PlatformException catch (e, stack) {
print("Plugin setFontDirectory error: ${e.message}");
return Future.error("setFontDirectory failed.", stack);
}
}
/// Registers the fonts inside the given list of font directories, so they
/// become available to use in FFmpeg filters.
///
/// Note that you need to use a package with "fontconfig" inside to be able
/// to use fonts in "FFmpeg".
static Future<void> setFontDirectoryList(List<String> fontDirectoryList,
[Map<String, String>? mapping = null]) async {
try {
await init();
return _platform.ffmpegKitConfigSetFontDirectoryList(
fontDirectoryList, mapping);
} on PlatformException catch (e, stack) {
print("Plugin setFontDirectoryList error: ${e.message}");
return Future.error("setFontDirectoryList failed.", stack);
}
}
/// Creates a new named pipe to use in "FFmpeg" operations.
///
/// Please note that creator is responsible of closing created pipes.
static Future<String?> registerNewFFmpegPipe() async {
try {
await init();
return _platform.ffmpegKitConfigRegisterNewFFmpegPipe();
} on PlatformException catch (e, stack) {
print("Plugin registerNewFFmpegPipe error: ${e.message}");
return Future.error("registerNewFFmpegPipe failed.", stack);
}
}
/// Closes a previously created "FFmpeg" pipe.
static Future<void> closeFFmpegPipe(String ffmpegPipePath) async {
try {
await init();
return _platform.ffmpegKitConfigCloseFFmpegPipe(ffmpegPipePath);
} on PlatformException catch (e, stack) {
print("Plugin closeFFmpegPipe error: ${e.message}");
return Future.error("closeFFmpegPipe failed.", stack);
}
}
/// Returns the version of FFmpeg bundled within "FFmpegKit" library.
static Future<String?> getFFmpegVersion() async {
try {
await init();
return _platform.ffmpegKitConfigGetFFmpegVersion();
} on PlatformException catch (e, stack) {
print("Plugin getFFmpegVersion error: ${e.message}");
return Future.error("getFFmpegVersion failed.", stack);
}
}
/// Returns FFmpegKit Flutter library version.
static Future<String> getVersion() async => FFmpegKitFactory.getVersion();
/// Returns whether FFmpegKit release is a Long Term Release or not.
static Future<bool> isLTSBuild() async {
try {
await init();
return _platform.ffmpegKitConfigIsLTSBuild().then((value) {
if (value == null) {
return false;
} else {
return value;
}
});
} on PlatformException catch (e, stack) {
print("Plugin isLTSBuild error: ${e.message}");
return Future.error("isLTSBuild failed.", stack);
}
}
/// Returns FFmpegKit native library build date.
static Future<String?> getBuildDate() async {
try {
await init();
return _platform.ffmpegKitConfigGetBuildDate();
} on PlatformException catch (e, stack) {
print("Plugin getBuildDate error: ${e.message}");
return Future.error("getBuildDate failed.", stack);
}
}
/// Sets an environment variable.
static Future<void> setEnvironmentVariable(String name, String value) async {
try {
await init();
return _platform.ffmpegKitConfigSetEnvironmentVariable(name, value);
} on PlatformException catch (e, stack) {
print("Plugin setEnvironmentVariable error: ${e.message}");
return Future.error("setEnvironmentVariable failed.", stack);
}
}
/// Registers a new ignored signal. Ignored signals are not handled by
/// "FFmpegKit" library.
static Future<void> ignoreSignal(Signal signal) async {
try {
await init();
return _platform.ffmpegKitConfigIgnoreSignal(signal.index);
} on PlatformException catch (e, stack) {
print("Plugin ignoreSignal error: ${e.message}");
return Future.error("ignoreSignal failed.", stack);
}
}
/// Asynchronously executes the [ffmpegSession] provided.
static Future<void> asyncFFmpegExecute(FFmpegSession ffmpegSession) async {
try {
await init();
return _platform
.ffmpegKitConfigAsyncFFmpegExecute(ffmpegSession.getSessionId());
} on PlatformException catch (e, stack) {
print("Plugin asyncFFmpegExecute error: ${e.message}");
return Future.error("asyncFFmpegExecute failed.", stack);
}
}
/// Asynchronously executes the [ffprobeSession] provided.
static Future<void> asyncFFprobeExecute(FFprobeSession ffprobeSession) async {
try {
await init();
return _platform
.ffmpegKitConfigAsyncFFprobeExecute(ffprobeSession.getSessionId());
} on PlatformException catch (e, stack) {
print("Plugin asyncFFprobeExecute error: ${e.message}");
return Future.error("asyncFFprobeExecute failed.", stack);
}
}
/// Asynchronously executes the [mediaInformationSession] provided.
static Future<void> asyncGetMediaInformationExecute(
MediaInformationSession mediaInformationSession,
[int? waitTimeout = null]) async {
try {
await init();
return _platform.ffmpegKitConfigAsyncGetMediaInformationExecute(
mediaInformationSession.getSessionId(), waitTimeout);
} on PlatformException catch (e, stack) {
print("Plugin asyncGetMediaInformationExecute error: ${e.message}");
return Future.error("asyncGetMediaInformationExecute failed.", stack);
}
}
/// Sets a global callback function to redirect FFmpeg/FFprobe logs.
static void enableLogCallback([LogCallback? logCallback = null]) {
FFmpegKitFactory.setGlobalLogCallback(logCallback);
}
/// Sets a global callback function to redirect FFmpeg statistics.
static void enableStatisticsCallback(
[StatisticsCallback? statisticsCallback = null]) {
FFmpegKitFactory.setGlobalStatisticsCallback(statisticsCallback);
}
/// Sets a global callback function to receive execution results.
static void enableExecuteCallback([ExecuteCallback? executeCallback = null]) {
FFmpegKitFactory.setGlobalExecuteCallback(executeCallback);
}
/// Returns the current log level.
static int getLogLevel() => _activeLogLevel;
/// Sets the log level.
static Future<void> setLogLevel(int logLevel) async {
_activeLogLevel = logLevel;
try {
await init();
return _platform.ffmpegKitConfigSetLogLevel(logLevel);
} on PlatformException catch (e, stack) {
print("Plugin setLogLevel error: ${e.message}");
return Future.error("setLogLevel failed.", stack);
}
}
/// Returns the session history size.
static Future<int?> getSessionHistorySize() async {
try {
await init();
return _platform.ffmpegKitConfigGetSessionHistorySize();
} on PlatformException catch (e, stack) {
print("Plugin getSessionHistorySize error: ${e.message}");
return Future.error("getSessionHistorySize failed.", stack);
}
}
/// Sets the session history size.
static Future<void> setSessionHistorySize(int sessionHistorySize) async {
try {
await init();
return _platform.ffmpegKitConfigSetSessionHistorySize(sessionHistorySize);
} on PlatformException catch (e, stack) {
print("Plugin setSessionHistorySize error: ${e.message}");
return Future.error("setSessionHistorySize failed.", stack);
}
}
/// Returns the session specified with "sessionId" from the session history.
static Future<Session?> getSession(int sessionId) async {
try {
await init();
return _platform
.ffmpegKitConfigGetSession(sessionId)
.then(FFmpegKitFactory.mapToNullableSession);
} on PlatformException catch (e, stack) {
print("Plugin getSession error: ${e.message}");
return Future.error("getSession failed.", stack);
}
}
/// Returns the last session created from the session history.
static Future<Session?> getLastSession() async {
try {
await init();
return _platform
.ffmpegKitConfigGetLastSession()
.then(FFmpegKitFactory.mapToNullableSession);
} on PlatformException catch (e, stack) {
print("Plugin getLastSession error: ${e.message}");
return Future.error("getLastSession failed.", stack);
}
}
/// Returns the last session completed from the session history.
static Future<Session?> getLastCompletedSession() async {
try {
await init();
return _platform
.ffmpegKitConfigGetLastCompletedSession()
.then(FFmpegKitFactory.mapToNullableSession);
} on PlatformException catch (e, stack) {
print("Plugin getLastCompletedSession error: ${e.message}");
return Future.error("getLastCompletedSession failed.", stack);
}
}
/// Returns all sessions in the session history.
static Future<List<Session>> getSessions() async {
try {
await init();
return _platform.ffmpegKitConfigGetSessions().then((sessions) {
if (sessions == null) {
return List.empty();
} else {
return sessions
.map((dynamic sessionObject) => FFmpegKitFactory.mapToSession(
sessionObject as Map<dynamic, dynamic>))
.toList();
}
});
} on PlatformException catch (e, stack) {
print("Plugin getSessions error: ${e.message}");
return Future.error("getSessions failed.", stack);
}
}
/// Clears all, including ongoing, sessions in the session history.
/// Note that callbacks cannot be triggered for deleted sessions.
static Future<void> clearSessions() async {
try {
await init();
return _platform.clearSessions();
} on PlatformException catch (e, stack) {
print("Plugin clearSessions error: ${e.message}");
return Future.error("clearSessions failed.", stack);
}
}
/// Returns sessions that have [sessionState].
static Future<List<Session>> getSessionsByState(
SessionState sessionState) async {
try {
await init();
return _platform
.ffmpegKitConfigGetSessionsByState(sessionState.index)
.then((sessions) {
if (sessions == null) {
return List.empty();
} else {
return sessions
.map((dynamic sessionObject) => FFmpegKitFactory.mapToSession(
sessionObject as Map<dynamic, dynamic>))
.toList();
}
});
} on PlatformException catch (e, stack) {
print("Plugin getSessionsByState error: ${e.message}");
return Future.error("getSessionsByState failed.", stack);
}
}
/// Returns the active log redirection strategy.
static LogRedirectionStrategy getLogRedirectionStrategy() =>
_globalLogRedirectionStrategy;
/// Sets the log redirection strategy.
static void setLogRedirectionStrategy(
LogRedirectionStrategy logRedirectionStrategy) {
_globalLogRedirectionStrategy = logRedirectionStrategy;
}
/// Returns the number of messages that are not transmitted to the
/// Flutter callbacks yet for this session.
static Future<int?> messagesInTransmit(int sessionId) async {
try {
await init();
return _platform.ffmpegKitConfigMessagesInTransmit(sessionId);
} on PlatformException catch (e, stack) {
print("Plugin messagesInTransmit error: ${e.message}");
return Future.error("messagesInTransmit failed.", stack);
}
}
/// Returns the string representation of the SessionState provided.
static String sessionStateToString(SessionState state) {
switch (state) {
case SessionState.created:
return "CREATED";
case SessionState.running:
return "RUNNING";
case SessionState.failed:
return "FAILED";
case SessionState.completed:
return "COMPLETED";
default:
return "";
}
}
/// Parses [command] into arguments. Uses space character to split the
/// arguments. Supports single and double quote characters.
static List<String> parseArguments(String command) {
final List<String> argumentList = List<String>.empty(growable: true);
StringBuffer currentArgument = new StringBuffer();
bool singleQuoteStarted = false;
bool doubleQuoteStarted = false;
for (int i = 0; i < command.length; i++) {
int? previousChar;
if (i > 0) {
previousChar = command.codeUnitAt(i - 1);
} else {
previousChar = null;
}
final currentChar = command.codeUnitAt(i);
if (currentChar == ' '.codeUnitAt(0)) {
if (singleQuoteStarted || doubleQuoteStarted) {
currentArgument.write(String.fromCharCode(currentChar));
} else if (currentArgument.length > 0) {
argumentList.add(currentArgument.toString());
currentArgument = new StringBuffer();
}
} else if (currentChar == '\''.codeUnitAt(0) &&
(previousChar == null || previousChar != '\\'.codeUnitAt(0))) {
if (singleQuoteStarted) {
singleQuoteStarted = false;
} else if (doubleQuoteStarted) {
currentArgument.write(String.fromCharCode(currentChar));
} else {
singleQuoteStarted = true;
}
} else if (currentChar == '\"'.codeUnitAt(0) &&
(previousChar == null || previousChar != '\\'.codeUnitAt(0))) {
if (doubleQuoteStarted) {
doubleQuoteStarted = false;
} else if (singleQuoteStarted) {
currentArgument.write(String.fromCharCode(currentChar));
} else {
doubleQuoteStarted = true;
}
} else {
currentArgument.write(String.fromCharCode(currentChar));
}
}
if (currentArgument.length > 0) {
argumentList.add(currentArgument.toString());
}
return argumentList;
}
/// Concatenates arguments into a string adding a space character between
/// two arguments.
static String argumentsToString(List<String>? arguments) {
if (arguments == null) {
return "null";
}
final StringBuffer stringBuffer = new StringBuffer();
for (int i = 0; i < arguments.length; i++) {
if (i > 0) {
stringBuffer.write(" ");
}
stringBuffer.write(arguments[i]);
}
return stringBuffer.toString();
}
// THE FOLLOWING METHODS ARE FLUTTER SPECIFIC
/// Enables logs.
static Future<void> enableLogs() async {
try {
await init();
return _platform.ffmpegKitConfigEnableLogs();
} on PlatformException catch (e, stack) {
print("Plugin enableLogs error: ${e.message}");
return Future.error("enableLogs failed.", stack);
}
}
/// Disable logs.
static Future<void> disableLogs() async {
try {
await init();
return _platform.ffmpegKitConfigDisableLogs();
} on PlatformException catch (e, stack) {
print("Plugin disableLogs error: ${e.message}");
return Future.error("disableLogs failed.", stack);
}
}
/// Enables statistics.
static Future<void> enableStatistics() async {
try {
await init();
return _platform.ffmpegKitConfigEnableStatistics();
} on PlatformException catch (e, stack) {
print("Plugin enableStatistics error: ${e.message}");
return Future.error("enableStatistics failed.", stack);
}
}
/// Disables statistics.
static Future<void> disableStatistics() async {
try {
await init();
return _platform.ffmpegKitConfigDisableStatistics();
} on PlatformException catch (e, stack) {
print("Plugin disableStatistics error: ${e.message}");
return Future.error("disableStatistics failed.", stack);
}
}
/// Returns the platform name the library is loaded on.
static Future<String?> getPlatform() async {
try {
await init();
return _platform.ffmpegKitConfigGetPlatform();
} on PlatformException catch (e, stack) {
print("Plugin getPlatform error: ${e.message}");
return Future.error("getPlatform failed.", stack);
}
}
/// Writes [inputPath] to [pipePath].
static Future<int?> writeToPipe(String inputPath, String pipePath) async {
try {
await init();
return _platform.ffmpegKitConfigWriteToPipe(inputPath, pipePath);
} on PlatformException catch (e, stack) {
print("Plugin writeToPipe error: ${e.message}");
return Future.error("writeToPipe failed.", stack);
}
}
/// Displays the native file dialog to select a file in read mode. If a file
/// is selected then this method returns the Structured Access Framework Uri
/// ("content:…") for that file.
///
/// Note that this method is Android only. It will fail if called on other
/// platforms.
static Future<String?> selectDocumentForRead(
[String? type = null, List<String>? extraTypes = null]) async {
try {
await init();
return _platform.ffmpegKitConfigSelectDocumentForRead(type, extraTypes);
} on PlatformException catch (e, stack) {
print("Plugin selectDocumentForRead error: ${e.message}");
return Future.error("selectDocumentForRead failed.", stack);
}
}
/// Displays the native file dialog to select a file in write mode. If a file
/// is selected then this method returns the Structured Access Framework Uri
/// ("content:…") for that file.
///
/// Note that this method is Android only. It will fail if called on other
/// platforms.
static Future<String?> selectDocumentForWrite(
[String? title = null,
String? type = null,
List<String>? extraTypes = null]) async {
try {
await init();
return _platform.ffmpegKitConfigSelectDocumentForWrite(
title, type, extraTypes);
} on PlatformException catch (e, stack) {
print("Plugin selectDocumentForWrite error: ${e.message}");
return Future.error("selectDocumentForWrite failed.", stack);
}
}
/// Converts the given Structured Access Framework Uri ("content:…") into
/// an input url that can be used in FFmpeg and FFprobe commands.
///
/// Note that this method is Android only. It will fail if called on other
/// platforms. It also requires API Level &ge; 19. On older API levels it
/// returns an empty url.
static Future<String?> getSafParameterForRead(String uriString) async {
try {
await init();
return _platform.ffmpegKitConfigGetSafParameterForRead(uriString);
} on PlatformException catch (e, stack) {
print("Plugin getSafParameterForRead error: ${e.message}");
return Future.error("getSafParameterForRead failed.", stack);
}
}
/// Converts the given Structured Access Framework Uri ("content:…") into
/// an output url that can be used in FFmpeg and FFprobe commands.
///
/// Note that this method is Android only. It will fail if called on other
/// platforms. It also requires API Level &ge; 19. On older API levels it
/// returns an empty url.
static Future<String?> getSafParameterForWrite(String uriString) async {
try {
await init();
return _platform.ffmpegKitConfigGetSafParameterForWrite(uriString);
} on PlatformException catch (e, stack) {
print("Plugin getSafParameterForWrite error: ${e.message}");
return Future.error("getSafParameterForWrite failed.", stack);
}
}
}

123
flutter/flutter/lib/ffmpeg_session.dart Normal file
View File

@ -0,0 +1,123 @@
/*
* Copyright (c) 2019-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
import 'package:ffmpeg_kit_flutter_platform_interface/ffmpeg_kit_flutter_platform_interface.dart';
import 'package:flutter/services.dart';
import 'abstract_session.dart';
import 'execute_callback.dart';
import 'ffmpeg_kit_config.dart';
import 'log_callback.dart';
import 'log_redirection_strategy.dart';
import 'src/ffmpeg_kit_factory.dart';
import 'statistics.dart';
import 'statistics_callback.dart';
/// An FFmpeg session.
class FFmpegSession extends AbstractSession {
/// Creates a new FFmpeg session with [argumentsArray].
static Future<FFmpegSession> create(List<String> argumentsArray,
[ExecuteCallback? executeCallback = null,
LogCallback? logCallback = null,
StatisticsCallback? statisticsCallback = null,
LogRedirectionStrategy? logRedirectionStrategy = null]) async {
final session = await AbstractSession.createFFmpegSession(
argumentsArray, logRedirectionStrategy);
final sessionId = session.getSessionId();
FFmpegKitFactory.setExecuteCallback(sessionId, executeCallback);
FFmpegKitFactory.setLogCallback(sessionId, logCallback);
FFmpegKitFactory.setStatisticsCallback(sessionId, statisticsCallback);
return session;
}
/// Creates a new FFmpeg session from [sessionMap], which includes session
/// fields as map keys.
static FFmpegSession fromMap(Map<dynamic, dynamic> sessionMap) =>
AbstractSession.createFFmpegSessionFromMap(sessionMap);
/// Returns the session specific statistics callback function.
StatisticsCallback? getStatisticsCallback() =>
FFmpegKitFactory.getStatisticsCallback(this.getSessionId());
/// Returns all statistics entries generated for this session. If there are
/// asynchronous statistics that are not delivered yet, this method waits for
/// them until [waitTimeout].
Future<List<Statistics>> getAllStatistics([int? waitTimeout]) async {
try {
await FFmpegKitConfig.init();
return FFmpegKitPlatform.instance
.ffmpegSessionGetAllStatistics(this.getSessionId(), waitTimeout)
.then((allStatistics) {
if (allStatistics == null) {
return List.empty();
} else {
return allStatistics
.map((dynamic statisticsObject) =>
FFmpegKitFactory.mapToStatistics(
statisticsObject as Map<dynamic, dynamic>))
.toList();
}
});
} on PlatformException catch (e, stack) {
print("Plugin getAllStatistics error: ${e.message}");
return Future.error("getAllStatistics failed.", stack);
}
}
/// Returns all statistics entries delivered for this session. Note that if
/// there are asynchronous statistics that are not delivered yet, this method
/// will not wait for them and will return immediately.
Future<List<Statistics>> getStatistics() async {
try {
await FFmpegKitConfig.init();
return FFmpegKitPlatform.instance
.ffmpegSessionGetStatistics(this.getSessionId())
.then((statistics) {
if (statistics == null) {
return List.empty();
} else {
return statistics
.map((dynamic statisticsObject) =>
FFmpegKitFactory.mapToStatistics(
statisticsObject as Map<dynamic, dynamic>))
.toList();
}
});
} on PlatformException catch (e, stack) {
print("Plugin getStatistics error: ${e.message}");
return Future.error("getStatistics failed.", stack);
}
}
/// Returns the last received statistics entry.
Future<Statistics?> getLastReceivedStatistics() async =>
this.getStatistics().then((statistics) {
if (statistics.length > 0) {
return statistics[statistics.length - 1];
} else {
return null;
}
});
bool isFFmpeg() => true;
bool isFFprobe() => false;
}

124
flutter/flutter/lib/ffprobe_kit.dart Normal file
View File

@ -0,0 +1,124 @@
/*
* Copyright (c) 2019-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
import 'package:ffmpeg_kit_flutter_platform_interface/ffmpeg_kit_flutter_platform_interface.dart';
import 'package:flutter/services.dart';
import 'execute_callback.dart';
import 'ffmpeg_kit_config.dart';
import 'ffprobe_session.dart';
import 'log_callback.dart';
import 'media_information_session.dart';
import 'src/ffmpeg_kit_factory.dart';
/// Main class to run "FFprobe" commands.
class FFprobeKit {
static FFmpegKitPlatform _platform = FFmpegKitPlatform.instance;
/// Asynchronously executes FFprobe with [command] provided.
static Future<FFprobeSession> executeAsync(String command,
[ExecuteCallback? executeCallback = null,
LogCallback? logCallback = null]) async =>
FFprobeKit.executeWithArgumentsAsync(
FFmpegKitConfig.parseArguments(command),
executeCallback,
logCallback);
/// Asynchronously executes FFprobe with [commandArguments] provided.
static Future<FFprobeSession> executeWithArgumentsAsync(
List<String> commandArguments,
[ExecuteCallback? executeCallback = null,
LogCallback? logCallback = null]) async {
final session = await FFprobeSession.create(
commandArguments, executeCallback, logCallback, null);
await FFmpegKitConfig.asyncFFprobeExecute(session);
return session;
}
/// Extracts the media information for the file at [path] asynchronously.
static Future<MediaInformationSession> getMediaInformationAsync(String path,
[ExecuteCallback? executeCallback = null,
LogCallback? logCallback = null,
int? waitTimeout = null]) async {
final commandArguments = [
"-v",
"error",
"-hide_banner",
"-print_format",
"json",
"-show_format",
"-show_streams",
"-i",
path
];
return FFprobeKit.getMediaInformationFromCommandArgumentsAsync(
commandArguments, executeCallback, logCallback, waitTimeout);
}
/// Extracts media information using the [command] provided asynchronously.
static Future<MediaInformationSession> getMediaInformationFromCommandAsync(
String command,
[ExecuteCallback? executeCallback = null,
LogCallback? logCallback = null,
int? waitTimeout = null]) async =>
FFprobeKit.getMediaInformationFromCommandArgumentsAsync(
FFmpegKitConfig.parseArguments(command),
executeCallback,
logCallback,
waitTimeout);
/// Extracts media information using the [commandArguments] provided
/// asynchronously.
static Future<MediaInformationSession>
getMediaInformationFromCommandArgumentsAsync(
List<String> commandArguments,
[ExecuteCallback? executeCallback = null,
LogCallback? logCallback = null,
int? waitTimeout = null]) async {
final session = await MediaInformationSession.create(
commandArguments, executeCallback, logCallback);
await FFmpegKitConfig.asyncGetMediaInformationExecute(session, waitTimeout);
return session;
}
/// Lists all FFprobe sessions in the session history.
static Future<List<FFprobeSession>> listSessions() async {
try {
await FFmpegKitConfig.init();
return _platform.ffprobeKitListSessions().then((sessions) {
if (sessions == null) {
return List.empty();
} else {
return sessions
.map((dynamic sessionObject) => FFmpegKitFactory.mapToSession(
sessionObject as Map<dynamic, dynamic>))
.map((session) => session as FFprobeSession)
.toList();
}
});
} on PlatformException catch (e, stack) {
print("Plugin listSessions error: ${e.message}");
return Future.error("listSessions failed.", stack);
}
}
}

51
flutter/flutter/lib/ffprobe_session.dart Normal file
View File

@ -0,0 +1,51 @@
/*
* Copyright (c) 2019-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
import 'abstract_session.dart';
import 'execute_callback.dart';
import 'log_callback.dart';
import 'log_redirection_strategy.dart';
import 'src/ffmpeg_kit_factory.dart';
/// An FFprobe session.
class FFprobeSession extends AbstractSession {
/// Creates a new FFprobe session with [argumentsArray].
static Future<FFprobeSession> create(List<String> argumentsArray,
[ExecuteCallback? executeCallback = null,
LogCallback? logCallback = null,
LogRedirectionStrategy? logRedirectionStrategy = null]) async {
final session = await AbstractSession.createFFprobeSession(
argumentsArray, logRedirectionStrategy);
final sessionId = session.getSessionId();
FFmpegKitFactory.setExecuteCallback(sessionId, executeCallback);
FFmpegKitFactory.setLogCallback(sessionId, logCallback);
return session;
}
/// Creates a new FFprobe session from [sessionMap], which includes session
/// fields as map keys.
static FFprobeSession fromMap(Map<dynamic, dynamic> sessionMap) =>
AbstractSession.createFFprobeSessionFromMap(sessionMap);
bool isFFmpeg() => false;
bool isFFprobe() => true;
}

84
flutter/flutter/lib/level.dart Normal file
View File

@ -0,0 +1,84 @@
/*
* Copyright (c) 2019-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
/// Defines log levels.
class Level {
/// This log level is defined by FFmpegKit. It is used to specify logs
/// printed to stderr by FFmpeg. Logs that has this level are not filtered
/// and always redirected.
static const int avLogStderr = -16;
/// Print no output.
static const int avLogQuiet = -8;
/// Something went really wrong and we will crash now.
static const int avLogPanic = 0;
/// Something went wrong and recovery is not possible.
/// For example, no header was found for a format which depends
/// on headers or an illegal combination of parameters is used.
static const int avLogFatal = 8;
/// Something went wrong and cannot losslessly be recovered.
/// However, not all future data is affected.
static const int avLogError = 16;
/// Something somehow does not look correct. This may or may not
/// lead to problems. An example would be the use of '-vstrict -2'.
static const int avLogWarning = 24;
/// int Standard information.
static const int avLogInfo = 32;
/// Detailed information.
static const int avLogVerbose = 40;
/// Stuff which is only useful for libav* developers.
static const int avLogDebug = 48;
/// Extremely verbose debugging, useful for libav* development.
static const int avLogTrace = 56;
/// Returns log level string from int
static String levelToString(int level) {
switch (level) {
case Level.avLogTrace:
return "TRACE";
case Level.avLogDebug:
return "DEBUG";
case Level.avLogVerbose:
return "VERBOSE";
case Level.avLogInfo:
return "INFO";
case Level.avLogWarning:
return "WARNING";
case Level.avLogError:
return "ERROR";
case Level.avLogFatal:
return "FATAL";
case Level.avLogPanic:
return "PANIC";
case Level.avLogStderr:
return "STDERR";
case Level.avLogQuiet:
default:
return "";
}
}
}

33
flutter/flutter/lib/log.dart Normal file
View File

@ -0,0 +1,33 @@
/*
* Copyright (c) 2019-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
/// Log entry for an FFmpegKit session.
class Log {
int _sessionId;
int _level;
String _message;
Log(this._sessionId, this._level, this._message);
int getSessionId() => _sessionId;
int getLevel() => _level;
String getMessage() => _message;
}

23
flutter/flutter/lib/log_callback.dart Normal file
View File

@ -0,0 +1,23 @@
/*
* Copyright (c) 2019-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
import 'log.dart';
/// Callback function that receives logs generated for "FFmpegKit" sessions.
typedef LogCallback = void Function(Log log);

26
flutter/flutter/lib/log_redirection_strategy.dart Normal file
View File

@ -0,0 +1,26 @@
/*
* Copyright (c) 2019-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
enum LogRedirectionStrategy {
alwaysPrintLogs,
printLogsWhenNoCallbacksDefined,
printLogsWhenGlobalCallbackNotDefined,
printLogsWhenSessionCallbackNotDefined,
neverPrintLogs
}

96
flutter/flutter/lib/media_information.dart Normal file
View File

@ -0,0 +1,96 @@
/*
* Copyright (c) 2019-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
import 'stream_information.dart';
/// Media information class.
class MediaInformation {
static const keyMediaProperties = "format";
static const keyFilename = "filename";
static const keyFormat = "format_name";
static const keyFormatLong = "format_long_name";
static const keyStartTime = "start_time";
static const keyDuration = "duration";
static const keySize = "size";
static const keyBitRate = "bit_rate";
static const keyTags = "tags";
Map<dynamic, dynamic>? _allProperties;
/// Creates a new [MediaInformation] instance
MediaInformation(this._allProperties);
/// Returns file name.
String? getFilename() => this.getStringProperty(MediaInformation.keyFilename);
/// Returns format.
String? getFormat() => this.getStringProperty(MediaInformation.keyFormat);
/// Returns long format.
String? getLongFormat() =>
this.getStringProperty(MediaInformation.keyFormatLong);
/// Returns duration.
String? getDuration() => this.getStringProperty(MediaInformation.keyDuration);
/// Returns start time.
String? getStartTime() =>
this.getStringProperty(MediaInformation.keyStartTime);
/// Returns size.
String? getSize() => this.getStringProperty(MediaInformation.keySize);
/// Returns bitrate.
String? getBitrate() => this.getStringProperty(MediaInformation.keyBitRate);
/// Returns all tags.
Map<dynamic, dynamic>? getTags() =>
this.getProperties(StreamInformation.keyTags);
/// Returns the media property associated with the key.
String? getStringProperty(String key) => this.getMediaProperties()?[key];
/// Returns the media property associated with the key.
num? getNumberProperty(String key) => this.getMediaProperties()?[key];
/// Returns the media properties associated with the key.
dynamic getProperties(String key) => this.getMediaProperties()?[key];
/// Returns all streams found as a list.
List<StreamInformation> getStreams() {
final List<StreamInformation> list =
List<StreamInformation>.empty(growable: true);
dynamic createStreamInformation(Map<dynamic, dynamic> streamProperties) =>
list.add(new StreamInformation(streamProperties));
this._allProperties?["streams"]?.forEach((Object? stream) {
createStreamInformation(stream as Map<dynamic, dynamic>);
});
return list;
}
/// Returns all media properties.
Map<dynamic, dynamic>? getMediaProperties() =>
this._allProperties?[keyMediaProperties];
/// Returns all properties found, including stream properties.
Map<dynamic, dynamic>? getAllProperties() => this._allProperties;
}

64
flutter/flutter/lib/media_information_json_parser.dart Normal file
View File

@ -0,0 +1,64 @@
/*
* Copyright (c) 2019-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
import 'package:ffmpeg_kit_flutter_platform_interface/ffmpeg_kit_flutter_platform_interface.dart';
import 'package:flutter/services.dart';
import 'ffmpeg_kit_config.dart';
import 'media_information.dart';
/// A parser that constructs "MediaInformation" from FFprobe's json output.
class MediaInformationJsonParser {
static FFmpegKitPlatform _platform = FFmpegKitPlatform.instance;
/// Extracts MediaInformation from the given FFprobe json output. Note that
/// this method does not fail as [fromWithError] does and returns null on
/// error.
static Future<MediaInformation?> from(String ffprobeJsonOutput) async {
try {
await FFmpegKitConfig.init();
return _platform
.mediaInformationJsonParserFrom(ffprobeJsonOutput)
.then((properties) {
if (properties == null || properties.length == 0) {
return null;
} else {
return new MediaInformation(properties);
}
});
} on PlatformException catch (e, stack) {
print("Plugin from error: ${e.message}");
return Future.error("from failed.", stack);
}
}
/// Extracts MediaInformation from the given FFprobe json output.
static Future<MediaInformation> fromWithError(
String ffprobeJsonOutput) async {
try {
await FFmpegKitConfig.init();
return _platform
.mediaInformationJsonParserFromWithError(ffprobeJsonOutput)
.then((properties) => new MediaInformation(properties));
} on PlatformException catch (e, stack) {
print("Plugin fromWithError error: ${e.message}");
return Future.error("fromWithError failed.", stack);
}
}
}

58
flutter/flutter/lib/media_information_session.dart Normal file
View File

@ -0,0 +1,58 @@
/*
* Copyright (c) 2019-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
import 'abstract_session.dart';
import 'execute_callback.dart';
import 'ffprobe_session.dart';
import 'log_callback.dart';
import 'media_information.dart';
import 'src/ffmpeg_kit_factory.dart';
/// A custom FFprobe session, which produces a "MediaInformation" object
/// using the FFprobe output.
class MediaInformationSession extends FFprobeSession {
MediaInformation? _mediaInformation;
/// Creates a new MediaInformation session with [argumentsArray].
static Future<MediaInformationSession> create(List<String> argumentsArray,
[ExecuteCallback? executeCallback = null,
LogCallback? logCallback = null]) async {
final session =
await AbstractSession.createMediaInformationSession(argumentsArray);
final sessionId = session.getSessionId();
FFmpegKitFactory.setExecuteCallback(sessionId, executeCallback);
FFmpegKitFactory.setLogCallback(sessionId, logCallback);
return session;
}
/// Creates a new MediaInformation session from [sessionMap], which includes
/// session fields as map keys.
static MediaInformationSession fromMap(Map<dynamic, dynamic> sessionMap) =>
AbstractSession.createMediaInformationSessionFromMap(sessionMap);
/// Returns the media information extracted in this session.
MediaInformation? getMediaInformation() => this._mediaInformation;
/// Sets the media information extracted in this session.
void setMediaInformation(MediaInformation? mediaInformation) {
this._mediaInformation = mediaInformation;
}
}

56
flutter/flutter/lib/packages.dart Normal file
View File

@ -0,0 +1,56 @@
/*
* Copyright (c) 2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
import 'package:ffmpeg_kit_flutter_platform_interface/ffmpeg_kit_flutter_platform_interface.dart';
import 'package:flutter/services.dart';
import 'ffmpeg_kit_config.dart';
/// Helper class to extract binary package information.
class Packages {
static FFmpegKitPlatform _platform = FFmpegKitPlatform.instance;
/// Returns the FFmpegKit Flutter binary package name.
static Future<String?> getPackageName() async {
try {
await FFmpegKitConfig.init();
return _platform.getPackageName();
} on PlatformException catch (e, stack) {
print("Plugin getPackageName error: ${e.message}");
return Future.error("getPackageName failed.", stack);
}
}
/// Returns enabled external libraries by FFmpeg.
static Future<List<String>> getExternalLibraries() async {
try {
await FFmpegKitConfig.init();
return _platform.getExternalLibraries().then((externalLibraries) {
if (externalLibraries == null) {
return List.empty();
} else {
return externalLibraries.cast<String>();
}
});
} on PlatformException catch (e, stack) {
print("Plugin getExternalLibraries error: ${e.message}");
return Future.error("getExternalLibraries failed.", stack);
}
}
}

44
flutter/flutter/lib/return_code.dart Normal file
View File

@ -0,0 +1,44 @@
/*
* Copyright (c) 2019-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
class ReturnCode {
static const int success = 0;
static const int cancel = 255;
int _value;
ReturnCode(this._value);
static bool isSuccess(ReturnCode? returnCode) =>
returnCode?.getValue() == ReturnCode.success;
static bool isCancel(ReturnCode? returnCode) =>
returnCode?.getValue() == ReturnCode.cancel;
int getValue() => this._value;
bool isValueSuccess() => this._value == ReturnCode.success;
bool isValueError() =>
(this._value != ReturnCode.success) && (this._value != ReturnCode.cancel);
bool isValueCancel() => this._value == ReturnCode.cancel;
String toString() => this._value.toString();
}

111
flutter/flutter/lib/session.dart Normal file
View File

@ -0,0 +1,111 @@
/*
* Copyright (c) 2019-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
import 'execute_callback.dart';
import 'log.dart';
import 'log_callback.dart';
import 'log_redirection_strategy.dart';
import 'return_code.dart';
import 'session_state.dart';
/// Common interface for all "FFmpegKit" sessions.
abstract class Session {
/// Returns the session specific execute callback function.
ExecuteCallback? getExecuteCallback();
/// Returns the session specific log callback function.
LogCallback? getLogCallback();
/// Returns the session identifier.
int? getSessionId();
/// Returns session create time.
DateTime? getCreateTime();
/// Returns session start time.
DateTime? getStartTime();
/// Returns session end time.
Future<DateTime?> getEndTime();
/// Returns time taken to execute this session in milliseconds or zero (0)
/// if the session is not over yet.
Future<int> getDuration();
/// Returns command arguments as an array.
List<String>? getArguments();
/// Returns command arguments as a concatenated string.
String? getCommand();
/// Returns all log entries generated for this session. If there are
/// asynchronous logs that are not delivered yet, this method waits for
/// them until [waitTimeout].
Future<List<Log>> getAllLogs([int? waitTimeout = null]);
/// Returns all log entries delivered for this session. Note that if there
/// are asynchronous logs that are not delivered yet, this method
/// will not wait for them and will return immediately.
Future<List<Log>> getLogs();
/// Returns all log entries generated for this session as a concatenated
/// string. If there are asynchronous logs that are not delivered yet,
/// this method waits for them until [waitTimeout].
Future<String?> getAllLogsAsString([int? waitTimeout = null]);
/// Returns all log entries delivered for this session as a concatenated
/// string. Note that if there are asynchronous logs that are not
/// delivered yet, this method will not wait for them and will return
/// immediately.
Future<String> getLogsAsString();
/// Returns the log output generated while running the session.
Future<String?> getOutput();
/// Returns the state of the session.
Future<SessionState> getState();
/// Returns the return code for this session. Note that return code is only
/// set for sessions that end with COMPLETED state. If a session is not
/// started, still running or failed then this method returns null.
Future<ReturnCode?> getReturnCode();
/// Returns the stack trace of the exception received while executing this
/// session.
///
/// The stack trace is only set for sessions that end with FAILED state. For
/// sessions that has COMPLETED state this method returns null.
Future<String?> getFailStackTrace();
/// Returns session specific log redirection strategy.
LogRedirectionStrategy? getLogRedirectionStrategy();
/// Returns whether there are still asynchronous messages being transmitted
/// for this session or not.
Future<bool> thereAreAsynchronousMessagesInTransmit();
/// Returns whether it is an "FFmpeg" session or not.
bool isFFmpeg();
/// Returns whether it is an "FFprobe" session or not.
bool isFFprobe();
/// Cancels running the session.
void cancel();
}

20
flutter/flutter/lib/session_state.dart Normal file
View File

@ -0,0 +1,20 @@
/*
* Copyright (c) 2019-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
enum SessionState { created, running, failed, completed }

21
flutter/flutter/lib/signal.dart Normal file
View File

@ -0,0 +1,21 @@
/*
* Copyright (c) 2019-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
/// Signals handled by FFmpegKit library.
enum Signal { sigInt, sigQuit, sigPipe, sigTerm, sigXCpu }

151
flutter/flutter/lib/src/ffmpeg_kit_factory.dart Normal file
View File

@ -0,0 +1,151 @@
/*
* Copyright (c) 2019-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
import '../execute_callback.dart';
import '../ffmpeg_session.dart';
import '../ffprobe_session.dart';
import '../log.dart';
import '../log_callback.dart';
import '../log_redirection_strategy.dart';
import '../media_information_session.dart';
import '../session.dart';
import '../statistics.dart';
import '../statistics_callback.dart';
final executeCallbackMap = new Map<int, ExecuteCallback>();
final logCallbackMap = new Map<int, LogCallback>();
final statisticsCallbackMap = new Map<int, StatisticsCallback>();
final logRedirectionStrategyMap = new Map<int, LogRedirectionStrategy>();
class FFmpegKitFactory {
static LogCallback? _logCallback;
static StatisticsCallback? _statisticsCallback;
static ExecuteCallback? _executeCallback;
static Statistics mapToStatistics(Map<dynamic, dynamic> statisticsMap) =>
new Statistics(
statisticsMap["sessionId"],
statisticsMap["videoFrameNumber"],
statisticsMap["videoFps"],
statisticsMap["videoQuality"],
statisticsMap["size"],
statisticsMap["time"],
statisticsMap["bitrate"],
statisticsMap["speed"]);
static Log mapToLog(Map<dynamic, dynamic> logMap) =>
new Log(logMap["sessionId"], logMap["level"], logMap["message"]);
static Session mapToSession(Map<dynamic, dynamic> sessionMap) {
switch (sessionMap["type"]) {
case 2:
return FFprobeSession.fromMap(sessionMap);
case 3:
return MediaInformationSession.fromMap(sessionMap);
case 1:
default:
return FFmpegSession.fromMap(sessionMap);
}
}
static Session? mapToNullableSession(Map<dynamic, dynamic>? sessionMap) {
if (sessionMap != null) {
switch (sessionMap["type"]) {
case 2:
return FFprobeSession.fromMap(sessionMap);
case 3:
return MediaInformationSession.fromMap(sessionMap);
case 1:
default:
return FFmpegSession.fromMap(sessionMap);
}
} else {
return null;
}
}
static String getVersion() => "4.5.0";
static LogRedirectionStrategy? getLogRedirectionStrategy(int? sessionId) =>
logRedirectionStrategyMap[sessionId];
static void setLogRedirectionStrategy(
int? sessionId, LogRedirectionStrategy? logRedirectionStrategy) {
if (sessionId != null && logRedirectionStrategy != null) {
logRedirectionStrategyMap[sessionId] = logRedirectionStrategy;
}
}
static LogCallback? getLogCallback(int? sessionId) =>
logCallbackMap[sessionId];
static void setLogCallback(int? sessionId, LogCallback? logCallback) {
if (sessionId != null && logCallback != null) {
logCallbackMap[sessionId] = logCallback;
}
}
static LogCallback? getGlobalLogCallback() => _logCallback;
static void setGlobalLogCallback(LogCallback? logCallback) {
_logCallback = logCallback;
}
static StatisticsCallback? getStatisticsCallback(int? sessionId) =>
statisticsCallbackMap[sessionId];
static void setStatisticsCallback(
int? sessionId, StatisticsCallback? statisticsCallback) {
if (sessionId != null && statisticsCallback != null) {
statisticsCallbackMap[sessionId] = statisticsCallback;
}
}
static StatisticsCallback? getGlobalStatisticsCallback() =>
_statisticsCallback;
static void setGlobalStatisticsCallback(
StatisticsCallback? statisticsCallback) {
_statisticsCallback = statisticsCallback;
}
static ExecuteCallback? getExecuteCallback(int? sessionId) =>
executeCallbackMap[sessionId];
static void setExecuteCallback(
int? sessionId, ExecuteCallback? executeCallback) {
if (sessionId != null && executeCallback != null) {
executeCallbackMap[sessionId] = executeCallback;
}
}
static ExecuteCallback? getGlobalExecuteCallback() => _executeCallback;
static void setGlobalExecuteCallback(ExecuteCallback? executeCallback) {
_executeCallback = executeCallback;
}
static DateTime? validDate(int? time) {
if (time == null || time <= 0) {
return null;
} else {
return DateTime.fromMillisecondsSinceEpoch(time, isUtc: false);
}
}
}

272
flutter/flutter/lib/src/ffmpeg_kit_flutter_initializer.dart Normal file
View File

@ -0,0 +1,272 @@
/*
* Copyright (c) 2019-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
import 'dart:io';
import 'package:ffmpeg_kit_flutter_platform_interface/ffmpeg_kit_flutter_platform_interface.dart';
import 'package:flutter/services.dart';
import '../arch_detect.dart';
import '../execute_callback.dart';
import '../ffmpeg_kit_config.dart';
import '../ffmpeg_session.dart';
import '../level.dart';
import '../log_callback.dart';
import '../log_redirection_strategy.dart';
import '../packages.dart';
import '../session.dart';
import '../statistics.dart';
import '../statistics_callback.dart';
import 'ffmpeg_kit_factory.dart';
class FFmpegKitInitializer {
static FFmpegKitPlatform _platform = FFmpegKitPlatform.instance;
static const EventChannel _eventChannel =
const EventChannel('flutter.arthenica.com/ffmpeg_kit_event');
static FFmpegKitInitializer _instance = new FFmpegKitInitializer();
static bool _initialized = false;
static Future<bool> initialize() async {
if (!_initialized) {
_initialized = true;
await _instance._initialize();
}
return _initialized;
}
void _onEvent(dynamic event) {
if (event is Map<dynamic, dynamic>) {
final Map<String, dynamic> eventMap = event.cast<String, dynamic>();
final Map<dynamic, dynamic>? logEvent =
eventMap['FFmpegKitLogCallbackEvent'];
final Map<dynamic, dynamic>? statisticsEvent =
eventMap['FFmpegKitStatisticsCallbackEvent'];
final Map<dynamic, dynamic>? executeEvent =
eventMap['FFmpegKitExecuteCallbackEvent'];
if (logEvent != null) {
_processLogCallbackEvent(logEvent);
}
if (statisticsEvent != null) {
_processStatisticsCallbackEvent(statisticsEvent);
}
if (executeEvent != null) {
_processExecuteCallbackEvent(executeEvent);
}
}
}
void _onError(Object error) {
print('Event error: $error');
}
void _processLogCallbackEvent(Map<dynamic, dynamic> event) {
final log = FFmpegKitFactory.mapToLog(event);
final int sessionId = event["sessionId"];
final int level = event["level"];
final String text = event["message"];
final int activeLogLevel = FFmpegKitConfig.getLogLevel();
var globalCallbackDefined = false;
var sessionCallbackDefined = false;
LogRedirectionStrategy activeLogRedirectionStrategy =
FFmpegKitConfig.getLogRedirectionStrategy();
// avLogStderr logs are always redirected
if ((activeLogLevel == Level.avLogQuiet && level != Level.avLogStderr) ||
level > activeLogLevel) {
// LOG NEITHER PRINTED NOR FORWARDED
return;
}
FFmpegKitConfig.getSession(sessionId).then((Session? session) {
activeLogRedirectionStrategy =
session?.getLogRedirectionStrategy() ?? activeLogRedirectionStrategy;
final LogCallback? logCallback = session?.getLogCallback();
if (logCallback != null) {
sessionCallbackDefined = true;
try {
// NOTIFY SESSION CALLBACK DEFINED
logCallback(log);
} on Exception catch (e, stack) {
print("Exception thrown inside session LogCallback block. $e");
print(stack);
}
}
final globalLogCallbackFunction = FFmpegKitFactory.getGlobalLogCallback();
if (globalLogCallbackFunction != null) {
globalCallbackDefined = true;
try {
// NOTIFY GLOBAL CALLBACK DEFINED
globalLogCallbackFunction(log);
} on Exception catch (e, stack) {
print("Exception thrown inside global LogCallback block. $e");
print(stack);
}
}
// EXECUTE THE LOG STRATEGY
switch (activeLogRedirectionStrategy) {
case LogRedirectionStrategy.neverPrintLogs:
{
return;
}
case LogRedirectionStrategy.printLogsWhenGlobalCallbackNotDefined:
{
if (globalCallbackDefined) {
return;
}
}
break;
case LogRedirectionStrategy.printLogsWhenSessionCallbackNotDefined:
{
if (sessionCallbackDefined) {
return;
}
}
break;
case LogRedirectionStrategy.printLogsWhenNoCallbacksDefined:
{
if (globalCallbackDefined || sessionCallbackDefined) {
return;
}
}
break;
case LogRedirectionStrategy.alwaysPrintLogs:
{}
break;
}
// PRINT LOGS
switch (level) {
case Level.avLogQuiet:
{
// PRINT NO OUTPUT
}
break;
default:
{
stdout.write(text);
}
}
});
}
void _processStatisticsCallbackEvent(Map<dynamic, dynamic> event) {
final Statistics statistics = FFmpegKitFactory.mapToStatistics(event);
final int sessionId = event["sessionId"];
FFmpegKitConfig.getSession(sessionId).then((Session? session) {
if (session != null && session.isFFmpeg()) {
final FFmpegSession ffmpegSession = session as FFmpegSession;
final StatisticsCallback? statisticsCallback =
ffmpegSession.getStatisticsCallback();
if (statisticsCallback != null) {
try {
// NOTIFY SESSION CALLBACK DEFINED
statisticsCallback(statistics);
} on Exception catch (e, stack) {
print(
"Exception thrown inside session StatisticsCallback block. $e");
print(stack);
}
}
}
final globalStatisticsCallbackFunction =
FFmpegKitFactory.getGlobalStatisticsCallback();
if (globalStatisticsCallbackFunction != null) {
try {
// NOTIFY GLOBAL CALLBACK DEFINED
globalStatisticsCallbackFunction(statistics);
} on Exception catch (e, stack) {
print("Exception thrown inside global StatisticsCallback block. $e");
print(stack);
}
}
});
}
void _processExecuteCallbackEvent(Map<dynamic, dynamic> event) {
final int sessionId = event["sessionId"];
FFmpegKitConfig.getSession(sessionId).then((Session? session) {
final ExecuteCallback? executeCallback = session?.getExecuteCallback();
if (executeCallback != null && session != null) {
try {
// NOTIFY SESSION CALLBACK DEFINED
executeCallback(session);
} on Exception catch (e, stack) {
print("Exception thrown inside session ExecuteCallback block. $e");
print(stack);
}
}
final globalExecuteCallbackFunction =
FFmpegKitFactory.getGlobalExecuteCallback();
if (globalExecuteCallbackFunction != null && session != null) {
try {
// NOTIFY GLOBAL CALLBACK DEFINED
globalExecuteCallbackFunction(session);
} on Exception catch (e, stack) {
print("Exception thrown inside global ExecuteCallback block. $e");
print(stack);
}
}
});
}
Future<int?> _getLogLevel() async {
try {
return _platform.ffmpegKitFlutterInitializerGetLogLevel();
} on PlatformException catch (e, stack) {
print("Plugin _getLogLevel error: ${e.message}");
return Future.error("_getLogLevel failed.", stack);
}
}
Future<void> _initialize() async {
print("Loading ffmpeg-kit-flutter.");
_eventChannel.receiveBroadcastStream().listen(_onEvent, onError: _onError);
final logLevel = await _getLogLevel();
if (logLevel != null) {
FFmpegKitConfig.setLogLevel(logLevel);
}
final version = FFmpegKitFactory.getVersion();
final platform = await FFmpegKitConfig.getPlatform();
final arch = await ArchDetect.getArch();
final packageName = await Packages.getPackageName();
await FFmpegKitConfig.enableRedirection();
final isLTSPostfix = (await FFmpegKitConfig.isLTSBuild()) ? "-lts" : "";
final fullVersion = "$platform-$packageName-$arch-$version$isLTSPostfix";
print("Loaded ffmpeg-kit-flutter-$fullVersion.");
}
}

81
flutter/flutter/lib/statistics.dart Normal file
View File

@ -0,0 +1,81 @@
/*
* Copyright (c) 2019-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
/// Statistics entry for an FFmpeg execute session.
class Statistics {
int _sessionId;
int _videoFrameNumber;
double _videoFps;
double _videoQuality;
int _size;
int _time;
double _bitrate;
double _speed;
Statistics(this._sessionId, this._videoFrameNumber, this._videoFps,
this._videoQuality, this._size, this._time, this._bitrate, this._speed);
int getSessionId() => this._sessionId;
void setSessionId(int sessionId) {
this._sessionId = sessionId;
}
int getVideoFrameNumber() => this._videoFrameNumber;
void setVideoFrameNumber(int videoFrameNumber) {
this._videoFrameNumber = videoFrameNumber;
}
double getVideoFps() => this._videoFps;
void setVideoFps(double videoFps) {
this._videoFps = videoFps;
}
double getVideoQuality() => this._videoQuality;
void setVideoQuality(double videoQuality) {
this._videoQuality = videoQuality;
}
int getSize() => this._size;
void setSize(int size) {
this._size = size;
}
int getTime() => this._time;
void setTime(int time) {
this._time = time;
}
double getBitrate() => this._bitrate;
void setBitrate(double bitrate) {
this._bitrate = bitrate;
}
double getSpeed() => this._speed;
void setSpeed(double speed) {
this._speed = speed;
}
}

23
flutter/flutter/lib/statistics_callback.dart Normal file
View File

@ -0,0 +1,23 @@
/*
* Copyright (c) 2019-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
import 'statistics.dart';
/// Callback function that receives statistics generated for "FFmpeg" sessions.dc
typedef StatisticsCallback = void Function(Statistics statistics);

124
flutter/flutter/lib/stream_information.dart Normal file
View File

@ -0,0 +1,124 @@
/*
* Copyright (c) 2019-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
/// Stream information class.
class StreamInformation {
static const keyIndex = "index";
static const keyType = "codec_type";
static const keyCodec = "codec_name";
static const keyCodecLong = "codec_long_name";
static const keyFormat = "pix_fmt";
static const keyWidth = "width";
static const keyHeight = "height";
static const keyBitRate = "bit_rate";
static const keySampleRate = "sample_rate";
static const keySampleFormat = "sample_fmt";
static const keyChannelLayout = "channel_layout";
static const keySampleAspectRatio = "sample_aspect_ratio";
static const keyDisplayAspectRatio = "display_aspect_ratio";
static const keyAverageFrameRate = "avg_frame_rate";
static const keyRealFrameRate = "r_frame_rate";
static const keyTimeBase = "time_base";
static const keyCodecTimeBase = "codec_time_base";
static const keyTags = "tags";
Map<dynamic, dynamic>? _allProperties;
/// Creates a new [StreamInformation] instance
StreamInformation(this._allProperties);
/// Returns stream index.
int? getIndex() => this.getNumberProperty(keyIndex)?.toInt();
/// Returns stream type.
String? getType() => this.getStringProperty(StreamInformation.keyType);
/// Returns stream codec.
String? getCodec() => this.getStringProperty(StreamInformation.keyCodec);
/// Returns stream codec in long format.
String? getFullCodec() =>
this.getStringProperty(StreamInformation.keyCodecLong);
/// Returns stream format.
String? getFormat() => this.getStringProperty(StreamInformation.keyFormat);
/// Returns width.
int? getWidth() =>
this.getNumberProperty(StreamInformation.keyWidth)?.toInt();
/// Returns height.
int? getHeight() =>
this.getNumberProperty(StreamInformation.keyHeight)?.toInt();
/// Returns bitrate.
String? getBitrate() => this.getStringProperty(StreamInformation.keyBitRate);
/// Returns sample rate.
String? getSampleRate() =>
this.getStringProperty(StreamInformation.keySampleRate);
/// Returns sample format.
String? getSampleFormat() =>
this.getStringProperty(StreamInformation.keySampleFormat);
/// Returns channel layout.
String? getChannelLayout() =>
this.getStringProperty(StreamInformation.keyChannelLayout);
/// Returns sample aspect ratio.
String? getSampleAspectRatio() =>
this.getStringProperty(StreamInformation.keySampleAspectRatio);
/// Returns display aspect ratio.
String? getDisplayAspectRatio() =>
this.getStringProperty(StreamInformation.keyDisplayAspectRatio);
/// Returns average frame rate.
String? getAverageFrameRate() =>
this.getStringProperty(StreamInformation.keyAverageFrameRate);
/// Returns real frame rate.
String? getRealFrameRate() =>
this.getStringProperty(StreamInformation.keyRealFrameRate);
/// Returns time base.
String? getTimeBase() =>
this.getStringProperty(StreamInformation.keyTimeBase);
/// Returns codec time base.
String? getCodecTimeBase() =>
this.getStringProperty(StreamInformation.keyCodecTimeBase);
/// Returns all tags.
Map<dynamic, dynamic>? getTags() =>
this.getProperties(StreamInformation.keyTags);
/// Returns the stream property associated with the key.
String? getStringProperty(String key) => this._allProperties?[key];
/// Returns the stream property associated with the key.
num? getNumberProperty(String key) => this._allProperties?[key];
/// Returns the stream properties associated with the key.
dynamic getProperties(String key) => this._allProperties?[key];
/// Returns all properties found.d
Map<dynamic, dynamic>? getAllProperties() => this._allProperties;
}

0
flutter/flutter/macos/Assets/.gitkeep Normal file
View File

23
flutter/flutter/macos/Classes/FFmpegKitFlutterPlugin.h Normal file
View File

@ -0,0 +1,23 @@
/*
* Copyright (c) 2018-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see <http://www.gnu.org/licenses/>.
*/
#import <FlutterMacOS/FlutterMacOS.h>
@interface FFmpegKitFlutterPlugin : NSObject<FlutterPlugin,FlutterStreamHandler>
@end

1120
flutter/flutter/macos/Classes/FFmpegKitFlutterPlugin.m Normal file
View File

File diff suppressed because it is too large Load Diff

135
flutter/flutter/macos/ffmpeg_kit_flutter.podspec Normal file
View File

@ -0,0 +1,135 @@
Pod::Spec.new do |s|
s.name = 'ffmpeg_kit_flutter'
s.version = '4.5.0'
s.summary = 'FFmpeg Kit for Flutter'
s.description = 'A Flutter plugin for running FFmpeg and FFprobe commands.'
s.homepage = 'https://github.com/tanersener/ffmpeg-kit'
s.license = { :file => '../LICENSE' }
s.author = { 'Taner Sener' => 'tanersener@gmail.com' }
s.platform = :osx
s.requires_arc = true
s.static_framework = true
s.source = { :path => '.' }
s.source_files = 'Classes/**/*'
s.public_header_files = 'Classes/**/*.h'
s.default_subspec = 'https'
s.dependency 'FlutterMacOS'
s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES' }
s.subspec 'min' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-macos-min', "4.5"
ss.osx.deployment_target = '10.15'
end
s.subspec 'min-lts' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-macos-min', "4.5.LTS"
ss.osx.deployment_target = '10.11'
end
s.subspec 'min-gpl' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-macos-min-gpl', "4.5"
ss.osx.deployment_target = '10.15'
end
s.subspec 'min-gpl-lts' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-macos-min-gpl', "4.5.LTS"
ss.osx.deployment_target = '10.11'
end
s.subspec 'https' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-macos-https', "4.5"
ss.osx.deployment_target = '10.15'
end
s.subspec 'https-lts' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-macos-https', "4.5.LTS"
ss.osx.deployment_target = '10.11'
end
s.subspec 'https-gpl' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-macos-https-gpl', "4.5"
ss.osx.deployment_target = '10.15'
end
s.subspec 'https-gpl-lts' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-macos-https-gpl', "4.5.LTS"
ss.osx.deployment_target = '10.11'
end
s.subspec 'audio' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-macos-audio', "4.5"
ss.osx.deployment_target = '10.15'
end
s.subspec 'audio-lts' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-macos-audio', "4.5.LTS"
ss.osx.deployment_target = '10.11'
end
s.subspec 'video' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-macos-video', "4.5"
ss.osx.deployment_target = '10.15'
end
s.subspec 'video-lts' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-macos-video', "4.5.LTS"
ss.osx.deployment_target = '10.11'
end
s.subspec 'full' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-macos-full', "4.5"
ss.osx.deployment_target = '10.15'
end
s.subspec 'full-lts' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-macos-full', "4.5.LTS"
ss.osx.deployment_target = '10.11'
end
s.subspec 'full-gpl' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-macos-full-gpl', "4.5"
ss.osx.deployment_target = '10.15'
end
s.subspec 'full-gpl-lts' do |ss|
ss.source_files = 'Classes/**/*'
ss.public_header_files = 'Classes/**/*.h'
ss.dependency 'ffmpeg-kit-macos-full-gpl', "4.5.LTS"
ss.osx.deployment_target = '10.11'
end
end

31
flutter/flutter/pubspec.yaml Normal file
View File

@ -0,0 +1,31 @@
name: ffmpeg_kit_flutter
description: FFmpeg Kit for Flutter. Supports Android, iOS and macOS platforms.
repository: https://github.com/tanersener/ffmpeg-kit
issue_tracker: https://github.com/tanersener/ffmpeg-kit/issues
homepage: https://github.com/tanersener/ffmpeg-kit
version: 4.5.0
environment:
sdk: ">=2.12.0 <3.0.0"
flutter: ">=2.0.0"
flutter:
plugin:
platforms:
android:
package: com.arthenica.ffmpegkit.flutter
pluginClass: FFmpegKitFlutterPlugin
ios:
pluginClass: FFmpegKitFlutterPlugin
macos:
pluginClass: FFmpegKitFlutterPlugin
dependencies:
ffmpeg_kit_flutter_platform_interface: ^0.1.0
flutter:
sdk: flutter
dev_dependencies:
flutter_test:
sdk: flutter
plugin_platform_interface: ^2.0.2

5
flutter/flutter_platform_interface/.gitignore vendored Normal file
View File

@ -0,0 +1,5 @@
.DS_Store
.dart_tool/
.packages
.pub/
build/

2
flutter/flutter_platform_interface/CHANGELOG.md Normal file
View File

@ -0,0 +1,2 @@
## 0.1.0
- Initial release

19
flutter/flutter_platform_interface/LICENSE Normal file
View File

@ -0,0 +1,19 @@
Copyright (c) 2021 Taner Sener
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.

9
flutter/flutter_platform_interface/README.md Normal file
View File

@ -0,0 +1,9 @@
# Platform Interface for FFmpegKit Flutter
A common platform interface for the [`ffmpeg_kit_flutter`][1] plugin.
This interface allows platform-specific implementations of the `ffmpeg_kit_flutter`
plugin, as well as the plugin itself, to ensure they are supporting the same
interface.
[1]: ../flutter

68
flutter/flutter_platform_interface/analysis_options.yaml Normal file
View File

@ -0,0 +1,68 @@
analyzer:
enable-experiment:
- non-nullable
strong-mode:
implicit-dynamic: false
errors:
missing_required_param: warning
missing_return: warning
linter:
rules:
- avoid_catching_errors
- avoid_function_literals_in_foreach_calls
- avoid_private_typedef_functions
- avoid_renaming_method_parameters
- avoid_returning_null_for_void
- avoid_unused_constructor_parameters
- avoid_void_async
- await_only_futures
- camel_case_types
- cancel_subscriptions
- comment_references
- constant_identifier_names
- control_flow_in_finally
- directives_ordering
- empty_statements
- file_names
- hash_and_equals
- implementation_imports
- iterable_contains_unrelated_type
- join_return_with_assignment
- lines_longer_than_80_chars
- list_remove_unrelated_type
- missing_whitespace_between_adjacent_strings
- no_runtimeType_toString
- non_constant_identifier_names
- only_throw_errors
- overridden_fields
- package_api_docs
- package_names
- package_prefixed_library_names
- prefer_asserts_in_initializer_lists
- prefer_const_constructors
- prefer_const_declarations
- prefer_expression_function_bodies
- prefer_final_locals
- prefer_function_declarations_over_variables
- prefer_initializing_formals
- prefer_inlined_adds
- prefer_interpolation_to_compose_strings
- prefer_is_not_operator
- prefer_null_aware_operators
- prefer_relative_imports
- prefer_typing_uninitialized_variables
- prefer_void_to_null
- provide_deprecation_message
- sort_pub_dependencies
- test_types_in_equals
- throw_in_finally
- unnecessary_brace_in_string_interps
- unnecessary_lambdas
- unnecessary_null_aware_assignments
- unnecessary_overrides
- unnecessary_parenthesis
- unnecessary_statements
- unnecessary_string_interpolations
- use_string_buffers
- void_checks

378
flutter/flutter_platform_interface/lib/ffmpeg_kit_flutter_platform_interface.dart Normal file
View File

@ -0,0 +1,378 @@
/*
* Copyright (c) 2021 Taner Sener
*
* 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.
*/
import 'package:plugin_platform_interface/plugin_platform_interface.dart';
import 'method_channel_ffmpeg_kit_flutter.dart';
abstract class FFmpegKitPlatform extends PlatformInterface {
/// Constructs a FFmpegKitPlatform.
FFmpegKitPlatform() : super(token: _token);
static final Object _token = Object();
static FFmpegKitPlatform _instance = MethodChannelFFmpegKit();
/// The default instance of [FFmpegKitPlatform] to use.
///
/// Defaults to [MethodChannelFFmpegKit].
static FFmpegKitPlatform get instance => _instance;
/// Platform-specific plugins should set this with their own platform-specific
/// class that extends [FFmpegKitPlatform] when they register
/// themselves.
static set instance(FFmpegKitPlatform instance) {
PlatformInterface.verifyToken(instance, _token);
_instance = instance;
}
// AbstractSession
Future<Map<dynamic, dynamic>?> abstractSessionCreateFFmpegSession(
List<String> argumentsArray) async {
throw UnimplementedError(
'abstractSessionCreateFFmpegSession() has not been implemented!');
}
Future<Map<dynamic, dynamic>?> abstractSessionCreateFFprobeSession(
List<String> argumentsArray) async {
throw UnimplementedError(
'abstractSessionCreateFFprobeSession() has not been implemented!');
}
Future<Map<dynamic, dynamic>?> abstractSessionCreateMediaInformationSession(
List<String> argumentsArray) async {
throw UnimplementedError('abstractSessionCreateMediaInformationSession()'
' has not been implemented!');
}
Future<int?> abstractSessionGetEndTime(int? sessionId) async {
throw UnimplementedError(
'abstractSessionGetEndTime() has not been implemented!');
}
Future<int?> abstractSessionGetDuration(int? sessionId) async {
throw UnimplementedError(
'abstractSessionGetDuration() has not been implemented!');
}
Future<List<dynamic>?> abstractSessionGetAllLogs(
int? sessionId, int? waitTimeout) async {
throw UnimplementedError(
'abstractSessionGetAllLogs() has not been implemented!');
}
Future<List<dynamic>?> abstractSessionGetLogs(int? sessionId) async {
throw UnimplementedError(
'abstractSessionGetLogs() has not been implemented!');
}
Future<String?> abstractSessionGetAllLogsAsString(
int? sessionId, int? waitTimeout) async {
throw UnimplementedError(
'abstractSessionGetAllLogsAsString() has not been implemented!');
}
Future<int?> abstractSessionGetState(int? sessionId) async {
throw UnimplementedError(
'abstractSessionGetState() has not been implemented!');
}
Future<int?> abstractSessionGetReturnCode(int? sessionId) async {
throw UnimplementedError(
'abstractSessionGetReturnCode() has not been implemented!');
}
Future<String?> abstractSessionGetFailStackTrace(int? sessionId) async {
throw UnimplementedError(
'abstractSessionGetFailStackTrace() has not been implemented!');
}
Future<bool> abstractSessionThereAreAsynchronousMessagesInTransmit(
int? sessionId) async {
throw UnimplementedError(
'abstractSessionThereAreAsynchronousMessagesInTransmit()'
' has not been implemented!');
}
// ArchDetect
Future<String> archDetectGetArch() async {
throw UnimplementedError('archDetectGetArch() has not been implemented!');
}
// FFmpegKit
Future<void> ffmpegKitCancel() async {
throw UnimplementedError('ffmpegKitCancel() has not been implemented!');
}
Future<void> ffmpegKitCancelSession(int sessionId) async {
throw UnimplementedError(
'ffmpegKitCancelSession() has not been implemented!');
}
Future<List<dynamic>?> ffmpegKitListSessions() async {
throw UnimplementedError(
'ffmpegKitListSessions() has not been implemented!');
}
// FFmpegKitConfig
Future<void> ffmpegKitConfigEnableRedirection() async {
throw UnimplementedError(
'ffmpegKitConfigEnableRedirection() has not been implemented!');
}
Future<void> ffmpegKitConfigDisableRedirection() async {
throw UnimplementedError(
'ffmpegKitConfigDisableRedirection() has not been implemented!');
}
Future<void> ffmpegKitConfigSetFontconfigConfigurationPath(
String path) async {
throw UnimplementedError('ffmpegKitConfigSetFontconfigConfigurationPath()'
' has not been implemented!');
}
Future<void> ffmpegKitConfigSetFontDirectory(
String path, Map<String, String>? mapping) async {
throw UnimplementedError(
'ffmpegKitConfigSetFontDirectory() has not been implemented!');
}
Future<void> ffmpegKitConfigSetFontDirectoryList(
List<String> fontDirectoryList, Map<String, String>? mapping) async {
throw UnimplementedError(
'ffmpegKitConfigSetFontDirectoryList() has not been implemented!');
}
Future<String?> ffmpegKitConfigRegisterNewFFmpegPipe() async {
throw UnimplementedError(
'ffmpegKitConfigRegisterNewFFmpegPipe() has not been implemented!');
}
Future<void> ffmpegKitConfigCloseFFmpegPipe(String ffmpegPipePath) async {
throw UnimplementedError(
'ffmpegKitConfigCloseFFmpegPipe() has not been implemented!');
}
Future<String?> ffmpegKitConfigGetFFmpegVersion() async {
throw UnimplementedError(
'ffmpegKitConfigGetFFmpegVersion() has not been implemented!');
}
Future<bool?> ffmpegKitConfigIsLTSBuild() async {
throw UnimplementedError(
'ffmpegKitConfigIsLTSBuild() has not been implemented!');
}
Future<String?> ffmpegKitConfigGetBuildDate() async {
throw UnimplementedError(
'ffmpegKitConfigGetBuildDate() has not been implemented!');
}
Future<void> ffmpegKitConfigSetEnvironmentVariable(
String name, String value) async {
throw UnimplementedError(
'ffmpegKitConfigSetEnvironmentVariable() has not been implemented!');
}
Future<void> ffmpegKitConfigIgnoreSignal(int signal) async {
throw UnimplementedError(
'ffmpegKitConfigIgnoreSignal() has not been implemented!');
}
Future<void> ffmpegKitConfigAsyncFFmpegExecute(int? sessionId) async {
throw UnimplementedError(
'ffmpegKitConfigAsyncFFmpegExecute() has not been implemented!');
}
Future<void> ffmpegKitConfigAsyncFFprobeExecute(int? sessionId) async {
throw UnimplementedError(
'ffmpegKitConfigAsyncFFprobeExecute() has not been implemented!');
}
Future<void> ffmpegKitConfigAsyncGetMediaInformationExecute(
int? sessionId, int? waitTimeout) async {
throw UnimplementedError('ffmpegKitConfigAsyncGetMediaInformationExecute()'
' has not been implemented!');
}
Future<void> ffmpegKitConfigSetLogLevel(int logLevel) async {
throw UnimplementedError(
'ffmpegKitConfigSetLogLevel() has not been implemented!');
}
Future<int?> ffmpegKitConfigGetSessionHistorySize() async {
throw UnimplementedError(
'ffmpegKitConfigGetSessionHistorySize() has not been implemented!');
}
Future<void> ffmpegKitConfigSetSessionHistorySize(
int sessionHistorySize) async {
throw UnimplementedError(
'ffmpegKitConfigSetSessionHistorySize() has not been implemented!');
}
Future<Map<dynamic, dynamic>?> ffmpegKitConfigGetSession(
int sessionId) async {
throw UnimplementedError(
'ffmpegKitConfigGetSession() has not been implemented!');
}
Future<Map<dynamic, dynamic>?> ffmpegKitConfigGetLastSession() async {
throw UnimplementedError(
'ffmpegKitConfigGetLastSession() has not been implemented!');
}
Future<Map<dynamic, dynamic>?>
ffmpegKitConfigGetLastCompletedSession() async {
throw UnimplementedError(
'ffmpegKitConfigGetLastCompletedSession() has not been implemented!');
}
Future<List<dynamic>?> ffmpegKitConfigGetSessions() async {
throw UnimplementedError(
'ffmpegKitConfigGetSessions() has not been implemented!');
}
Future<void> clearSessions() async {
throw UnimplementedError('clearSessions() has not been implemented!');
}
Future<List<dynamic>?> ffmpegKitConfigGetSessionsByState(
int sessionState) async {
throw UnimplementedError(
'ffmpegKitConfigGetSessionsByState() has not been implemented!');
}
Future<int?> ffmpegKitConfigMessagesInTransmit(int sessionId) async {
throw UnimplementedError(
'ffmpegKitConfigMessagesInTransmit() has not been implemented!');
}
Future<void> ffmpegKitConfigEnableLogs() async {
throw UnimplementedError(
'ffmpegKitConfigEnableLogs() has not been implemented!');
}
Future<void> ffmpegKitConfigDisableLogs() async {
throw UnimplementedError(
'ffmpegKitConfigDisableLogs() has not been implemented!');
}
Future<void> ffmpegKitConfigEnableStatistics() async {
throw UnimplementedError(
'ffmpegKitConfigEnableStatistics() has not been implemented!');
}
Future<void> ffmpegKitConfigDisableStatistics() async {
throw UnimplementedError(
'ffmpegKitConfigDisableStatistics() has not been implemented!');
}
Future<String?> ffmpegKitConfigGetPlatform() async {
throw UnimplementedError(
'ffmpegKitConfigGetPlatform() has not been implemented!');
}
Future<int?> ffmpegKitConfigWriteToPipe(
String inputPath, String pipePath) async {
throw UnimplementedError(
'ffmpegKitConfigWriteToPipe() has not been implemented!');
}
Future<String?> ffmpegKitConfigSelectDocumentForRead(
String? type, List<String>? extraTypes) async {
throw UnimplementedError(
'ffmpegKitConfigSelectDocumentForRead() has not been implemented!');
}
Future<String?> ffmpegKitConfigSelectDocumentForWrite(
String? title, String? type, List<String>? extraTypes) async {
throw UnimplementedError(
'ffmpegKitConfigSelectDocumentForWrite() has not been implemented!');
}
Future<String?> ffmpegKitConfigGetSafParameterForRead(
String uriString) async {
throw UnimplementedError(
'ffmpegKitConfigGetSafParameterForRead() has not been implemented!');
}
Future<String?> ffmpegKitConfigGetSafParameterForWrite(
String uriString) async {
throw UnimplementedError(
'ffmpegKitConfigGetSafParameterForWrite() has not been implemented!');
}
// FFmpegKitFlutterInitializer
Future<int?> ffmpegKitFlutterInitializerGetLogLevel() async {
throw UnimplementedError(
'ffmpegKitFlutterInitializerGetLogLevel() has not been implemented!');
}
// FFmpegSession
Future<List<dynamic>?> ffmpegSessionGetAllStatistics(
int? sessionId, int? waitTimeout) async {
throw UnimplementedError(
'ffmpegSessionGetAllStatistics() has not been implemented!');
}
Future<List<dynamic>?> ffmpegSessionGetStatistics(int? sessionId) async {
throw UnimplementedError(
'ffmpegSessionGetStatistics() has not been implemented!');
}
// FFprobeKit
Future<List<dynamic>?> ffprobeKitListSessions() async {
throw UnimplementedError(
'ffprobeKitListSessions() has not been implemented!');
}
// MediaInformationJsonParser
Future<Map<dynamic, dynamic>?> mediaInformationJsonParserFrom(
String ffprobeJsonOutput) async {
throw UnimplementedError(
'mediaInformationJsonParserFrom() has not been implemented!');
}
Future<Map<dynamic, dynamic>?> mediaInformationJsonParserFromWithError(
String ffprobeJsonOutput) async {
throw UnimplementedError(
'mediaInformationJsonParserFromWithError() has not been implemented!');
}
Future<String?> getPackageName() async {
throw UnimplementedError('getPackageName() has not been implemented!');
}
Future<List<dynamic>?> getExternalLibraries() async {
throw UnimplementedError(
'getExternalLibraries() has not been implemented!');
}
}

347
flutter/flutter_platform_interface/lib/method_channel_ffmpeg_kit_flutter.dart Normal file
View File

@ -0,0 +1,347 @@
/*
* Copyright (c) 2021 Taner Sener
*
* 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.
*/
import 'package:flutter/foundation.dart';
import 'package:flutter/services.dart';
import 'ffmpeg_kit_flutter_platform_interface.dart';
const MethodChannel _channel =
const MethodChannel('flutter.arthenica.com/ffmpeg_kit');
/// An implementation of [FFmpegKitPlatform] that uses method channels.
class MethodChannelFFmpegKit extends FFmpegKitPlatform {
/// The MethodChannel that is being used by this implementation of the plugin.
@visibleForTesting
MethodChannel get channel => _channel;
// AbstractSession
@override
Future<Map<dynamic, dynamic>?> abstractSessionCreateFFmpegSession(
List<String> argumentsArray) async =>
_channel.invokeMethod<Map<dynamic, dynamic>>(
'ffmpegSession', {'arguments': argumentsArray});
@override
Future<Map<dynamic, dynamic>?> abstractSessionCreateFFprobeSession(
List<String> argumentsArray) async =>
_channel.invokeMethod<Map<dynamic, dynamic>>(
'ffprobeSession', {'arguments': argumentsArray});
@override
Future<Map<dynamic, dynamic>?> abstractSessionCreateMediaInformationSession(
List<String> argumentsArray) async =>
_channel.invokeMethod<Map<dynamic, dynamic>>(
'mediaInformationSession', {'arguments': argumentsArray});
@override
Future<int?> abstractSessionGetEndTime(int? sessionId) async => _channel
.invokeMethod<int>('abstractSessionGetEndTime', {'sessionId': sessionId});
@override
Future<int?> abstractSessionGetDuration(int? sessionId) async =>
_channel.invokeMethod<int>(
'abstractSessionGetDuration', {'sessionId': sessionId});
@override
Future<List<dynamic>?> abstractSessionGetAllLogs(
int? sessionId, int? waitTimeout) async =>
_channel.invokeMethod<List<dynamic>>('abstractSessionGetAllLogs',
{'sessionId': sessionId, 'waitTimeout': waitTimeout});
@override
Future<List<dynamic>?> abstractSessionGetLogs(int? sessionId) async =>
_channel.invokeMethod<List<dynamic>>(
'abstractSessionGetLogs', {'sessionId': sessionId});
@override
Future<String?> abstractSessionGetAllLogsAsString(
int? sessionId, int? waitTimeout) async =>
_channel.invokeMethod<String>('abstractSessionGetAllLogsAsString',
{'sessionId': sessionId, 'waitTimeout': waitTimeout});
@override
Future<int?> abstractSessionGetState(int? sessionId) async => _channel
.invokeMethod<int>('abstractSessionGetState', {'sessionId': sessionId});
@override
Future<int?> abstractSessionGetReturnCode(int? sessionId) async =>
_channel.invokeMethod<int>(
'abstractSessionGetReturnCode', {'sessionId': sessionId});
@override
Future<String?> abstractSessionGetFailStackTrace(int? sessionId) async =>
_channel.invokeMethod<String>(
'abstractSessionGetFailStackTrace', {'sessionId': sessionId});
@override
Future<bool> abstractSessionThereAreAsynchronousMessagesInTransmit(
int? sessionId) async =>
_channel.invokeMethod<bool>(
'abstractSessionThereAreAsynchronousMessagesInTransmit',
{'sessionId': sessionId}).then((value) => value ?? false);
// ArchDetect
@override
Future<String> archDetectGetArch() async =>
_channel.invokeMethod<String>('getArch').then((value) => value ?? "");
// FFmpegKit
@override
Future<void> ffmpegKitCancel() async => _channel.invokeMethod<void>('cancel');
@override
Future<void> ffmpegKitCancelSession(int sessionId) async =>
_channel.invokeMethod<void>('cancelSession', {'sessionId': sessionId});
@override
Future<List<dynamic>?> ffmpegKitListSessions() async =>
_channel.invokeMethod<List<dynamic>>('getFFmpegSessions');
// FFmpegKitConfig
@override
Future<void> ffmpegKitConfigEnableRedirection() async =>
_channel.invokeMethod<void>('enableRedirection');
@override
Future<void> ffmpegKitConfigDisableRedirection() async =>
_channel.invokeMethod<void>('disableRedirection');
@override
Future<void> ffmpegKitConfigSetFontconfigConfigurationPath(
String path) async =>
_channel
.invokeMethod<void>('setFontconfigConfigurationPath', {'path': path});
@override
Future<void> ffmpegKitConfigSetFontDirectory(
String path, Map<String, String>? mapping) async =>
_channel.invokeMethod<void>(
'setFontDirectory', {'fontDirectory': path, 'fontNameMap': mapping});
@override
Future<void> ffmpegKitConfigSetFontDirectoryList(
List<String> fontDirectoryList, Map<String, String>? mapping) async =>
_channel.invokeMethod<void>('setFontDirectoryList',
{'fontDirectoryList': fontDirectoryList, 'fontNameMap': mapping});
@override
Future<String?> ffmpegKitConfigRegisterNewFFmpegPipe() async =>
_channel.invokeMethod<String>('registerNewFFmpegPipe');
@override
Future<void> ffmpegKitConfigCloseFFmpegPipe(String ffmpegPipePath) async =>
_channel.invokeMethod<void>(
'closeFFmpegPipe', {'ffmpegPipePath': ffmpegPipePath});
@override
Future<String?> ffmpegKitConfigGetFFmpegVersion() async =>
_channel.invokeMethod<String>('getFFmpegVersion');
@override
Future<bool?> ffmpegKitConfigIsLTSBuild() async =>
_channel.invokeMethod<bool>('isLTSBuild');
@override
Future<String?> ffmpegKitConfigGetBuildDate() async =>
_channel.invokeMethod<String>('getBuildDate');
@override
Future<void> ffmpegKitConfigSetEnvironmentVariable(
String name, String value) async =>
_channel.invokeMethod<void>('setEnvironmentVariable',
{'variableName': name, 'variableValue': value});
@override
Future<void> ffmpegKitConfigIgnoreSignal(int signal) async =>
_channel.invokeMethod<void>('ignoreSignal', {'signal': signal});
@override
Future<void> ffmpegKitConfigAsyncFFmpegExecute(int? sessionId) async =>
_channel.invokeMethod<void>(
'asyncFFmpegSessionExecute', {'sessionId': sessionId});
@override
Future<void> ffmpegKitConfigAsyncFFprobeExecute(int? sessionId) async =>
_channel.invokeMethod<void>(
'asyncFFprobeSessionExecute', {'sessionId': sessionId});
@override
Future<void> ffmpegKitConfigAsyncGetMediaInformationExecute(
int? sessionId, int? waitTimeout) async =>
_channel.invokeMethod<void>('asyncMediaInformationSessionExecute',
{'sessionId': sessionId, 'waitTimeout': waitTimeout});
@override
Future<void> ffmpegKitConfigSetLogLevel(int logLevel) async =>
_channel.invokeMethod<void>('setLogLevel', {'level': logLevel});
@override
Future<int?> ffmpegKitConfigGetSessionHistorySize() async =>
_channel.invokeMethod<int>('getSessionHistorySize');
@override
Future<void> ffmpegKitConfigSetSessionHistorySize(
int sessionHistorySize) async =>
_channel.invokeMethod<void>(
'setSessionHistorySize', {'sessionHistorySize': sessionHistorySize});
@override
Future<Map<dynamic, dynamic>?> ffmpegKitConfigGetSession(
int sessionId) async =>
_channel.invokeMethod<Map<dynamic, dynamic>>(
'getSession', {'sessionId': sessionId});
@override
Future<Map<dynamic, dynamic>?> ffmpegKitConfigGetLastSession() async =>
_channel.invokeMethod<Map<dynamic, dynamic>>('getLastSession');
@override
Future<Map<dynamic, dynamic>?>
ffmpegKitConfigGetLastCompletedSession() async => _channel
.invokeMethod<Map<dynamic, dynamic>>('getLastCompletedSession');
@override
Future<List<dynamic>?> ffmpegKitConfigGetSessions() async =>
_channel.invokeMethod<List<dynamic>>('getSessions');
@override
Future<void> clearSessions() async =>
_channel.invokeMethod<void>('clearSessions');
@override
Future<List<dynamic>?> ffmpegKitConfigGetSessionsByState(
int sessionState) async =>
_channel.invokeMethod<List<dynamic>>(
'getSessionsByState', {'state': sessionState});
@override
Future<int?> ffmpegKitConfigMessagesInTransmit(int sessionId) async =>
_channel
.invokeMethod<int>('messagesInTransmit', {'sessionId': sessionId});
@override
Future<void> ffmpegKitConfigEnableLogs() async =>
_channel.invokeMethod<void>('enableLogs');
@override
Future<void> ffmpegKitConfigDisableLogs() async =>
_channel.invokeMethod<void>('disableLogs');
@override
Future<void> ffmpegKitConfigEnableStatistics() async =>
_channel.invokeMethod<void>('enableStatistics');
@override
Future<void> ffmpegKitConfigDisableStatistics() async =>
_channel.invokeMethod<void>('disableStatistics');
@override
Future<String?> ffmpegKitConfigGetPlatform() async =>
_channel.invokeMethod<String>('getPlatform');
@override
Future<int?> ffmpegKitConfigWriteToPipe(
String inputPath, String pipePath) async =>
_channel.invokeMethod<int>(
'writeToPipe', {'input': inputPath, 'pipe': pipePath});
@override
Future<String?> ffmpegKitConfigSelectDocumentForRead(
String? type, List<String>? extraTypes) async =>
_channel.invokeMethod<String>('selectDocument',
{'writable': false, 'type': type, 'extraTypes': extraTypes});
@override
Future<String?> ffmpegKitConfigSelectDocumentForWrite(
String? title, String? type, List<String>? extraTypes) async =>
_channel.invokeMethod<String>('selectDocument', {
'writable': true,
'title': title,
'type': type,
'extraTypes': extraTypes
});
@override
Future<String?> ffmpegKitConfigGetSafParameterForRead(
String uriString) async =>
_channel.invokeMethod<String>(
'getSafParameter', {'writable': false, 'uri': uriString});
@override
Future<String?> ffmpegKitConfigGetSafParameterForWrite(
String uriString) async =>
_channel.invokeMethod<String>(
'getSafParameter', {'writable': true, 'uri': uriString});
// FFmpegKitFlutterInitializer
Future<int?> ffmpegKitFlutterInitializerGetLogLevel() async =>
_channel.invokeMethod<int>('getLogLevel');
// FFmpegSession
@override
Future<List<dynamic>?> ffmpegSessionGetAllStatistics(
int? sessionId, int? waitTimeout) async =>
_channel.invokeMethod<List<dynamic>>('ffmpegSessionGetAllStatistics',
{'sessionId': sessionId, 'waitTimeout': waitTimeout});
@override
Future<List<dynamic>?> ffmpegSessionGetStatistics(int? sessionId) async =>
_channel.invokeMethod<List<dynamic>>(
'ffmpegSessionGetStatistics', {'sessionId': sessionId});
// FFprobeKit
@override
Future<List<dynamic>?> ffprobeKitListSessions() async =>
_channel.invokeMethod<List<dynamic>>('getFFprobeSessions');
// MediaInformationJsonParser
@override
Future<Map<dynamic, dynamic>?> mediaInformationJsonParserFrom(
String ffprobeJsonOutput) async =>
_channel.invokeMethod<Map<dynamic, dynamic>>(
'mediaInformationJsonParserFrom',
{'ffprobeJsonOutput': ffprobeJsonOutput});
@override
Future<Map<dynamic, dynamic>?> mediaInformationJsonParserFromWithError(
String ffprobeJsonOutput) async =>
_channel.invokeMethod<Map<dynamic, dynamic>>(
'mediaInformationJsonParserFromWithError',
{'ffprobeJsonOutput': ffprobeJsonOutput});
@override
Future<String?> getPackageName() async =>
_channel.invokeMethod<String>('getPackageName');
@override
Future<List<dynamic>?> getExternalLibraries() async =>
_channel.invokeMethod<List<dynamic>>('getExternalLibraries');
}

21
flutter/flutter_platform_interface/pubspec.yaml Normal file
View File

@ -0,0 +1,21 @@
name: ffmpeg_kit_flutter_platform_interface
description: A common platform interface for ffmpeg_kit_flutter plugin.
repository: https://github.com/tanersener/ffmpeg-kit
issue_tracker: https://github.com/tanersener/ffmpeg-kit/issues
homepage: https://github.com/tanersener/ffmpeg-kit
# NOTE: We strongly prefer non-breaking changes, even at the expense of a
# less-clean API. See https://flutter.dev/go/platform-interface-breaking-changes
version: 0.1.0
environment:
sdk: ">=2.12.0 <3.0.0"
flutter: ">=2.0.0"
dependencies:
flutter:
sdk: flutter
plugin_platform_interface: ^2.0.2
dev_dependencies:
flutter_test:
sdk: flutter

106
tools/release/flutter/create_packages.sh Executable file
View File

@ -0,0 +1,106 @@
#!/bin/bash
CURRENT_DIR=$(pwd)
BASEDIR="${CURRENT_DIR}/../../.."
TMPDIR="${BASEDIR}/.tmp"
PACKAGES_DIR="${TMPDIR}/flutter_packages"
SOURCE_DIR="${BASEDIR}/flutter/flutter"
PACKAGES=(min min-gpl https https-gpl audio video full full-gpl)
prepare_inline_sed() {
if [ "$(uname)" == "Darwin" ]; then
export SED_INLINE="sed -i .tmp"
else
export SED_INLINE="sed -i"
fi
}
create_main_releases() {
for CURRENT_PACKAGE in "${PACKAGES[@]}"; do
local FLUTTER_PACKAGE_NAME="$(echo "${CURRENT_PACKAGE}" | sed "s/\-/\_/g")"
local PACKAGE_PATH="${PACKAGES_DIR}/${CURRENT_PACKAGE}"
cp -r ${SOURCE_DIR} ${PACKAGE_PATH}
# 1. pubspec
$SED_INLINE "s|name: ffmpeg_kit_flutter|name: ffmpeg_kit_flutter_$FLUTTER_PACKAGE_NAME|g" ${PACKAGE_PATH}/pubspec.yaml
# UPDATE VERSION
rm -f ${PACKAGE_PATH}/pubspec.yaml.tmp
# 2. android
# UPDATE MIN SDK VERSION
$SED_INLINE "s|com.arthenica:.*|com.arthenica:ffmpeg-kit-$CURRENT_PACKAGE:$NATIVE_VERSION'|g" ${PACKAGE_PATH}/android/build.gradle
rm -f ${PACKAGE_PATH}/android/build.gradle.tmp
# 3. ios
$SED_INLINE "s|ffmpeg_kit_flutter|ffmpeg_kit_flutter_$FLUTTER_PACKAGE_NAME|g" ${PACKAGE_PATH}/ios/ffmpeg_kit_flutter.podspec
# UPDATE VERSION
$SED_INLINE "s|s.default_subspec.*|s.default_subspec = '$CURRENT_PACKAGE'|g" ${PACKAGE_PATH}/ios/ffmpeg_kit_flutter.podspec
rm -f ${PACKAGE_PATH}/ios/ffmpeg_kit_flutter.podspec.tmp
mv ${PACKAGE_PATH}/ios/ffmpeg_kit_flutter.podspec ${PACKAGE_PATH}/ios/ffmpeg_kit_flutter_$FLUTTER_PACKAGE_NAME.podspec
# 4. macos
$SED_INLINE "s|ffmpeg_kit_flutter|ffmpeg_kit_flutter_$FLUTTER_PACKAGE_NAME|g" ${PACKAGE_PATH}/macos/ffmpeg_kit_flutter.podspec
# UPDATE VERSION
$SED_INLINE "s|s.default_subspec.*|s.default_subspec = '$CURRENT_PACKAGE'|g" ${PACKAGE_PATH}/macos/ffmpeg_kit_flutter.podspec
rm -f ${PACKAGE_PATH}/macos/ffmpeg_kit_flutter.podspec.tmp
mv ${PACKAGE_PATH}/macos/ffmpeg_kit_flutter.podspec ${PACKAGE_PATH}/macos/ffmpeg_kit_flutter_$FLUTTER_PACKAGE_NAME.podspec
done;
echo "main releases created!"
}
create_lts_releases() {
for CURRENT_PACKAGE in "${PACKAGES[@]}"; do
local FLUTTER_PACKAGE_NAME="$(echo "${CURRENT_PACKAGE}" | sed "s/\-/\_/g")"
local PACKAGE_PATH="${PACKAGES_DIR}/${CURRENT_PACKAGE}-lts"
cp -r ${SOURCE_DIR} ${PACKAGE_PATH}
# 1. pubspec
$SED_INLINE "s|name: ffmpeg_kit_flutter|name: ffmpeg_kit_flutter_$FLUTTER_PACKAGE_NAME|g" ${PACKAGE_PATH}/pubspec.yaml
$SED_INLINE "s|version: .*|version: $VERSION-LTS|g" ${PACKAGE_PATH}/pubspec.yaml
rm -f ${PACKAGE_PATH}/pubspec.yaml.tmp
# 2. android
$SED_INLINE "s|minSdkVersion.*|minSdkVersion 16|g" ${PACKAGE_PATH}/android/build.gradle
$SED_INLINE "s|com.arthenica:.*|com.arthenica:ffmpeg-kit-$CURRENT_PACKAGE:$NATIVE_VERSION.LTS'|g" ${PACKAGE_PATH}/android/build.gradle
rm -f ${PACKAGE_PATH}/android/build.gradle.tmp
# 3. ios
$SED_INLINE "s|ffmpeg_kit_flutter|ffmpeg_kit_flutter_$FLUTTER_PACKAGE_NAME|g" ${PACKAGE_PATH}/ios/ffmpeg_kit_flutter.podspec
$SED_INLINE "s|s.version.*|s.version = '$VERSION.LTS'|g" ${PACKAGE_PATH}/ios/ffmpeg_kit_flutter.podspec
$SED_INLINE "s|s.default_subspec.*|s.default_subspec = '$CURRENT_PACKAGE-lts'|g" ${PACKAGE_PATH}/ios/ffmpeg_kit_flutter.podspec
rm -f ${PACKAGE_PATH}/ios/ffmpeg_kit_flutter.podspec.tmp
mv ${PACKAGE_PATH}/ios/ffmpeg_kit_flutter.podspec ${PACKAGE_PATH}/ios/ffmpeg_kit_flutter_$FLUTTER_PACKAGE_NAME.podspec
# 4. macos
$SED_INLINE "s|ffmpeg_kit_flutter|ffmpeg_kit_flutter_$FLUTTER_PACKAGE_NAME|g" ${PACKAGE_PATH}/macos/ffmpeg_kit_flutter.podspec
$SED_INLINE "s|s.version.*|s.version = '$VERSION.LTS'|g" ${PACKAGE_PATH}/macos/ffmpeg_kit_flutter.podspec
$SED_INLINE "s|s.default_subspec.*|s.default_subspec = '$CURRENT_PACKAGE-lts'|g" ${PACKAGE_PATH}/macos/ffmpeg_kit_flutter.podspec
rm -f ${PACKAGE_PATH}/macos/ffmpeg_kit_flutter.podspec.tmp
mv ${PACKAGE_PATH}/macos/ffmpeg_kit_flutter.podspec ${PACKAGE_PATH}/macos/ffmpeg_kit_flutter_$FLUTTER_PACKAGE_NAME.podspec
done;
echo "lts releases created!"
}
if [[ $# -ne 2 ]];
then
echo "Usage: create_package.sh <version name> <native library version>"
exit 1
fi
VERSION="$1"
NATIVE_VERSION="$2"
rm -rf "${PACKAGES_DIR}"
mkdir -p "${PACKAGES_DIR}"
prepare_inline_sed
create_main_releases;
create_lts_releases;
cp -r "${BASEDIR}/flutter/flutter_platform_interface" "$PACKAGES_DIR"