screenkit 0.0.1 → 0.0.2

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

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/project.json",
+  "$id": "https://screenkit.dev/schemas/refs/project.json",
   "title": "Watermark",
   "oneOf": [
     { "type": "boolean", "enum": [false] },

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

@@ -1,10 +1,19 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/tts/elevenlabs.json",
+  "$id": "https://screenkit.dev/schemas/tts/elevenlabs.json",
   "title": "The ElevenLabs voice engine options",
   "type": "object",
-  "required": ["voice_id"],
+  "required": ["voice_id", "engine"],
+  "additionalProperties": false,
   "properties": {
+    "enabled": {
+      "type": "boolean"
+    },
+    "engine": {
+      "type": "string",
+      "enum": ["eleven_labs"],
+      "description": "The TTS engine to use"
+    },
     "voice_id": { "type": "string" },
     "output_format": {
       "type": "string",

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

@@ -0,0 +1,26 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://screenkit.dev/schemas/tts/espeak.json",
+  "title": "espeak synthesizer for English and other languages",
+  "type": "object",
+  "required": ["engine"],
+  "additionalProperties": false,
+  "properties": {
+    "enabled": {
+      "type": "boolean"
+    },
+    "engine": {
+      "type": "string",
+      "enum": ["espeak"],
+      "description": "The TTS engine to use"
+    },
+    "voice": {
+      "description": "The voice to use",
+      "oneOf": [{ "type": "null" }, { "type": "string" }]
+    },
+    "rate": {
+      "description": "The speaking rate (words per minute)",
+      "oneOf": [{ "type": "null" }, { "type": "integer" }]
+    }
+  }
+}

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

@@ -1,9 +1,19 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "$id": "https://github.com/fnando/screenkit/schemas/tts/say.json",
+  "$id": "https://screenkit.dev/schemas/tts/say.json",
   "title": "The Apple `say` voice engine options",
   "type": "object",
+  "additionalProperties": false,
+  "required": ["engine"],
   "properties": {
+    "enabled": {
+      "type": "boolean"
+    },
+    "engine": {
+      "type": "string",
+      "enum": ["say"],
+      "description": "The TTS engine to use"
+    },
     "voice": {
       "description": "The voice to use",
       "oneOf": [{ "type": "null" }, { "type": "string" }]

data/lib/screenkit/shell.rb

@@ -14,6 +14,12 @@ module ScreenKit
       end
     end
 
+    # Checks if a command exists in the system's PATH.
+    # Right now we're completely ignoring Windows (unless it's running on WSL).
+    def command_exist?(command)
+      !`which #{command}`.strip.empty?
+    end
+
     def run_command(command, *args, log_path: nil)
       args = args.flatten.compact.map(&:to_s)
       stdout, stderr, status = Open3.capture3(command, *args)

data/lib/screenkit/time_formatter.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ScreenKit
+  class TimeFormatter
+    def self.parse(input)
+      return input if input.is_a?(Numeric)
+
+      hour, minute, second = ([0, 0, 0] + input.to_s.split(":"))[-3..-1]
+                             .map(&:to_i)
+
+      (hour * 3600) + (minute * 60) + second
+    end
+  end
+end

data/lib/screenkit/tts/base.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ScreenKit
+  module TTS
+    class Base
+      extend SchemaValidator
+
+      # Additional options for the tts engine.
+      attr_reader :options
+
+      def initialize(enabled: true, **options)
+        @enabled = enabled
+        @options = options
+      end
+
+      def enabled?
+        @enabled
+      end
+    end
+  end
+end

data/lib/screenkit/tts/eleven_labs.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
 module ScreenKit
-  module VoiceEngines
-    class TTS
-      extend SchemaValidator
-
+  module TTS
+    class ElevenLabs < Base
       def self.schema_path
         ScreenKit.root_dir
                  .join("screenkit/schemas/tts/elevenlabs.json")
@@ -13,12 +11,13 @@ module ScreenKit
       # The Eleven Labs API key.
       attr_reader :api_key
 
-      # Additional options for the Eleven Labs voice engine.
-      attr_reader :options
-
-      def initialize(api_key:, **options)
+      def initialize(api_key:, **)
+        super(**)
         @api_key = api_key
-        @options = options
+      end
+
+      def available?
+        enabled? && !api_key.to_s.empty?
       end
 
       def generate(output_path:, text:, log_path: nil)

data/lib/screenkit/tts/espeak.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ScreenKit
+  module TTS
+    class Espeak < Base
+      include Shell
+
+      def self.schema_path
+        ScreenKit.root_dir.join("screenkit/schemas/tts/espeak.json")
+      end
+
+      def available?
+        enabled? && command_exist?("espeak")
+      end
+
+      def generate(text:, output_path:, log_path: nil)
+        self.class.validate!(options)
+
+        {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:
+      end
+    end
+  end
+end

data/lib/screenkit/tts/say.rb

@@ -2,22 +2,21 @@
 
 module ScreenKit
   module TTS
-    class Say
+    class Say < Base
       include Shell
-      extend SchemaValidator
 
       def self.schema_path
         ScreenKit.root_dir.join("screenkit/schemas/tts/say.json")
       end
 
-      def initialize(**options)
-        @options = options
+      def available?
+        enabled? && command_exist?("say")
       end
 
       def generate(text:, output_path:, log_path: nil)
-        self.class.validate!(@options)
+        self.class.validate!(options)
 
-        {voice: nil, rate: nil}.merge(@options) => {voice:, rate:}
+        {voice: nil, rate: nil}.merge(options) => {voice:, rate:}
 
         run_command "say",
                     (["-v", voice] if voice),

data/lib/screenkit/utils.rb

@@ -2,6 +2,12 @@
 
 module ScreenKit
   module Utils
+    def has_audio?(path)
+      cmd = "ffprobe -v error -select_streams a:0 -show_entries " \
+            "stream=codec_type -of default=noprint_wrappers=1:nokey=1"
+      `#{cmd} #{path}`.strip == "audio"
+    end
+
     def fps(path)
       cmd = "ffprobe -v error -select_streams v:0 -show_entries " \
             "stream=r_frame_rate -of default=noprint_wrappers=1:nokey=1"

data/lib/screenkit/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: screenkit
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nando Vieira
@@ -262,13 +262,16 @@ files:
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/dependabot.yml"
+- ".github/workflows/docker.yml"
 - ".github/workflows/ruby-tests.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- Brewfile
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - DOCUMENTATION.md
+- Dockerfile
 - Gemfile
 - LICENSE.md
 - README.md
@@ -283,8 +286,9 @@ files:
 - lib/screenkit/banner.rb
 - lib/screenkit/callout.rb
 - lib/screenkit/callout/styles/base.rb
-- lib/screenkit/callout/styles/default.rb
+- lib/screenkit/callout/styles/file_copy.rb
 - lib/screenkit/callout/styles/inline_block.rb
+- lib/screenkit/callout/styles/shadow_block.rb
 - lib/screenkit/callout/text_style.rb
 - lib/screenkit/cli.rb
 - lib/screenkit/cli/base.rb
@@ -305,6 +309,7 @@ files:
 - lib/screenkit/exporter/segment.rb
 - lib/screenkit/exporter/video.rb
 - lib/screenkit/generators/episode.rb
+- lib/screenkit/generators/episode/callouts/001.yml
 - lib/screenkit/generators/episode/config.yml.erb
 - lib/screenkit/generators/episode/content/001.tape
 - lib/screenkit/generators/episode/scripts/001.txt
@@ -312,42 +317,8 @@ files:
 - lib/screenkit/generators/project/Gemfile.erb
 - lib/screenkit/generators/project/resources/backtracks/default.aac
 - lib/screenkit/generators/project/resources/fonts/open-sans/OFL.txt
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans-Bold.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans-BoldItalic.ttf
 - lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans-ExtraBold.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans-ExtraBoldItalic.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans-Italic.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans-Light.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans-LightItalic.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans-Medium.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans-MediumItalic.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans-Regular.ttf
 - lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans-SemiBold.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans-SemiBoldItalic.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans_Condensed-Bold.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans_Condensed-BoldItalic.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans_Condensed-ExtraBold.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans_Condensed-ExtraBoldItalic.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans_Condensed-Italic.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans_Condensed-Light.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans_Condensed-LightItalic.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans_Condensed-Medium.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans_Condensed-MediumItalic.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans_Condensed-Regular.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans_Condensed-SemiBold.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans_Condensed-SemiBoldItalic.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans_SemiCondensed-Bold.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans_SemiCondensed-BoldItalic.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans_SemiCondensed-ExtraBold.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans_SemiCondensed-ExtraBoldItalic.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans_SemiCondensed-Italic.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans_SemiCondensed-Light.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans_SemiCondensed-LightItalic.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans_SemiCondensed-Medium.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans_SemiCondensed-MediumItalic.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans_SemiCondensed-Regular.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans_SemiCondensed-SemiBold.ttf
-- lib/screenkit/generators/project/resources/fonts/open-sans/OpenSans_SemiCondensed-SemiBoldItalic.ttf
 - lib/screenkit/generators/project/resources/fonts/open-sans/README.txt
 - lib/screenkit/generators/project/resources/images/logo.png
 - lib/screenkit/generators/project/resources/images/watermark.png
@@ -361,14 +332,17 @@ files:
 - lib/screenkit/resources/mute.mp3
 - lib/screenkit/resources/transparent.png
 - lib/screenkit/schema_validator.rb
-- lib/screenkit/schemas/callouts/default.json
+- lib/screenkit/schemas/callout_styles/file_copy.json
+- lib/screenkit/schemas/callout_styles/inline_block.json
+- lib/screenkit/schemas/callout_styles/shadow_block.json
 - lib/screenkit/schemas/callouts/inline_block.json
+- lib/screenkit/schemas/callouts/shadow_block.json
 - lib/screenkit/schemas/episode.json
 - lib/screenkit/schemas/project.json
 - lib/screenkit/schemas/refs/anchor.json
 - lib/screenkit/schemas/refs/animation.json
 - lib/screenkit/schemas/refs/background.json
-- lib/screenkit/schemas/refs/callout.json
+- lib/screenkit/schemas/refs/callout_style.json
 - lib/screenkit/schemas/refs/color.json
 - lib/screenkit/schemas/refs/demotape.json
 - lib/screenkit/schemas/refs/demotape_themes.json
@@ -385,15 +359,20 @@ files:
 - lib/screenkit/schemas/refs/text_style.json
 - lib/screenkit/schemas/refs/transition.json
 - lib/screenkit/schemas/refs/tts.json
+- lib/screenkit/schemas/refs/tts_builtin.json
 - lib/screenkit/schemas/refs/watermark.json
 - lib/screenkit/schemas/tts/elevenlabs.json
+- lib/screenkit/schemas/tts/espeak.json
 - lib/screenkit/schemas/tts/say.json
 - lib/screenkit/shell.rb
 - lib/screenkit/sound.rb
 - lib/screenkit/spacing.rb
 - lib/screenkit/spinner.rb
+- lib/screenkit/time_formatter.rb
 - lib/screenkit/transition.rb
+- lib/screenkit/tts/base.rb
 - lib/screenkit/tts/eleven_labs.rb
+- lib/screenkit/tts/espeak.rb
 - lib/screenkit/tts/say.rb
 - lib/screenkit/utils.rb
 - lib/screenkit/version.rb
@@ -406,10 +385,10 @@ metadata:
   rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/fnando/screenkit
   bug_tracker_uri: https://github.com/fnando/screenkit/issues
-  source_code_uri: https://github.com/fnando/screenkit/tree/v0.0.1
-  changelog_uri: https://github.com/fnando/screenkit/tree/v0.0.1/CHANGELOG.md
-  documentation_uri: https://github.com/fnando/screenkit/tree/v0.0.1/README.md
-  license_uri: https://github.com/fnando/screenkit/tree/v0.0.1/LICENSE.md
+  source_code_uri: https://github.com/fnando/screenkit/tree/v0.0.2
+  changelog_uri: https://github.com/fnando/screenkit/tree/v0.0.2/CHANGELOG.md
+  documentation_uri: https://github.com/fnando/screenkit/tree/v0.0.2/README.md
+  license_uri: https://github.com/fnando/screenkit/tree/v0.0.2/LICENSE.md
 rdoc_options: []
 require_paths:
 - lib