Skip to content

README.md

Latest commit

 

History

History
177 lines (117 loc) · 5.98 KB

README.md

File metadata and controls

177 lines (117 loc) · 5.98 KB

Contributors Forks Stargazers Issues MIT License


Logo

BrailleVideo

Represent videos with braille characters.
Report Bug · Request Feature

Table of Contents
  1. Getting Started
  2. Usage
  3. Roadmap
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Installation

  1. Clone the repo
git clone https://github.com/PyroCalzone/BrailleVideo.git
  1. Download the Prerequisites

(back to top)

Usage

  • convertVideo(file, compression=1) converts mp4 file to braille frames. Compression skips frames, save E.G. fps, frames = convertVideo(videoFile, compression=2)
  • playVideo(fps, frames, audioFile = None, save=False) plays braille video using pygame, more accurate than terminal. Save will save each frame to a folder called frames, this if for use with makeMP4() E.G. playVideo(fps, frames, audioFile=audioFile)
  • playVideoTerminal(fps, frames) plays braille video using terminal. E.G. playVideoTerminal(fps, frames)
  • audioFromVideo(file) converts video file into mp3 for use with playVideo(audioFile=). E.G. audioFile = audioFromFile('BadApple.mp4')
  • convertToBraille(code) converts braille code into braille characters. Left column top to bottom: 1, 2, 3, 7. Right column top to bottom: 4, 5, 6, 8. so code 123568 is ⢷
  • makeMP4(audioFile = None) takes saved frames from playVideo(fps, frames, save=True) and converts it to a mp4 video file called output.mp4.

(back to top)

Roadmap

  • Braille dictionary
  • Convert pixels to braille data
  • Terminal video player
  • Non-Terminal video player
  • Audio with video player
  • Output video converter!

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

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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

(back to top)

License

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

(back to top)

Contact

Pyro - Discord Server - pyrocalzoneemail@gmail.com

Project Link: https://github.com/PyroCalzone/BrailleVideo

(back to top)

Acknowledgments

(back to top)