rb_webcam 0.2.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+/spec/rb_webcam_spec_flymake.rb
+/spec/rb_webcam_spec_flymake_flymake.rb

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Hirotoshi YOSHITAKA
+
+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.rdoc

@@ -0,0 +1,32 @@
+= rb_webcam
+Crossplatform video capture library for Ruby
+(Powered by OpenCV)
+
+== Platform
+Windows, Mac OS X, Linux, etc...
+(OpenCV capable systems)
+
+== Dependency
+nice-ffi >= 0.3
+OpenCV Library >= 2.0.0
+
+== Install
+gem install rb_webcam
+
+== Usage
+camera_id = 0
+Webcam.open(camera_id) {|capture| image = capture.grab}
+
+or
+
+capture = Webcam.new
+image = capture.grab
+capture.close
+
+== TODO
+* output 'image' is *IplImage yet. we'll implement feature for JPG, BMP output.
+* specity size at initialize, or anytime.
+
+== LICENSE
+The MIT License
+Copyright (c) 2010 Hirotoshi YOSHITAKA. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rb_webcam"
+    gem.summary = "Crossplatform video capture library for Ruby (Powered by OpenCV)"
+    gem.description = "Crossplatform video capture library for Ruby (Powered by OpenCV)"
+    gem.email = "tyounan.moti@gmail.com"
+    gem.homepage = "http://github.com/TyounanMOTI/rb_webcam"
+    gem.authors = ["TyounanMOTI"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency "nice-ffi", ">= 0.3"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rb_webcam #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/lib/rb_webcam.rb

@@ -0,0 +1,161 @@
+require 'nice-ffi'
+
+# wrapper module of OpenCV::Highgui
+module Highgui
+  extend NiceFFI::Library
+
+  load_library("highgui")
+
+  class CvCapture < NiceFFI::OpaqueStruct
+  end
+
+  SIGNED_FLAG = 0x80000000
+  enum :color_depth, [ :unsinged_1bit,  1,
+                       :unsigned_8bit,  8,
+                       :unsigned_16bit, 16,
+                       :unsinged_32bit, 32,
+                       :signed_8bit,    SIGNED_FLAG | 8,
+                       :signed_16bit,   SIGNED_FLAG | 16,
+                       :signed_32bit,   SIGNED_FLAG | 32 ]
+  
+  # Grabbed webcam image will be stored in this structure.
+  # http://opencv.willowgarage.com/documentation/basic_structures.html#iplimage
+  class IplImage < NiceFFI::Struct
+    layout :n_size,         :int,
+           :id,             :int,
+           :n_channels,     :int,
+           :alpha_channel,  :int,
+           :depth,          :color_depth,
+           :color_mode,     [:char, 4],  # pointer to char[4]
+           :channel_seq,    [:char, 4],  # pointer to char[4]
+           :data_order,     :int,
+           :origin,         :int,
+           :align,          :int,
+           :width,          :int,
+           :height,         :int,
+           :roi,            :pointer,    # pointer to struct _IplROI
+           :mask_roi,       :pointer,    # pointer to struct _IplImage
+           :image_id,       :pointer,    # pointer to void
+           :tile_info,      :pointer,    # pointer to struct _IplTileInfo
+           :image_size,     :int,
+           :image_data,     :pointer,    # pointer to char array
+           :width_step,     :int,
+           :border_mode,    [:int, 4],   # pointer to int[4]
+           :border_const,   [:int, 4],   # pointer to int[4]
+           :image_data_origin, :pointer  # pointer to char array
+  end
+
+  enum :property, [ :position_msec, 0,
+                    :position_frames,
+                    :position_avi_ratio,
+                    :width,
+                    :height,
+                    :fps,
+                    :fourcc,
+                    :frame_count,
+                    :format,
+                    :mode,
+                    :brightness,
+                    :contrast,
+                    :saturation,
+                    :hue,
+                    :gain,
+                    :exposure,
+                    :convert_rgb,
+                    :white_balance,
+                    :rectification ]
+
+  attach_function :create_camera_capture, :cvCreateCameraCapture, [:int], :pointer
+  attach_function :release_capture, :cvReleaseCapture, [:pointer], :void
+  attach_function :query, :cvQueryFrame, [:pointer], IplImage.typed_pointer
+  attach_function :get_property, :cvGetCaptureProperty, [:pointer, :property], :double
+  attach_function :set_property, :cvSetCaptureProperty, [:pointer, :property, :double], :int
+end
+
+# Class to controll your webcam.
+# Initialize camera, grab image, then close.
+class Webcam
+  # Open camera with 'method with block' sentence.
+  # This will open then close at start and end of block.
+  # ex.
+  # Webcam.open { |camera| @image = camera.grab }
+  def self.open(camera_id=0)
+    webcam = Webcam.new(camera_id)
+    yield webcam
+    webcam.close
+  end
+  
+  # Open camera with camera_id, and size.
+  # camera_id: '0' to autodetect.
+  def initialize(camera_id=0)
+    @capture_handler = Highgui.create_camera_capture(camera_id)
+  end
+
+  # Grab a frame from camera and returns IplImage struct.
+  # This needs camera still opened.
+  def grab
+    raise "Camera has'nt be initialized" if @capture_handler.nil?
+    image = Highgui.query(@capture_handler)
+    return Image.new(image)
+  end
+
+  # Close camera. You need close opened camera for cleaner behavior.
+  def close
+    Highgui.release_capture(FFI::MemoryPointer.new(:pointer).write_pointer(@capture_handler))
+    @capture_handler = nil
+  end
+
+  # Set resolution of camera output.
+  # [usage] @webcam.resolution_mode = {width: 160, height: 120}
+  # Available resolution_mode is depends on your camera.
+  def resolution_mode=(resolution)
+    Highgui.set_property(@capture_handler, :width, resolution[:width])
+    Highgui.set_property(@capture_handler, :height, resolution[:height])
+  end
+
+  # Get resolution mode of camera.
+  # return format is written in resolution_mode=(resolution)
+  def resolution_mode
+    {width: Highgui.get_property(@capture_handler, :width),
+    height: Highgui.get_property(@capture_handler, :height)}
+  end
+
+  # Getter for debug use.
+  # Internally used to call OpenCV C functions for specified camera.
+  attr_reader :capture_handler
+  
+  # Property Container of image from webcam.
+  # Get size, color_depth, mode, etc.. of image.
+  # Each instance have IplImage struct data.
+  # TODO: Having pointer to IplImage struct will be good for performance?
+  #       (Does whole structure copying occur at Image.new(iplimage) ?)
+  class Image
+    def initialize(iplimage_struct)
+      @iplimage_struct = iplimage_struct
+    end
+
+    # get size of image. Hash with :width, :height elements.
+    def size
+      {width: @iplimage_struct.width, height: @iplimage_struct.height}
+    end
+
+    # get color depth of image.
+    def color_depth
+      @iplimage_struct.depth
+    end
+    
+    # FFI::Pointer to image data
+    def data
+      @iplimage_struct.image_data
+    end
+    
+    # data size of image
+    def data_size
+      @iplimage_struct.image_size
+    end
+    
+    # IplImage structure stored grabbed image from camera.
+    attr_reader :iplimage_struct
+  end
+end
+

data/rb_webcam.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rb_webcam}
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["TyounanMOTI"]
+  s.date = %q{2010-03-25}
+  s.description = %q{Crossplatform video capture library for Ruby (Powered by OpenCV)}
+  s.email = %q{tyounan.moti@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/rb_webcam.rb",
+     "rb_webcam.gemspec",
+     "spec/rb_webcam_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/TyounanMOTI/rb_webcam}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Crossplatform video capture library for Ruby (Powered by OpenCV)}
+  s.test_files = [
+    "spec/rb_webcam_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<nice-ffi>, [">= 0.3"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<nice-ffi>, [">= 0.3"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<nice-ffi>, [">= 0.3"])
+  end
+end
+

data/spec/rb_webcam_spec.rb

@@ -0,0 +1,72 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Webcam do
+  share_examples_for "Webcam which closed" do
+    it { lambda{ @c_webcam.grab }.should raise_error(RuntimeError, "Camera has'nt be initialized") }
+  end
+
+  share_examples_for "Webcam which lives a full life" do
+    it { @c_webcam.should_not be_nil }
+    
+    it "capture handler should be instance of FFI::Pointer" do
+      @c_webcam.capture_handler.should be_instance_of(FFI::Pointer)
+    end
+    
+    describe "grabbed image" do
+      before do
+        @image = @c_webcam.grab
+      end
+      
+      it { @image.should be_instance_of Webcam::Image }
+
+      it "should have @iplimage_struct instance of Highgui::IplImage" do
+        @image.iplimage_struct.should be_instance_of Highgui::IplImage
+      end
+
+      it "color_depth should equal to camera resolution mode" do
+        @image.size.should == @c_webcam.resolution_mode
+      end
+      
+      it "color_depth should be Symbol" do
+        @image.color_depth.should be_instance_of Symbol
+      end
+      
+      it "data should be instance of FFI::Pointer" do
+        @image.data.should be_instance_of FFI::Pointer
+      end
+      
+      it "data size should > 0" do
+        @image.data_size.should > 0
+      end
+    end
+    
+    it "resolution mode of width should > 0" do
+      @c_webcam.resolution_mode[:width].should > 0.0
+    end
+    
+    it "close() should return nil" do
+      @c_webcam.close.should be_nil
+    end
+    
+    it_should_behave_like "Webcam which closed"
+  end
+
+  context "when given camera_id: 0" do
+    before(:all) do
+      @c_webcam = Webcam.new(0)
+    end
+
+    it_should_behave_like "Webcam which lives a full life"
+  end
+
+  context "when grab a frame using method with block" do
+    before do
+      @c_webcam
+      Webcam.open(0) do |camera|
+        @c_webcam = camera
+      end
+    end
+
+    it_should_behave_like "Webcam which closed"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rb_webcam'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: rb_webcam
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
+platform: ruby
+authors: 
+- TyounanMOTI
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-25 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nice-ffi
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        version: "0.3"
+  type: :runtime
+  version_requirements: *id002
+description: Crossplatform video capture library for Ruby (Powered by OpenCV)
+email: tyounan.moti@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rb_webcam.rb
+- rb_webcam.gemspec
+- spec/rb_webcam_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/TyounanMOTI/rb_webcam
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Crossplatform video capture library for Ruby (Powered by OpenCV)
+test_files: 
+- spec/rb_webcam_spec.rb
+- spec/spec_helper.rb