uencode 3.0.0 → 3.1.0

data/LICENSE.txt

@@ -0,0 +1,9 @@
+This project is released under The MIT License
+
+Copyright © 2011, uEncode, Cássio Marques
+
+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

@@ -1,6 +1,6 @@
 # UEncode
 
-A Ruby gem to interact with the [uEncode](http://www.uencode.com) API. This extends the work of [Cassio Marques](https://github.com/cassiomarques/).
+A Ruby gem to interact with the [uEncode](http://www.uencode.com) API. This extends the work of [Cássio Marques](https://github.com/cassiomarques/).
 
 ## Creating a job
 
@@ -14,8 +14,7 @@ end
 
 
 #create job and set source video
-job = UEncode::Job.new :userdata => "AnyDataUsefulToYou", :callback => "Your Email Address or Callack Url"
-job.source_video = UEncode::Source.new :url => "http://your.source.url/foo.flv", :timeout => 600
+job = UEncode::Job.new :userdata => "AnyDataUsefulToYou", :callback => "Your Email Address or Callack Url", :source_video => {:url => "http://your.source.url/foo.flv", :timeout => 600}
 
 #create configuration for a video output
 configuration = {:video => {:bitrate => 1000, :codec => 'h264', :profile => 'baseline', :size => {:width => 640, :height => 480}, :fix_rotation => true, :force_sqare_pixels => true}}
@@ -45,6 +44,18 @@ puts response.code
 puts response.data
 ```
 
+## Advanced output options
+``` ruby
+#add an overlay to a video or capture output
+out = UEncode::VideoOutput.new :container => 'mpeg4', :overlay => {:quadrant=>'Lower-Right', :source_image=>{:url=>'http://your.source.url/logo.png'}}
+
+#encode only a portion of input video (values are seconds)
+out = UEncode::VideoOutput.new :container => 'mpeg4', :clip => {:start => 30, :duration => 60}
+
+#add metadata to a video
+out = UEncode::VideoOutput.new :container => 'mpeg4', :metadata => {:title => 'Video Title', :author => 'Video Author'}
+```
+
 ## Checking job status
 ``` ruby
 require 'uencode'
@@ -81,7 +92,7 @@ The gem does not validate input. Consult the [uEncode API documentation](http://
 
 This project is released under The MIT License
 
-Copyright © 2011, uEncode, Cassio Marques
+Copyright © 2011, uEncode, Cássio Marques
 
 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:
 

data/lib/uencode.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2011, uEncode, Cassio Marques
+# Copyright (c) 2011, uEncode, Cássio Marques
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
@@ -18,8 +18,17 @@ module UEncode
 
   module AttrSetting
     def set_attributes(options)
-      self.class.const_get("ATTRIBUTES").each { |attr| instance_variable_set(:"@#{attr}", options[attr.to_sym] || options[attr.to_s]) }
-    end
+#      self.class.const_get("ATTRIBUTES").each { |attr| instance_variable_set(:"@#{attr}", options[attr.to_sym] || options[attr.to_s]) }
+#      options.each do |key, value|
+          options.each_pair { |key, value| 
+          if self.class.const_get("ATTRIBUTES").include?(key)
+            instance_variable_set(:"@#{key}", value)
+          else
+            self.send("#{key}=", value) 
+          end
+          }
+        
+      end
 
     def initialize(options)
       set_attributes options

data/lib/uencode/elements.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2011, uEncode, Cassio Marques
+# Copyright (c) 2011, uEncode, Cássio Marques
 
 module UEncode
 
@@ -76,6 +76,62 @@ module UEncode
     private
     def root_name; "source"; end
   end
+  
+  class OverlayUrl
+    include Transfer
+    
+    private
+    def root_name; "url"; end
+  end
+  
+  class Position
+    ATTRIBUTES = [:x, :y]
+    
+    include AttrSetting
+
+    def to_xml
+      %Q{
+      <position>
+      <#{x.nil? ? '<x>' + x.to_s + '</x>' : ""}
+      <#{y.nil? ? '<y>' + y.to_s + '</y>' : ""}
+      </position>
+      }
+    end
+  end
+  
+  class Overlay
+    ATTRIBUTES = [:quadrant]
+    
+    include AttrSetting
+
+    def position=(_position)
+      _position = Position.new(_position) unless _position.instance_of?(Position) || _position.nil?
+      instance_variable_set :@position, _position
+    end
+    
+    def position
+      @position
+    end
+    
+    def source_image=(_source)
+       _source = OverlayUrl.new(_source) unless _source.instance_of?(OverlayUrl) || _source.nil?
+       instance_variable_set :@source_image, _source
+    end
+                    
+    def source_image
+      @source_image
+    end                                          
+    
+    def to_xml
+      %Q{
+        <overlay>
+          #{!source_image.nil? ? source_image.to_xml : ""}
+          #{!@position.nil? ? @position.to_xml : ""}
+          #{!quadrant.nil? ? '<quadrant>' + quadrant.to_s + '</quadrant>' : ""}
+        </overlay>
+      }
+    end
+  end
 
   class CaptureOutput
     ATTRIBUTES = [:rate, :stretch, :crop, :zip, :prefix]
@@ -107,6 +163,14 @@ module UEncode
       @max_size
     end
                                                                         
+    def overlay=(_overlay)
+      _overlay = Overlay.new(_overlay) unless _overlay.instance_of?(Overlay) || _overlay.nil?
+      instance_variable_set :@overlay, _overlay
+    end
+
+    def overlay
+      @overlay
+    end
 
     def to_xml
       %Q{
@@ -119,19 +183,93 @@ module UEncode
             </destinations>
           #{@size ? @size.to_xml : ""}
           #{@max_size ? @max_size.to_xml : ""}                    
+          #{@overlay ? @overlay.to_xml : ""}
           </capture>
       }
     end
   end
 
+  class Metadata
+    ATTRIBUTES = [:title, :author, :composer, :album, :year, :track, :comment, :genre, :copyright, :description, :synopsis, :show, :episode_id, :network]
+
+    include AttrSetting
+
+    def to_xml
+      %Q{
+        <meta>
+        #{!title.nil? ? '<title>' + title.to_s + '</title>' : ""}
+        #{!author.nil? ? '<author>' + author.to_s + '</author>' : ""}
+        #{!composer.nil? ? '<composer>' + composer.to_s + '</composer>' : ""}
+        #{!album.nil? ? '<album>' + album.to_s + '</album>' : ""}
+        #{!year.nil? ? '<year>' + year.to_s + '</year>' : ""}
+        #{!track.nil? ? '<track>' + track.to_s + '</track>' : ""}
+        #{!comment.nil? ? '<comment>' + comment.to_s + '</comment>' : ""}
+        #{!genre.nil? ? '<genre>' + genre.to_s + '</genre>' : ""}
+        #{!copyright.nil? ? '<copyright>' + copyright.to_s + '</copyright>' : ""}
+        #{!description.nil? ? '<description>' + description.to_s + '</description>' : ""}
+        #{!synopsis.nil? ? '<synopsis>' + synopsis.to_s + '</synopsis>' : ""}
+        #{!show.nil? ? '<show>' + show.to_s + '</show>' : ""}
+        #{!episode_id.nil? ? '<episode_id>' + episode_id.to_s + '</episode_id>' : ""}
+        #{!network.nil? ? '<network>' + network.to_s + '</network>' : ""}
+        </meta>
+      }
+    end
+  end                      
+
+  class Clip
+    ATTRIBUTES = [:start, :duration]
+
+    include AttrSetting
+    
+    def to_xml
+      %Q{
+        <clip>
+        #{!start.nil? ? '<start>' + start.to_s + '</start>' : ""}
+        #{!duration.nil? ? '<duration>' + duration.to_s + '</duration>' : ""}
+        </clip>
+      }
+    end
+  end
+  
   class VideoOutput
     ATTRIBUTES = [:destination, :container]
 
+    include AttrSetting
+
     include Enumerable
 
     attr_writer :container
     attr_accessor :streams
 
+
+    def overlay=(_overlay)
+      _overlay = Overlay.new(_overlay) unless _overlay.instance_of?(Overlay) || _overlay.nil?
+      instance_variable_set :@overlay, _overlay
+    end
+
+    def overlay
+      @overlay
+    end
+
+    def clip=(_clip)
+      _clip = Clip.new(_clip) unless _clip.instance_of?(Clip) || _clip.nil?
+      instance_variable_set :@clip, _clip
+    end
+
+    def clip
+      @clip
+    end
+
+    def metadata=(_metadata)
+      _metadata = Metadata.new(_metadata) unless _metadata.instance_of?(Metadata) || _metadata.nil?
+      instance_variable_set :@metadata, _metadata
+    end
+
+    def metadata
+      @metadata
+    end
+
+
     def initialize(options)
       @streams = VideoStreams.new
       @destinations = []
@@ -150,8 +288,11 @@ module UEncode
       %Q{
           <video>
             <destinations>
-              #{@destinations.inject("") { |s, dest| s << dest.to_xml}}                        
+            #{@destinations.inject("") { |s, dest| s << dest.to_xml}}                        
             </destinations>
+            #{metadata.nil? ? "" : metadata.to_xml}
+            #{clip.nil? ? "" : clip.to_xml}
+            #{overlay.nil? ? "" : overlay.to_xml}
             <container>#{container}</container>
             #{@streams.to_xml}
           </video>
@@ -163,6 +304,7 @@ module UEncode
   class VideoStreams
     attr_reader :video_config, :audio_config
 
+
     def initialize
       @video_config = VideoConfig.new
       @audio_config = AudioConfig.new
@@ -180,17 +322,17 @@ module UEncode
     # codec, bitrate, channels, samplerate.
     #   
     def configure(hash)
-      video = hash[:video]
-      audio = hash[:audio]      
-      if !video.nil?
+      vid = hash[:video]
+      aud = hash[:audio]      
+      if !vid.nil?
         configure_video do |c|
-          video.each_pair { |key, value| c.send("#{key}=", value) }
+          vid.each_pair { |key, value| c.send("#{key}=", value)}
         end
       end
 
-      if !audio.nil?
+      if !aud.nil?
         configure_audio do |c|
-          audio.each_pair { |key, value| c.send("#{key}=", value) }
+          aud.each_pair { |key, value| c.send("#{key}=", value) }
         end
       end
     end
@@ -241,12 +383,6 @@ module UEncode
   class VideoConfig
     attr_accessor :bitrate, :codec, :profile, :quality, :framerate, :passes, :deinterlace, :fix_rotation, :force_square_pixels
 
-    def initialize
-      @deinterlace = false
-      @profile     = "main"
-      @passes      = 1
-    end
-
     def size=(_size)
       _size = Size.new(_size) unless _size.instance_of?(Size) || _size.nil?
       instance_variable_set :@size, _size
@@ -269,6 +405,7 @@ module UEncode
   # The audio configs for each VideoStream
   class AudioConfig
     attr_accessor :codec, :bitrate, :channels, :samplerate, :quality
+
   end
 
   class JobStatus
@@ -290,7 +427,7 @@ module UEncode
     def source_video
       @source_video
     end
-
+    
     def initialize(options)
       @video_outputs = []
       @captures = []
@@ -311,7 +448,7 @@ module UEncode
         <job>
           #{source_video.nil? ? "" : source_video.to_xml}
           #{userdata.nil? ? "" : '<userdata>' + userdata + '</userdata>'}
-          #{callback.nil? ? "" : '<callback>' + callback + '</callback>'}
+          #{callback.nil? ? "" : '<callback>' + callback + '</callback>'}          
           <outputs>
             #{@video_outputs.inject("") { |s, vid| s << vid.to_xml}}
             #{@captures.inject("") { |s, cap| s << cap.to_xml }}

data/lib/uencode/request.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2011, uEncode, Cassio Marques
+# Copyright (c) 2011, uEncode, Cássio Marques
 
 module UEncode
   class Request

data/lib/uencode/response.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2011, uEncode, Cassio Marques
+# Copyright (c) 2011, uEncode, Cássio Marques
 
 module UEncode
   class Response

data/lib/uencode/version.rb

@@ -1,5 +1,5 @@
-# Copyright (c) 2011, uEncode, Cassio Marques
+# Copyright (c) 2011, uEncode, Cássio Marques
 
 module UEncode
-  VERSION = "3.0.0"
+  VERSION = "3.1.0"
 end

metadata

@@ -2,7 +2,7 @@
 name: uencode
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors: 
   - uencode
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-16 00:00:00 -04:00
+date: 2012-03-29 00:00:00 -04:00
 default_executable: 
 dependencies: 
   - !ruby/object:Gem::Dependency 
@@ -71,7 +71,7 @@ files:
   - .autotest
   - .gitignore
   - Gemfile
-  - Guardfile
+  - LICENSE.txt
   - README.md
   - Rakefile
   - lib/uencode.rb

data/Guardfile

@@ -1,8 +0,0 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-guard 'rspec', :notification => true do
-  watch(%r{^spec/.+_spec\.rb})
-  watch(%r{^lib/(.+)\.rb})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb') { "spec" }
-end