mpv_client 0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d60f3a4af287f1ac6b2b11747a70c321ccc391af20fad025f85cf8396d7a1ad4
+  data.tar.gz: efcf9a2bf9462cead535062df2e8c977de63ed6ecf4090115315fd97232a636c
+SHA512:
+  metadata.gz: 01304ea3875cc0d379b4e66ccaedb231fa584101eb258d6b398a0457a559f299ff813916895c9c51959042a97e2c40d2109172ffd29853781fa4ecc00b59709b
+  data.tar.gz: b27f90410619d5f6ae3c23663f7ed0e3028eb61e0e8955c0f74fefd027f0753b836b3e8a5922bbde6eb9816607c052bf20c7564a8e197965971f87f086660ff7

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+Gemfile.lock
+*.gem

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 John Labovitz
+
+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,3 @@
+# mpv_client
+
+FIXME

data/Rakefile

@@ -0,0 +1 @@
+require 'simple-rake-tasks'

data/lib/mpv_client.rb

@@ -0,0 +1,114 @@
+require 'json'
+require 'socket'
+
+class MPVClient
+
+  class Error < StandardError; end
+
+  attr_accessor :socket
+
+  def initialize(mpv_params={})
+    @requests = {}
+    @property_observers = {}
+    @event_observers = {}
+    @request_id = @property_observer_id = 0
+    @socket_path = '/tmp/mpv_socket'
+    @mpv_params = {
+      'idle' => 'yes',
+      'input-ipc-server' => @socket_path,
+    }.merge(mpv_params).compact
+    start
+    register_event('property-change') do |event|
+      observer = @property_observers[event['name']] \
+        or raise Error, "Can't find property observer for event: #{event.inspect}"
+      observer.call(event['name'], event['data'])
+    end
+  end
+
+  def start
+    cmd = ['mpv'] + @mpv_params.map { |k, v| "--#{k}" + (v.to_s.empty? ? '' : "=#{v}") }
+# ;;pp(cmd: cmd)
+    File.unlink(@socket_path) if File.exist?(@socket_path)
+    @pid = Process.spawn(*cmd)
+    raise Error, "mpv failed to start" unless @pid > 0
+    until File.exist?(@socket_path)
+# ;;puts "[sleeping until socket path exists]"
+      sleep 0.1
+      if Process.waitpid(@pid, Process::WNOHANG)
+        raise Error, "mpv failed to start (exit status #{$?.exitstatus.inspect})"
+      end
+    end
+    @socket = UNIXSocket.new(@socket_path)
+  end
+
+  def stop
+    @socket.close
+    @socket = nil
+    Process.kill('INT', @pid)
+# ;;puts "[waiting for mpv to exit: #{@pid}]"
+    Process.waitpid(@pid)
+# ;;puts "[mpv exited with status #{$?.exitstatus.inspect}]"
+    @pid = nil
+    File.unlink(@socket_path) if File.exist?(@socket_path)
+  end
+
+  def command(*args)
+# ;;puts "COMMAND: #{args.inspect}"
+    responded = false
+    result = nil
+    @requests[@request_id] = proc do |response|
+      case response['error']
+      when 'success'
+        responded = true
+        result = response['data']
+      else
+        raise Error, "Response error: #{response.inspect}"
+      end
+    end
+    request = { 'command' => args, 'request_id' => @request_id }
+# ;;puts "=> #{request.inspect}"
+    @socket.puts(JSON.generate(request))
+    @request_id += 1
+    process_response until responded
+    result
+  end
+
+  def process_response
+    response = JSON.load(@socket.gets) or return
+# ;;puts "<= #{response.inspect}"
+    if (name = response['event'])
+      if (observer = @event_observers[name])
+        observer.call(response)
+      end
+    elsif (request_id = response['request_id'])
+      handler = @requests.delete(request_id) \
+        or raise Error, "No handler for response: #{response.inspect}"
+      handler.call(response)
+    else
+      raise Error, "Unhandled response: #{response.inspect}"
+    end
+  end
+
+  def unpack_version(packed)
+    [packed >> 16, packed & 0x00FF]
+  end
+
+  def set_property(name, value)
+    command('set_property', name, value)
+  end
+
+  def get_property(name)
+    command('get_property', name)
+  end
+
+  def observe_property(name, &block)
+    @property_observers[name] = block
+    command('observe_property', @property_observer_id, name)
+    @property_observer_id += 1
+  end
+
+  def register_event(name, &block)
+    @event_observers[name] = block
+  end
+
+end

data/mpv_client.gemspec

@@ -0,0 +1,26 @@
+#encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name          = 'mpv_client'
+  s.version       = '0.3'
+  s.summary       = %q{Ruby bindings to the MPV media player, via MPV's JSON-IPC protocol.}
+  s.description   = %q{
+    MPVClient provides Ruby bindings to the MPV media player, via MPV's JSON-IPC protocol.
+  }
+  s.author        = 'John Labovitz'
+  s.email         = 'johnl@johnlabovitz.com'
+  s.homepage      = 'http://github.com/jslabovitz/mpv_client'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_path  = 'lib'
+
+  s.add_dependency 'json', '~> 2.15'
+
+  s.add_development_dependency 'minitest', '~> 5.26'
+  s.add_development_dependency 'minitest-power_assert', '~> 0.3'
+  s.add_development_dependency 'rake', '~> 13.3'
+  s.add_development_dependency 'simple-rake-tasks', '~> 0.1'
+end

data/test/client_test.rb

@@ -0,0 +1,106 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'mpv_client'
+
+require 'minitest/autorun'
+require 'minitest/power_assert'
+
+class MPVClient
+
+  class ClientTest < Minitest::Test
+
+    # i_suck_and_my_tests_are_order_dependent!
+
+    def setup
+# ;;puts
+      @mpv = MPVClient.new
+      @logs = []
+      @mpv.register_event('log-message') do |event|
+# ;;puts "** #{event.inspect}"
+        @logs << event
+      end
+      @mpv.command('request_log_messages', 'status')
+    end
+
+    def shutdown
+      @mpv.command('quit')
+      @mpv.stop
+    end
+
+    def test_version
+      version = @mpv.command('get_version')
+      assert { version != nil }
+      version = @mpv.unpack_version(version)
+      assert { version == [1, 109] }
+    end
+
+    def test_client_name
+      client_name = @mpv.command('client_name')
+      assert { client_name == 'ipc_0' }
+    end
+
+    def test_time_us
+      time = @mpv.command('get_time_us')
+      assert { time.kind_of?(Numeric) }
+      assert { time > 0 }
+    end
+
+    def test_good_command
+      assert {
+        @mpv.command('stop')
+        true
+      }
+    end
+
+    def test_bad_command
+      assert_raises(MPVClient::Error) {
+        @mpv.command('xyzzy')
+      }
+    end
+
+    def test_set_get_property
+      expected_value = 50.0
+      @mpv.set_property('volume', expected_value)
+      actual_value = @mpv.get_property('volume')
+      assert {
+        actual_value == expected_value
+      }
+    end
+
+    def test_observe_property
+      expected_value = 50.0
+      actual_value = nil
+      stop = false
+      @mpv.observe_property('volume') do |name, value|
+        actual_value = value
+        stop = true
+      end
+      @mpv.set_property('volume', expected_value)
+      until stop
+        @mpv.process_response
+      end
+      assert {
+        actual_value == expected_value
+      }
+    end
+
+    def test_process_events
+      volume = nil
+      @mpv.observe_property('volume') do |name, value|
+        volume = value
+      end
+      first = true
+      until volume == 50.0
+        if (IO.select([@mpv.socket], [], [], 1))
+          @mpv.process_response
+        else
+          if first
+            @mpv.set_property('volume', 50.0)
+            first = false
+          end
+        end
+      end
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: mpv_client
+version: !ruby/object:Gem::Version
+  version: '0.3'
+platform: ruby
+authors:
+- John Labovitz
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.26'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.26'
+- !ruby/object:Gem::Dependency
+  name: minitest-power_assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.3'
+- !ruby/object:Gem::Dependency
+  name: simple-rake-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: "\n    MPVClient provides Ruby bindings to the MPV media player, via
+  MPV's JSON-IPC protocol.\n  "
+email: johnl@johnlabovitz.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mpv_client.rb
+- mpv_client.gemspec
+- test/client_test.rb
+homepage: http://github.com/jslabovitz/mpv_client
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: Ruby bindings to the MPV media player, via MPV's JSON-IPC protocol.
+test_files:
+- test/client_test.rb