Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sbis04/video_trimmer
Flutter video trimmer package
https://github.com/sbis04/video_trimmer
hacktoberfest video-trimmer
Last synced: 2 days ago
JSON representation
Flutter video trimmer package
- Host: GitHub
- URL: https://github.com/sbis04/video_trimmer
- Owner: sbis04
- License: mit
- Created: 2020-04-30T04:56:04.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-02T05:36:22.000Z (5 months ago)
- Last Synced: 2024-11-06T16:12:06.287Z (9 days ago)
- Topics: hacktoberfest, video-trimmer
- Language: Dart
- Homepage: https://pub.dev/packages/video_trimmer
- Size: 22.5 MB
- Stars: 440
- Watchers: 6
- Forks: 271
- Open Issues: 59
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
A Flutter package for trimming videos
### Features
* Customizable video trimmer.
* Supports two types of trim viewer, fixed length and scrollable.
* Video playback control.
* Retrieving and storing video file.
Also, supports conversion to **GIF**.
> NOTE: Versions `3.0.0` and above uses the "Full" version of Flutter FFmpeg. To install the "LTS" version, use the "x.x.x-LTS" version of this package.
Following image shows the structure of the `TrimViewer`. It consists of the `Duration` on top (displaying the start, end, and scrubber time), `TrimArea` consisting of the thumbnails, and `TrimEditor` which is an overlay that let's you select a portion from the video.
## Example
The [example app](https://github.com/sbis04/video_trimmer/tree/main/example) running on an iPhone 13 Pro device:
## Usage
Add the dependency `video_trimmer` to your **pubspec.yaml** file:
For using main version of FFmpeg package:
```yaml
dependencies:
video_trimmer: ^3.0.0
```
For using LTS version of FFmpeg package:
```yaml
dependencies:
video_trimmer: ^3.0.0-LTS
```
### Android configuration
No additional configuration is needed for using on Android platform. You are good to go!
### iOS configuration
* Add the following keys to your **Info.plist** file, located in `/ios/Runner/Info.plist`:
```
NSCameraUsageDescription
Used to demonstrate image picker plugin
NSMicrophoneUsageDescription
Used to capture audio for image picker plugin
NSPhotoLibraryUsageDescription
Used to demonstrate image picker plugin
```
## FFmpeg Release
This package supports both Main and [LTS version](https://github.com/arthenica/ffmpeg-kit/wiki/LTS-Releases) of the FFmpeg implementation.
Main Release
LTS Release
Android API Level
24
16
Android Camera Access
Yes
-
Android Architectures
arm-v7a-neon
arm64-v8a
x86
x86-64
arm-v7a
arm-v7a-neon
arm64-v8a
x86
x86-64
iOS Min SDK
12.1
10
iOS Architectures
arm64
arm64-simulator
arm64-mac-catalyst
x86-64
x86-64-mac-catalyst
armv7
arm64
i386
x86-64
## Functionalities
### Loading input video file
```dart
final Trimmer _trimmer = Trimmer();
await _trimmer.loadVideo(videoFile: file);
```
### Saving trimmed video
Returns a string to indicate whether the saving operation was successful.
```dart
await _trimmer
.saveTrimmedVideo(startValue: _startValue, endValue: _endValue)
.then((value) {
setState(() {
_value = value;
});
});
```
### Video playback state
Returns the video playback state. If **true** then the video is playing, otherwise it is paused.
```dart
await _trimmer.videoPlaybackControl(
startValue: _startValue,
endValue: _endValue,
);
```
### Advanced Command
You can use an advanced **FFmpeg** command if you require more customization. Just define your FFmpeg command using the `ffmpegCommand` property and set an output video format using `customVideoFormat`.
Refer to the [Official FFmpeg Documentation](https://ffmpeg.org/documentation.html) for more information.
> **NOTE:** Passing a wrong video format to the `customVideoFormat` property may result in a crash.
```dart
// Example of defining a custom command
// This is already used for creating GIF by
// default, so you do not need to use this.
await _trimmer
.saveTrimmedVideo(
startValue: _startValue,
endValue: _endValue,
ffmpegCommand:
'-vf "fps=10,scale=480:-1:flags=lanczos,split[s0][s1];[s0]palettegen[p];[s1][p]paletteuse" -loop 0',
customVideoFormat: '.gif')
.then((value) {
setState(() {
_value = value;
});
});
```
## Widgets
### Display a video playback area
```dart
VideoViewer(trimmer: _trimmer)
```
### Display the video trimmer area
```dart
TrimViewer(
trimmer: _trimmer,
viewerHeight: 50.0,
viewerWidth: MediaQuery.of(context).size.width,
maxVideoLength: const Duration(seconds: 10),
onChangeStart: (value) => _startValue = value,
onChangeEnd: (value) => _endValue = value,
onChangePlaybackState: (value) =>
setState(() => _isPlaying = value),
)
```
## Example
Before using this example directly in a Flutter app, don't forget to add the `video_trimmer` & `file_picker` packages to your `pubspec.yaml` file.
You can try out this example by replacing the entire content of `main.dart` file of a newly created Flutter project.
```dart
import 'dart:io';
import 'package:file_picker/file_picker.dart';
import 'package:flutter/material.dart';
import 'package:video_trimmer/video_trimmer.dart';
void main() => runApp(MyApp());
class MyApp extends StatelessWidget {
@override
Widget build(BuildContext context) {
return MaterialApp(
title: 'Video Trimmer',
theme: ThemeData(
primarySwatch: Colors.blue,
),
home: HomePage(),
);
}
}
class HomePage extends StatelessWidget {
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: Text("Video Trimmer"),
),
body: Center(
child: Container(
child: ElevatedButton(
child: Text("LOAD VIDEO"),
onPressed: () async {
FilePickerResult? result = await FilePicker.platform.pickFiles(
type: FileType.video,
allowCompression: false,
);
if (result != null) {
File file = File(result.files.single.path!);
Navigator.of(context).push(
MaterialPageRoute(builder: (context) {
return TrimmerView(file);
}),
);
}
},
),
),
),
);
}
}
class TrimmerView extends StatefulWidget {
final File file;
TrimmerView(this.file);
@override
_TrimmerViewState createState() => _TrimmerViewState();
}
class _TrimmerViewState extends State {
final Trimmer _trimmer = Trimmer();
double _startValue = 0.0;
double _endValue = 0.0;
bool _isPlaying = false;
bool _progressVisibility = false;
Future _saveVideo() async {
setState(() {
_progressVisibility = true;
});
String? _value;
await _trimmer
.saveTrimmedVideo(startValue: _startValue, endValue: _endValue)
.then((value) {
setState(() {
_progressVisibility = false;
_value = value;
});
});
return _value;
}
void _loadVideo() {
_trimmer.loadVideo(videoFile: widget.file);
}
@override
void initState() {
super.initState();
_loadVideo();
}
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: Text("Video Trimmer"),
),
body: Builder(
builder: (context) => Center(
child: Container(
padding: EdgeInsets.only(bottom: 30.0),
color: Colors.black,
child: Column(
mainAxisAlignment: MainAxisAlignment.center,
mainAxisSize: MainAxisSize.max,
children: [
Visibility(
visible: _progressVisibility,
child: LinearProgressIndicator(
backgroundColor: Colors.red,
),
),
ElevatedButton(
onPressed: _progressVisibility
? null
: () async {
_saveVideo().then((outputPath) {
print('OUTPUT PATH: $outputPath');
final snackBar = SnackBar(
content: Text('Video Saved successfully'));
ScaffoldMessenger.of(context).showSnackBar(
snackBar,
);
});
},
child: Text("SAVE"),
),
Expanded(
child: VideoViewer(trimmer: _trimmer),
),
Center(
child: TrimViewer(
trimmer: _trimmer,
viewerHeight: 50.0,
viewerWidth: MediaQuery.of(context).size.width,
maxVideoLength: const Duration(seconds: 10),
onChangeStart: (value) => _startValue = value,
onChangeEnd: (value) => _endValue = value,
onChangePlaybackState: (value) =>
setState(() => _isPlaying = value),
),
),
TextButton(
child: _isPlaying
? Icon(
Icons.pause,
size: 80.0,
color: Colors.white,
)
: Icon(
Icons.play_arrow,
size: 80.0,
color: Colors.white,
),
onPressed: () async {
bool playbackState = await _trimmer.videoPlaybackControl(
startValue: _startValue,
endValue: _endValue,
);
setState(() {
_isPlaying = playbackState;
});
},
)
],
),
),
),
),
);
}
}
```
## Troubleshooting LTS version
While running on the Android platform if it gives an error that the `minSdkVersion` needs to be `24`, or on iOS platform that the Podfile platform version should be `11`, first go to `pubspec.lock` file and see if the version of `ffmpeg_kit_flutter` has `-LTS` suffix. This should fix all issues for iOS platform.
On Android, if you still face the same issue, try adding the following to the `/android/app/src/main/AndroidManifest.xml`:
```
```
## License
Copyright (c) 2023 Souvik Biswas
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.