Skip to main content

An utf-8/truecolor image and video viewer for the terminal

Project description

Terminal Media Viewer

View images and videos without leaving the console



Features

  • View images form any terminal
  • Watch videos from any terminal
  • Watch youtube videos from any terminal (-y, --youtube)
  • Play videos at any fps (-f, --fps, -F, --origfps)
  • Resize images / videos (-w, -h, --width, --height)
  • Easy to use

Examples

Viewing an image

Watching a video


Requirements

  • A terminal that supports truecolor (list) and utf-8 (most terminals should support utf-8).
  • ffmpeg (only for videos)
  • youtube-dl (only for youtube videos)

Usage

tmv [OPTIONS...] [INPUT FILE / URL]

  • INPUT
    File to display/play

  • OPTIONS...

    • -y. --youtube
      View youtube videos
    • -h, --height
      Set height (setting both width and height will ignore original aspect ratio)
    • -w, --width
      Set width (setting both width and height will ignore original aspect ratio)
    • -f, --fps
      Set fps (default 15 fps)
    • -F, --origfps
      Use original fps from video (default 15 fps)
    • -s, --no-sound
      Disable sound
    • -i, --no-info
      Disable progress bar for videos
    • -?, --help
      Display help
    • -V
      Display version

Installation

Linux

Instructions:

  1. Install dependencies.

    • libavcodec-dev
    • libavformat-dev
    • libavfilter-dev
    • libavdevice-dev

    In addition, to watch videos install:

    • ffmpeg
    • youtube-dl
  2. Clone the repository and run make.

    git clone https://github.com/kal39/TerminalMediaViewer.git
    cd TerminalMediaViewer
    make
    

    To install tmv to /usr/local/bin you can run make install (needs sudo privileges).
    To uninstall run make uninstall (needs sudo privileges).

MacOS

Requirements:

  • homebrew
  • iterm2

Instructions:

  1. Install dependencies
    brew install argp-standalone
    
    In addition, to watch videos:
    brew install ffmpeg
    brew install youtube-dl
    
  2. Clone the repository and run make.
    git clone https://github.com/kal39/TerminalMediaViewer.git
    cd TerminalMediaViewer
    make
    
    To install tmv to /usr/local/bin you can run make install (needs sudo privileges).
    To uninstall run make uninstall (needs sudo privileges).

Only works on iTerm2.

There are some performance issues. Depending on the video encoding, your mileage may vary.


Releases

  • v0.1.1 Youtube Support
    TerminalMediaViewer can now play videos directly from youtube.
    To play videos from youtube, use the -y option.

    • Improved memory usage
    • Cursor is now hidden during videos
    • Supports spaces in video filenames
    • Play videos directly from youtube
    • Check if ffmpeg and YouTube exist before playing videos
    • Better error and debug messages
  • v0.1 Initial release
    Initial release of tmv.
    It is in a very early state so bugs are expected.

    • View images
    • Watch videos (with sound)
    • Resize images / videos

Contributing

Any contributions are greatly appreciated.


kal39(https://github.com/kal39) - kal390983@gmail.com
Distributed under the MIT license. See LICENSE for more information.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ptmv-0.1.0.tar.gz (28.4 MB view details)

Uploaded Source

Built Distribution

ptmv-0.1.0-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file ptmv-0.1.0.tar.gz.

File metadata

  • Download URL: ptmv-0.1.0.tar.gz
  • Upload date:
  • Size: 28.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for ptmv-0.1.0.tar.gz
Algorithm Hash digest
SHA256 373ad6c07742d0bcaca11cc6e059971cbc5944bf5338877936115e6d80eef1aa
MD5 1ae02342d75a8ae7480be6042cb4c81f
BLAKE2b-256 b10dd5bde961f2ef6c1f61fed50d5db025443469b0bc0f3c42a01402e155e727

See more details on using hashes here.

File details

Details for the file ptmv-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: ptmv-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for ptmv-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5db68a10acf6c325115d8b5d5524a24603e84ffe0431f1eb3d313d0113b444d2
MD5 380dd72458e6f9bf42b92377631ae45f
BLAKE2b-256 d9a5fd381c192631c03f9dcdec95703e1ef0dbc570a2fb4fd798066a9998b104

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page