Skip to content

Latest commit

 

History

History
74 lines (54 loc) · 3.5 KB

README.md

File metadata and controls

74 lines (54 loc) · 3.5 KB
Raw

Terminal Vidya Player

A terminal application to play videos with an ASCII output.

Coloured line printing sample

Coloured buffer printing sample

Requirements

  • FFmpeg-6
  • libao-1.2.2
  • opencv4 (Optional If MEDIA_HANDLER is set to opencv in CMakeLists.txt and __USE_OPENCV is defined in include/media.hpp, uses opencv instead of FFmpeg for video handling) Depending on the build for video processing, either opencv4 or FFmpeg 6 + libao 1.2.2 is required.

Can't test with older versions as MSYS2 doesn't allow them out of box, especially FFmpeg with its many deprecated functions.

Building The Project

From project root, run

cmake -S "." -B "./out/build";
cmake --build "./out/build" --config Debug;

and the executable should be in out/build or out/build/Debug/

or make your life easier with the pre-existing launch.json and VSCode!

Usage

term-video --file <filepath>

Argument Details
-f, --file Relative path of the file from your current working directory.
-fa, --force-aspect Flag whether to use the source video's aspect ratio in playback.
-s, --skip-frames Number of frames to skip for every 1 frame.
-sk, --seek-step Time in milliseconds for each seek step.
-b, --buffer Write directly to the console buffer instead of conventional printing.
-c, --color, --colour To use colour output in playback.
-ct, --color-threshold, --colour-threshold In ANSI RGB printing, the absolute difference in colour before using a new ANSI code. Refer to src/optimiser.cpp.
-na, --no-audio Disable audio playback.
-al, --audio-language Choose a preferred audio language, expects 3 letter ISO 639-2 codes.
-alumi, --avg-lumi Use average of RGB values instead of relative luminance for luminance. Refer to src/colour.cpp.

Use ctrl + <arrow left/right> for video seeking.

Optimisation Settings

For coloured line printing, ANSI colour codes are used to switch the foreground text colours which may cause long print times if many different colours are used in 1 frame which leads to slowdown. For optimisation, 2 arguments can be used:

  • -s | --skip-frames
  • -t | --threshold.

--skip-frames will skip the number of frames provided for every frame rendered. So if you pass --skip-frames 2, it will skip 2 frames for every frame drawn, cutting the framerate by 1/3.

--threshold will include a threshold on how different a colour must be with the previous colour used to use an ANSI code. If you pass --threshold 4, and the previous colour was RGB(120, 200, 255), the next pixel will only use an ANSI colour code if it's outside of RGB([116,124], [196,204], [251,255]).

Coloured Buffer Printing Limitation

With Coloured buffer printing in Windows, output will be limited to 16 colours as it uses CHAR_INFO.

To Dos

  • Read video and output frames as ASCII
  • Support colour
  • Force video aspect ratio
  • Write output to buffer
  • Audio playback
  • Handle resolution changes
  • Audio track selection
  • Subtitle display
  • Subtitle selection
  • Video seeking (Technically works but easily desynced)
  • Proper linux buffer output colours
  • More character support