screenkit 0.0.5 → 0.0.7

data/lib/screenkit/exporter/segment.rb

@@ -177,6 +177,10 @@ module ScreenKit
                     log_path:
       end
 
+      def script_content
+        @script_content ||= script_path.read if script_path.file?
+      end
+
       def create_voiceover(log_path:)
         return if voiceover_path&.file? && !episode.options.overwrite
         return unless script_path.file?
@@ -185,7 +189,7 @@ module ScreenKit
         FileUtils.mkdir_p(voiceover_path.dirname)
 
         episode.tts_engine.generate(
-          text: script_path.read,
+          text: script_content,
           output_path: voiceover_path,
           log_path:
         )
@@ -294,9 +298,9 @@ module ScreenKit
           "#{prefix}-#{index}.{png,#{ContentType.video.join(',')}}"
         ).first
 
-        raise "Callout file not found for #{prefix}-#{index}" unless callout_path
+        return callout_path if callout_path
 
-        callout_path
+        raise "Callout file not found for #{prefix}-#{index}"
       end
 
       def video_callout?(callout_path)

data/lib/screenkit/exporter/video.rb

@@ -9,8 +9,12 @@ module ScreenKit
       # The path to the input video file.
       attr_reader :input_path
 
-      def initialize(input_path:)
+      # The path to the log file.
+      attr_reader :log_path
+
+      def initialize(input_path:, log_path: nil)
         @input_path = input_path
+        @log_path = log_path
       end
 
       def export(output_path)
@@ -26,7 +30,8 @@ module ScreenKit
                     "-r", "24",
                     "-c:v", "libx264",
                     "-y",
-                    output_path
+                    output_path,
+                    log_path:
       end
     end
   end

data/lib/screenkit/generators/episode/config.yml.erb

@@ -1,106 +1,11 @@
 ---
 # yaml-language-server: $schema=https://screenkit.dev/schemas/episode.json
 
-# The episode title. When there are no linebreaks, they will be inferred based
-# on the approximate text width.
-title: "CREATING SCREENCASTS WITH SCREENKIT"
-
-# Callouts are informational boxes that on the screen during the
-# video (also known as lower thirds).
-#
-# The project's configuration can define the callout structure, while the
-# episode configuration can define the content and timing.
-callouts_styles:
-  - type: info
-    title: "ScreenKit"
-    body: "Visit https://github.com/fnando/screenkit to learn more."
-    starts_at: 3
-    duration: 5
-    width: 600
-
-# The background music to be played during the episode.
-# When not set, the backtrack will be defined by using the project's
-# `backtrack_dir` configuration, and a track will be randomly selected.
-# To disable the backtrack entirely, use `backtrack: false`.
-# backtrack: resources/backtrack.mp3
-
-# Define episode-specific scene configurations.
-# When present, this will have higher precedence over the project's
-# configuration, so you can have different intro/outro for each episode.
-# 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: open-sans/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: images/logo.png
-#       x: 100
-#       y: 200
-#       width: 200
-#       height: 34
-#
-#     # 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: sounds/chime.mp3
-#
-#   outro:
-#     # The duration of the outro scene in seconds.
-#     duration: 3.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: sounds/chime.mp3
-#
-#     # The logo to be displayed in the video outro.
-#     logo:
-#       path: images/logo.png
-#       x: center
-#       y: center
-#       width: 500
-#
-#   segment:
-#     # The duration of the crossover transition between segments in seconds.
-#     crossfade_duration: 0.5
-
-# Define episode-specific voice configuration.
-# When present, this will have higher precedence over the project's
-# configuration, so you can have different intro/outro segments for each
-# episode.
-# tts:
-#   engine: elevenlabs
-#   voice_id: 56AoDkrOh6qfVPDXZ7Pt
-#   language_code: en
-#   voice_settings:
-#     speed: 0.9
-#     stability: 0.5
-#     similarity: 0.75
-#     style: 0.0
+# The episode title (displayed in intro scene).
+# Line breaks are inferred based on approximate text width.
+title: <%= options.title.to_yaml[4..] %>
+
+# Episode-specific overrides for global configuration.
+# Use an editor with JSON Schema support to see available options and
+# autocomplete.
+# Schema: https://screenkit.dev/schemas/episode.json

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

@@ -0,0 +1,48 @@
+---
+name: Screenkit
+
+on:
+  workflow_dispatch:
+    inputs:
+      episode:
+        type: string
+        description: "Episode number (e.g. 001)"
+        required: true
+      tts_preset:
+        description: "TTS preset name"
+        default: ""
+        type: choice
+        options:
+          - ""
+          - say
+          - espeak
+          - eleven_labs
+          - eleven_labs_mp3_192k
+      match:
+        type: string
+        description: "Match pattern for segments (e.g. 001)"
+        default: ""
+      overwrite:
+        type: boolean
+        description: "Regenerate files"
+
+jobs:
+  screenkit:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      actions: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Run Screenkit
+        uses: fnando/screenkit@v1
+        with:
+          episode: ${{ github.event.inputs.episode }}
+          tts_preset: ${{ github.event.inputs.tts_preset }}
+          tts_api_key: ${{ secrets.TTS_API_KEY }}
+          overwrite: ${{ github.event.inputs.overwrite }}
+          match: ${{ github.event.inputs.match }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}

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

@@ -84,23 +84,51 @@ watermark:
 # Each TTS engine has its own detection mechanism. For instance, say and espeak
 # checks for a binary with the same name. ElevenLabs checks for the presence of
 # `--tts-api-key`.
+#
+# You can have multiple presets for the same engine. Just set a different
+# configuration block using a different `id`. Then, when you're exporting the
+# video, you can use `--tts-preset <id>`. If you don't provide a preset, the
+# first available engine will be used.
 tts:
   # Apple Say TTS engine configuration.
-  - engine: say
+  - id: say
+    engine: say
+    rate: 150
+    enabled: true
+
+  # Apple Say TTS engine configuration.
+  - id: say_pt_br
+    engine: say
+    voice: "Luciana"
     rate: 150
     enabled: true
 
   # eSpeak TTS engine configuration.
-  - engine: espeak
+  - id: espeak
+    engine: espeak
     rate: 150
     voice: en-us
     enabled: true
 
   # Eleven Labs TTS engine configuration.
-  - engine: eleven_labs
+  - id: eleven_labs
+    engine: eleven_labs
+    enabled: true
+    voice_id: 56AoDkrOh6qfVPDXZ7Pt
+    language_code: en
+    voice_settings:
+      speed: 0.9
+      stability: 0.5
+      similarity: 0.75
+      style: 0.0
+
+  # Eleven Labs TTS engine configuration.
+  - id: eleven_labs_mp3_192k
+    engine: eleven_labs
     enabled: true
     voice_id: 56AoDkrOh6qfVPDXZ7Pt
     language_code: en
+    output_format: mp3_44100_192
     voice_settings:
       speed: 0.9
       stability: 0.5

data/lib/screenkit/generators/project.rb

@@ -22,6 +22,7 @@ module ScreenKit
       def copy_files
         copy_file "screenkit.yml"
         directory "resources", exclude_pattern: /DS_Store/
+        directory ".github", exclude_pattern: /DS_Store/
       end
 
       def bundle_install
@@ -32,6 +33,12 @@ module ScreenKit
         end
       end
 
+      def instructions
+        cmd = set_color("screenkit episode new --title TITLE", :blue)
+        path = set_color(destination_root, :blue)
+        say "\nTo create a new episode, run #{cmd} from #{path}"
+      end
+
       no_commands do
         # Add helper methods here
       end

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

@@ -7,9 +7,13 @@
     { "$ref": "../tts/elevenlabs.json" },
     {
       "type": "object",
-      "required": ["engine"],
+      "required": ["engine", "id"],
       "additionalProperties": true,
       "properties": {
+        "id": {
+          "type": "string",
+          "description": "A unique identifier for the tts configuration"
+        },
         "engine": {
           "type": "string",
           "description": "The TTS engine to use",

data/lib/screenkit/schemas/tts/elevenlabs.json

@@ -5,6 +5,10 @@
   "type": "object",
   "required": ["voice_id"],
   "properties": {
+    "id": {
+      "type": "string",
+      "description": "A unique identifier for the tts configuration"
+    },
     "enabled": {
       "type": "boolean"
     },

data/lib/screenkit/schemas/tts/espeak.json

@@ -4,6 +4,10 @@
   "title": "espeak synthesizer for English and other languages",
   "type": "object",
   "properties": {
+    "id": {
+      "type": "string",
+      "description": "A unique identifier for the tts configuration"
+    },
     "enabled": {
       "type": "boolean"
     },

data/lib/screenkit/schemas/tts/say.json

@@ -4,6 +4,10 @@
   "title": "The Apple `say` voice engine options",
   "type": "object",
   "properties": {
+    "id": {
+      "type": "string",
+      "description": "A unique identifier for the tts configuration"
+    },
     "enabled": {
       "type": "boolean"
     },

data/lib/screenkit/shell.rb

@@ -20,9 +20,9 @@ module ScreenKit
       !`which #{command}`.strip.empty?
     end
 
-    def run_command(command, *args, log_path: nil)
+    def run_command(command, *args, log_path: nil, **)
       args = args.flatten.compact.map(&:to_s)
-      stdout, stderr, status = Open3.capture3(command, *args)
+      stdout, stderr, status = Open3.capture3(command, *args, **)
       exit_code = status.exitstatus
 
       if exit_code&.nonzero?

data/lib/screenkit/tts/base.rb

@@ -3,18 +3,48 @@
 module ScreenKit
   module TTS
     class Base
+      require_relative "../core_ext"
+      require_relative "../schema_validator"
+
       extend SchemaValidator
 
+      using CoreExt
+
       # Additional options for the tts engine.
       attr_reader :options
 
-      def initialize(enabled: true, **options)
-        @enabled = enabled
+      # The preset name for the tts engine.
+      attr_reader :id
+
+      # The list of segments.
+      # This is available so that engines can contextually generate audio, for
+      # instance, by providing previous/next text (e.g. Eleven Labs).
+      attr_reader :segments
+
+      # The API key for the tts engine, if applicable.
+      attr_reader :api_key
+
+      # Detects if the tts engine is available.
+      def self.available?(**)
+        false
+      end
+
+      def self.engine_name
+        name.split("::").last.underscore
+      end
+
+      def initialize(id: nil, segments: nil, api_key: nil, **options)
+        @segments = Array(segments)
         @options = options
+        @id = id
+        @api_key = api_key
       end
 
-      def enabled?
-        @enabled
+      def redact_file(path, text)
+        return unless File.file?(path)
+
+        content = File.read(path).gsub(text, "[REDACTED]")
+        File.write(path, content)
       end
     end
   end

data/lib/screenkit/tts/eleven_labs.rb

@@ -8,21 +8,16 @@ module ScreenKit
                  .join("screenkit/schemas/tts/elevenlabs.json")
       end
 
-      # The Eleven Labs API key.
-      attr_reader :api_key
-
-      def initialize(api_key:, **)
-        super(**)
-        @api_key = api_key
+      def self.available?(api_key: nil, **)
+        api_key.to_s.empty?
       end
 
-      def available?
-        enabled? && !api_key.to_s.empty?
+      def all_texts
+        @all_texts ||= segments.map(&:script_content)
       end
 
       def generate(output_path:, text:, log_path: nil)
-        self.class.validate!(options)
-        voice_id = options.delete(:voice_id)
+        voice_id = options[:voice_id]
 
         if log_path
           File.open(log_path, "w") do |f|
@@ -32,9 +27,23 @@ module ScreenKit
 
         require "aitch"
 
+        Aitch.configure do |config|
+          config.logger = Logger.new(log_path) if log_path
+        end
+
+        current_index = all_texts.index { it == text }
+
+        if current_index
+          previous_text = all_texts[current_index - 1]
+          next_text = all_texts[current_index + 1]
+        end
+
+        params = options.merge(text:, previous_text:, next_text:)
+                        .except(:voice_id)
+
         response = Aitch.post(
           url: "https://api.elevenlabs.io/v1/text-to-speech/#{voice_id}",
-          body: JSON.dump(options.merge(text:)),
+          body: JSON.dump(params),
           options: {expect: 200},
           headers: {
             "content-type": "application/json",
@@ -44,6 +53,8 @@ module ScreenKit
         )
 
         File.binwrite(output_path, response.body)
+      ensure
+        redact_file(log_path, api_key)
       end
     end
   end

data/lib/screenkit/tts/espeak.rb

@@ -3,14 +3,14 @@
 module ScreenKit
   module TTS
     class Espeak < Base
-      include Shell
+      extend Shell
 
-      def self.schema_path
-        ScreenKit.root_dir.join("screenkit/schemas/tts/espeak.json")
+      def self.available?(**)
+        command_exist?("espeak")
       end
 
-      def available?
-        enabled? && command_exist?("espeak")
+      def self.schema_path
+        ScreenKit.root_dir.join("screenkit/schemas/tts/espeak.json")
       end
 
       def generate(text:, output_path:, log_path: nil)
@@ -18,12 +18,12 @@ module ScreenKit
 
         {voice: nil, rate: nil}.merge(options) => {voice:, rate:}
 
-        run_command "espeak",
-                    (["-v", voice] if voice),
-                    (["-s", rate] if rate),
-                    "-w", output_path.sub_ext(".wav"),
-                    text,
-                    log_path:
+        self.class.run_command "espeak",
+                               (["-v", voice] if voice),
+                               (["-s", rate] if rate),
+                               "-w", output_path.sub_ext(".wav"),
+                               text,
+                               log_path:
       end
     end
   end

data/lib/screenkit/tts/say.rb

@@ -3,14 +3,14 @@
 module ScreenKit
   module TTS
     class Say < Base
-      include Shell
+      extend Shell
 
       def self.schema_path
         ScreenKit.root_dir.join("screenkit/schemas/tts/say.json")
       end
 
-      def available?
-        enabled? && command_exist?("say")
+      def self.available?(**)
+        command_exist?("say")
       end
 
       def generate(text:, output_path:, log_path: nil)
@@ -18,12 +18,12 @@ module ScreenKit
 
         {voice: nil, rate: nil}.merge(options) => {voice:, rate:}
 
-        run_command "say",
-                    (["-v", voice] if voice),
-                    (["-r", rate] if rate),
-                    "-o", output_path.sub_ext(".aiff"),
-                    text,
-                    log_path:
+        self.class.run_command "say",
+                               (["-v", voice] if voice),
+                               (["-r", rate] if rate),
+                               "-o", output_path.sub_ext(".aiff"),
+                               text,
+                               log_path:
       end
     end
   end

data/lib/screenkit/utils.rb

@@ -2,7 +2,7 @@
 
 module ScreenKit
   module Utils
-    def has_audio?(path)
+    def has_audio?(path) #  rubocop:disable Naming/PredicatePrefix
       cmd = "ffprobe -v error -select_streams a:0 -show_entries " \
             "stream=codec_type -of default=noprint_wrappers=1:nokey=1"
       `#{cmd} #{path}`.strip == "audio"

data/lib/screenkit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ScreenKit
-  VERSION = "0.0.5"
+  VERSION = "0.0.7"
 end

data/lib/screenkit.rb

@@ -1,3 +1,79 @@
 # frozen_string_literal: true
 
-require_relative "screen_kit"
+require "thor"
+require "thor/completion"
+require "yaml"
+require "json-schema"
+require "mini_magick"
+require "pathname"
+require "tty-spinner"
+require "etc"
+require "securerandom"
+require "demo_tape/duration"
+
+module ScreenKit
+  require_relative "screenkit/version"
+  require_relative "screenkit/duration"
+  require_relative "screenkit/core_ext"
+  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"
+  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/callout/styles/base"
+  require_relative "screenkit/transition"
+  require_relative "screenkit/parallel_processor"
+  require_relative "screenkit/cli"
+  require_relative "screenkit/cli/base"
+  require_relative "screenkit/cli/episode"
+  require_relative "screenkit/cli/root"
+  require_relative "screenkit/animation_filters"
+  require_relative "screenkit/tts/base"
+  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"
+
+  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
+
+  # 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)
+end