TagLib-1.11.1 support

TagLib 1.11 introduced a new API to access and edit pictures of Ogg files.
This patch bring support for this new API, dropping support for older versions of TagLib.

Methods flagged as deprecated in TagLib-1.11.1 have been removed.
Some APIs have been purposely ignored:
- the new "Unified property interface" API, which allow to edit some file types by 1/exporting the properties as a map, 2/ editing the map, 3/ reimporting the whole map.
- various TagLib::*::File constructors reading from a C++ IOStream
- APIs that appear to only be useful internally

Unit-tests have been updated/added for most of the new stuff.
Yard documentation have been updated.

The cxx files have been generated using Swig-3.0.7.

Author: Sigill

.travis.yml

@@ -6,13 +6,9 @@ env:
 matrix:
   include:
     - rvm: 2.2.7
-      env: TAGLIB_VERSION=1.7.2 TAGLIB_DIR=$TRAVIS_BUILD_DIR/tmp/x86_64-linux-gnu/taglib-1.7.2 LD_LIBRARY_PATH=$TRAVIS_BUILD_DIR/tmp/x86_64-linux-gnu/taglib-1.7.2/lib:$LD_LIBRARY_PATH
-    - rvm: 2.2.7
-      env: TAGLIB_VERSION=1.8 TAGLIB_DIR=$TRAVIS_BUILD_DIR/tmp/x86_64-linux-gnu/taglib-1.8 LD_LIBRARY_PATH=$TRAVIS_BUILD_DIR/tmp/x86_64-linux-gnu/taglib-1.8/lib:$LD_LIBRARY_PATH
+      env: TAGLIB_VERSION=1.11.1 TAGLIB_DIR=$TRAVIS_BUILD_DIR/tmp/x86_64-linux-gnu/taglib-1.11.1 LD_LIBRARY_PATH=$TRAVIS_BUILD_DIR/tmp/x86_64-linux-gnu/taglib-1.11.1/lib:$LD_LIBRARY_PATH
     - rvm: 2.3.4
-      env: TAGLIB_VERSION=1.9.1 TAGLIB_DIR=$TRAVIS_BUILD_DIR/tmp/x86_64-linux-gnu/taglib-1.9.1 LD_LIBRARY_PATH=$TRAVIS_BUILD_DIR/tmp/x86_64-linux-gnu/taglib-1.9.1/lib:$LD_LIBRARY_PATH
-    - rvm: 2.4.1
-      env: TAGLIB_VERSION=1.10 TAGLIB_DIR=$TRAVIS_BUILD_DIR/tmp/x86_64-linux-gnu/taglib-1.10 LD_LIBRARY_PATH=$TRAVIS_BUILD_DIR/tmp/x86_64-linux-gnu/taglib-1.10/lib:$LD_LIBRARY_PATH
+      env: TAGLIB_VERSION=1.11.1 TAGLIB_DIR=$TRAVIS_BUILD_DIR/tmp/x86_64-linux-gnu/taglib-1.11.1 LD_LIBRARY_PATH=$TRAVIS_BUILD_DIR/tmp/x86_64-linux-gnu/taglib-1.11.1/lib:$LD_LIBRARY_PATH
     - rvm: 2.4.1
       env: TAGLIB_VERSION=1.11.1 TAGLIB_DIR=$TRAVIS_BUILD_DIR/tmp/x86_64-linux-gnu/taglib-1.11.1 LD_LIBRARY_PATH=$TRAVIS_BUILD_DIR/tmp/x86_64-linux-gnu/taglib-1.11.1/lib:$LD_LIBRARY_PATH
 before_script: bundle exec rake vendor

README.md

@@ -26,7 +26,7 @@ Contributions for more coverage of the library are very welcome.
 Installation
 ------------
 
-Before you install the gem, make sure to have [taglib][taglib] installed
+Before you install the gem, make sure to have [taglib 1.11.1 or higher][taglib] installed
 with header files (and a C++ compiler of course):
 
 * Debian/Ubuntu: `sudo apt-get install libtag1-dev`
@@ -69,8 +69,7 @@ if you don't have it):
 
     bundle install
 
-Regenerate SWIG wrappers if you made changes in `.i` files (use at least
-version 2.0.5 of SWIG):
+Regenerate SWIG wrappers if you made changes in `.i` files (use version 3.0.7 of SWIG):
 
     rake swig
 
@@ -97,17 +96,17 @@ Build and install gem into system gems:
 
 Build a specific version of Taglib:
 
-    PLATFORM=x86_64-linux TAGLIB_VERSION=1.9.1 rake vendor
+    PLATFORM=x86_64-linux TAGLIB_VERSION=1.11.1 rake vendor
 
-The above command will automatically download Taglig 1.9.1, build it and install it in `tmp/x86_64-linux/taglib-1.9.1`.
+The above command will automatically download Taglib 1.11.1, build it and install it in `tmp/x86_64-linux/taglib-1.11.1`.
 
-The `swig` and `compile` tasks can then be executed against that specific version of Taglib by setting the `TAGLIB_DIR` environment variable to `$PWD/tmp/x86_64-linux/taglib-1.9.1` (it is assumed that taglib headers are located at `$TAGLIB_DIR/include` and taglib libraries at `$TAGLIB_DIR/lib`).
+The `swig` and `compile` tasks can then be executed against that specific version of Taglib by setting the `TAGLIB_DIR` environment variable to `$PWD/tmp/x86_64-linux/taglib-1.11.1` (it is assumed that taglib headers are located at `$TAGLIB_DIR/include` and taglib libraries at `$TAGLIB_DIR/lib`).
 
-The `test` task can then be run for that version of Taglib by adding `$PWD/tmp/x86_64-linux/taglib-1.9.1/lib` to the `LD_LIBRARY_PATH` environment variable.
+The `test` task can then be run for that version of Taglib by adding `$PWD/tmp/x86_64-linux/taglib-1.11.1/lib` to the `LD_LIBRARY_PATH` environment variable.
 
 To do everything in one command:
 
-    PLATFORM=x86_64-linux TAGLIB_VERSION=1.7.2 TAGLIB_DIR=$PWD/tmp/x86_64-linux/taglib-1.7.2 LD_LIBRARY_PATH=$PWD/tmp/x86_64-linux/taglib-1.7.2/lib rake vendor compile test
+    PLATFORM=x86_64-linux TAGLIB_VERSION=1.11.1 TAGLIB_DIR=$PWD/tmp/x86_64-linux/taglib-1.11.1 LD_LIBRARY_PATH=$PWD/tmp/x86_64-linux/taglib-1.11.1/lib rake vendor compile test
 
 ### Workflow
 

docs/taglib/aiff.rb

@@ -53,11 +53,43 @@ def tag
     def audio_properties
     end
 
+    # @return [Boolean] Whether or not the file on disk actually has an ID3v2 tag.
+    #
+    # @since 1.0.0
+    def id3v2_tag?
+    end
+
   end
 
   class Properties < TagLib::AudioProperties
-    # @return [Integer] Sample width
-    attr_reader :sample_width
+    # @return [Integer] Number of bits per audio sample.
+    #
+    # @since 1.0.0
+    attr_reader :bits_per_sample
+
+    # @return [Integer] Number of sample frames.
+    #
+    # @since 1.0.0
+    attr_reader :sample_frames
+
+    # @return [String] The compression type of the AIFF-C file.
+    # For example, "NONE" for not compressed, "ACE2" for ACE 2-to-1.
+    # If the file is in AIFF format, always returns an empty string.
+    #
+    # @since 1.0.0
+    attr_reader :compression_type
+
+    # @return [String] Returns the concrete compression name of the AIFF-C file.
+    # If the file is in AIFF format, always returns an empty string.
+    #
+    # @since 1.0.0
+    attr_reader :compression_name
+
+    # @return [Boolean] True if the file is in AIFF-C format, false if AIFF format.
+    #
+    # @since 1.0.0
+    def aiff_c?
+    end
   end
 
 end

docs/taglib/base.rb

@@ -247,7 +247,14 @@ class AudioProperties
     Accurate = 2
 
     # @return [Integer] length of the file in seconds
-    attr_reader :length
+    #
+    # @since 1.0.0
+    attr_reader :length_in_seconds
+
+    # @return [Integer] length of the file in milliseconds
+    #
+    # @since 1.0.0
+    attr_reader :length_in_milliseconds
 
     # @return [Integer] bit rate in kb/s (kilobit per second)
     attr_reader :bitrate

docs/taglib/flac.rb

@@ -30,6 +30,13 @@ module TagLib::FLAC
   #     file.save
   #   end
   class File < TagLib::File
+
+    NoTags      = 0x0000
+    XiphComment = 0x0001
+    ID3v1       = 0x0002
+    ID3v2       = 0x0004
+    AllTags     = 0xffff
+
     # {include:::TagLib::FileRef.open}
     #
     # @param (see #initialize)
@@ -82,6 +89,14 @@ def audio_properties
     def picture_list
     end
 
+    # Remove the specified picture.
+    #
+    # @param [TagLib::FLAC::Picture] picture
+    #
+    # @since 1.0.0
+    def remove_picture(picture)
+    end
+
     # Remove all pictures.
     #
     # @return [void]
@@ -94,12 +109,46 @@ def remove_pictures
     # @return [void]
     def add_picture(picture)
     end
+
+    # Remove the tags matching the specified OR-ed types.
+    #
+    # @param [int] tags The types of tags to remove.
+    # @return [void]
+    #
+    # @since 1.0.0
+    def strip(tags=TagLib::FLAC::File::AllTags)
+    end
+
+    # @return [Boolean] Whether or not the file on disk actually has a XiphComment.
+    #
+    # @since 1.0.0
+    def xiph_comment?
+    end
+
+    # @return [Boolean] Whether or not the file on disk actually has an ID3v1 tag.
+    #
+    # @since 1.0.0
+    def id3v1_tag?
+    end
+
+    # @return [Boolean] Whether or not the file on disk actually has an ID3v2 tag.
+    #
+    # @since 1.0.0
+    def id3v2_tag?
+    end
   end
 
   # FLAC audio properties.
   class Properties < TagLib::AudioProperties
-    # @return [Integer] Sample width
-    attr_reader :sample_width
+    # @return [Integer] Number of bits per audio sample.
+    #
+    # @since 1.0.0
+    attr_reader :bits_per_sample
+
+    # @return [Integer] Number of sample frames.
+    #
+    # @since 1.0.0
+    attr_reader :sample_frames
 
     # @return [binary String] MD5 signature of uncompressed audio stream
     #   (binary data)
@@ -172,5 +221,12 @@ def initialize()
     #
     # @return [binary String]
     attr_accessor :data
+
+    # Parse the picture data in the FLAC picture block format.
+    # @return [Boolean] True if the data have been successfully been parsed, false otherwise.
+    #
+    # @since 1.0.0
+    def parse(rawdata)
+    end
   end
 end

docs/taglib/id3v1.rb

@@ -1,5 +1,34 @@
 module TagLib::ID3v1
   # An ID3v1 tag.
   class Tag < TagLib::Tag
+    # @return [Integer] the genre as a number
+    # @return [255] if not present
+    #
+    # @since 1.0.0
+    attr_accessor :genre_number
+  end
+
+  # @return [Array<String>] the ID3v1 genre list.
+  #
+  # @since 1.0.0
+  def genre_list
+  end
+
+  # @return [Map<String, int>] the map associating a genre to its index.
+  #
+  # @since 1.0.0
+  def genre_map
+  end
+
+  # @return [String] the name of genre at `index` in the ID3v1 genre list.
+  #
+  # @since 1.0.0
+  def genre(index)
+  end
+
+  # @return [String] the genre index for the (case sensitive) genre `name`.
+  #
+  # @since 1.0.0
+  def genre_index(name)
   end
 end