taglib-ruby 0.6.0 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5a05d3733b4a04a791f619b399e24070ddc184ee2282d61d5b7f377726e3f2cd
+  data.tar.gz: cc92fc66ba1a8643a8a5b4ea1ff6398ba1277b756697dfbd3450007954103b48
+SHA512:
+  metadata.gz: 6350877ea0c574bc92c4a09cd501f15648f13b464cbce35aab4b38722fe4357f224a2b802dc15efe6aa17f6ee3e7d78ae837e54b3fbf061f61bf9a355a12f1d4
+  data.tar.gz: 23c439bbc1aabf7d4bf1b2b434de929fac6c1738468028054ca83f1001ae36f0bbabedb22db2db2da66fd701b328db2f2aceb4962dd661ec1983140963d11bbc

data/.yardopts

@@ -5,5 +5,5 @@
 docs/**/*.rb
 -
 README.md
-CHANGES.md
+CHANGELOG.md
 LICENSE.txt

data/{CHANGES.md → CHANGELOG.md}

@@ -1,7 +1,42 @@
 Changes in Releases of taglib-ruby
 ==================================
 
-## 0.6.0 (2013-04-26)
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## 1.1.0 - 2021-01-20
+### Added
+- Added support for CTOC and CHAP frames for ID3v2
+
+## 1.0.1 - 2020-03-25
+
+### Fixed
+- Fix segmentation fault with TagLib::FLAC picture lists (#91), thanks
+  @jameswyper!
+
+## 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)
+
+## 0.7.0 - 2014-08-21
+
+* Add support for TagLib::RIFF::AIFF (#52, by @tchev)
+* Add support for TagLib::RIFF::WAV (#57, by @tchev)
+* Associate filesystem encoding to filename strings
+* Allow CXX override during gem installation
+* Try to detect location of vendor/taglib on Heroku (#28)
+* Documentation updates
+
+## 0.6.0 - 2013-04-26
 
 * Add support for TagLib::MP4 (#3, by @jacobvosmaer)
 * Add support for TagLib::ID3v2::Header (#19, by @kaethorn)
@@ -12,24 +47,24 @@ Changes in Releases of taglib-ruby
 * Fix segfault when passing a non-String to a String argument
 * Documentation updates
 
-## 0.5.2 (2012-10-06)
+## 0.5.2 - 2012-10-06
 
 * Fix memory bug with TagLib::MPEG::File#tag and TagLib::FLAC::File#tag
   which could cause crashes (#14)
 * Update TagLib of binary gem for Windows to 1.8
 
-## 0.5.1 (2012-06-16)
+## 0.5.1 - 2012-06-16
 
 * Fix crashes (segfault) with nil arguments, e.g. with `tag.title = nil`
 * Document TagLib::MPEG::File#save and TagLib::MPEG::File#strip (#11)
 * Update TagLib of binary gem for Windows to 1.7.2
 
-## 0.5.0 (2012-04-15)
+## 0.5.0 - 2012-04-15
 
 * Add support for FLAC
 * Fix problem in SWIG causing compilation error on MacRuby (#10)
 
-## 0.4.0 (2012-03-18)
+## 0.4.0 - 2012-03-18
 
 * Pre-compiled binary gem for Windows (Ruby 1.9) with TagLib 1.7.1
 * Unicode filename support on Windows
@@ -43,35 +78,35 @@ title = TagLib::FileRef.open("file.mp3") do |file|
 end
 ```
 
-## 0.3.1 (2012-01-22)
+## 0.3.1 - 2012-01-22
 
 * Fix ObjectPreviouslyDeleted exception after calling
   TagLib::ID3v2::Tag#add_frame (#8)
 * Make installation under MacPorts work out of the box (#7)
 
-## 0.3.0 (2012-01-02)
+## 0.3.0 - 2012-01-02
 
 * Add support for Ogg Vorbis
 * Add support for ID3v1 (#2)
 * Add #close to File classes for explicitly releasing resources
 * Fix compilation on Windows
 
-## 0.2.1 (2011-11-05)
+## 0.2.1 - 2011-11-05
 
 * Fix compilation error due to missing typedef on some systems (#5)
 
-## 0.2.0 (2011-10-22)
+## 0.2.0 - 2011-10-22
 
 * API documentation
 * Add support for:
   * TagLib::AudioProperties and TagLib::MPEG::Properties (#4)
   * TagLib::ID3v2::RelativeVolumeFrame
 
-## 0.1.1 (2011-09-17)
+## 0.1.1 - 2011-09-17
 
 * Add installation instructions and clean up description
 
-## 0.1.0 (2011-09-17)
+## 0.1.0 - 2011-09-17
 
 * Initial release
 * Coverage of the following API:

data/README.md

@@ -18,18 +18,17 @@ taglib-ruby currently supports the following:
 
 Contributions for more coverage of the library are very welcome.
 
-[![Build status][travis-img]][travis-link]
-
-[![flattr this project][flattr-img]][flattr-link]
+[![Gem version][gem-img]][gem-link]
+[![ci](https://github.com/robinst/taglib-ruby/workflows/ci/badge.svg)](https://github.com/robinst/taglib-ruby/actions?query=workflow%3Aci)
 
 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`
 
@@ -37,6 +36,14 @@ Then do:
 
     gem install taglib-ruby
 
+### OS X C++ compiler override
+
+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` environment variable.
+
+    TAGLIB_RUBY_CXX=g++-4.2 gem install taglib-ruby
+
 Usage
 -----
 
@@ -48,27 +55,66 @@ Begin with the {TagLib} namespace.
 Release Notes
 -------------
 
-See {file:CHANGES.md}.
+See {file:CHANGELOG.md}.
 
 Contributing
 ------------
 
+### Dependencies
+
+Fedora:
+
+    sudo dnf install taglib-devel ruby-devel gcc-c++ redhat-rpm-config swig
+
 ### Building
 
-    # Install dependencies
+Install dependencies (uses bundler, install it via `gem install bundler`
+if you don't have it):
+
     bundle install
-    # Regenerate SWIG wrappers (only necessary if you made changes)
+
+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
-    # Compile extension
+
+Force regeneration of all SWIG wrappers:
+
+    touch ext/*/*.i
+    rake swig
+
+Compile extensions:
+
     rake clean compile
-    # Run tests
+
+Run tests:
+
     rake test
-    # Build and install gem into system gems
+
+Run irb with library:
+
+    irb -Ilib -rtaglib
+
+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
+* Check out the latest main branch to make sure the feature hasn't been
   implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't
   requested it and/or contributed it
@@ -85,7 +131,7 @@ Contributing
 License
 -------
 
-Copyright (c) 2010-2013 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.
@@ -95,7 +141,5 @@ a DLL. TagLib is distributed under the GNU Lesser General Public License
 version 2.1 (LGPL) and Mozilla Public License (MPL).
 
 [taglib]: http://taglib.github.io/
-[travis-img]: https://secure.travis-ci.org/robinst/taglib-ruby.png
-[travis-link]: http://travis-ci.org/robinst/taglib-ruby
-[flattr-img]: http://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
+[gem-img]: https://badge.fury.io/rb/taglib-ruby.svg
+[gem-link]: https://rubygems.org/gems/taglib-ruby

data/Rakefile

@@ -23,7 +23,16 @@ YARD::Rake::YardocTask.new do |t|
   t.options = ['--title', "taglib-ruby #{version}"]
 end
 
-# Change to Bundler::GemHelper.gemspec when it's released
-$gemspec = Bundler.load_gemspec('taglib-ruby.gemspec')
+$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. The environment variable can be set to
+# prevent running swig.
+import 'tasks/swig.rake' unless ENV['SKIP_SWIG'] == 'true'

data/docs/taglib/aiff.rb

@@ -0,0 +1,95 @@
+# @since 0.7.0
+module TagLib::RIFF::AIFF
+
+  # The file class for `.aiff` files.
+  #
+  # @example Reading the title
+  #   title = TagLib::RIFF::AIFF::File.open("sample.aiff") do |file|
+  #     file.tag.title
+  #   end
+  #
+  # @example Reading AIFF-specific audio properties
+  #   TagLib::RIFF::AIFF::File.open("sample.aiff") do |file|
+  #     file.audio_properties.sample_width  #=>  16
+  #   end
+  #
+  # @example Saving ID3v2 cover-art to disk
+  #   TagLib::RIFF::AIFF::File.open("sample2.aif") do |file|
+  #     id3v2_tag = file.tag
+  #     cover = id3v2_tag.frame_list('APIC').first
+  #     ext = cover.mime_type.rpartition('/')[2]
+  #     File.open("cover-art.#{ext}", "wb") { |f| f.write cover.picture }
+  #   end
+  #
+  # @see ID3v2::Tag ID3v2 examples.
+  #
+  class File < TagLib::File
+    # {include:::TagLib::FileRef.open}
+    #
+    # @param (see #initialize)
+    # @yield [file] the {File} object, as obtained by {#initialize}
+    # @return the return value of the block
+    #
+    def self.open(filename, read_properties=true)
+    end
+
+    # Load an AIFF file.
+    #
+    # @param [String] filename
+    # @param [Boolean] read_properties if audio properties should be
+    #                  read
+    def initialize(filename, read_properties=true)
+    end
+
+    # Returns the ID3v2 tag.
+    #
+    # @return [TagLib::ID3v2::Tag]
+    def tag
+    end
+
+    # Returns audio properties.
+    #
+    # @return [TagLib::RIFF::AIFF::Properties]
+    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] 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

@@ -5,7 +5,7 @@
 # * Reading/writing basic tag and audio properties without having to
 #   know the tagging format: {TagLib::FileRef}
 # * Reading properties of MPEG files: {TagLib::MPEG::File}
-# * Reading/writing ID3v2 tags: {TagLib::MPEG::File} and
+# * Reading/writing ID3v2 tags: {TagLib::MPEG::File}, {TagLib::RIFF::AIFF::File} and
 #   {TagLib::ID3v2::Tag}
 # * Reading/writing Ogg Vorbis tags: {TagLib::Ogg::Vorbis::File}
 # * Reading/writing FLAC tags: {TagLib::FLAC::File}
@@ -23,6 +23,27 @@
 #
 # For ID3v2 frames, you can also set a default text encoding globally
 # using the {TagLib::ID3v2::FrameFactory}.
+#
+# ## Modifying attributes
+#
+# Mutable Ruby types (String, Array) returned by TagLib cannot be modified in-place.
+#
+# @example Modifying an attribute in-place does not work
+#   tag.title = 'Title'
+#   tag.title
+#   # => "Title"
+#   tag.title << ' of the song'
+#   # => "Title of the song"
+#   tag.title
+#   # => "Title"
+#
+# @example You need to replace the existing attribute value
+#   tag.title = 'Title'
+#   tag.title
+#   # => "Title"
+#   tag.title = 'Title of the song'
+#   tag.title
+#   # => "Title of the song"
 module TagLib
 
   # Major version of TagLib the extensions were compiled against
@@ -226,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