screenkit 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b105910b064ec4639068b441398fe95290b31a26bc19d0745d96970956a338d
-  data.tar.gz: 9e84a6b711c03fd3f1765d0fd1dd3cd7fd53857197fb82b480d9ff16c6b08d4b
+  metadata.gz: 6cf85172336bdd8b19097835329c4deef29f9d2b57ab5b3caa1f1f2cb5681226
+  data.tar.gz: 69ba53b85b77fea9292a1833a3195467a3e782481a67b94b75983c47d89afb24
 SHA512:
-  metadata.gz: 98cb59b8738b6bbae13f4a7f0815214975272c967e2b7c7153e1618f61e0e95e16e9fc707802b810d38ec36d9ea0092d88163b472fe6b414c7c2db5c41d249be
-  data.tar.gz: 6a4679359994481516de5393ca439e867f040f6974fc2b9ded318b37ff341574cb646dc6f2b65a89c8896c5d38f067fdccf4ac29c0688ae0d961080cc996e653
+  metadata.gz: 1d98ebece57b893b59766b61ba359f0ef44038e17f08d812eaa870f94f502662a23a18e6582674fd494630b492b3cf5d44f256735ddf690ed5604cf775fcd1f2
+  data.tar.gz: be1ad9cddd204eb4ecff40f9eb2d1c2490f713770cb7d3957e7fe870b9bad14838d2fa4abca53f9ebc6207d07fbdd9773d53e4a76d48bea82a9343635754faf9

data/.github/workflows/docker.yml

@@ -0,0 +1,46 @@
+---
+name: docker-image
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - Dockerfile
+    tags:
+      - v*
+  workflow_dispatch:
+    inputs:
+      ref:
+        description: "Git ref to build the image from"
+        required: false
+        default: "main"
+
+concurrency:
+  group: image-workflow
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.inputs.ref }}
+
+      - run: >
+          echo "IMAGE_TAG=${{ (inputs.ref || github.ref_name) == 'main' &&
+          'latest' || (inputs.ref || github.ref_name) }}" >> $GITHUB_ENV
+
+      - name: Build Docker Image
+        run: |
+          docker build -t fnando/screenkit:${{ env.IMAGE_TAG }} .
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_HUB_USERNAME }}
+          password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
+
+      - name: Push Docker Image
+        run: |
+          docker push fnando/screenkit:${{ env.IMAGE_TAG }}

data/.github/workflows/ruby-tests.yml

@@ -24,7 +24,7 @@ jobs:
           - Gemfile
 
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
 
       - uses: actions/cache@v4
         with:
@@ -36,6 +36,26 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby }}
 
+      - name: Install system dependencies
+        run: |
+          # Install ImageMagick and zsh
+          sudo apt-get update
+          sudo apt-get install -y imagemagick zsh espeak
+
+          # Download and install FFmpeg 8
+          wget --quiet https://github.com/BtbN/FFmpeg-Builds/releases/download/latest/ffmpeg-master-latest-linux64-gpl.tar.xz
+          tar -xf ffmpeg-master-latest-linux64-gpl.tar.xz
+          sudo cp ffmpeg-master-latest-linux64-gpl/bin/ffmpeg /usr/local/bin/
+          sudo cp ffmpeg-master-latest-linux64-gpl/bin/ffprobe /usr/local/bin/
+
+          # Download and install ttyd
+          wget --quiet https://github.com/tsl0922/ttyd/releases/download/1.7.7/ttyd.x86_64
+          chmod +x ttyd.x86_64
+          sudo mv ttyd.x86_64 /usr/local/bin/ttyd
+
+          # Install ffmpeg-normalize
+          pip3 install ffmpeg-normalize
+
       - name: Install gem dependencies
         env:
           BUNDLE_GEMFILE: ${{ matrix.gemfile }}

data/Brewfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+brew "ffmpeg"
+brew "espeak"
+brew "imagemagick"

data/CHANGELOG.md

@@ -11,6 +11,17 @@ Prefix your message with one of the following:
 - [Security] in case of vulnerabilities.
 -->
 
+## v0.0.3
+
+- [Changed] Do not expand path when creating project/episode.
+
+## v0.0.2
+
+- [Added] Add file copy callout style, to copy files to the final output path.
+- [Changed] Copy only two OpenSans font files.
+- [Changed] Rename the default callout to `shadow_block`.
+- [Fixed] Changed all JSON Schema files to use a consistent url.
+
 ## v0.0.1
 
 - [Added] Allow configuring Demo Tape using episode or project configuration.

data/CONTRIBUTING.md

@@ -32,6 +32,31 @@ by [opening an issue on Github](https://github.com/fnando/screenkit/issues).
 When you're ready to make your pull request, follow checklist below to make sure
 your contribution is according to how this project works.
 
+### Setting up your environment
+
+This project requires the following dependencies:
+
+- ffmpeg
+- imagemagick
+- espeak
+- ruby
+- ffmpeg-normalize
+
+If you are using macOS, you can install them using [Homebrew](https://brew.sh).
+There's a Brewfile at the root directory with the required dependencies:
+
+```sh
+brew bundle install
+```
+
+For ffmpeg-normalize, you can use pip:
+
+```sh
+pip install ffmpeg-normalize --user
+```
+
+### Guidelines
+
 1. [Fork](https://help.github.com/forking/) screenkit
 2. Create a topic branch - `git checkout -b my_branch`
 3. Make your changes using [descriptive commit messages](#commit-messages)

data/DOCUMENTATION.md

@@ -36,6 +36,17 @@ Or add to your Gemfile:
 gem "screenkit"
 ```
 
+### Docker
+
+```bash
+docker run --shm-size=2g -v $PWD:/source --rm -it docker.io/fnando/screenkit
+```
+
+Notice that Chrome requires a lot of memory, so you need `--shm-size=2g` (or
+more).
+
+To create a new project:
+
 ---
 
 ## Quick Start
@@ -215,7 +226,7 @@ Define reusable callout styles:
 
 ```yaml
 callouts:
-  default:
+  shadow_block:
     background_color: "#ffff00"
     shadow: "#2242d3" # Color string or false
 
@@ -311,7 +322,6 @@ callouts:
 
 - **Seconds**: `starts_at: 90` (90 seconds)
 - **HH:MM:SS**: `starts_at: "00:01:30"` (1 minute 30 seconds)
-- **Duration**: Always in seconds or time units (`5s`, `2m`, `1h`)
 
 ---
 
@@ -397,14 +407,15 @@ during the video.
 
 ScreenKit provides two built-in callout styles:
 
-#### Default Style
+#### Shadow Block Style
 
-The default style displays a title and body in a box with optional shadow.
+The shadow block style displays a title and body in a box with optional shadow.
 
 ```yaml
-callouts:
-  info:
-    style: default                    # Optional: defaults to "default"
+callout_styles:
+  shadow_block:                       # This key can be anything.
+    style: shadow_block               # The callout style name (will resolve to
+                                      # a ruby class).
     background_color: "#ffff00"       # Background color (hex)
 
     # Shadow
@@ -445,11 +456,11 @@ callouts:
         volume: 0.7                   # Volume (0.0 to 1.0)
 ```
 
-**Usage in episode:**
+##### Usage in episode
 
 ```yaml
 callouts:
-  - type: info
+  - type: shadow_block
     title: "ScreenKit"
     body: "Visit https://github.com/fnando/screenkit"
     starts_at: 3
@@ -463,27 +474,24 @@ similar to syntax highlighting or code comments. Perfect for displaying code
 snippets, commands, or short inline text.
 
 ```yaml
-callouts:
-  code:
-    style: inline_block
+callouts_styles:
+  code: # This key can be anything.
+    style: inline_block # Will resolve to a ruby class.
     background_color: "#000000" # Background color (hex)
 
-    # Text Style (single style for all text)
     text_style:
       color: "#ffffff"
       size: 40
       font_path: open-sans/OpenSans-ExtraBold.ttf
 
     # Layout
-    padding: 20 # Padding around text (pixels)
-    margin: 100 # Margin from edge (pixels)
-    anchor: [left, center] # Position anchor point
-    width: 600 # Maximum width (pixels)
+    padding: 20
+    margin: 100
+    anchor: [left, center]
+    width: 600
 
-    # Animation
-    animation: fade # "fade" or "slide"
+    animation: fade
 
-    # Transitions
     in_transition:
       duration: 0.4
       sound: false
@@ -493,7 +501,7 @@ callouts:
       sound: false
 ```
 
-**Usage in episode:**
+##### Usage in episode
 
 ```yaml
 callouts:
@@ -513,14 +521,91 @@ callouts:
     duration: 6
 ```
 
-**Key differences from default style:**
+#### File Copy Style
+
+This is not a callout style per se. Instead, you can copy a file to the final
+output directory during episode export. Useful for adding custom assets that may
+be produced outside of ScreenKit.
 
-- Uses `text` instead of `title` and `body`
-- Only one `text_style` (no separate title/body styles)
-- No `shadow` option
-- Each line gets its own background rectangle
-- Text can include manual line breaks (`\n`)
-- Auto-wraps based on `width` if no line breaks present
+```yaml
+callouts_styles:
+  file_copy: # This key can be anything.
+    style: file_copy
+
+    # Layout
+    padding: 20
+    margin: 100
+    anchor: [left, center]
+    width: 600
+
+    animation: fade
+
+    in_transition:
+      duration: 0.4
+      sound: false
+
+    out_transition:
+      duration: 0.3
+      sound: false
+```
+
+##### Usage in episode
+
+```yaml
+callouts:
+  - type: file_copy
+    file_path: images/social_card.png
+```
+
+```yaml
+callouts:
+  - type: file_copy
+    file_path: videos/social_card.mov
+```
+
+> [!NOTE]
+>
+> When copying a video file, the video will be used as an overlay, without
+> resizing or repositioning. That means your overlay needs to be exactly
+> 1920x1080 and 24 FPS. If the video has sound, it will be kept on the final
+> output.
+
+#### Custom Callout Styles
+
+You can create custom callout styles by placing them in the
+`ScreenKit::Callout::Styles` namespace.
+
+```ruby
+module ScreenKit
+  class Callout
+    module Styles
+      class SomeStyle < Base
+        extend SchemaValidator
+
+        def self.schema_path
+          "some/path/to/your/schema.json"
+        end
+
+        # `source` is the way you search for resources.
+        # `output_path` is where you must save the generated callout file.
+        # `log_path` is where you can write logs (optional).
+        def initialize(source:, output_path:, log_path:, **options)
+          self.class.validate!(options)
+
+          @source = source
+          @output_path = output_path
+          @log_path = log_path
+          @options = options
+        end
+
+        def render
+          # Generate the image/video that will be used as a callout.
+        end
+      end
+    end
+  end
+end
+```
 
 ### Anchor Positions
 
@@ -607,28 +692,33 @@ module. Custom engines must implement the `generate` method:
 ```ruby
 module ScreenKit
   module TTS
-    class CustomEngine
+    class CustomEngine < Base
       include Shell
-      extend SchemaValidator
 
       # Optional: Define schema path for validation
       def self.schema_path
         ScreenKit.root_dir.join("screenkit/schemas/tts/custom_engine.json")
       end
 
-      def initialize(**options)
-        @options = options
-        # Validate options against schema if defined
-        self.class.validate!(@options) if respond_to?(:validate!)
+      # This method is required.
+      def available?
+        enabled? && command_exist?("some-command")
       end
 
+      # This method is required.
       def generate(text:, output_path:, log_path: nil)
+        # Optional: validate options against JSON schema.
+        self.class.validate!(options)
+
         # Generate audio file from text
         # Write output to output_path
         # Optionally log to log_path
 
         # Example implementation:
-        # File.write(output_path, generated_audio_data)
+        # run_command "some-command",
+        #             "-o", output_path.sub_ext(".wav"),
+        #             text,
+        #             log_path:
       end
     end
   end
@@ -700,8 +790,12 @@ out_transition:
 ```
 episodes/001-episode-name/
 ├── config.yml              # Episode configuration
+├── callouts/               # Callout definitions
+│   ├── 001.yml             # Callouts that will appear on segment 001
+│   ├── 002.yml
+│   └── ...
 ├── content/                # Terminal recordings
-│   ├── 001.tape           # VHS tape files
+│   ├── 001.tape            # Demo Tape files
 │   ├── 002.tape
 │   └── ...
 ├── scripts/                # Voiceover scripts
@@ -718,9 +812,9 @@ episodes/001-episode-name/
     └── fonts/
 ```
 
-### VHS Tape Files
+### Demo Tape Files
 
-ScreenKit uses [VHS](https://github.com/charmbracelet/vhs) tape files for
+ScreenKit uses [Demo Tape](https://github.com/fnando/demotape) tape files for
 terminal recordings:
 
 ```tape
@@ -879,7 +973,8 @@ When exporting an episode, ScreenKit:
 
 1. **Validates** project and episode configurations
 2. **Generates voiceovers** from script files (if TTS enabled)
-3. **Renders terminal recordings** from tape files using VHS
+3. **Renders terminal recordings** from tape files using
+   [Demo Tape](https://github.com/fnando/demotape)
 4. **Combines segments** with crossfade transitions
 5. **Adds intro/outro** scenes
 6. **Overlays callouts** with animations
@@ -917,7 +1012,7 @@ be processed).
 ### Visuals
 
 - Use consistent branding across callouts
-- Test callout timing with `screenkit callout` command
+- Test callout formats with `screenkit callout` command
 - PNG images with transparency work best for logos and watermarks
 
 ### Organization
@@ -953,7 +1048,7 @@ bundle exec screenkit ...
 
 **TTS not working:**
 
-- For ElevenLabs: Set `--voice-api-key` or `ELEVENLABS_API_KEY` env variable
+- For ElevenLabs: Set `--voice-api-key`
 - For macOS `say`: Verify voice name with `say -v ?`
 
 ---

data/Dockerfile

@@ -0,0 +1,107 @@
+# Stage 1: Download and extract fonts
+FROM --platform=linux/amd64 alpine:latest AS fonts
+RUN apk add --no-cache curl unzip
+RUN mkdir /fonts && \
+    curl -sSL -o JetBrainsMono.zip https://github.com/ryanoasis/nerd-fonts/releases/download/v3.4.0/JetBrainsMono.zip && \
+    unzip -j JetBrainsMono.zip 'JetBrainsMonoNerdFontPropo-*.ttf' -d /fonts
+
+# Stage 2: Download binaries
+FROM --platform=linux/amd64 alpine:latest AS binaries
+ARG SLIDES_VERSION=0.9.0
+ARG TTYD_VERSION=1.7.7
+ARG LL_VERSION=0.0.11
+ARG BAT_VERSION=0.26.0
+RUN apk add --no-cache curl
+RUN mkdir /bin-download && cd /bin-download && \
+    curl -sSL https://github.com/maaslalani/slides/releases/download/v${SLIDES_VERSION}/slides_${SLIDES_VERSION}_linux_amd64.tar.gz | tar xz && \
+    curl -sSL https://github.com/tsl0922/ttyd/releases/download/${TTYD_VERSION}/ttyd.x86_64 > ttyd && \
+    curl -sSL https://github.com/fnando/ll/releases/download/v${LL_VERSION}/ll-x86_64-unknown-linux-gnu.tar.gz | tar xz && \
+    curl -sSL https://github.com/sharkdp/bat/releases/download/v${BAT_VERSION}/bat-v${BAT_VERSION}-x86_64-unknown-linux-musl.tar.gz | tar xz && \
+    mv bat-v${BAT_VERSION}-x86_64-unknown-linux-musl/bat . && \
+    chmod +x slides ttyd ll bat
+
+# Stage 3: Final image
+FROM --platform=linux/amd64 ruby:3.4-alpine
+
+# Install runtime dependencies and build tools
+RUN apk add --no-cache \
+    --repository=http://dl-cdn.alpinelinux.org/alpine/edge/main \
+    --repository=http://dl-cdn.alpinelinux.org/alpine/edge/community \
+    bash \
+    bash-completion \
+    build-base \
+    ca-certificates \
+    chromium \
+    chromium-chromedriver \
+    curl \
+    fish \
+    ffmpeg \
+    font-liberation \
+    font-noto \
+    font-noto-emoji \
+    freetype \
+    git \
+    gtk+3.0 \
+    harfbuzz \
+    imagemagick \
+    jq \
+    less \
+    mesa-gl \
+    nss \
+    python3 \
+    py3-pip \
+    py3-virtualenv \
+    sudo \
+    ttf-dejavu \
+    ttf-freefont \
+    udev \
+    zsh \
+    && fc-cache -f
+
+ARG USER=screenkit
+ENV TERM=xterm-256color
+ENV PATH="/venv/bin:/source/bin:/${USER}/bin:$PATH"
+ENV CHROME_BIN=/usr/bin/chromium-browser
+ENV CHROME_PATH=/usr/lib/chromium/
+
+# Copy binaries and fonts from builder stages
+COPY --from=binaries /bin-download/slides /usr/local/bin/slides
+COPY --from=binaries /bin-download/ttyd /usr/local/bin/ttyd
+COPY --from=binaries /bin-download/ll /usr/local/bin/ll
+COPY --from=binaries /bin-download/bat /usr/local/bin/bat
+COPY --from=fonts /fonts /usr/local/share/fonts
+
+# Update font cache
+RUN fc-cache -f
+
+# Create user
+RUN adduser -D -h /${USER} -s /bin/zsh -u 1001 ${USER} \
+    && chown -R ${USER}:${USER} /${USER} \
+    && echo "${USER} ALL=(ALL) NOPASSWD:ALL" > /etc/sudoers.d/${USER} \
+    && chmod 0440 /etc/sudoers.d/${USER}
+
+RUN mkdir -p /venv && chown -R ${USER}:${USER} /venv
+RUN mkdir -p /${USER}-local && chown -R ${USER}:${USER} /${USER}-local
+
+# Install screenkit gem
+RUN gem install screenkit && \
+    mkdir -p /usr/share/bash-completion/completions && \
+    mkdir -p /usr/share/zsh/site-functions && \
+    mkdir -p /usr/share/fish/vendor_completions.d && \
+    screenkit completion --shell bash > /usr/share/bash-completion/completions/screenkit && \
+    screenkit completion --shell zsh > /usr/share/zsh/site-functions/_screenkit && \
+    screenkit completion --shell fish > /usr/share/fish/vendor_completions.d/screenkit.fish && \
+    echo 'autoload -Uz compinit && compinit' >> /etc/zsh/zshrc && \
+    echo 'source /usr/share/bash-completion/bash_completion' >> /etc/bash/bashrc && \
+    apk del build-base
+
+USER ${USER}
+WORKDIR /${USER}
+
+# Create Python virtual environment
+RUN python3 -m venv /venv
+RUN /venv/bin/pip install ffmpeg-normalize
+
+WORKDIR /source
+
+ENTRYPOINT [ "screenkit" ]

data/lib/screen_kit.rb

@@ -19,6 +19,7 @@ module ScreenKit
   require_relative "screenkit/content_type"
   require_relative "screenkit/anchor"
   require_relative "screenkit/banner"
+  require_relative "screenkit/time_formatter"
   require_relative "screenkit/spacing"
   require_relative "screenkit/watermark"
   require_relative "screenkit/spinner"
@@ -31,17 +32,15 @@ module ScreenKit
   require_relative "screenkit/config/episode"
   require_relative "screenkit/callout"
   require_relative "screenkit/callout/text_style"
+  require_relative "screenkit/callout/styles/base"
   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/tts/base"
   require_relative "screenkit/path_lookup"
   require_relative "screenkit/sound"
   require_relative "screenkit/utils"
@@ -54,6 +53,18 @@ module ScreenKit
   require_relative "screenkit/exporter/image"
   require_relative "screenkit/exporter/video"
 
+  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/tts/*.rb")
+
   def self.root_dir
     @root_dir ||= Pathname(__dir__)
   end
@@ -66,16 +77,4 @@ module ScreenKit
 
   # 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/animation_filters.rb

@@ -110,5 +110,21 @@ module ScreenKit
 
       {video: filters, out_start:}
     end
+
+    def video
+      filters = []
+
+      # For video callouts:
+      # Add transparent padding at start to delay, then overlay
+      filters <<
+        "[#{callout_index}:v]tpad=start_duration=#{starts_at}:" \
+        "color=black@0.0[callout#{index}_delayed]"
+
+      filters <<
+        "[#{input_stream}][callout#{index}_delayed]overlay=x=#{x}:y=#{y}:" \
+        "eof_action=pass[#{output_stream}]"
+
+      {video: filters, out_start:}
+    end
   end
 end

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

@@ -4,6 +4,18 @@ module ScreenKit
   class Callout
     module Styles
       class Base
+        attr_reader :source, :output_path, :log_path
+        attr_accessor :options
+
+        extend SchemaValidator
+
+        def initialize(source:, output_path:, log_path: nil, **options)
+          @source = source
+          @output_path = output_path
+          @log_path = log_path
+          @options = options
+        end
+
         def text_wrap(text, max_width:, font_size:)
           words = text.to_s.split(/\s+/)
           width_factor = 0.6