hornetseye-ffmpeg 0.1.0

data/README.md

@@ -0,0 +1,4 @@
+Hornetseye-FFMPEG
+======
+This Ruby extension defines the class {Hornetseye::AVInput} for reading frames from video files.
+

data/Rakefile

@@ -0,0 +1,178 @@
+#!/usr/bin/env ruby
+require 'date'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rbconfig'
+
+PKG_NAME = 'hornetseye-ffmpeg'
+PKG_VERSION = '0.1.0'
+CXX = ENV[ 'CXX' ] || 'g++'
+STRIP = ENV[ 'STRIP' ] || 'strip'
+RB_FILES = FileList[ 'lib/**/*.rb' ]
+CC_FILES = FileList[ 'ext/*.cc' ]
+HH_FILES = FileList[ 'ext/*.hh' ]
+TC_FILES = FileList[ 'test/tc_*.rb' ]
+TS_FILES = FileList[ 'test/ts_*.rb' ]
+SO_FILE = "ext/#{PKG_NAME.tr '\-', '_'}.so"
+PKG_FILES = [ 'Rakefile', 'README.md', 'COPYING', '.document' ] +
+            RB_FILES + CC_FILES + HH_FILES + TS_FILES + TC_FILES
+BIN_FILES = [ 'README.md', 'COPYING', '.document', SO_FILE ] +
+            RB_FILES + TS_FILES + TC_FILES
+SUMMARY = %q{Read video frames using libffmpeg}
+DESCRIPTION = %q{This Ruby extension defines the class Hornetseye::AVInput for reading frames from video files.}
+AUTHOR = %q{Jan Wedekind}
+EMAIL = %q{jan@wedesoft.de}
+HOMEPAGE = %q{http://wedesoft.github.com/hornetseye-ffmpeg/}
+
+OBJ = CC_FILES.ext 'o'
+$CXXFLAGS = ENV[ 'CXXFLAGS' ] || ''
+$CXXFLAGS = "#{$CXXFLAGS} -fPIC"
+if Config::CONFIG[ 'rubyhdrdir' ]
+  $CXXFLAGS += "#{$CXXFLAGS} -I#{Config::CONFIG[ 'rubyhdrdir' ]} " +
+              "-I#{Config::CONFIG[ 'rubyhdrdir' ]}/#{Config::CONFIG[ 'arch' ]}"
+else
+  $CXXFLAGS += "#{$CXXFLAGS} -I#{Config::CONFIG[ 'archdir' ]}"
+end
+$LIBRUBYARG = Config::CONFIG[ 'LIBRUBYARG' ]
+$SITELIBDIR = Config::CONFIG[ 'sitelibdir' ]
+$SITEARCHDIR = Config::CONFIG[ 'sitearchdir' ]
+
+task :default => :all
+
+desc 'Compile Ruby extension (default)'
+task :all => [ SO_FILE ]
+
+file SO_FILE => OBJ do |t|
+   sh "#{CXX} -shared -o #{t.name} #{OBJ} -lavformat -lswscale #{$LIBRUBYARG}"
+   # sh "#{STRIP} --strip-all #{t.name}"
+end
+
+task :test => [ SO_FILE ]
+
+desc 'Install Ruby extension'
+task :install => :all do
+  verbose true do
+    for f in RB_FILES do
+      FileUtils.mkdir_p "#{$SITELIBDIR}/#{File.dirname f.gsub( /^lib\//, '' )}"
+      FileUtils.cp_r f, "#{$SITELIBDIR}/#{f.gsub( /^lib\//, '' )}"
+    end
+    FileUtils.mkdir_p $SITEARCHDIR
+    FileUtils.cp SO_FILE, "#{$SITEARCHDIR}/#{File.basename SO_FILE}"
+  end
+end
+
+desc 'Uninstall Ruby extension'
+task :uninstall do
+  verbose true do
+    for f in RB_FILES do
+      FileUtils.rm_f "#{$SITELIBDIR}/#{f.gsub /^lib\//, ''}"
+    end
+    FileUtils.rm_f "#{$SITEARCHDIR}/#{File.basename SO_FILE}"
+  end
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'ext'
+  t.test_files = TC_FILES
+end
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new :yard do |y|
+    y.options << '--no-private'
+    y.files << FileList[ 'lib/**/*.rb' ]
+  end
+rescue LoadError
+  STDERR.puts 'Please install \'yard\' if you want to generate documentation'
+end
+
+Rake::PackageTask.new PKG_NAME, PKG_VERSION do |p|
+  p.need_tar = true
+  p.package_files = PKG_FILES
+end
+
+begin
+  require 'rubygems/builder'
+  $SPEC = Gem::Specification.new do |s|
+    s.name = PKG_NAME
+    s.version = PKG_VERSION
+    s.platform = Gem::Platform::RUBY
+    s.date = Date.today.to_s
+    s.summary = SUMMARY
+    s.description = DESCRIPTION
+    s.author = AUTHOR
+    s.email = EMAIL
+    s.homepage = HOMEPAGE
+    s.files = PKG_FILES
+    s.test_files = TC_FILES
+    s.require_paths = [ 'lib', 'ext' ]
+    s.rubyforge_project = %q{hornetseye}
+    s.extensions = %w{Rakefile}
+    s.has_rdoc = 'yard'
+    s.extra_rdoc_files = []
+    s.rdoc_options = %w{--no-private}
+    s.add_dependency %<malloc>, [ '~> 1.1' ]
+    s.add_dependency %<multiarray>, [ '~> 0.5' ]
+    s.add_dependency %<hornetseye-frame>, [ '~> 0.1' ]
+    s.add_development_dependency %q{rake}
+  end
+  GEM_SOURCE = "#{PKG_NAME}-#{PKG_VERSION}.gem"
+  $BINSPEC = Gem::Specification.new do |s|
+    s.name = PKG_NAME
+    s.version = PKG_VERSION
+    s.platform = Gem::Platform::CURRENT
+    s.date = Date.today.to_s
+    s.summary = SUMMARY
+    s.description = DESCRIPTION
+    s.author = AUTHOR
+    s.email = EMAIL
+    s.homepage = HOMEPAGE
+    s.files = BIN_FILES
+    s.test_files = TC_FILES
+    s.require_paths = [ 'lib', 'ext' ]
+    s.rubyforge_project = %q{hornetseye}
+    s.has_rdoc = 'yard'
+    s.extra_rdoc_files = []
+    s.rdoc_options = %w{--no-private}
+    s.add_dependency %<malloc>, [ '~> 1.1' ]
+    s.add_dependency %<multiarray>, [ '~> 0.5' ]
+    s.add_dependency %<hornetseye-frame>, [ '~> 0.1' ]
+  end
+  GEM_BINARY = "#{PKG_NAME}-#{PKG_VERSION}-#{$BINSPEC.platform}.gem"
+  desc "Build the gem file #{GEM_SOURCE}"
+  task :gem => [ "pkg/#{GEM_SOURCE}" ]
+  file "pkg/#{GEM_SOURCE}" => [ 'pkg' ] + $SPEC.files do
+    when_writing 'Creating GEM' do
+      Gem::Builder.new( $SPEC ).build
+      verbose true do
+        FileUtils.mv GEM_SOURCE, "pkg/#{GEM_SOURCE}"
+      end
+    end
+  end
+  desc "Build the gem file #{GEM_BINARY}"
+  task :gem_binary => [ "pkg/#{GEM_BINARY}" ]
+  file "pkg/#{GEM_BINARY}" => [ 'pkg' ] + $BINSPEC.files do
+    when_writing 'Creating binary GEM' do
+      Gem::Builder.new( $BINSPEC ).build
+      verbose true do
+        FileUtils.mv GEM_BINARY, "pkg/#{GEM_BINARY}"
+      end
+    end
+  end
+rescue LoadError
+  STDERR.puts 'Please install \'rubygems\' if you want to create Gem packages'
+end
+
+rule '.o' => '.cc' do |t|
+   sh "#{CXX} #{$CXXFLAGS} -c -o #{t.name} #{t.source}"
+end
+
+file 'ext/avinput.o' => [ 'ext/avinput.cc', 'ext/avinput.hh', 'ext/error.hh',
+                          'ext/frame.hh' ]
+file 'ext/frame.o' => [ 'ext/frame.cc', 'ext/frame.hh' ]
+file 'ext/init.o' => [ 'ext/init.cc', 'ext/avinput.hh' ]
+
+CLEAN.include 'ext/*.o'
+CLOBBER.include SO_FILE, 'doc', '.yardoc'
+

data/ext/avinput.cc

@@ -0,0 +1,159 @@
+/* HornetsEye - Computer Vision with Ruby
+   Copyright (C) 2006, 2007, 2008, 2009, 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/>. */
+#include "avinput.hh"
+
+using namespace std;
+
+VALUE AVInput::cRubyClass = Qnil;
+
+AVInput::AVInput( const string &mrl ) throw (Error):
+  m_mrl( mrl ), m_ic( NULL ), m_enc( NULL ), m_codec( NULL ), m_idx( -1 ),
+  m_frame( NULL )
+{
+  try {
+    int err = av_open_input_file( &m_ic, mrl.c_str(), NULL, 0, NULL );
+    ERRORMACRO( err >= 0, Error, , "Error opening file \"" << mrl << "\": "
+                << strerror( -err ) );
+    err = av_find_stream_info( m_ic );
+    ERRORMACRO( err >= 0, Error, , "Error finding stream info for file \""
+                << mrl << "\": " << strerror( -err ) );
+    for ( int i=0; i<m_ic->nb_streams; i++ )
+      if ( m_ic->streams[i]->codec->codec_type == CODEC_TYPE_VIDEO ) {
+        m_idx = i;
+        break;
+      };
+    ERRORMACRO( m_idx >= 0, Error, , "Could not find video stream in file \""
+                << mrl << "\"" );
+    m_enc = m_ic->streams[ m_idx ]->codec;
+    m_codec = avcodec_find_decoder( m_enc->codec_id );
+    ERRORMACRO( m_codec != NULL, Error, , "Could not find decoder for file \""
+                << mrl << "\"" );
+    err = avcodec_open( m_enc, m_codec );
+    ERRORMACRO( err >= 0, Error, , "Error opening codec for file \""
+                << mrl << "\": " << strerror( -err ) );
+    m_frame = avcodec_alloc_frame();
+    ERRORMACRO( m_frame, Error, , "Error allocating frame" );
+  } catch ( Error &e ) {
+    close();
+    throw e;
+  };
+}
+
+AVInput::~AVInput(void)
+{
+  close();
+}
+
+void AVInput::close(void)
+{
+  if ( m_frame ) {
+    av_free( m_frame );
+    m_frame = NULL;
+  };
+  if ( m_codec ) {
+    avcodec_close( m_enc );
+    m_codec = NULL;
+  };
+  m_enc = NULL;
+  m_idx = -1;
+  if ( m_ic ) {
+    av_close_input_file( m_ic );
+    m_ic = NULL;
+  };
+}
+
+FramePtr AVInput::read(void) throw (Error)
+{
+  FramePtr retVal;
+  AVPacket packet;
+  while ( av_read_frame( m_ic, &packet ) >= 0 ) {
+    if ( packet.stream_index == m_idx ) {
+      int frameFinished;
+      int err = avcodec_decode_video( m_enc, m_frame, &frameFinished,
+                                      packet.data, packet.size );
+      ERRORMACRO( err >= 0, Error, ,
+                  "Error decoding frame of video \"" << m_mrl << "\"" );
+      if ( frameFinished ) {
+        av_free_packet( &packet );
+        AVFrame frame;
+        m_data = boost::shared_array< char >( new char[ m_enc->width *
+                                                        m_enc->height *
+                                                        3 / 2 ] );
+        frame.data[0] = (uint8_t *)m_data.get();
+        frame.data[1] = (uint8_t *)m_data.get() +
+                        m_enc->width * m_enc->height * 5 / 4;
+        frame.data[2] = (uint8_t *)m_data.get() + m_enc->width * m_enc->height;
+        frame.linesize[0] = m_enc->width;
+        frame.linesize[1] = m_enc->width / 2;
+        frame.linesize[2] = m_enc->width / 2;
+        struct SwsContext *swsContext =
+          sws_getContext( m_enc->width, m_enc->height, m_enc->pix_fmt,
+                          m_enc->width, m_enc->height, PIX_FMT_YUV420P,
+                          SWS_BILINEAR, 0, 0, 0 );
+        sws_scale( swsContext, m_frame->data, m_frame->linesize, 0,
+                   m_enc->height, frame.data, frame.linesize );
+        sws_freeContext( swsContext );
+        retVal = FramePtr( new Frame( "YV12", m_enc->width, m_enc->height,
+                                      m_data.get() ) );
+        break;
+      };
+    };
+    av_free_packet( &packet );
+  };
+  ERRORMACRO( retVal.get(), Error, , "No more frames available" );
+  return retVal;
+}
+
+VALUE AVInput::registerRubyClass( VALUE rbModule )
+{
+  av_register_all();
+  cRubyClass = rb_define_class_under( rbModule, "AVInput", rb_cObject );
+  rb_define_singleton_method( cRubyClass, "new",
+                              RUBY_METHOD_FUNC( wrapNew ), 1 );
+  rb_define_method( cRubyClass, "read", RUBY_METHOD_FUNC( wrapRead ), 0 );
+}
+
+void AVInput::deleteRubyObject( void *ptr )
+{
+  delete (AVInputPtr *)ptr;
+}
+
+VALUE AVInput::wrapNew( VALUE rbClass, VALUE rbMRL )
+{
+  VALUE retVal = Qnil;
+  try {
+    rb_check_type( rbMRL, T_STRING );
+    AVInputPtr ptr( new AVInput( StringValuePtr( rbMRL ) ) );
+    retVal = Data_Wrap_Struct( rbClass, 0, deleteRubyObject,
+                               new AVInputPtr( ptr ) );
+  } catch ( exception &e ) {
+    rb_raise( rb_eRuntimeError, "%s", e.what() );
+  };
+  return retVal;
+}
+
+VALUE AVInput::wrapRead( VALUE rbSelf )
+{
+  VALUE retVal = Qnil;
+  try {
+    AVInputPtr *self; Data_Get_Struct( rbSelf, AVInputPtr, self );
+    FramePtr frame( (*self)->read() );
+    retVal = frame->rubyObject();
+  } catch ( exception &e ) {
+    rb_raise( rb_eRuntimeError, "%s", e.what() );
+  };
+  return retVal;
+}

data/ext/avinput.hh

@@ -0,0 +1,52 @@
+/* HornetsEye - Computer Vision with Ruby
+   Copyright (C) 2006, 2007, 2008, 2009, 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/>. */
+#ifndef AVFORMAT_HH
+#define AVFORMAT_HH
+
+#include <boost/shared_ptr.hpp>
+#include <ruby.h>
+extern "C" {
+  #include <libswscale/swscale.h>
+  #include <libavformat/avformat.h>
+}
+#include "error.hh"
+#include "frame.hh"
+
+class AVInput
+{
+public:
+  AVInput( const std::string &mrl ) throw (Error);
+  virtual ~AVInput(void);
+  void close(void);
+  FramePtr read(void) throw (Error);
+  static VALUE cRubyClass;
+  static VALUE registerRubyClass( VALUE rbModule );
+  static void deleteRubyObject( void *ptr );
+  static VALUE wrapNew( VALUE rbClass, VALUE rbMRL );
+  static VALUE wrapRead( VALUE rbSelf );
+protected:
+  std::string m_mrl;
+  AVFormatContext *m_ic;
+  AVCodecContext *m_enc;
+  AVCodec *m_codec;
+  int m_idx;
+  AVFrame *m_frame;
+  boost::shared_array< char > m_data;
+};
+
+typedef boost::shared_ptr< AVInput > AVInputPtr;
+
+#endif

data/ext/error.hh

@@ -0,0 +1,50 @@
+/* HornetsEye - Computer Vision with Ruby
+   Copyright (C) 2006, 2007, 2008, 2009, 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/>. */
+#ifndef ERROR_HH
+#define ERROR_HH
+
+#include <exception>
+#include <sstream>
+
+class Error: public std::exception
+{
+public:
+  Error(void) {}
+  Error( Error &e ): std::exception( e )
+    { m_message << e.m_message.str(); }
+  virtual ~Error(void) throw() {}
+  template< typename T >
+  std::ostream &operator<<( const T &t )
+    { m_message << t; return m_message; }
+  std::ostream &operator<<( std::ostream& (*__pf)(std::ostream&) )
+    { (*__pf)( m_message ); return m_message; }
+  virtual const char* what(void) const throw() {
+    temp = m_message.str();
+    return temp.c_str();
+  }
+protected:
+  std::ostringstream m_message;
+  mutable std::string temp;
+};
+
+#define ERRORMACRO( condition, class, params, message ) \
+  if ( !( condition ) ) {                               \
+    class _e params;                                    \
+    _e << message;                                      \
+    throw _e;                                           \
+  };
+
+#endif

data/ext/frame.cc

@@ -0,0 +1,32 @@
+/* HornetsEye - Computer Vision with Ruby
+   Copyright (C) 2006, 2007, 2008, 2009, 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/>. */
+#include <iostream>
+#include "frame.hh"
+
+using namespace std;
+
+Frame::Frame( const char *typecode, int width, int height, char *data ):
+  m_frame( Qnil )
+{
+  VALUE mModule = rb_define_module( "Hornetseye" );
+  VALUE cMalloc = rb_define_class_under( mModule, "Malloc", rb_cObject );
+  VALUE cFrame = rb_define_class_under( mModule, "Frame", rb_cObject );
+  VALUE memory = Data_Wrap_Struct( cMalloc, 0, 0, (void *)data );
+  m_frame = rb_funcall( cFrame, rb_intern( "import" ), 4,
+                        rb_const_get( mModule, rb_intern( typecode ) ),
+                        INT2NUM( width ), INT2NUM( height ),
+                        memory );
+}

data/ext/frame.hh

@@ -0,0 +1,34 @@
+/* HornetsEye - Computer Vision with Ruby
+   Copyright (C) 2006, 2007, 2008, 2009, 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/>. */
+#ifndef FRAME_HH
+#define FRAME_HH
+
+#include <boost/smart_ptr.hpp>
+#include <ruby.h>
+
+class Frame
+{
+public:
+  Frame( const char *typecode, int width, int height, char *data );
+  virtual ~Frame(void) {}
+  VALUE rubyObject(void) { return m_frame; }
+protected:
+  VALUE m_frame;
+};
+
+typedef boost::shared_ptr< Frame > FramePtr;
+
+#endif

data/ext/init.cc

@@ -0,0 +1,38 @@
+/* HornetsEye - Computer Vision with Ruby
+   Copyright (C) 2006, 2007, 2008, 2009, 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/>. */
+#include "avinput.hh"
+
+#ifdef WIN32
+#define DLLEXPORT __declspec(dllexport)
+#define DLLLOCAL
+#else
+#define DLLEXPORT __attribute__ ((visibility("default")))
+#define DLLLOCAL __attribute__ ((visibility("hidden")))
+#endif
+
+extern "C" DLLEXPORT void Init_hornetseye_ffmpeg(void);
+
+extern "C" {
+
+  void Init_hornetseye_ffmpeg(void)
+  {
+    rb_require( "hornetseye_frame" );
+    VALUE rbHornetseye = rb_define_module( "Hornetseye" );
+    AVInput::registerRubyClass( rbHornetseye );
+    rb_require( "hornetseye_ffmpeg_ext.rb" );
+  }
+
+}

data/lib/hornetseye_ffmpeg_ext.rb

@@ -0,0 +1,18 @@
+# hornetseye-frame - Colourspace conversions and compression
+# 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/>.
+
+require 'hornetseye_frame'
+