vtools 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Vadim Todorov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,131 @@
+# VTools
+
+Daemon video processor tools to operate the video (get info, encode & generate thumbnails).
+Under the hood ffmpeg & ffmpegthumbnailer are used.
+Some ideas has been taken at the streamio-ffmpeg gem (parse output methods).
+
+Project was developed for the [WebTV](http://web.tv)
+
+## Installation
+
+  (sudo) gem install vtools
+
+Please read changelog to check ffmpeg versions compatibility.
+
+## Usage
+
+### Getting started
+
+Before start, daemon should be correctly configured, to have valid access to the storage.
+Mandatory methods are: **connect**, **recv** and **send**.
+
+``` ruby
+#--file library.rb--#
+# encoding: binary
+
+#to setup storage:
+VTools::Storage.setup do
+
+  # connection setup
+  connect_action do
+    # ... connect to the storage (persistent)
+  end
+
+  # message reciever
+  # should return JSON encoded string
+  # see complete storage setup reference for details
+  recv_action do
+    # ... job data recieve algorithm
+  end
+
+  # message sender
+  # recieves hash: { :data => execution_result, :action => executed_action }
+  # execution_result can be video object or array with thumbnails
+  send_action do |result|
+    # ... send action here
+  end
+end
+
+# storage can be setup separate
+VTools::Storage.connect_action do
+  # ... connect to the storage
+end
+```
+
+### Setup message (JSON)
+
+```
+{ "action" : "convert|thumbs|info", "file" : "path/to/file", "setup" :  < setup > }
+# setup can be:
+# -- "predefined_set_id"
+# -- { ffmpeg_options_hash }
+# -- { "set": "predefined_set_str", ffmpeg_options_hash }
+```
+
+### User friendly option names
+
+```
+converter (ffmpeg)
+  preserve_aspect   (true or false)
+  extension         (result file extension)
+  width, height
+  resolution
+  duration
+
+thumbnailer (ffmpegthumbnailer)
+  thumb_count
+  thumb_start_point (in percents)
+  time              (time offset, alias for -t)
+  quality           (0 - 10)
+  width
+```
+
+## Start
+
+To launch daemon is enough to require library with storage setup:
+  (sudo) vtools start -- -r library
+
+## Options
+
+### Daemon options are
+  start
+  stop
+  restart
+
+### Application options are:
+  -c or --config-file - load config from file
+  -r or --require     - load ruby library file (can be used more than once)
+
+### To see complete options list use
+  vtools --help
+
+### Using logger
+
+By default the `logger` gem is used. But there is possibility to set custom logger, that is compatible with the default logger.
+
+``` ruby
+VTools.logger = CustomLoger.new($stdout)
+```
+
+### Additioinal methods
+
+Path generator is used by the thumnailer, converter or both to generate necessary dir tree logic for the media.
+It accepts file name and should return relative path (excluding file name itself)
+
+``` ruby
+# path generator (used to )
+VTools.path_generator do |file_name|
+  # ..
+end
+
+```
+
+**Network calls** (TCP GET request, that will return message body content, ignoring response headers)
+
+``` ruby
+
+# http calls
+VTools.network_call "site.com/some/uri"
+VTools.network_call "www.site.com"
+VTools.network_call "http://www.site.com"
+```

data/Rakefile

@@ -0,0 +1,29 @@
+# -*- encoding: binary -*-
+
+require 'rake/gempackagetask'
+
+$LOAD_PATH.unshift 'lib'
+require "vtools/version"
+
+spec = Gem::Specification.new do |s|
+  s.name                    = "vtools"
+  s.summary                 = "Daemon tools to operate the video (get info, encode & generate thumbnails)."
+  s.description             = File.read(File.join(File.dirname(__FILE__), 'README.md'))
+  s.extensions              = 'extconf.rb'
+  s.version                 = VTools::VERSION.join('.')
+  s.requirements            = ['ffmpeg v >= 1.8', 'ffmpegthumbnailer v >= 2', 'gem Daemons v >= 1.1.4']
+  s.author                  = "tofir"
+  s.email                   = "v.tofir@gmail.com"
+  s.homepage                = "http://tofir.comuv.com"
+  s.platform                = Gem::Platform::RUBY
+  s.required_ruby_version   = ">=1.9"
+  s.files                   = Dir['**/**']
+  s.executables             = ["vtools"]
+  s.test_files              = Dir["spec/*_spec.rb"]
+
+  s.add_dependency              'daemons', '>= 1.1.4'
+  s.add_dependency              'json'
+  s.add_development_dependency  'rspec'
+end
+
+Rake::GemPackageTask.new(spec).define

data/bin/vtools

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# -*- encoding: binary -*-
+
+require 'daemons'
+require 'vtools'
+
+VTools::Options.parse! ARGV
+
+options = {:multiple => true}
+
+if VTools::CONFIG[:logging]
+  options[:backtrace] = true
+  options[:log_output] = true
+  options[:log_dir] = VTools::CONFIG[:PWD]
+end
+
+
+# daemonize server
+Daemons.run_proc 'harvester', options do
+  # start process
+  VTools::Harvester.daemonize!
+end

data/doc/CONFIG.md

@@ -0,0 +1,36 @@
+# Using config file (YAML)
+
+To make VTools parse config file it should be given to it with -c option:
+
+  $ vtools start -- -c config.json
+
+
+## Format
+
+
+    #system
+    :ffmpeg_binary:     'ffmpeg'
+    :thumb_binary:      'ffmpegthumbnailer'
+    :library:           ['lib.rb']
+   
+    #harvester
+    :max_jobs:          5
+    :harvester_timer:   3  # timeout between job requests
+    :temp_dir:          "/tmp"
+   
+    #converter
+    :validate_duration: false
+    :video_storage:     "/home/projects/video_storage"
+   
+    #thumbnailer
+    :thumb_storage:     "/home/projects/thumb_storage"
+   
+    #predefined video qualities
+    :video_set:
+        # SET_NAME    -vcodec     -acodec    -s WDTxHGT      -vb       -ab    -ar      -ac  EXT    POSTFIX   [-vpre]
+        :x264_180p: [ 'libx264',  'libfaac',  '240x180',    '96k',    '64k',  22050,    2,  'mp4', '_180',   'normal'   ]
+   
+    # predefined thumbnailer setup
+    :thumb_set:
+        # SET_NAME   -s   -q count start%
+        :w120s:   [  120, 10,  5,   0 ]

data/doc/HOOKS.md

@@ -0,0 +1,37 @@
+# Using hooks
+
+Multiple actions can be attached for a single hook.
+
+**hooks placeholders:**
+
+* job_started (video, action)
+* job_finished (result, video, action)
+
+* before_convert (video, command)
+* in_convert (video, progress)
+* convert_success (video, output_file)
+* convert_error (video, error, ffmpeg_output)
+
+* before_thumb (video, config)
+* in_thumb (video, thumb)
+* thumb_success (video, thumbs_array)
+* thumb_error (video, errors)
+
+``` ruby
+# multiple hooks setup
+VTools::Handler.collection do
+  set :in_convert do |video|
+    #..
+  end
+
+  set :in_thumb do |video|
+    #..
+  end
+  # ...
+end
+
+# single hook setup
+VTools::Handler.set :job_started do
+  #..
+end
+```

data/doc/LIB_EXAMPLE.md

@@ -0,0 +1,109 @@
+# Library example
+
+Library can be required via `-r` option
+
+  $ vtools start -- -r library
+  $ vtools start -- -r library.rb
+
+```ruby
+# -*- encoding: binary -*-
+
+# path generator
+VTools.path_generator do |file_name|
+
+  storage_path = VTools::CONFIG[:PWD] + "/../test_storage"
+  first = file_name[0...2]
+  second = file_name[2...4]
+  # create all parent dirs (storage... path .. ) ???
+  if (error = `mkdir -p #{storage_path}/#{first}/#{second}`).empty?
+    "#{storage_path}/#{first}/#{second}"
+  else
+    raise Exception, "Can't create storage dirs (#{error})"
+  end
+end
+
+# storage setup
+VTools::Storage.setup do
+
+  connect_action do
+    @mq = MQ.new
+    print "----------- connected to the MQ -------\n"
+  end
+
+  # recieve data for processing
+  recv_action do
+    job = @mq.recv
+    setup = "{\"set\" : \"flv_240p\", \"acodec\" : \"#{job}\" }"
+    "{\"action\" : \"#{action}\", \"file\" : \"#{file}\", \"setup\" : #{setup} }"
+  end
+
+  send_action do |result|
+    @mq.send "video.success #{result[:action]} "
+    print "----------------> 'terminated' MQ sent (#{result[:data].to_json}) - action #{result[:action]}\n"
+  end
+end
+
+# hooks
+VTools::Handler.collection do
+
+  set :job_started do |video, action|
+    print "(#{video.name}) ------> job     | started | {#{video}} :: scope: #{action}\n"
+  end
+
+  set :in_convert do |video, status|
+
+    # cgeate thumb each step
+    current = (status * 1000).round / 10.0
+    @count ||= 0;
+
+    # generate thumbs on the fly
+    if @count == 10
+      @count = 0
+      print "(#{video.name}) >>>>>>> add_thumb --------- #{current}%\n"
+      video.create_thumbs :thumb_count => 1,
+                          :time => current.to_i,
+                          :postfix => current.to_i,
+                          :width => 600
+    end
+
+    @count += 1
+
+    print "(#{video.name}) +++++++ convert | status  | (#{current}%)\n"
+  end
+
+  set :in_thumb do |video, thumb|
+    print "(#{video.name}) +++++++ generate| thumbs  | (#{thumb})\n"
+  end
+
+  set :before_convert do |video, command|
+    print "(#{video.name}) ------- convert |scheduled| {#{video}}\n"
+  end
+
+  set :before_thumb do |video, config|
+    print "(#{video.name}) ------- thumbs  |scheduled| {#{video}} :: (config: #{config})\n"
+  end
+
+  set :convert_error do |video|
+    print "(#{video.name}) !!!!!!! convert | failed  | {#{video}}\n"
+  end
+
+  set :convert_success do |video|
+    print "(#{video.name}) <------ convert |finished | {#{video}}\n"
+  end
+
+  set :thumb_success do |video, thumbs|
+    if thumbs
+      images = ":: "
+      thumbs.each do |hash|
+        images += "#{hash[:offset]}||"
+      end
+      images = "#{images} count:#{thumbs.count}"
+    end
+    print "(#{video.name}) <------ thumbs  |finished | {#{video}} #{images}\n"
+  end
+
+  set :job_finished do |result, video, action|
+    print "(#{video.name}) <------ job     |finished | {#{video}} :: scope: #{action}\n"
+  end
+end
+```

data/extconf.rb

@@ -0,0 +1,7 @@
+# -*- encoding: binary -*-
+
+# validate if ffmpeg & ffmpegthumbnails exists
+ffmpeg      = `which ffmpeg`
+thumbnailer = `which ffmpegthumbnailer`
+
+puts "\n*---------------> Could not find ffmpeg/ffmpegthumbnailer.. <---------------*\n" if thumbnailer.empty? || ffmpeg.empty?

data/lib/vtools.rb

@@ -0,0 +1,79 @@
+# -*- encoding: binary -*-
+
+module VTools
+
+  # set global $LOAD_PATH
+  $: << File.dirname(__FILE__) << Dir.getwd
+
+  Thread.abort_on_exception = true
+
+  require 'optparse'
+  require 'json'
+  require 'yaml'
+  require 'ostruct'
+  require 'open3'
+  require 'logger'
+
+  require 'vtools/version'
+  require 'vtools/errors'
+  require 'vtools/shared_methods'
+  require 'vtools/config'
+  require 'vtools/options'
+  require 'vtools/handler'
+  require 'vtools/storage'
+  require 'vtools/harvester'
+  require 'vtools/job'
+  require 'vtools/video'
+  require 'vtools/converter'
+  require 'vtools/thumbnailer'
+  require 'vtools/convert_options'
+  require 'vtools/thumbs_options'
+
+  include SharedMethods # extend with common methods
+
+  # callbacks after ARGV config has been parsed
+  Handler.collection do
+
+    # load external config file & external libs
+    set :config_parsed do
+      CONFIG.load!
+      load_libs
+    end
+
+    # set job finished handlers
+    set :job_finished do |result, video, action|
+      # log job status
+      log :info, "Job finished. name: #{video.name},  action : #{action}"
+    end
+
+    # set converter error handlers
+    set :before_convert do |video, command|
+      # log status
+      log :info, "Running encoding... (#{video.name}) : #{command}"
+    end
+
+    # set converter error handlers
+    set :convert_success do |video, output_file|
+      # log status
+      log :info, "Encoding of #{video.path} to #{output_file} succeeded"
+    end
+
+    # set converter error handlers
+    set :convert_error do |video, errors, output|
+      # log error
+      log :error, "Failed encoding... #{video} #{output} #{errors}"
+    end
+
+    # set thumbnailer success handlers
+    set :thumb_success do |video, thumbs|
+      # log status
+      log :info, "Thumbnail creation of #{video.path} succeeded"
+    end
+
+    # set thumbnailer error handlers
+    set :thumb_error do |video, errors|
+      # log error
+      log :error, "Failed create thumbnail for the video #{video.name} #{errors}"
+    end
+  end # Handler.collection
+end # VTools