chapter 0.1.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Pascal Jungblut
+
+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.

data/README.md

@@ -0,0 +1,56 @@
+#chapter#
+
+chapter is a simple gem to set mp4 chapter information.
+
+##prerequisites##
+To use it, you'll need [mp4v2][1] installed on your system.
+
+On OS X:
+
+    brew install mp4v2
+On FreeBSD:
+
+    cd /usr/ports/multimedia/mp4v2 && make install clean
+On other systems you might need to compile it yourself. Please refer to the mp4v2 [documentation][2] on how to do that.
+##Installation##
+Via Rubygems:
+
+    gem install chapter
+Or add the gem to your `Gemfile`:
+
+    gem 'chapter'
+
+##Usage##
+
+###Get the chapters in a file###
+
+    require 'chapter'
+    chapters = Chapter.chapters '/path/to/file.m4a'
+`chapters` will be an array of hashes. Each hash represents a chapter with its position and duration (both in microseconds) and its title.
+####Example
+
+    [
+      {"title"=>"Introduction", "duration"=>12325, "position"=>0},
+      {"title"=>"Discussion", "duration"=>655325, "position"=>12325}
+    ]
+###Set chapters
+Setting the chapters is just as simple:
+
+    require 'chapter'
+    chapters = [{"title"=>"Introduction", "duration"=>12325},
+      {"title"=>"Discussion", "duration"=>655325}]
+    Chapter.set_chapters("/path/fo/file.m4a", chapters)
+**CAUTON**: `set_chapters` will overwrite any existing chapters in the file.
+
+##Copyright
+###The MIT Licence
+Copyright (c) 2012 Pascal Jungblut
+
+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.
+
+[1]: https://code.google.com/p/mp4v2/
+[2]: https://code.google.com/p/mp4v2/wiki/BuildSource

data/ext/chapter/chapter.c

@@ -0,0 +1,74 @@
+#include <ruby.h>
+#include <mp4v2/mp4v2.h>
+#include <stdio.h>
+#include <string.h>
+
+static VALUE
+rb_get_chapters(VALUE self, VALUE path) {
+    char* fileName = StringValuePtr(path);
+    MP4FileHandle file = MP4Read(fileName, 0);
+    if(file == MP4_INVALID_FILE_HANDLE )
+    {
+       rb_raise(rb_eException, "could not load file");
+       return Qnil;
+    }
+
+    MP4Chapter_t * chapters = 0;
+    uint32_t chapterCount = 0;
+
+    // get the list of chapters
+    MP4ChapterType chtp = MP4GetChapters(file, &chapters, &chapterCount, MP4ChapterTypeAny);
+
+    uint32_t i;
+    uint32_t pos = 0;
+    VALUE result = rb_ary_new();
+    for (i = 0; i < chapterCount; ++i)
+    {
+    	VALUE chapter = rb_hash_new();
+        // print the infos
+	rb_hash_aset(chapter, rb_str_new2("title"), rb_str_new2(chapters[i].title));
+	rb_hash_aset(chapter, rb_str_new2("duration"), INT2NUM(chapters[i].duration));
+	rb_hash_aset(chapter, rb_str_new2("position"), INT2NUM(pos));
+	rb_ary_push(result, chapter);
+	pos = pos + chapters[i].duration;
+
+    }
+    // free up the memory
+    MP4Free(chapters);
+    return result;
+}
+
+static VALUE
+rb_set_chapters(VALUE self, VALUE path, VALUE chapters) {
+    char* fileName = StringValuePtr(path);
+    MP4FileHandle file = MP4Modify(fileName, 0, 0);
+    if(file == MP4_INVALID_FILE_HANDLE )
+    {
+       rb_raise(rb_eException, "could not load file");
+       return Qnil;
+    }
+    uint32_t chapter_len = RARRAY_LEN(chapters);
+    uint32_t i;
+    MP4Chapter_t newChapters[chapter_len]; 
+    for (i = 0; i < chapter_len; i++) {
+
+        VALUE duration = rb_hash_aref(rb_ary_entry(chapters, i), rb_str_new2("duration"));
+        VALUE title = rb_hash_aref(rb_ary_entry(chapters, i), rb_str_new2("title"));
+
+        MP4Chapter_t *chapter = malloc(sizeof(MP4Chapter_t));
+        chapter->duration = NUM2UINT(duration);
+        strcpy(chapter->title, StringValuePtr(title));
+        newChapters[i] = *chapter;
+    }
+
+    MP4SetChapters(file, &newChapters[0], chapter_len, MP4ChapterTypeQt);
+    MP4Close(file);
+    return Qnil;
+}
+
+/* ruby calls this to load the extension */
+void Init_chapter(void) {
+    VALUE klass = rb_define_class("Chapter", rb_cObject);
+    rb_define_singleton_method(klass, "chapters", rb_get_chapters, 1);
+    rb_define_singleton_method(klass, "set_chapters", rb_set_chapters, 2);
+}

data/ext/chapter/extconf.rb

@@ -0,0 +1,4 @@
+require 'mkmf'
+
+have_library('mp4v2')
+create_makefile('chapter/chapter')

data/lib/chapter.rb

@@ -0,0 +1 @@
+require 'chapter/chapter'

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: chapter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Pascal Jungblut
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This very simple gem uses the mp4v2 C library to read and set the chapters
+  of mp4 files.
+email: mail@pascal-jungblut.com
+executables: []
+extensions:
+- ext/chapter/extconf.rb
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ext/chapter/chapter.c
+- ext/chapter/extconf.rb
+- lib/chapter.rb
+- LICENSE.txt
+- README.md
+homepage: http://github.com/pascalj/chapter
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1952082223091747186
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Read and write chapters of mp4 files
+test_files: []