sonycam 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66e31989753b84b73e0d25c3e149082feebccabf
+  data.tar.gz: 91f347e53cc61ca868b757184370d2d354c2726c
+SHA512:
+  metadata.gz: f98bce7464db042a3b758b90af3c5ad153f3c443b1a55416340b5b7fef3349be7af0b0b1f7744f46096fcea2281544c34c1ac6398f0b40e3c37b7adfd4a24a4a
+  data.tar.gz: e7298aeece3a259de2c3c259f8813dfe4cf1d4972fd286a347c29aa465ed777c7274986d60ef4dc64cae8a6c1d156af7831b3552b71211622445eaa38d0ae084

data/bin/sonycam

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'sonycam/cli'
+Sonycam::CLI.start(ARGV)

data/lib/sonycam.rb

@@ -0,0 +1,8 @@
+require 'sonycam/scanner'
+require 'sonycam/device_description'
+require 'sonycam/api'
+require 'sonycam/error'
+require 'sonycam/liveview'
+
+module Sonycam
+end

data/lib/sonycam/api.rb

@@ -0,0 +1,23 @@
+require 'net/http'
+require 'json'
+
+module Sonycam
+  class API
+    def initialize api_url
+      @uri = URI(api_url)
+      @http = Net::HTTP.start(@uri.host, @uri.port)
+    end
+
+    # id property of JSON-RPC seems to be totally useless over HTTP since it's request-response pattern.
+    def request method, *params, **options
+      json = {method: method, params: params, id: 1, version: '1.0'}.merge!(options).to_json
+      ret = JSON.parse(@http.request_post(@uri.path, json).body)
+      if ret['error']
+        error_code, error_message = ret['error']
+        raise Sonycam::Error.new_from_code(error_code), error_message
+      else
+        ret
+      end
+    end
+  end
+end

data/lib/sonycam/cli.rb

@@ -0,0 +1,38 @@
+require 'thor'
+require 'sonycam'
+require 'open-uri'
+
+module Sonycam
+  class CLI < Thor
+    DD_PATH = File.join(ENV['HOME'], '.sonycam')
+
+    desc 'scan', 'Discover devices'
+    def scan
+      location = Scanner.scan.first
+      puts "Found location: #{location}"
+      File.write File.join(DD_PATH), open(location).read
+      puts "Device description file saved to #{DD_PATH}"
+    end
+
+    desc 'list QUERY', 'List all API or search'
+    def list query
+      api = API.new DeviceDescription.new(DD_PATH).api_url(:camera)
+      puts api.request(:getAvailableApiList)['result'].first.select{|method| method =~ /#{query}/i }
+    end
+
+    desc 'api METHOD PARAMS', 'Send API request'
+    def api method, *params
+      api = API.new DeviceDescription.new(DD_PATH).api_url(:camera)
+      jj api.request(method, *params)
+    end
+
+    desc 'liveview', 'Start Liveview and output to STDOUT'
+    def liveview
+      api = API.new DeviceDescription.new(DD_PATH).api_url(:camera)
+      liveview_url = api.request('startLiveview')['result'][0]
+      Liveview.stream(liveview_url) do |packet|
+        puts packet[:payload_data][:jpeg_data]
+      end
+    end
+  end
+end

data/lib/sonycam/device_description.rb

@@ -0,0 +1,32 @@
+require 'nokogiri'
+require 'open-uri'
+
+class DeviceDescription
+  attr_reader :doc
+
+  # document: String or Nokogiri::XML::Node
+  def initialize document
+    @doc = Nokogiri::XML(open(document))
+    @camera_name = @doc.at_xpath('//xmlns:friendlyName').content
+    @api_url_hash = {}
+    @doc.xpath('//av:X_ScalarWebAPI_Service', av: 'urn:schemas-sony-com:av').each do |node|
+      type = node.at_xpath('av:X_ScalarWebAPI_ServiceType', av: 'urn:schemas-sony-com:av').content
+      url = node.at_xpath('av:X_ScalarWebAPI_ActionList_URL', av: 'urn:schemas-sony-com:av').content
+      @api_url_hash[type.to_sym] = url
+    end
+  end
+
+  # type: :camera, :system, :guide
+  def api_url type = :camera
+    # Hush, it's a secret, don't tell anyone.
+    if @camera_name == 'DSC-RX100M2'
+      url = @api_url_hash[type].sub('sony', 'camera')
+      puts "DSC-RX100M2 detected, API URL \"#{url}\" was used insteadly."
+      return url
+    end
+
+    if action_list_url = @api_url_hash[type] then "#{action_list_url}/#{type}"
+    else raise "Can't not find service type \"#{type}\"."
+    end
+  end
+end

data/lib/sonycam/error.rb

@@ -0,0 +1,41 @@
+module Sonycam
+  module Error
+    MAPPING = {
+      1 => :Any,
+      2 => :Timeout,
+      3 => :IllegalArgument,
+      4 => :IllegalDataFormat,
+      5 => :IllegalRequest,
+      6 => :IllegalResponse,
+      7 => :IllegalState,
+      8 => :IllegalType,
+      9 => :IndexOutOfBounds,
+      10 => :NoSuchElement,
+      11 => :NoSuchField,
+      12 => :NoSuchMethod,
+      13 => :NULLPointer,
+      14 => :UnsupportedVersion,
+      15 => :UnsupportedOperation,
+      40400 => :Shootingfail,
+      40401 => :CameraNotReady,
+      40402 => :AlreadyRunningPollingAPI147,
+      40403 => :StillCapturingNotFinished,
+      401 => :Unauthorized,
+      403 => :Forbidden,
+      404 => :NotFound,
+      406 => :NotAcceptable,
+      413 => :RequestEntityTooLarge,
+      414 => :RequestURITooLong,
+      501 => :NotImplemented,
+      503 => :ServiceUnavailable
+    }
+
+    MAPPING.each_value do |error_name|
+      const_set error_name, Class.new(StandardError)
+    end
+
+    def self.new_from_code code
+      const_get(MAPPING[code])
+    end
+  end
+end

data/lib/sonycam/liveview.rb

@@ -0,0 +1,42 @@
+require 'net/http'
+require 'sonycam/packet'
+
+module Liveview
+  extend self
+  def stream liveview_url
+    uri = URI(liveview_url)
+    Net::HTTP.start(uri.host, uri.port) do |http|
+      request = Net::HTTP::Get.new uri
+      http.request request do |response|
+        state = :commen_header
+        buf = ''.force_encoding('BINARY')
+        commen_header = nil
+        payload_header = nil
+          response.read_body do |chunk|
+          buf += chunk
+          until buf.empty?
+            case state
+            when :commen_header # 8 bytes
+              break if buf.size < 8
+              commen_header = buf.slice!(0, 8).unpack('H2CnN')
+              state = :payload_header
+            when :payload_header # 128 bytes
+              break if buf.size < 128
+              payload_header = buf.slice!(0, 128).unpack('H8H6CH8CH*')
+              state = :payload_data
+            when :payload_data
+              jpeg_data_size = payload_header[1].to_i(16)
+              padding_size = payload_header[2]
+              break if buf.size < jpeg_data_size + padding_size
+              jpeg_data = buf.slice!(0, jpeg_data_size)
+              padding_data = buf.slice!(0, padding_size)
+              state = :commen_header
+              yield Packet.new(commen_header, payload_header, jpeg_data, padding_data)
+            end # case state
+            # gets
+          end # until buf.empty?
+        end # response.read_body do |chunk|
+      end # http.request request do |response|
+    end rescue retry # Net::HTTP.start(uri.host, uri.port) do |http|
+  end # def stream
+end # class Liveview

data/lib/sonycam/packet.rb

@@ -0,0 +1,28 @@
+class Packet
+  def initialize commen_header, payload_header, jpeg_data, padding_data
+    @packet = {
+      commen_header: {
+        start_byte: commen_header[0], # hex, fixed "FF"
+        payload_type: commen_header[1], # int
+        sequence_number: commen_header[2], # int
+        time_stamp: commen_header[3] # int
+      },
+      payload_header: {
+        star_code: payload_header[0], # hex, fixed "24356879"
+        jpeg_data_size: payload_header[1].to_i(16), # int
+        padding_size: payload_header[2], # int
+        reserved: payload_header[3], # hex
+        flag: payload_header[4], # int, fixed "00"
+        reserved_2: payload_header[5]
+
+      },
+      payload_data: {
+        jpeg_data: jpeg_data,
+        padding_data: padding_data
+      },
+    }
+  end
+  def [] key
+    @packet[key]
+  end
+end

data/lib/sonycam/scanner.rb

@@ -0,0 +1,40 @@
+require 'socket'
+require 'timeout'
+
+module Sonycam
+  module Scanner
+    extend self
+    # returns array of device description XML URL
+    def scan ip = nil, timeout: 10
+      m_search = <<-EOS
+M-SEARCH * HTTP/1.1\r
+HOST: 239.255.255.250:1900\r
+MAN: ssdp:discover\r
+MX: #{timeout}\r
+ST: urn:schemas-sony-com:service:ScalarWebAPI:1\r
+\r
+EOS
+
+      addresses = ip ? Array(Addrinfo.ip(ip)) : Socket.ip_address_list.reject{ |a| a.ipv4_loopback? || a.ipv6_loopback? || a.ipv6_linklocal? }
+      locations = []
+      addresses.map do |addr_info|
+        Thread.new do
+          begin
+            sock = UDPSocket.new
+            sock.bind(addr_info.ip_address, 0)
+            sock.send(m_search, 0, '239.255.255.250', 1900)
+            Timeout::timeout(timeout) do
+              response = sock.recv(1024)
+              headers = Hash[response.split("\r\n").map{|x| x[/^([^:]*)\s*:\s*(.*)$/]; [$1, $2]}]
+              locations << headers['LOCATION'] if headers['ST'] == 'urn:schemas-sony-com:service:ScalarWebAPI:1'
+            end
+          rescue Timeout::Error
+          rescue
+            puts $!.inspect, $@
+          end
+        end
+      end.each(&:join)
+      locations
+    end # def scan
+  end
+end

data/lib/sonycam/version.rb

@@ -0,0 +1,3 @@
+module Sonycam
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: sonycam
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tony Jian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sony Camera Remote API Wrapper
+email: tonytonyjan@gmail.com
+executables:
+- sonycam
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/sonycam
+- lib/sonycam.rb
+- lib/sonycam/api.rb
+- lib/sonycam/cli.rb
+- lib/sonycam/device_description.rb
+- lib/sonycam/error.rb
+- lib/sonycam/liveview.rb
+- lib/sonycam/packet.rb
+- lib/sonycam/scanner.rb
+- lib/sonycam/version.rb
+homepage: https://github.com/tonytonyjan/sonycam
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: Sony Camera Remote API Wrapper
+test_files: []