Skip to content
This repository was archived by the owner on Jan 6, 2025. It is now read-only.

Commit d8db2ad

Browse files
committed
update README
1 parent d3aca61 commit d8db2ad

File tree

2 files changed

+32
-14
lines changed

2 files changed

+32
-14
lines changed

Diff for: README.md

+30-14
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# MobileFFmpeg ![GitHub release](https://img.shields.io/badge/release-v4.2.1-blue.svg) ![Bintray](https://img.shields.io/badge/bintray-v4.2.1-blue.svg) ![CocoaPods](https://img.shields.io/badge/pod-v4.2.1-blue.svg) [![Build Status](https://travis-ci.org/tanersener/mobile-ffmpeg.svg?branch=master)](https://travis-ci.org/tanersener/mobile-ffmpeg)
1+
# MobileFFmpeg ![GitHub release](https://img.shields.io/badge/release-v4.2.2-blue.svg) ![Bintray](https://img.shields.io/badge/bintray-v4.2.2-blue.svg) ![CocoaPods](https://img.shields.io/badge/pod-v4.2.2-blue.svg) [![Build Status](https://travis-ci.org/tanersener/mobile-ffmpeg.svg?branch=master)](https://travis-ci.org/tanersener/mobile-ffmpeg)
22

3-
FFmpeg for Android and iOS / tvOS
3+
FFmpeg for Android, iOS and tvOS
44

55
<img src="https://github.com/tanersener/mobile-ffmpeg/blob/master/docs/assets/mobile-ffmpeg-logo-v7.png" width="320">
66

@@ -54,12 +54,11 @@ FFmpeg for Android and iOS / tvOS
5454
### 2. Using
5555
Published binaries are available at [Github](https://github.com/tanersener/mobile-ffmpeg/releases), [JCenter](https://bintray.com/bintray/jcenter) and [CocoaPods](https://cocoapods.org).
5656

57-
- Visit [Importing iOS Frameworks](https://github.com/tanersener/mobile-ffmpeg/wiki/Importing-iOS-Frameworks) guide to manually import iOS / tvOS frameworks
58-
- Refer to [Using iOS Universal Binaries](https://github.com/tanersener/mobile-ffmpeg/wiki/Using-iOS-Universal-Binaries) guide to import iOS / tvOS universal binaries
59-
6057
Unpublished development builds can be found under the [development-snapshot](https://www.dropbox.com/sh/frzg32yjzyucmob/AADX81RhiVfk9o7Vo2J8jlH2a) directory.
6158

62-
There are eight different binary packages. Below you can see which system libraries and external libraries are enabled in each of them.
59+
There are eight different `mobile-ffmpeg` packages. Below you can see which system libraries and external libraries are enabled in each of them.
60+
61+
Please remember that some parts of `FFmpeg` are licensed under the `GPL` and only `GPL` licensed `mobile-ffmpeg` packages include them.
6362

6463
<table>
6564
<thead>
@@ -115,10 +114,10 @@ There are eight different binary packages. Below you can see which system librar
115114
- `AVFoundation` is not available on `tvOS`, `VideoToolbox` is not available on `tvOS` LTS releases
116115

117116
#### 2.1 Android
118-
1. Add MobileFFmpeg dependency from `jcenter()`
117+
1. Add MobileFFmpeg dependency to your `build.gradle` in `mobile-ffmpeg-<package name>` format
119118
```
120119
dependencies {
121-
implementation 'com.arthenica:mobile-ffmpeg-min:4.2.1'
120+
implementation 'com.arthenica:mobile-ffmpeg-min:4.2.2'
122121
}
123122
```
124123
@@ -192,16 +191,16 @@ There are eight different binary packages. Below you can see which system librar
192191
```
193192
194193
#### 2.2 iOS / tvOS
195-
1. Add MobileFFmpeg pod to your `Podfile`
194+
1. Add MobileFFmpeg dependency to your `Podfile` in `mobile-ffmpeg-<package name>` format
196195
197196
- iOS
198197
```
199-
pod 'mobile-ffmpeg-min', '~> 4.2.1'
198+
pod 'mobile-ffmpeg-min', '~> 4.2.2'
200199
```
201200
202201
- tvOS
203202
```
204-
pod 'mobile-ffmpeg-tv-min', '~> 4.2.1'
203+
pod 'mobile-ffmpeg-tv-min', '~> 4.2.2'
205204
```
206205
207206
2. Execute commands.
@@ -277,8 +276,18 @@ There are eight different binary packages. Below you can see which system librar
277276
```
278277
[MobileFFmpegConfig setFontDirectory:@"<folder with fonts>" with:nil];
279278
```
279+
280+
#### 2.3 Manual Installation
281+
##### 2.3.1 Android
282+
283+
You can import `MobileFFmpeg` aar packages in `Android Studio` using the `File` -> `New` -> `New Module` -> `Import .JAR/.AAR Package` menu.
284+
285+
##### 2.3.2 iOS / tvOS
286+
287+
iOS and tvOS frameworks can be installed manually using the [Importing Frameworks](https://github.com/tanersener/mobile-ffmpeg/wiki/Importing-Frameworks) guide.
288+
If you want to use universal binaries please refer to [Using Universal Binaries](https://github.com/tanersener/mobile-ffmpeg/wiki/Using-Universal-Binaries) guide.
280289
281-
#### 2.3 Test Application
290+
#### 2.4 Test Application
282291
You can see how MobileFFmpeg is used inside an application by running test applications provided.
283292
There is an `Android` test application under the `android/test-app` folder, an `iOS` test application under the
284293
`ios/test-app` folder and a `tvOS` test application under the `tvos/test-app` folder.
@@ -291,12 +300,17 @@ burning subtitles, video stabilization and pipe operations.
291300
### 3. Versions
292301
293302
`MobileFFmpeg` version number is aligned with `FFmpeg` since version `4.2`.
294-
In previous versions, `MobileFFmpeg` version of a release and `FFmpeg` version included in that release was different.
303+
304+
In previous versions, `MobileFFmpeg` version of a release and `FFmpeg` version included in that release was different.
305+
The following table lists `FFmpeg` versions used in `MobileFFmpeg` releases.
306+
295307
- `dev` part in `FFmpeg` version number indicates that `FFmpeg` source is pulled from the `FFmpeg` `master` branch.
296308
Exact version number is obtained using `git describe --tags`.
297309
298310
| MobileFFmpeg Version | FFmpeg Version | Release Date |
299311
| :----: | :----: |:----: |
312+
| [4.2.2](https://github.com/tanersener/mobile-ffmpeg/releases/tag/v4.2.2) | 4.2-dev-1824 | July 3, 2019 |
313+
| [4.2.2.LTS](https://github.com/tanersener/mobile-ffmpeg/releases/tag/v4.2.2.LTS) | 4.2-dev-1824 | July 3, 2019 |
300314
| [4.2.1](https://github.com/tanersener/mobile-ffmpeg/releases/tag/v4.2.1) | 4.2-dev-1156 | Apr 2, 2019 |
301315
| [4.2](https://github.com/tanersener/mobile-ffmpeg/releases/tag/v4.2) | 4.2-dev-480 | Jan 3, 2019 |
302316
| [4.2.LTS](https://github.com/tanersener/mobile-ffmpeg/releases/tag/v4.2.LTS) | 4.2-dev-480 | Jan 3, 2019 |
@@ -316,7 +330,7 @@ Starting from `v4.2`, `MobileFFmpeg` binaries are published in two different var
316330
317331
- Main releases include complete functionality of the library and support the latest SDK/API features.
318332
319-
- LTS releases are customized to support a wide range of devices. They are built using older API/SDK versions, so some features are not available for them.
333+
- 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.
320334
321335
This table shows the differences between two variants.
322336
@@ -339,6 +353,8 @@ Please remember that these builds are provided for testing and development purpo
339353
340354
### 6. Building
341355
356+
Build scripts from `master` and `development` branches are tested periodically. See the latest status from the table below.
357+
342358
| branch | status |
343359
| :---: | :---: |
344360
| master | [![Build Status](https://travis-ci.org/tanersener/mobile-ffmpeg.svg?branch=master)](https://travis-ci.org/tanersener/mobile-ffmpeg) |

Diff for: tools/clean.sh

+2
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ rm -rf ../ios/test-app/universal/Pods
1717
rm -rf ../ios/test-app/universal/*.framework
1818
rm -rf ../ios/test-app/universal/mobile-ffmpeg-universal
1919

20+
rm -rf ../tvos/test-app/pods/Pods
21+
rm -rf ../tvos/test-app/pods/*.framework
2022
rm -rf ../tvos/test-app/manual-frameworks/Pods
2123
rm -rf ../tvos/test-app/manual-frameworks/*.framework
2224
rm -rf ../tvos/test-app/universal/Pods

0 commit comments

Comments
 (0)