minhngoc25a
/
fvid
mirror of https://github.com/AlfredoSequeida/fvid
1
0
Fork 0
Code Issues Releases Wiki Activity
50 Commits 4 Branches 3 Tags 5.5 MiB
Python 100%
Go to file
Theelgirl 36e939c451 Update __main__.py 2020-10-13 14:33:33 +00:00
fvid Update __main__.py 2020-10-13 14:33:33 +00:00
.gitignore created requirements, and ignoring a tmp folder 2020-10-07 09:29:41 -04:00
LICENSE.md add license 2020-10-07 07:06:25 -07:00
README.md Added demo video 2020-10-07 18:04:57 -07:00
setup.py Update setup.py 2020-10-13 14:26:32 +00:00

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

Windows

py -m fvid -i [input file] -e

Retrieving data from videos

Linux/OSX

fvid -i [input video] -d

Windows

py -m fvid -i [input video] -d

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