Merge pull request #93 from jameswyper/issue-91-fix-memory-leak-flac-picture

Fix for issue #91

Author: robinst

README.md

@@ -73,7 +73,7 @@ if you don't have it):
 
     bundle install
 
-Regenerate SWIG wrappers if you made changes in `.i` files (use version 3.0.7 of SWIG):
+Regenerate SWIG wrappers if you made changes in `.i` files (use version 3.0.7 of SWIG - 3.0.8 through 3.0.12 will not work):
 
     rake swig
 

ext/taglib_flac/taglib_flac.i

@@ -86,6 +86,13 @@
       SWIG_RubyRemoveTracking(properties);
     }
 
+    TagLib::List<TagLib::FLAC::Picture *> list = file->pictureList();
+      for (TagLib::List<TagLib::FLAC::Picture *>::ConstIterator it = list.begin(); it != list.end(); it++) {
+        TagLib::FLAC::Picture *picture = (*it);
+        SWIG_RubyUnlinkObjects(picture);
+        SWIG_RubyRemoveTracking(picture);
+      }
+
     SWIG_RubyUnlinkObjects(ptr);
     SWIG_RubyRemoveTracking(ptr);
 

ext/taglib_flac/taglib_flac_wrap.cxx

@@ -2210,6 +2210,13 @@ SWIGINTERN void TagLib_FLAC_File_close(TagLib::FLAC::File *self){
       SWIG_RubyRemoveTracking(properties);
     }
 
+    TagLib::List<TagLib::FLAC::Picture *> list = file->pictureList();
+      for (TagLib::List<TagLib::FLAC::Picture *>::ConstIterator it = list.begin(); it != list.end(); it++) {
+        TagLib::FLAC::Picture *picture = (*it);
+        SWIG_RubyUnlinkObjects(picture);
+        SWIG_RubyRemoveTracking(picture);
+      }
+
     SWIG_RubyUnlinkObjects(ptr);
     SWIG_RubyRemoveTracking(ptr);
 

test/data/flac_nopic.flac

@@ -0,0 +1,43 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class TestFlacPictureMemory < Test::Unit::TestCase
+
+  N = 10000
+
+  context "TagLib::FLAC::Picture" do
+ 
+    setup do
+      
+    end
+
+    should "release memory when closing flac file with picture data" do
+      c = 0
+      N.times do
+        TagLib::FLAC::File.open("test/data/flac.flac", false) do |f|
+          f.picture_list.each do |p|
+            x = p.data
+            c = c + 1
+          end
+        end
+      end
+      assert_equal N,c
+    end
+
+    should "process a flac file without picture data" do
+      c = 0
+      N.times do
+        TagLib::FLAC::File.open("test/data/flac_nopic.flac", false) do |f|
+          f.picture_list.each do |p|
+            x = p.data
+            c = c + 1
+          end
+        end
+      end
+      assert_equal 0,c
+    end
+
+    teardown do
+
+    end
+  end
+end