hindbaer 0.0.3 → 0.0.4

data/README.markdown

@@ -1,8 +1,8 @@
 Hindbær
 =======
 
-A [Hindenburg Journalist](http://hindenburgsystems.com/) client for parsing, 
-modifying and generating audio session files.
+Parse, modify and generate [Hindenburg Journalist](http://hindenburgsystems.com/)
+audio session files.
 
 Installation
 ------------
@@ -30,6 +30,10 @@ Parse a session file:
     
     session.length # in seconds
     
+Render Session object as xml:
+
+    session.to_xml
+    
 Retrieve all tracks:
 
     tracks = session.tracks
@@ -45,6 +49,8 @@ Retrieve all track plugins:
     plugin.name
     plugin.uid
     
+There is currently support for the four default plugins and their attributes.
+    
 Retrieve all regions for a given track:
 
     regions = tracks.first.regions

data/hindbaer.gemspec

@@ -4,7 +4,7 @@ require File.expand_path('../lib/hindbaer/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Jamie Hodge"]
   gem.email         = ["jamiehodge@me.com"]
-  gem.description   = %q{A Hindenburg Journalist client}
+  gem.description   = %q{A Hindenburg Journalist parser}
   gem.summary       = %q{Parse, modify and generate Hindenburg Journalist audio session files}
   gem.homepage      = "http://github.com/jamiehodge/hindbaer"
 

data/lib/hindbaer/clip.rb

@@ -22,6 +22,7 @@ module Hindbaer
     end
     
     def leq
+      return '-' if @doc['Leq'] == '-'
       @doc['Leq'].to_f
     end
   end

data/lib/hindbaer/info.rb

@@ -53,6 +53,10 @@ module Hindbaer
       @doc['Date']
     end
     
+    def genre
+      @doc['Genre']
+    end
+    
     def copyright
       @doc['Copyright']
     end

data/lib/hindbaer/plugin/base.rb

@@ -0,0 +1,23 @@
+module Hindbaer
+  module Plugin
+    class Base
+      
+      def initialize(fragment)
+        @doc = fragment
+      end
+
+      def id
+        @doc['Id'].to_i
+      end
+
+      def name
+        @doc['Name']
+      end
+
+      def uid
+        @doc['UID']
+      end
+      
+    end
+  end
+end

data/lib/hindbaer/plugin/compressor.rb

@@ -0,0 +1,19 @@
+module Hindbaer
+  module Plugin
+    class Compressor < Hindbaer::Plugin::Base
+
+      def uid
+        'nhcl'
+      end
+
+      def name
+        'Compressor'
+      end
+
+      def comp
+        @doc['Comp']
+      end
+      
+    end
+  end
+end

data/lib/hindbaer/plugin/equalizer.rb

@@ -0,0 +1,63 @@
+module Hindbaer
+  module Plugin
+    class Equalizer < Hindbaer::Plugin::Base
+
+      def uid
+        'nheq'
+      end
+
+      def name
+        'Equalizer'
+      end
+
+      def bypass
+        @doc['Bypass']
+      end
+
+      def low_freq_freq
+        @doc['LF_Freq']
+      end
+
+      def low_freq_gain
+        @doc['LF_Gain']      
+      end
+
+      def low_freq_q
+        @doc['LF_Q']
+      end
+
+      def low_freq_type
+        @doc['LF_Type']
+      end
+
+      def mid_freq_freq
+        @doc['MF_Freq']
+      end
+
+      def mid_freq_gain
+        @doc['MF_Gain']
+      end
+
+      def mid_freq_q
+        @doc['MF_Q']
+      end
+
+      def high_freq_freq
+        @doc['HF_Freq']
+      end
+
+      def high_freq_gain
+        @doc['HF_Gain']
+      end
+
+      def high_freq_q
+        @doc['HF_Q']
+      end
+
+      def high_freq_type
+        @doc['HF_Type']
+      end
+      
+    end
+  end
+end

data/lib/hindbaer/plugin/voice_profiler.rb

@@ -0,0 +1,63 @@
+module Hindbaer
+  module Plugin
+    class VoiceProfiler < Hindbaer::Plugin::Base
+
+      def uid
+        'nhft'
+      end
+
+      def name
+        'Voice Profiler'
+      end
+
+      def low_freq_freq
+        @doc['LF_Freq']
+      end
+
+      def low_freq_gain
+        @doc['LF_Gain']      
+      end
+
+      def low_freq_q
+        @doc['LF_Q']
+      end
+
+      def mid_freq_freq
+        @doc['MF_Freq']
+      end
+
+      def mid_freq_gain
+        @doc['MF_Gain']
+      end
+
+      def mid_freq_q
+        @doc['MF_Q']
+      end
+
+      def high_freq_freq
+        @doc['HF_Freq']
+      end
+
+      def high_freq_gain
+        @doc['HF_Gain']
+      end
+
+      def high_freq_q
+        @doc['HF_Q']
+      end
+
+      def high_pass_freq
+        @doc['HP_Freq']
+      end
+
+      def high_pass_gain
+        @doc['HP_Gain']
+      end
+
+      def comp
+        @doc['Comp']
+      end
+      
+    end
+  end
+end

data/lib/hindbaer/plugin.rb

@@ -1,20 +1,26 @@
+require_relative 'plugin/base'
+require_relative 'plugin/equalizer'
+require_relative 'plugin/compressor'
+require_relative 'plugin/voice_profiler'
+
 module Hindbaer
-  class Plugin
+  module Plugin
+    extend self
     
-    def initialize(fragment)
-      @doc = fragment
+    def create(fragment)
+      case fragment['UID']
+      when 'nheq'
+        Hindbaer::Plugin::Equalizer.new(fragment)
+      when 'nhcl'
+        Hindbaer::Plugin::Compressor.new(fragment)
+      when 'nhlu'
+        Hindbaer::Plugin::Base.new(fragment)
+      when 'nhft'
+        Hindbaer::Plugin::VoiceProfiler.new(fragment)
+      end
     end
     
-    def id
-      @doc['Id'].to_i
-    end
-    
-    def name
-      @doc['Name']
-    end
-    
-    def uid
-      @doc['UID']
-    end
   end
-end
+  
+end
+

data/lib/hindbaer/session.rb

@@ -45,6 +45,66 @@ module Hindbaer
         Hindbaer.tc_to_secs(r.length)
       end.max
     end
+    
+    def to_xml
+      Nokogiri::XML::Builder.new do |xml|
+        xml.Session Version: software_version, Samplerate: sample_rate do
+          xml.Info Subtitle: info.subtitle, Album: info.album, Composer: info.composer, Track: info.album_track, Genre: info.genre, Author: info.author, Link: info.link, Email: info.email, Description: info.description, Artist: info.artist, Date: info.date, Title: info.title, Explicit: info.explicit? ? 'YES' : 'NO', Copyright: info.copyright, Identifier: info.identifier, Keywords: info.keywords.join(', '), Reference: info.reference
+          xml.AudioPool Path: audio_pool.path, Location: audio_pool.location do
+            audio_pool.files.each do |file|
+              xml.File Id: file.id, Name: file.name, Duration: file.duration, Channels: file.num_channels, Leq: file.leq do
+                xml.MetaData OriginalPath: file.original_path
+              end
+            end
+          end
+          xml.Tracks do
+            tracks.each do |track|
+              xml.Track Name: track.name, Pan: track.pan do
+                track.regions.each do |region|
+                  xml.Region Ref: region.reference.id, Name: region.name, Start: region.start_time, Length: region.length, Offset: region.offset, FadeIn: region.fade_in, FadeOut: region.fade_out, Gain: region.gain, Leq: region.leq do
+                    region.fades.each do |fade|
+                      xml.Fade Start: fade.start_time, Length: fade.length, Gain: fade.gain
+                    end
+                  end
+                end
+                unless track.plugins.empty?
+                  xml.Plugins do
+                    track.plugins.each do |plugin|
+                      case plugin.uid
+                      when 'nheq'
+                        xml.Plugin Id: plugin.id, Name: plugin.name, UID: plugin.uid, Bypass: plugin.bypass, LF_Freq: plugin.low_freq_freq, LF_Gain: plugin.low_freq_gain, LF_Q: plugin.low_freq_q, LF_Type: plugin.low_freq_type, MF_Freq: plugin.mid_freq_freq, MF_Gain: plugin.mid_freq_gain, MF_Q: plugin.mid_freq_q, HF_Freq: plugin.high_freq_freq, HF_Gain: plugin.high_freq_gain, HF_Q: plugin.high_freq_q, HF_Type: plugin.high_freq_type do
+                          xml.cdata('')
+                        end
+                      when 'nhcl'
+                        xml.Plugin Id: plugin.id, Name: plugin.name, UID: plugin.uid, Comp: plugin.comp
+                      when 'nhlu'
+                        xml.Plugin Id: plugin.id, Name: plugin.name, UID: plugin.uid
+                      when 'nhft'
+                        xml.Plugin Id: plugin.id, Name: plugin.name, UID: plugin.uid, LF_Freq: plugin.low_freq_freq, LF_Gain: plugin.low_freq_gain, LF_Q: plugin.low_freq_q, MF_Freq: plugin.mid_freq_freq, MF_Gain: plugin.mid_freq_gain, MF_Q: plugin.mid_freq_q, HF_Freq: plugin.high_freq_freq, HF_Gain: plugin.high_freq_gain, HF_Q: plugin.high_freq_q, HP_Freq: plugin.high_pass_freq, HP_Gain: plugin.high_pass_gain, Comp: plugin.comp
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+          xml.Clipboard do
+            clipboard_groups.each do |group|
+              xml.Group Caption: group.caption, Used: group.num_clips_used do
+                group.clips.each do |clip|
+                  xml.Clip Ref: clip.reference.id, Name: clip.name, Length: clip.length, Leq: clip.leq
+                end
+              end
+            end
+          end
+          xml.Markers do
+            markers.each do |marker|
+              xml.Marker Id: marker.id, Name: marker.name, Time: marker.time
+            end
+          end
+        end
+      end.to_xml
+    end
 
   end
 end

data/lib/hindbaer/track.rb

@@ -21,7 +21,7 @@ module Hindbaer
     end
     
     def plugins
-      @doc.css('Plugin').map { |p| Hindbaer::Plugin.new(p.dup.unlink) }
+      @doc.css('Plugin').map { |p| Hindbaer::Plugin.create(p.dup.unlink) }
     end
   end
 end

data/lib/hindbaer/version.rb

@@ -1,3 +1,3 @@
 module Hindbaer
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/clip_spec.rb

@@ -22,7 +22,7 @@ describe Hindbaer::Clip do
   end
   
   it 'must return long-term equivalent level' do
-    @clip.leq.must_equal 0
+    @clip.leq.must_equal '-'
   end
   
   it 'must return parent group' do

data/spec/fixtures/project.nhsx

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
-<Session Version="Hindenburg Journalist Pro 1.12.1752" Samplerate="44100">
-  <Info Subtitle="Vestibulum Ante Ipsum Primis" Album="Nulla At Nulla" Composer="Quisque Eget Odio Ac" Track="1" Genre="Podcast" Author="Jamie Hodge" Link="http://" Email="user@example.com" Description="Etiam at risus et justo" Artist="Lorem Ipsum Dolor" Date="Today" Title="Suspendisse Dictum Feugiat Nisl Ut" Explicit="Yes" Copyright="2011" Identifier="Lorem Ipsum Dolor Sit" Keywords="In, Condimentum, Facilisis" Reference="Vivamus Hendrerit Arcu" />
+<Session Version="Hindenburg Journalist Pro 1.10.1742" Samplerate="44100">
+  <Info Subtitle="Vestibulum Ante Ipsum Primis" Album="Nulla At Nulla" Composer="Quisque Eget Odio Ac" Track="1" Genre="Podcast" Author="Jamie Hodge" Link="http://" Email="user@example.com" Description="Etiam at risus et justo" Artist="Lorem Ipsum Dolor" Date="Today" Title="Suspendisse Dictum Feugiat Nisl Ut" Explicit="Yes" Copyright="2011" Keywords="In, Condimentum, Facilisis" Identifier="Lorem Ipsum Dolor Sit" Reference="Vivamus Hendrerit Arcu"/>
   <AudioPool Path="Example session Files" Location="/Users/jamiehodge/Desktop">
     <File Id="1" Name="file1.wav" Duration="2:51:09.025" Channels="2" Leq="-10.4">
       <MetaData OriginalPath="/path/to/file1.wav"/>
@@ -12,7 +12,7 @@
       <MetaData OriginalPath="/path/to/file3.wav"/>
     </File>
     <File Id="4" Name="file4.wav" Duration="1:12:23.850" Channels="2" Leq="-16.2">
-      <MetaData OriginalPath="/path/to/file4.wav/>
+      <MetaData OriginalPath="/path/to/file4.wav"/>
     </File>
   </AudioPool>
   <Tracks>
@@ -22,16 +22,19 @@
       </Region>
       <Region Ref="1" Name="Speak 2" Start="44.171" Length="08.808" Offset="01:11.521" FadeIn="00.036" FadeOut="00.245" Gain="-0.8" Leq="-16.4"/>
       <Plugins>
-        <Plugin Id="0" Name="Equalizer" UID="nheq" Bypass="1" MF_Q="0.1" LF_Gain="0.5" HP_Freq="0.00454545" HP_Gain="0.2" HF_Q="0.1" MF_Gain="0.5" HF_Gain="0.5" HF_Freq="0.363636" HF_Type="0" MF_Freq="0.0454545" LF_Freq="0.00909091" LF_Q="0.1" LF_Type="0">
+        <Plugin Id="0" Name="Equalizer" UID="nheq" MF_Q="0.1" LF_Gain="0.5" HP_Freq="0.00454545" HP_Gain="0.2" HF_Q="0.1" MF_Gain="0.5" HF_Gain="0.5" HF_Freq="0.363636" HF_Type="0" MF_Freq="0.0454545" LF_Freq="0.00909091" LF_Q="0.1" LF_Type="0">
           <![CDATA[]]>
         </Plugin>
+        <Plugin Id="1" Name="Compressor" UID="nhcl" Comp="0.275"/>
+        <Plugin Id="2" Name="Loudness Meter" UID="nhlu"/>
+        <Plugin Id="3" Name="Voice Profiler" UID="nhft" MF_Q="0.12" LF_Gain="0.398302" HP_Freq="0.00181818" HP_Gain="0.365926" HF_Q="0.03" MF_Gain="0.35" HF_Gain="0.569759" HF_Freq="0.454545" Comp="0.15" MF_Freq="0.0381288" LF_Freq="0.00502632" LF_Q="0.12"/>
       </Plugins>
     </Track>
     <Track Name="Interview" Pan="0.025">
       <Region Ref="2" Name="Interview 1" Start="10.758" Length="33.553" FadeIn="00.085" Gain="1.2" Leq="-21.1"/>
       <Region Ref="2" Name="Interview 2" Start="58.078" Length="05.636" Offset="05.840" FadeIn="00.773" FadeOut="00.140" Gain="-3.7"/>
       <Plugins>
-        <Plugin Id="0" Name="Equalizer" UID="nheq" Bypass="1" MF_Q="0.1" LF_Gain="0.5" HP_Freq="0.00454545" HP_Gain="0.2" HF_Q="0.1" MF_Gain="0.5" HF_Gain="0.5" HF_Freq="0.363636" HF_Type="0" MF_Freq="0.0454545" LF_Freq="0.00909091" LF_Q="0.1" LF_Type="0">
+        <Plugin Id="0" Name="Equalizer" UID="nheq" Bypass="1" MF_Q="0.1" HP_Freq="0.00454545" LF_Gain="0.5" HP_Gain="0.5" HF_Q="0.1" MF_Gain="0.5" HF_Gain="0.5" HF_Freq="0.363636" HF_Type="0" MF_Freq="0.0454545" LF_Freq="0.00909091" LF_Q="0.1" LF_Type="0">
           <![CDATA[]]>
         </Plugin>
       </Plugins>
@@ -96,4 +99,4 @@
     <Marker Id="1" Name="In" Time="01:01.000"/>
     <Marker Id="2" Name="Out" Time="12:42.720"/>
   </Markers>
-</Session>
+</Session>

data/spec/info_spec.rb

@@ -55,6 +55,10 @@ describe Hindbaer::Info do
     @info.copyright.must_equal '2011'
   end
   
+  it 'must return genre' do
+    @info.genre.must_equal 'Podcast'
+  end
+  
   it 'must return whether explicit' do
     @info.explicit?.must_equal true
   end

data/spec/{plugin_spec.rb → plugin_base_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Hindbaer::Plugin do
+describe Hindbaer::Plugin::Base do
   
   before do
     project = Hindbaer::Session.new('spec/fixtures/project.nhsx')

data/spec/session_spec.rb

@@ -7,7 +7,7 @@ describe Hindbaer::Session do
   end
   
   it 'must return software version' do
-    @session.software_version.must_equal 'Hindenburg Journalist Pro 1.12.1752'
+    @session.software_version.must_equal 'Hindenburg Journalist Pro 1.10.1742'
   end
   
   it 'must return sample rate' do
@@ -41,4 +41,11 @@ describe Hindbaer::Session do
     @session.length.must_equal 10269.025000000001
   end
   
+  it 'must render itself as xml' do
+   File.open('/Users/jamiehodge/Desktop/untitled.nhsx', 'w') do |file|
+     file << @session.to_xml
+   end
+    @session.to_xml.must_equal File.open('spec/fixtures/project.nhsx').read
+  end
+  
 end

data/spec/track_spec.rb

@@ -21,8 +21,8 @@ describe Hindbaer::Track do
   end
   
   it 'must return all plugins' do
-    @track.plugins.first.must_be_kind_of Hindbaer::Plugin
-    @track.plugins.size.must_equal 1
+    @track.plugins.first.must_be_kind_of Hindbaer::Plugin::Base
+    @track.plugins.size.must_equal 4
   end
   
   it 'must return parent session' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hindbaer
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-24 00:00:00.000000000Z
+date: 2011-08-26 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70139580355740 !ruby/object:Gem::Requirement
+  requirement: &70144081230500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70139580355740
+  version_requirements: *70144081230500
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70139580355160 !ruby/object:Gem::Requirement
+  requirement: &70144081230080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70139580355160
+  version_requirements: *70144081230080
 - !ruby/object:Gem::Dependency
   name: guard-minitest
-  requirement: &70139580354440 !ruby/object:Gem::Requirement
+  requirement: &70144081229620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70139580354440
+  version_requirements: *70144081229620
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70139580353860 !ruby/object:Gem::Requirement
+  requirement: &70144081229180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70139580353860
+  version_requirements: *70144081229180
 - !ruby/object:Gem::Dependency
   name: growl_notify
-  requirement: &70139580353260 !ruby/object:Gem::Requirement
+  requirement: &70144081228620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70139580353260
+  version_requirements: *70144081228620
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70139580352660 !ruby/object:Gem::Requirement
+  requirement: &70144081228000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70139580352660
+  version_requirements: *70144081228000
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70139580352240 !ruby/object:Gem::Requirement
+  requirement: &70144081227520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,8 +87,8 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70139580352240
-description: A Hindenburg Journalist client
+  version_requirements: *70144081227520
+description: A Hindenburg Journalist parser
 email:
 - jamiehodge@me.com
 executables: []
@@ -110,6 +110,10 @@ files:
 - lib/hindbaer/info.rb
 - lib/hindbaer/marker.rb
 - lib/hindbaer/plugin.rb
+- lib/hindbaer/plugin/base.rb
+- lib/hindbaer/plugin/compressor.rb
+- lib/hindbaer/plugin/equalizer.rb
+- lib/hindbaer/plugin/voice_profiler.rb
 - lib/hindbaer/region.rb
 - lib/hindbaer/session.rb
 - lib/hindbaer/track.rb
@@ -122,7 +126,7 @@ files:
 - spec/group_spec.rb
 - spec/info_spec.rb
 - spec/marker_spec.rb
-- spec/plugin_spec.rb
+- spec/plugin_base_spec.rb
 - spec/region_spec.rb
 - spec/session_spec.rb
 - spec/spec_helper.rb
@@ -160,7 +164,7 @@ test_files:
 - spec/group_spec.rb
 - spec/info_spec.rb
 - spec/marker_spec.rb
-- spec/plugin_spec.rb
+- spec/plugin_base_spec.rb
 - spec/region_spec.rb
 - spec/session_spec.rb
 - spec/spec_helper.rb