ffi-gphoto2 0.5.1 → 0.8.0

data/lib/ffi/gphoto2/camera_list.rb

@@ -4,7 +4,7 @@ module FFI
       # libgphoto2/gphoto2-list.c
       layout :used, :int,
              :max, :int,
-             :_entry, :pointer, # Entry*
+             :_entry, Entry.by_ref,
              :ref_count, :int
 
       def self.release(ptr)

data/lib/ffi/gphoto2/camera_widget.rb

@@ -7,7 +7,7 @@ module FFI
              :info, [:char, 1024],
              :name, [:char, 256],
 
-             :parent, :pointer, # CameraWidget
+             :parent, CameraWidget.by_ref,
 
              :value_string, :string,
              :value_int, :int,

data/lib/ffi/gphoto2_port.rb

@@ -1,3 +1,5 @@
+require 'ffi'
+
 module FFI
   module GPhoto2Port
     extend FFI::Library
@@ -8,9 +10,16 @@ module FFI
     require 'ffi/gphoto2_port/gp_port_result'
 
     # enums
+    require 'ffi/gphoto2_port/gp_port_serial_parity'
     require 'ffi/gphoto2_port/gp_port_type'
 
     # structs
+    require 'ffi/gphoto2_port/gp_port_settings_serial'
+    require 'ffi/gphoto2_port/gp_port_settings_usb'
+    require 'ffi/gphoto2_port/gp_port_settings_usb_disk_direct'
+    require 'ffi/gphoto2_port/gp_port_settings_usb_scsi'
+    require 'ffi/gphoto2_port/gp_port_settings'
+    require 'ffi/gphoto2_port/gp_port'
     require 'ffi/gphoto2_port/gp_port_info'
     require 'ffi/gphoto2_port/gp_port_info_list'
 
@@ -20,12 +29,23 @@ module FFI
     attach_function :gp_port_info_get_type, [GPPortInfo, :pointer], :int
 
     attach_function :gp_port_info_list_new, [:pointer], :int
-    attach_function :gp_port_info_list_free, [GPPortInfoList.by_ref], :int
+    attach_function :gp_port_info_list_free, [:pointer], :int
     attach_function :gp_port_info_list_load, [GPPortInfoList.by_ref], :int
     attach_function :gp_port_info_list_lookup_path, [GPPortInfoList.by_ref, :string], :int
     attach_function :gp_port_info_list_get_info, [GPPortInfoList.by_ref, :int, :pointer], :int
 
     # libgphoto2_port/gphoto2/gphoto2-port-result.h
     attach_function :gp_port_result_as_string, [:int], :string
+
+    # libgphoto2_port/gphoto2/gphoto2-port.h
+    attach_function :gp_port_new, [:pointer], :int
+    attach_function :gp_port_free, [:pointer], :int
+
+    attach_function :gp_port_set_info, [GPPort.by_ref, GPPortInfo], :int
+
+    attach_function :gp_port_open, [GPPort.by_ref], :int
+    attach_function :gp_port_close, [GPPort.by_ref], :int
+
+    attach_function :gp_port_reset, [GPPort.by_ref], :int
   end
 end

data/lib/ffi/gphoto2_port/gp_port.rb

@@ -0,0 +1,17 @@
+module FFI
+  module GPhoto2Port
+    class GPPort < FFI::ManagedStruct
+      # libgphoto2_port/libgphoto2_port/gphoto2-port.h
+      layout :type, GPPortType,
+             :settings, GPPortSettings,
+             :settings_pending, GPPortSettings,
+             :timeout, :int,
+             :pl, :pointer, # GPPortPrivateLibrary *
+             :pc, :pointer # GPPortPrivateCore *
+
+      def self.release(ptr)
+        FFI::GPhoto2.gp_port_free(ptr)
+      end
+    end
+  end
+end

data/lib/ffi/gphoto2_port/gp_port_info_list.rb

@@ -2,7 +2,7 @@ module FFI
   module GPhoto2Port
     class GPPortInfoList < FFI::ManagedStruct
       # libgphoto2_port/libgphoto2_port/gphoto2-port-info-list.c
-      layout :info, :pointer, # GPPortInfo*
+      layout :info, GPPortInfo.by_ref,
              :count, :uint,
              :iolib_count, :uint
 

data/lib/ffi/gphoto2_port/gp_port_serial_parity.rb

@@ -0,0 +1,6 @@
+module FFI
+  module GPhoto2Port
+    # libgphoto2_port/libgphoto2_port/gphoto2-port.h
+    GPPortSerialParity = enum :off, :even, :odd
+  end
+end

data/lib/ffi/gphoto2_port/gp_port_settings.rb

@@ -0,0 +1,11 @@
+module FFI
+  module GPhoto2Port
+    class GPPortSettings < FFI::Struct
+      # libgphoto2_port/libgphoto2_port/gphoto2-port.h
+      layout :serial, GPPortSettingsSerial,
+             :usb, GPPortSettingsUSB,
+             :usbdiskdirect, GPPortSettingsUsbDiskDirect,
+             :usbscsi, GPPortSettingsUsbScsi
+    end
+  end
+end

data/lib/ffi/gphoto2_port/gp_port_settings_serial.rb

@@ -0,0 +1,12 @@
+module FFI
+  module GPhoto2Port
+    class GPPortSettingsSerial < FFI::Struct
+      # libgphoto2_port/libgphoto2_port/gphoto2-port.h
+      layout :port, [:char, 128],
+             :speed, :int,
+             :bits, :int,
+             :parity, GPPortSerialParity,
+             :stopbits, :int
+    end
+  end
+end

data/lib/ffi/gphoto2_port/gp_port_settings_usb.rb

@@ -0,0 +1,15 @@
+module FFI
+  module GPhoto2Port
+    class GPPortSettingsUSB < FFI::Struct
+      # libgphoto2_port/libgphoto2_port/gphoto2-port.h
+      layout :inep, :int,
+             :outep, :int,
+             :intep, :int,
+             :config, :int,
+             :interface, :int,
+             :altsetting, :int,
+             :maxpacketsize, :int,
+             :port, [:char, 64]
+    end
+  end
+end

data/lib/ffi/gphoto2_port/gp_port_settings_usb_disk_direct.rb

@@ -0,0 +1,8 @@
+module FFI
+  module GPhoto2Port
+    class GPPortSettingsUsbDiskDirect < FFI::Struct
+      # libgphoto2_port/libgphoto2_port/gphoto2-port.h
+      layout :path, [:char, 128]
+    end
+  end
+end

data/lib/ffi/gphoto2_port/gp_port_settings_usb_scsi.rb

@@ -0,0 +1,8 @@
+module FFI
+  module GPhoto2Port
+    class GPPortSettingsUsbScsi < FFI::Struct
+      # libgphoto2_port/libgphoto2_port/gphoto2-port.h
+      layout :path, [:char, 128]
+    end
+  end
+end

data/lib/gphoto2.rb

@@ -1,7 +1,5 @@
 require 'logger'
 
-require 'ffi'
-
 require 'ffi/gphoto2'
 require 'ffi/gphoto2_port'
 
@@ -17,6 +15,9 @@ require 'gphoto2/camera_widgets/text_camera_widget'
 require 'gphoto2/camera_widgets/toggle_camera_widget'
 require 'gphoto2/camera_widgets/window_camera_widget'
 
+require 'gphoto2/camera_file_info/camera_file_info'
+require 'gphoto2/camera_file_info/file_camera_file_info'
+
 require 'gphoto2/camera/capture'
 require 'gphoto2/camera/configuration'
 require 'gphoto2/camera/event'
@@ -32,6 +33,7 @@ require 'gphoto2/camera_folder'
 require 'gphoto2/camera_list'
 require 'gphoto2/context'
 require 'gphoto2/entry'
+require 'gphoto2/port'
 require 'gphoto2/port_info'
 require 'gphoto2/port_info_list'
 require 'gphoto2/port_result'
@@ -39,6 +41,24 @@ require 'gphoto2/port_result'
 require 'gphoto2/version'
 
 module GPhoto2
+  # A runtime error for unsuccessful return codes.
+  class Error < RuntimeError
+    # @return [Integer]
+    attr_reader :code
+
+    # @param [String] message
+    # @param [Integer] code
+    def initialize(message, code)
+      super(message)
+      @code = code
+    end
+
+    # @return [String]
+    def to_s
+      "#{super} (#{code})"
+    end
+  end
+
   # @return [Logger]
   def self.logger
     @logger ||= Logger.new(STDERR)
@@ -46,10 +66,10 @@ module GPhoto2
 
   # @param [Integer] rc
   # @return [void]
-  # @raise RuntimeError when the return code is not {FFI::GPhoto2Port::GP_OK}
+  # @raise [GPhoto2::Error] when the return code is not {FFI::GPhoto2Port::GP_OK}
   def self.check!(rc)
     logger.debug "#{caller.first} => #{rc}" if ENV['DEBUG']
     return if rc >= FFI::GPhoto2Port::GP_OK
-    raise "#{PortResult.as_string(rc)} (#{rc})"
+    raise Error.new(PortResult.as_string(rc), rc)
   end
 end

data/lib/gphoto2/camera.rb

@@ -83,10 +83,18 @@ module GPhoto2
       autorelease(camera, &blk)
     end
 
+    # Filters devices by a given condition.
+    #
+    # Filter keys can be either `model` or `port`. Only the first filter is
+    # used.
+    #
     # @example
     #   # Find the cameras whose model names contain Nikon.
     #   cameras = GPhoto2::Camera.where(model: /nikon/i)
     #
+    #   # Select a camera by its port.
+    #   camera = GPhoto2::Camera.where(port: 'usb:250,004').first
+    #
     # @param [Hash] condition
     # @return [Array<GPhoto2::Camera>]
     def self.where(condition)
@@ -143,7 +151,7 @@ module GPhoto2
     # @param [CameraOperation] operation
     # @return [Boolean]
     def can?(operation)
-      (abilities[:operations] & CameraOperation[operation]) != 0
+      (abilities.operations & (CameraOperation[operation] || 0)) != 0
     end
 
     private
@@ -171,7 +179,7 @@ module GPhoto2
     end
 
     def new
-      ptr = FFI::MemoryPointer.new(FFI::GPhoto2::Camera)
+      ptr = FFI::MemoryPointer.new(:pointer)
       rc = gp_camera_new(ptr)
       GPhoto2.check!(rc)
       @ptr = FFI::GPhoto2::Camera.new(ptr.read_pointer)

data/lib/gphoto2/camera/capture.rb

@@ -16,6 +16,23 @@ module GPhoto2
         CameraFile.new(self, path.folder, path.name)
       end
 
+      # Triggers a capture and immedately returns.
+      #
+      # A camera trigger is the first half of a {#capture}. Instead of
+      # returning a {GPhoto2::CameraFile}, a trigger immediately returns and
+      # the caller has to poll for events.
+      #
+      # @example
+      #   camera.trigger
+      #   event = camera.wait_for(:file_added)
+      #   event.data # => CameraFile
+      #
+      # @return [void]
+      def trigger
+        save
+        trigger_capture
+      end
+
       # Captures a preview from the camera.
       #
       # Previews are not stored on the camera but are returned as data in a
@@ -54,6 +71,11 @@ module GPhoto2
         GPhoto2.check!(rc)
         file
       end
+
+      def trigger_capture
+        rc = gp_camera_trigger_capture(ptr, context.ptr)
+        GPhoto2.check!(rc)
+      end
     end
   end
 end

data/lib/gphoto2/camera/configuration.rb

@@ -70,6 +70,7 @@ module GPhoto2
       # @param [Object] value
       # @return [Object]
       def []=(key, value)
+        raise ArgumentError, "invalid key: #{key}" unless self[key]
         self[key].value = value
         @dirty = true
         value
@@ -137,7 +138,7 @@ module GPhoto2
       end
 
       def get_config
-        widget_ptr = FFI::MemoryPointer.new(FFI::GPhoto2::CameraWidget)
+        widget_ptr = FFI::MemoryPointer.new(:pointer)
         rc = gp_camera_get_config(ptr, widget_ptr, context.ptr)
         GPhoto2.check!(rc)
         widget = FFI::GPhoto2::CameraWidget.new(widget_ptr.read_pointer)

data/lib/gphoto2/camera/event.rb

@@ -21,16 +21,13 @@ module GPhoto2
 
       def wait_for_event(timeout)
         # assume CameraEventType is an int
-        type = FFI::MemoryPointer.new(:int)
-
-        data = FFI::MemoryPointer.new(:pointer)
+        type_ptr = FFI::MemoryPointer.new(:int)
         data_ptr = FFI::MemoryPointer.new(:pointer)
-        data_ptr.write_pointer(data)
 
-        rc = gp_camera_wait_for_event(ptr, timeout, type, data_ptr, context.ptr)
+        rc = gp_camera_wait_for_event(ptr, timeout, type_ptr, data_ptr, context.ptr)
         GPhoto2.check!(rc)
 
-        type = FFI::GPhoto2::CameraEventType[type.read_int]
+        type = FFI::GPhoto2::CameraEventType[type_ptr.read_int]
         data = data_ptr.read_pointer
 
         data =

data/lib/gphoto2/camera_abilities.rb

@@ -30,6 +30,15 @@ module GPhoto2
       ptr[field]
     end
 
+    # @return [Integer] a bit field of supported operations
+    def operations
+      if self[:operations] == :none
+        CameraOperation[:none]
+      else
+        self[:operations]
+      end
+    end
+
     private
 
     def get_abilities

data/lib/gphoto2/camera_abilities_list.rb

@@ -32,7 +32,7 @@ module GPhoto2
     private
 
     def new
-      ptr = FFI::MemoryPointer.new(FFI::GPhoto2::CameraAbilitiesList)
+      ptr = FFI::MemoryPointer.new(:pointer)
       rc = gp_abilities_list_new(ptr)
       GPhoto2.check!(rc)
       @ptr = FFI::GPhoto2::CameraAbilitiesList.new(ptr.read_pointer)

data/lib/gphoto2/camera_file.rb

@@ -3,6 +3,9 @@ module GPhoto2
     include FFI::GPhoto2
     include GPhoto2::Struct
 
+    # The preview data is assumed to be a jpg.
+    PREVIEW_FILENAME = 'capture_preview.jpg'.freeze
+
     # @return [String]
     attr_reader :folder
 
@@ -44,6 +47,11 @@ module GPhoto2
       data_and_size.last
     end
 
+    # @return [GPhoto2::CameraFileInfo, nil]
+    def info
+      preview? ? nil : get_info
+    end
+
     private
 
     def data_and_size
@@ -54,30 +62,40 @@ module GPhoto2
     end
 
     def default_filename
-      # previews are always jpg
-      preview? ? 'capture_preview.jpg' : @name
+      preview? ? PREVIEW_FILENAME : @name
     end
 
     def new
-      ptr = FFI::MemoryPointer.new(FFI::GPhoto2::CameraFile)
+      ptr = FFI::MemoryPointer.new(:pointer)
       rc = gp_file_new(ptr)
       GPhoto2.check!(rc)
       @ptr = FFI::GPhoto2::CameraFile.new(ptr.read_pointer)
     end
 
     def get_data_and_size
-      data = FFI::MemoryPointer.new(:uchar)
       data_ptr = FFI::MemoryPointer.new(:pointer)
-      data_ptr.write_pointer(data)
-      size = FFI::MemoryPointer.new(:ulong)
+      size_ptr = FFI::MemoryPointer.new(:ulong)
 
-      rc = gp_file_get_data_and_size(ptr, data_ptr, size)
+      rc = gp_file_get_data_and_size(ptr, data_ptr, size_ptr)
       GPhoto2.check!(rc)
 
-      size = size.read_ulong
+      size = size_ptr.read_ulong
       data = data_ptr.read_pointer.read_bytes(size)
 
       [data, size]
     end
+
+    def get_info
+      info = FFI::GPhoto2::CameraFileInfo.new
+
+      rc = gp_camera_file_get_info(@camera.ptr,
+                                   @folder,
+                                   @name,
+                                   info,
+                                   @camera.context.ptr)
+      GPhoto2.check!(rc)
+
+      FileCameraFileInfo.new(info[:file])
+    end
   end
 end

data/lib/gphoto2/camera_file_info/camera_file_info.rb

@@ -0,0 +1,52 @@
+module GPhoto2
+  # @abstract
+  class CameraFileInfo
+    include FFI::GPhoto2
+    include GPhoto2::Struct
+
+    # @param [FFI::GPhoto2::CameraFileInfo] ptr
+    def initialize(ptr)
+      @ptr = ptr
+    end
+
+    # @return [Integer] a bit field of set info fields
+    def fields
+      fields = ptr[:fields]
+
+      if fields.is_a?(Symbol)
+        CameraFileInfoFields[fields]
+      else
+        fields
+      end
+    end
+
+    # return [Boolean] whether the given field is set
+    def has_field?(field)
+      (fields & CameraFileInfoFields[field]) != 0
+    end
+
+    # @return [CameraFileStatus, nil]
+    def status
+      fetch(:status)
+    end
+
+    # @return [Integer, nil] the size of the file in bytes
+    def size
+      fetch(:size)
+    end
+
+    # @return [String, nil] the media type of the file
+    def type
+      type = fetch(:type)
+      type ? type.to_s : nil
+    end
+
+    protected
+
+    # param [Symbol] key
+    # @return [Object, nil]
+    def fetch(key)
+      ptr[key] if has_field?(key)
+    end
+  end
+end