convert2ascii 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37a56a08059d638a7c1e406248484e8fb3ca0fd1d494c8676ac5cc1119e15eeb
-  data.tar.gz: 3cbf2abb2d13a8a1d1091128852584d35d073ac8b1d7a056dc856916d913582d
+  metadata.gz: aa45c05c40f8dbd46f9bae8e89b7e83123f38ac7ae413051db32e5a0e8562d08
+  data.tar.gz: f0c0fca60c7dd724b66e226975784fe0d834683533ad734dc349ab4d8b288925
 SHA512:
-  metadata.gz: e1dcecc188abc4c1a5916199f91fba45fa1ee70d6fe25427a27b502e5c41fa57fe3c3dedf4cd0a7f3402ac36f132e44f87874ada185d0dc374d78eb29fd9e389
-  data.tar.gz: aedcc98597e9ef05af5c26435384cb72741b2e97cca92df0e1e2b44e9314f0f2a465f5a070503db29a5bc16bb0cc97933ab4ab7a9b9d21f44179f9df923bc6f9
+  metadata.gz: 906c707016273c0988157544eddef58f562fe02b767a626a4124f3dd0e389b91521bfc2685c426cdac716f1a581c8990da0d11e502c73b7595a19c9aefa12074
+  data.tar.gz: 3ef8a737f983d57966516fb980836f6e4da64dd45c6dc0dafa15ad05951e36d89d8cdd83b7cf49a4a2c8507270e53500091dd0a304af3742625985a3f3f8b6b6

data/README.md

@@ -1,63 +1,101 @@
-# Convert2ASCII
+# Convert2Ascii
 
 Convert Image/Video to ASCII art.
 
 
+## Intro
+
+convert2ascii provides two executable commands：
+
+* image2ascii: transform picture to ascii art and display in terminal.
+* video2ascii: transform video to ascii art, you can save or play it in terminal.
+
+It also provides classes as a gem:
+
+* Convert2Ascii::Image2Ascii
+* Convert2Ascii::Video2Ascii
+
+you can use it in your code and make your own ascii art !
+
+
 ## Test pass
 
 * MacOS 15.2 ✅
 * Ubuntu 24.04 ✅
 * Windows 11  ❌
-
+* Docker ✅
 
 ## Example
 
+* Black Myth: Wukong
+
 ![example](./example/wukong.jpg)
 
-![neo](./example/neo.gif)
+* The Matrix: Neo
 
-![example2](./example/doulai.jpg)
+![neo](./example/neo.gif)
 
 ## Prerequisites
 
-* Ruby3+
+* Ruby 3+
 * ImageMagick ([Download here](https://imagemagick.org/script/download.php))
 * ffmpeg ([Download here](https://www.ffmpeg.org/))
 
+# How to use
+
+## Try in Docker
+
+`$ docker run -it -v $(pwd):/app  mark24code/convert2ascii bash -c "cd /app && exec bash"`
 
-## Executable command
+>  `$(pwd)` can be changed to your local path. Here, use your working path.
+
+```bash
+# image
+image2ascii -i </path/to/image>
+
+# video 
+video2ascii -i </path/to/video.mp4>
+```
+
+
+## Install
+
+`$ gem install convert2ascii`
+
+
+## Executable commands
 
 ### image2ascii
 
-Make image to ascii art in your terminal.
+Convert an image to ascii art.
 
 ```bash
 image2ascii -h
 Usage: image2ascii [options]
-        --version                    verison
+        --version                    version
     -i, --image=URI                  image uri (required)
     -w, --width=WIDTH                image width (integer)
-    -s, --style=STYLE                ascii style: ['color'| 'text']
-    -b, --block                      ascii color style use BLOCK or not [ true | false ]
+    -s, --style=STYLE                ascii style: 'color'/'text'
+    -b, --block                      ascii color style use BLOCK or not true/false
 ```
 
 ### video2ascii
 
-Make image to ascii art in your terminal.
+Convert a video to ascii art.
 
 ```bash
 Usage: video2ascii [options]
 
-* default will generate and play without save.
-* -p will just play ascii frames dir, and ignore -i, -o others options. --loop will play loop
+* By default, it will generate and play without saving.
+* The -p option will just play the ascii frames within the directory, and ignore -i, -o other options. --loop will play loop
 * -i,-o will just generate and output frames and ignore others options
-        --version                    verison
+        --version                    version
     -i, --input=URI                  video uri (required)
     -w, --width=WIDTH                video width (integer)
     -s, --style=STYLE                ascii style: ['color'| 'text']
     -b, --block                      ascii color style use BLOCK or not [ true | false ]
-    -o, --ouput=OUTPUT               save ascii frame to output dirname
-    -p, --play_dir=PLAY_DIRNAME      input ascii frames dirname to play
+    -o, --ouput=OUTPUT               save ascii frames to the output directory
+    -p, --play_dir=PLAY_DIRNAME      input the ascii frames directory to play
         --loop
 ```
 
@@ -108,6 +146,7 @@ ascii.generate.play
 
 ```
 
+
 ## Inspired by
 
 * [michaelkofron/image2ascii](https://github.com/michaelkofron/image2ascii)

data/Rakefile

@@ -14,6 +14,19 @@ task :build_rdoc do
   system("rdoc build")
 end
 
+desc "Build Docker image"
+task :build_docker do
+  system("docker build . -t mark24code/convert2ascii:latest")
+end
+
+desc "Push Docker image"
+task :push_docker do
+  system("docker push mark24code/convert2ascii:latest")
+end
 
+desc "Run in docker"
+task :run_in_docker do
+  system("docker run -it -v $(pwd):/app  mark24code/convert2ascii bash -c \"cd /app && exec bash\"")
+end
 
 task default: %i[]

data/exe/image2ascii

@@ -7,7 +7,7 @@ options = {}
 OptionParser.new do |parser|
   parser.banner = "Usage: image2ascii [options]"
 
-  parser.on("--version", "verison") do |v|
+  parser.on("--version", "version") do |v|
     puts "convert2ascii/image2ascii: v#{::Convert2Ascii::VERSION}"
     puts "author: Mark24"
     puts "mail: mark.zhangyoung@gmail.com"

data/exe/video2ascii

@@ -45,7 +45,7 @@ Usage: video2ascii [options]
 * -p will just play ascii frames dir, and ignore -i, -o others options. --loop will play loop
 * -i,-o will just generate and output frames and ignore others options
 DOC
-  parser.on("--version", "verison") do |v|
+  parser.on("--version", "version") do |v|
     puts "convert2ascii/video2ascii: v#{::Convert2Ascii::VERSION}"
     puts "author: Mark24"
     puts "mail: mark.zhangyoung@gmail.com"
@@ -82,11 +82,11 @@ DOC
     options[:color_block] = color_block || false
   end
 
-  parser.on("-o", "--ouput=OUTPUT", "save ascii frame to output dirname") do |output|
+  parser.on("-o", "--ouput=OUTPUT", "save ascii frames to the output directory") do |output|
     options[:output] = output
   end
 
-  parser.on("-p", "--play_dir=PLAY_DIRNAME", "input ascii frames dirname to play") do |play_dir|
+  parser.on("-p", "--play_dir=PLAY_DIRNAME", "input the ascii frames directory to play") do |play_dir|
     options[:play_dir] = play_dir
   end
 

data/lib/convert2ascii/multi-tasker.rb

@@ -1,36 +1,34 @@
-require "async"
-require "async/barrier"
-require "async/semaphore"
+require "parallel"
 require "etc"
+require "rainbow"
 
 module Convert2Ascii
   class MultiTasker
     def initialize(proc_tasks)
       @proc_tasks = proc_tasks
       @count = set_threads_count
+      @finished = []
+      @time_start = nil
     end
 
     def set_threads_count
       cpu_threads = (Etc.nprocessors || 1)
-      cpu_threads = cpu_threads > 4 ? cpu_threads - 1 : cpu_threads
+      cpu_threads = cpu_threads > 4 ? cpu_threads - 2 : 1
       cpu_threads
     end
 
-    def run
-      barrier = Async::Barrier.new
-
-      Sync do
-        # Only 10 tasks are created at a time:
-        semaphore = Async::Semaphore.new(@count, parent: barrier)
+    def progress(index)
+      @finished << index
+      print(Rainbow("\rprocessing...  #{sprintf("%.2f", (1.0 * @finished.length / @proc_tasks.length) * 100)} % (time: #{sprintf("%.2f", Time.now - @time_start)} s)").green)
+    end
 
-        @proc_tasks.map do |proc_task|
-          semaphore.async do
-            proc_task.call
-          end
-        end.map(&:wait)
-      ensure
-        barrier.stop
+    def run
+      @time_start = Time.now
+      results = Parallel.map(@proc_tasks, in_processes: @count, finish: ->(item, index, result) { progress(index) }, finish_in_order: true) do |task|
+        task && task.call
       end
+
+      results
     end
   end
 end

data/lib/convert2ascii/terminal-player.rb

@@ -2,12 +2,15 @@ require "rainbow"
 require_relative "./terminal"
 
 module Convert2Ascii
-  class TerminalPlayer
+  class TerminalPlayerError < StandardError
+  end
 
+  class TerminalPlayer
     SAFE_SLOW_DELTA = 0.9 # seconds
     SAFE_FAST_DELTA = 0.2 # seconds
 
     attr_accessor :play_loop, :step_duration, :debug
+
     def initialize(**args)
       @debug = false
       @audio = args[:audio]
@@ -20,6 +23,13 @@ module Convert2Ascii
       @backspace_adjust = "\033[A" * (@frames.length + 1)
 
       regist_hook
+      check_params
+    end
+
+    def check_params
+      if @frames.length <= 0
+        raise TerminalPlayerError, "\n[Error] frame's length must be >= 0 "
+      end
     end
 
     def play
@@ -76,7 +86,7 @@ module Convert2Ascii
     end
 
     def debug_log(var_name)
-      puts Rainbow('-- debug ----').yellow
+      puts Rainbow("-- debug ----").yellow
       puts "class:"
       p var_name.class
       puts "value:"
@@ -84,7 +94,6 @@ module Convert2Ascii
     end
 
     def full_screen(content)
-
       if !content
         return content
       end

data/lib/convert2ascii/version.rb

@@ -1,3 +1,3 @@
 module Convert2Ascii
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/lib/convert2ascii/video2ascii.rb

@@ -8,7 +8,7 @@ require_relative "./image2ascii"
 require_relative "./terminal-player"
 require_relative "./multi-tasker"
 require_relative "./check_package"
-require_relative './version'
+require_relative "./version"
 
 module Convert2Ascii
   class Video2AsciiError < StandardError
@@ -17,14 +17,14 @@ module Convert2Ascii
   class Video2Ascii
     DEFAULT_STEP_DURATION = 0.04
 
-
     attr_accessor :uri, :width, :threads_count, :output, :step_duration
+
     def initialize(**args)
       @uri = args[:uri]
       @step_duration = args[:step_duration] || DEFAULT_STEP_DURATION
       @threads_count = set_threads_count
 
-      @tmpdir = nil
+      @tmpdir = File.join(Dir.home, ".convert2ascii")
       @output = Dir.pwd
 
       # image2ascii attrs
@@ -34,7 +34,6 @@ module Convert2Ascii
       @color_block = args[:color_block] || false
 
       check_packages
-      regist_hooks
     end
 
     def generate(**args)
@@ -43,34 +42,36 @@ module Convert2Ascii
       @color = args[:color] || @color # full
       @color_block = args[:color_block] || @color_block
 
-      @tmpdir = Dir.mktmpdir
+      remove_tmpdir
+      Dir.mkdir(@tmpdir)
       @audio = get_audio_from_video(@tmpdir)
       screenshots_from_video(@tmpdir)
       convert_all_images(@tmpdir)
       @frames_path = order_frames_path
 
-      self
-    end
-
-
-    def save(output_dir)
-      system("rm -rf #{@tmpdir}/*.jpg")
-      system("rm -rf #{output_dir} && mkdir #{output_dir}")
-      system("cp -r #{@tmpdir}/* #{output_dir}")
-
       # save config
-      File.open("#{output_dir}/meta.json", "w") do |f|
+      File.open("#{@tmpdir}/meta.json", "w") do |f|
         config = {
           step_duration: @step_duration,
-          audio: @audio ?  File.basename(@audio) : nil,
-          frames_count: @frames_path.length
+          audio: @audio ? File.basename(@audio) : nil,
+          frames_count: @frames_path.length,
         }
         json_data = JSON.generate(config, pretty: true)
         f.puts json_data
       end
 
+      self
+    end
+
+    def save(output_dir)
+      system("rm -rf #{@tmpdir}/*.jpg")
+      system("rm -rf #{output_dir} && mkdir #{output_dir}")
+      system("cp -r #{@tmpdir}/* #{output_dir}")
+
       puts ""
       puts Rainbow("[info] save success!").green
+    ensure
+      after_clean
     end
 
     def order_frames_path
@@ -79,7 +80,7 @@ module Convert2Ascii
         get_name_order(a) <=> get_name_order(b)
       end
 
-      @frames_path =  frames_path
+      @frames_path = frames_path
     end
 
     def play(**args)
@@ -88,14 +89,21 @@ module Convert2Ascii
       frames = @frames_path.map { |f| File.open(f).read }
 
       player_args = {
-        frames: ,
+        frames:,
         audio: @audio,
         play_loop:,
         step_duration:,
       }
+
       TerminalPlayer.new(**player_args).play
 
       return true
+    ensure
+      after_clean
+    end
+
+    def after_clean
+      remove_tmpdir
     end
 
     private
@@ -105,12 +113,10 @@ module Convert2Ascii
       CheckFFmpeg.new.check
     end
 
-    def regist_hooks
-      at_exit {
-        if @tmpdir
-          FileUtils.remove_entry @tmpdir
-        end
-      }
+    def remove_tmpdir
+      if File.directory? @tmpdir
+        FileUtils.remove_entry @tmpdir
+      end
     end
 
     def set_threads_count
@@ -156,7 +162,7 @@ module Convert2Ascii
         width: @width,
         style: @style,
         color: @color,
-        color_block: @color_block
+        color_block: @color_block,
       }
       Image2Ascii.new(uri: image).generate(**config).ascii_string
     end
@@ -169,10 +175,7 @@ module Convert2Ascii
 
     def convert_all_images(save_dir)
       images = Dir.glob("#{save_dir}/*.jpg")
-
-      processed_count = 0
       tasks = []
-      time_start = Time.now
       images.each_with_index do |image, i|
         tasks << lambda {
           begin
@@ -181,9 +184,6 @@ module Convert2Ascii
             File.open("#{@tmpdir}/#{basename}.txt", "w") do |f|
               f.puts ascii_string
             end
-
-            processed_count += 1
-            print(Rainbow("\rprocessing...  #{sprintf("%.2f", (1.0 * processed_count / images.length) * 100)} % (time: #{sprintf("%.2f", Time.now - time_start)} s)").green)
           rescue => error
             puts "-------"
             puts Rainbow("\n[Error] convert_to_ascii -> image: #{image} | i: #{i}").red
@@ -194,6 +194,5 @@ module Convert2Ascii
 
       MultiTasker.new(tasks).run
     end
-
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: convert2ascii
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Mark24
 bindir: exe
 cert_chain: []
-date: 2025-01-12 00:00:00.000000000 Z
+date: 2025-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rmagick
@@ -38,19 +38,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.1.1
 - !ruby/object:Gem::Dependency
-  name: async
+  name: parallel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.21'
+        version: '1.26'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.21'
+        version: '1.26'
 description: This gem can help you convert image or video became ASCII art in your
   terminal.
 email: