hornetseye-dc1394 0.3.2 → 0.3.4

data/README.md

@@ -1,3 +1,47 @@
 hornetseye-dc1394
-======
+=================
 This Ruby extension provides camera input for DC1394 compatible firewire cameras using libdc1394 2.x.
+
+**Author**:       Jan Wedekind
+**Copyright**:    2010
+**License**:      GPL
+
+Synopsis
+--------
+
+This Ruby extension provides the class {Hornetseye::DC1394Input} for capturing video frames using a DC1394-compatible firewire camera.
+
+Installation
+------------
+*hornetseye-dc1394* requires the V4L2 headers. If you are running Debian or (K)ubuntu, you can install them like this:
+
+    $ sudo aptitude install libdc1394-22-dev
+
+To install this Ruby extension, use the following command:
+
+    $ sudo gem install hornetseye-dc1394
+
+Alternatively you can build and install the Ruby extension from source as follows:
+
+    $ rake
+    $ sudo rake install
+
+Usage
+-----
+
+Simply run Interactive Ruby:
+
+    $ irb
+
+You can open a DC1394-compatible firewire camera as shown below. This example will open the camera and switch to a resolution selected by the user. Finally the camera input is displayed in a window. This example requires *hornetseye-xorg* in addition to this Ruby extension.
+
+    require 'rubygems'
+    require 'hornetseye_dc1394'
+    require 'hornetseye_xorg'
+    include Hornetseye
+    camera = DC1394Input.new 0 do |modes|
+      modes.each_with_index { |mode,i| puts "#{i + 1}: #{mode}" }
+      modes[ STDIN.readline.to_i - 1 ]
+    end
+    X11Display.show { camera.read }
+

data/Rakefile

@@ -7,7 +7,7 @@ require 'rake/loaders/makefile'
 require 'rbconfig'
 
 PKG_NAME = 'hornetseye-dc1394'
-PKG_VERSION = '0.3.2'
+PKG_VERSION = '0.3.4'
 CFG = RbConfig::CONFIG
 CXX = ENV[ 'CXX' ] || 'g++'
 RB_FILES = FileList[ 'lib/**/*.rb' ]

data/ext/dc1394input.cc

@@ -395,6 +395,8 @@ VALUE DC1394Input::registerRubyClass( VALUE module )
                    INT2NUM( DC1394_FEATURE_MODE_ONE_PUSH_AUTO ) );
   rb_define_singleton_method( cRubyClass, "new", RUBY_METHOD_FUNC( wrapNew ), 5 );
   rb_define_method( cRubyClass, "close", RUBY_METHOD_FUNC( wrapClose ), 0 );
+  rb_define_method( cRubyClass, "width", RUBY_METHOD_FUNC( wrapWidth ), 0 );
+  rb_define_method( cRubyClass, "height", RUBY_METHOD_FUNC( wrapHeight ), 0 );
   rb_define_method( cRubyClass, "read", RUBY_METHOD_FUNC( wrapRead ), 0 );
   rb_define_method( cRubyClass, "status?", RUBY_METHOD_FUNC( wrapStatus ), 0 );
   rb_define_method( cRubyClass, "feature_read",
@@ -474,6 +476,18 @@ VALUE DC1394Input::wrapStatus( VALUE rbSelf )
   return (*self)->status() ? Qtrue : Qfalse;
 }
 
+VALUE DC1394Input::wrapWidth( VALUE rbSelf )
+{
+  DC1394InputPtr *self; Data_Get_Struct( rbSelf, DC1394InputPtr, self );
+  return INT2NUM((*self)->width());
+}
+
+VALUE DC1394Input::wrapHeight( VALUE rbSelf )
+{
+  DC1394InputPtr *self; Data_Get_Struct( rbSelf, DC1394InputPtr, self );
+  return INT2NUM((*self)->height());
+}
+
 VALUE DC1394Input::wrapFeatureGetValue( VALUE rbSelf, VALUE rbFeature )
 {
   VALUE rbRetVal = Qnil;

data/ext/dc1394input.hh

@@ -33,6 +33,8 @@ public:
   FramePtr read(void) throw (Error);
   bool status(void) const;
   std::string inspect(void) const;
+  int width(void) const { return m_width; }
+  int height(void) const { return m_height; }
   unsigned int featureGetValue( dc1394feature_t feature ) throw (Error);
   void featureSetValue( dc1394feature_t feature, unsigned int value ) throw (Error);
   bool featureIsPresent( dc1394feature_t feature ) throw (Error);
@@ -54,6 +56,8 @@ public:
   static VALUE wrapClose( VALUE rbSelf );
   static VALUE wrapRead( VALUE rbSelf );
   static VALUE wrapStatus( VALUE rbSelf );
+  static VALUE wrapWidth( VALUE rbSelf );
+  static VALUE wrapHeight( VALUE rbSelf );
   static VALUE wrapFeatureGetValue( VALUE rbSelf, VALUE rbFeature );
   static VALUE wrapFeatureSetValue( VALUE rbSelf, VALUE rbFeature, VALUE rbValue );
   static VALUE wrapFeatureIsPresent( VALUE rbSelf, VALUE rbFeature );

data/lib/hornetseye-dc1394/dc1394input.rb

@@ -1,4 +1,4 @@
-# hornetseye-xorg - Graphical output under X.Org
+# hornetseye-dc1394 - Capture from DC1394 compatible firewire camera
 # Copyright (C) 2010 Jan Wedekind
 #
 # This program is free software: you can redistribute it and/or modify
@@ -17,14 +17,33 @@
 # Namespace of Hornetseye computer vision library
 module Hornetseye
 
+  # Class for handling a DC1394-compatible firewire camera
+  #
+  # This Ruby-extension is based on libdc1394.
+  #
+  # @see http://damien.douxchamps.net/ieee1394/libdc1394/
   class DC1394Input
 
     class << self
 
+      # DC1394 handle
+      #
+      # @private
       @@dc1394 = nil
 
+      # Alias for overriding native method
+      #
+      # @private
       alias_method :orig_new, :new
 
+      # Open the firewire camera
+      #
+      # @param [Integer] node Camera node to open.
+      # @param [Integer] speed Firewire bus speed.
+      # @param [Integer,NilClass] frame_rate Desired frame rate.
+      # @param [Proc] action Optional block for selecting the desired video mode.
+      #
+      # return [DC1394Input] An object for accessing the firewire camera.
       def new( node = 0, speed = SPEED_400, frame_rate = nil, &action )
         dc1394 = @@dc1394 || DC1394.new
         begin

data/lib/hornetseye-dc1394/docs.rb

@@ -0,0 +1,100 @@
+# hornetseye-dc1394 - Capture from DC1394 compatible firewire camera
+# Copyright (C) 2010 Jan Wedekind
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Namespace of Hornetseye computer vision library
+module Hornetseye
+
+  # Class for handling a DC1394-compatible firewire camera
+  #
+  # This Ruby-extension is based on libdc1394.
+  #
+  # @see http://damien.douxchamps.net/ieee1394/libdc1394/
+  class DC1394Input
+
+    class << self
+
+      # Close the video device
+      #
+      # @return [DC1394Input] Returns +self+.
+      def close
+      end
+
+      # Read a video frame
+      #
+      # @return [MultiArray,Frame_] The video frame.
+      def read
+      end
+
+      # Check whether device is not closed
+      #
+      # @return [Boolean] Returns +true+ as long as device is open.
+      def status?
+      end
+
+      # Width of video input
+      #
+      # @return [Integer] Width of video frames.
+      def width
+      end
+
+      # Height of video input
+      #
+      # @return [Integer] Width of video frames.
+      def height
+      end
+
+      def feature_read( id )
+      end
+
+      def feature_write( id, value )
+      end
+
+      def feature_exist?( id )
+      end
+
+      def feature_readable?( id )
+      end
+
+      def feature_switchable?( id )
+      end
+
+      def feature_on?( id )
+      end
+
+      def feature_on( id, value )
+      end
+
+      def feature_modes( id )
+      end
+
+      def feature_mode_read( id )
+      end
+
+      def feature_mode_write( id, mode )
+      end
+
+      def feature_min( id )
+      end
+
+      def feature_max( id )
+      end
+
+    end
+
+  end
+
+end
+

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 2
-  version: 0.3.2
+  - 4
+  version: 0.3.4
 platform: ruby
 authors: 
 - Jan Wedekind
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-21 00:00:00 +00:00
+date: 2010-11-22 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -87,6 +87,7 @@ files:
 - .document
 - lib/hornetseye_dc1394_ext.rb
 - lib/hornetseye-dc1394/dc1394input.rb
+- lib/hornetseye-dc1394/docs.rb
 - ext/dc1394input.cc
 - ext/dc1394select.cc
 - ext/init.cc