ffi-gphoto2 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4fb2cb331909ca8e1522318738dfbfe6675c6aba
+  data.tar.gz: d895c48398334dc8c60565b7302673244402f06d
+SHA512:
+  metadata.gz: 6dbbfd432cd4ad2516ba6ebfbeda293debd0a02587b41b5bf2d21f6c2d35c7bee9b70ed06265958158cec9a66b9b7d12c237bb636b668b289947c08c152971a8
+  data.tar.gz: c9c4ae048625002e761f87390d7a57d664c8e471344e88395d5581910efba2ca16edc0910c3cbbbc54dbd0432ea6a766b713ee0f6add001b999fb130cc11fc10

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ffi-gphoto2.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michael Macias
+
+MIT License
+
+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,90 @@
+# ffi-gphoto2
+
+**ffi-gphoto2** provides an FFI for common functions in [libgphoto2][1].
+It also includes a facade to interact with the library in a more
+canonical Ruby way.
+
+## Installation
+
+### Prerequisites
+
+  * Ruby >= 1.9
+  * libgphoto2 >= 2.5.0 (`brew install libgphoto2`)
+
+### Gem
+
+    $ gem install ffi-gphoto2
+
+## Usage
+
+    require 'gphoto2'
+
+    # list available cameras
+    cameras = GPhoto2::Camera.all
+    # => [#<GPhoto2::Camera>, ...]
+
+    # list found cameras by model and port path
+    cameras.map { |c| [c.model, c.port] }
+    # => [['Nikon DSC D5100 (PTP mode)', 'usb:250,006'], ...]
+
+    # use the first camera
+    camera = cameras.first
+
+    # ...or more conveniently
+    camera = GPhoto2::Camera.first
+
+    # ...or even search by model name
+    camera = GPhoto2::Camera.where(/nikon/i).first
+
+    # list camera configuration names
+    camera.config.keys
+    # => ['autofocusdrive', 'manualfocusdrive', 'controlmode', ...]
+
+    # read the current configuration value of an option
+    camera['whitebalance']
+    # => "Automatic"
+
+    # list valid choices of a configuration option
+    camera['whitebalance'].choices
+    # => ['Automatic', 'Daylight', 'Fluorescent', 'Tungsten', ...]
+
+    # check if the configuration has changed
+    camera.dirty?
+    # => false
+
+    # change camera configuration
+    camera['iso'] = 800
+    camera['f-number'] = 'f/4.5'
+    camera['shutterspeed2'] = '1/30'
+
+    # check if the configuration has changed
+    camera.dirty?
+    # => true
+
+    # apply the new configuration on the device
+    camera.save
+
+    # take a photo
+    file = camera.capture
+
+    # ...and save it to the current working directory
+    file.save
+
+    # traverse the camera filesystem
+    folder = camera/'store_00010001/DCIM/100D5100'
+
+    # list files
+    files = folder.files
+    folder.files.map(&:name)
+    => ["DSC_0001.JPG", "DSC_0002.JPG", ...]
+
+    # save a file
+    files.first.save
+
+    # close the camera
+    camera.finalize
+
+More examples can be found in [`examples/`][2].
+
+[1]: http://www.gphoto.org/
+[2]: https://github.com/zaeleus/ffi-gphoto2/tree/master/examples

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task default: :spec

data/examples/intervalometer.rb

@@ -0,0 +1,12 @@
+require 'gphoto2'
+
+camera = GPhoto2::Camera.first
+
+six_hours = 60 * 60 * 6
+stop_time = Time.now + six_hours
+
+# take a photo every 30 seconds for 6 hours
+until Time.now >= stop_time
+  camera.capture.save
+  sleep 30
+end

data/examples/live_view.rb

@@ -0,0 +1,21 @@
+# Run and pipe to a video player that can demux raw mjpeg. For example,
+#
+#     ruby live_view.rb | mpv --demuxer=+lavf --demuxer-lavf-format=mjpeg --demuxer-lavf-analyzeduration=0.1 -
+
+require 'gphoto2'
+
+# automatically flush the io buffer
+STDOUT.sync = true
+
+camera = GPhoto2::Camera.first
+
+begin
+  loop do
+    # write the preview image to stdout
+    print camera.preview.data
+  end
+ensure
+  # make sure to close (or #exit) the camera
+  # otherwise, the mirror will stay up
+  camera.finalize
+end

data/ffi-gphoto2.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'gphoto2/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ffi-gphoto2'
+  spec.summary       = 'A Ruby FFI for common functions in libgphoto2'
+  spec.homepage      = 'https://github.com/zaeleus/ffi-gphoto2'
+
+  spec.authors       = ['Michael Macias']
+  spec.email         = ['mamacias@go.olemiss.edu']
+
+  spec.version       = GPhoto2::VERSION
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.requirements << 'libgphoto2 >= 2.5.0'
+  spec.required_ruby_version = '>= 1.9'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.14.1'
+
+  spec.add_dependency 'ffi', '~> 1.9.0'
+end

data/lib/ffi/gphoto2.rb

@@ -0,0 +1,85 @@
+require 'ffi/gphoto2_port'
+
+module FFI
+  module GPhoto2
+    extend FFI::Library
+
+    ffi_lib 'libgphoto2'
+
+    # enums
+    require 'ffi/gphoto2/camera_capture_type'
+    require 'ffi/gphoto2/camera_driver_status'
+    require 'ffi/gphoto2/camera_event_type'
+    require 'ffi/gphoto2/camera_file_access_type'
+    require 'ffi/gphoto2/camera_file_operation'
+    require 'ffi/gphoto2/camera_file_type'
+    require 'ffi/gphoto2/camera_folder_operation'
+    require 'ffi/gphoto2/camera_operation'
+    require 'ffi/gphoto2/camera_widget_type'
+    require 'ffi/gphoto2/gphoto_device_type'
+
+    # structs
+    require 'ffi/gphoto2/camera'
+    require 'ffi/gphoto2/camera_abilities'
+    require 'ffi/gphoto2/camera_abilities_list'
+    require 'ffi/gphoto2/camera_file'
+    require 'ffi/gphoto2/camera_file_path'
+    require 'ffi/gphoto2/camera_list'
+    require 'ffi/gphoto2/camera_widget'
+    require 'ffi/gphoto2/entry'
+    require 'ffi/gphoto2/gp_context'
+
+    # gphoto2/gphoto2-abilities-list.h
+    attach_function :gp_abilities_list_new, [:pointer], :int
+    attach_function :gp_abilities_list_free, [CameraAbilitiesList.by_ref], :int
+    attach_function :gp_abilities_list_load, [CameraAbilitiesList.by_ref, GPContext.by_ref], :int
+    attach_function :gp_abilities_list_detect, [CameraAbilitiesList.by_ref, GPhoto2Port::GPPortInfoList.by_ref, CameraList.by_ref, GPContext.by_ref], :int
+    attach_function :gp_abilities_list_lookup_model, [CameraAbilitiesList.by_ref, :string], :int
+    attach_function :gp_abilities_list_get_abilities, [CameraAbilitiesList.by_ref, :int, CameraAbilities.by_ref], :int
+
+    # gphoto2/gphoto2-camera.h
+    attach_function :gp_camera_new, [:pointer], :int
+    attach_function :gp_camera_set_abilities, [Camera.by_ref, CameraAbilities.by_value], :int
+    attach_function :gp_camera_set_port_info, [Camera.by_ref, GPhoto2Port::GPPortInfo], :int
+    attach_function :gp_camera_exit, [Camera.by_ref, GPContext.by_ref], :int
+    attach_function :gp_camera_ref, [Camera.by_ref], :int
+    attach_function :gp_camera_unref, [Camera.by_ref], :int
+    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
+    attach_function :gp_camera_capture_preview, [Camera.by_ref, CameraFile.by_ref, GPContext.by_ref], :int
+    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, [Camera.by_ref, :string, :string, CameraFileType, CameraFile.by_ref, GPContext.by_ref], :int
+
+    # gphoto2/gphoto2-context.h
+    attach_function :gp_context_new, [], :pointer
+    attach_function :gp_context_ref, [GPContext.by_ref], :void
+    attach_function :gp_context_unref, [GPContext.by_ref], :void
+
+    # gphoto2/gphoto2-file.h
+    attach_function :gp_file_new, [:pointer], :int
+    attach_function :gp_file_free, [CameraFile.by_ref], :int
+    attach_function :gp_file_get_data_and_size, [CameraFile.by_ref, :pointer, :pointer], :int
+
+    # gphoto2/gphoto2-list.h
+    attach_function :gp_list_new, [:pointer], :int
+    attach_function :gp_list_free, [CameraList.by_ref], :int
+    attach_function :gp_list_count, [CameraList.by_ref], :int
+    attach_function :gp_list_get_name, [CameraList.by_ref, :int, :pointer], :int
+    attach_function :gp_list_get_value, [CameraList.by_ref, :int, :pointer], :int
+
+    # gphoto2/gphoto2-widget.h
+    attach_function :gp_widget_free, [CameraWidget.by_ref], :int
+    attach_function :gp_widget_count_children, [CameraWidget.by_ref], :int
+    attach_function :gp_widget_get_child, [CameraWidget.by_ref, :int, :pointer], :int
+    attach_function :gp_widget_set_value, [CameraWidget.by_ref, :pointer], :int
+    attach_function :gp_widget_get_value, [CameraWidget.by_ref, :pointer], :int
+    attach_function :gp_widget_get_name, [CameraWidget.by_ref, :pointer], :int
+    attach_function :gp_widget_get_type, [CameraWidget.by_ref, :pointer], :int
+    attach_function :gp_widget_get_range, [CameraWidget.by_ref, :pointer, :pointer, :pointer], :int
+    attach_function :gp_widget_count_choices, [CameraWidget.by_ref], :int
+    attach_function :gp_widget_get_choice, [CameraWidget.by_ref, :int, :pointer], :int
+  end
+end

data/lib/ffi/gphoto2/camera.rb

@@ -0,0 +1,12 @@
+module FFI
+  module GPhoto2
+    class Camera < FFI::Struct
+      # gphoto2/gphoto2-camera.h
+      layout :port, :pointer, # GPPort
+             :fs, :pointer, # CameraFilesystem
+             :functions, :pointer, # CameraFunctions
+             :pl, :pointer, # CameraPrivateLibrary
+             :pc, :pointer # CameraPrivateCore
+    end
+  end
+end

data/lib/ffi/gphoto2/camera_abilities.rb

@@ -0,0 +1,37 @@
+require 'ffi/gphoto2_port/gp_port_type'
+
+module FFI
+  module GPhoto2
+    class CameraAbilities < FFI::Struct
+      # gphoto2/gphoto2-abilities-list.h
+      layout :model, [:char, 128],
+             :status, CameraDriverStatus,
+
+             :port, GPhoto2Port::GPPortType,
+             :speed, [:int, 64],
+
+             :operations, CameraOperation,
+             :file_operations, CameraFileOperation,
+             :folder_operations, CameraFolderOperation,
+
+             :usb_vendor, :int,
+             :usb_product, :int,
+             :usb_class, :int,
+             :usb_subclass, :int,
+             :usb_protocol, :int,
+
+             :library, [:char, 1024],
+             :id, [:char, 1024],
+
+             :device_type, GphotoDeviceType,
+
+             :reserved2, :int,
+             :reserved3, :int,
+             :reserved4, :int,
+             :reserved5, :int,
+             :reserved6, :int,
+             :reserved7, :int,
+             :reserved8, :int
+    end
+  end
+end

data/lib/ffi/gphoto2/camera_abilities_list.rb

@@ -0,0 +1,15 @@
+require 'ffi/gphoto2/camera_abilities'
+
+module FFI
+  module GPhoto2
+    class CameraAbilitiesList < FFI::ManagedStruct
+      # libgphoto2/gphoto2-abilities-list.c
+      layout :count, :int,
+             :abilities, :pointer # CameraAbilities*
+
+      def self.release(ptr)
+        FFI::GPhoto2.gp_abilities_list_free(ptr)
+      end
+    end
+  end
+end

data/lib/ffi/gphoto2/camera_capture_type.rb

@@ -0,0 +1,8 @@
+module FFI
+  module GPhoto2
+    # gphoto2/gphoto2-camera.h
+    CameraCaptureType = enum :image,
+                             :movie,
+                             :sound
+  end
+end

data/lib/ffi/gphoto2/camera_driver_status.rb

@@ -0,0 +1,9 @@
+module FFI
+  module GPhoto2
+    # gphoto2/gphoto2-abilities-list.h
+    CameraDriverStatus = enum :production,
+                              :testing,
+                              :experimental,
+                              :deprecated
+  end
+end

data/lib/ffi/gphoto2/camera_event_type.rb

@@ -0,0 +1,10 @@
+module FFI
+  module GPhoto2
+    # gphoto2/gphoto2-camera.h
+    CameraEventType = enum :unknown,
+                           :timeout,
+                           :file_added,
+                           :folder_added,
+                           :capture_complete
+  end
+end

data/lib/ffi/gphoto2/camera_file.rb

@@ -0,0 +1,28 @@
+module FFI
+  module GPhoto2
+    class CameraFile < FFI::ManagedStruct
+      MAX_PATH = 256
+
+      # libgphoto2/gphoto2-file.c
+      layout :mime_type, [:char, 64],
+             :name, [:char, MAX_PATH],
+             :ref_count, :int,
+             :mtime, :time_t,
+
+             :accesstype, CameraFileAccessType,
+
+             :size, :ulong,
+             :data, :pointer, # unsigned char*
+             :offset, :ulong,
+
+             :fd, :int,
+
+             :handler, :pointer, # CameraFileHandler
+             :private, :pointer # void*
+
+      def self.release(ptr)
+        FFI::GPhoto2.gp_file_free(ptr)
+      end
+    end
+  end
+end