Go to file
Theelgirl 7f1bdcf8d7 Merge branch 'master' of https://github.com/AlfredoSequeida/fvid
what am i doing

Former-commit-id: d11400e0bdbde6316e4775d813bf3d9d477b6ed2
2021-03-09 08:48:03 -08:00
docs Update docs 2021-03-02 10:50:03 -08:00
fvid Vastly speed up cython; misc other changes 2021-03-09 08:19:25 -08:00
tests Add tests; they take a long time atm 2021-03-09 08:30:19 -08:00
.gitignore docs 2021-02-21 11:24:12 -08:00
.readthedocs.yml Update Docs 2021-02-25 10:50:49 -08:00
CHANGELOG.md Update changelog 2021-02-25 10:59:48 -08:00
LICENSE.md add license 2020-10-07 07:06:25 -07:00
README.md update README 2020-10-29 13:45:19 +03:00
requirements.txt Vastly speed up cython; misc other changes 2021-03-09 08:19:25 -08:00
setup.py Remove unneeded lines 2020-10-28 17:10:54 +00:00


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.



Requires installation of FFmpeg and libmagic first, then install using pip3


pip3 install fvid 


py -m pip install fvid 


Encoding files as videos


fvid -i [input file] -e
fvid -i [input file] --framerate 1 -e
fvid -i [input file] --password "wow fvid is cool" -e


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


fvid -i [input video] -d


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. :)