mplayer-ruby 0.1.0

data/lib/mplayer-ruby/slave_video_commands.rb

@@ -0,0 +1,228 @@
+module MPlayer
+  module SlaveVideoCommands
+    
+    # Set/adjust the audio delay.
+    # If type is :relative adjust the delay by <value> seconds.
+    # If type is :absolute, set the delay to <value> seconds.
+    def audio_delay(value,type = :relative)
+      adjust_set :audio_delay, value, type
+    end
+    
+    # Adjust the subtitle delay
+    # :relative is adjust by +/- <value> seconds.
+    # :absolute is set it to <value>. (default)
+    def sub_delay(value,type = :absolute)
+      adjust_set :sub_delay, value, type
+    end
+
+    # Step forward in the subtitle list by <value> steps
+    # step backwards if <value> is negative
+    # can also set type to :backward or :forward and return postive <value>
+    def sub_step(value, type = :forward)
+      type = :backward if value < 0
+      send(type == :forward ? "sub_step #{value.abs}" : "sub_step -#{value.abs}" )
+    end
+    
+    # Toggle OSD mode
+    # or set it to <level>
+    def osd(level=nil)
+      send(level.nil? ? "osd" : "osd #{level}")
+    end
+
+    # Show <string> on the OSD.
+    # :duration sets the length to display text.
+    # :level sets the osd level to display at. (default: 0 => always show)
+    def osd_show_text(string,options = {})
+      options.reverse_merge!({:duration => 0, :level => 0})
+      send("osd_show_text #{string} #{options[:duration]} #{options[:level]}")
+    end
+
+    # Show an expanded property string on the OSD
+    # see -playing-msg for a list of available expansions
+    # :duration sets the length to display text.
+    # :level sets the osd level to display at. (default: 0 => always show)
+    def osd_show_property_text(string,options={})
+      options.reverse_merge!({:duration => 0, :level => 0})
+      send("osd_show_property_text #{string} #{options[:duration]} #{options[:level]}")
+    end
+    
+    # Set/adjust video parameters.
+    # If :relative, modifies parameter by <value>.
+    # If :absolute, parameter is set to <value>.
+    # <value> is in the range [-100, 100].
+    def contrast(value, type = :relative)
+      setting :contrast, value, type
+    end
+
+    # Set/adjust video parameters.
+    # If :relative, modifies parameter by <value>.
+    # If :absolute, parameter is set to <value>.
+    # <value> is in the range [-100, 100].
+    def gamma(value, type = :relative)
+      setting :gamma, value, type
+    end
+
+    # Set/adjust video parameters.
+    # If :relative, modifies parameter by <value>.
+    # If :absolute, parameter is set to <value>.
+    # <value> is in the range [-100, 100].
+    def hue(value, type = :relative)
+      setting :hue, value, type
+    end
+
+    # Set/adjust video parameters.
+    # If :relative, modifies parameter by <value>.
+    # If :absolute, parameter is set to <value>.
+    # <value> is in the range [-100, 100].
+    def brightness(value, type = :relative)
+      setting :brightness, value, type
+    end
+
+    # Set/adjust video parameters.
+    # If :relative, modifies parameter by <value>.
+    # If :absolute, parameter is set to <value>.
+    # <value> is in the range [-100, 100].
+    def saturation(value, type = :relative)
+      setting :saturation, value, type
+    end
+    
+    # Toggle/set frame dropping mode
+    # if :on, turns on dropping mode
+    # if :off, turns off dropping mode
+    # call by itself toggles dropping mode
+    def frame_drop(value = nil)
+      toggle :frame_drop, value
+    end
+
+    # Adjust/set subtitle position.
+    # If :relative, modifies parameter by <value>.
+    # If :absolute, parameter is set to <value>.
+    def sub_pos(value,type = :relative)
+      adjust_set :sub_pos, value, type
+    end
+
+    # Toggle/set subtitle alignment. [alignment]
+    # :top sets top alignment
+    # :center sets center alignment
+    # :bottom sets bottom alignment
+    def sub_alignment(alignment = nil)
+      send case alignment
+      when :top then "sub_alignment 0"
+      when :center then "sub_alignment 1"
+      when :bottom then "sub_alignment 2"
+      else "sub_alignment"
+      end
+    end
+
+    # Toggle/set subtitle visibility.
+    # :on turns on visilibity.
+    # :off turns off visilibility.
+    # else toggles visibility.
+    def sub_visibility(value = nil)
+      toggle :sub_visibility, value
+    end
+
+    # Loads subtitles from <file>.
+    def sub_load(file)
+      raise ArgumentError, "Invalid File" unless File.exists? file
+      send("sub_load #{file}")
+    end
+
+    # Removes the selected sub file
+    # :all removes all sub files. (Default)
+    # <value> removes the sub file at that index.
+    def sub_remove(value = :all)
+      cmd = (value == :all ? -1 : value)
+      send "sub_remove #{cmd}"
+    end
+    
+    # Displays subtitle
+    # :cycle will cycle through all sub_titles. (Default)
+    # <value> will display the sub_title at that index.
+    def sub_select(value = :cycle)
+      cmd = (value == :cycle ? -2 : value)
+      send "sub_select #{cmd}"
+    end
+
+    #  Display first subtitle from <value>
+    #  :sub for SUB_SOURCE_SUBS for file subs
+    #  :vobsub for  SUB_SOURCE_VOBSUB for VOBsub files
+    #  :demux SUB_SOURCE_DEMUX for subtitle embedded in the media file or DVD subs.
+    #  :off will turn off subtitle display.
+    #  :cycle will cycle between the first subtitle of each currently available sources.
+    def sub_source(value = :cycle)
+      switch = case value
+      when :sub then 0
+      when :vobsub then 1
+      when :demux then 2
+      when :off then -1
+      when :cycle then -2
+      end
+      send "sub_source #{switch}"
+    end
+
+    # Display subtitle specifid by <value> for file subs. corresponding to ID_FILE_SUB_ID
+    # :off turns off sub
+    # :cycle will cycle all file subs. (Default)
+    def sub_vob(value = :cycle)
+      select_cycle :sub_vob, value
+    end
+
+    # Display subtitle specifid by <value> for file subs. corresponding to ID_VOBSUB_ID
+    # :off turns off sub
+    # :cycle will cycle all file subs. (Default)
+    def sub_file(value = :cycle)
+      select_cycle :sub_file, value
+    end
+
+    # Display subtitle specifid by <value> for file subs. corresponding to ID_SUBTITLE_ID
+    # :off turns off sub
+    # :cycle will cycle all file subs. (Default)
+    def sub_demux(value = :cycle)
+      select_cycle :sub_demux, value
+    end
+
+    # Adjust the subtitle size by +/- <value>
+    # :set set it to <value>
+    # :relative adjusts it by value
+    def sub_scale(value,type = :relative)
+      adjust_set :sub_scale, value, type
+    end
+
+    # switch_audio [value] (currently MPEG*, AVI, Matroska and streams handled by libavformat)
+    # <value> Switch to the audio track with the ID <value>.
+    # :cycle available tracks if [value] is omitted or negative.
+    def switch_audio(value = :cycle)
+      select_cycle :switch_audio, value
+    end
+    # switch_angle [value] (DVDs only)
+    # <value> Switch to the DVD angle with the ID [value].
+    # :cycle available angles if [value] is omitted or negative.
+    def switch_angle(value = :cycle)
+      select_cycle :switch_angle, value
+    end
+
+    # switch_title [value] (DVDNAV only)
+    # <value> Switch to the DVD title with the ID [value].
+    # :cycle available titles if [value] is omitted or negative.
+    def switch_title(value = :cycle)
+      select_cycle :switch_title, value
+    end
+
+    # switch_ratio [value]
+    # <value> Change aspect ratio at runtime. [value] is the new aspect ratio expressed
+    # as a float (e.g. 1.77778 for 16/9).
+    # There might be problems with some video filters.
+    def switch_ratio(value); send("switch_ratio #{value}"); end
+
+    # switch_vsync [value]
+    # :on Toggle vsync on
+    # :off Toggle off
+    # nil for just Toggle
+    def switch_vsync(value = nil)
+      toggle :switch_vsync, value
+    end
+    
+    
+  end
+end

data/mplayer-ruby.gemspec

@@ -0,0 +1,75 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mplayer-ruby}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Arthur Chiu"]
+  s.date = %q{2010-02-01}
+  s.description = %q{A Ruby wrapper for MPlayer}
+  s.email = %q{mr.arthur.chiu@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc",
+     "TODO"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "TODO",
+     "VERSION",
+     "examples/general_playback.rb",
+     "lib/mplayer-ruby.rb",
+     "lib/mplayer-ruby/slave.rb",
+     "lib/mplayer-ruby/slave_commands.rb",
+     "lib/mplayer-ruby/slave_video_commands.rb",
+     "mplayer-ruby.gemspec",
+     "test.watchr",
+     "test/mplayer-ruby_test.rb",
+     "test/slave_commands_test.rb",
+     "test/slave_test.rb",
+     "test/slave_video_commands_test.rb",
+     "test/test.mp3",
+     "test/teststrap.rb"
+  ]
+  s.homepage = %q{http://github.com/achiu/mplayer-ruby}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Ruby wrapper for MPlayer}
+  s.test_files = [
+    "test/mplayer-ruby_test.rb",
+     "test/slave_commands_test.rb",
+     "test/slave_test.rb",
+     "test/slave_video_commands_test.rb",
+     "test/teststrap.rb",
+     "examples/general_playback.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<riot>, [">= 0.10.11"])
+      s.add_development_dependency(%q<rr>, [">= 0.10.5"])
+      s.add_runtime_dependency(%q<open4>, [">= 1.0.1"])
+    else
+      s.add_dependency(%q<riot>, [">= 0.10.11"])
+      s.add_dependency(%q<rr>, [">= 0.10.5"])
+      s.add_dependency(%q<open4>, [">= 1.0.1"])
+    end
+  else
+    s.add_dependency(%q<riot>, [">= 0.10.11"])
+    s.add_dependency(%q<rr>, [">= 0.10.5"])
+    s.add_dependency(%q<open4>, [">= 1.0.1"])
+  end
+end
+

data/test.watchr

@@ -0,0 +1,45 @@
+#
+# 'autotest' for riot
+# install watchr
+# $ sudo gem install watchr
+# 
+# Run With:
+# $ watchr test.watchr
+#
+
+# --------------------------------------------------
+# Helpers
+# --------------------------------------------------
+
+def run(cmd)
+  puts(cmd)
+  system(cmd)
+end
+
+def run_all_tests
+  system( "rake test" )
+end
+
+def sudo(cmd)
+  run("sudo #{cmd}")
+end
+
+# --------------------------------------------------
+# Watchr Rules
+# --------------------------------------------------
+watch("^lib.*/(.*)\.rb") { |m| run("ruby -rubygems test/#{m[1]}_test.rb") }
+watch("test.*/teststrap\.rb") { run_all_tests }
+watch('^test.*/(.*)_test\.rb') { |m|  run("ruby -rubygems test/#{m[1]}_test.rb") }
+watch('(.*)\.gemspec') { |m| sudo("rake install") }
+ 
+# --------------------------------------------------
+# Signal Handling
+# --------------------------------------------------
+# Ctrl-\
+Signal.trap('QUIT') do
+  puts " --- Running all tests ---\n\n"
+  run_all_tests
+end
+ 
+# Ctrl-C
+Signal.trap('INT') { abort("\n") }

data/test/mplayer-ruby_test.rb

@@ -0,0 +1,2 @@
+require File.expand_path("teststrap", File.dirname(__FILE__))
+

data/test/slave_commands_test.rb

@@ -0,0 +1,239 @@
+require File.expand_path("teststrap", File.dirname(__FILE__))
+
+context "MPlayer::Player" do
+  setup do
+    mock(Open4).popen4("/usr/bin/mplayer -slave -quiet test/test.mp3") { [true,true,true,true] }
+    stub(true).gets { "playback" }
+    @player = MPlayer::Slave.new('test/test.mp3')
+  end
+
+  context "pause" do
+    setup { mock_send @player, "pause" }
+    asserts("returns true") { @player.pause }
+  end
+
+  context "quit" do
+    setup do
+      mock_send @player, "quit"
+      mock(@player.stdin).close { true }
+    end
+    asserts("returns true") { @player.quit }
+  end
+
+  context "volume" do
+
+    context "increases" do
+      setup { mock_send @player, "volume 1","Volume: 10 %\n",/Volume/ }
+      asserts("returns true") { @player.volume :up }.equals "10"
+    end
+
+    context "decreases" do
+      setup { mock_send @player, "volume 0","Volume: 10 %\n",/Volume/ }
+      asserts("returns true") { @player.volume :down }.equals "10"
+    end
+
+    context "sets volume" do
+      setup { mock_send @player, "volume 40 1","Volume: 10 %\n",/Volume/ }
+      asserts("returns true") { @player.volume :set,40 }.equals "10"
+    end
+
+    context "incorrect action" do
+      setup { @player.volume :boo }
+      asserts("returns false").equals false
+    end
+  end
+
+  context "seek" do
+
+    context "by relative" do
+      setup { mock_send @player, "seek 5 0","Position: 10 %\n",/Position/ }
+      asserts("seek 5") { @player.seek 5 }
+      asserts("seek 5,:relative") { @player.seek 5,:relative }.equals "10"
+    end
+
+    context "by percentage" do
+      setup { mock_send @player, "seek 5 1","Position: 10 %\n",/Position/ }
+      asserts("seek 5,:percent") { @player.seek 5,:percent }.equals "10"
+    end
+
+    context "by absolute" do
+      setup { mock_send @player, "seek 5 2","Position: 10 %\n",/Position/ }
+      asserts("seek 5,:absolute") { @player.seek 5,:absolute }.equals "10"
+    end
+  end
+
+  context "edl_mark" do
+    setup { mock_send @player, "edl_mark"}
+    asserts("returns true") { @player.edl_mark }
+  end
+
+  context "speed_incr" do
+    setup { mock_send @player, "speed_incr 5","Speed: x   10",/Speed/ }
+    asserts("speed_incr 5") { @player.speed_incr 5 }.equals "10"
+  end
+
+  context "speed_mult" do
+    setup { mock_send @player, "speed_mult 5","Speed: x   10",/Speed/ }
+    asserts("speed_mult 5") { @player.speed_mult 5 }.equals "10"
+  end
+
+  context "speed_set" do
+    setup { mock_send @player, "speed_set 5","Speed: x   10",/Speed/ }
+    asserts("speed_set 5") { @player.speed_set 5 }.equals "10"
+  end
+
+  context "speed_set speed_mult speed_incr raise error" do
+    asserts("speed_incr 6") {  @player.speed_incr 6 }.raises ArgumentError,"Value must be less than 6"
+    asserts("speed_mult 6") {  @player.speed_mult 6 }.raises ArgumentError,"Value must be less than 6"
+    asserts("speed_set 6") {  @player.speed_set 6 }.raises ArgumentError,"Value must be less than 6"
+  end
+
+  context "speed" do
+
+    context "increment" do
+      setup { mock(@player).speed_incr(5) { true } }
+      asserts("speed 5,:increment") { @player.speed 5,:increment }
+    end
+
+    context "multiply" do
+      setup { mock(@player).speed_mult(5) { true } }
+      asserts("speed 5,:multiply") { @player.speed 5,:multiply }
+    end
+
+    context "set" do
+      setup { mock(@player).speed_set(5) { true } }
+      asserts("speed 5") {  @player.speed 5 }
+      asserts("speed 5, :set") {  @player.speed 5,:set }
+    end
+  end
+
+  context "frame_step" do
+    setup { mock_send @player, "frame_step" }
+    asserts("returns true") { @player.frame_step }
+  end
+
+  context "pt_step" do
+
+    context "forced" do
+      setup { mock_send @player, "pt_step 5 1" }
+      asserts("pt_step 5, :force") { @player.pt_step 5, :force }
+    end
+
+    context "not forced" do
+      setup { mock_send @player, "pt_step 5 0"  }
+      asserts("pt_step 5") {  @player.pt_step 5 }
+      asserts("pt_step 5, :no_force") { @player.pt_step 5, :no_force }
+    end
+  end
+
+  context "pt_up_step" do
+
+    context "forced" do
+      setup { mock_send @player, "pt_up_step 5 1"}
+      asserts("pt_up_step 5, :force") { @player.pt_up_step 5, :force }
+    end
+
+    context "not forced" do
+      setup { mock_send @player, "pt_up_step 5 0" }
+      asserts("pt_up_step 5") { @player.pt_up_step 5 }
+      asserts("pt_up_step 5, :no_force") { @player.pt_up_step 5, :no_force }
+    end
+  end
+
+  context "alt_src_step" do
+    setup { mock_send @player, "alt_src_step 5" }
+    asserts("returns true") { @player.alt_src_step 5 }
+  end
+
+  context "loop" do
+
+    context "none" do
+      setup { mock_send @player,"loop -1" }
+      asserts("loop :none") { @player.loop :none }
+    end
+
+    context "forever" do
+      setup { mock_send @player, "loop 0" }
+      asserts("loop") { @player.loop }
+      asserts("loop :forever") { @player.loop :forever }
+    end
+
+    context "set value" do
+      setup { mock_send @player,"loop 5" }
+      asserts("loop :set, 5") { @player.loop :set, 5 }
+    end
+  end
+
+  context "use_master" do
+    setup { mock_send @player, "use_master" }
+    asserts("returns true") { @player.use_master }
+  end
+
+  context "mute" do
+
+    context "toggle" do
+      setup { mock_send @player, "mute", "Mute: enabled",/Mute/}
+      asserts("returns true") { @player.mute }.equals "enabled"
+    end
+
+    context "set on" do
+      setup { mock_send @player, "mute 1","Mute: enabled",/Mute/}
+      asserts("mute :on") { @player.mute :on }.equals "enabled"
+    end
+
+    context "set off" do
+      setup { mock_send @player, "mute 0","Mute: enabled",/Mute/}
+      asserts("mute :off") { @player.mute :off }.equals "enabled"
+    end
+  end
+
+  context "get" do
+
+    %w[time_pos time_length file_name video_codec video_bitrate video_resolution
+      audio_codec audio_bitrate audio_samples meta_title meta_artist meta_album
+    meta_year meta_comment meta_track meta_genre].each do |info|
+      context info do
+        resp = case info
+        when "time_pos" then "ANS_TIME_POSITION"
+        when "time_length" then "ANS_LENGTH"
+        when "file_name" then "ANS_FILENAME"
+        else "ANS_#{info.upcase}"
+        end
+        setup { mock_send @player, "get_#{info}","#{resp}='100'",/#{resp}/ }
+        asserts("get :#{info}") { @player.get info.to_sym }
+      end
+    end
+  end
+
+  context "load_file" do
+
+    asserts("invalid file") { @player.load_file 'booger' }.raises ArgumentError,"Invalid File"
+    context "append" do
+      setup { mock_send @player, "loadfile test/test.mp3 1" }
+      asserts("load_file test/test.mp3, :append") { @player.load_file 'test/test.mp3', :append }
+    end
+
+    context "no append" do
+      setup { mock_send @player, "loadfile test/test.mp3 0" }
+      asserts("load_file test/test.mp3") { @player.load_file 'test/test.mp3' }
+      asserts("load_file test/test.mp3, :no_append") { @player.load_file 'test/test.mp3', :no_append }
+    end
+  end
+
+  context "load_list" do
+
+    asserts("invalid playlist") { @player.load_list 'booger' }.raises ArgumentError,"Invalid File"
+    context "append" do
+      setup { mock_send @player, "loadlist test/test.mp3 1" }
+      asserts("load_list test/test.mp3, :append") { @player.load_list 'test/test.mp3', :append }
+    end
+
+    context "no append" do
+      setup { mock_send @player, "loadlist test/test.mp3 0" }
+      asserts("load_list test/test.mp3") { @player.load_list 'test/test.mp3' }
+      asserts("load_list test/test.mp3, :no_append") { @player.load_list 'test/test.mp3', :no_append }
+    end
+  end
+
+
+end