screenkit 0.0.0

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

@@ -0,0 +1,26 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://github.com/fnando/screenkit/schemas/refs/logo.json",
+  "title": "Logo",
+  "type": "object",
+  "required": ["path"],
+  "allOf": [
+    { "$ref": "position.json" },
+    {
+      "width": {
+        "type": "integer",
+        "description": "Width of the logo (height is calculated proportionally)",
+        "minimum": 1
+      }
+    },
+
+    {
+      "path": {
+        "type": "string",
+        "description": "Path to the logo image file",
+        "minLength": 1,
+        "pattern": "\\S"
+      }
+    }
+  ]
+}

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

@@ -0,0 +1,26 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://github.com/fnando/screenkit/schemas/refs/outro.json",
+  "title": "Outro",
+  "required": ["logo"],
+  "properties": {
+    "background": { "$ref": "background.json" },
+    "logo": { "$ref": "logo.json" },
+    "sound": { "$ref": "sound.json" },
+    "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
+    }
+  }
+}

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

@@ -0,0 +1,38 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://github.com/fnando/screenkit/schemas/refs/position.json",
+  "title": "Position",
+  "type": "object",
+  "properties": {
+    "x": {
+      "oneOf": [
+        {
+          "type": "integer",
+          "description": "X coordinate in pixels",
+          "minimum": 0,
+          "default": 0
+        },
+        {
+          "type": "string",
+          "enum": ["center"],
+          "description": "Center horizontally"
+        }
+      ]
+    },
+    "y": {
+      "oneOf": [
+        {
+          "type": "integer",
+          "description": "Y coordinate in pixels",
+          "minimum": 0,
+          "default": 0
+        },
+        {
+          "type": "string",
+          "enum": ["center"],
+          "description": "Center vertically"
+        }
+      ]
+    }
+  }
+}

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

@@ -0,0 +1,27 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://github.com/fnando/screenkit/schemas/refs/scenes.json",
+  "title": "Scenes",
+  "type": "object",
+  "required": ["intro", "outro", "segment"],
+  "properties": {
+    "intro": {
+      "$ref": "intro.json"
+    },
+    "outro": {
+      "$ref": "outro.json"
+    },
+    "segment": {
+      "type": "object",
+      "description": "Main content scene configuration",
+      "required": ["crossfade_duration"],
+      "properties": {
+        "crossfade_duration": {
+          "type": "number",
+          "description": "Duration of the crossover transition between segments in seconds",
+          "minimum": 0
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://github.com/fnando/screenkit/schemas/refs/size.json",
+  "title": "Size",
+  "type": "object",
+  "required": ["width", "height"],
+  "properties": {
+    "width": {
+      "type": "number",
+      "description": "Width in pixels",
+      "minimum": 1
+    },
+    "height": {
+      "type": "number",
+      "description": "Height in pixels",
+      "minimum": 1
+    }
+  }
+}

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

@@ -0,0 +1,36 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://github.com/fnando/screenkit/schemas/refs/sound.json",
+  "title": "Sound",
+  "oneOf": [
+    {
+      "type": "boolean",
+      "enum": [false],
+      "description": "No sound"
+    },
+    {
+      "type": "string",
+      "format": "uri",
+      "description": "Path to the sound file"
+    },
+    {
+      "type": "object",
+      "required": ["path"],
+      "properties": {
+        "volume": {
+          "type": "number",
+          "description": "The sound volume level",
+          "minimum": 0.0,
+          "maximum": 1.0,
+          "default": 1.0
+        },
+        "path": {
+          "type": "string",
+          "description": "Path to the sound file",
+          "minLength": 1,
+          "pattern": "\\S"
+        }
+      }
+    }
+  ]
+}

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

@@ -0,0 +1,22 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://github.com/fnando/screenkit/schemas/refs/spacing.json",
+  "title": "Spacing (Padding/Margin)",
+  "oneOf": [
+    {
+      "type": "integer",
+      "description": "Uniform spacing value applied to all sides",
+      "minimum": 0
+    },
+    {
+      "type": "array",
+      "description": "Spacing values [top, right, bottom, left]",
+      "items": {
+        "type": "integer",
+        "minimum": 0
+      },
+      "minItems": 1,
+      "maxItems": 4
+    }
+  ]
+}

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

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://github.com/fnando/screenkit/schemas/refs/text_style.json",
+  "title": "Text Style",
+  "properties": {
+    "font_path": {
+      "type": "string",
+      "format": "uri"
+    },
+    "size": {
+      "type": "integer",
+      "minimum": 1
+    },
+    "color": {
+      "$ref": "color.json"
+    }
+  }
+}

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

@@ -0,0 +1,15 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://github.com/fnando/screenkit/schemas/refs/transition.json",
+  "type": "object",
+  "title": "Transition",
+  "required": ["duration", "sound"],
+  "properties": {
+    "sound": { "$ref": "sound.json" },
+    "duration": {
+      "type": "number",
+      "description": "Transition duration in seconds",
+      "minimum": 0
+    }
+  }
+}

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

@@ -0,0 +1,47 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://github.com/fnando/screenkit/schemas/refs/tts.json",
+  "title": "The TTS engine used for voiceover",
+  "oneOf": [
+    {
+      "type": "boolean",
+      "enum": [false]
+    },
+    {
+      "type": "object",
+      "$ref": "../tts/say.json",
+      "properties": {
+        "engine": {
+          "type": "string",
+          "enum": ["say"],
+          "description": "The TTS engine to use"
+        }
+      }
+    },
+    {
+      "type": "object",
+      "$ref": "../tts/elevenlabs.json",
+      "properties": {
+        "engine": {
+          "type": "string",
+          "enum": ["elevenlabs"],
+          "description": "The TTS engine to use"
+        }
+      }
+    },
+    {
+      "type": "object",
+      "required": ["engine"],
+      "additionalProperties": true,
+      "properties": {
+        "engine": {
+          "type": "string",
+          "description": "The TTS engine to use",
+          "not": {
+            "enum": ["say", "elevenlabs"]
+          }
+        }
+      }
+    }
+  ]
+}

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

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://github.com/fnando/screenkit/schemas/project.json",
+  "title": "Watermark",
+  "oneOf": [
+    { "type": "boolean", "enum": [false] },
+    { "type": "string", "format": "uri" },
+    {
+      "type": "object",
+      "properties": {
+        "path": { "type": "string", "format": "uri" },
+        "anchor": { "$ref": "anchor.json" },
+        "position": { "$ref": "position.json" },
+        "opacity": { "type": "number", "minimum": 0, "maximum": 1 }
+      }
+    }
+  ]
+}

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

@@ -0,0 +1,67 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://github.com/fnando/screenkit/schemas/tts/elevenlabs.json",
+  "title": "The ElevenLabs voice engine options",
+  "type": "object",
+  "required": ["voice_id"],
+  "properties": {
+    "voice_id": { "type": "string" },
+    "output_format": {
+      "type": "string",
+      "enum": [
+        "mp3_22050_32",
+        "mp3_24000_48",
+        "mp3_44100_32",
+        "mp3_44100_64",
+        "mp3_44100_96",
+        "mp3_44100_128",
+        "mp3_44100_192",
+        "pcm_8000",
+        "pcm_16000",
+        "pcm_22050",
+        "pcm_24000",
+        "pcm_32000",
+        "pcm_44100",
+        "pcm_48000",
+        "ulaw_8000",
+        "alaw_8000",
+        "opus_48000_32",
+        "opus_48000_64",
+        "opus_48000_96",
+        "opus_48000_128",
+        "opus_48000_192"
+      ]
+    },
+    "model_id": { "type": "string" },
+    "language_code": {
+      "type": "string",
+      "minLength": 2,
+      "maxLength": 2,
+      "pattern": "\\S+"
+    },
+    "previous_text": { "type": "string" },
+    "next_text": { "type": "string" },
+    "previous_request_ids": { "type": "array", "items": { "type": "string" } },
+    "next_request_ids": { "type": "array", "items": { "type": "string" } },
+    "voice_settings": {
+      "type": "object",
+      "properties": {
+        "stability": {
+          "type": "number",
+          "minimum": 0,
+          "maximum": 1
+        },
+        "similarity_boost": {
+          "type": "number",
+          "minimum": 0,
+          "maximum": 1
+        }
+      },
+      "style": {
+        "type": "integer",
+        "minimum": 0
+      },
+      "speed": { "type": "number" }
+    }
+  }
+}

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

@@ -0,0 +1,16 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "https://github.com/fnando/screenkit/schemas/tts/say.json",
+  "title": "The Apple `say` voice engine options",
+  "type": "object",
+  "properties": {
+    "voice": {
+      "description": "The voice to use",
+      "oneOf": [{ "type": "null" }, { "type": "string" }]
+    },
+    "rate": {
+      "description": "The speaking rate (words per minute)",
+      "oneOf": [{ "type": "null" }, { "type": "number", "pattern": "/^\\d+$/" }]
+    }
+  }
+}

data/lib/screenkit/shell.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module ScreenKit
+  module Shell
+    Error = Class.new(StandardError) do
+      attr_reader :stdout, :stderr, :command, :args
+
+      def initialize(message, stdout:, stderr:, command:, args:)
+        super(message)
+        @stdout = stdout
+        @stderr = stderr
+        @command = command
+        @args = args
+      end
+    end
+
+    def run_command(command, *args, log_path: nil)
+      args = args.flatten.compact.map(&:to_s)
+      stdout, stderr, status = Open3.capture3(command, *args)
+      exit_code = status.exitstatus
+
+      if exit_code&.nonzero?
+        output = [command, *args].join(" ")
+        $stderr << "Command failed: #{output}\n"
+        $stderr << "#{stdout}\n" unless stdout.empty?
+        $stderr << "#{stderr}\n" unless stderr.empty?
+
+        raise Error.new(
+          "#{command.inspect} failed with exit=#{exit_code}",
+          stdout:,
+          stderr:,
+          command:,
+          args:
+        )
+      end
+
+      [stdout, stderr]
+    ensure
+      if log_path
+        header = ->(text) { ("=" * 10) + " #{text} " + ("=" * 10) }
+
+        File.open(log_path, "w") do |f|
+          f << "#{header.call('COMMAND')}\n\n"
+          f << "#{[command, *args].join(' ')}\n\n"
+
+          f << "#{header.call('EXIT CODE')}\n\n"
+          f << "#{exit_code}\n\n"
+
+          f << "#{header.call('STDOUT')}\n\n"
+          f << "#{stdout}\n\n"
+
+          f << "#{header.call('STDERR')}\n\n"
+          f << "#{stderr}\n"
+        end
+      end
+    end
+  end
+end

data/lib/screenkit/sound.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module ScreenKit
+  class Sound
+    # The requested sound file path.
+    # @return [Pathname]
+    attr_reader :path
+
+    # The volume level for the sound.
+    # @return [Float]
+    attr_reader :volume
+
+    # Initializes a new Sound instance.
+    #
+    # @param input [Pathname|FalseClass|Hash] The sound configuration. It will
+    # be denormalized to all the proper attributes.
+    # @return [void]
+    def initialize(input:, source:)
+      @volume = 1.0
+
+      case input
+      when FalseClass, nil
+        @path = ScreenKit.root_dir.join("screenkit/resources/mute.mp3")
+      when Hash
+        {path: nil, volume: 1.0}.merge(input) => {path:, volume:}
+        @path = Pathname(path)
+        @volume = volume
+      else
+        @path = Pathname(input)
+      end
+
+      return if @path.absolute?
+      return if @path.file?
+
+      candidate = source.search(@path)
+
+      @path = if candidate.file?
+                candidate
+              else
+                candidate.glob("**/*.{#{ContentType.audio.join(',')}}").sample
+              end
+    end
+  end
+end

data/lib/screenkit/spacing.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ScreenKit
+  class Spacing
+    attr_reader :top, :right, :bottom, :left
+
+    def initialize(value)
+      @top, @right, @bottom, @left = (Array(value) * 4).take(4)
+    end
+
+    def horizontal
+      right + left
+    end
+
+    def vertical
+      top + bottom
+    end
+
+    def as_json(*)
+      [top, right, bottom, left]
+    end
+  end
+end

data/lib/screenkit/spinner.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ScreenKit
+  class Spinner
+    attr_reader :phrase
+
+    def initialize(phrases: [])
+      @phrases = phrases
+      @shell = Thor::Shell::Color.new
+      @phrase = @phrases.sample
+      @spinner = create_spinner
+      update(@phrase)
+    end
+
+    def create_spinner
+      TTY::Spinner.new(
+        "           :spinner  :title",
+        frames: [
+          @shell.set_color("◉", :white),
+          @shell.set_color("◎", :white),
+          @shell.set_color("∙", :white)
+        ],
+        interval: 3,
+        clear: true,
+        hide_cursor: true
+      ).tap(&:auto_spin)
+    end
+
+    def update(phrase)
+      @spinner ||= create_spinner
+      @spinner.update(title: @shell.set_color(phrase, :white))
+    end
+
+    def stop
+      @spinner&.stop
+      @spinner = nil
+    end
+  end
+end

data/lib/screenkit/transition.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ScreenKit
+  class Transition
+    attr_reader :duration, :sound
+
+    def initialize(duration:, sound:)
+      @duration = duration
+      @sound = sound
+    end
+
+    def as_json(*)
+      {duration:, sound:}
+    end
+  end
+end

data/lib/screenkit/tts/eleven_labs.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module ScreenKit
+  module VoiceEngines
+    class TTS
+      extend SchemaValidator
+
+      def self.schema_path
+        ScreenKit.root_dir
+                 .join("screenkit/schemas/tts/elevenlabs.json")
+      end
+
+      # 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)
+        @api_key = api_key
+        @options = options
+      end
+
+      def generate(output_path:, text:, log_path: nil)
+        self.class.validate!(options)
+        voice_id = options.delete(:voice_id)
+
+        if log_path
+          File.open(log_path, "w") do |f|
+            f << JSON.pretty_generate(options.merge(text:))
+          end
+        end
+
+        require "aitch"
+
+        response = Aitch.post(
+          url: "https://api.elevenlabs.io/v1/text-to-speech/#{voice_id}",
+          body: JSON.dump(options.merge(text:)),
+          options: {expect: 200},
+          headers: {
+            "content-type": "application/json",
+            "user-agent": "ScreenKit/#{ScreenKit::VERSION}",
+            "xi-api-key": api_key
+          }
+        )
+
+        File.binwrite(output_path, response.body)
+      end
+    end
+  end
+end

data/lib/screenkit/tts/say.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ScreenKit
+  module TTS
+    class Say
+      include Shell
+      extend SchemaValidator
+
+      def self.schema_path
+        ScreenKit.root_dir.join("screenkit/schemas/tts/say.json")
+      end
+
+      def initialize(**options)
+        @options = options
+      end
+
+      def generate(text:, output_path:, log_path: nil)
+        self.class.validate!(@options)
+
+        {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:
+      end
+    end
+  end
+end