ffruby 0.0.1 → 0.2.0

data/README.rdoc

@@ -0,0 +1,44 @@
+= FFruby
+
+FFruby is a Ruby interface to FFmpeg's libavformat and libavcodec. It allows you to query metadata from a wide variety of media files through some simple classes. FFmpeg's libraries are required and also the development headers if building.
+
+== FAQ
+
+=== Where do I go for support and contributions?
+
+We are hosted by RubyForge at http://rubyforge.org/projects/ffruby.
+
+=== Where do I get the latest version?
+
+It should be available through RubyGems as ffruby. Failing that, try RubyForge.
+
+=== What about transcoding?
+
+I still start FFmpeg through a subshell when I need to transcode something. There is little to be gained from doing this within Ruby itself. Other than requiring a fair amount of work, one major disadvantage is that if FFmpeg segfaults (which it has been known to do), it will bring the entire Ruby process down with it, which is probably something you want to avoid.
+
+=== So what is this good for?
+
+Being able to reliably read the source file's metadata is very important in deciding how it should be transcoded, or whether it even needs to be transcoded at all. This is not something you want to rely on a subshell for as that would involve awkward parsing of FFmpeg's output, which does change between versions.
+
+== Changes
+
+=== 0.2.0 (2010/11/24)
+
+- Reworked class structure under common FFruby module.
+- Compatibility with old and new FFmpeg versions.
+- Methods to query supported formats and codecs.
+- Safer memory handling.
+- RDoc documentation.
+- Repackaged using Jeweler.
+
+=== 0.1 (2007/07/26), 0.0.1 (2008/01/11)
+
+- More or less the same original version. Latter was the initial gem release.
+
+== Authors
+
+- James Le Cuirot <chewi@aura-online.co.uk>
+
+== Copyright
+
+Copyright (c) 2007-2010 James Le Cuirot. See LICENSE for details.

data/Rakefile

@@ -1,147 +1,48 @@
-require "rake"
-require "rake/clean"
-require "rake/gempackagetask"
-require "rake/rdoctask"
-require "rake/testtask"
-require "fileutils"
-require "yaml"
-include FileUtils
-require "lib/ffruby/version"
-
-GEM_NAME = "ffruby"
-REV = nil
-
-GEM_VERSION = FFruby::VERSION::STRING + (REV ? ".#{REV}" : "")
-CLEAN.include [
-  "ext/ffruby/*.{bundle,so,obj,pdb,lib,def,exp}", 
-  "ext/ffruby/Makefile", 
-  "**/.*.sw?", 
-  "*.gem", 
-  ".config"
-]
-RDOC_OPTS = ["--quiet", "--title", "FFruby Reference", "--main", "README", "--inline-source"]
-
-@config_file = "~/.rubyforge/user-config.yml"
-@config = nil
-def rubyforge_username
-  unless @config
-    begin
-      @config = YAML.load(File.read(File.expand_path(@config_file)))
-    rescue
-      puts <<-EOS
-ERROR: No rubyforge config file found: #{@config_file}"
-Run 'rubyforge setup' to prepare your env for access to Rubyforge
- - See http://newgem.rubyforge.org/rubyforge.html for more details
-      EOS
-      exit
-    end
+require 'rubygems'
+require 'rake'
+
+RDOC_FILES = [ "README.rdoc", "ext/ffruby/ffruby{file,stream,}.c" ]
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ffruby"
+    gem.version = File.read('VERSION')
+    gem.license = "LGPL-2.1"
+    gem.author = "James Le Cuirot"
+    gem.email = "chewi@aura-online.co.uk"
+    gem.rubyforge_project = "ffruby"
+    gem.homepage = "http://rubyforge.org/projects/ffruby/"
+    gem.summary = "A Ruby interface to FFmpeg's libavformat and libavcodec."
+    gem.description = "A Ruby interface to FFmpeg's libavformat and libavcodec. It allows you to query metadata from a wide variety of media files through some simple classes."
+    gem.requirements = "FFmpeg libraries and also development headers if building."
+    gem.files = RDOC_FILES + [ "LICENSE", "Rakefile", "VERSION", "ext/ffruby/{extconf.rb,ffruby.h}" ]
+    gem.extra_rdoc_files = RDOC_FILES 
   end
-  @rubyforge_username ||= @config["username"]
-end
-
-desc "Does a full compile, test run"
-task :default => [:compile, :test]
-
-desc "Compiles all extensions"
-task :compile => [:ffruby] do
-  if Dir.glob(File.join("lib","ffruby*.*")).length == 0
-    STDERR.puts "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
-    STDERR.puts "Gem actually failed to build.  Your system is"
-    STDERR.puts "NOT configured properly to build ffruby."
-    STDERR.puts "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
-    exit(1)
+  Jeweler::GemcutterTasks.new
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "rdoc"
+    rubyforge.remote_doc_path = ""
   end
+rescue LoadError
+  puts "To prepare a gem, please install the jeweler gem."
 end
 
-desc "Packages up FFruby."
-task :package => [:clean]
-
-desc "Releases packages for all FFruby packages and platforms."
-task :release => [:package]
-
-desc "Run all the tests"
-Rake::TestTask.new do | test_task |
-  test_task.libs << "test"
-  test_task.test_files = FileList["test/test_*.rb"]
-  test_task.verbose = true
-end
-
-Rake::RDocTask.new do | rdoc |
-  rdoc.rdoc_dir = "doc/rdoc"
-  rdoc.options += RDOC_OPTS
-  rdoc.main = "README"
-  rdoc.rdoc_files.add ["README", "lib/**/*.rb"]
-end
-
-spec =
-Gem::Specification.new do | specification |
-  specification.name = GEM_NAME
-  specification.version = GEM_VERSION
-  specification.platform = Gem::Platform::RUBY
-  specification.has_rdoc = true
-  specification.rdoc_options += RDOC_OPTS
-  specification.extra_rdoc_files = ["README"]
-  specification.summary = "a library that does something with media files!"
-  specification.description = specification.summary
-  specification.author = "ffruby: James Le Cuirot, gem: Wayne E. Seguin"
-  specification.email = "wayneeseguin at gmail dot com"
-  specification.homepage = "ffruby.rubyforge.org"
-  
-  specification.files = %w(README Rakefile) +
-  Dir.glob("{bin,doc,test,lib,extras}/**/*") + 
-  Dir.glob("ext/**/*.{h,c,rb,rl}") + 
-  %w[ext/ffruby/ffruby.c] # needed because it's generated later
-
-  specification.require_path = "lib"
-  specification.extensions = FileList["ext/**/extconf.rb"].to_a
-  specification.bindir = "bin"
-end
-
-Rake::GemPackageTask.new(spec) do | package |
-  package.need_tar = true
-  package.gem_spec = spec
-end
-
-extension = "ffruby"
-ext = "ext/ffruby"
-ext_so = "#{ext}/#{extension}.#{Config::CONFIG["DLEXT"]}"
-ext_files = FileList[
-  "#{ext}/*.c",
-  "#{ext}/*.h",
-  "#{ext}/*.rl",
-  "#{ext}/extconf.rb",
-  "#{ext}/Makefile",
-  "lib"
-] 
-
-task "lib" do
-  directory "lib"
-end
-
-desc "Builds just the #{extension} extension"
-task extension.to_sym => ["#{ext}/Makefile", ext_so ]
-
-file "#{ext}/Makefile" => ["#{ext}/extconf.rb"] do
-  #Dir.chdir(ext) do
-    if `uname.a`.match(/Darwin Kernel Version 9\.0\.0:.*i386/)
-      ENV["ARCHFLAGS"] = "-arch i386"
-    end
-    ruby "extconf.rb"
-  #end
-end
-
-file ext_so => ext_files do
-  Dir.chdir(ext) do
-    sh(PLATFORM =~ /win32/ ? "nmake" : "make")
+begin
+  require 'rake/rdoctask'
+  Rake::RDocTask.new do |rdoc|
+    rdoc.rdoc_dir = 'rdoc'
+    rdoc.title = "FFruby " + File.read('VERSION')
+    rdoc.rdoc_files.include *RDOC_FILES
   end
-  cp ext_so, "lib"
-end
-
-task :install do
-  sh %{rake package}
-  sh %{sudo gem install pkg/#{GEM_NAME}-#{GEM_VERSION}}
+rescue LoadError
+  puts "To build the documentation, please install the rdoc gem."
 end
 
-task :uninstall => [:clean] do
-  sh %{sudo gem uninstall #{GEM_NAME}}
+begin
+  require 'rake/extensiontask'
+  Rake::ExtensionTask.new('ffruby')
+  task :default => :compile
+rescue LoadError
+  puts "To build the library, please install the rake-compiler gem."
 end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/ext/ffruby/extconf.rb

@@ -1,13 +1,26 @@
-#!/bin/env ruby
+#!/usr/bin/env ruby
 
 require "mkmf"
+
 dir_config("ffmpeg")
+
+%w( avformat avcodec ).each do |lib|
+  header = "#{lib}.h"
+  result = false
+
+  [ "lib#{lib}", "ffmpeg" ].each do |dir|
+    path = File.join(dir, header)
+
+    if checking_for(path) { try_cpp(cpp_include(path)) }
+      result = path
+      break
+    end
+  end
+
+  $defs.push "-D#{lib.upcase}_H_PATH=\"<#{result || header}>\""
+end
+
 have_library("avformat")
 have_library("avcodec")
-create_makefile("ffruby")
 
-# avcodec is not built for ppc
-if `uname -a`.match(/i386/)
-`sed '1,$s/-arch ppc//' Makefile >> ./Makefile.tmp`
-`mv ./Makefile.tmp Makefile`
-end
+create_makefile("ffruby")

data/ext/ffruby/ffruby.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2007 James Le Cuirot
+ * Copyright (c) 2007-2010 James Le Cuirot
  *
  * This file is part of FFruby.
  *
@@ -18,18 +18,53 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
-#define _GNU_SOURCE
-#include <ruby.h>
-#include <ffmpeg/avformat.h>
-#include <ffmpeg/avcodec.h>
+#include "ffruby.h"
 
 extern void Init_ffrf();
 extern void Init_ffrs();
 
+/* Returns an array of the input and output formats supported by
+ * FFmpeg. This method will hopefully be expanded to return more than
+ * just names in the future. */
+static VALUE ffruby_formats(VALUE self, VALUE klass)
+{
+	AVInputFormat *ifmt;
+	AVOutputFormat *ofmt;
+	VALUE array = rb_ary_new();
+
+	for (ifmt = av_iformat_next(NULL); ifmt; ifmt = av_iformat_next(ifmt))
+		rb_ary_push(array, rb_str_new2(ifmt->name));
+
+	for (ofmt = av_oformat_next(NULL); ofmt; ofmt = av_oformat_next(ofmt))
+		rb_ary_push(array, rb_str_new2(ofmt->name));
+
+	return rb_funcall(rb_funcall(array, rb_intern("uniq"), 0), rb_intern("sort"), 0);
+}
+
+/* Returns an array of the codecs supported by FFmpeg. This method
+ * will hopefully be expanded to return more than just names in the
+ * future. */
+static VALUE ffruby_codecs(VALUE self, VALUE klass)
+{
+	AVCodec *codec;
+	VALUE array = rb_ary_new();
+
+	for (codec = av_codec_next(NULL); codec; codec = av_codec_next(codec))
+		rb_ary_push(array, rb_str_new2(codec->name));
+
+	return rb_funcall(rb_funcall(array, rb_intern("uniq"), 0), rb_intern("sort"), 0);
+}
+
+/* Top level module for the FFruby classes. Provides access to
+ * information about FFmpeg itself. */
 void Init_ffruby()
 {
 	av_register_all();
-	
+
+	mFFruby = rb_define_module("FFruby");
+	rb_define_module_function(mFFruby, "formats", ffruby_formats, 0);
+	rb_define_module_function(mFFruby, "codecs", ffruby_codecs, 0);
+
 	Init_ffrf();
 	Init_ffrs();
 }

data/ext/ffruby/ffruby.h

@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2007-2010 James Le Cuirot
+ *
+ * This file is part of FFruby.
+ *
+ * FFruby is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * FFruby 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with FFmpeg; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+#ifndef _FFRUBY_H_
+#define _FFRUBY_H_
+
+#include <ruby.h>
+#include AVFORMAT_H_PATH
+#include AVCODEC_H_PATH
+
+VALUE mFFruby;
+VALUE cFFrubyFile;
+VALUE cFFrubyStream;
+VALUE cFFrubyVideoStream;
+VALUE cFFrubyAudioStream;
+
+#endif

data/ext/ffruby/ffrubyfile.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2007 James Le Cuirot
+ * Copyright (c) 2007-2010 James Le Cuirot
  *
  * This file is part of FFruby.
  *
@@ -18,21 +18,17 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
-#define _GNU_SOURCE
-#include <ruby.h>
-#include <ffmpeg/avformat.h>
-#include <ffmpeg/avcodec.h>
+#include "ffruby.h"
+#include <string.h>
 #include <stdio.h>
 
-VALUE cFFrubyFile;
-
-extern VALUE cFFrubyVideoStream;
-extern VALUE cFFrubyAudioStream;
+/* Satisfy stupid RDoc. This hopefully gets optimised away. */
+static void rdoc() { mFFruby = rb_define_module("FFruby"); }
 
 static void ffrf_free(AVFormatContext *fmt)
 {
 	unsigned int i;
-	
+
 	if (fmt != NULL)
 	{
 		for (i = 0; i < fmt->nb_streams; i++)
@@ -40,11 +36,16 @@ static void ffrf_free(AVFormatContext *fmt)
 			if (fmt->streams[i]->codec->codec != NULL)
 				avcodec_close(fmt->streams[i]->codec);
 		}
-		
+
 		av_close_input_file(fmt);
 	}
 }
 
+static VALUE ffrf_alloc(VALUE klass)
+{
+	return Data_Wrap_Struct(klass, 0, ffrf_free, NULL);
+}
+
 static AVFormatContext* ffrf_get_fmt(VALUE self)
 {
 	AVFormatContext *fmt;
@@ -52,97 +53,104 @@ static AVFormatContext* ffrf_get_fmt(VALUE self)
 	return fmt;
 }
 
-static VALUE ffrf_alloc(VALUE klass)
-{
-	return Data_Wrap_Struct(klass, 0, ffrf_free, NULL);
-}
-
+/* Returns the title string. */
 static VALUE ffrf_title(VALUE self)
 {
 	AVFormatContext *fmt = ffrf_get_fmt(self);
 	return rb_str_new2(fmt->title);
 }
 
+/* Returns the author string. */
 static VALUE ffrf_author(VALUE self)
 {
 	AVFormatContext *fmt = ffrf_get_fmt(self);
 	return rb_str_new2(fmt->author);
 }
 
+/* Returns the copyright string. */
 static VALUE ffrf_copyright(VALUE self)
 {
 	AVFormatContext *fmt = ffrf_get_fmt(self);
 	return rb_str_new2(fmt->copyright);
 }
 
+/* Returns the comment string. */
 static VALUE ffrf_comment(VALUE self)
 {
 	AVFormatContext *fmt = ffrf_get_fmt(self);
 	return rb_str_new2(fmt->comment);
 }
 
+/* Returns the album string. */
 static VALUE ffrf_album(VALUE self)
 {
 	AVFormatContext *fmt = ffrf_get_fmt(self);
 	return rb_str_new2(fmt->album);
 }
 
+/* Returns the genre string. */
 static VALUE ffrf_genre(VALUE self)
 {
 	AVFormatContext *fmt = ffrf_get_fmt(self);
 	return rb_str_new2(fmt->genre);
 }
 
+/* Returns the year. */
 static VALUE ffrf_year(VALUE self)
 {
 	AVFormatContext *fmt = ffrf_get_fmt(self);
 	return INT2NUM(fmt->year);
 }
 
+/* Returns the track number. */
 static VALUE ffrf_track(VALUE self)
 {
 	AVFormatContext *fmt = ffrf_get_fmt(self);
 	return INT2NUM(fmt->track);
 }
 
+/* Returns the duration in seconds as a float. */
 static VALUE ffrf_duration(VALUE self)
 {
 	AVFormatContext *fmt = ffrf_get_fmt(self);
 	return rb_float_new((double) fmt->duration / (double) AV_TIME_BASE);
 }
 
+/* Returns the bit rate. */
 static VALUE ffrf_bit_rate(VALUE self)
 {
 	AVFormatContext *fmt = ffrf_get_fmt(self);
 	return INT2NUM(fmt->bit_rate);
 }
 
+/* Returns the format name. */
 static VALUE ffrf_format(VALUE self)
 {
 	AVFormatContext *fmt = ffrf_get_fmt(self);
 	return rb_str_new2(fmt->iformat->name);
 }
 
+/* Returns an array of streams contained within this file. */
 static VALUE ffrf_streams(VALUE self)
 {
 	unsigned int i;
 	AVFormatContext *fmt;
 	VALUE streams;
 	VALUE* args;
-	
+
 	if ((streams = rb_iv_get(self, "@streams")) == Qnil)
 	{
 		fmt = ffrf_get_fmt(self);
 		streams = rb_ary_new();
 		rb_iv_set(self, "@streams", streams);
-		
+
 		args = (VALUE*) ALLOCA_N(VALUE*, 2);
 		args[0] = self;
-		
+
 		for (i = 0; i < fmt->nb_streams; i++)
 		{
 			args[1] = INT2FIX(i);
-			
+
 			switch (fmt->streams[i]->codec->codec_type)
 			{
 				case CODEC_TYPE_VIDEO:
@@ -156,7 +164,7 @@ static VALUE ffrf_streams(VALUE self)
 			}
 		}
 	}
-	
+
 	return streams;
 }
 
@@ -166,60 +174,77 @@ static VALUE ffrf_av_streams(VALUE self, VALUE klass)
 	VALUE streams;
 	VALUE typed_streams;
 	unsigned int i;
-	
+
 	streams = rb_funcall(self, rb_intern("streams"), 0);
 	typed_streams = rb_ary_new();
 	Check_Type(streams, T_ARRAY);
-	
+
 	for (i = 0; i < RARRAY(streams)->len; i++)
 	{
 		if (rb_obj_is_kind_of((stream = rb_ary_entry(streams, i)), klass))
 			rb_ary_push(typed_streams, stream);
 	}
-	
+
 	return typed_streams;
 }
 
+/* Returns an array of video streams contained within this file. */
 static VALUE ffrf_video_streams(VALUE self)
 {
 	return ffrf_av_streams(self, cFFrubyVideoStream);
 }
 
+/* Returns an array of audio streams contained within this file. */
 static VALUE ffrf_audio_streams(VALUE self)
 {
 	return ffrf_av_streams(self, cFFrubyAudioStream);
 }
 
+/* call-seq:
+ *   new(filename) -> FFruby::File
+ *
+ * Creates an FFruby::File instance using the given filename. */
 static VALUE ffrf_initialize(VALUE self, VALUE filename)
 {
+	size_t len;
 	char* msg;
 	AVFormatContext *fmt;
 	VALUE exception;
+
 	VALUE filename_str = rb_funcall(filename, rb_intern("to_s"), 0);
-	
-	if (av_open_input_file(&fmt, RSTRING(filename_str)->ptr, NULL, 0, NULL) != 0)
+    char* filename_ptr = RSTRING(filename_str)->ptr;
+
+	if (av_open_input_file(&fmt, filename_ptr, NULL, 0, NULL) != 0)
 	{
-		asprintf(&msg, "Cannot open file %s!", RSTRING(filename_str)->ptr);
+		len = strlen("Cannot open file !") + strlen(filename_ptr) + 1;
+		msg = ALLOC_N(char, len);
+		snprintf(msg, len, "Cannot open file %s!", filename_ptr);
 		exception = rb_exc_new2(rb_eIOError, msg);
 		free(msg);
 		rb_exc_raise(exception);
 	}
-	
+
 	if (av_find_stream_info(fmt) < 0)
 	{
-		asprintf(&msg, "Problem reading file %s!", RSTRING(filename_str)->ptr);
+		len = strlen("Problem reading file !") + strlen(filename_ptr) + 1;
+		msg = ALLOC_N(char, len);
+		snprintf(msg, len, "Problem reading file %s!", filename_ptr);
 		exception = rb_exc_new2(rb_eIOError, msg);
 		free(msg);
 		rb_exc_raise(exception);
 	}
-	
+
 	DATA_PTR(self) = fmt;
 	return self;
 }
 
+/* Document-class: FFruby::File
+ *
+ * An interface to FFmpeg on existing files. Provides access to
+ * metadata and stream instances. */
 void Init_ffrf()
 {
-	cFFrubyFile = rb_define_class("FFrubyFile", rb_cObject);
+	cFFrubyFile = rb_define_class_under(mFFruby, "File", rb_cObject);
 	rb_define_alloc_func(cFFrubyFile, ffrf_alloc);
 	rb_define_method(cFFrubyFile, "initialize", ffrf_initialize, 1);
 	rb_define_method(cFFrubyFile, "title", ffrf_title, 0);