vlc-client 0.0.1.beta

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc
+.sublime/
+Guardfile
+trials

data/.rspec

@@ -0,0 +1 @@
+-r ./spec/helper.rb -c -f documentation

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+script: bundle exec rake --verbose --trace
+matrix:
+  allow_failures:
+      - rvm: ruby-head
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ruby-head

data/.yardopts

@@ -0,0 +1,2 @@
+--no-private --protected --markup markdown lib/**/*.rb - README.md LICENSE
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vlc.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Miguel Guinada
+
+MIT License
+
+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

@@ -0,0 +1,108 @@
+# vlc-client [![Build Status](https://secure.travis-ci.org/mguinada/vlc-client.png?branch=master)](http://travis-ci.org/mguinada/vlc-client)
+
+vlc-client manages a [VLC media player](http://www.videolan.org/vlc/) through it's RC interface.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'vlc-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vlc-client
+
+## Usage
+
+### Create a client and connect to a running VLC media play instance.
+
+```ruby
+
+#Expects a VLC media player running on 192.168.1.10:9999
+#e.g. vlc --extraintf rc --rc-host 192.168.1.10:9999"
+
+vlc = VLC::Client.new('192.168.1.10', 9999)
+# => "#<VLC::Client:0x0000000229c370 @server=#<VLC::Server:0x0000000229c6e0 @headless=false, @port=9999, @host=\"192.168.1.10\", @pid=10514>, @self_managed=true, @connection=#<VLC::Connection:0x0000000229c258 @port=9999, @host=\"192.168.1.10\", @socket=#<TCPSocket:fd 5>>>"
+
+vlc.connect
+# => true
+vlc.play('http://example.org/media.mp3') #play media
+=> true
+vlc.playing?
+=> true
+vlc.fullscreen
+=> true
+#...
+
+```
+
+### Create a self managed client/server system.
+_(requires a local installation of VLC media player)_
+
+```ruby
+
+vlc = VLC::System.new #A local VLC client/server system where a local VLC server is automaticaly managed
+# => "#<VLC::System:0x00000001bbb1a0 @client=#<VLC::Client:0x00000001bbade0 @server=#<VLC::Server:0x00000001bbb178 @headless=false, @port=9595, @host=\"localhost\", @pid=11225>, @connection=#<VLC::Connection:0x00000001bbacc8 @port=9595, @host=\"localhost\", @socket=#<TCPSocket:fd 5>>>>"
+
+vlc.connected? #auto_connect
+=> true
+
+vlc.play('http://example.org/media.mp3')
+=> true
+
+vlc.progress
+=> 1 #%
+#...
+
+#Technically this the same as
+vlc = VLC::Client.new(VLC::Server.new('localhost', 9595, false))
+# => "#<VLC::Client:0x000000011de128 @server=#<VLC::Server:0x000000011de380 @headless=false, @port=9595, @host=\"localhost\", @pid=12656>, @connection=#<VLC::Connection:0x000000011de038 @port=9595, @host=\"localhost\", @socket=#<TCPSocket:fd 5>>>"
+```
+
+###Get local VLC server lifecycle management control
+_(requires a local installation of VLC media player)_
+
+```ruby
+
+vlc = VLC::System.new('127.0.0.1', 9999, auto_start: false)
+=> "#<VLC::System:0x00000001695f68 @client=#<VLC::Client:0x0000000169d718 @server=#<VLC::Server:0x00000001695ec8 @headless=false, @port=9999, @host=\"127.0.0.1\", @pid=VLC::NullObject>, @connection=#<VLC::Connection:0x0000000169d588 @port=9999, @host=\"127.0.0.1\", @socket=VLC::NullObject>>>"
+
+vlc.server.running?
+# => false
+vlc.server.start
+# => 12672
+vlc.connect
+# => true
+```
+
+## Reference
+
+[reference](http://rdoc.info/github/mguinada/vlc-client)
+
+## Support
+
+vlc-client has been tested on linux only.
+If you need support for other OS a pull request is welcome.
+
+## Contributing
+
+1. Fork it
+2. Create your topic branch (`git checkout -b my-topic-branch`)
+3. Add/change specs for your unimplemented feature or bug fix
+4. Make sure specs fail by running `bundle exec rake spec`. If not return to step 3
+5. Hack it
+6. Make sure specs pass (`bundle exec rake spec`). If not return to step 5
+7. Edit the documentation so it is coherent with your feature or fix. Run `bundle exec rake yard` to review
+8. Commit changes (`git commit -am 'Add some feature/fix'`) and push to the branch (`git push origin my-topic-branch`)
+9. Submit a pull request for your branch.
+
+## Copyright
+
+Copyright (c) 2012 Miguel Guinada
+[LICENSE][] for details.
+
+[license]: https://github.com/mguinada/vlc-client/blob/master/LICENSE

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+
+task :test    => :spec
+task :default => :spec
+
+RSpec::Core::RakeTask.new do |task|
+  task.rspec_opts = ["-c", "-f documentation", "-r ./spec/helper.rb"]
+  task.pattern    = 'spec/**/*_spec.rb'
+end
+
+desc "Open an interactive session preloaded with this gem's code"
+task :console do
+  if gem_available?("pry")
+    sh "pry -I lib -r vlc-client.rb"
+  else
+    sh "irb -rubygems -I lib -r vlc-client.rb"
+  end
+end
+
+namespace :doc do
+  desc "Generate documentation"
+  YARD::Rake::YardocTask.new do |t|
+    t.files   = ['lib/**/*.rb']
+    t.options = ['--no-private', '--protected', '--markup', 'markdown']
+  end
+end
+
+#
+# Determins if a gem is available at the current runtime
+#
+def gem_available?(name)
+  Gem::Specification.find_by_name(name)
+rescue Gem::LoadError
+  false
+rescue
+  Gem.available?(name) #for backwards compatibility
+end

data/lib/vlc-client.rb

@@ -0,0 +1,102 @@
+require 'uri'
+require 'socket'
+require 'retryable'
+
+require 'vlc-client/version'
+
+require 'vlc-client/null_object'
+
+require 'vlc-client/core_ext/array'
+
+require 'vlc-client/server'
+require 'vlc-client/connection'
+require 'vlc-client/errors'
+
+require 'vlc-client/client/media_controls'
+require 'vlc-client/client/video_controls'
+require 'vlc-client/client/connection_management'
+
+require 'vlc-client/system'
+
+module VLC
+  # The VLC client
+  class Client
+    include VLC::Client::MediaControls
+    include VLC::Client::VideoControls
+    include VLC::Client::ConnectionManagement
+
+    attr_accessor :host,
+                  :port,
+                  :server
+
+    # Creates a client to manage VLC media player
+    #
+    # @overload initialize(host, port) sets the host and port
+    #
+    #   @param [String] host The ip to connect to
+    #   @param [Integer] port the port
+    #
+    #   @example
+    #     vlc = VLC::Client.new('10.10.0.10', 9000)
+    #
+    # @overload initialize(server, options) handle a server wrapper for a self-managed operation mode. This requires a local VLC media play instalation.
+    #
+    #   @param [Server] server a VLC server lifecycle manager
+    #   @param [Hash] options
+    #   @option options [Boolean] :auto_start When false, the server lifecycle is not managed automatically and controll is passed to the developer
+    #   @option options [Integer] :conn_retries Number of connection retries (each separated by a second) to make on auto-connect. Defaults to 5.
+    #
+    #   @example
+    #     vlc = VLC::Client.new(VLC::Server.new)
+    #     vlc.server.started?
+    #     => true
+    #
+    #     vlc = VLC::Client.new(VLC::Server.new, auto_start: false)
+    #     vlc.server.started?
+    #     => false
+    #
+    # @return [VLC::VLC] a VLC client
+    #
+    # @raise [VLC::ConnectionRefused] if the connection fails
+    #
+    def initialize(*args)
+      args = NullObject.Null?(args)
+      options = args.extract_options!
+
+      process_args(args)
+      @connection = Connection.new(host, port)
+      bind_server(server, options) unless server.nil?
+    end
+
+    private
+    attr_reader :connection
+
+    def bind_server(server, options = {})
+      @connection.host = server.host
+      @connection.port = server.port
+
+      if options.fetch(:auto_start, true)
+        begin
+          @server.start
+          retryable(:tries => options.fetch(:conn_retries, 5), :on => VLC::ConnectionRefused) { connect }
+        rescue VLC::ConnectionRefused => e
+          @server.stop
+          raise e
+        end
+      end
+    end
+
+    def process_args(args)
+      case args.size
+      when 1
+        @server = args.first
+      when 2
+        @host = args.first.to_s
+        @port = Integer(args.last)
+      else
+        @host, @port = 'localhost', 9595
+      end
+      args
+    end
+  end
+end

data/lib/vlc-client/client/connection_management.rb

@@ -0,0 +1,23 @@
+module VLC
+  class Client
+    module ConnectionManagement
+      # Connects to VLC RC interface on Client#host and Client#port
+      def connect
+        connection.connect
+      end
+
+      # Disconnects from VLC RC interface
+      def disconnect
+        connection.disconnect
+      end
+
+      # Queries if there is an active connection to VLC RC interface
+      #
+      def connected?
+        connection.connected?
+      end
+
+      def disconnected?; not connected?; end
+    end
+  end
+end

data/lib/vlc-client/client/media_controls.rb

@@ -0,0 +1,98 @@
+module VLC
+  class Client
+    module MediaControls
+      # Plays media or resumes playback
+      #
+      # @overload play(media)
+      #   addes the given media and plays it
+      #
+      #   @param media [String, File, URI] the media to be played
+      #
+      #   @example
+      #     vlc.play('http://example.org/media.mp3')
+      #
+      # @overload play
+      #   plays the current media or resume playback is paused
+      #
+      #   @example
+      #     vlc.play('http://example.org/media.mp3')
+      #     vlc.pause
+      #     vlc.play #resume playback
+      #
+      def play(media = nil)
+        connection.write(media.nil? ? "play" : "add #{media_arg(media)}")
+      end
+
+      # Pauses playback
+      #
+      def pause
+        connection.write("pause")
+      end
+
+      # Stops media currently playing
+      #
+      def stop
+        connection.write("stop")
+      end
+
+      # Gets the title of the media at play
+      #
+      def title
+        connection.write("get_title", false)
+      end
+
+      # Gets the current playback progress in time
+      #
+      # @return [Integer] time in seconds
+      #
+      def time
+        Integer(connection.write("get_time", false))
+      rescue ArgumentError
+        0
+      end
+
+      # Gets the length of the media being played
+      #
+      # @return [Integer] time in seconds
+      #
+      def length
+        Integer(connection.write("get_length", false))
+      rescue ArgumentError
+        0
+      end
+
+      # Get the progress of the the media being played
+      #
+      # @return [Integer] a relative value on percentage
+      #
+      def progress
+        l = length
+        l.zero? ? 0 : 100 * time / l
+      end
+
+      # Queries VLC if media is being played
+      #
+      def playing?
+        connection.write("is_playing", false) == "1"
+      end
+
+      # Queries VLC if playback is currently stopped
+      #
+      def stopped?
+        connection.write("is_playing", false) == "0"
+      end
+
+      private
+      def media_arg(media)
+        case media
+        when File
+          media.path
+        when String, URI
+          media
+        else
+          raise ArgumentError, "Can play: #{media}"
+        end
+      end
+    end
+  end
+end