screenkit 0.0.0

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,20 @@
+# The MIT License (MIT)
+
+Copyright (c) 2025 Nando Vieira
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# screenkit
+
+[![Tests](https://github.com/fnando/screenkit/workflows/ruby-tests/badge.svg)](https://github.com/fnando/screenkit)
+[![Gem](https://img.shields.io/gem/v/screenkit.svg)](https://rubygems.org/gems/screenkit)
+[![Gem](https://img.shields.io/gem/dt/screenkit.svg)](https://rubygems.org/gems/screenkit)
+[![MIT License](https://img.shields.io/:License-MIT-blue.svg)](https://tldrlegal.com/license/mit-license)
+
+Terminal to screencast, simplified
+
+## Installation
+
+```bash
+gem install screenkit
+```
+
+Or add the following line to your project's Gemfile:
+
+```ruby
+gem "screenkit"
+```
+
+## Usage
+
+TODO: Write gem usage
+
+## Maintainer
+
+- [Nando Vieira](https://github.com/fnando)
+
+## Contributors
+
+- https://github.com/fnando/screenkit/contributors
+
+## Contributing
+
+For more details about how to contribute, please read
+https://github.com/fnando/screenkit/blob/main/CONTRIBUTING.md.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT). A copy of the license can be
+found at https://github.com/fnando/screenkit/blob/main/LICENSE.md.
+
+## Code of Conduct
+
+Everyone interacting in the screenkit project's codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/fnando/screenkit/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rubocop/rake_task"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "screen_kit"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+begin
+  require "pry"
+  Pry.start
+rescue LoadError
+  require "irb"
+  IRB.start(__FILE__)
+end

data/bin/setup

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/screenkit

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/screenkit"
+ScreenKit::CLI.start

data/lib/screen_kit.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "thor"
+require "thor/completion"
+require "yaml"
+require "json-schema"
+require "mini_magick"
+require "pathname"
+require "tty-spinner"
+require "etc"
+require "securerandom"
+
+module ScreenKit
+  require_relative "screenkit/version"
+  require_relative "screenkit/core_ext/string"
+  require_relative "screenkit/core_ext/json"
+  require_relative "screenkit/content_type"
+  require_relative "screenkit/anchor"
+  require_relative "screenkit/banner"
+  require_relative "screenkit/spacing"
+  require_relative "screenkit/watermark"
+  require_relative "screenkit/spinner"
+  require_relative "screenkit/shell"
+  require_relative "screenkit/schema_validator"
+  require_relative "screenkit/generators/project"
+  require_relative "screenkit/generators/episode"
+  require_relative "screenkit/config/base"
+  require_relative "screenkit/config/project"
+  require_relative "screenkit/config/episode"
+  require_relative "screenkit/callout"
+  require_relative "screenkit/callout/text_style"
+  require_relative "screenkit/transition"
+  require_relative "screenkit/parallel_processor"
+  require_relative "screenkit/callout/styles/base"
+  require_relative "screenkit/callout/styles/default"
+  require_relative "screenkit/cli"
+  require_relative "screenkit/cli/base"
+  require_relative "screenkit/cli/episode"
+  require_relative "screenkit/cli/root"
+  require_relative "screenkit/tts/say"
+  require_relative "screenkit/tts/eleven_labs"
+  require_relative "screenkit/animation_filters"
+  require_relative "screenkit/path_lookup"
+  require_relative "screenkit/sound"
+  require_relative "screenkit/utils"
+  require_relative "screenkit/logfile"
+  require_relative "screenkit/exporter/intro"
+  require_relative "screenkit/exporter/outro"
+  require_relative "screenkit/exporter/demotape"
+  require_relative "screenkit/exporter/episode"
+  require_relative "screenkit/exporter/segment"
+  require_relative "screenkit/exporter/image"
+  require_relative "screenkit/exporter/video"
+
+  def self.root_dir
+    @root_dir ||= Pathname(__dir__)
+  end
+
+  # Raised when the configuration schema is invalid.
+  InvalidConfigSchemaError = Class.new(StandardError)
+
+  # Raised when a file is not found.
+  FileNotFoundError = Class.new(StandardError)
+
+  # Raised when a file entry is not found in the lookup.
+  FileEntryNotFoundError = Class.new(StandardError)
+
+  require_files = lambda do |pattern|
+    Gem.find_files_from_load_path(pattern).each do |path|
+      next if path.include?("test")
+
+      require(path)
+    end
+  end
+
+  # Load all files that may be available as plugins.
+  require_files.call("screenkit/callout/styles/*.rb")
+  require_files.call("screenkit/callout/tts/*.rb")
+end

data/lib/screenkit/anchor.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ScreenKit
+  class Anchor
+    # The vertical alignment (:top, :center, :bottom).
+    attr_reader :vertical
+
+    # The horizontal alignment (:left, :center, :right).
+    attr_reader :horizontal
+
+    def initialize(value)
+      @horizontal, @vertical = (Array(value) * 2).take(2)
+    end
+
+    def as_json(*)
+      [horizontal, vertical]
+    end
+  end
+end

data/lib/screenkit/animation_filters.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module ScreenKit
+  class AnimationFilters
+    attr_reader :callout_index, :input_stream, :output_stream, :index,
+                :starts_at, :ends_at, :x, :y, :animation_duration,
+                :content_duration, :image_width, :image_height,
+                :callout_duration, :fade_out_start, :out_start
+
+    def initialize(
+      callout_index:,
+      input_stream:,
+      output_stream:,
+      index:,
+      starts_at:,
+      ends_at:,
+      x:,
+      y:,
+      animation_duration:,
+      content_duration:,
+      image_width:,
+      image_height:
+    )
+      @callout_index = callout_index
+      @input_stream = input_stream
+      @output_stream = output_stream
+      @index = index
+      @starts_at = starts_at
+      @ends_at = ends_at
+      @x = x
+      @y = y
+      @animation_duration = animation_duration
+      @content_duration = content_duration
+      @image_width = image_width
+      @image_height = image_height
+
+      # Calculated values used by animation methods
+      @callout_duration = ends_at - starts_at
+      @fade_out_start = callout_duration - animation_duration
+      @out_start = ends_at - animation_duration
+    end
+
+    def fade
+      filters = []
+
+      # Scale callout and apply fade in and fade out
+      # Fade in starts at 0, fade out starts at
+      # (callout_duration - animation_duration)
+      filters <<
+        "[#{callout_index}:v]scale=#{image_width}:#{image_height},fade=t=in:" \
+        "st=0:d=#{animation_duration}:alpha=1,fade=t=out:" \
+        "st=#{fade_out_start}:d=#{animation_duration}:alpha=1" \
+        "[callout#{index}_faded]"
+
+      # Use setpts to delay the callout's presentation timestamp to sync with
+      # starts_at, then overlay it
+      filters <<
+        "[callout#{index}_faded]setpts=PTS+#{starts_at}/TB" \
+        "[callout#{index}_delayed]"
+      filters <<
+        "[#{input_stream}][callout#{index}_delayed]overlay=x=#{x}:y=#{y}:" \
+        "enable='between(t,#{starts_at},#{ends_at})'" \
+        "[#{output_stream}]"
+
+      {video: filters, out_start:}
+    end
+
+    def slide
+      filters = []
+
+      # Scale and split callout for blur effect
+      filters << "[#{callout_index}:v]scale=#{image_width}:" \
+                 "#{image_height}[callout#{index}_base]"
+      filters << "[callout#{index}_base]split=3[callout#{index}_blur_in]" \
+                 "[callout#{index}_sharp][callout#{index}_blur_out]"
+
+      # Create blurred versions for motion and delay them to the correct
+      # timeline position
+      filters <<
+        "[callout#{index}_blur_in]boxblur=20:1,setpts=PTS+#{starts_at}/TB" \
+        "[callout#{index}_blurred_in]"
+      filters <<
+        "[callout#{index}_sharp]setpts=PTS+#{starts_at}/TB" \
+        "[callout#{index}_sharp_delayed]"
+      filters <<
+        "[callout#{index}_blur_out]boxblur=20:1,setpts=PTS+#{starts_at}/TB" \
+        "[callout#{index}_blurred_out]"
+
+      # Overlay blurred version during slide in
+      # Animation runs from 0 to animation_duration in callout's timeline
+      filters <<
+        "[#{input_stream}][callout#{index}_blurred_in]overlay=x=" \
+        "'if(lt(t,#{starts_at + animation_duration}),-W+((t-#{starts_at})*" \
+        "(W+#{x})/#{animation_duration}),#{x})':y=#{y}:enable=" \
+        "'between(t,#{starts_at},#{starts_at + animation_duration})'" \
+        "[#{output_stream}_in]"
+
+      # Overlay sharp version while visible
+      filters <<
+        "[#{output_stream}_in][callout#{index}_sharp_delayed]overlay=x=#{x}:" \
+        "y=#{y}:enable='between(t,#{starts_at + animation_duration}," \
+        "#{out_start})'[#{output_stream}_hold]"
+
+      # Overlay blurred version during slide out (to the left)
+      filters <<
+        "[#{output_stream}_hold][callout#{index}_blurred_out]overlay=x=" \
+        "'if(lt(t,#{ends_at}),#{x}-((t-#{out_start})*(W+#{x})/" \
+        "#{animation_duration}),-W)':y=#{y}:enable='between(t,#{out_start}," \
+        "#{ends_at})'[#{output_stream}]"
+
+      {video: filters, out_start:}
+    end
+  end
+end

data/lib/screenkit/banner.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ScreenKit
+  class Banner
+    def self.source
+      version = "v#{VERSION}"
+      version_line = "┃#{' ' * (69 - version.size)}#{version}     ┃ ║"
+
+      <<~TEXT
+        ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+        ┃  Terminal to screencast, simplified                                      ┃═╗
+        ┃  ███████╗ ██████╗██████╗ ███████╗███████╗███╗   ██╗██╗  ██╗██╗████████╗  ┃ ║
+        ┃  ██╔════╝██╔════╝██╔══██╗██╔════╝██╔════╝████╗  ██║██║ ██╔╝██║╚══██╔══╝  ┃ ║
+        ┃  ███████╗██║     ██████╔╝█████╗  █████╗  ██╔██╗ ██║█████╔╝ ██║   ██║     ┃ ║
+        ┃  ╚════██║██║     ██╔══██╗██╔══╝  ██╔══╝  ██║╚██╗██║██╔═██╗ ██║   ██║     ┃ ║
+        ┃  ███████║╚██████╗██║  ██║███████╗███████╗██║ ╚████║██║  ██╗██║   ██║     ┃ ║
+        ┃  ╚══════╝ ╚═════╝╚═╝  ╚═╝╚══════╝╚══════╝╚═╝  ╚═══╝╚═╝  ╚═╝╚═╝   ╚═╝     ┃ ║
+        #{version_line}
+        ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ ║
+          ╚══════════════════════════════════════════════════════════════════════════╝
+      TEXT
+    end
+
+    def self.banner
+      return source if !$stdout.tty? || ENV["NO_COLOR"]
+
+      colors = ["\e[31m", "\e[32m", "\e[33m", "\e[34m", "\e[35m", "\e[36m"]
+      text = colors.sample
+      accent = (colors - [text]).sample
+      clear = "\e[0m"
+
+      chars = source.each_char.with_object([]) do |char, buffer|
+        buffer << case char
+                  when /[A-Za-z0-9.,]/
+                    "#{text}#{char}#{clear}"
+                  when "╚", "═", "║", "╝", "╔", "╗"
+                    "\e[37m#{char}#{clear}"
+                  else
+                    "#{accent}#{char}#{clear}"
+                  end
+      end
+
+      chars.join
+    end
+  end
+end

data/lib/screenkit/callout/styles/base.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module ScreenKit
+  class Callout
+    module Styles
+      class Base
+        def text_wrap(text, max_width:, font_size:)
+          words = text.to_s.split(/\s+/)
+          width_factor = 0.6
+
+          [].tap do |lines|
+            words.each do |word|
+              line = lines.pop.to_s
+              word_width = word.size * (font_size * width_factor)
+              line_width = line.size * (font_size * width_factor)
+
+              if line_width + word_width <= max_width
+                line = [(line unless line.empty?), word].compact.join(" ")
+                lines << line
+              else
+                lines << line
+                lines << word
+              end
+            end
+          end
+        end
+
+        # Escape text for use in ImageMagick caption.
+        def escape_text(text)
+          text.gsub("'", "\\\\'")
+        end
+
+        def remove_file(path)
+          File.unlink(path) if path && File.exist?(path)
+        end
+
+        def render_text_image(text:, style:, width:, type:)
+          return [nil, 0, 0] if text.to_s.empty?
+
+          image = MiniMagick::Image.open(
+            create_text_image(text:, style:, width:, type:)
+          )
+
+          [image.path, image.width, image.height]
+        end
+
+        # Convert values to high resolution (2x).
+        # @param value [Object] The value to convert.
+        # @return [Object] The converted value.
+        def hi_res(value)
+          case value
+          when Array
+            value.map { hi_res(it) }
+          when Hash
+            value.transform_values { hi_res(it) }
+          when Numeric
+            value * 2
+          else
+            value
+          end
+        end
+
+        # Create a text image using MiniMagick.
+        # @param text [String] The text to render.
+        # @param style [TextStyle] The text style to apply.
+        # @param width [Integer] The width of the text image.
+        # @param type [String] The ImageMagick text type (e.g., "caption").
+        # @return [Array] The path to the generated text image, and the actual
+        #                 `Tempfile` instance.
+        def create_text_image(text:, style:, width:, type:)
+          hash = SecureRandom.hex(10)
+          tmp_path = File.join(Dir.tmpdir, "callout-text-#{hash}.png")
+          FileUtils.mkdir_p(File.dirname(tmp_path))
+
+          MiniMagick.convert do |image|
+            unless type == "label"
+              image << "-size"
+              image << "#{width}x"
+            end
+
+            image << "-background"
+            image << "none"
+            image << "-fill"
+            image << style.color
+            image << "-font"
+            image << style.font_path.to_s
+            image << "-pointsize"
+            image << style.size.to_s
+            image << "#{type}:#{escape_text(text)}"
+            image << "PNG:#{tmp_path}"
+          end
+
+          tmp_path
+        rescue MiniMagick::Error => error
+          retry if error.message.include?("No such file or directory")
+          raise
+        end
+      end
+    end
+  end
+end

data/lib/screenkit/callout/styles/default.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require "mini_magick"
+
+module ScreenKit
+  class Callout
+    module Styles
+      class Default < Base
+        extend SchemaValidator
+
+        attr_reader :background_color, :body, :body_style,
+                    :output_path, :padding, :shadow,
+                    :title, :title_style, :width, :source
+
+        def self.schema_path
+          ScreenKit.root_dir.join("screenkit/schemas/callouts/default.json")
+        end
+
+        def initialize(source:, **kwargs) #  rubocop:disable Lint/MissingSuper
+          self.class.validate!(kwargs)
+          @source = source
+
+          # Set default values
+          kwargs[:shadow] = case kwargs[:shadow]
+                            when false
+                              {color: "#ffffffff", offset: 0}
+                            when Integer
+                              {color: "#00000080", offset: kwargs[:shadow]}
+                            when String
+                              {color: kwargs[:shadow], offset: 20}
+                            else
+                              kwargs[:shadow]
+                            end
+
+          kwargs = hi_res({width: 600}.merge(kwargs))
+
+          kwargs.each do |key, value|
+            value = case key
+                    when :body_style, :title_style
+                      TextStyle.new(source:, **value)
+                    when :padding
+                      Spacing.new(value)
+                    else
+                      value
+                    end
+
+            instance_variable_set(:"@#{key}", value)
+          end
+        end
+
+        def as_json(*)
+          {
+            background_color:,
+            body:,
+            body_style: body_style.as_json,
+            output_path:,
+            padding: padding.as_json,
+            shadow:,
+            title:,
+            title_style: title_style.as_json,
+            width:
+          }
+        end
+
+        def render
+          title_path, _, title_height =
+            *render_text_image(text: title,
+                               style: title_style,
+                               width: text_width,
+                               type: "caption")
+          body_path, _, body_height =
+            *render_text_image(text: body,
+                               style: body_style,
+                               width: text_width,
+                               type: "caption")
+          text_gap = if title_path && body_path
+                       (title_style.size * hi_res(0.2)).round
+                     else
+                       0
+                     end
+
+          image_width = width
+          image_height = padding.vertical +
+                         title_height +
+                         text_gap +
+                         body_height +
+                         shadow[:offset]
+
+          MiniMagick.convert do |image|
+            # Create transparent canvas
+            image << "-size"
+            image << "#{image_width}x#{image_height}"
+            image << "xc:none"
+
+            # Draw rectangle shadow
+            image << "-fill"
+            image << shadow[:color]
+            image << "-draw"
+            image << "rectangle 0,#{shadow[:offset]}," \
+                     "#{width - shadow[:offset]},#{image_height}"
+
+            # Draw rectangle background
+            image << "-fill"
+            image << background_color
+            image << "-draw"
+            image << "rectangle #{shadow[:offset]},0," \
+                     "#{image_width},#{image_height - shadow[:offset]}"
+
+            # Composite title
+            if title_path
+              image << title_path
+              image << "-geometry"
+              image << "+#{text_x}+#{padding.left}"
+              image << "-composite"
+            end
+
+            # Composite body
+            if body_path
+              image << body_path
+              image << "-geometry"
+              image << "+#{text_x}+#{padding.left + title_height + text_gap}"
+              image << "-composite"
+            end
+
+            image << "PNG:#{output_path}"
+          end
+
+          output_path
+        rescue MiniMagick::Error => error
+          retry if error.message.include?("No such file or directory")
+          raise
+        ensure
+          remove_file(title_path)
+          remove_file(body_path)
+        end
+
+        private def text_width = width - padding.horizontal
+        private def text_x = shadow[:offset] + padding.left
+        private def title_y = padding.top
+        private def body_y = title_y + text_gap + title_style.size
+      end
+    end
+  end
+end