mpv 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c9709a37f45494f1a9eb585ffd75d5c5bde46216
+  data.tar.gz: 8fe87470f1136dfb73d8fd7c5b8c0224a2f10f51
+SHA512:
+  metadata.gz: 6182028b78524c2f4df68fbc21623cb411fa9fdf03264d29de43d201315c2dbe5c57e87a18433eda6c5d8da92643d38aac8d04f9595cb5be7be0d71c82ab92e1
+  data.tar.gz: becd50aef26eee2637429b8f02df03c638d4af8b609f7051cc7e1d707987207ff74dc7e1fc32a028193f0522f8d27b12905595329d16539a126b4da2582a50c7

data/.yardopts

@@ -0,0 +1 @@
+--tag command:"muzak command" --tag cmdexample:"example invocation" --no-private --markup-provider=redcarpet --markup=markdown - *.md LICENSE

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 William Woodruff <william @ tuffbizz.com>
+
+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,28 @@
+ruby-mpv
+========
+
+A ruby library for controlling mpv processes.
+
+### Installation
+
+```bash
+$ gem install mpv
+```
+
+### Example
+
+For full documentation, please see the [RubyDocs]().
+
+```irb
+# this will be called every time mpv sends an event back over the socket
+def event(event)
+  puts "look ma! a callback: #{event}"
+end
+
+session = MPV::Session.new # contains both a MPV::Server and a MPV::Client
+session.client.callbacks << self
+session.client.get_property "pause"
+session.client.command "get_version"
+session.client.command "loadlist", "my_huge_playlist.txt", "append"
+session.client.quit!
+```

data/lib/mpv.rb

@@ -0,0 +1,9 @@
+require_relative "mpv/client"
+require_relative "mpv/server"
+require_relative "mpv/session"
+
+# The toplevel namespace for ruby-mpv.
+module MPV
+  # The current version of ruby-mpv.
+  VERSION = "0.0.1".freeze
+end

data/lib/mpv/client.rb

@@ -0,0 +1,119 @@
+require "socket"
+require "json"
+require "thread"
+
+module MPV
+  # Represents a connection to a mpv process that has been spawned
+  # with an IPC socket.
+  # @see https://mpv.io/manual/stable/#json-ipc
+  #  MPV's IPC docs
+  # @see https://mpv.io/manual/master/#properties
+  #  MPV's property docs
+  class Client
+    # @return [String] the path of the socket used to communicate with mpv
+    attr_reader :socket_path
+
+    # @return [Array<Object>] objects whose #event method will be called
+    #  whenever mpv emits an event
+    attr_accessor :callbacks
+
+    # @param path [String] the domain socket for communication with mpv
+    def initialize(path)
+      @socket_path = path
+
+      @socket = UNIXSocket.new(@socket_path)
+
+      @callbacks = []
+
+      @command_queue = Queue.new
+      @result_queue = Queue.new
+      @event_queue = Queue.new
+
+      @command_thread = Thread.new { pump_commands! }
+      @results_thread = Thread.new { pump_results! }
+      @events_thread = Thread.new { dispatch_events! }
+    end
+
+    # Sends a command to the mpv process.
+    # @param args [Array] the individual command arguments to send
+    # @return [Hash] mpv's response to the command
+    # @example
+    #  client.command "loadfile", "mymovie.mp4", "append-play"
+    def command(*args)
+      payload = {
+        "command" => args
+      }
+
+      @command_queue << JSON.generate(payload)
+
+      @result_queue.pop
+    end
+
+    # Sends a property change to the mpv process.
+    # @param args [Array] the individual property arguments to send
+    # @return [Hash] mpv's response
+    # @example
+    #  client.set_property "pause", true
+    def set_property(*args)
+      command "set_property", *args
+    end
+
+    # Retrieves a property from the mpv process.
+    # @param args [Array] the individual property arguments to send
+    # @return [Object] the value of the property
+    # @example
+    #  client.get_property "pause" # => true
+    def get_property(*args)
+      command("get_property", *args)["data"]
+    end
+
+    # Terminates the mpv process.
+    # @return [void]
+    # @note this object becomes garbage once this method is run
+    def quit!
+      command "quit"
+      @socket = nil
+      File.delete(@socket_path) if File.exist?(@socket_path)
+    end
+
+    private
+
+    def pump_commands!
+      loop do
+        begin
+          @socket.puts(@command_queue.pop)
+        rescue EOFError # the player is deactivating
+          Thread.exit
+        end
+      end
+    end
+
+    def pump_results!
+      loop do
+        begin
+          response = JSON.parse(@socket.readline)
+
+          if response["event"]
+            @event_queue << response["event"]
+          else
+            @result_queue << response
+          end
+        rescue EOFError, IOError # the player is deactivating
+          Thread.exit
+        end
+      end
+    end
+
+    def dispatch_events!
+      loop do
+        event = @event_queue.pop
+
+        callbacks.each do |callback|
+          Thread.new do
+            callback.send :event, event if callback.respond_to?(:event)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mpv/server.rb

@@ -0,0 +1,40 @@
+require "tempfile"
+
+module MPV
+  # Represents an active mpv process.
+  class Server
+    # @return [Array<String>] the command-line arguments used when spawning mpv
+    attr_reader :args
+
+    # @return [String] the path to the socket used by this mpv process
+    attr_reader :socket_path
+
+    # @return [Fixnum] the process id of the mpv process
+    attr_reader :pid
+
+    # @param path [String] the path of the socket to be created
+    #  (defaults to a tmpname in `/tmp`)
+    # @param user_args [Array<String>] additional arguments to use when
+    #  spawning mpv
+    def initialize(path: Dir::Tmpname.make_tmpname("/tmp/mpv", ".sock"),
+                   user_args: [])
+      @socket_path = path
+      @args = [
+        "--idle",
+        "--no-terminal",
+        "--input-ipc-server=%{path}" % { path: @socket_path },
+      ] + user_args
+
+      @pid = Process.spawn("mpv", *@args)
+    end
+
+    # @return [Boolean] Whether or not the current instance is running.
+    def running?
+      begin
+        !!@pid && Process.waitpid(@pid, Process::WNOHANG).nil?
+      rescue Errno::ECHILD
+        false
+      end
+    end
+  end
+end

data/lib/mpv/session.rb

@@ -0,0 +1,31 @@
+module MPV
+  # Represents a combined mpv "server" and "client" communicating over
+  # JSON IPC.
+  class Session
+    # @return [String] the path of the socket being used for communication
+    attr_reader :socket_path
+
+    # @return [MPV::Server] the server object responsible for the mpv process
+    attr_reader :server
+
+    # @return [MPV::Client] the client communicating with mpv
+    attr_reader :client
+
+    # @param path [String] the path of the socket to create
+    #  (defaults to a tmpname in `/tmp`)
+    # @param user_args [Array<String>] additional arguments to use when
+    #  spawning mpv
+    def initialize(path: Dir::Tmpname.make_tmpname("/tmp/mpv", ".sock"),
+                   user_args: [])
+      @socket_path = path
+
+      @server = Server.new(path: @socket_path, user_args: user_args)
+
+      until File.exist?(@socket_path)
+        sleep 0.1
+      end
+
+      @client = Client.new(@socket_path)
+    end
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: mpv
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- William Woodruff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-13 00:00:00.000000000 Z
+dependencies: []
+description: A library for creating and controlling mpv instances.
+email: william@tuffbizz.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- LICENSE
+- README.md
+- lib/mpv.rb
+- lib/mpv/client.rb
+- lib/mpv/server.rb
+- lib/mpv/session.rb
+homepage: https://github.com/woodruffw/ruby-mpv
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: mpv - A ruby library for controlling mpv processes.
+test_files: []