ffi-gphoto2 0.5.1 → 0.6.0

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

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

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_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,8 +62,7 @@ module GPhoto2
     end
 
     def default_filename
-      # previews are always jpg
-      preview? ? 'capture_preview.jpg' : @name
+      preview? ? PREVIEW_FILENAME : @name
     end
 
     def new
@@ -66,18 +73,29 @@ module GPhoto2
     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

data/lib/gphoto2/camera_file_info/file_camera_file_info.rb

@@ -0,0 +1,30 @@
+module GPhoto2
+  class FileCameraFileInfo < CameraFileInfo
+    # @return [Integer, nil]
+    def width
+      fetch(:width)
+    end
+
+    # @return [Integer, nil]
+    def height
+      fetch(:height)
+    end
+
+    # @return [Boolean, nil]
+    def readable?
+      permissions = fetch(:permissions)
+      (permissions & CameraFilePermissions[:read]) != 0 if permissions
+    end
+
+    # @return [Boolean, nil]
+    def deletable?
+      permissions = fetch(:permissions)
+      (permissions & CameraFilePermissions[:delete]) != 0 if permissions
+    end
+
+    # @return [Time, nil] the last modification time
+    def mtime
+      Time.at(ptr[:mtime]) if has_field?(:mtime)
+    end
+  end
+end

data/lib/gphoto2/camera_widgets/camera_widget.rb

@@ -70,7 +70,7 @@ module GPhoto2
       map
     end
 
-    # @param [String]
+    # @return [String]
     def to_s
       value.to_s
     end
@@ -93,9 +93,7 @@ module GPhoto2
     end
 
     def get_name
-      str = FFI::MemoryPointer.new(:string)
       str_ptr = FFI::MemoryPointer.new(:pointer)
-      str_ptr.write_pointer(str)
 
       rc = gp_widget_get_name(ptr, str_ptr)
       GPhoto2.check!(rc)
@@ -113,11 +111,9 @@ module GPhoto2
     end
 
     def get_label
-      str = FFI::MemoryPointer.new(:string)
       str_ptr = FFI::MemoryPointer.new(:pointer)
-      str_ptr.write_pointer(str)
 
-      rc = gp_widget_get_type(ptr, str_ptr)
+      rc = gp_widget_get_label(ptr, str_ptr)
       GPhoto2.check!(rc)
 
       str_ptr = str_ptr.read_pointer

data/lib/gphoto2/camera_widgets/radio_camera_widget.rb

@@ -8,9 +8,7 @@ module GPhoto2
     protected
 
     def get_value
-      val = FFI::MemoryPointer.new(:string)
       val_ptr = FFI::MemoryPointer.new(:pointer)
-      val_ptr.write_pointer(val)
 
       rc = gp_widget_get_value(ptr, val_ptr)
       GPhoto2.check!(rc)
@@ -34,9 +32,7 @@ module GPhoto2
     end
 
     def get_choice(i)
-      val = FFI::MemoryPointer.new(:string)
       val_ptr = FFI::MemoryPointer.new(:pointer)
-      val_ptr.write_pointer(val)
 
       rc = gp_widget_get_choice(ptr, i, val_ptr)
       GPhoto2.check!(rc)

data/lib/gphoto2/camera_widgets/text_camera_widget.rb

@@ -3,9 +3,7 @@ module GPhoto2
     protected
 
     def get_value
-      val = FFI::MemoryPointer.new(:string)
       val_ptr = FFI::MemoryPointer.new(:pointer)
-      val_ptr.write_pointer(val)
 
       rc = gp_widget_get_value(ptr, val_ptr)
       GPhoto2.check!(rc)
@@ -15,7 +13,7 @@ module GPhoto2
     end
 
     def set_value(text)
-      val = FFI::MemoryPointer.from_string(text)
+      val = FFI::MemoryPointer.from_string(text.to_s)
       rc = gp_widget_set_value(ptr, val)
       GPhoto2.check!(rc)
     end

data/lib/gphoto2/entry.rb

@@ -20,9 +20,7 @@ module GPhoto2
     private
 
     def get_name
-      name = FFI::MemoryPointer.new(:string)
       ptr = FFI::MemoryPointer.new(:pointer)
-      ptr.write_pointer(name)
 
       rc = gp_list_get_name(@camera_list.ptr, @index, ptr)
       GPhoto2.check!(rc)
@@ -32,9 +30,7 @@ module GPhoto2
     end
 
     def get_value
-      value = FFI::MemoryPointer.new(:string)
       ptr = FFI::MemoryPointer.new(:pointer)
-      ptr.write_pointer(value)
 
       rc = gp_list_get_value(@camera_list.ptr, @index, ptr)
       GPhoto2.check!(rc)

data/lib/gphoto2/port_info.rb

@@ -44,9 +44,7 @@ module GPhoto2
     end
 
     def get_name
-      name = FFI::MemoryPointer.new(:string)
       name_ptr = FFI::MemoryPointer.new(:pointer)
-      name_ptr.write_pointer(name)
 
       rc = gp_port_info_get_name(ptr, name_ptr)
       GPhoto2.check!(rc)
@@ -56,9 +54,7 @@ module GPhoto2
     end
 
     def get_path
-      path = FFI::MemoryPointer.new(:string)
       path_ptr = FFI::MemoryPointer.new(:pointer)
-      path_ptr.write_pointer(path)
 
       rc = gp_port_info_get_path(ptr, path_ptr)
       GPhoto2.check!(rc)

data/lib/gphoto2/version.rb

@@ -1,3 +1,3 @@
 module GPhoto2
-  VERSION = '0.5.1'
+  VERSION = '0.6.0'
 end

data/spec/gphoto2/camera_abilities_spec.rb

@@ -34,5 +34,28 @@ module GPhoto2
         expect(abilities[key]).to eq(value)
       end
     end
+
+    describe '#operations' do
+      context 'when no or one operation is supported' do
+        it 'returns a bit field of supported operations' do
+          abilities = CameraAbilities.new(camera_abilities_list, index)
+          allow(abilities).to receive(:[]).and_return(:none)
+          expect(abilities.operations).to eq(0)
+        end
+      end
+
+      context 'when multiple operations are supported' do
+        it 'returns a bit field of supported operations' do
+          abilities = CameraAbilities.new(camera_abilities_list, index)
+
+          capture_image = FFI::GPhoto2::CameraOperation[:capture_image]
+          config = FFI::GPhoto2::CameraOperation[:config]
+          operations = capture_image | config
+
+          allow(abilities).to receive(:[]).and_return(operations)
+          expect(abilities.operations).to eq(0x11)
+        end
+      end
+    end
   end
 end

data/spec/gphoto2/camera_file_info/file_camera_file_info_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'ostruct'
+
+module GPhoto2
+  describe FileCameraFileInfo do
+    it_behaves_like CameraFileInfo
+
+    let(:camera_file_info_file) do
+      OpenStruct.new(
+        fields: 0xff,
+        status: :not_downloaded,
+        size: 7355608,
+        type: 'image/jpeg',
+        width: 4928,
+        height: 3264,
+        permissions: 0xff,
+        mtime: Time.at(1467863342)
+      )
+    end
+
+    describe '#width' do
+      it 'returns the width of the file' do
+        info = FileCameraFileInfo.new(camera_file_info_file)
+        expect(info.width).to eq(4928)
+      end
+    end
+
+    describe '#height' do
+      it 'returns the height of the file' do
+        info = FileCameraFileInfo.new(camera_file_info_file)
+        expect(info.height).to eq(3264)
+      end
+    end
+
+    describe '#readable?' do
+      it 'returns whether the file is readable' do
+        info = FileCameraFileInfo.new(camera_file_info_file)
+        expect(info.readable?).to be(true)
+      end
+    end
+
+    describe '#deletable?' do
+      it 'returns whether the file is deletable' do
+        info = FileCameraFileInfo.new(camera_file_info_file)
+        expect(info.deletable?).to be(true)
+      end
+    end
+
+    describe '#mtime' do
+      it 'returns the last modification time of the file' do
+        info = FileCameraFileInfo.new(camera_file_info_file)
+        expect(info.mtime).to eq(Time.at(1467863342))
+      end
+    end
+  end
+end