hindbaer 0.0.4 → 0.0.5

data/README.markdown

@@ -24,7 +24,7 @@ Parse a session file:
     session.info.description
     session.info.author
     session.info.album
-    session.ínfo.album_track
+    session.ínfo.track
     session.info.keywords
     # etc.
     
@@ -36,15 +36,13 @@ Render Session object as xml:
     
 Retrieve all tracks:
 
-    tracks = session.tracks
-    track = tracks.first
+    track = session.tracks.first
     track.name
-    track.panning
+    track.pan
     
 Retrieve all track plugins:
 
-    plugins = track.plugins
-    plugin = plugins.first
+    plugin = track.plugins.first
     plugin.id
     plugin.name
     plugin.uid
@@ -53,11 +51,10 @@ There is currently support for the four default plugins and their attributes.
     
 Retrieve all regions for a given track:
 
-    regions = tracks.first.regions
-    region = region.first
-    region.reference # audio file reference
+    region = tracks.first.regions.first
+    region.ref # audio file reference
     region.name
-    region.start_time
+    region.start
     region.length
     region.offset
     region.fade_in
@@ -67,30 +64,26 @@ Retrieve all regions for a given track:
     
 Retrieve all fades for a given region:
 
-    fades = regions.first.fades
-    fade = fades.first
-    fade.start_time
+    fade = regions.first.fades.first
+    fade.start
     fade.length
     fade.gain
     
 Retrieve all clipboard groups and their clips:
 
-    groups = session.clipboard_groups
-    group = group.first
+    group = session.clipboard_groups.first
     group.caption
-    group.num_clips_used
+    group.used
     
-    clips = group.clips
-    clip = clips.first
-    clip.reference
+    clip = group.clips.first
+    clip.ref
     clip.name
     clip.length
     clip.leq # (long-term equivalent level)
     
 Retrieve all markers:
 
-    markers = session.markers
-    marker = markers.first
+    marker = session.markers.first
     marker.id
     marker.name
     marker.time
@@ -105,11 +98,20 @@ Retrieve all audio file references:
     file.id
     file.name
     file.duration
-    file.num_channels
+    file.channels
     file.leq # (long-term equivalent level)
-    file.dynamics
+    file.dyn
     file.original_path # original file path
     
+Add a new track:
+
+    new_track = Hindbaer::Track.new do |t|
+      t.name = 'Foo'
+      t.pan = '-1'
+    end
+    session.tracks << new_track
+    session.to_xml
+    
 License
 -------
 

data/lib/hindbaer/audio_pool.rb

@@ -1,20 +1,37 @@
 module Hindbaer
   class AudioPool
     
-    def initialize(fragment)
-      @doc = fragment
-    end
+    ATTRIBUTES = %w{
+      path location
+      }
+      
+    attr_accessor *ATTRIBUTES
+    attr_accessor :files
     
-    def path
-      @doc['Path']
+    def self.parse(doc)
+      new do
+        ATTRIBUTES.each do |attribute|
+          self.send("#{attribute.to_sym}=", doc[attribute.capitalize])
+        end
+        
+        self.files = doc.css('File').map do |f|
+          Hindbaer::File.parse(f)
+        end
+      end
     end
     
-    def location
-      @doc['Location']
+    def initialize(&block)
+      self.files = []
+      
+      block.arity > 0 ? block.call(self) : instance_eval(&block)
     end
     
-    def files
-      @doc.css('File').map { |f| Hindbaer::File.new(f.dup.unlink) }
+    def to_xml(xml)
+      xml.AudioPool Path: path, Location: location do
+        files.each do |file|
+          file.to_xml(xml)
+        end
+      end
     end
     
   end

data/lib/hindbaer/clip.rb

@@ -1,29 +1,27 @@
 module Hindbaer
   class Clip
     
-    def initialize(fragment, group)
-      @doc = fragment
-      @group = group
-    end
-    
-    attr_reader :group
+    ATTRIBUTES = %w{
+      ref name length leq
+      }
+      
+    attr_accessor *ATTRIBUTES
     
-    def reference
-      id = @doc['Ref'].to_i
-      self.group.session.audio_pool.files.find { |a| a.id == id }
+    def self.parse(doc)
+      new do
+        ATTRIBUTES.each do |attribute|
+          self.send("#{attribute.to_sym}=", doc[attribute.capitalize])
+        end
+      end
     end
     
-    def name
-      @doc['Name']
+    def initialize(&block)
+      block.arity > 0 ? block.call(self) : instance_eval(&block)
     end
     
-    def length
-      @doc['Length']
+    def to_xml(xml)
+      xml.Clip Ref: ref, Name: name, Length: length, Leq: leq
     end
     
-    def leq
-      return '-' if @doc['Leq'] == '-'
-      @doc['Leq'].to_f
-    end
   end
 end

data/lib/hindbaer/fade.rb

@@ -1,20 +1,26 @@
 module Hindbaer
   class Fade
     
-    def initialize(fragment)
-      @doc = fragment
-    end
+    ATTRIBUTES = %w{
+      start length gain
+      }
+      
+    attr_accessor *ATTRIBUTES
     
-    def start_time
-      @doc['Start']
+    def self.parse(doc)
+      new do
+        ATTRIBUTES.each do |attribute|
+          self.send("#{attribute.to_sym}=", doc[attribute.capitalize])
+        end
+      end
     end
     
-    def length
-      @doc['Length']
+    def initialize(&block)
+      block.arity > 0 ? block.call(self) : instance_eval(&block)
     end
     
-    def gain
-      @doc['Gain']
+    def to_xml(xml)
+      xml.Fade Start: start, Length: length, Gain: gain
     end
     
   end

data/lib/hindbaer/file.rb

@@ -1,36 +1,34 @@
 module Hindbaer
   class File
-    def initialize(fragment)
-      @doc = fragment
-    end
-    
-    def id
-      @doc['Id'].to_i
-    end
     
-    def name
-      @doc['Name']
-    end
+    ATTRIBUTES = %w{
+      id name duration
+      channels leq dyn
+      }
+      
+    attr_accessor *ATTRIBUTES
+    attr_accessor :original_path
     
-    def duration
-      @doc['Duration']
+    def self.parse(doc)
+      new do
+        ATTRIBUTES.each do |attribute|
+          self.send("#{attribute.to_sym}=", doc[attribute.capitalize])
+        end
+        
+        self.original_path = doc.at_css('MetaData')['OriginalPath'] if 
+          doc.at_css('MetaData')
+      end
     end
     
-    def num_channels
-      @doc['Channels'].to_i
+    def initialize(&block)
+      block.arity > 0 ? block.call(self) : instance_eval(&block)
     end
     
-    def leq
-      @doc['Leq'].to_f || 0
+    def to_xml(xml)
+      xml.File Id: id, Name: name, Duration: duration, Channels: channels, Leq: leq do
+        xml.MetaData OriginalPath: original_path
+      end
     end
     
-    def dynamics
-      @doc['Dyn'].to_f || 0
-    end
-    
-    def original_path
-      return unless md = @doc.at_css('MetaData')
-      md['OriginalPath']
-    end
   end
 end

data/lib/hindbaer/group.rb

@@ -1,23 +1,38 @@
 module Hindbaer
   class Group
     
-    def initialize(fragment, session)
-      @doc = fragment
-      @session = session
+    ATTRIBUTES = %w{
+      caption used
+    }
+
+    attr_accessor *ATTRIBUTES
+    attr_accessor :clips
+
+    def self.parse(fragment)
+      new do
+        ATTRIBUTES.each do |attribute|
+          self.send(
+            "#{attribute.to_sym}=",   
+            fragment[attribute.split('_').map(&:capitalize).join]
+          )
+        end
+        
+        self.clips = fragment.css('Clip').map { |c| Hindbaer::Clip.parse(c) }
+      end
     end
     
-    attr_reader :session
-    
-    def caption
-      @doc['Caption']
-    end
-    
-    def num_clips_used
-      @doc['Used'].to_i
+    def initialize(&block)
+      self.clips = []
+      
+      block.arity > 0 ? block.call(self) : instance_eval(&block)
     end
     
-    def clips
-      @doc.css('Clip').map { |c| Hindbaer::Clip.new(c.dup.unlink, self) }
+    def to_xml(xml)
+      xml.Group Caption: caption, Used: used do
+        clips.each do |clip|
+          clip.to_xml(xml)
+        end
+      end
     end
     
   end

data/lib/hindbaer/info.rb

@@ -1,80 +1,33 @@
 module Hindbaer
   class Info
     
-    def initialize(fragment)
-      @doc = fragment
-    end
-    
-    def name
-      @doc['Name']
-    end
-    
-    def title
-      @doc['Title']
-    end
-    
-    def subtitle
-      @doc['Subtitle']
-    end
-    
-    def author
-      @doc['Author']
-    end
-    
-    def link
-      @doc['Link']
-    end
-    
-    def email
-      @doc['Email']
-    end
-    
-    def description
-      @doc['Description']
-    end
-    
-    def album
-      @doc['Album']
-    end
-    
-    def album_track
-      @doc['Track']
-    end
-    
-    def artist
-      @doc['Artist']
-    end
-    
-    def composer
-      @doc['Composer']
-    end
-    
-    def date
-      @doc['Date']
-    end
-    
-    def genre
-      @doc['Genre']
-    end
-    
-    def copyright
-      @doc['Copyright']
-    end
-    
-    def explicit?
-      @doc['Explicit'] == 'Yes'
-    end
-    
-    def keywords
-      @doc['Keywords'].split(',').map { |k| k.strip }
-    end
-    
-    def identifier
-      @doc['Identifier']
-    end
-    
-    def reference
-      @doc['Reference']
+    ATTRIBUTES = %w{
+      name title subtitle author link email
+      description album track artist composer
+      date genre copyright explicit keywords
+      identifier reference
+      }
+      
+    attr_accessor *ATTRIBUTES
+    
+    def self.parse(fragment)
+      new do
+        ATTRIBUTES.each do |attribute|
+          self.send("#{attribute.to_sym}=", fragment[attribute.capitalize])
+        end
+        
+        self.keywords = keywords.split(',').map &:strip
+      end
+    end
+    
+    def initialize(&block)
+      self.keywords = []
+      
+      block.arity > 0 ? block.call(self) : instance_eval(&block)
+    end
+    
+    def to_xml(xml)
+      xml.Info Subtitle: subtitle, Album: album, Composer: composer, Track: track, Genre: genre, Author: author, Link: link, Email: email, Description: description, Artist: artist, Date: date, Title: title, Explicit: explicit, Copyright: copyright, Identifier: identifier, Keywords: keywords.join(', '), Reference: reference
     end
     
   end