256 -> 8bit, rework test, rework imgshow

Author: t-bltg

AsciiPixel/Project.toml

@@ -14,16 +14,12 @@ ImageCore = "0.9"
 julia = "1.6"
 
 [extras]
-CoordinateTransformations = "150eb455-5306-5404-9cee-2592286d6298"
 ImageIO = "82e4d734-157c-48bb-816b-45c225c6df19"
 ImageMagick = "6218d12a-5da1-5696-b52f-db25d2ecc6d1"
-ImageTransformations = "02fcd773-0e25-5acc-982a-7f6622650795"
 OffsetArrays = "6fe1bfb0-de20-5000-8ca7-80f57d26f881"
 ReferenceTests = "324d217c-45ce-50fc-942e-d289b448e8cf"
-Rotations = "6038ab10-8711-5258-84ad-4b1120ba62dc"
-SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 TestImages = "5e47fb64-e119-507b-a336-dd2b206d9990"
 
 [targets]
-test = ["CoordinateTransformations", "ImageIO", "ImageMagick", "ImageTransformations", "OffsetArrays", "Rotations", "ReferenceTests", "SparseArrays", "Test", "TestImages"]
+test = ["ImageIO", "ImageMagick", "OffsetArrays", "ReferenceTests", "Test", "TestImages"]

AsciiPixel/src/AsciiPixel.jl

@@ -9,23 +9,31 @@ export ascii_encode
 include("colorant2ansi.jl")
 include("ascii_encode.jl")
 
-const colormode = Ref{TermColorDepth}(TermColor256())
+const colormode = Ref{TermColorDepth}(TermColor8bit())
 
 """
-    use_256()
+    set_colordepth(bit::Int)
 
-Triggers `ascii_encode256` (256 colors, 8bit) automatically if an array of colorants is to
-be displayed in the julia REPL. (This is the default)
+Sets the terminal color depth to the given argument.
 """
-use_256() = (colormode[] = TermColor256())
-
-"""
-    use_24bit()
-
-Triggers `ascii_encode24bit` automatically if an array of colorants is to
-be displayed in the julia REPL.
-Call `AsciiPixel.use_256()` to restore default behaviour.
-"""
-use_24bit() = (colormode[] = TermColor24bit())
+function set_colordepth(bit::Int)
+    if bit == 8
+        colormode[] = TermColor8bit()
+    elseif bit == 24
+        colormode[] = TermColor24bit()
+    else
+        error("Setting color depth to $bit-bit is not supported, valid mode are:
+          - 8bit (256 colors)
+          - 24bit")
+    end
+    colormode[]
+end
+
+set_colordepth(bit::AbstractString) = set_colordepth(parse(Int, replace(bit, r"[^0-9]"=>"")))
+
+function __init__()
+    # use 24bit if the terminal supports it
+    lowercase(get(ENV, "COLORTERM", "")) in ("24bit", "truecolor") && set_colordepth(24)
+end
 
 end # module

AsciiPixel/src/ascii_encode.jl

@@ -18,7 +18,7 @@ ansi terminal colors.
 - The encoder `enc` specifies which kind of unicode represenation
   should be used.
 
-- The `colordepth` can either be `TermColor256()` or `TermColor24bit()`
+- The `colordepth` can either be `TermColor8bit()` or `TermColor24bit()`
   and specifies which terminal color codes should be used.
 
 - `maxheight` and `maxwidth` specify the maximum numbers of
@@ -152,8 +152,7 @@ end
 """
     ascii_encode([stream], img, [depth::TermColorDepth], [maxsize])
 
-Displays the given image `img` using unicode characters and
-terminal colors (defaults to 256 colors).
+Displays the given image `img` using unicode characters and terminal colors.
 `img` has to be an array of `Colorant`.
 
 If working in the REPL, the function tries to choose the encoding
@@ -193,55 +192,4 @@ function ascii_encode(
     end
 end
 
-"""
-    ascii_encode([stream], img, [depth::TermColorDepth], [maxsize])
-
-Displays the given image `img` using unicode characters and
-terminal colors (defaults to 256 colors).
-`img` has to be an array of `Colorant`.
-
-If working in the REPL, the function tries to choose the encoding
-based on the current display size. The image will also be
-downsampled to fit into the display (using `restrict`).
-"""
-function ascii_encode(
-        io::IO,
-        img::AbstractArray{<:Colorant},
-        colordepth::TermColorDepth,
-        maxsize::Tuple = displaysize(io))
-    # otherwise, use our own implementation
-    print_matrix(io, x) = ascii_encode(io, x, colordepth, maxsize)
-    Base.show_nd(io, img, print_matrix, true)
-end
-
-ascii_encode(io::IO, img, args...) = ascii_encode(io, img, colormode[], args...)
-ascii_encode(img, args...) = ascii_encode(stdout, img, colormode[], args...)
-ascii_encode(io::IO, img, colordepth::TermColorDepth, args...) = throw(ArgumentError("imshow only supports colorant arrays with 1 or 2 dimensions"))
-
-"""
-    ascii_encode256([stream], img, [maxsize])
-
-Displays the given image `img` using unicode characters and
-the widely supported 256 terminal colors.
-`img` has to be an array of `Colorant`.
-
-If working in the REPL, the function tries to choose the encoding
-based on the current display size. The image will also be
-downsampled to fit into the display (using `restrict`).
-"""
-ascii_encode256(io::IO, img, args...) = ascii_encode(io, img, TermColor256(), args...)
-ascii_encode256(img, args...) = ascii_encode256(stdout, img, args...)
-
-"""
-    ascii_encode24bit([stream], img, [maxsize])
-
-Displays the given image `img` using unicode characters and
-the 24 terminal colors that some modern terminals support.
-`img` has to be an array of `Colorant`.
-
-If working in the REPL, the function tries to choose the encoding
-based on the current display size. The image will also be
-downsampled to fit into the display (using `restrict`).
-"""
-ascii_encode24bit(io::IO, img, args...) = ascii_encode(io, img, TermColor24bit(), args...)
-ascii_encode24bit(img, args...) = ascii_encode24bit(stdout, img, args...)
+ascii_encode(io::IO, img::AbstractArray{<:Colorant}) = ascii_encode(io, img, colormode[])

AsciiPixel/src/colorant2ansi.jl

@@ -1,5 +1,5 @@
 abstract type TermColorDepth end
-struct TermColor256   <: TermColorDepth end
+struct TermColor8bit   <: TermColorDepth end
 struct TermColor24bit <: TermColorDepth end
 
 """
@@ -24,16 +24,16 @@ julia> colorant2ansi(Gray(.5))
 244
 ```
 """
-colorant2ansi(color) = _colorant2ansi(color, TermColor256())
+colorant2ansi(color) = _colorant2ansi(color, TermColor8bit())
 
 # Fallback for non-rgb and transparent colors (convert to rgb)
 _colorant2ansi(gr::Color, colordepth::TermColorDepth) =
     _colorant2ansi(convert(RGB, gr), colordepth)
 _colorant2ansi(gr::TransparentColor, colordepth::TermColorDepth) =
     _colorant2ansi(color(gr), colordepth)
 
-# 256 colors
-function _colorant2ansi(col::AbstractRGB, ::TermColor256)
+# 8bit (256) colors
+function _colorant2ansi(col::AbstractRGB, ::TermColor8bit)
     r, g, b = clamp01nan(red(col)), clamp01nan(green(col)), clamp01nan(blue(col))
     r24, g24, b24 = map(c->round(Int, 23c), (r, g, b))
     if r24 == g24 == b24
@@ -46,7 +46,7 @@ function _colorant2ansi(col::AbstractRGB, ::TermColor256)
     end
 end
 
-_colorant2ansi(gr::Color{<:Any,1}, ::TermColor256) = round(Int, 232 + 23clamp01nan(real(gr)))
+_colorant2ansi(gr::Color{<:Any,1}, ::TermColor8bit) = round(Int, 232 + 23clamp01nan(real(gr)))
 
 # 24 bit colors
 function _colorant2ansi(col::AbstractRGB, ::TermColor24bit)