viddl 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 754721cccbe03abc4baaaeeb3cc7b4a466ff792b
+  data.tar.gz: 4aaddeaa7ff0dcd5bdedd75e81168671a640e528
+SHA512:
+  metadata.gz: d0ac5e272ff2b62a0db0e2de646c85450ad802a1b9248216966f1421a3fdcaa555ca4938c867629bc09756945915f787e59976195147852941bc0823cc1ac5c8
+  data.tar.gz: 81f1c6314ab103b92c6bead41880835dc5eb4afebe9362d09f6881d35cc9fb4122b8b82604745b426364dfe7ec8d410ce14fa1f725d965e696451fa4d143fd8f

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2017 Ari Russo
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,100 @@
+# Viddl
+
+![Viddl](http://i.imgur.com/OuHviqv.png "Viddl")
+
+Use Viddl to quickly download, cut, crop and resize videos
+
+Viddl can be used at the [command line](#command-line) or in [Ruby](#ruby)
+
+It requires that both [youtube-dl](https://github.com/rg3/youtube-dl) and [ffmpeg](https://ffmpeg.org) are installed before using.
+
+## Usage
+
+Running Viddl generates video clip files in the current directory
+
+### Command Line
+
+The command line usage and options are as follows:
+
+#### Download
+
+With no options, Viddl will download the original video
+
+```sh
+viddl https://www.youtube.com/watch?v=6g4dkBF5anU
+```
+
+#### Cut
+
+This will start the clip at 10 seconds into the original video and run for five seconds
+
+```sh
+viddl https://www.youtube.com/watch?v=6g4dkBF5anU -s 10 -d 5
+```
+
+Alternately, this will start the clip at 15 seconds in the original video and stop at 22 seconds
+
+```sh
+viddl https://www.youtube.com/watch?v=6g4dkBF5anU -s 15 -e 22
+```
+
+#### Resize
+
+This will resize to 640 x 480:
+
+```sh
+viddl https://www.youtube.com/watch?v=6g4dkBF5anU -w 640 -h 480
+```
+
+#### Crop
+
+This will crop a 40 x 40 pixel box at position 20 x 20:
+
+```sh
+viddl https://www.youtube.com/watch?v=6g4dkBF5anU --cx 20 --cy 20 --cw 40 --ch 40
+```
+
+#### Strip Audio
+
+Audio can be left out of the clip:
+
+```sh
+viddl https://www.youtube.com/watch?v=6g4dkBF5anU --no-audio
+```
+
+#### Combine
+
+Any or all of these options can be used together:
+
+```sh
+viddl https://www.youtube.com/watch?v=6g4dkBF5anU -s 15 -e 22 --no-audio --cx 20 --cy 20 --cw 40 --ch 40 -w 640 -h 480
+```
+
+### Ruby
+
+Similar to the command line, Ruby usage and options are as follows:
+
+```ruby
+options = {
+  start: 15,
+  end: 22,
+  audio: false,
+  crop: {
+    x: 20,
+    y: 20,
+    width: 40,
+    height: 40
+  },
+  width: 640,
+  height: 480
+}
+
+video = Viddl::Video.download("https://www.youtube.com/watch?v=6g4dkBF5anU")
+video.create_clip(options)
+```
+
+## License
+
+Licensed under Apache 2.0, See the file LICENSE
+
+Copyright (c) 2017 [Ari Russo](http://arirusso.com)

data/bin/viddl

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require "optparse"
+require "viddl"
+
+def help(opts)
+  puts(opts)
+  exit
+end
+
+options = {}
+opts = OptionParser.new do |opts|
+  opts.banner = "Usage: viddl [url] [options]"
+
+  ## cut
+
+  opts.on("-dDURATION", "--duration=DURATION", "Duration") do |duration|
+    options[:duration] = duration.to_f
+  end
+
+  opts.on("-eEND", "--end=END", "End time") do |en|
+    options[:end] = en.to_f
+  end
+
+  opts.on("-sSTART", "--start=START", "Start time") do |start|
+    options[:start] = start.to_f
+  end
+
+  # resize
+
+  opts.on("-wWIDTH", "--width=WIDTH", "Width") do |width|
+    options[:width] = width.to_i
+  end
+
+  opts.on("-hHEIGHT", "--height=HEIGHT", "Height") do |height|
+    options[:height] = height.to_i
+  end
+
+  # crop
+
+  opts.on("--cx=CX", "Crop X") do |cx|
+    options[:crop] ||= {}
+    options[:crop][:x] = cx.to_i
+  end
+
+  opts.on("--cy=CY", "Crop Y") do |cy|
+    options[:crop] ||= {}
+    options[:crop][:y] = cy.to_i
+  end
+
+  opts.on("--cw=CWIDTH", "Crop Width") do |cwidth|
+    options[:crop] ||= {}
+    options[:crop][:width] = cwidth.to_i
+  end
+
+  opts.on("--ch=CHEIGHT", "Crop Height") do |cheight|
+    options[:crop] ||= {}
+    options[:crop][:height] = cheight.to_i
+  end
+
+  # audio
+
+  opts.on("--no-audio", "No audio") do
+    options[:audio] = false
+  end
+
+  opts.on_tail("--help", "Show this message") { help(opts) }
+
+end
+opts.parse!
+
+url = ARGV[0]
+
+if url.nil?
+  help(opts) and exit
+end
+
+video = Viddl::Video.download(url)
+video.create_clip(options)

data/lib/viddl.rb

@@ -0,0 +1,19 @@
+#
+# viddl
+#
+# (c)2017 Ari Russo
+# Apache 2.0 License
+# https://github.com/arirusso/viddl
+#
+
+# modules
+require "viddl/system"
+require "viddl/video"
+
+module Viddl
+
+  extend self
+
+  VERSION = "0.0.2"
+
+end

data/lib/viddl/system.rb

@@ -0,0 +1,38 @@
+module Viddl
+
+  module System
+
+    extend self
+
+    # Validate that the system has all of its dependencies
+    # @return [Boolean]
+    def validate
+      validate_ffmpeg
+      validate_youtube_dl
+      true
+    end
+
+    private
+
+    # Validate that ffmpeg is installed
+    # @return [Boolean]
+    def validate_ffmpeg
+      result = Kernel.system("ffmpeg")
+      if result.nil?
+        raise("Viddl requires that ffmpeg be installed")
+      end
+      true
+    end
+
+    # Validate that youtube-dl is installed
+    # @return [Boolean]
+    def validate_youtube_dl
+      result = Kernel.system("youtube-dl")
+      if result.nil?
+        raise("Viddl requires that youtube-dl be installed https://github.com/rg3/youtube-dl")
+      end
+    end
+
+  end
+
+end

data/lib/viddl/video.rb

@@ -0,0 +1,23 @@
+require "viddl/video/clip"
+require "viddl/video/download"
+require "viddl/video/instance"
+
+module Viddl
+
+  module Video
+
+    extend self
+
+    # Download a video using the given url
+    # @param [String] url
+    # @param [Hash] options
+    # @return [Video::Instance]
+    def download(url, options = {})
+      video = Instance.new(url)
+      video.process_download(options)
+      video
+    end
+
+  end
+
+end

data/lib/viddl/video/clip.rb

@@ -0,0 +1,129 @@
+require "viddl/video/clip/audio"
+require "viddl/video/clip/crop"
+require "viddl/video/clip/cut"
+require "viddl/video/clip/resize"
+
+module Viddl
+
+  module Video
+
+    class Clip
+
+      MODULES = [Audio, Crop, Cut, Resize]
+
+      # Create a clip using the given video source file path and options
+      # @param [String] source_path Path to video file to create clip from
+      # @param [Hash] options
+      # @option options [Boolean] :audio Whether to include audio
+      # @option options [Numeric] :start Time in the source file where the clip starts
+      # @option options [Numeric] :duration Duration of the clip
+      # @option options [Numeric] :end Time in the source file where the clip ends
+      # @option options [Integer, String] :width The desired width to resize to
+      # @option options [Integer, String] :height The desired height to resize to
+      # @option options [Hash] :crop The desired crop parameters (:x, :y, :width, :height)
+      # @return [Clip]
+      def self.process(path, options = {})
+        clip = new(path)
+        clip.process(options)
+        clip
+      end
+
+      # @param [String] source_path Path to video file to create clip from
+      def initialize(source_path)
+        @source_path = source_path
+      end
+
+      # Create a clip using the given options
+      # @param [Hash] options
+      # @option options [Boolean] :audio Whether to include audio
+      # @option options [Numeric] :start Time in the source file where the clip starts
+      # @option options [Numeric] :duration Duration of the clip
+      # @option options [Numeric] :end Time in the source file where the clip ends
+      # @option options [Integer, String] :width The desired width to resize to
+      # @option options [Integer, String] :height The desired height to resize to
+      # @option options [Hash] :crop The desired crop parameters (:x, :y, :width, :height)
+      # @return [Boolean]
+      def process(options = {})
+        command = command_line(options)
+        Kernel.system(command)
+      end
+
+      private
+
+      # Command line to create a clip from the source file and given options
+      # @param [Hash] options
+      # @option options [Boolean] :audio Whether to include audio
+      # @option options [Numeric] :start Time in the source file where the clip starts
+      # @option options [Numeric] :duration Duration of the clip
+      # @option options [Numeric] :end Time in the source file where the clip ends
+      # @option options [Integer, String] :width The desired width to resize to
+      # @option options [Integer, String] :height The desired height to resize to
+      # @option options [Hash] :crop The desired crop parameters (:x, :y, :width, :height)
+      # @return [String]
+      def command_line(options = {})
+        if options.values.compact.empty?
+          # when there are no clip options, the source file can just be copied
+          # over to the output file location without using ffmpeg
+          "cp #{@source_path} #{output_path}"
+        else
+          formatted_opts = options_formatted(options)
+
+          modules_with_args = MODULES.select { |mod| mod.respond_to?(:args) }
+          modules_with_filters = MODULES.select { |mod| mod.respond_to?(:filter_args) }
+
+          module_args = modules_with_args.map { |mod| mod.args(formatted_opts) }.compact
+          module_filters = modules_with_filters.map { |mod| mod.filter_args(formatted_opts) }.compact
+
+          module_arg_string = module_args.join(" ")
+          unless module_filters.empty?
+            module_arg_string += " -vf '#{module_filters.join(",")}'"
+          end
+
+          "ffmpeg -i #{@source_path} #{module_arg_string} #{output_path(formatted_opts)}"
+        end
+      end
+
+      # Options formatted for ffmpeg
+      # @param [Hash] options
+      # @option options [Boolean] :audio Whether to include audio (default: true)
+      # @option options [Numeric] :start Time in the source file where the clip starts
+      # @option options [Numeric] :duration Duration of the clip
+      # @option options [Numeric] :end Time in the source file where the clip ends
+      # @option options [Integer, String] :width The desired width to resize to
+      # @option options [Integer, String] :height The desired height to resize to
+        # @option options [Hash] :crop The desired crop parameters (:x, :y, :width, :height)
+      # @return [Hash]
+      def options_formatted(options = {})
+        mod_options = MODULES.map { |mod| mod.options_formatted(options) }
+        mod_options.inject(:merge)
+      end
+
+      # Path of the created clip
+      # @param [Hash] options
+      # @option options [Boolean] :audio Whether to include audio
+      # @option options [Numeric] :start Time in the source file where the clip starts
+      # @option options [Numeric] :duration Duration of the clip
+      # @option options [Integer, String] :width The desired width to resize to
+      # @option options [Integer, String] :height The desired height to resize to
+      # @option options [Hash] :crop The desired crop parameters (:x, :y, :width, :height)
+      # @return [String]
+      def output_path(options = {})
+        base = @source_path.scan(/#{Download::TEMPDIR}\/(.*)/).flatten.first
+        result = base
+        if !options.values.flatten.compact.empty?
+          name, ext = *base.split(".")
+          tokens = ""
+          MODULES.each do |mod|
+            token = mod.filename_token(options)
+            tokens += "-#{token}" unless token.nil?
+          end
+          result = "#{name}#{tokens}.#{ext}"
+        end
+        result
+      end
+
+    end
+
+  end
+
+end

data/lib/viddl/video/clip/audio.rb

@@ -0,0 +1,43 @@
+module Viddl
+
+  module Video
+
+    class Clip
+
+      module Audio
+
+        extend self
+
+        # Audio options formatted for ffmpeg
+        # @param [Hash] options
+        # @option options [Boolean] :audio Whether to include audio (default: true)
+        # @return [Hash]
+        def options_formatted(options = {})
+          result = {}
+          result[:audio] = !options[:audio].eql?(false)
+          result
+        end
+
+        # Command line options for audio
+        # @param [Hash] options
+        # @option options [Boolean] :audio Whether to include audio (default: false)
+        # @return [String, nil]
+        def args(options = {})
+          "-an" if options[:audio].eql?(false)
+        end
+
+        # Token added to clip filename for audio args
+        # @param [Hash] options
+        # @option options [Boolean] :audio Whether to include audio in the clip (default: false)
+        # @return [String, nil]
+        def filename_token(options = {})
+          "noaudio" if options[:audio].eql?(false)
+        end
+
+      end
+
+    end
+
+  end
+
+end