vorbis_comment.rb

This library implements a Vorbis Comment reader/writer. If called from the command line, it prints out the contents of the Vorbis comments for the given filename arguments.

ruby-vorbis_comment is a pure Ruby library for manipulating Vorbis comments. It wraps libvorbis and libogg, so it should be completely standards compatible. Vorbis comment is the standard tagging format for Ogg Vorbis, FLAC, and Speex files.

The library includes a C extension, which may or may not build cleanly on all architectures. It is developed and tested on OpenBSD amd64. If it doesn't work on your machine, please try to get it to work and send in a patch.

This library tries to be API compatible with ruby-apetag, a library for reading and writing APE tags, the standard tagging format for Musepack and Monkey's Audio, which can also be used with MP3s as an alternative to ID3v2.

General Use:

require 'vorbiscomment'
a = VorbisComment.new('file.ogg')
a.exists? # if it already has an vorbis comment
a.fields # a CICPHash of fields, keys are strings, values are lists of strings
a.pretty_print # string suitable for pretty printing
a.update{|fields| fields['Artist']='Test Artist'; fields.delete('Year')}
 # Update the tag with the added/changed/deleted fields
 # Note that you should do: a.update{|fields| fields.replace('Test'=>'Test')}
 # and NOT: a.update{|fields| fields = {'Test'=>'Test'}}
 # You need to update/modify the fields given, not reassign it
a.remove! # clear the list of vorbis comments from the file

To build the library, run rake build. To run the tests for the library after building, run rake.

If you find any bugs, would like additional documentation, or want to submit a patch, please use GitHub (github.com/jeremyevans/ruby-vorbis_comment/issues). One known bug is that it doesn't like files less than 8K in size.

The RDoc for the project is available on ruby-vorbiscomment.jeremyevans.net

The most current source code can be accessed via github (github.com/jeremyevans/ruby-vorbis_comment/). Note that the library isn't modified on a regular basis, so it is unlikely to be different from the latest release.

The pure ruby part of this library is copyright Jeremy Evans and is released under the MIT License.

The C part of this library is copyright Jeremy Evans and Tilman Sauerbeck and is licensed under the GNU LGPL.

Copyright © 2007,2010,2013,2020 Jeremy Evans

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.