vorbis_comment 1.0.0

data/vcedit.h

@@ -0,0 +1,52 @@
+/*
+ * Copyright (C) 2000-2001 Michael Smith (msmith at xiph org)
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, version 2.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301 USA
+ */
+
+#ifndef __VCEDIT_H
+#define __VCEDIT_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <stdio.h>
+#include <ogg/ogg.h>
+#include <vorbis/codec.h>
+
+typedef enum {
+	VCEDIT_ERR_SUCCESS = 0,
+	VCEDIT_ERR_OPEN,
+	VCEDIT_ERR_INVAL,
+	VCEDIT_ERR_TMPFILE,
+	VCEDIT_ERR_REOPEN
+} vcedit_error;
+
+typedef struct vcedit_state_St vcedit_state;
+
+vcedit_state *vcedit_state_new (const char *filename);
+void vcedit_state_ref (vcedit_state *state);
+void vcedit_state_unref (vcedit_state *state);
+vorbis_comment *vcedit_comments (vcedit_state *state);
+vcedit_error vcedit_open (vcedit_state *state);
+vcedit_error vcedit_write (vcedit_state *state);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* __VCEDIT_H */
+

data/vorbis_comment.gemspec

@@ -0,0 +1,19 @@
+spec = Gem::Specification.new do |s| 
+  s.name = "vorbis_comment"
+  s.version = "1.0.0"
+  s.author = "Jeremy Evans"
+  s.email = "code@jeremyevans.net"
+  s.homepage = "http://rubyforge.org/projects/vorbiscomment/"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Vorbis Comment Reader/Writer Library"
+  s.files = Dir["*"]
+  s.require_paths = ["."]
+  s.extensions << 'extconf.rb'
+  s.autorequire = "vorbis_comment"
+  s.test_files = Dir["test/*"]
+  s.has_rdoc = true
+  s.rdoc_options = %w'--inline-source --line-numbers'
+  s.add_dependency('cicphash', [">= 1.0.0"])
+  s.rubyforge_project = 'vorbiscomment'
+end
+

data/vorbis_comment.rb

@@ -0,0 +1,164 @@
+#!/usr/bin/env ruby
+# This library implements a Vorbis Comment reader/writer.
+# If called from the command line, it prints out the contents of the APEv2 tag 
+# 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 i386 and 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 run the tests for the library, run test_vorbis_comment.rb.
+#
+# If you find any bugs, would like additional documentation, or want to submit a
+# patch, please use Rubyforge (http://rubyforge.org/projects/vorbis_comment/).
+# One known bug is in the libvorbis library, in that it doesn't like files less
+# than 8K in size.
+#
+# The most current source code can be accessed via anonymous SVN at 
+# svn://code.jeremyevans.net/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 (c) 2007 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.
+
+require 'cicphash'
+
+# Contains all of the Vorbis comment fields found in the filename/file given.
+class VorbisComment
+  attr_reader :filename
+  BAD_KEY_RE = /[\x00-\x1f=\x7e-\xff]/
+  
+  # Set the filename to be used
+  def initialize(filename)
+    @filename = filename.to_s
+  end
+  
+  # Check for the existance of the a vorbis comment in the file.
+  # Because all Vorbis bitstreams should have a comment, any file missing
+  # a comment probably isn't a vorbis file, or it's possible the file is
+  # corrupt.
+  def exists?
+    begin
+      fields
+      true
+    rescue InvalidDataError
+      false
+    end
+  end
+  
+  # Clear all fields from the vorbis comment
+  def remove!
+    update{|fields| fields.clear}
+  end
+  
+  # Get all the fields in the vorbis comment
+  def fields
+    return @fields if @fields
+    @fields = CICPHash.new
+    read_fields
+    @fields
+  end
+  
+  # Return a string suitable for pretty printing, used by the command line
+  def pretty_print
+    begin
+      fields.sort.collect{|key, value| "#{key}: #{value.join(', ')}"}.join("\n")
+    rescue OpenError
+      "FILE NOT FOUND!"
+    rescue InvalidDataError, InvalidCommentError
+      "CORRUPT TAG!"
+    end
+  end
+  
+  # Update the vorbis comment with the changes that occur to fields inside the
+  # block.  Make sure to modify the fields given and not reassign them.
+  def update(&block)
+    yield fields
+    write_fields(normalize_fields)
+    fields
+  end
+  
+  private
+    # Return a array with key/value pairs so that keys with multiple values
+    # have multiple entries.  This is used mainly to make the C extension
+    # easier to code.
+    def normalize_fields
+      comments = []
+      fields.each do |key, values|
+        key = key.to_s
+        raise InvalidCommentError if key =~ BAD_KEY_RE
+        values = [values] unless values.is_a?(Array)
+        values = values.collect{|value| value.to_s}
+        values.each do |value| 
+          value.unpack('U*') rescue (raise InvalidCommentError)
+          comments << [key, value]
+        end
+      end
+      comments.sort
+    end
+    
+    # Add a value for the given key to the list of values for that key, creating
+    # the list if this is the first value for that key.  This is used to make
+    # the C extension easier to code.
+    def add_to_fields(key, value)
+      (fields[key] ||= []) << value
+    end
+end
+
+require 'vorbis_comment_ext' # define read_fields and write_fields
+
+# If called directly from the command line, treat all arguments as filenames
+# and pretty print the vorbis comment fields for each filename.
+if __FILE__ == $0
+  ARGV.each do |filename| 
+    puts filename, '-'*filename.length, VorbisComment.new(filename).pretty_print, ''
+  end
+end

data/vorbis_comment_ext.c

@@ -0,0 +1,161 @@
+/*
+ * Copyright (C) 2007 Jeremy Evans (code at jeremyevans net)
+ * Copyright (C) 2006 Tilman Sauerbeck (tilman at code-monkey de)
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, version 2.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301 USA
+ */
+
+#include <ruby.h>
+#include <st.h>
+#include <stdio.h>
+#include <stdbool.h>
+#include <errno.h>
+#include <assert.h>
+#include <limits.h>
+#include <unistd.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <ogg/ogg.h>
+#include <vorbis/codec.h>
+
+#include "vcedit.h"
+
+static VALUE eOpen, eInvalidData, eInvalidComment, eTempFile, eReopen;
+
+/*
+ * call-seq:
+ *  object.read_fields -> fields
+ *
+ * Reads the comments from the file into the appropriate data structure.
+ * Returns the fields (a precreated CICPHash). Do not call this directly.
+ */
+VALUE read_fields (VALUE self) {
+    vcedit_state *state;
+    vorbis_comment *vc;
+    VALUE fields, filename;
+    VALUE k, v;
+    int add_to_fields;
+    int i;
+
+    filename = rb_iv_get(self, "@filename");
+    state = vcedit_state_new(StringValuePtr(filename));
+    if (!state)
+        rb_raise (rb_eNoMemError, "Out of Memory");
+
+    switch (vcedit_open (state)) {
+        case VCEDIT_ERR_OPEN:
+            vcedit_state_unref(state);
+            rb_raise (eOpen, "Cannot open file");
+        case VCEDIT_ERR_INVAL:
+            vcedit_state_unref(state);
+            rb_raise (eInvalidData, "Invalid data");
+        default:
+            break;
+    }
+
+    vc = vcedit_comments(state);
+    
+    fields = rb_iv_get(self, "@fields");
+    rb_funcall(fields, rb_intern("clear"), 0);
+    add_to_fields = rb_intern("add_to_fields");
+
+    /* check whether all comments are well-formed */
+    for (i = 0; i < vc->comments; i++) {
+        char *ptr, *content = vc->user_comments[i];
+
+        ptr = strchr (content, '=');
+        if (!ptr || ptr == content) {
+            rb_funcall(fields, rb_intern("clear"), 0);
+            vcedit_state_unref(state);
+            rb_raise (eInvalidComment, "invalid comment - %s", content);
+        }
+        
+        k = rb_str_new (content, ptr - content);
+        v = rb_str_new2 (ptr + 1);
+        rb_funcall(self, add_to_fields, 2, k, v);
+    }
+    
+    vcedit_state_unref(state);
+    return fields;
+}
+
+/*
+ * call-seq:
+ *  object.write_fields(comments) -> comments
+ *
+ * Writes the comments to the file. Do not call this directly.
+ */
+VALUE write_fields (VALUE self, VALUE comments) {
+    vcedit_state *state;
+    vorbis_comment *vc;
+    struct RArray *items, *comment;
+    VALUE filename;
+    int i, j;
+
+    filename = rb_iv_get(self, "@filename");
+    state = vcedit_state_new(StringValuePtr(filename));
+    if (!state)
+        rb_raise (rb_eNoMemError, "Out of Memory");
+
+    switch (vcedit_open (state)) {
+        case VCEDIT_ERR_OPEN:
+            vcedit_state_unref(state);
+            rb_raise (eOpen, "Cannot open file");
+        case VCEDIT_ERR_INVAL:
+            vcedit_state_unref(state);
+            rb_raise (eInvalidData, "Invalid data");
+        default:
+            break;
+    }
+
+    vc = vcedit_comments(state);
+    vorbis_comment_clear(vc);
+    vorbis_comment_init(vc);
+
+    items = RARRAY(comments);
+    for (i = 0; i < items->len; i++) {
+        comment = RARRAY(items->ptr[i]);
+        vorbis_comment_add_tag(vc, StringValuePtr(comment->ptr[0]), StringValuePtr(comment->ptr[1]));
+    }
+    
+    switch (vcedit_write (state)) {
+        case VCEDIT_ERR_INVAL:
+            vcedit_state_unref(state);
+            rb_raise (eInvalidData, "Invalid data");
+        case VCEDIT_ERR_TMPFILE:
+            vcedit_state_unref(state);
+            rb_raise (eTempFile, "Cannot create temporary file");
+        case VCEDIT_ERR_REOPEN:
+            vcedit_state_unref(state);
+            rb_raise (eReopen, "Cannot reopen file");
+        default:
+            break;
+    }
+    vcedit_state_unref(state);
+    
+    return comments;
+}
+
+void Init_vorbis_comment_ext(void) {
+    VALUE VorbisComment;
+    VorbisComment = rb_define_class("VorbisComment", rb_cObject);
+    rb_define_private_method(VorbisComment, "read_fields", read_fields, 0);
+    rb_define_private_method(VorbisComment, "write_fields", write_fields, 1);
+    eOpen = rb_define_class_under (VorbisComment, "OpenError", rb_eStandardError);
+    eInvalidData = rb_define_class_under (VorbisComment, "InvalidDataError", rb_eStandardError);
+    eInvalidComment = rb_define_class_under (VorbisComment, "InvalidCommentError", rb_eStandardError);
+    eTempFile = rb_define_class_under (VorbisComment, "TempFileError", rb_eStandardError);
+    eReopen = rb_define_class_under (VorbisComment, "ReopenError", rb_eStandardError);
+}

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: vorbis_comment
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2007-09-11 00:00:00 -07:00
+summary: Vorbis Comment Reader/Writer Library
+require_paths: 
+- .
+email: code@jeremyevans.net
+homepage: http://rubyforge.org/projects/vorbiscomment/
+rubyforge_project: vorbiscomment
+description: 
+autorequire: vorbis_comment
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Jeremy Evans
+files: 
+- LICENSE
+- extconf.rb
+- test
+- vcedit.c
+- vcedit.h
+- vorbis_comment.gemspec
+- vorbis_comment.rb
+- vorbis_comment_ext.c
+- vorbis_comment-1.0.0.gem
+test_files: 
+- test/test_vorbis_comment.rb
+- test/manyfields.ogg
+- test/corrupt.ogg
+- test/lt8k.ogg
+- test/blank.ogg
+- test/title.ogg
+rdoc_options: 
+- --inline-source
+- --line-numbers
+extra_rdoc_files: []
+
+executables: []
+
+extensions: 
+- extconf.rb
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cicphash
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: