mplayer-ruby 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Arthur Chiu
+
+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.rdoc

@@ -0,0 +1,59 @@
+= mplayer-ruby
+
+A Ruby Wrapper for MPlayer. Controls MPlayer via the Slave Protocol.
+
+
+See examples/ for usage.
+
+
+== Installation
+
+
+=== MPlayer
+
+==== Linux
+
+    $ sudo apt-get install mplayer
+    
+==== Mac OS X
+
+===== via Homebrew
+
+    $ 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
+
+It's hosted on gemcutter.org
+
+   $ sudo gem install mplayer-ruby
+
+
+
+== TODO
+* Complete Slave Protocol 
+* Complete Other Functionalities 
+* Create a Better README
+* RDoc?
+* Example Usages
+
+== 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
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (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 (c) 2010 Arthur Chiu. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,68 @@
+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 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mplayer-ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO

@@ -0,0 +1,47 @@
+
+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]
+sub_log
+
+Player Options
+Audio Options
+Decoding Options
+all the Options...

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/examples/general_playback.rb

@@ -0,0 +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
+
+puts $player.volume :up
+sleep 5
+puts $player.volume :down
+sleep 5
+puts $player.volume :set, 60
+sleep 5
+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
+
+sleep 10
+# step forward
+puts $player.next 1
+sleep 10
+# step backward
+puts $player.back 1
+
+sleep 10
+
+# returns information on the file
+$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
+end
+
+# time_position. fields can also be called as methods
+puts $player.time_position
+puts $player.year
+
+# mute
+puts $player.mute :on
+sleep 10
+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
+
+# sets the speed of playback
+puts ($player.speed 2,:increment)
+puts $player.speed 2,:multiply
+puts $player.speed 1
+
+# quits MPlayer
+puts $player.quit
+
+

data/lib/mplayer-ruby.rb

@@ -0,0 +1,6 @@
+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 }

data/lib/mplayer-ruby/slave.rb

@@ -0,0 +1,63 @@
+module MPlayer
+  class Slave
+    attr_accessor :stdin
+    attr_reader :pid,:stdout,:stderr,:file
+    include MPlayer::SlaveCommands
+    include MPlayer::SlaveVideoCommands
+
+
+    # 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)
+      @file = file
+      mplayer = "#{options[:path]} -slave -quiet #{@file}"
+      @pid,@stdin,@stdout,@stderr = Open4.popen4(mplayer)
+      until @stdout.gets.inspect =~ /playback/ do
+      end #fast forward to the desired output
+    end
+
+    # sends command to mplayer stdin and retrieves stdout.
+    # If match is provided, fast-forwards stdout to matching response.
+    def send(cmd,match = //)
+      @stdin.puts(cmd)
+      response = @stdout.gets
+      until response =~ match
+        response = @stdout.gets
+      end
+      response.gsub("\e[A\r\e[K","")
+    end
+
+    private
+
+    def select_cycle(command,value,match = //)
+      switch = case value
+      when :off then -1
+      when :cycle then -2
+      else value
+      end
+      send "#{command} #{switch}",match
+    end
+
+    def toggle(command,value,match = //)
+      cmd = case value
+      when :on then "#{command} 1"
+      when :off then "#{command} 0"
+      else "#{command}"
+      end
+      send 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
+    end
+
+    def adjust_set(command,value,type = :relative, match = //)
+      switch = ( type == :relative ? 0 : 1 )
+      send "#{command} #{value} #{switch}",match
+    end
+
+  end
+end

data/lib/mplayer-ruby/slave_commands.rb

@@ -0,0 +1,188 @@
+module MPlayer
+  module SlaveCommands
+    # Increase/decrease volume
+    # :up increase volume
+    # :down decreases volume
+    # :set sets the volume at <value>
+    def volume(action,value=30)
+      cmd =
+      case action
+      when :up then "volume 1"
+      when :down then "volume 0"
+      when :set then "volume #{value} 1"
+      else return false
+      end
+      resp = send cmd, /Volume/
+      resp.gsub("Volume: ","").gsub(" %\n","")
+    end
+
+    # Seek to some place in the file
+    # :relative is a relative seek of +/- <value> seconds (default).
+    # :perecent is a seek to <value> % in the file.
+    # :absolute is a seek to an absolute position of <value> seconds.
+    def seek(value,type = :relative)
+      command = case type
+      when :percent then "seek #{value} 1"
+      when :absolute then "seek #{value} 2"
+      else "seek #{value} 0"
+      end
+      resp = send command, /Position/
+      resp.gsub("Position: ","").gsub(" %\n","")
+    end
+
+    # Adjusts the current playback speed
+    # :increment adds <value> to the current speed
+    # :multiply multiplies the current speed by <value>
+    # :set sets the current speed to <value>.(default)
+    def speed(value,type = :set)
+      case type
+      when :increment then speed_incr(value)
+      when :multiply then speed_mult(value)
+      else speed_set(value)
+      end
+    end
+
+    # Adjust/set how many times the movie should be looped.
+    # :none means no loop
+    # :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
+      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.  
+    # 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")
+    end
+
+    # goes to the next entry in the playlist denoted by value.
+    # No action will occur unless :force is specified
+    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
+    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")
+    end
+
+    # Switch volume control between master and PCM.
+    def use_master; send("use_master"); end
+
+    # Toggle sound output muting or set it to [value] when [value] >= 0
+    #     (1 == on, 0 == off).
+    def mute(value = nil)
+      resp = toggle :mute, value, /Mute/
+      resp.gsub("Mute: ","")
+    end
+
+    # returns information on file
+    # available values are:
+    # 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
+    def get(value)
+      match = case value.to_s
+      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}"
+      end
+      resp = send "get_#{value}",/#{match}/
+      resp.gsub("#{match}=","").gsub("'","")
+    end
+
+    # This gives methods for each of the fields that data can be extract on.
+    # Just to provide more syntactic sugar.
+    %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 |field|
+      define_method(field.to_sym) { get(field) }
+    end
+    alias :time_position :time_pos
+    alias :filename :file_name
+    alias :title :meta_title
+    alias :album :meta_album
+    alias :year :meta_year
+    alias :artist :meta_artist
+    alias :comment :meta_comment
+    alias :genre :meta_genre
+
+
+    # Loads the file into 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
+      switch = (append == :append ? 1 : 0)
+      send "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
+      switch = (append == :append ? 1 : 0)
+      send "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
+
+    # Add <value> to the current playback speed.
+    def speed_incr(value)
+      speed_setting :speed_incr, value
+    end
+
+    # Multiply the current speed by <value>.
+    def speed_mult(value)
+      speed_setting :speed_mult, value
+    end
+
+    # Set the speed to <value>.
+    # cannot be greater than 5
+    def speed_set(value)
+      speed_setting :speed_set, value
+    end
+
+    # Play one frame, then pause again.
+    def frame_step; send("frame_step"); end
+
+    # Write the current position into the EDL file.
+    def edl_mark; send("edl_mark"); end
+
+    # Pauses/Unpauses the file.
+    def pause; send("pause") ; end
+
+    # Quits MPlayer
+    def quit
+      send('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   ","")
+    end
+
+  end
+end