# aatv

Transforms video into ascii art.

Example launch line |[ gst-launch-1.0 videotestsrc ! aatv ! videoconvert ! autovideosink ]| This pipeline shows the effect of aatv on a test stream.

## Hierarchy

    GObject
        ╰──GInitiallyUnowned
            ╰──GstObject
                ╰──GstElement
                    ╰──GstBaseTransform
                        ╰──GstVideoFilter
                            ╰──aatv

## Factory details

Authors: – Eric Marks

Classification: – `Filter/Effect/Video`

Rank – none

Plugin – gstaasink

Package – GStreamer Good Plug-ins

## Pad Templates

### `sink`

    video/x-raw:
             format: { I420 }
              width: [ 1, 2147483647 ]
             height: [ 1, 2147483647 ]
          framerate: [ 0/1, 2147483647/1 ]

Presence – always

Direction – sink

Object type – GstPad

### `src`

    video/x-raw:
             format: { RGBA }
              width: [ 1, 2147483647 ]
             height: [ 1, 2147483647 ]
          framerate: [ 0/1, 2147483647/1 ]

Presence – always

Direction – src

Object type – GstPad

## Properties

### brightness

    “brightness” gint

Brightness

Flags : Read / Write

Default value : 0

### brightness-actual

    “brightness-actual” gfloat

Actual calculated foreground pixel fill percentage

Flags : Read

Default value : 0.35

### brightness-auto

    “brightness-auto” gboolean

Automatically adjust brightness based on the previous frame's foreground pixel fill percentage

Flags : Read / Write

Default value : true

### brightness-max

    “brightness-max” gfloat

Maximum target foreground pixel fill percentage for automatic brightness control

Flags : Read / Write

Default value : 0.4

### brightness-min

    “brightness-min” gfloat

Minimum target foreground pixel fill percentage for automatic brightness control

Flags : Read / Write

Default value : 0.3

### color-background

    “color-background” guint

Color to use as the background for the ASCII text (big-endian ARGB).

Flags : Read / Write

Default value : -16777216

### color-rain

    “color-rain” guint

Automatically sets color-rain-bold, color-rain-normal, and color-rain-dim with progressively dimmer values (big-endian ARGB).

Flags : Read / Write

Default value : -16711936

### color-rain-bold

    “color-rain-bold” guint

Sets the brightest color to use for foreground ASCII text rain overlays (big-endian ARGB).

Flags : Read / Write

Default value : -16711936

### color-rain-dim

    “color-rain-dim” guint

Sets the dimmest brightness color to use for foreground ASCII text rain overlays (big-endian ARGB).

Flags : Read / Write

Default value : -16761088

### color-rain-normal

    “color-rain-normal” guint

Sets the normal brightness color to use for foreground ASCII text rain overlays (big-endian ARGB).

Flags : Read / Write

Default value : -16744704

### color-text

    “color-text” guint

Automatically sets color-test-bold, color-text-normal, and color-text-dim with progressively dimmer values (big-endian ARGB).

Flags : Read / Write

Default value : -1

### color-text-bold

    “color-text-bold” guint

Sets the brightest color to use for foreground ASCII text (big-endian ARGB).

Flags : Read / Write

Default value : -1

### color-text-dim

    “color-text-dim” guint

Sets the dimmest brightness color to use for foreground ASCII text (big-endian ARGB).

Flags : Read / Write

Default value : -12632257

### color-text-normal

    “color-text-normal” guint

Sets the normal brightness color to use for foreground ASCII text (big-endian ARGB).

Flags : Read / Write

Default value : -8421505

### contrast

    “contrast” gint

Contrast

Flags : Read / Write

Default value : 0

### dither

    “dither” GstAATvDitherers *

Add noise to more closely approximate gray levels.

Flags : Read / Write

Default value : no-dithering (0)

### font

    “font” GstAATvFonts *

AAlib Font

Flags : Read / Write

Default value : Standard-vga-8x8-font (0)

### gamma

    “gamma” gfloat

Gamma correction

Flags : Read / Write

Default value : 1

### height

    “height” gint

Height of the ASCII canvas

Flags : Read / Write

Default value : 24

### qos

    “qos” gboolean

Handle Quality-of-Service events

Flags : Read / Write

Default value : true

### rain-delay-max

    “rain-delay-max” gint

Maximum frame delay between rain motion

Flags : Read / Write

Default value : 3

### rain-delay-min

    “rain-delay-min” gint

Minimum frame delay between rain motion

Flags : Read / Write

Default value : 0

### rain-length-max

    “rain-length-max” gint

Maximum length of a rain

Flags : Read / Write

Default value : 30

### rain-length-min

    “rain-length-min” gint

Minimum length of a rain

Flags : Read / Write

Default value : 4

### rain-mode

    “rain-mode” GstAATvRainModes *

Set the direction of raindrops

Flags : Read / Write

Default value : none (0)

### rain-spawn-rate

    “rain-spawn-rate” gfloat

Percentage chance for a raindrop to spawn

Flags : Read / Write

Default value : 0.2

### randomval

    “randomval” gint

Adds a random value in the range (-randomval/2,ranomval/2) to each pixel during rendering

Flags : Read / Write

Default value : 0

### width

    “width” gint

Width of the ASCII canvas

Flags : Read / Write

Default value : 80

## Named constants

### GstAATvDitherers

#### Members

`no-dithering` (0) – no dithering
`error-distribution` (1) – error-distribution
`floyd-steelberg-dithering` (2) – floyd-steelberg dithering

### GstAATvFonts

#### Members

`Standard-vga-8x8-font` (0) – vga8
`Standard-vga-8x9-font` (1) – vga9
`Standard-mda/vga-8x14-font` (2) – mda14
`Standard-vga-8x16-font` (3) – vga16
`X-8x13-font` (4) – X8x13
`X-8x13bold-font` (5) – X8x13bold
`Standard-X-8x16-font` (6) – X8x16
`line-Font-8x8` (7) – line
`Font-8x8-from-vgagl` (8) – vgagl8
`Adobe-courier` (9) – courier

### GstAATvRainModes

#### Members

`none` (0) – No Rain
`down` (1) – Rain Down
`up` (2) – Rain Up
`left` (3) – Rain Left
`right` (4) – Rain Right

The results of the search are