rdvd-slideshow 0.0.1

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2009-02-11
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,14 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/rdvd-slideshow.rb
+lib/rdvd-slideshow/slideshow.rb
+lib/rdvd-slideshow/slideshow_task.rb
+lib/rdvd-slideshow/slideshow_input.rb
+test/helper.rb
+test/test.jpg
+test/test_slideshow.rb
+test/test_slideshow_task.rb
+test/test_slideshow_input.rb
+test/outputs/

data/README.txt

@@ -0,0 +1,56 @@
+= rdvd-slideshow
+
+* http://rdvd-slideshow.rubyforge.org/
+
+== DESCRIPTION:
+
+A ruby interface for dvd-slideshow utility (http://dvd-slideshow.sourceforge.net)
+
+== FEATURES/PROBLEMS:
+
+== SYNOPSIS:
+
+Sample script to build basic slideshow:
+
+  slideshow = RDvdSlideshow::Slideshow.build do |show|
+    show.output_dir = "/tmp"
+    show.write_input do |input|
+      input.title "My slideshow", "2.0"
+      input.image "/tmp/picture1.jpg", "0.5"
+      input.image "/tmp/picture2.jpg", "0.5"
+      input.exit
+    end
+  end
+
+== REQUIREMENTS:
+
+* RProgram >= 0.1.3
+
+== INSTALL:
+
+  $ sudo gem install rdvd-slideshow
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 FIX
+
+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/Rakefile

@@ -0,0 +1,16 @@
+# -*- ruby -*-
+
+$:.unshift(File.dirname(__FILE__) + '/lib')
+
+require 'rubygems'
+require 'hoe'
+require './lib/rdvd-slideshow.rb'
+
+Hoe.new('rdvd-slideshow', RDvdSlideshow::VERSION) do |p|
+  p.rubyforge_name = 'rdvd-slideshow'
+  p.developer('sdabet', 'sebastiendabet@gmail.com')
+  p.remote_rdoc_dir = ''
+  p.extra_deps = [['rprogram', '>=0.1.3']]
+end
+
+# vim: syntax=Ruby

data/lib/rdvd-slideshow.rb

@@ -0,0 +1,5 @@
+require 'rdvd-slideshow/slideshow'
+
+module RDvdSlideshow
+  VERSION = '0.0.1'
+end

data/lib/rdvd-slideshow/slideshow.rb

@@ -0,0 +1,39 @@
+require 'rdvd-slideshow/slideshow_task'
+require 'rprogram/program'
+
+module RDvdSlideshow
+
+  class Slideshow < RProgram::Program
+    name_program "dvd-slideshow"
+    
+    def initialize(path)
+      super(path)
+    end
+    
+    #
+    # Launches the building of the slideshow.
+    # Options and/or block can be passed to configure the slideshow.
+    # Example:
+    # Slideshow.build(:output_dir=>"output",:input_file=>"input.txt")
+    #
+    # or with a block:
+    # Slideshow.build do |show|
+    #   show.output_dir = "output"
+    #   show.write_input do |input|
+    #    input.image "toto.jpg", "0.5"
+    #   end
+    # end
+    #
+    def self.build(options={},&block)
+      self.find.build(options,&block)
+    end
+
+    #
+    # Instance method for building slideshow
+    #
+    def build(options={},&block)
+      run_task(SlideshowTask.new(options,&block))
+    end
+  end
+
+end

data/lib/rdvd-slideshow/slideshow_input.rb

@@ -0,0 +1,103 @@
+require 'tempfile'
+
+module RDvdSlideshow
+  
+  #
+  # A SlideshowInput is responsible for building the input file used by dvd-slideshow.
+  # 
+  class SlideshowInput
+    
+    #
+    # Initializes the file path and write the content of the file.
+    # If no file path is given, a temp file is used (Tempfile).
+    # The provided block is used to build the content of the file.
+    # The file is flushed after writing.
+    #
+    def initialize(file_path=nil,&block)
+      @file = file_path ? File.new(file_path,'w') : Tempfile.new('slideshow_input')
+      
+      block.call(self) if block
+      @file.flush
+    end
+    
+    # Path to the path where slideshow input configuration is written
+    def file_path
+      @file.path
+    end
+    
+    #
+    # Adds a new image
+    #
+    def image(path,duration,options={})
+      write_line(path,duration,options,[:subtitle,:effect,:effect_params])
+    end
+    
+    #
+    # Adds a title
+    #
+    def title(duration,text)
+      write_line("title",duration,{:text=>text},[:text])
+    end
+    
+    #
+    # Adds a title bar
+    # Possible options are : _upper\_title_ and _lower\_title_
+    #
+    def titlebar(duration,options={})
+      write_line("titlebar",duration,options,[:upper_title,:lower_title])
+    end
+    
+    #
+    # Adds a music
+    # Possible options are : _subtitle_
+    #
+    def musictitle(duration,options={})
+      write_line("musictitle",duration,options,[:subtitle])
+    end
+    
+    def fadein(duration,options={})
+      write_line("fadein",duration,options,[:subtitle])
+    end
+    
+    def fadeout(duration,options={})
+      write_line("fadeout",duration,options,[:subtitle])
+    end
+    
+    #
+    # Adds an exit command
+    #
+    def exit
+      @file.puts "exit"
+    end
+    
+    protected
+    
+    def separator
+      ':'
+    end
+    
+    def write_line(keyword,duration,options={},sorted_keys=[])
+      @file.puts build_line(keyword,duration,options,sorted_keys)
+    end
+    
+    def build_line(keyword,duration,options={},sorted_keys=[])
+      line = keyword + separator + format_duration(duration)
+      index = 0
+      remaining_options = options.values.length
+      while remaining_options > 0
+        line << separator
+        value = options[sorted_keys[index]]
+        line << (value || "")
+        index += 1
+        remaining_options -= 1 if value
+      end
+      return line
+    end
+    
+    def format_duration(duration)
+       "%.3f" % duration.to_f
+    end
+    
+  end
+
+end

data/lib/rdvd-slideshow/slideshow_task.rb

@@ -0,0 +1,67 @@
+require 'rprogram/task'
+require 'rdvd-slideshow/slideshow_input'
+
+module RDvdSlideshow
+
+  #
+  # ==dvd-slideshow options:
+  #
+  # <tt>-n</tt>:: <tt>mencoder.name</tt>
+  # <tt>-o</tt>:: <tt>mencoder.output_dir</tt>
+  # <tt>-b</tt>:: <tt>mencoder.background</tt>
+  # <tt>-a</tt>:: <tt>mencoder.audio_file</tt>
+  # <tt>-p</tt>:: <tt>mencoder.pal</tt>
+  # <tt>-mp2</tt>:: <tt>mencoder.mp2</tt>
+  # <tt>-L</tt>:: <tt>mencoder.low_quality</tt>
+  # <tt>-H</tt>:: <tt>mencoder.high_quality</tt>
+  # <tt>-theme</tt>:: <tt>mencoder.theme</tt>
+  # <tt>-border</tt>:: <tt>mencoder.border</tt>
+  # <tt>-sharpen</tt>:: <tt>mencoder.sharpen</tt>
+  # <tt>-r</tt>:: <tt>mencoder.auto_crop</tt>
+  # <tt>-w</tt>:: <tt>mencoder.widescreen</tt>
+  # <tt>-smp</tt>:: <tt>mencoder.smp</tt>
+  # <tt>-mpeg2enc</tt>:: <tt>mencoder.mpeg2enc</tt>
+  # <tt>-vcd</tt>:: <tt>mencoder.vcd</tt>
+  # <tt>-flv</tt>:: <tt>mencoder.flv</tt>
+  # <tt>-s</tt>:: <tt>mencoder.output_size</tt>
+  # <tt>-f</tt>:: <tt>mencoder.input_file</tt>
+  #
+  # Instead of providing an input file it is possible to programatically define the input with the write_input method
+  # 
+  class SlideshowTask < RProgram::Task
+    
+    long_option :flag => '-n', :name => :name
+    long_option :flag => '-o', :name => :output_dir
+    long_option :flag => '-b', :name => :background
+    long_option :flag => '-a', :name => :audio_file
+    long_option :flag => '-p', :name => :pal
+    long_option :flag => '-mp2', :name => :mp2
+    long_option :flag => '-L', :name => :low_quality
+    long_option :flag => '-H', :name => :high_quality
+    long_option :flag => '-theme'
+    long_option :flag => '-border'
+    long_option :flag => '-sharpen'
+    long_option :flag => '-r', :name => :auto_crop
+    long_option :flag => '-w', :name => :widescreen
+    long_option :flag => '-smp'
+    long_option :flag => '-mpeg2enc'
+    long_option :flag => '-vcd'
+    long_option :flag => '-flv'
+    long_option :flag => '-s', :name => :output_size
+    long_option :flag => '-f', :name => :input_file
+    
+    #
+    # Configures the input configuration of the slideshow
+    # and generates automatically the corresponding input file.
+    # The provided block is used to configure the SlideshowInput object
+    #
+    def write_input(&block)
+      @input = SlideshowInput.new do |input|
+        block.call(input) if block
+      end
+      @options[:input_file] = @input.file_path
+    end
+    
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,45 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'test/unit'
+require 'rubygems'
+require 'fileutils'
+
+class Test::Unit::TestCase
+
+  def input_file
+    File.dirname(__FILE__) + '/input_file'
+  end
+  
+  def output_dir
+    File.dirname(__FILE__) + '/outputs'
+  end
+  
+  def default_image
+    File.dirname(__FILE__) + '/test.jpg'
+  end
+  
+  def setup
+    FileUtils.mkdir_p output_dir
+  end
+  
+  def teardown
+    # Delete test input file
+    File.delete(input_file) if File.file?(input_file)
+    # Clean outputs directory
+    delete_content output_dir
+  end
+
+  protected
+  
+  # Recursively delete folder content
+  def delete_content(dir)
+    Dir.foreach(dir) do |f|
+      path = dir + "/" + f
+      if f == '.' or f == '..' then next
+      elsif File.directory?(path) then FileUtils.rm_rf(path)      
+      else FileUtils.rm(path)
+      end
+    end 
+  end 
+
+end

data/test/test_slideshow.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/helper'
+require 'rdvd-slideshow/slideshow'
+
+class TestSlideshow < Test::Unit::TestCase
+
+  def test_slideshow
+    result = RDvdSlideshow::Slideshow.build(:name=>"test slideshow",:output_dir=>output_dir,:mp2=>true) do |show|
+      show.write_input do |input|
+        input.image default_image, 2
+      end
+    end
+    
+    assert result
+    assert File.exists?(output_dir + "/test_slideshow.vob")
+  end
+
+end

data/test/test_slideshow_input.rb

@@ -0,0 +1,98 @@
+require File.dirname(__FILE__) + '/helper'
+require 'rdvd-slideshow/slideshow_input'
+
+class TestSlideshowInput < Test::Unit::TestCase
+
+  def test_empty_input
+    input = RDvdSlideshow::SlideshowInput.new(nil)
+    
+    assert File.exists?(input.file_path), "Input file was not created"
+
+    lines = File.readlines(input.file_path)
+    assert lines.empty?, "Input file should be empty"
+  end
+  
+  def test_image
+    input = RDvdSlideshow::SlideshowInput.new(input_file) do |input|
+      input.image(default_image,0.5)
+      input.image(default_image,0.5, :effect=>"special_effect")
+    end
+    
+    lines = File.readlines(input.file_path)
+    assert_equal 2, lines.length
+    assert_equal "#{default_image}:0.500\n", lines[0]
+    assert_equal "#{default_image}:0.500::special_effect\n", lines[1]
+  end
+  
+  def test_image_with_no_input_file_path
+    input = RDvdSlideshow::SlideshowInput.new do |input|
+      input.image(default_image,0.5)
+      input.image(default_image,0.5, :effect=>"special_effect")
+    end
+    
+    lines = File.readlines(input.file_path)
+    assert_equal 2, lines.length
+    assert_equal "#{default_image}:0.500\n", lines[0]
+    assert_equal "#{default_image}:0.500::special_effect\n", lines[1]
+  end
+
+  def test_title
+    input = RDvdSlideshow::SlideshowInput.new(input_file) do |input|
+      input.title 0.5,"test_title"
+    end
+    
+    lines = File.readlines(input.file_path)
+    assert_equal 1, lines.length
+    assert_equal "title:0.500:test_title\n", lines[0]
+  end
+  
+  def test_titlebar
+    input = RDvdSlideshow::SlideshowInput.new(input_file) do |input|
+      input.titlebar 0.5
+      input.titlebar 0.5,{:upper_title=>"my upper text"}
+      input.titlebar 0.5,{:lower_title=>"my lower text"}
+      input.titlebar 0.5,{:upper_title=>"my upper text",:lower_title=>"my lower text"}
+    end
+    
+    lines = File.readlines(input.file_path)
+    assert_equal 4, lines.length
+    assert_equal "titlebar:0.500\n", lines[0]
+    assert_equal "titlebar:0.500:my upper text\n", lines[1]
+    assert_equal "titlebar:0.500::my lower text\n", lines[2]
+    assert_equal "titlebar:0.500:my upper text:my lower text\n", lines[3]
+  end
+  
+  def test_musictitle
+    input = RDvdSlideshow::SlideshowInput.new(input_file) do |input|
+      input.musictitle(0.5)
+      input.musictitle(0.5,{:subtitle=>"my subtitle"})
+    end
+    
+    lines = File.readlines(input.file_path)
+    assert_equal 2, lines.length
+    assert_equal "musictitle:0.500\n", lines[0]
+    assert_equal "musictitle:0.500:my subtitle\n", lines[1]
+  end
+  
+  def test_exit
+    input = RDvdSlideshow::SlideshowInput.new(input_file) do |input|
+      input.exit
+    end
+    
+    lines = File.readlines(input.file_path)
+    assert_equal 1, lines.length
+    assert_equal "exit\n", lines[0]
+  end
+  
+  def test_duration_conversion
+    input = RDvdSlideshow::SlideshowInput.new(input_file) do |input|
+      input.image(default_image, 2)
+      input.image(default_image, 1.23456789)
+    end
+    
+    lines = File.readlines(input.file_path)
+    assert_equal "#{default_image}:2.000\n", lines[0]
+    assert_equal "#{default_image}:1.235\n", lines[1]
+  end
+  
+end

data/test/test_slideshow_task.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/helper'
+require 'rdvd-slideshow/slideshow_task'
+
+class TestSlideshowTask < Test::Unit::TestCase
+
+  def test_slideshow_task
+    task = RDvdSlideshow::SlideshowTask.new(:output_dir => output_dir)
+    task.write_input do |input|
+      input.image default_image, 0.5
+    end
+    
+    input_file = task.input_file
+    assert !input_file.nil?
+    
+    lines = File.readlines(input_file)
+    assert 1, lines.length
+    assert_equal "#{default_image}:0.500\n",lines[0]
+  end
+
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: rdvd-slideshow
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- sdabet
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-13 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rprogram
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.2
+    version: 
+description: A ruby interface for dvd-slideshow utility (http://dvd-slideshow.sourceforge.net)
+email: 
+- sebastiendabet@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/rdvd-slideshow.rb
+- lib/rdvd-slideshow/slideshow.rb
+- lib/rdvd-slideshow/slideshow_task.rb
+- lib/rdvd-slideshow/slideshow_input.rb
+- test/helper.rb
+- test/test.jpg
+- test/test_slideshow.rb
+- test/test_slideshow_task.rb
+- test/test_slideshow_input.rb
+- test/outputs/
+has_rdoc: true
+homepage: http://rdvd-slideshow.rubyforge.org/
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rdvd-slideshow
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: A ruby interface for dvd-slideshow utility (http://dvd-slideshow.sourceforge.net)
+test_files: 
+- test/test_slideshow_input.rb
+- test/test_slideshow.rb
+- test/test_slideshow_task.rb