cheap-impression-presenter 1.1.3 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 559b5a0157ab1677e1e1f57de21cb22327e6b779ef25da65124e5e02f115585f
-  data.tar.gz: 4e92ed0ae3c091965b6df6444200b56c240046194646ede5d1637faf165e4a95
+  metadata.gz: 4209c6083d151bd361c30b8f9023a0423129a9c574dbbbbf1a985604b92ce613
+  data.tar.gz: fdeae446fbbab6131e8c9057f8497742216e236e23c435fda32faebb3d13eb50
 SHA512:
-  metadata.gz: 43bdfcddc75072ec0d3767bbb58802c55af33973ceeed469ee3eb9a3ddbfa49cc947b56b629f97184562295a25a98cc5d5b9b3720dfe1fff2088f8491e54c8f1
-  data.tar.gz: af3794816e59ea883cfd2149c43350cd22298013a79d9d854db5fba7e0250aff35835952eb0e1fd1c4c75049bf685315dd16f3ef0ab72adc6aba04807f553237
+  metadata.gz: 9871191241cc17fff202da966deafa55bc51f05300d02d19608e165d1cb52f902ec8a859787f08091ba2f49d086a399769d770eccec0c68e87ad39e1b25eb29b
+  data.tar.gz: ed9f7d89cd31fc5f9f97257795d2116b38aac833b475e8ca37076932aa55b3e4d9356d8803368cdde545d09060aa5dc43650d7b13b4600a78e932af859870c51

data/INSTALL.md

@@ -6,11 +6,17 @@ It wont work in a windows terminal for now.
 
 You can utilize 'figlet' (chimp has a plugin).
 
-You can utilize 'img2sixel' if you want to display graphics on your terminal
-(chimp has a sixel plugin).
+You can utilize 'img2sixel' if you want to display graphics on a terminal with
+sixel support (chimp has a sixel plugin).
 
-You can utilize 'inkscape' if you want to display svgs as sixel graphics on
-your terminal, or include them in the PDF output (chimp has a sixel plugin).
+You can utilize 'magick' (ImageMagick 7) if you want to display graphics on a
+terminal with kitty graphics support, e.g. kitty, Ghostty, WezTerm (chimp has a
+kitty plugin).
+
+The pic plugin uses whichever of the two your terminal supports.
+
+You can utilize 'inkscape' if you want to display svgs as graphics on your
+terminal, or include them in the PDF output.
 
 The PDF output (chimp -o pdf) uses the DejaVu Sans Mono font if it is
 installed. Otherwise Courier is used, which lacks some characters (e.g. box

data/README.md

@@ -17,11 +17,17 @@ features need external programs, which have to be installed separately (all are
 available in the usual linux distributions and homebrew):
 
 * ``figlet``: for the figlet plugin.
-* ``img2sixel`` (from libsixel): for the sixel plugin, i.e. pictures in the terminal.
-  Your terminal also needs sixel support. On linux a VTE based terminal with
-  sixel enabled works well, e.g. Black Box
-  (https://flathub.org/apps/com.raggesilver.BlackBox), where sixel has to be
-  switched on in the preferences.
+* Pictures in the terminal need a terminal that supports either sixel or the
+  kitty graphics protocol. The pic plugin finds out which one your terminal
+  has and uses it, so you only need the program for that one:
+  * ``img2sixel`` (from libsixel): for sixel (the sixel plugin). On linux a
+    VTE based terminal with sixel enabled works well, e.g. Black Box
+    (https://flathub.org/apps/com.raggesilver.BlackBox), where sixel has to be
+    switched on in the preferences.
+  * ``magick`` (ImageMagick 7): for the kitty graphics protocol (the kitty
+    plugin), e.g. in kitty (https://sw.kovidgoyal.net/kitty/), Ghostty
+    (https://ghostty.org) or WezTerm (https://wezterm.org). Pictures are sent
+    through the terminal, so this also works via ssh.
 * ``inkscape``: for svg pictures, in the terminal as well as in the PDF output.
 * DejaVu Sans Mono font: for the PDF output. If it is not installed, Courier is
   used, which lacks some characters (e.g. box drawing).
@@ -51,6 +57,11 @@ their own center parameter.
 
 Everything else is in plugins. The following plugins are existing for now:
 
+* Pic: display graphics in the terminal, with whatever the terminal supports
+  (kitty graphics protocol or sixel, kitty if both, nothing if neither):
+  `` ```pic,20 name.png``. This is the one to use, it takes the same
+  parameters as Sixel (see below). If the detection is wrong, set
+  ``CHIMP_PIC`` to ``kitty``, ``sixel`` or ``none``.
 * Sixel: display graphics in the terminal: `` ```sixel,20 name.png``.
   * The parameter 20 denotes the size in characters.
   * You can add right or center as an additional parameter to align the
@@ -62,6 +73,8 @@ Everything else is in plugins. The following plugins are existing for now:
     picture instead of beneath. Combined with +++ the next picture replaces the
     current one, which allows for simple animations (see
     examples/sixel_svg.2.txt).
+* Kitty: the same as Sixel, but with the kitty graphics protocol:
+  `` ```kitty,20 name.png``. All parameters of the Sixel plugin work.
 * Figlet: display fancy ascii text: `` ```figlet FANCY_TEXT``.
   * You can add right or center as a parameter to align the fancy text.
   * If the fancy text is right aligned, normal text is added on the left of the

data/chimp.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name             = "cheap-impression-presenter"
-  s.version          = "1.1.3"
+  s.version          = "1.2.1"
   s.platform         = Gem::Platform::RUBY
   s.license          = "GPL-3.0-or-later"
   s.summary          = "CHIMP - Make a cheap impression. Present via terminal."

data/lib/output/screen.rb

@@ -4,7 +4,18 @@ require 'io/console'
 
 module Window #{{{
   class WinchError < Exception; end
+
+  def self::sync_begin()
+    $stdout << "\e[?2026h"
+    $stdout.flush
+  end
+  def self::sync_end()
+    $stdout << "\e[?2026l"
+    $stdout.flush
+  end
+
   def self::init()
+    self::sync_begin
     self::clear
     $stdout << "\e[?25l"
     $stdout.flush
@@ -17,10 +28,11 @@ module Window #{{{
     self::clear
     self::set_pos 0, 0
     $stdout << "\e[?25h"
-    $stdout.flush
+    self::sync_end
     nil
   end
   def self::getch()
+    self::sync_end
     number = nil
     loop do
       ch = $stdin.getch
@@ -49,6 +61,8 @@ module Window #{{{
           end
       end
     end
+  ensure
+    self::sync_begin
   end
   def self::lines()
     TTY::Screen.lines
@@ -56,7 +70,13 @@ module Window #{{{
   def self::columns()
     TTY::Screen.columns
   end
+  #### how often the screen was cleared; plugins check if what they
+  #### drew is still there
+  def self::cleared()
+    @cleared || 0
+  end
   def self::clear()
+    @cleared = cleared + 1
     $stdout << "\e[2J"
     $stdout.flush
     self
@@ -216,11 +236,12 @@ module Chimp
             if tag.ttype == "P_INCREMENTAL"
               ### erase only what this step has drawn (pictures next to it stay), then wait at the end of the previous step again
               step = tree[c.open].userdata
-              step[:drawn].each do |x1,y1,x2,y2|
+              step[:drawn].each do |x1,y1,x2,y2,erase|
                 y1.upto(y2) do |y|
                   @screen.set_pos x1, y
                   @screen.print ' ' * (x2-x1+1)
                 end
+                erase.call if erase
               end
               @screen.set_pos step[:x], step[:y]
               raise TagMoveEvent, pos
@@ -246,13 +267,15 @@ module Chimp
         eval('Chimp::Plugin::' + data[:name].upcase).new.prepare(data[:what],data[:parameters],data[:additional])
       end
 
-      #### plugins may return the area they drew as [x1,y1,x2,y2], otherwise the whole lines they printed on count
+      #### plugins may return the area they drew as [x1,y1,x2,y2],
+      #### otherwise the whole lines they printed on count an
+      #### optional fifth element is called to erase, e.g., kitty pics
       def process(data)
         require File::dirname(__FILE__) + "/../plugins/#{data[:name]}.rb"
         area = eval('Chimp::Plugin::' + data[:name].upcase).new.process(data[:what],data[:parameters],@screen,data[:additional])
         return unless @drawn
         x, y = @screen.get_pos
-        @drawn << (area.is_a?(Array) && area.length == 4 ? area : [1, @y, @screen.columns, y])
+        @drawn << (area.is_a?(Array) && [4, 5].include?(area.length) ? area : [1, @y, @screen.columns, y])
         @x, @y = x, y
       end
       private :process

data/lib/plugins/kitty.rb

@@ -0,0 +1,117 @@
+require 'fileutils'
+require 'base64'
+require 'io/console'
+
+module Chimp
+  module Plugin
+    class KITTY < Base
+      @@placed = {} # [x,y] => [id, width, screen clears so far, what it replaced], the pictures on the screen
+      #### pixel size of a character cell: from the terminal if it knows, else 10x21 as for sixel and the pdf
+      def cell_size
+        rows, cols, xpix, ypix = [0, 0, 0, 0].pack('S4').then { |buf| $stdout.ioctl(0x5413, buf); buf.unpack('S4') } # TIOCGWINSZ
+        return [xpix / cols, ypix / rows] if xpix > 0 && ypix > 0
+        [10, 21]
+      rescue StandardError
+        [10, 21]
+      end
+
+      # converted images are cached in .PRESENTATIONNAME/ next to the presentation
+      def cache_file(what,width,fname)
+        dir = File.join(File.dirname(fname),'.' + File.basename(fname,'.*'))
+        File.join(dir,"#{what.gsub('/','_')}.#{width}.kitty.png")
+      end
+
+      #### kitty only takes png. the terminal scales it to the width, so it does not depend on the zoom
+      #### (which would convert everything again for each zoom). as for sixel 10 pixels per character,
+      #### and 5 bits per color, which keeps it small (it goes through the terminal, maybe via ssh)
+      def png(what,width,fname)
+        src = File.join(File.dirname(fname),what)
+        pixels = width * 10
+        cache = cache_file(what,width,fname)
+        if File.exist?(cache) && File.exist?(src) && File.mtime(cache) >= File.mtime(src)
+          return File.binread(cache)
+        end
+        convert = if what =~ /\.svg$/
+          "inkscape -D -d 300 --export-type=png #{src} -o - | magick - -resize #{pixels}x -depth 5 png:-"
+        else
+          "magick #{src} -resize #{pixels}x -depth 5 png:-"
+        end
+        result = `#{convert}`
+        if $?.success? && !result.empty?
+          FileUtils.mkdir_p(File.dirname(cache))
+          File.binwrite(cache,result)
+        end
+        result
+      end
+
+      def prepare(what,parameters,additional)
+        return if parameters[0] !~ /\d/
+        png(what,parameters[0].to_i,additional[:fname])
+      end
+
+      def process(what,parameters,screen,additional)
+        if parameters[0] !~ /\d/
+          screen.print 'Use ```kitty,NUM with NUM beeing the width if the picture in characters.'
+          return
+        end
+
+        restore = parameters.include?('animate') || parameters.include?('float')
+        width = parameters[0].to_i
+        len = screen.columns
+        pos = screen.get_pos
+        x, y = pos
+        ### move instead of printing spaces, spaces would erase a picture already on this line
+        if parameters.include? 'right'
+          x += len-width
+        elsif parameters.include? 'center'
+          x += (len-width)/2
+        end
+        screen.set_pos x, y
+        if screen.respond_to?(:image) # pdf output
+          screen.image what, width, additional[:fname]
+          _, bottom = screen.get_pos
+          last = bottom
+          erase = nil
+        else
+          data = png(what,width,additional[:fname])
+          return if data.empty?
+          ### the terminal scales the png to the width, which says how many lines it covers
+          w, h = data[16,8].unpack('NN')
+          cw, ch = cell_size
+          bottom = y + (width * cw * h / (w * ch).to_f).ceil
+          ### bottom is the line after the picture, erasing it would erase what is there (e.g. the footer)
+          last = bottom - 1
+          id = rand(1...2**31)
+          ### a picture drawn at the same place as another one replaces it (e.g. for animations). only its placement
+          ### goes, the terminal keeps the data so going back can show it again. clearing the screen (next slide)
+          ### removes all pictures, so whatever was placed before that is not there to replace.
+          covered = @@placed[[x, y]]
+          covered = nil unless covered && covered[2] == screen.cleared
+          ### all chunks in one write, a flush per chunk stutters, q=2 keeps the terminal from answering
+          chunks = Base64.strict_encode64(data).scan(/.{1,4096}/)
+          screen.print (covered ? "\e_Ga=d,d=i,i=#{covered[0]},q=2\e\\" : '') + chunks.each_with_index.map { |chunk,i|
+            keys = i == 0 ? "a=T,f=100,i=#{id},c=#{width},C=1,q=2," : ''
+            "\e_G#{keys}m=#{i < chunks.length-1 ? 1 : 0};#{chunk}\e\\"
+          }.join
+          @@placed[[x, y]] = [id, width, screen.cleared, covered]
+          ### pictures are not part of the text, printing spaces does not erase them. bring back what it replaced.
+          erase = lambda do
+            screen.print "\e_Ga=d,d=I,i=#{id},q=2\e\\"
+            if covered
+              screen.set_pos x, y
+              screen.print "\e_Ga=p,i=#{covered[0]},c=#{covered[1]},C=1,q=2\e\\"
+            end
+            @@placed[[x, y]] = covered
+          end
+        end
+        if restore
+          screen.set_pos *pos
+        else
+          screen.set_pos 0, bottom
+        end
+        ### the area the picture covers, so going back can erase exactly that
+        [x, y, x+width-1, last, erase].compact
+      end
+    end
+  end
+end

data/lib/plugins/pic.rb

@@ -0,0 +1,59 @@
+require 'io/console'
+require_relative 'sixel'
+require_relative 'kitty'
+
+module Chimp
+  module Plugin
+    class PIC < Base
+      #### ask the terminal once: a kitty graphics query, then a device attributes query (4 means sixel),
+      #### which every terminal answers, so we know when to stop waiting for the kitty answer
+      def detect
+        return ENV['CHIMP_PIC'].to_sym if %w{kitty sixel none}.include?(ENV['CHIMP_PIC'])
+        return :none unless $stdin.tty? && $stdout.tty?
+        res = ''
+        $stdin.raw do
+          $stdout << "\e_Gi=31,s=1,v=1,a=q,t=d,f=24;AAAA\e\\\e[c"
+          $stdout.flush
+          while IO.select([$stdin], nil, nil, 1) && (c = $stdin.getc)
+            res << c
+            break if res =~ /\e\[\?[\d;]*c/
+          end
+        end
+        if res.include?("\e_Gi=31;OK")
+          :kitty
+        elsif res =~ /\e\[\?([\d;]*)c/ && $1.split(';').include?('4')
+          :sixel
+        else
+          :none
+        end
+      rescue StandardError
+        :none
+      end
+
+      def graphics
+        @@graphics ||= detect
+      end
+
+      def delegate(screen=nil)
+        ### the pdf does not care, both plugins hand the picture to it
+        return SIXEL.new if screen.respond_to?(:image)
+        case graphics
+          when :kitty then KITTY.new
+          when :sixel then SIXEL.new
+        end
+      end
+
+      def prepare(what,parameters,additional)
+        delegate&.prepare(what,parameters,additional)
+      end
+
+      def process(what,parameters,screen,additional)
+        if parameters[0] !~ /\d/
+          screen.print 'Use ```pic,NUM with NUM beeing the width if the picture in characters.'
+          return
+        end
+        delegate(screen)&.process(what,parameters,screen,additional)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cheap-impression-presenter
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.1
 platform: ruby
 authors:
 - Juergen eTM Mangler
@@ -72,7 +72,9 @@ files:
 - lib/output/pdf.rb
 - lib/output/screen.rb
 - lib/plugins/figlet.rb
+- lib/plugins/kitty.rb
 - lib/plugins/lnums.rb
+- lib/plugins/pic.rb
 - lib/plugins/sixel.rb
 - tools/chimp
 homepage: https://github.com/etm/chimp