Fideo

Encodes any file to a video

Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Documentation
• Contributing
• License
• Contact

About The Project

This project is aimed at:

• Encoding any file - pdf, image, zip archive, anything to a video, like this one.
• Uploading that video to YouTube, as it provides us free umlimited cloud storage of videos
• Downloading that video anywhere and decoding back it into our original file

So in short, we are going to exploit the unlimited free cloud storage of videos provided by YouTube as our cloud backup of files.

Built With

• Python3
• Jupyter notebook

Getting Started

Grab a python3 distribution and run the source code in jupyter notebook / terminal. You can just have python3 installed on your machine and run main.py with proper options and arguments right from your terminal, rather than using jupyter notebook.

Prerequisites

pip install -r requirements.txt

in your terminal to install all the required dependencies and modules. Else they get installed automatically if you run the ipython notebook.

Installation

1. Clone the repo

git clone https://github.com/shie-ld/fideo.git

2. Install required modules

pip install -r requirements.txt

3. Run the ipython notebook in src folder

Don't forget to put in the filename you want to encode in encode_file function in the last of the notebook. Check current directory and viola, you have encoded the file to video.

**OR**

4. Hit python3 main.py [options] <arguments> with proper options and arguments and you are good to go.

Usage

Using Jupyter Notebook:

Encode file.zip to OUTFILE.mp4:

encode_file('file.zip')

Decode OUTFILE.mp4 to OUT.zip:

decode_file('OUTFILE.mp4', 'OUT.zip')

which should come out to be an exact copy of file.zip. You can verify that by comparing the two files.

Using Command Line:

OPTIONS
-e | --encode : Specify you want to encode a file

-d | --decode : Specify you want to decode a file

-i | --input : Specifying the input file. You can use absolute paths as well as relative paths. 
               It is a required argument.
               eg. -i /home/user/file.zip
               
-o | --output : Specifying the output file. You can use absolute paths as well as relative paths.
                Any existing file with same name will be deleted.
                At encoding time default is OUTFILE.mp4
                eg. -o /home/user/video.mp4
                
-f | --framerate : Specify the encoding and decoding framerate of video. Default is 24.
                   Must be integer. Encoding and Decoding should have the same framerate.
                

So practical usage will look like:

pip install -r requirements.txt

# encoding
python3 main.py -e -i infile.zip -f 15 -o video.mp4 

# decoding
python3 main.py -d -i video.mp4 -f 15 -o outfile.mp4 

Documentation:

See the main.py.

NOTE:

Due to some issues, you may see a warning when you access the program through command line. Anyways, you can ignore the warnings and the program will run fine.

/bin/bash: warning: setlocale: LC_ALL: cannot change locale (en_US.UTF-8)
ffmpeg version n4.3.1 Copyright (c) 2000-2020 the FFmpeg developers
  built with gcc 7 (Ubuntu 7.5.0-3ubuntu1~18.04)
  configuration: --prefix= --prefix=/usr --disable-debug --disable-doc --disable-static --enable-cuda --enable-cuda-sdk --enable-cuvid --enable-libdrm --enable-ffplay --enable-gnutls --enable-gpl --enable-libass --enable-libfdk-aac --enable-libfontconfig --enable-libfreetype --enable-libmp3lame --enable-libnpp --enable-libopencore_amrnb --enable-libopencore_amrwb --enable-libopus --enable-libpulse --enable-sdl2 --enable-libspeex --enable-libtheora --enable-libtwolame --enable-libv4l2 --enable-libvorbis --enable-libvpx --enable-libx264 --enable-libx265 --enable-libxcb --enable-libxvid --enable-nonfree --enable-nvenc --enable-omx --enable-openal --enable-opencl --enable-runtime-cpudetect --enable-shared --enable-vaapi --enable-vdpau --enable-version3 --enable-xlib
  libavutil      56. 51.100 / 56. 51.100
  libavcodec     58. 91.100 / 58. 91.100
  libavformat    58. 45.100 / 58. 45.100
  libavdevice    58. 10.100 / 58. 10.100
  libavfilter     7. 85.100 /  7. 85.100
  libswscale      5.  7.100 /  5.  7.100
  libswresample   3.  7.100 /  3.  7.100
  libpostproc    55.  7.100 / 55.  7.100
Input #0, image2, from './inframes/frame_%d.png':
  Duration: 00:00:00.08, start: 0.000000, bitrate: N/A
    Stream #0:0: Video: png, monob(pc), 854x480, 25 tbr, 25 tbn, 25 tbc

**OR**

bin/bash: warning: setlocale: LC_ALL: cannot change locale (en_US.UTF-8)
ffmpeg version n4.3.1 Copyright (c) 2000-2020 the FFmpeg developers
  built with gcc 7 (Ubuntu 7.5.0-3ubuntu1~18.04)
  configuration: --prefix= --prefix=/usr --disable-debug --disable-doc --disable-static --enable-cuda --enable-cuda-sdk --enable-cuvid --enable-libdrm --enable-ffplay --enable-gnutls --enable-gpl --enable-libass --enable-libfdk-aac --enable-libfontconfig --enable-libfreetype --enable-libmp3lame --enable-libnpp --enable-libopencore_amrnb --enable-libopencore_amrwb --enable-libopus --enable-libpulse --enable-sdl2 --enable-libspeex --enable-libtheora --enable-libtwolame --enable-libv4l2 --enable-libvorbis --enable-libvpx --enable-libx264 --enable-libx265 --enable-libxcb --enable-libxvid --enable-nonfree --enable-nvenc --enable-omx --enable-openal --enable-opencl --enable-runtime-cpudetect --enable-shared --enable-vaapi --enable-vdpau --enable-version3 --enable-xlib
  libavutil      56. 51.100 / 56. 51.100
  libavcodec     58. 91.100 / 58. 91.100
  libavformat    58. 45.100 / 58. 45.100
  libavdevice    58. 10.100 / 58. 10.100
  libavfilter     7. 85.100 /  7. 85.100
  libswscale      5.  7.100 /  5.  7.100
  libswresample   3.  7.100 /  3.  7.100
  libpostproc    55.  7.100 / 55.  7.100
Input #0, mov,mp4,m4a,3gp,3g2,mj2, from 'video.mp4':
  Metadata:
    major_brand     : isom
    minor_version   : 512
    compatible_brands: isomiso2avc1mp41
    encoder         : Lavf58.45.100
  Duration: 00:00:00.08, start: 0.000000, bitrate: 29530 kb/s
    Stream #0:0(und): Video: h264 (High 4:4:4 Predictive) (avc1 / 0x31637661), yuvj444p(pc), 854x480, 29687 kb/s, 24 fps, 24 tbr, 12288 tbn, 48 tbc (default)
    Metadata:
      handler_name    : VideoHandler
Stream mapping:
  Stream #0:0 (h264) -> fps
  fps -> Stream #0:0 (png)
Press [q] to stop, [?] for help
[swscaler @ 0x56482c82f3c0] deprecated pixel format used, make sure you did set range correctly
Output #0, image2, to './outframes/frame_%d.png':
  Metadata:
    major_brand     : isom
    minor_version   : 512
    compatible_brands: isomiso2avc1mp41
    encoder         : Lavf58.45.100
    Stream #0:0: Video: png, rgb24, 854x480, q=2-31, 200 kb/s, 24 fps, 24 tbn, 24 tbc (default)
    Metadata:
      encoder         : Lavc58.91.100 png
frame=    2 fps=0.0 q=-0.0 Lsize=N/A time=00:00:00.08 bitrate=N/A speed=0.505x    
video:513kB audio:0kB subtitle:0kB other streams:0kB global headers:0kB muxing overhead: unknown

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Rudresh Dixit -> [email protected]

Nitin Yadav -> [email protected]

Felix Toppo -> [email protected]

Project Link: https://github.com/shie-ld/fideo