enable github pages

2021-03-06 16:56:09 +00:00 · 2021-03-06 16:56:09 +00:00 · 73ebc16c8b
commit 73ebc16c8b
parent 1a72036753
3 changed files with 170 additions and 15 deletions
--- a/README.md
+++ b/README.md
@ -7,21 +7,9 @@ FFmpeg Kit for applications.
 ### 1. Features
 - Scripts to build FFmpeg libraries
 - `FFmpegKit` wrapper library to run `FFmpeg`/`FFprobe` commands in applications
- Supports
-    - Android, iOS, macOS and tvOS
-    - FFmpeg `v4.4-dev`
-        - 29 external libraries
-
-            `chromaprint`, `dav1d`, `fontconfig`, `freetype`, `fribidi`, `gmp`, `gnutls`, `kvazaar`, `lame`, `libaom`, `libass`, `libiconv`, `libilbc`, `libtheora`, `libvorbis`, `libvpx`, `libwebp`, `libxml2`, `opencore-amr`, `openh264`, `opus`, `sdl`, `shine`, `snappy`, `soxr`, `speex`, `tesseract`, `twolame`, `vo-amrwbenc`
-        
-        - 5 external libraries with GPL license
-
-            `rubberband`, `vid.stab`, `x264`, `x265`, `xvidcore`
-
-    - Parallel command execution
-
+- Supports Android, iOS, macOS and tvOS
+- Based on FFmpeg `v4.4-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) and [CocoaPods](https://cocoapods.org).
-
 - Licensed under `LGPL 3.0`, or `GPL v3.0` if GPL licensed libraries are enabled

 ### 2. Android
@ -38,7 +26,7 @@ See [Apple](https://github.com/tanersener/ffmpeg-kit/tree/development/apple) to

 Use `android.sh`, `ios.sh`, `macos.sh` and `tvos.sh` to build `FFmpegKit` for each platform.

-All scripts support additional options to enable libraries and disable platform architectures.
+All scripts support additional options to enable optional libraries and disable platform architectures.

 ### 5. FFmpegKit Library

--- a/docs/_config.yml
+++ b/docs/_config.yml
@ -0,0 +1,14 @@
+# main section
+title: ffmpeg-kit
+baseurl: "/ffmpeg-kit"
+locale: "en"
+theme: jekyll-theme-minimal
+markdown: kramdown
+
+# github section
+show_downloads: true
+github:
+  zip_url:
+  tar_url: 
+  owner_name: Taner Sener
+  owner_url: https://github.com/tanersener
--- a/docs/index.md
+++ b/docs/index.md
@ -0,0 +1,153 @@
+# FFmpegKit
+
+FFmpeg Kit for applications.
+
+<img src="https://github.com/tanersener/ffmpeg-kit/raw/main/docs/assets/ffmpeg-kit-icon-v9.png" width="180">
+
+### 1. Features
+- Scripts to build FFmpeg libraries
+- `FFmpegKit` wrapper library to run `FFmpeg`/`FFprobe` commands in applications
+- Supports Android, iOS, macOS and tvOS
+- Based on FFmpeg `v4.4-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) and [CocoaPods](https://cocoapods.org).
+- Licensed under `LGPL 3.0`, or `GPL v3.0` if GPL licensed libraries are enabled
+
+### 2. Android
+
+See [Android](https://github.com/tanersener/ffmpeg-kit/tree/development/android) to learn more about `FFmpegKit` for
+`Android`.
+
+### 3. iOS, macOS, tvOS
+
+See [Apple](https://github.com/tanersener/ffmpeg-kit/tree/development/apple) to use `FFmpegKit` on `Apple` platforms
+(`iOS`, `macOS`, `tvOS`).
+
+### 4. Build Scripts
+
+Use `android.sh`, `ios.sh`, `macos.sh` and `tvos.sh` to build `FFmpegKit` for each platform.
+
+All scripts support additional options to enable optional libraries and disable platform architectures.
+
+### 5. 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 has a `Java` API and `Apple` libraries (`iOS`, `macOS`, `tvOS`) have an `Objective-C` API,
+which are identical in terms of features and capabilities.
+
+### 6. Binary Packages
+
+There are eight different `ffmpeg-kit` packages distributed on
+[Github](https://github.com/tanersener/ffmpeg-kit/releases),
+[Maven Central](https://search.maven.org) and [CocoaPods](https://cocoapods.org).
+Below you can see which 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
+include them.
+
+<table>
+<thead>
+<tr>
+<th align="center"></th>
+<th align="center"><sup>min</sup></th>
+<th align="center"><sup>min-gpl</sup></th>
+<th align="center"><sup>https</sup></th>
+<th align="center"><sup>https-gpl</sup></th>
+<th align="center"><sup>audio</sup></th>
+<th align="center"><sup>video</sup></th>
+<th align="center"><sup>full</sup></th>
+<th align="center"><sup>full-gpl</sup></th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td align="center"><sup>external libraries</sup></td>
+<td align="center">-</td>
+<td align="center"><sup>vid.stab</sup><br><sup>x264</sup><br><sup>x265</sup><br><sup>xvidcore</sup></td>
+<td align="center"><sup>gmp</sup><br><sup>gnutls</sup></td>
+<td align="center"><sup>gmp</sup><br><sup>gnutls</sup><br><sup>vid.stab</sup><br><sup>x264</sup><br><sup>x265</sup><br><sup>xvidcore</sup></td>
+<td align="center"><sup>lame</sup><br><sup>libilbc</sup><br><sup>libvorbis</sup><br><sup>opencore-amr</sup><br><sup>opus</sup><br><sup>shine</sup><br><sup>soxr</sup><br><sup>speex</sup><br><sup>twolame</sup><br><sup>vo-amrwbenc</sup></td>
+<td align="center"><sup>dav1d</sup><br><sup>fontconfig</sup><br><sup>freetype</sup><br><sup>fribidi</sup><br><sup>kvazaar</sup><br><sup>libass</sup><br><sup>libiconv</sup><br><sup>libtheora</sup><br><sup>libvpx</sup><br><sup>libwebp</sup><br><sup>snappy</sup></td>
+<td align="center"><sup>dav1d</sup><br><sup>fontconfig</sup><br><sup>freetype</sup><br><sup>fribidi</sup><br><sup>gmp</sup><br><sup>gnutls</sup><br><sup>kvazaar</sup><br><sup>lame</sup><br><sup>libass</sup><br><sup>libiconv</sup><br><sup>libilbc</sup><br><sup>libtheora</sup><br><sup>libvorbis</sup><br><sup>libvpx</sup><br><sup>libwebp</sup><br><sup>libxml2</sup><br><sup>opencore-amr</sup><br><sup>opus</sup><br><sup>shine</sup><br><sup>snappy</sup><br><sup>soxr</sup><br><sup>speex</sup><br><sup>twolame</sup><br><sup>vo-amrwbenc</sup></td>
+<td align="center"><sup>dav1d</sup><br><sup>fontconfig</sup><br><sup>freetype</sup><br><sup>fribidi</sup><br><sup>gmp</sup><br><sup>gnutls</sup><br><sup>kvazaar</sup><br><sup>lame</sup><br><sup>libass</sup><br><sup>libiconv</sup><br><sup>libilbc</sup><br><sup>libtheora</sup><br><sup>libvorbis</sup><br><sup>libvpx</sup><br><sup>libwebp</sup><br><sup>libxml2</sup><br><sup>opencore-amr</sup><br><sup>opus</sup><br><sup>shine</sup><br><sup>snappy</sup><br><sup>soxr</sup><br><sup>speex</sup><br><sup>twolame</sup><br><sup>vid.stab</sup><br><sup>vo-amrwbenc</sup><br><sup>x264</sup><br><sup>x265</sup><br><sup>xvidcore</sup></td>
+</tr>
+</tbody>
+</table>
+
+- `AVFoundation` is not available on `tvOS`, `VideoToolbox` is not available on `tvOS` LTS releases
+
+### 7. Versions
+
+`FFmpegKit` binaries generated use the same major and minor version numbers as the upstream `FFmpeg` project. The exact
+version number is obtained using `git describe --tags`. `dev` part in `FFmpeg` version number indicates that `FFmpeg`
+source is cloned from the `FFmpeg` `master` branch.
+
+|  FFmpegKit Version | FFmpeg Version | Release Date |
+| :----: | :----: |:----: |
+| [4.4](https://github.com/tanersener/ffmpeg-kit/releases/tag/v4.4) | 4.4-dev-3015 | Mar 03, 2021 |
+| [4.4.LTS](https://github.com/tanersener/ffmpeg-kit/releases/tag/v4.4.LTS) | 4.4-dev-3015 | Mar 03, 2021 |
+
+### 8. LTS Releases
+
+`FFmpegKit` binaries are published in two release variants: `Main Release` and `LTS Release`.
+
+- Main releases include complete functionality of the library and support the latest SDK/API features.
+
+- LTS releases are customized to support a wider range of devices. They are built using older API/SDK versions, so some features are not available on them.
+
+This table shows the differences between two variants.
+
+|        | Main Release | LTS Release |
+| :----: | :----: | :----: |
+| Android API Level | 24 | 16 | 
+| Android Camera Access | Yes | - |
+| Android Architectures | arm-v7a-neon<br/>arm64-v8a<br/>x86<br/>x86-64 | arm-v7a<br/>arm-v7a-neon<br/>arm64-v8a<br/>x86<br/>x86-64 |
+| Xcode Compatibility | 11.0 or later | 7.3.1 or later |
+| iOS SDK | 12.1 | 9.3 |
+| iOS AVFoundation | Yes | - |
+| iOS Architectures | arm64<br/>arm64-simulator<br/>arm64-mac-catalyst<br/>x86-64<br/>x86-64-mac-catalyst | armv7<br/>arm64<br/>i386<br/>x86-64 |
+| macOS SDK | 10.15 | 10.11 |
+| macOS AVFoundation | Yes | - |
+| macOS Architectures | arm64<br/>x86-64 | x86-64 |
+| tvOS SDK | 10.2 | 9.2 |
+| tvOS Architectures | arm64<br/>x86-64<br/>arm64-simulator | arm64<br/>x86-64 |
+
+### 9. 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.
+
+### 10. 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.
+
+### 11. Patents
+
+It is not clearly explained in their documentation, but it is believed that `FFmpeg`, `kvazaar`, `x264` and `x265`
+include algorithms which are subject to software patents. If you live in a country where software algorithms are
+patentable then you'll probably need to pay royalty fees to patent holders. We are not lawyers though, so we recommend
+that you seek legal advice first. See [FFmpeg Patent Mini-FAQ](https://ffmpeg.org/legal.html).
+
+`openh264` clearly states that it uses patented algorithms. Therefore, if you build `ffmpeg-kit` with `openh264` and
+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.
+
+### 12. 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` branch. Therefore, if you want to create a pull request, please open it against
+the `development`.
+
+### 13. See Also
+
+- [FFmpeg API Documentation](https://ffmpeg.org/doxygen/4.0/index.html)
+- [FFmpeg Wiki](https://trac.ffmpeg.org/wiki/WikiStart)
+- [FFmpeg External Library Licenses](https://www.ffmpeg.org/doxygen/4.0/md_LICENSE.html)