ffi-gphoto2 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83f9c14b8b7006440420e875c32d4a93b809ce28
-  data.tar.gz: 9e3ccef87bc4565c88c4750e64d09ccde23f3330
+  metadata.gz: 39745534e29e0571decd8eda706d74278a146cc1
+  data.tar.gz: 83c84f47474b4bd940748b11f4b65769db508550
 SHA512:
-  metadata.gz: 9d90104862dfccd44685aefa3870d83cde93e23a0aab57df6a7eb5a7feb2d9e712ca8c3125260b36f18b090df6ea8fce60726e913b667617f551180058c12397
-  data.tar.gz: f8536cef9cf2d3d7c9cfedb71fa0e7079280a7a7a0e7f579e1b886c4cba8e37e9316504e2298f1aabc0358638a3cd7f0ef5d20e5c87eee95ea4e15d82acef454
+  metadata.gz: 287d38fca23d5e76207ea9f4e93d89ee4856f4c30a7deb198c5c2dc305d1eae171b881b3427671c10d623d605ffa877e9708a1db4efbc72ceb19fe0bc3c2589b
+  data.tar.gz: 8e69d5a190b2db161ce6d8be0bdb153282d7407955b8ce98a8b0269ecc544b63d2ac7b3bf0a2ffcf22631f23e75694bf15d1f0d7441d8124753b8a4a4f7f83bf

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: required
+dist: trusty
+language: ruby
+rvm:
+  - 2.3.1
+before_install:
+  - gem install bundler -v 1.12.5
+  - sudo apt-get -qq update
+  - sudo apt-get install libgphoto2-6 libgphoto2-port10
+  - sudo ln -s /usr/lib/x86_64-linux-gnu/libgphoto2.so{.6,}
+  - sudo ln -s /usr/lib/x86_64-linux-gnu/libgphoto2_port.so{.10,}

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+## HEAD
+
+## 0.6.0
+
+* [FIX] Use the correct default filename when a `CameraFile` is a preview.
+* [ADD] Add `CameraFileInfo` and related operations. `CameraFile#info` only
+  supports files.
+* [FIX] `CameraWidget#label` calls the correct widget label function.
+* [FIX] `Camera#[]=` raises an `ArgumentError` when passed an invalid key
+  instead of failing on `nil`.
+* [ADD] Add `CameraAbilities#operations` to always return an `Integer`.
+  libgphoto2 does not stay in the defined enum set of `CameraOperations`;
+  therefore, it is treated as an integer bit field instead.
+* [CHANGE] Errors are thrown as `GPhoto2::Error` rather than `RuntimeError`.
+  Use `#message` and `#code` to extract the the GPhoto2 error message and
+  return code, respectively.
+* [ADD] `Camera#trigger` for trigger capture.
+* [FIX] `TextCameraWidget` values can by any object that implements `#to_s`.

data/README.md

@@ -1,6 +1,10 @@
 # ffi-gphoto2
 
-**ffi-gphoto2** provides an FFI for common functions in [libgphoto2][1].
+
+[![Gem Version](https://badge.fury.io/rb/ffi-gphoto2.svg)](https://badge.fury.io/rb/ffi-gphoto2)
+[![Build Status](https://travis-ci.org/zaeleus/ffi-gphoto2.svg?branch=master)](https://travis-ci.org/zaeleus/ffi-gphoto2)
+
+**ffi-gphoto2** provides an FFI for common functions in [libgphoto2][gphoto].
 It also includes a facade to interact with the library in a more
 idiomatic Ruby way.
 
@@ -34,9 +38,17 @@ camera = cameras.first
 # ...or more conveniently
 camera = GPhoto2::Camera.first
 
-# ...or even search by model name
+# search by model name
 camera = GPhoto2::Camera.where(model: /nikon/i).first
 
+# the above examples require the camera be manually closed when done
+camera.close
+
+# pass a block to automatically close the camera
+GPhoto2::Camera.first do |camera|
+  # ...
+end
+
 # check camera abilities (see `FFI::GPhoto2::CameraOperation.symbols`)
 camera.can? :capture_image
 # => true
@@ -97,14 +109,11 @@ file.save
 
 # ...and then delete it from the camera
 file.delete
-
-# close the camera
-camera.finalize
 ```
 
-More examples can be found in [`examples/`][2]. YARD documentation can be
-generated using the `rake yard` task or [browsed online][3].
+More examples can be found in [`examples/`][examples]. YARD documentation can be
+generated using the `rake yard` task or [browsed online][rubydoc].
 
-[1]: http://www.gphoto.org/
-[2]: https://github.com/zaeleus/ffi-gphoto2/tree/master/examples
-[3]: http://www.rubydoc.info/gems/ffi-gphoto2/frames
+[gphoto]: http://www.gphoto.org/
+[examples]: https://github.com/zaeleus/ffi-gphoto2/tree/master/examples
+[rubydoc]: http://www.rubydoc.info/gems/ffi-gphoto2/frames

data/examples/autofocus.rb

@@ -0,0 +1,21 @@
+require 'gphoto2'
+
+# Capture an image only after successfully autofocusing.
+#
+# Typically, if the camera fails to autofocus, updating the `autofocusdrive`
+# key will throw an "Unspecified error (-1)". This catches the exception and
+# continues to autofocus until it is successful.
+
+GPhoto2::Camera.first do |camera|
+  begin
+    camera.update(autofocusdrive: true)
+  rescue GPhoto2::Error
+    puts "autofocus failed... retrying"
+    camera.reload
+    retry
+  ensure
+    camera.update(autofocusdrive: false)
+  end
+
+  camera.capture
+end

data/examples/capture.rb

@@ -0,0 +1,8 @@
+require 'gphoto2'
+
+# Captures a single photo and saves it to the current working directory.
+
+GPhoto2::Camera.first do |camera|
+  file = camera.capture
+  file.save
+end

data/examples/continuous_burst.rb

@@ -0,0 +1,27 @@
+require 'gphoto2'
+
+# This example is limited to Nikon cameras with a continuous burst mode.
+
+# The number of frames to capture.
+N = 3
+
+GPhoto2::Camera.first do |camera|
+  # Set the camera to continuous burst mode.
+  camera.update(capturemode: 'Burst', burstnumber: N)
+
+  # Use `#trigger` instead of `#capture` so the data remains in the camera
+  # buffer.
+  camera.trigger
+
+  # Wait for the camera to process all the images.
+  queue = N.times.map do
+    event = camera.wait_for(:file_added)
+
+    # The event data contains a `CameraFile` when the `:file_added` event is
+    # triggered.
+    event.data
+  end
+
+  # Save all the images to the current working directory.
+  queue.each(&:save)
+end

data/examples/list_config.rb

@@ -14,6 +14,7 @@ def visit(widget, level = 0)
 
   indent << '  '
 
+  puts "#{indent}label: #{widget.label}"
   puts "#{indent}type: #{widget.type}"
   puts "#{indent}value: #{widget.value}"
 

data/examples/list_files.rb

@@ -0,0 +1,52 @@
+require 'gphoto2'
+
+# Recursively list folder contents with extended metadata.
+
+MAGNITUDES = %w[bytes KiB MiB GiB].freeze
+
+# @param [Integer] size filesize in bytes
+# @param [Integer[ precision
+# @return [String]
+def format_filesize(size, precision = 1)
+  n = 0
+
+  while size >= 1024.0 && n < MAGNITUDES.size
+    size /= 1024.0
+    n += 1
+  end
+
+  "%.#{precision}f %s" % [size, MAGNITUDES[n]]
+end
+
+# @param [CameraFolder] folder a root directory
+def visit(folder)
+  files = folder.files
+
+  puts "#{folder.path} (#{files.size} files)"
+
+  files.each do |file|
+    info = file.info
+
+    name = file.name
+    # Avoid using `File#size` here to prevent having to load the data along
+    # with it.
+    size = format_filesize(info.size)
+    mtime = info.mtime.utc.iso8601
+
+    if info.has_field?(:width) && info.has_field?(:height)
+      dimensions = "#{info.width}x#{info.height}"
+    else
+      dimensions = '-'
+    end
+
+    puts "#{name.ljust(30)}  #{size.rjust(12)}  #{dimensions.rjust(12)}  #{mtime}"
+  end
+
+  puts
+
+  folder.folders.each { |child| visit(child) }
+end
+
+GPhoto2::Camera.first do |camera|
+  visit(camera.filesystem)
+end

data/ffi-gphoto2.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/zaeleus/ffi-gphoto2'
 
   spec.authors       = ['Michael Macias']
-  spec.email         = ['mamacias@go.olemiss.edu']
+  spec.email         = ['zaeleus@gmail.com']
 
   spec.version       = GPhoto2::VERSION
   spec.license       = 'MIT'
@@ -24,8 +24,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.2.0'
-  spec.add_development_dependency 'yard', '~> 0.8.7'
+  spec.add_development_dependency 'rspec', '~> 3.5.0'
+  spec.add_development_dependency 'yard', '~> 0.9.0'
 
   spec.add_dependency 'ffi', '~> 1.9.0'
 end

data/lib/ffi/gphoto2.rb

@@ -11,7 +11,10 @@ module FFI
     require 'ffi/gphoto2/camera_driver_status'
     require 'ffi/gphoto2/camera_event_type'
     require 'ffi/gphoto2/camera_file_access_type'
+    require 'ffi/gphoto2/camera_file_info_fields'
     require 'ffi/gphoto2/camera_file_operation'
+    require 'ffi/gphoto2/camera_file_permissions'
+    require 'ffi/gphoto2/camera_file_status'
     require 'ffi/gphoto2/camera_file_type'
     require 'ffi/gphoto2/camera_folder_operation'
     require 'ffi/gphoto2/camera_operation'
@@ -23,10 +26,14 @@ module FFI
     require 'ffi/gphoto2/camera_abilities'
     require 'ffi/gphoto2/camera_abilities_list'
     require 'ffi/gphoto2/camera_file'
+    require 'ffi/gphoto2/camera_file_info_audio'
+    require 'ffi/gphoto2/camera_file_info_file'
+    require 'ffi/gphoto2/camera_file_info_preview'
+    require 'ffi/gphoto2/camera_file_info'
     require 'ffi/gphoto2/camera_file_path'
+    require 'ffi/gphoto2/entry'
     require 'ffi/gphoto2/camera_list'
     require 'ffi/gphoto2/camera_widget'
-    require 'ffi/gphoto2/entry'
     require 'ffi/gphoto2/gp_context'
 
     # gphoto2/gphoto2-abilities-list.h
@@ -47,10 +54,12 @@ module FFI
     attach_function :gp_camera_get_config, [Camera.by_ref, :pointer, GPContext.by_ref], :int
     attach_function :gp_camera_set_config, [Camera.by_ref, CameraWidget.by_ref, GPContext.by_ref], :int
     attach_function :gp_camera_capture, [Camera.by_ref, CameraCaptureType, CameraFilePath.by_ref, GPContext.by_ref], :int, blocking: true
+    attach_function :gp_camera_trigger_capture, [Camera.by_ref, GPContext.by_ref], :int, blocking: true
     attach_function :gp_camera_capture_preview, [Camera.by_ref, CameraFile.by_ref, GPContext.by_ref], :int, blocking: true
     attach_function :gp_camera_wait_for_event, [Camera.by_ref, :int, :pointer, :pointer, GPContext.by_ref], :int
     attach_function :gp_camera_folder_list_files, [Camera.by_ref, :string, CameraList.by_ref, GPContext.by_ref], :int
     attach_function :gp_camera_folder_list_folders, [Camera.by_ref, :string, CameraList.by_ref, GPContext.by_ref], :int
+    attach_function :gp_camera_file_get_info, [Camera.by_ref, :string, :string, CameraFileInfo.by_ref, GPContext.by_ref], :int
     attach_function :gp_camera_file_get, [Camera.by_ref, :string, :string, CameraFileType, CameraFile.by_ref, GPContext.by_ref], :int, blocking: true
     attach_function :gp_camera_file_delete, [Camera.by_ref, :string, :string, GPContext.by_ref], :int
 

data/lib/ffi/gphoto2/camera_abilities_list.rb

@@ -5,7 +5,7 @@ module FFI
     class CameraAbilitiesList < FFI::ManagedStruct
       # libgphoto2/gphoto2-abilities-list.c
       layout :count, :int,
-             :abilities, :pointer # CameraAbilities*
+             :abilities, CameraAbilities.by_ref
 
       def self.release(ptr)
         FFI::GPhoto2.gp_abilities_list_free(ptr)

data/lib/ffi/gphoto2/camera_file_info.rb

@@ -0,0 +1,10 @@
+module FFI
+  module GPhoto2
+    class CameraFileInfo < FFI::Struct
+      # libgphoto2/gphoto2-filesys.h
+      layout :preview, CameraFileInfoPreview,
+             :file, CameraFileInfoFile,
+             :audio, CameraFileInfoAudio
+    end
+  end
+end

data/lib/ffi/gphoto2/camera_file_info_audio.rb

@@ -0,0 +1,11 @@
+module FFI
+  module GPhoto2
+    class CameraFileInfoAudio < FFI::Struct
+      # gphoto2/gphoto2-filesys.h
+      layout :fields, CameraFileInfoFields,
+             :status, CameraFileStatus,
+             :size, :uint64,
+             :type, [:char, 64]
+    end
+  end
+end

data/lib/ffi/gphoto2/camera_file_info_fields.rb

@@ -0,0 +1,14 @@
+module FFI
+  module GPhoto2
+    # gphoto2/gphoto2-filesys.h
+    CameraFileInfoFields = enum :none, 0,
+                                :type, 1 << 0,
+                                :size, 1 << 2,
+                                :width, 1 << 3,
+                                :height, 1 << 4,
+                                :permissions, 1 << 5,
+                                :status, 1 << 6,
+                                :mtime, 1 << 7,
+                                :all, 0xff
+  end
+end

data/lib/ffi/gphoto2/camera_file_info_file.rb

@@ -0,0 +1,15 @@
+module FFI
+  module GPhoto2
+    class CameraFileInfoFile < FFI::Struct
+      # gphoto2/gphoto2-filesys.h
+      layout :fields, CameraFileInfoFields,
+             :status, CameraFileStatus,
+             :size, :uint64,
+             :type, [:char, 64],
+             :width, :uint32,
+             :height, :uint32,
+             :permissions, CameraFilePermissions,
+             :mtime, :time_t
+    end
+  end
+end

data/lib/ffi/gphoto2/camera_file_info_preview.rb

@@ -0,0 +1,13 @@
+module FFI
+  module GPhoto2
+    class CameraFileInfoPreview < FFI::Struct
+      # gphoto2/gphoto2-filesys.h
+      layout :fields, CameraFileInfoFields,
+             :status, CameraFileStatus,
+             :size, :uint64,
+             :type, [:char, 64],
+             :width, :uint32,
+             :height, :uint32
+    end
+  end
+end

data/lib/ffi/gphoto2/camera_file_permissions.rb

@@ -0,0 +1,9 @@
+module FFI
+  module GPhoto2
+    # gphoto2/gphoto2-filesys.h
+    CameraFilePermissions = enum :none, 0,
+                                 :read, 1 << 0,
+                                 :delete, 1 << 1,
+                                 :all, 0xff
+  end
+end

data/lib/ffi/gphoto2/camera_file_status.rb

@@ -0,0 +1,7 @@
+module FFI
+  module GPhoto2
+    # gphoto2/gphoto2-filesys.h
+    CameraFileStatus = enum :not_downloaded,
+                            :downloaded
+  end
+end

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/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/gphoto2.rb

@@ -17,6 +17,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'
@@ -39,6 +42,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 +67,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