You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
Theelgirl 7f1bdcf8d7 Merge branch 'master' of https://github.com/AlfredoSequeida/fvid 5 months ago
docs Update docs 5 months ago
fvid Vastly speed up cython; misc other changes 5 months ago
tests Add tests; they take a long time atm 5 months ago
.gitignore docs 5 months ago
.readthedocs.yml Update Docs 5 months ago
CHANGELOG.md Update changelog 5 months ago
LICENSE.md add license 10 months ago
README.md update README 9 months ago
requirements.txt Vastly speed up cython; misc other changes 5 months ago
setup.py Remove unneeded lines 9 months ago

README.md

Maintenance PyPI license

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.

fvid


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

  1. 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.
  2. Fork the repository 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. :)