taglib-ruby 0.4.0 → 0.5.0

data/ext/taglib_id3v1/taglib_id3v1_wrap.cxx

@@ -1552,7 +1552,7 @@ SWIG_Ruby_NewPointerObj(void *ptr, swig_type_info *type, int flags)
         downcast methods. */
       if (obj != Qnil) {
         VALUE value = rb_iv_get(obj, "@__swigtype__");
-        char* type_name = RSTRING_PTR(value);
+        const char* type_name = RSTRING_PTR(value);
 				
         if (strcmp(type->name, type_name) == 0) {
           return obj;

data/ext/taglib_id3v2/taglib_id3v2.i

@@ -78,14 +78,7 @@ VALUE taglib_id3v2_framelist_to_ruby_array(TagLib::ID3v2::FrameList *list) {
 }
 %apply TagLib::ID3v2::FrameList & { const TagLib::ID3v2::FrameList & };
 
-%typemap(in, noblock=1) TagLib::ID3v2::Frame * (int res = 0) {
-  res = SWIG_ConvertPtr($input, %as_voidptrptr(&$1), $descriptor, SWIG_POINTER_DISOWN | %convertptr_flags);
-  if (!SWIG_IsOK(res)) {
-    %argument_fail(res, "$type", $symname, $argnum);
-  }
-  SWIG_RubyUnlinkObjects($1);
-  SWIG_RubyRemoveTracking($1);
-}
+%apply SWIGTYPE *DISOWN { TagLib::ID3v2::Frame *frame };
 %ignore TagLib::ID3v2::Tag::removeFrame(Frame *, bool);
 %include <taglib/id3v2tag.h>
 %clear TagLib::ID3v2::Frame *;

data/ext/taglib_id3v2/taglib_id3v2_wrap.cxx

@@ -1552,7 +1552,7 @@ SWIG_Ruby_NewPointerObj(void *ptr, swig_type_info *type, int flags)
         downcast methods. */
       if (obj != Qnil) {
         VALUE value = rb_iv_get(obj, "@__swigtype__");
-        char* type_name = RSTRING_PTR(value);
+        const char* type_name = RSTRING_PTR(value);
 				
         if (strcmp(type->name, type_name) == 0) {
           return obj;

data/ext/taglib_mpeg/taglib_mpeg_wrap.cxx

@@ -1555,7 +1555,7 @@ SWIG_Ruby_NewPointerObj(void *ptr, swig_type_info *type, int flags)
         downcast methods. */
       if (obj != Qnil) {
         VALUE value = rb_iv_get(obj, "@__swigtype__");
-        char* type_name = RSTRING_PTR(value);
+        const char* type_name = RSTRING_PTR(value);
 				
         if (strcmp(type->name, type_name) == 0) {
           return obj;

data/ext/taglib_ogg/taglib_ogg_wrap.cxx

@@ -1552,7 +1552,7 @@ SWIG_Ruby_NewPointerObj(void *ptr, swig_type_info *type, int flags)
         downcast methods. */
       if (obj != Qnil) {
         VALUE value = rb_iv_get(obj, "@__swigtype__");
-        char* type_name = RSTRING_PTR(value);
+        const char* type_name = RSTRING_PTR(value);
 				
         if (strcmp(type->name, type_name) == 0) {
           return obj;

data/ext/taglib_vorbis/taglib_vorbis_wrap.cxx

@@ -1555,7 +1555,7 @@ SWIG_Ruby_NewPointerObj(void *ptr, swig_type_info *type, int flags)
         downcast methods. */
       if (obj != Qnil) {
         VALUE value = rb_iv_get(obj, "@__swigtype__");
-        char* type_name = RSTRING_PTR(value);
+        const char* type_name = RSTRING_PTR(value);
 				
         if (strcmp(type->name, type_name) == 0) {
           return obj;

data/lib/taglib.rb

@@ -12,3 +12,4 @@ require 'taglib/id3v1'
 require 'taglib/id3v2'
 require 'taglib/ogg'
 require 'taglib/vorbis'
+require 'taglib/flac'

data/lib/taglib/flac.rb

@@ -0,0 +1,7 @@
+require 'taglib_flac'
+
+module TagLib::FLAC
+  class File
+    extend ::TagLib::FileOpenable
+  end
+end

data/lib/taglib/version.rb

@@ -1,7 +1,7 @@
 module TagLib
   module Version
     MAJOR = 0
-    MINOR = 4
+    MINOR = 5
     PATCH = 0
     BUILD = nil
 

data/taglib-ruby.gemspec

@@ -13,7 +13,8 @@ Gem::Specification.new do |s|
   s.licenses    = ["MIT"]
   s.summary     = "Ruby interface for the taglib C++ library"
   s.description = <<DESC
-Ruby interface for the taglib C++ library.
+Ruby interface for the taglib C++ library, for reading and writing
+meta-data (tags) of many audio formats.
 
 In contrast to other libraries, this one wraps the C++ API using SWIG,
 not only the minimal C API. This means that all tags can be accessed.
@@ -34,6 +35,7 @@ DESC
     "ext/taglib_id3v2/extconf.rb",
     "ext/taglib_ogg/extconf.rb",
     "ext/taglib_vorbis/extconf.rb",
+    "ext/taglib_flac/extconf.rb",
   ]
   s.extra_rdoc_files = [
     "CHANGES.md",
@@ -50,6 +52,7 @@ DESC
     "Rakefile",
     "docs/default/fulldoc/html/css/common.css",
     "docs/taglib/base.rb",
+    "docs/taglib/flac.rb",
     "docs/taglib/id3v1.rb",
     "docs/taglib/id3v2.rb",
     "docs/taglib/mpeg.rb",
@@ -60,6 +63,8 @@ DESC
     "ext/taglib_base/includes.i",
     "ext/taglib_base/taglib_base.i",
     "ext/taglib_base/taglib_base_wrap.cxx",
+    "ext/taglib_flac/taglib_flac.i",
+    "ext/taglib_flac/taglib_flac_wrap.cxx",
     "ext/taglib_id3v1/extconf.rb",
     "ext/taglib_id3v1/taglib_id3v1.i",
     "ext/taglib_id3v1/taglib_id3v1_wrap.cxx",
@@ -80,6 +85,7 @@ DESC
     "ext/win.cmake",
     "lib/taglib.rb",
     "lib/taglib/base.rb",
+    "lib/taglib/flac.rb",
     "lib/taglib/id3v1.rb",
     "lib/taglib/id3v2.rb",
     "lib/taglib/mpeg.rb",
@@ -94,7 +100,10 @@ DESC
     "test/data/Makefile",
     "test/data/add-relative-volume.cpp",
     "test/data/crash.mp3",
+    "test/data/flac-create.cpp",
+    "test/data/flac.flac",
     "test/data/globe_east_540.jpg",
+    "test/data/globe_east_90.jpg",
     "test/data/id3v1-create.cpp",
     "test/data/id3v1.mp3",
     "test/data/relative-volume.mp3",
@@ -106,6 +115,8 @@ DESC
     "test/fileref_open_test.rb",
     "test/fileref_properties_test.rb",
     "test/fileref_write_test.rb",
+    "test/flac_file_test.rb",
+    "test/flac_file_write_test.rb",
     "test/id3v1_tag_test.rb",
     "test/id3v2_frames_test.rb",
     "test/id3v2_memory_test.rb",

data/tasks/docs_coverage.rake

@@ -4,19 +4,34 @@ task :docs_coverage do |t|
     objects.sort_by { |obj| obj.path }
   end
 
+  def synthetic_methods(cls)
+    methods = cls.inherited_meths
+    methods.map do |m|
+      YARD::CodeObjects::MethodObject.new(cls, m.name)
+    end
+  end
+
   YARD.parse("ext/**/*_wrap.cxx")
   ext_codeobjects = sort(YARD::Registry.all)
+
   YARD::Registry.clear
   YARD.parse("docs/**/*.rb")
-  docs_codeobjects = sort(YARD::Registry.all(:module, :class, :method))
+  docs_classes = YARD::Registry.all(:class)
+  docs_others = YARD::Registry.all(:module, :method)
+  docs_codeobjects = sort(docs_classes + docs_others)
+
+  # SWIG generates methods for base classes in the subclasses too, we
+  # don't want them appearing in the "only in ext" list.
+  inherited_methods = docs_classes.map { |c| synthetic_methods(c) }.flatten
 
-  only_in_ext = (ext_codeobjects - docs_codeobjects)
+  only_in_ext = (ext_codeobjects - docs_codeobjects - inherited_methods)
   only_in_docs = (docs_codeobjects - ext_codeobjects)
 
   unless only_in_ext.empty?
     puts
     puts "=== Only in ext (to document): "
     puts only_in_ext
+    p only_in_ext[4].explicit
   end
   unless only_in_docs.empty?
     puts

data/tasks/ext.rake

@@ -42,6 +42,9 @@ end
 Rake::ExtensionTask.new("taglib_vorbis", $gemspec) do |ext|
   configure_cross_compile(ext)
 end
+Rake::ExtensionTask.new("taglib_flac", $gemspec) do |ext|
+  configure_cross_compile(ext)
+end
 
 task :cross => [:taglib] do
   # Mkmf just uses "g++" as C++ compiler, despite what's in rbconfig.rb.

data/tasks/swig.rake

@@ -14,7 +14,9 @@ task :swig =>
    'ext/taglib_id3v1/taglib_id3v1_wrap.cxx',
    'ext/taglib_id3v2/taglib_id3v2_wrap.cxx',
    'ext/taglib_ogg/taglib_ogg_wrap.cxx',
-   'ext/taglib_vorbis/taglib_vorbis_wrap.cxx']
+   'ext/taglib_vorbis/taglib_vorbis_wrap.cxx',
+   'ext/taglib_flac/taglib_flac_wrap.cxx',
+  ]
 
 base_dependencies = ['ext/taglib_base/taglib_base.i', 'ext/taglib_base/includes.i']
 
@@ -41,3 +43,7 @@ end
 file 'ext/taglib_vorbis/taglib_vorbis_wrap.cxx' => ['ext/taglib_vorbis/taglib_vorbis.i'] + base_dependencies do
   run_swig('taglib_vorbis')
 end
+
+file 'ext/taglib_flac/taglib_flac_wrap.cxx' => ['ext/taglib_flac/taglib_flac.i'] + base_dependencies do
+  run_swig('taglib_flac')
+end

data/test/data/Makefile

@@ -1,6 +1,6 @@
 .PHONY: all clean
 
-all:: add-relative-volume id3v1-create vorbis-create
+all:: add-relative-volume id3v1-create vorbis-create flac-create
 
 add-relative-volume: add-relative-volume.cpp
 	g++ -o $@ $< -ltag -I/usr/include/taglib
@@ -11,5 +11,8 @@ id3v1-create: id3v1-create.cpp
 vorbis-create: vorbis-create.cpp
 	g++ -o $@ $< -ltag -I/usr/include/taglib
 
+flac-create: flac-create.cpp
+	g++ -o $@ $< -ltag -I/usr/include/taglib
+
 clean::
-	-rm add-relative-volume id3v1-create
+	-rm add-relative-volume id3v1-create vorbis-create flac-create

data/test/data/flac-create.cpp

@@ -0,0 +1,80 @@
+#include <iostream>
+#include <fstream>
+#include <stdlib.h>
+
+#include <taglib/taglib.h>
+#include <taglib/flacfile.h>
+#include <taglib/xiphcomment.h>
+
+using namespace TagLib;
+
+ByteVector getPictureData(const char *filename);
+
+int main(int argc, char **argv) {
+  if (argc != 2) {
+    std::cout << "usage: " << argv[0] << " file" << std::endl;
+    exit(1);
+  }
+  char *filename = argv[1];
+
+  FLAC::File file(filename);
+  Ogg::XiphComment *tag = file.xiphComment(true);
+
+  tag->setTitle("Title");
+  tag->setArtist("Artist");
+  tag->setAlbum("Album");
+  tag->setComment("Comment");
+  tag->setGenre("Pop");
+  tag->setYear(2011);
+  tag->setTrack(7);
+
+  tag->addField("VERSION", "original");
+  tag->addField("PERFORMER", "Performer");
+  tag->addField("COPYRIGHT", "2011 Me, myself and I");
+  tag->addField("LICENSE", "Any Use Permitted");
+  tag->addField("ORGANIZATION", "Organization");
+  tag->addField("DESCRIPTION", "Test file");
+  tag->addField("LOCATION", "Earth");
+  tag->addField("CONTACT", "Contact");
+
+  tag->addField("MULTIPLE", "A");
+  tag->addField("MULTIPLE", "B", false);
+
+  FLAC::Picture *picture = new FLAC::Picture();
+
+  picture->setType(FLAC::Picture::FrontCover);
+  picture->setMimeType("image/jpeg");
+  picture->setDescription("Globe");
+  picture->setWidth(90);
+  picture->setHeight(90);
+  picture->setColorDepth(8);
+  picture->setNumColors(0);
+
+  ByteVector data = getPictureData("globe_east_90.jpg");
+  picture->setData(data);
+
+  file.addPicture(picture);
+
+  file.save();
+}
+
+ByteVector getPictureData(const char *filename) {
+  std::ifstream is;
+  is.open(filename, std::ios::binary);
+
+  is.seekg(0, std::ios::end);
+  int length = is.tellg();
+  is.seekg(0, std::ios::beg);
+
+  char *buffer = new char[length];
+
+  is.read(buffer, length);
+  is.close();
+
+  ByteVector result(buffer, length);
+  delete[] buffer;
+
+  return result;
+}
+
+// vim: set filetype=cpp sw=2 ts=2 expandtab:

data/test/flac_file_test.rb

@@ -0,0 +1,101 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class FlacFileTest < Test::Unit::TestCase
+  context "TagLib::FLAC::File" do
+    setup do
+      @file = TagLib::FLAC::File.new("test/data/flac.flac")
+    end
+
+    should "have a tag" do
+      tag = @file.tag
+      assert_not_nil tag
+      assert_equal TagLib::Tag, tag.class
+    end
+
+    should "have XiphComment" do
+      tag = @file.xiph_comment
+      assert_not_nil tag
+      assert_equal TagLib::Ogg::XiphComment, tag.class
+    end
+
+    should "have method for ID3v1 tag" do
+      assert_nil @file.id3v1_tag
+    end
+
+    should "have method for ID3v2 tag" do
+      assert_nil @file.id3v2_tag
+    end
+
+    context "audio properties" do
+      setup do
+        @properties = @file.audio_properties
+      end
+
+      should "exist" do
+        assert_not_nil @properties
+      end
+
+      should "contain basic information" do
+        assert_equal 1, @properties.length
+        assert_equal 212, @properties.bitrate
+        assert_equal 44100, @properties.sample_rate
+        assert_equal 1, @properties.channels
+      end
+
+      should "contain flac-specific information" do
+        assert_equal 16, @properties.sample_width
+        assert_equal "x\xD1\x9B\x86\xDF,\xD4\x88\xB3YW\xE6\xBD\x88Ih", @properties.signature
+      end
+    end
+
+    context "picture_list" do
+      setup do
+        @pictures = @file.picture_list
+      end
+
+      should "have a picture" do
+        assert_equal 1, @pictures.size
+      end
+
+      context "first element" do
+        setup do
+          @picture = @pictures.first
+        end
+
+        should "be a TagLib::FLAC::Picture," do
+          assert_equal TagLib::FLAC::Picture, @picture.class
+        end
+
+        should "have meta-data" do
+          assert_equal TagLib::FLAC::Picture::FrontCover, @picture.type
+          assert_equal "image/jpeg", @picture.mime_type
+          assert_equal "Globe", @picture.description
+          assert_equal 90, @picture.width
+          assert_equal 90, @picture.height
+          assert_equal 8, @picture.color_depth
+          assert_equal 0, @picture.num_colors
+        end
+
+        should "have data" do
+          picture_data = File.open("test/data/globe_east_90.jpg", 'rb'){ |f| f.read }
+          assert_equal picture_data, @picture.data
+        end
+      end
+    end
+
+    teardown do
+      @file.close
+      @file = nil
+    end
+  end
+
+  context "TagLib::FLAC::File.open" do
+    should "should work" do
+      title = nil
+      TagLib::FLAC::File.open("test/data/flac.flac", false) do |file|
+        title = file.tag.title
+      end
+      assert_equal "Title", title
+    end
+  end
+end

data/test/flac_file_write_test.rb

@@ -0,0 +1,81 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class FlacFileWriteTest < Test::Unit::TestCase
+
+  SAMPLE_FILE = "test/data/flac.flac"
+  OUTPUT_FILE = "test/data/output.flac"
+  PICTURE_FILE = "test/data/globe_east_90.jpg"
+
+  def reloaded
+    TagLib::FLAC::File.open(OUTPUT_FILE, false) do |file|
+      yield file
+    end
+  end
+
+  context "TagLib::FLAC::File" do
+    setup do
+      FileUtils.cp SAMPLE_FILE, OUTPUT_FILE
+      @file = TagLib::FLAC::File.new(OUTPUT_FILE, false)
+    end
+
+    should "be able to save the title" do
+      tag = @file.tag
+      assert_not_nil tag
+      tag.title = "New Title"
+      success = @file.save
+      assert success
+      @file.close
+      @file = nil
+
+      written_title = reloaded do |file|
+        file.tag.title
+      end
+      assert_equal "New Title", written_title
+    end
+
+    should "be able to remove pictures" do
+      assert_equal 1, @file.picture_list.size
+      @file.remove_pictures
+      assert_equal 0, @file.picture_list.size
+      success = @file.save
+      assert success
+    end
+
+    should "be able to add and save a new picture" do
+      picture_data = File.open(PICTURE_FILE, 'rb') { |f| f.read }
+
+      pic = TagLib::FLAC::Picture.new
+      pic.type = TagLib::FLAC::Picture::FrontCover
+      pic.mime_type = "image/jpeg"
+      pic.description = "desc"
+      pic.width = 90
+      pic.height = 90
+      pic.data = picture_data
+
+      assert_equal 1, @file.picture_list.size
+      @file.add_picture(pic)
+      assert_equal 2, @file.picture_list.size
+
+      success = @file.save
+      assert success
+
+      reloaded do |file|
+        written_pic = file.picture_list.last
+        assert_equal TagLib::FLAC::Picture::FrontCover, written_pic.type
+        assert_equal "image/jpeg", written_pic.mime_type
+        assert_equal "desc", written_pic.description
+        assert_equal 90, written_pic.width
+        assert_equal 90, written_pic.height
+        assert_equal picture_data, written_pic.data
+      end
+    end
+
+    teardown do
+      if @file
+        @file.close
+        @file = nil
+      end
+      FileUtils.rm OUTPUT_FILE
+    end
+  end
+end