mirror of https://github.com/AlfredoSequeida/fvid
7f1bdcf8d7
what am i doing Former-commit-id: d11400e0bdbde6316e4775d813bf3d9d477b6ed2 |
||
---|---|---|
docs | ||
fvid | ||
tests | ||
.gitignore | ||
.readthedocs.yml | ||
CHANGELOG.md | ||
LICENSE.md | ||
README.md | ||
requirements.txt | ||
setup.py |
README.md
Demonstration/Explanation Video
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 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
- Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug here tag for issues that should be ideal for people who are not very familiar with the codebase yet.
- Fork the repository on GitHub to start making your changes to the master branch (or branch off of it).
- Write a test which shows that the bug was fixed or that the feature works as expected.
- Send a pull request and bug the maintainer until it gets merged and published. :)