https://github.com/alfredosequeida/fvid
fvid is a project that aims to encode any file as a video using 1-bit color images to survive compression algorithms for data retrieval.
https://github.com/alfredosequeida/fvid
ffmpeg hacktoberfest hacktoberfest2020 open-source pillow video youtube
Last synced: 6 months ago
JSON representation
fvid is a project that aims to encode any file as a video using 1-bit color images to survive compression algorithms for data retrieval.
- Host: GitHub
- URL: https://github.com/alfredosequeida/fvid
- Owner: AlfredoSequeida
- License: mit
- Created: 2020-10-05T10:32:12.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-15T18:29:46.000Z (over 4 years ago)
- Last Synced: 2025-04-05T06:06:04.809Z (6 months ago)
- Topics: ffmpeg, hacktoberfest, hacktoberfest2020, open-source, pillow, video, youtube
- Language: Python
- Homepage:
- Size: 5.2 MB
- Stars: 358
- Watchers: 12
- Forks: 42
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)
[](https://pypi.python.org/pypi/ansicolortags/)
[Demonstration/Explanation Video](https://youtu.be/yu_ZIr0q5rU)
fvid is a project that aims to encode any file as a video using 1-bit color images
to survive compression algorithms for data retrieval.
---
# Installation
Requires installation of [FFmpeg](https://ffmpeg.org/download.html) and libmagic first, then install using pip3
Linux/macOS
```
pip3 install fvid
```
Windows
```
py -m pip install fvid
```
# Usage
Encoding files as videos
Linux/OSX
```
fvid -i [input file] -e
fvid -i [input file] --framerate 1 -e
fvid -i [input file] --password "wow fvid is cool" -e
```
Windows
```
py -m fvid -i [input file] -e
py -m fvid -i [input file] --framerate 1 -e
py -m fvid -i [input file] --password "wow fvid is cool" -e
```
Retrieving data from videos
Linux/OSX
```
fvid -i [input video] -d
```
Windows
```
py -m fvid -i [input video] -d
```
If the file was encoded with a non-default password, it'll prompt you to enter the password upon decoding.
How to Contribute
-----------------
1. Check for open issues or open a fresh issue to start a discussion
around a feature idea or a bug [here](https://github.com/AlfredoSequeida/fvid/issues)
tag for issues that should be ideal for people who are not very familiar with the codebase yet.
2. Fork [the repository](https://github.com/alfredosequeida/fvid) on
GitHub to start making your changes to the **master** branch (or branch off of it).
3. Write a test which shows that the bug was fixed or that the feature
works as expected.
4. Send a pull request and bug the maintainer until it gets merged and
published. :)