video-stream-ascii

v1.6.2

Published

a year ago

Convert video stream to ascii art

Downloads

0High
0Medium
0Low

im-rises

video ascii art stream video-stream video-ascii video-stream-ascii video-ascii-art video-stream-ascii-art

video-stream-ascii

Description

This is a simple web package that converts a video stream into ASCII art for React.

🚀🚀🚀 The package is published on npm 🚀🚀

It works on desktop and mobile as well, there is two demos, one for the camera and one for video files input. You can check them at those links:

🚀🚀 Video Ascii Webcam 🚀🚀

🚀🚀 Video Ascii Player 🚀🚀

The source code of the examples is available on GitHub:

Image to ASCII art version

I also made a version for images, you can check it at this link:
https://github.com/Im-Rises/image-ascii-art

You can check the demo at this link:
https://im-rises.github.io/image-ascii-art-website

Screenshots

Install packages

You can install it by typing the following command in your terminal:

npm install video-stream-ascii

yarn add video-stream-ascii

Usage

To use the package, you need to import it into your project:

import {VideoStreamAscii} from "video-stream-ascii";

Then you can create use the Component like this in Typescript/JavaScript:

<VideoAscii
    videoStreaming={videoRef.current!.video!}
    parentRef={parentRef}
    artType={ArtTypeEnum.ASCII_COLOR_BG_IMAGE}
    charsPerLine={charsPerLine}
    charsPerColumn={charsPerColumn}
    fontColor={'white'}
    backgroundColor={'black'}
/>

You can also pass a pre tag reference to the component, so it can be used to get the ASCII text:

<VideoAscii
    videoStreaming={videoRef.current!.video!}
    parentRef={parentRef}
    artType={ArtTypeEnum.ASCII_COLOR_BG_IMAGE}
    charsPerLine={charsPerLine}
    charsPerColumn={charsPerColumn}
    fontColor={'white'}
    backgroundColor={'black'}
    flipY={true}
    preTagRef={preTagRef}
/>

To use the component, you need to pass the following props:

videoStreaming - The video stream from the camera.
parentRef - The reference of the parent element, to fit the ascii art in it.
artType - The type of the ascii art, you can choose between ASCII, ASCII_COLOR and ASCII_COLOR_BG_IMAGE.
charsPerLine - The number of characters per line.
charsPerColumn - The number of characters per column.
fontColor - The color of the font.
backgroundColor - The color of the background.
flipY - Flip the ascii art vertically.
preTagRef - The reference of the pre tag, to get the ascii art text.

The parentRef is used to fit the ascii art in the parent element, so you need to pass the reference of the parent element like a div, you can check the example to see how to use it.

Warning
Be careful when using this package, the camera must be working before enabling the video stream. If you want to set the ascii art with a correct aspect ratio, follow the examples (webcam or video player).

The artType is used to choose the type of the ascii art, you can choose between ASCII, ASCII_COLOR and ASCII_COLOR_BG_IMAGE.

ASCII - The ascii art will be defined only by two colors the font color and the background color. (which you can set with the props fontColor and backgroundColor).
ASCII_COLOR - The ascii art will be printed with each character having the color of the pixel it represents (it is an extensive mode, you should use the ASCII_COLOR_BG_IMAGE mode instead).
ASCII_COLOR_BG_IMAGE - The ascii art will be printed with color using the original image as background for the color of the characters, you should use this mode if you want good performance instead of the ASCII_COLOR mode.