screenkit 0.0.0

data/lib/screenkit/generators/project/screenkit.yml

@@ -0,0 +1,189 @@
+---
+# yaml-language-server: $schema=../../schemas/project.json
+
+# ScreenKit project configuration file.
+schema: 1
+
+# The episodes directory is where the source files for each episode are stored.
+# A new episode can be generated with `screenkit episode new`.
+#
+# The episode directory name can include placeholders:
+# - %{episode_number}: The episode number
+# - %{episode_slug}: A URL-friendly slug for the episode title
+# - %{date}: The current timestamp in `yyyy-mm-dd` format.
+#
+# You can have padded episodes number by using a format string that looks like
+# `%<episode_number>03d` (e.g. `001`).
+episode_dir: episodes/%<episode_number>03d-%{episode_slug}
+
+# The resources directory contains additional resource files used in the video.
+# These can include images, sounds, fonts, etc.
+# When defining your configuration, you can just specify the partial path. For
+# instance, if you have an image at `resources/images/picture.png`, you can just
+# refer to it as `images/picture.png`.
+#
+# You can also specify absolute paths, like system font directories.
+#
+# To point to the episode directory, use the placeholder `%{episode_dir}`.
+resources_dir:
+  - .
+  - "%{episode_dir}"
+  - resources
+  - "%{episode_dir}/resources"
+  - resources/backtracks
+  - "%{episode_dir}/resources/backtracks"
+  - resources/sounds
+  - "%{episode_dir}/resources/sounds"
+  - resources/images
+  - "%{episode_dir}/resources/images"
+  - resources/fonts
+  - "%{episode_dir}/resources/fonts"
+  - resources
+  - "%{episode_dir}/resources"
+  - ~/Library/Fonts
+  - /Library/Fonts
+  - /System/Library/Fonts
+  - ~/.fonts
+  - ~/.local/share/fonts
+  - /usr/share/fonts
+  - /usr/local/share/fonts
+  - /opt/share/fonts
+
+# The output directory is where the generated video files will be saved.
+# You can change this to any directory you prefer.
+#
+# To point to the episode directory's name, use the placeholder
+# `%{episode_dirname}`.
+output_dir: output/%{episode_dirname}
+
+# Set the backtrack file or directory.
+# When a directory is specified, a random backtrack will be chosen from the
+# directory.
+# When a file is specified, that specific backtrack will be used instead.
+#
+# The entry is searched by using the `resorces_dir` config.
+#
+# You can disable the backtrack by setting this to `false`.
+backtrack: backtracks/
+
+# Render a watermark.
+# This is useful for branding or copyright purposes.
+# The watermark is omitted from the intro and outro scenes.
+# To disable the watermark, use `watermark: false`.
+watermark:
+  path: "watermark.png"
+  anchor: [right, bottom]
+  margin: 100
+
+# TTS configuration.
+# To disable voiceover entirely, set `tts: false`.
+# tts:
+#   engine: elevenlabs
+#   voice_id: 56AoDkrOh6qfVPDXZ7Pt
+#   language_code: en
+#   voice_settings:
+#     speed: 0.9
+#     stability: 0.5
+#     similarity: 0.75
+#     style: 0.0
+tts:
+  engine: say
+  rate: 150
+
+# Scene configurations define how different scenes in the video are rendered.
+# There are three types of scenes: intro, outro, and segment.
+# - Intro: The opening scene of the video, typically featuring the logo.
+# - Outro: The closing scene of the video.
+# - Segment: The main content scenes of the video.
+scenes:
+  intro:
+    # The duration of the intro scene in seconds.
+    duration: 5.5
+
+    # The fade-in duration in seconds.
+    fade_in: 0
+
+    # The fade-out duration in seconds.
+    fade_out: 0.5
+
+    # The background color/image of the intro scene.
+    background: "#100f50"
+
+    # The title text to be displayed in the intro scene.
+    title:
+      x: 100
+      y: 300
+      font_path: opensans/OpenSans-ExtraBold.ttf
+      size: 144
+      color: "#ffffff"
+
+    # The logo to be displayed in the video intro.
+    # Works best with a transparent PNG file in high resolution (at least 2x the
+    # size it'll be displayed).
+    logo:
+      path: logo.png
+      x: 100
+      y: 200
+      width: 300
+
+    # The sound to be played along with the logo in the intro.
+    # This must correspond to a sound file in the sounds directory, with any
+    # audio extension (e.g. mp3, m4a, wav).
+    sound: false
+
+  outro:
+    # The duration of the outro scene in seconds.
+    duration: 5.5
+
+    # The fade-in duration in seconds.
+    fade_in: 0.5
+
+    # The fade-out duration in seconds.
+    fade_out: 0.5
+
+    # The background color/image of the outro scene.
+    background: "#100f50"
+
+    # The sound to be played along with the logo in the outro.
+    sound: chime.mp3
+
+    # The logo to be displayed in the video outro.
+    logo:
+      path: logo.png
+      x: center
+      y: center
+      width: 300
+
+  segment:
+    # The duration of the crossover transition between segments in seconds.
+    crossfade_duration: 0.5
+
+# Callout configurations define the appearance and behavior of callouts used
+# in the video. Callouts are visual elements that highlight important
+# information. Each callout type can have its own settings for icon, background,
+# text styles, animations, and sounds.
+callouts:
+  info:
+    # yaml-language-server: $schema=../../schemas/callouts/default.json
+    background_color: "#ffff00"
+    shadow: "#2242d3"
+    title_style:
+      color: "#000000"
+      size: 40
+      font_path: opensans/OpenSans-ExtraBold.ttf
+    body_style:
+      color: "#000000"
+      size: 32
+      font_path: opensans/OpenSans-Semibold.ttf
+    margin: 100
+    padding: 50
+    anchor: [left, bottom]
+    animation: fade
+    in_transition:
+      duration: 0.4
+      sound: pop.mp3
+    out_transition:
+      duration: 0.3
+      sound:
+        path: pop.mp3
+        volume: 0.7

data/lib/screenkit/generators/project.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ScreenKit
+  module Generators
+    class Project < Thor::Group
+      include Thor::Actions
+
+      attr_accessor :options
+
+      def self.source_root
+        File.join(__dir__, "project")
+      end
+
+      def create_project_dir
+        template "Gemfile.erb", "Gemfile"
+      end
+
+      def copy_files
+        copy_file "screenkit.yml"
+        directory "resources", exclude_pattern: /DS_Store/
+      end
+
+      def bundle_install
+        in_root do
+          run "bundle install"
+        end
+      end
+
+      no_commands do
+        # Add helper methods here
+      end
+    end
+  end
+end

data/lib/screenkit/logfile.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ScreenKit
+  class Logfile
+    attr_reader :root_dir, :basename, :mutex
+    attr_accessor :index
+
+    def initialize(root_dir)
+      @root_dir = root_dir
+      @index = 0
+      @mutex = Mutex.new
+    end
+
+    def create(*args)
+      args.unshift(mutex.synchronize { format("%04d", index) })
+      mutex.synchronize { self.index += 1 }
+
+      Pathname(root_dir).join("#{args.join('-')}.txt")
+    end
+
+    def log(*args)
+      message = args.pop
+      path = create(*args)
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, "w") { it << message.to_s }
+    end
+
+    def json_log(*args)
+      message = args.pop
+      log(*args, JSON.pretty_generate(message))
+    end
+  end
+end

data/lib/screenkit/parallel_processor.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module ScreenKit
+  class ParallelProcessor
+    attr_reader :spinner, :list, :message, :mutex, :count, :log_path
+    attr_accessor :progress
+
+    def initialize(spinner:, list:, message:, log_path: nil)
+      @list = list
+      @message = message
+      @spinner = spinner
+      @mutex = Mutex.new
+      @progress = 0
+      @count = list.size
+      @log_path = log_path
+    end
+
+    def run(&block)
+      started_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      indexed_list = list.map.with_index {|item, index| [item, index] }
+      arity = block.arity
+
+      indexed_list.each_slice(Etc.nprocessors) do |slice|
+        threads = slice.map do |args|
+          thread = Thread.new do
+            yield(*args.take([1, arity].max), log_path:)
+            update_progress
+          end
+
+          thread.abort_on_exception = true
+          thread
+        end
+
+        threads.each(&:join)
+      end
+
+      spinner.stop
+
+      ended_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      ended_at - started_at
+    end
+
+    def update_progress
+      mutex.synchronize do
+        self.progress += 1
+        spinner.update(format(message, count:, progress:))
+      end
+    end
+  end
+end

data/lib/screenkit/path_lookup.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ScreenKit
+  class PathLookup
+    # The directories to search for files.
+    attr_reader :dirs
+
+    def initialize(*dirs)
+      @dirs = dirs.map { Pathname(it) }
+    end
+
+    # Search for the given path in the configured directories.
+    # @param path [String, Pathname] The relative path to search for.
+    # @return [Pathname, nil] The found path or nil if not found.
+    def search(path, default: nil)
+      dirs.each do |dir|
+        candidate = dir.join(path)
+        return candidate if candidate.exist?
+      end
+
+      return default if default
+
+      raise FileEntryNotFoundError,
+            %[No file entry found for #{path.to_s.inspect}]
+    end
+  end
+end

data/lib/screenkit/schema_validator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ScreenKit
+  module SchemaValidator
+    def validate!(attributes)
+      errors = JSON::Validator
+               .fully_validate("file://#{schema_path}", attributes)
+
+      return if errors.empty?
+
+      raise ArgumentError, "Invalid attributes: #{errors.first}"
+    end
+  end
+end

data/lib/screenkit/schemas/callouts/default.json

@@ -0,0 +1,44 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://github.com/fnando/screenkit/schemas/callouts/basic.json",
+  "title": "Basic Callout",
+  "type": "object",
+  "required": [
+    "background_color",
+    "body_style",
+    "padding",
+    "shadow",
+    "title_style"
+  ],
+  "properties": {
+    "width": {
+      "type": "number",
+      "description": "The callout width"
+    },
+    "background_color": {
+      "$ref": "../refs/color.json"
+    },
+    "shadow": {
+      "oneOf": [
+        { "type": "boolean", "enum": [false] },
+        { "type": "string", "$ref": "../refs/color.json" },
+        {
+          "type": "object",
+          "properties": {
+            "color": { "$ref": "../refs/color.json" },
+            "offset": { "type": "integer" }
+          }
+        }
+      ]
+    },
+    "title_style": {
+      "$ref": "../refs/text_style.json"
+    },
+    "body_style": {
+      "$ref": "../refs/text_style.json"
+    },
+    "padding": {
+      "$ref": "../refs/spacing.json"
+    }
+  }
+}

data/lib/screenkit/schemas/callouts/inline_block.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://github.com/fnando/screenkit/schemas/callouts/inline_block.json",
+  "title": "Inline Block Callout",
+  "type": "object",
+  "required": ["background_color", "text_style"],
+  "properties": {
+    "background_color": { "$ref": "../refs/color.json" },
+    "width": {
+      "type": "number",
+      "description": "The callout width"
+    },
+    "text_style": {
+      "$ref": "../refs/text_style.json"
+    },
+    "padding": {
+      "$ref": "../refs/spacing.json"
+    }
+  }
+}

data/lib/screenkit/schemas/episode.json

@@ -0,0 +1,74 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://github.com/fnando/screenkit/schemas/episode.json",
+  "title": "ScreenKit Episode Configuration",
+  "description": "Schema for ScreenKit episode configuration file (config.yml)",
+  "type": "object",
+  "required": ["title"],
+  "properties": {
+    "backtrack": { "$ref": "refs/sound.json" },
+    "scenes": { "$ref": "refs/scenes.json" },
+    "tts": { "$ref": "refs/tts.json" },
+    "watermark": { "$ref": "refs/watermark.json" },
+    "title": {
+      "type": "string",
+      "description": "The episode title",
+      "minLength": 1,
+      "pattern": "\\S"
+    },
+    "callouts": {
+      "type": "array",
+      "description": "List of callouts to be used in the episode",
+      "items": {
+        "type": "object",
+        "required": ["type", "starts_at", "duration"],
+        "additionalProperties": true,
+        "properties": {
+          "type": {
+            "type": "string",
+            "description": "Callout type identifier",
+            "minLength": 1,
+            "pattern": "\\S"
+          },
+          "starts_at": {
+            "oneOf": [
+              {
+                "type": "string",
+                "description": "Callout start time in HH:MM:SS format (e.g. 00:01:30)"
+              },
+              {
+                "type": "number",
+                "description": "Callout start time in seconds (e.g. 90)"
+              }
+            ]
+          },
+          "duration": {
+            "oneOf": [
+              {
+                "type": "string",
+                "description": "Callout duration time (e.g. 5s)",
+                "pattern": "/^\\d+(s|m|h)$/"
+              },
+              {
+                "type": "number",
+                "description": "Callout duration time in seconds (e.g. 5)"
+              }
+            ]
+          },
+          "width": {
+            "oneOf": [
+              {
+                "type": "string",
+                "description": "Callout width in percentage (e.g. 50%)"
+              },
+              {
+                "type": "number",
+                "description": "Callout width in pixels (e.g. 300)"
+              }
+            ]
+          }
+        }
+      }
+    }
+  }
+}

data/lib/screenkit/schemas/project.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://github.com/fnando/screenkit/schemas/project.json",
+  "title": "ScreenKit Project Configuration",
+  "description": "Schema for ScreenKit project configuration file (screenkit.yml)",
+  "type": "object",
+  "required": ["schema", "resources_dir", "episode_dir", "output_dir"],
+  "properties": {
+    "resources_dir": { "$ref": "refs/directory.json" },
+    "backtrack": { "$ref": "refs/sound.json" },
+    "tts": { "$ref": "refs/tts.json" },
+    "watermark": { "$ref": "refs/watermark.json" },
+    "scenes": { "$ref": "refs/scenes.json" },
+    "schema": {
+      "type": "integer",
+      "description": "The schema version number",
+      "enum": [1]
+    },
+    "episode_dir": {
+      "type": "string",
+      "description": "Directory where episode source files are stored. Supports placeholders like %{episode_number}, %{episode_slug} and %{date}.",
+      "$ref": "refs/directory.json"
+    },
+    "output_dir": {
+      "type": "string",
+      "description": "Directory where generated video files will be saved. Supports placeholders like %{episode_number}, %{episode_slug} and %{date}.",
+      "format": "uri"
+    },
+    "callouts": {
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "refs/callout.json"
+      }
+    }
+  },
+  "additionalProperties": false
+}

data/lib/screenkit/schemas/refs/anchor.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://github.com/fnando/screenkit/schemas/anchor.json",
+  "title": "Anchor",
+  "type": "array",
+  "description": "Anchor position [horizontal, vertical]",
+  "items": [
+    {
+      "type": "string",
+      "enum": ["left", "center", "right"]
+    },
+    {
+      "type": "string",
+      "enum": ["top", "center", "bottom"]
+    }
+  ]
+}

data/lib/screenkit/schemas/refs/animation.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://github.com/fnando/screenkit/schemas/refs/animation.json",
+  "title": "Animation Type",
+  "type": "string",
+  "enum": ["slide", "fade"]
+}

data/lib/screenkit/schemas/refs/background.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://github.com/fnando/screenkit/schemas/refs/background.json",
+  "title": "Background",
+  "anyOf": [
+    {
+      "type": "string",
+      "format": "uri"
+    },
+    {
+      "$ref": "color.json"
+    }
+  ]
+}

data/lib/screenkit/schemas/refs/callout.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://github.com/fnando/screenkit/schemas/callout.json",
+  "title": "Callout",
+  "type": "object",
+  "required": [
+    "in_transition",
+    "out_transition",
+    "anchor",
+    "margin",
+    "animation"
+  ],
+  "properties": {
+    "in_transition": { "$ref": "transition.json" },
+    "out_transition": { "$ref": "transition.json" },
+    "animation": { "$ref": "animation.json" },
+    "margin": { "$ref": "spacing.json" },
+    "style": {
+      "type": "string",
+      "description": "Callout style name (defaults to 'default')",
+      "default": "default"
+    },
+    "anchor": {
+      "$ref": "anchor.json"
+    }
+  }
+}

data/lib/screenkit/schemas/refs/color.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://github.com/fnando/screenkit/schemas/refs/color.json",
+  "title": "Color type with optional alpha channel",
+  "type": "string",
+  "pattern": "^#[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$"
+}

data/lib/screenkit/schemas/refs/directory.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://github.com/fnando/screenkit/schemas/project.json",
+  "title": "Directory",
+  "oneOf": [
+    {
+      "type": "string",
+      "description": "Directory containing background music files",
+      "format": "uri"
+    },
+    {
+      "type": "array",
+      "description": "List of directories containing background music files",
+      "items": {
+        "type": "string",
+        "format": "uri"
+      }
+    }
+  ]
+}

data/lib/screenkit/schemas/refs/intro.json

@@ -0,0 +1,30 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://github.com/fnando/screenkit/schemas/refs/intro.json",
+  "title": "Intro",
+  "properties": {
+    "duration": {
+      "type": "number",
+      "description": "Duration of the intro scene in seconds",
+      "minimum": 0
+    },
+    "fade_in": {
+      "type": "number",
+      "description": "Fade-in duration in seconds",
+      "minimum": 0
+    },
+    "fade_out": {
+      "type": "number",
+      "description": "Fade-out duration in seconds",
+      "minimum": 0
+    },
+    "title": {
+      "type": "object",
+      "description": "Title configuration",
+      "allOf": [{ "$ref": "text_style.json" }, { "$ref": "position.json" }]
+    },
+    "background": { "$ref": "background.json" },
+    "logo": { "$ref": "logo.json" },
+    "sound": { "$ref": "sound.json" }
+  }
+}