mplayer-ruby 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e9ad024a90484d39f8b1efac03b369665c742977
+  data.tar.gz: 8740c2eca2d6800d8d51ae13759b066e04b3d688
+SHA512:
+  metadata.gz: b5179590bd43f0759dc993d7eeda0a45a7de9ec21b71eeed7d7a32a8f784a82564134db3dc314daab2010ae7d19066c28b4df2fb584c2a70b9cf904d32fca605
+  data.tar.gz: 5627fdd4bdbd058d368811e60750f31eadfbb78db7988fe8ba11d68a115bd80f0a93f4fe86c769eb05f67cb92e27b4a8ac19e11660ee6a6807d89bebc5263c58

data/.gitignore

@@ -17,5 +17,6 @@ tmtags
 coverage
 rdoc
 pkg
+Gemfile.lock
 
 ## PROJECT::SPECIFIC

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+script: bundle exec rake
+matrix:
+  allow_failures:
+    - rvm: 1.8.7
+    - rvm: ruby-head

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Change Log
+
+## [Unreleased](https://github.com/petems/mplayer-ruby/tree/HEAD)
+
+[Full Changelog](https://github.com/petems/mplayer-ruby/compare/v0.1.0...HEAD)
+
+**Merged pull requests:**
+
+- Merge pull requests 8 and 9 [\#10](https://github.com/petems/mplayer-ruby/pull/10) ([arirusso](https://github.com/arirusso))
+
+- Enable passing arbitrary command-line options on startup [\#9](https://github.com/petems/mplayer-ruby/pull/9) ([arirusso](https://github.com/arirusso))
+
+- Add option to start in fullscreen [\#8](https://github.com/petems/mplayer-ruby/pull/8) ([arirusso](https://github.com/arirusso))
+
+- Quote filename for load\_file and load\_list commands [\#6](https://github.com/petems/mplayer-ruby/pull/6) ([dfyx](https://github.com/dfyx))
+
+- Let operating system find mplayer [\#5](https://github.com/petems/mplayer-ruby/pull/5) ([dfyx](https://github.com/dfyx))
+
+- Fix HTTP leading to "Invalid File" error [\#4](https://github.com/petems/mplayer-ruby/pull/4) ([dfyx](https://github.com/dfyx))
+
+- Allow media file names with spaces in them \(Second try, now with working tests\) [\#3](https://github.com/petems/mplayer-ruby/pull/3) ([cmol](https://github.com/cmol))
+
+- Merging in @freenerd's URI support stuff, looks good... [\#1](https://github.com/petems/mplayer-ruby/pull/1) ([petems](https://github.com/petems))
+
+- Edit: Add quotes around the media file parameter for mplayer [\#2](https://github.com/petems/mplayer-ruby/pull/2) ([cmol](https://github.com/cmol))
+
+## [v0.1.0](https://github.com/petems/mplayer-ruby/tree/v0.1.0) (2010-02-01)
+
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/{README.rdoc → README.md}

@@ -1,51 +1,39 @@
-= mplayer-ruby
+# mplayer-ruby [![Build Status](https://travis-ci.org/petems/mplayer-ruby.svg?branch=master)](https://travis-ci.org/petems/mplayer-ruby)
 
 A Ruby Wrapper for MPlayer. Controls MPlayer via the Slave Protocol.
 
+See [RDOC](http://mplayer-ruby.rubyforge.org/mplayer-ruby/index.html) for additional information.
 
-See examples/ for usage.
+See [examples/](http://github.com/petems/mplayer-ruby/tree/master/examples/) for usage.
 
 
-== Installation
+## Installation
 
 
-=== MPlayer
+### MPlayer
 
-==== Linux
+#### Linux
 
     $ sudo apt-get install mplayer
-    
-==== Mac OS X
 
-===== via Homebrew
+#### Mac OS X
 
-    $ brew install mplayer
-    
-===== via download
-
- download (Mac OS X Extended)[http://www.mplayerhq.hu/homepage/design7/news.html].
-
- then create a symbolic link for mplayer.
- 
-    $ sudo ln -s "/Applications/MPlayer OSX Extended.app/Contents/Resources/External_Binaries/mplayer.app/Contents/MacOS/mplayer" /usr/bin/mplayer
-
-=== MPlayer-ruby
+##### via Homebrew
 
-It's hosted on gemcutter.org
-
-   $ sudo gem install mplayer-ruby
+    $ brew install mplayer
 
+### MPlayer-ruby
 
+    $ gem install mplayer-ruby
 
-== TODO
-* Complete Slave Protocol 
-* Complete Other Functionalities 
+## TODO
+* Complete Slave Protocol
+* Complete Other Functionalities
 * Create a Better README
-* RDoc?
 * Example Usages
 
-== Note on Patches/Pull Requests
- 
+## Note on Patches/Pull Requests
+
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a
@@ -54,6 +42,6 @@ It's hosted on gemcutter.org
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
-== Copyright
+## Copyright
 
 Copyright (c) 2010 Arthur Chiu. See LICENSE for details.

data/Rakefile

@@ -1,24 +1,6 @@
 require 'rubygems'
 require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "mplayer-ruby"
-    gem.summary = %Q{Ruby wrapper for MPlayer}
-    gem.description = %Q{A Ruby wrapper for MPlayer}
-    gem.email = "mr.arthur.chiu@gmail.com"
-    gem.homepage = "http://github.com/achiu/mplayer-ruby"
-    gem.authors = ["Arthur Chiu"]
-    gem.add_development_dependency "riot", ">= 0.10.11"
-    gem.add_development_dependency "rr", ">=0.10.5"
-    gem.add_dependency "open4", ">=1.0.1"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
+require 'bundler/gem_tasks'
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
@@ -40,8 +22,6 @@ rescue LoadError
   end
 end
 
-task :test => :check_dependencies
-
 begin
   require 'reek/adapters/rake_task'
   Reek::RakeTask.new do |t|
@@ -57,7 +37,7 @@ end
 
 task :default => :test
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 

data/TODO

@@ -1,44 +1,10 @@
 
 Slave Commands:
-
-balance              Float
-tv_start_scan       
-tv_step_channel      Integer
-tv_step_norm        
-tv_step_chanlist    
-tv_set_channel       String
-tv_last_channel     
-tv_set_freq          Float
-tv_step_freq         Float
-tv_set_norm          String
-tv_set_brightness    Integer [Integer]
-tv_set_contrast      Integer [Integer]
-tv_set_hue           Integer [Integer]
-tv_set_saturation    Integer [Integer]
-forced_subs_only     [Integer]
-switch_ratio         [Float]
-vo_fullscreen        [Integer]
-vo_ontop             [Integer]
 file_filter          Integer
-vo_rootwin           [Integer]
-vo_border            [Integer]
-screenshot           [Integer]
-panscan              Float [Integer]
-switch_vsync         [Integer]
-loadfile             String [Integer]
-loadlist             String [Integer]
 run                  String
-change_rectangle     Integer Integer
-dvdnav               String
-get_vo_fullscreen   
-get_sub_visibility  
 key_down_event       Integer
-set_property         String String
-get_property         String
-step_property        String [Float] [Integer]
-seek_chapter         Integer [Integer]
 set_mouse_pos        Integer Integer
-vobsub_lang          [Integer]
+vobsub_lang          [Integer] - stub linked
 sub_log
 
 Player Options

data/examples/general_playback.rb

@@ -1,60 +1,60 @@
 require File.join(File.dirname(__FILE__),'..','lib','mplayer-ruby')
 
-$player = MPlayer::Slave.new '/Volumes/Storage/Music/segundo.ogg', :path => '/usr/bin/mplayer' #defauults to /usr/bin/mplayer
+@player = MPlayer::Slave.new '/Volumes/Storage/Music/segundo.ogg', :path => '/usr/bin/mplayer' #defauults to /usr/bin/mplayer
 
-puts $player.volume :up
+puts @player.volume :up
 sleep 5
-puts $player.volume :down
+puts @player.volume :down
 sleep 5
-puts $player.volume :set, 60
+puts @player.volume :set, 60
 sleep 5
-load file and play immediately
-puts $player.load_file "/Volumes/Storage/Music/primero.ogg", :no_append
+# load file and play immediately
+puts @player.load_file "/Volumes/Storage/Music/primero.ogg", :no_append
 
 sleep 10
 
 # load file and queue
 # load_file(file) defaults to :append
-puts $player.load_file "/Volumes/Storage/Music/segundo.ogg", :append
+puts @player.load_file "/Volumes/Storage/Music/segundo.ogg", :append
 
 sleep 10
 # step forward
-puts $player.next 1
+puts @player.next 1
 sleep 10
 # step backward
-puts $player.back 1
+puts @player.back 1
 
 sleep 10
 
 # returns information on the file
-$player.get :meta_artist
-$player.get :meta_album
-$player.get :meta_track
+@player.get :meta_artist
+@player.get :meta_album
+@player.get :meta_track
 %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 |line|
-  puts $player.get line
+  puts @player.get line
 end
 
 # time_position. fields can also be called as methods
-puts $player.time_position
-puts $player.year
+puts @player.time_position
+puts @player.year
 
 # mute
-puts $player.mute :on
+puts @player.mute :on
 sleep 10
-puts $player.mute # toggles back to off
+puts @player.mute # toggles back to off
 # seek to position in song
-puts $player.seek 2
-puts $player.seek 10, :percent
-puts $player.seek 20, :absolute
+puts @player.seek 2
+puts @player.seek 10, :percent
+puts @player.seek 20, :absolute
 
 # sets the speed of playback
-puts ($player.speed 2,:increment)
-puts $player.speed 2,:multiply
-puts $player.speed 1
+puts @player.speed 2,:increment
+puts @player.speed 2,:multiply
+puts @player.speed 1
 
 # quits MPlayer
-puts $player.quit
+puts @player.quit
 
 

data/lib/mplayer-ruby.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'open4'
-require 'active_support/core_ext/hash'
 require File.dirname(__FILE__) + '/mplayer-ruby/slave_commands'
 require File.dirname(__FILE__) + '/mplayer-ruby/slave_video_commands'
-Dir[File.dirname(__FILE__) + '/mplayer-ruby/**/*.rb'].each { |lib| require lib }
+require File.dirname(__FILE__) + '/mplayer-ruby/slave_tv_commands'
+require File.dirname(__FILE__) + '/mplayer-ruby/slave_sub_commands'
+require File.dirname(__FILE__) + '/mplayer-ruby/slave'

data/lib/mplayer-ruby/slave.rb

@@ -4,25 +4,32 @@ module MPlayer
     attr_reader :pid,:stdout,:stderr,:file
     include MPlayer::SlaveCommands
     include MPlayer::SlaveVideoCommands
-
+    include MPlayer::SlaveTvCommands
+    include MPlayer::SlaveSubCommands
+    require 'uri'
 
     # Initializes a new instance of MPlayer.
     # set :path to point to the location of mplayer
     # defaults to '/usr/bin/mplayer'
-    def initialize(file = "",options ={:path => '/usr/bin/mplayer'})
-      raise ArgumentError,"Invalid File" unless File.exists?(file)
+    def initialize(file = "",options ={})
+      unless File.exists?(file) || URI::regexp.match(file)
+        raise ArgumentError,"Invalid File"
+      end
+      options[:path] ||= 'mplayer'
       @file = file
-      mplayer = "#{options[:path]} -slave -quiet #{@file}"
+
+      mplayer = invocation(options)
+
       @pid,@stdin,@stdout,@stderr = Open4.popen4(mplayer)
       until @stdout.gets.inspect =~ /playback/ do
-      end #fast forward to the desired output
+      end #fast forward past mplayer's initial output
     end
 
-    # sends command to mplayer stdin and retrieves stdout.
+    # commands command to mplayer stdin and retrieves stdout.
     # If match is provided, fast-forwards stdout to matching response.
-    def send(cmd,match = //)
+    def command(cmd,match = //)
       @stdin.puts(cmd)
-      response = @stdout.gets
+      response = ""
       until response =~ match
         response = @stdout.gets
       end
@@ -31,13 +38,29 @@ module MPlayer
 
     private
 
+    # Command line string to invoke mplayer
+    # @param [Hash] options
+    # @option options [Boolean] :fullscreen Whether to start in fullscreen
+    # @option options [String] :options Arbitrary command line options
+    # @option options [Boolean] :screenshot Whether to enable screenshots
+    # @return [String]
+    def invocation(options = {})
+      path = options[:path] || "mplayer"
+      command = "#{path} -slave -quiet "
+      command += "-fs " if options[:fullscreen]
+      command += "-vf screenshot " if options[:screenshot]
+      command += "#{options[:options]} " unless options[:options].nil?
+      command += "\"#{@file}\""
+      command
+    end
+
     def select_cycle(command,value,match = //)
       switch = case value
       when :off then -1
       when :cycle then -2
       else value
       end
-      send "#{command} #{switch}",match
+      command "#{command} #{switch}",match
     end
 
     def toggle(command,value,match = //)
@@ -46,17 +69,17 @@ module MPlayer
       when :off then "#{command} 0"
       else "#{command}"
       end
-      send cmd,match
+      command cmd,match
     end
 
     def setting(command,value,type, match = //)
       raise(ArgumentError,"Value out of Range -100..100") unless (-100..100).include?(value)
-      adjust_set command, value, type
+      adjust_set command, value, type, match
     end
 
     def adjust_set(command,value,type = :relative, match = //)
       switch = ( type == :relative ? 0 : 1 )
-      send "#{command} #{value} #{switch}",match
+      command "#{command} #{value} #{switch}",match
     end
 
   end

data/lib/mplayer-ruby/slave_commands.rb

@@ -12,7 +12,7 @@ module MPlayer
       when :set then "volume #{value} 1"
       else return false
       end
-      resp = send cmd, /Volume/
+      resp = command cmd, /Volume/
       resp.gsub("Volume: ","").gsub(" %\n","")
     end
 
@@ -26,7 +26,7 @@ module MPlayer
       when :absolute then "seek #{value} 2"
       else "seek #{value} 0"
       end
-      resp = send command, /Position/
+      resp = command command, /Position/
       resp.gsub("Position: ","").gsub(" %\n","")
     end
 
@@ -47,19 +47,19 @@ module MPlayer
     # :forever means loop forever.(default)
     # :set sets the amount of times to loop. defaults to one loop.
     def loop(action = :forever,value = 1)
-      send case action
+      command case action
       when :none then "loop -1"
       when :set then "loop #{value}"
       else "loop 0"
       end
     end
 
-    # Go to the next/previous entry in the playtree. 
-    #T he sign of <value> tells the direction.  
+    # Go to the next/previous entry in the playtree.
+    #T he sign of <value> tells the direction.
     # If no entry is available in the given direction it will do
     # nothing unless :force
     def pt_step(value,force = :no_force)
-      send(force == :force ? "pt_step #{value} 1" : "pt_step #{value} 0")
+      command(force == :force ? "pt_step #{value} 1" : "pt_step #{value} 0")
     end
 
     # goes to the next entry in the playlist denoted by value.
@@ -67,22 +67,21 @@ module MPlayer
     def next(value,force = :no_force)
       pt_step value.abs, force
     end
-    
+
     # goes to the previous entry in the playlist denoted by value.
     # No action will occur unless :force is specified
     def back(value,force = :no_force)
-      v = "-" + value.to_s.gsub("-","")
-      pt_step v, force
+      pt_step -value.abs, force
     end
 
     # Similar to pt_step but jumps to the next/previous entry in the parent list.
     # Useful to break out of the inner loop in the playtree.
     def pt_up_step(value,force = :no_force)
-      send(force == :force ? "pt_up_step #{value} 1" : "pt_up_step #{value} 0")
+      command(force == :force ? "pt_up_step #{value} 1" : "pt_up_step #{value} 0")
     end
 
     # Switch volume control between master and PCM.
-    def use_master; send("use_master"); end
+    def use_master; command("use_master"); end
 
     # Toggle sound output muting or set it to [value] when [value] >= 0
     #     (1 == on, 0 == off).
@@ -97,14 +96,14 @@ module MPlayer
     # audio_codec audio_bitrate audio_samples meta_title meta_artist meta_album
     # meta_year meta_comment meta_track meta_genre
     def get(value)
-      match = case value.to_s
+      field = value.to_s
+      match = case field
       when "time_pos" then "ANS_TIME_POSITION"
       when "time_length" then "ANS_LENGTH"
       when "file_name" then "ANS_FILENAME"
-      else "ANS_#{value.to_s.upcase}"
+      else "ANS_#{field.upcase}"
       end
-      resp = send "get_#{value}",/#{match}/
-      resp.gsub("#{match}=","").gsub("'","")
+      command("get_#{value}",/#{match}/).gsub("#{match}=","").gsub("'","")
     end
 
     # This gives methods for each of the fields that data can be extract on.
@@ -128,23 +127,27 @@ module MPlayer
     # :append loads the file and appends it to the current playlist
     # :no_append will stop playback and play new loaded file
     def load_file(file,append = :no_append)
-      raise ArgumentError,"Invalid File" unless File.exists? file
+      unless File.exists?(file) || URI::regexp.match(file)
+        raise ArgumentError,"Invalid File"
+      end
       switch = (append == :append ? 1 : 0)
-      send "loadfile #{file} #{switch}"
+      command "loadfile \"#{file}\" #{switch}"
     end
 
     # Loads the playlist into MPlayer
     # :append loads the playlist and appends it to the current playlist
     # :no_append will stop playback and play new loaded playlist
     def load_list(file,append = :no_append)
-      raise ArgumentError,"Invalid File" unless File.exists? file
+      unless File.exists?(file) || URI::regexp.match(file)
+        raise ArgumentError,"Invalid File"
+      end
       switch = (append == :append ? 1 : 0)
-      send "loadlist #{file} #{switch}"
+      command "loadlist \"#{file}\" #{switch}"
     end
 
     # When more than one source is available it selects the next/previous one.
     # ASX Playlist ONLY
-    def alt_src_step(value); send("alt_src_step #{value}"); end
+    def alt_src_step(value); command("alt_src_step #{value}"); end
 
     # Add <value> to the current playback speed.
     def speed_incr(value)
@@ -162,26 +165,31 @@ module MPlayer
       speed_setting :speed_set, value
     end
 
+    #set balance to <value>
+    def balance(value)
+      command("balance #{value}")
+    end
+
     # Play one frame, then pause again.
-    def frame_step; send("frame_step"); end
+    def frame_step; command("frame_step"); end
 
     # Write the current position into the EDL file.
-    def edl_mark; send("edl_mark"); end
+    def edl_mark; command("edl_mark"); end
 
     # Pauses/Unpauses the file.
-    def pause; send("pause") ; end
+    def pause; command("pause") ; end
 
     # Quits MPlayer
     def quit
-      send('quit')
+      command('quit')
       @stdin.close
     end
 
     private
-    
+
     def speed_setting(command,value)
       raise ArgumentError,"Value must be less than 6" unless value <= 5
-      send("#{command} #{value}",/Speed/).gsub("Speed: x   ","")
+      command("#{command} #{value}",/Speed/).gsub("Speed: x   ","")
     end
 
   end