taglib-ruby 0.7.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ce29a8851b17cdd725f415e66caa729bc6bc318f
-  data.tar.gz: 6e74b0b44a29c8fdc70d34d507ab1e831a2275e3
+SHA256:
+  metadata.gz: 2e071c43695cf3898de6224fefa308e83dcb4e8b1e8f09c7e348a53a5a4a34bc
+  data.tar.gz: 9247a84147c330e268897940a08cebbe124e92e81741ab64a2eaea07962a9f36
 SHA512:
-  metadata.gz: 30a434b42ed99ce408216039a9f9c8aad3aa295d95e7bd76d3bfdbcecac0d08f5b39ebb386c0b825e6ba4b20df067f3f0ea2aa7d6b8d30ee97aff50f56d55f8e
-  data.tar.gz: 3f6a1b4e58673c87f02ca79703ed7664682d43df1e874ef12131ac10507588006fa1499d9fca76725430f471dbc248c5a6b934fe480082536d7c17c8224babf2
+  metadata.gz: '0986da0ee118c9062c6f167d6e0b2d20c03dc029f34ec50ad7ecdc85668fc9814a9a71656059a72abf5f2dab65895f02f425ce4dd3cd5b4729dd72b09f4e2006'
+  data.tar.gz: 6343921b422e32260edf5f3c5e79b487369a4ee7da5a3a53fcfc9812d1534d9d0351a34e2b4e8233a5483718671ecf4b05d1d7c1df8f66602adc0a9f044ef3aa

data/CHANGES.md

@@ -1,6 +1,13 @@
 Changes in Releases of taglib-ruby
 ==================================
 
+## 1.0.0 (2020-01-07)
+
+* Support for TagLib >= 1.11.1 (drop support for earlier versions) (#83)
+  * This includes a lot of new APIs and some changed APIs, see
+    `@since 1.0.0` in the docs
+* Stop using tainted strings to fix warnings with Ruby 2.7 (#86)
+
 ## 0.7.1 (2015-12-28)
 
 * Fix compile error during gem installation on Ruby 2.3 (MRI) (#67)

data/README.md

@@ -21,16 +21,14 @@ Contributions for more coverage of the library are very welcome.
 [![Gem version][gem-img]][gem-link]
 [![Build status][travis-img]][travis-link]
 
-[![flattr this project][flattr-img]][flattr-link]
-
 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`
-* Fedora/RHEL: `sudo yum install taglib-devel`
+* Fedora/RHEL: `sudo dnf install taglib-devel`
 * Brew: `brew install taglib`
 * MacPorts: `sudo port install taglib`
 
@@ -42,7 +40,7 @@ Then do:
 
 Not all versions of TagLib get along with `clang++`, the default C++ compiler
 on OS X. To compile taglib-ruby's C++ extensions with a different compiler
-during installation, set the `TAGLIB_RUBY_CXX` environement variable.
+during installation, set the `TAGLIB_RUBY_CXX` environment variable.
 
     TAGLIB_RUBY_CXX=g++-4.2 gem install taglib-ruby
 
@@ -62,6 +60,12 @@ See {file:CHANGES.md}.
 Contributing
 ------------
 
+### Dependencies
+
+Fedora:
+
+    sudo dnf install taglib-devel ruby-devel gcc-c++ redhat-rpm-config swig
+
 ### Building
 
 Install dependencies (uses bundler, install it via `gem install bundler`
@@ -69,8 +73,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
 
@@ -95,6 +98,20 @@ Build and install gem into system gems:
 
     rake install
 
+Build a specific version of Taglib:
+
+    PLATFORM=x86_64-linux TAGLIB_VERSION=1.11.1 rake vendor
+
+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.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.11.1/lib` to the `LD_LIBRARY_PATH` environment variable.
+
+To do everything in one command:
+
+    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
 
 * Check out the latest master to make sure the feature hasn't been
@@ -114,7 +131,7 @@ Build and install gem into system gems:
 License
 -------
 
-Copyright (c) 2010-2014 Robin Stocker and others, see Git history.
+Copyright (c) 2010-2020 Robin Stocker and others, see Git history.
 
 taglib-ruby is distributed under the MIT License,
 see LICENSE.txt for details.
@@ -128,5 +145,3 @@ version 2.1 (LGPL) and Mozilla Public License (MPL).
 [gem-link]: https://rubygems.org/gems/taglib-ruby
 [travis-img]: https://api.travis-ci.org/robinst/taglib-ruby.png
 [travis-link]: https://travis-ci.org/robinst/taglib-ruby
-[flattr-img]: https://api.flattr.com/button/flattr-badge-large.png
-[flattr-link]: https://flattr.com/submit/auto?user_id=robinst&url=https://github.com/robinst/taglib-ruby&title=taglib-ruby&tags=github&category=software

data/Rakefile

@@ -25,4 +25,14 @@ end
 
 $gemspec = Bundler::GemHelper.gemspec
 
-FileList['tasks/**/*.rake'].each { |task| import task }
+import 'tasks/docs_coverage.rake'
+import 'tasks/ext.rake'
+import 'tasks/gemspec_check.rake'
+
+# When importing swig.rake, the *_wrap.cxx files depend on being generated
+# by Swig. Since the ExtensionTasks depend on the *_wrap.cxx files,
+# compiling the extensions will trigger Swig, which is not desired as
+# those files have already been generated and there's no reason to make
+# Swig a variable of the CI. To prevent those dependencies, do not import
+# swig.rake when running in Travis.
+import 'tasks/swig.rake' unless ENV['TRAVIS'] == 'true'

data/docs/taglib/aiff.rb

@@ -24,7 +24,7 @@ module TagLib::RIFF::AIFF
   # @see ID3v2::Tag ID3v2 examples.
   #
   class File < TagLib::File
-    # {include:TagLib::FileRef.open}
+    # {include:::TagLib::FileRef.open}
     #
     # @param (see #initialize)
     # @yield [file] the {File} object, as obtained by {#initialize}
@@ -53,11 +53,43 @@ module TagLib::RIFF::AIFF
     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

data/docs/taglib/base.rb

@@ -247,7 +247,14 @@ module TagLib
     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

data/docs/taglib/flac.rb

@@ -30,7 +30,14 @@ module TagLib::FLAC
   #     file.save
   #   end
   class File < TagLib::File
-    # {include:TagLib::FileRef.open}
+
+    NoTags      = 0x0000
+    XiphComment = 0x0001
+    ID3v1       = 0x0002
+    ID3v2       = 0x0004
+    AllTags     = 0xffff
+
+    # {include:::TagLib::FileRef.open}
     #
     # @param (see #initialize)
     # @yield [file] the {File} object, as obtained by {#initialize}
@@ -82,6 +89,14 @@ module TagLib::FLAC
     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 @@ module TagLib::FLAC
     # @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 @@ module TagLib::FLAC
     #
     # @return [binary String]
     attr_accessor :data
+
+    # Parse the picture data in the FLAC picture block format.
+    # @return [Boolean] True if the data has been parsed successfully, false otherwise.
+    #
+    # @since 1.0.0
+    def parse(rawdata)
+    end
   end
-end
+end

data/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

data/docs/taglib/id3v2.rb

@@ -478,7 +478,7 @@ module TagLib::ID3v2
     # @param [String] value simple text to set
     attr_writer :text
 
-    # @param [String] value URL
+    # @return [String] the URL
     attr_accessor :url
   end
 

data/docs/taglib/mp4.rb

@@ -54,7 +54,7 @@ module TagLib::MP4
   #   #   #<TagLib::MP4::Item:0x007f9bab61d818 @__swigtype__="_p_TagLib__MP4__Item">]]
   class File < TagLib::File
 
-    # {include:TagLib::FileRef.open}
+    # {include:::TagLib::FileRef.open}
     #
     # @param (see #initialize)
     # @yield [file] the {File} object, as obtained by {#initialize}
@@ -82,12 +82,48 @@ module TagLib::MP4
     # @return [TagLib::MP4::Properties]
     def audio_properties
     end
+
+    # @return [Boolean] Returns whether or not the file actually has an MP4 tag, or the
+    # file has a Metadata Item List (ilst) atom.
+    #
+    # @since 1.0.0
+    def mp4_tag?
+    end
   end
 
   class Tag < TagLib::Tag
-    # Returns the map containing all the items in the tag
-    # @return [TagLib::MP4::ItemListMap]
-    def item_list_map
+    # @return [TagLib::MP4::ItemMap] The map containing all the items in the tag.
+    #
+    # @since 1.0.0
+    def item_map
+    end
+
+    # @return [TagLib::MP4::Item] The Item associated to `key` (will be invalid in `key` does not exists).
+    #
+    # @since 1.0.0
+    def [](key)
+    end
+
+    # Associate the `value` Item to `key`, overwriting any previous value.
+    # @param key [String]
+    # @param value [TagLib::MP4::Item]
+    # @return [nil]
+    #
+    # @since 1.0.0
+    def []=(key, value)
+    end
+
+    # Remove the [TagLib::MP4::Item] associated to `key`.
+    # @return [nil]
+    #
+    # @since 1.0.0
+    def remove_item(key)
+    end
+
+    # @return True if the tag has an entry for `key`, false otherwise.
+    #
+    # @since 1.0.0
+    def contains(key)
     end
   end
 
@@ -109,11 +145,32 @@ module TagLib::MP4
     def self.from_bool(value)
     end
 
+    # @param [Fixnum] value
+    # @return [TagLib::MP4::Item]
+    #
+    # @since 1.0.0
+    def self.from_byte(value)
+    end
+
+    # @param [Boolean] value
+    # @return [TagLib::MP4::Item]
+    #
+    # @since 1.0.0
+    def self.from_uint(value)
+    end
+
     # @param [Fixnum] number
     # @return [TagLib::MP4::Item]
     def self.from_int(number)
     end
 
+    # @param [Fixnum] number
+    # @return [TagLib::MP4::Item]
+    #
+    # @since 1.0.0
+    def self.from_long_long(number)
+    end
+
     # @example
     #   TagLib::MP4::Item.from_int_pair([4, 11])
     # @param [Array<Fixnum, Fixnum>] integer_pair
@@ -126,18 +183,43 @@ module TagLib::MP4
     def self.from_string_list(string_array)
     end
 
+    # @param [TagLib::ByteVectorList] list
+    # @return [TagLib::MP4::Item]
+    #
+    # @since 1.0.0
+    def self.from_byte_vector_list(list)
+    end
+
     # @return [Boolean]
     def to_bool
     end
 
-    # @return [Array<TagLib::MP4::CoverArt>]
-    def to_cover_art_list
+    # @return [Fixnum]
+    #
+    # @since 1.0.0
+    def to_byte
+    end
+
+    # @return [Fixnum]
+    #
+    # @since 1.0.0
+    def to_uint
     end
 
     # @return [Fixnum]
     def to_int
     end
 
+    # @return [Fixnum]
+    #
+    # @since 1.0.0
+    def to_long_long
+    end
+
+    # @return [Array<TagLib::MP4::CoverArt>]
+    def to_cover_art_list
+    end
+
     # @return [Array<Fixnum, Fixnum>]
     def to_int_pair
     end
@@ -146,19 +228,25 @@ module TagLib::MP4
     def to_string_list
     end
 
+    # @return [TagLib::ByteVectorList]
+    #
+    # @since 1.0.0
+    def to_byte_vector_list
+    end
+
     # @return [Boolean]
     def valid?
     end
   end
 
-  # The underlying C++-structure of `ItemListMap` inherits from `std::map`.
-  # Consequently, `ItemListMap` behaves differently from a Ruby hash in a few
-  # places: the C++ memory management strategies of ItemListMap can lead to
+  # The underlying C++-structure of `ItemMap` inherits from `std::map`.
+  # Consequently, `ItemMap` behaves differently from a Ruby hash in a few
+  # places: the C++ memory management strategies of ItemMap can lead to
   # a situation where a Ruby object refers to a location in memory that was
   # freed by C++. To prevent Ruby from crashing on us with a segmentation
   # fault, we raise an `ObjectPreviouslyDeleted` exception when we try to access
   # data that is no longer available.
-  class ItemListMap
+  class ItemMap
     # Return the Item under `key`, or `nil` if no Item is present.
     # @param [String] key
     # @return [TagLib::MP4::Item]
@@ -235,10 +323,30 @@ module TagLib::MP4
     # @return [Array<Array<String, TagLib::MP4::Item>>]
     def to_a
     end
+
+    # Convert self into an hash.
+    # @return [Hash<String, TagLib::MP4::Item>]
+    #
+    # @since 1.0.0
+    def to_h
+    end
   end
   #
   class Properties < TagLib::AudioProperties
-    attr_reader :bits_per_sample, :encrypted?
+    Unknown = 0
+    AAC     = 1
+    ALAC    = 2
+
+    # @return [Integer] The number of bits per audio sample.
+    attr_reader :bits_per_sample
+
+    # @return [Boolean] Whether or not the file is encrypted.
+    attr_reader :encrypted?
+
+    # @return [Integer] The codec used in the file.
+    #
+    # @since 1.0.0
+    attr_reader :codec
   end
 
   # The `CoverArt` class is used to embed cover art images in MP4 tags.
@@ -247,8 +355,11 @@ module TagLib::MP4
   #   image_data = File.open('cover_art.jpeg', 'rb') { |f| f.read }
   #   cover_art = TagLib::MP4::CoverArt.new(TagLib::MP4::CoverArt::JPEG, image_data)
   class CoverArt
-    JPEG = 0x0D
-    PNG  = 0x0E
+    Unknown = 0x00
+    JPEG    = 0x0D
+    PNG     = 0x0E
+    BMP     = 0x1B
+    GIF     = 0x0C # Deprecated
 
     # Returns the format of the image data: `JPEG` or `PNG`.
     # @return [Fixnum]