lydown 0.12.4 → 0.14.0

data/lib/lydown/rendering/repeats.rb

@@ -0,0 +1,27 @@
+module Lydown::Rendering
+  class RepeatStart < Base
+    def translate
+      @context.emit(:music, "\\repeat volta #{@event[:count]} { ")
+    end
+  end
+  
+  class RepeatVolta < Base
+    def translate
+      @context['process/volta_count'] ||= 0
+      
+      if @context['process/volta_count'] == 0
+        @context.emit(:music, "} \\alternative { { ")
+      else
+        @context.emit(:music, "} { ")
+      end
+      @context['process/volta_count'] += 1
+    end
+  end
+  
+  class RepeatEnd < Base
+    def translate
+      @context['process/volta_count'] = nil
+      @context.emit(:music, "} } ")
+    end
+  end
+end

data/lib/lydown/rendering/settings.rb

@@ -7,13 +7,13 @@ module Lydown::Rendering
   class Setting < Base
     include Notes
     
-    SETTING_KEYS = [
-      'key', 'time', 'pickup', 'clef', 'part', 'movement', 'tempo',
-      'accidentals', 'beams', 'end_barline', 'macros', 'empty_staves',
-      'midi_tempo', 'instrument_names', 'instrument_name_style',
-      'parts', 'score', 'movement_source', 'colla_parte', 'include',
-      'mode', 'nomode', 'bar_numbers', 'document', 'notation_size'
-    ]
+    SETTING_KEYS = %w{
+      key time pickup clef part movement tempo accidentals beams end_barline 
+      macros empty_staves midi_tempo instrument_names instrument_name_style 
+      parts score movement_source colla_parte include require mode nomode 
+      bar_numbers document notation_size work transpose editions layout
+      movement_title
+    }
 
     RENDERABLE_SETTING_KEYS = [
       'key', 'time', 'clef', 'beams'
@@ -25,7 +25,7 @@ module Lydown::Rendering
       'empty_staves' => ['hide', 'show'],
       'instrument_names' => ['hide', 'show', 'inline', 'inline-right-align', 'inline-center-align'],
       'instrument_name_style' => ['normal', 'smallcaps'],
-      'page_break' => ['none', 'before', 'after', 'before and after', 'blank page before'],
+      'page_break' => ['none', 'before', 'after', 'before and after', 'blank page before', 'bookpart before'],
       'mode' => ['score', 'part', 'none'],
       'bar_numbers' => ['hide', 'shows'],
       'notation_size' => ['huge', 'large', 'normalsize', 'small', 'tiny', 'teeny']
@@ -38,7 +38,7 @@ module Lydown::Rendering
       end
       
       key = @event[:key]
-      value = @event[:value]
+      value = @event[:value] && @event[:value].gsub("\\n", "\n")
       level = @event[:level] || 0
       
       unless (level > 0) || SETTING_KEYS.include?(key)
@@ -67,6 +67,8 @@ module Lydown::Rendering
           @context.reset(:movement)
         when 'include'
           add_include(:includes, value)
+        when 'require'
+          add_require(:requires, value)
         when 'mode'
           set_mode(value.nil? ? :none : value.to_sym)
         when 'nomode'
@@ -87,6 +89,12 @@ module Lydown::Rendering
         case key
         when 'include'
           add_include(path + 'includes', value)
+        when 'require'
+          add_require(path + 'requires', value)
+        when 'lyrics_markup_file'
+          set_lyrics_markup(path, value)
+        when 'order' # staff order
+          set_staff_order(path, value)
         else
           path << key
           @context.set_setting(path, value)
@@ -163,6 +171,11 @@ module Lydown::Rendering
       @context['process/mode'] = (mode == :none) ? nil : mode
     end
     
+    def set_staff_order(path, order)
+      order = order.split(',').map {|s| s.strip}
+      @context.set_setting("#{path}order", order)
+    end
+    
     def add_include(includes_path, path)
       includes = @context.get_current_setting(includes_path) || []
 
@@ -180,6 +193,20 @@ module Lydown::Rendering
 
       @context.set_setting(includes_path, includes)
     end
+    
+    def set_lyrics_markup(path, fn)
+      source_filename = @context['process/last_filename']
+      if source_filename
+        fn = File.expand_path(File.join(File.dirname(source_filename), fn))
+      end
+      @context.set_setting("#{path}lyrics_markup", IO.read(fn))
+    end
+
+    def add_require(requires_path, package)
+      requires = @context.get_current_setting(requires_path) || []
+      requires << package
+      @context.set_setting(requires_path, requires)
+    end
   end
 end
 

data/lib/lydown/rendering/skipping.rb

@@ -2,12 +2,20 @@ module Lydown::Rendering
   PROOFING_LY_SETTINGS = <<EOF
     \\paper {
       indent=0\\mm
-      line-width=110\\mm
       oddFooterMarkup=##f
       oddHeaderMarkup=##f
       bookTitleMarkup = ##f
       scoreTitleMarkup = ##f
-      page-breaking = #ly:minimal-breaking
+      page-breaking = #ly:minimal-breaking %#ly:one-line-auto-height-breaking
+      top-margin=10\\mm
+      bottom-margin=10\\mm
+    }
+
+    \\layout {
+      \\context {
+        \\Score
+        \\remove "Bar_number_engraver"
+      }  
     }
 EOF
   

data/lib/lydown/rendering/staff.rb

@@ -1,7 +1,12 @@
 module Lydown::Rendering
   module Staff
     def self.staff_groups(context, opts, parts)
+      if context.render_mode == :part
+        opts = opts.merge(part: context['render_opts/parts'])
+      end
+      
       model = context.get_setting('score/order', opts)
+      
       parts_copy = parts.clone
       
       groups = []
@@ -23,43 +28,38 @@ module Lydown::Rendering
       groups
     end
     
-    SYSTEM_START = {
-      "brace" => "SystemStartBrace",
-      "bracket" => "SystemStartBracket"
-    }
+    # returns a hierarchy of staffgroups, each containing group configuration
+    # and a list of parts
+    def self.staff_group_hierarchy(context, staff_groups)
+      staff_groups.map {|group|
+        {
+          class: 'StaffGroup',
+          config: staff_group_config(context, group),
+          parts:  group
+        }
+      }
+    end
     
-    BRACKET_PARTS = %w{soprano alto tenore basso soprano1 soprano2 
-      alto1 alto2 tenore1 tenore2 basso1 basso2}
+    VOCAL_GROUP_SPAN_BAR_OVERRIDE = 
+      "\\override SpanBar #'break-visibility = #'#( #t #f #t )"
     
-    def self.staff_group_directive(group)
-      if group.size == 1
-        nil
-      elsif BRACKET_PARTS.include?(group.first)
-        "SystemStartBracket"
+    def self.staff_group_config(context, group)
+      if is_vocal_group?(group)
+        VOCAL_GROUP_SPAN_BAR_OVERRIDE
       else
-        "SystemStartBrace"
+        ''
       end
     end
     
-    # renders a systemStartDelimiterHierarchy expression
-    def self.staff_hierarchy(staff_groups)
-      directive = nil
-      expr = staff_groups.inject('') do |m, group|
-        directive = staff_group_directive(group)
-        if directive
-          m << "(#{directive} #{group.join(' ')}) "
-        else
-          m << "#{group.join(' ')} "
-        end
-        m
-      end
-      
-      if (staff_groups.size == 1) && (staff_groups[0].size > 1) && directive == "SystemStartBracket"
-        # If all staves are already group, no need to add the system bracket
-        "#'#{expr}"
-      else
-        "#'(SystemStartBar #{expr})"
-      end
+    VOCAL_PARTS = %w{
+      soprano alto tenore basso soprano1 soprano2 alto1 alto2 tenore1 tenore2
+      basso1 basso2 1soprano 2soprano 1alto 2alto 1tenore 2tenore 1basso 2basso
+      1soprano1 1soprano2 2soprano1 2soprano2 1alto1 1alto2 2alto1 2alto2
+      1tenore1 1tenore2 2tenore1 2tenore2 1basso1 1basso2 2basso1 2basso2
+    }
+    
+    def self.is_vocal_group?(group)
+      !!group.find {|part| VOCAL_PARTS.include? part }
     end
     
     def self.clef(context, opts)
@@ -105,6 +105,13 @@ module Lydown::Rendering
       title.strip
     end
     
+    def self.heading_part_title(context, opts)
+      title = context.get_setting("parts/#{opts[:part]}/heading_title", opts) ||
+              context.get_setting("parts/#{opts[:part]}/title", opts) ||
+              Lydown::Rendering.default_part_title(opts[:part])
+      title.strip
+    end
+    
     def self.part_title(context, opts)
       title = qualified_part_title(context, opts)
 

data/lib/lydown/rendering/voices.rb

@@ -11,7 +11,7 @@ module Lydown::Rendering
     def self.render_voices(context)
       context['process/voice_selector'] = nil
       
-      music = Lydown::Templates.render(:multi_voice, context, part: context[:part])
+      music = Inverso::Template.render(:multi_voice, context: context, part: context[:part])
       
       context.emit(:music, music)
       

data/lib/lydown/templates.rb

@@ -3,29 +3,29 @@ require 'erb'
 module Lydown
   module Templates
     TEMPLATES_DIR = File.join(File.dirname(__FILE__), 'templates')
-    
+
     @@templates = {}
-    
+
     def self.render(name, ctx, locals = {})
       _binding = ctx.respond_to?(:template_binding) ? ctx.template_binding(locals) : binding
 
       # remove trailing white space and superfluous new lines
       template(name).result(_binding).gsub(/^\s+$/, '').gsub(/\n+/m, "\n")
     end
-    
+
     def self.template(name)
       @@templates[name] ||= load_template(name)
     end
-    
+
     def self.load_template(name)
-      fn = name.is_a?(Symbol) ? 
+      fn = name.is_a?(Symbol) ?
         File.join(TEMPLATES_DIR, "#{name}.erb") :
         name
-      
+
       ERB.new IO.read(fn), 0, '<>'
     end
   end
-  
+
   module TemplateBinding
     # Used to bind to instance when rendering templates
     def template_binding(locals = {})
@@ -34,4 +34,4 @@ module Lydown
       b
     end
   end
-end
+end

data/lib/lydown/templates/layout.rb

@@ -0,0 +1,40 @@
+info = Lydown::Rendering.layout_info(context)
+return unless info
+
+layout = Lydown::Rendering::Layout
+
+pp  = lambda {|k| layout.to_pp(info[k])}
+m   = lambda {|k, d = nil| layout.fmt(info[k] || d)}
+v   = lambda {|k| layout.to_v(info[k])}
+
+vertical_margins = layout.calculate_vertical_margins(info).join(" ")
+`
+\paper {
+  {{?false}}
+  annotate-spacing = ##t
+  {{/}}
+
+  {{layout.define_paper_size(info)}}
+  #(layout-set-staff-size {{pp[:staff_size]}})
+
+  %indent = {{m[:indent, '0mm']}}
+
+  {{?info[:margin_inner]}}
+  two-sided = ##t
+  inner-margin = {{m[:margin_inner]}}
+  outer-margin = {{m[:margin_outer]}}
+  binding-offset = 0\mm
+  {{/}}
+
+  top-margin = {{m[:margin_top]}}
+  bottom-margin = {{m[:margin_bottom]}}
+}
+\setVerticalMargins {{vertical_margins}}
+
+\layout {
+  \context {
+    \Score
+    \remove "Bar_number_engraver"
+  }
+}
+`

data/lib/lydown/templates/lilypond_doc.rb

@@ -0,0 +1,95 @@
+`
+\version "2.18.2"
+
+{{? context.render_mode}}
+#(define lydown:render-mode '{{context.render_mode}})
+{{/}}
+
+{{? !context['render_opts/no_lib']}}
+\pinclude "{{File.join(LY_LIB_DIR, 'lib.ly')}}"
+{{/}}
+`
+
+Lydown::Rendering.get_set_variables(context).each do |k, v|
+`
+#(define lydown:{{k}} {{v}})
+`
+end
+
+proof_mode = context.render_mode == :proof
+
+includes = Lydown::Rendering.include_files(context, {})
+includes.each {|i| __emit__[i, " "]}
+
+if proof_mode
+  __emit__[Lydown::Rendering::PROOFING_LY_SETTINGS]
+end
+
+unless context['render_opts/no_layout']
+  __render__(:layout, _)
+end
+
+packages = Lydown::Rendering.packages_to_load(context, {})
+packages.each do |p|
+`
+\require "{{p}}"
+`
+end
+
+__render__(:variables, _)
+
+work = context.get_setting('work', {}) || {}
+markup = lambda {|m| Lydown::Rendering::Markup.convert(m) }
+part_title =  (context.render_mode == :part) &&
+              (part = context['render_opts/parts']) &&
+              Lydown::Rendering::Staff.heading_part_title(context, part: part)
+doc_page_break = (context.render_mode == :part) ?
+  context.get_setting("parts/#{context['render_opts/parts']}/document/page_break", {}) :
+  context.get_setting("#{context.render_mode}/document/page_break", {})
+
+`
+{{? !proof_mode}}
+\book {
+{{/}}
+  {{?doc_page_break == 'blank page before'}}
+  \paper {
+     first-page-number = #-1
+  }
+  {{/}}
+  \header {
+    {{?t = work[:composer]}}composer = {{markup[t]}}{{/}}
+    {{?t = work[:opus]}}opus = {{markup[t]}}{{/}}
+    {{?t = work[:title]}}title = {{markup[t]}}{{/}}
+    {{?t = work[:subtitle]}}subtitle = {{markup[t]}}{{/}}
+    {{?t = work[:source]}}source = {{markup[t]}}{{/}}
+    {{?t = work[:edition]}}edition = {{markup[t]}}{{/}}
+    {{?part_title}}instrument = {{markup[part_title]}}{{/}}
+  }
+
+  {{? !proof_mode}}
+  \bookpart {
+  {{/}}
+
+  {{?doc_page_break == 'before'}}
+  \pageBreak
+  {{/}}
+
+  {{?doc_page_break == 'blank page before'}}
+    \paper { oddHeaderMarkup = ##f evenHeaderMarkup = ##f }
+    \markup " "
+  } \bookpart {
+    \paper { oddHeaderMarkup = ##f evenHeaderMarkup = ##f
+      bookTitleMarkup = ##f } \markup { " " }
+  } \bookpart {
+    \paper { bookTitleMarkup = ##f }
+  {{/}}
+`
+
+context['movements'].each do |n, m|
+  __render__(:movement, context: context, name: n, movement: m)
+end
+`
+{{? !proof_mode}}
+} }
+{{/}}
+`

data/lib/lydown/templates/movement.rb

@@ -0,0 +1,188 @@
+render_mode = context.render_mode
+staff_groups = Lydown::Rendering::Staff.staff_groups(
+  context, {movement: name}, movement['parts'].keys)
+parts_in_order = staff_groups.flatten
+
+staff_group_hierarchy = Lydown::Rendering::Staff.staff_group_hierarchy(context, staff_groups)
+
+
+parts = parts_in_order.inject({}) do |m, p|
+  m[p] = movement['parts'][p]
+  m
+end
+
+score_mode = (render_mode == :score) ||
+  (render_mode == :proof) || (parts.size > 1)
+
+tacet = Lydown::Rendering::Movement.tacet?(context, name)
+movement_title = Lydown::Rendering::Movement.movement_title(context, name)
+movement_source = context.get_setting(:movement_source , movement: name)
+lyrics_markup = Lydown::Rendering.lyrics_markup(context, movement: name)
+
+format = context['options/format'] || context['render_opts/format'] || :pdf
+midi_mode = (format == :midi) || (format == :mp3)
+
+empty_staves = context.get_setting(:empty_staves, movement: name)
+
+page_breaks = Lydown::Rendering::Movement.page_breaks(context, movement: name)
+
+includes = Lydown::Rendering.include_files(context, movement: name)
+
+packages = Lydown::Rendering.packages_to_load(context, movement: name)
+
+hide_bar_numbers = Lydown::Rendering::Movement.hide_bar_numbers?(
+  context, movement: name
+)
+
+if page_breaks[:blank_page_before]
+`
+} \bookpart {
+  \paper { bookTitleMarkup = ##f }
+  \markup \column {
+  \null \null \null \null \null \null
+  \null \null \null \null \null \null
+  \null \null \null \null \null \null
+  \null \null \null \null \null \null
+  \fill-line { "(this page has been left blank to facilitate page turning)" }
+  }
+} \bookpart {
+  \paper { bookTitleMarkup = ##f }
+  \pageBreak
+`
+elsif page_breaks[:before]
+`
+\pageBreak
+`
+elsif page_breaks[:bookpart_before]
+`
+} \bookpart {
+  \paper { bookTitleMarkup = ##f }
+`
+end
+
+packages.each do |p|
+`
+\require "{{p}}"
+`
+end
+
+includes.each {|i| __emit__[i, " "]}
+
+unless tacet
+  `
+  \score {
+  `
+  if movement_title && render_mode != :proof
+    `
+      \header {
+        piece = {{movement_title.inspect}}
+        {{?movement_source}}
+        movement-source = {{movement_source.inspect}}
+        {{/}}
+        {{?lyrics_markup}}
+        lyrics-markup = {{lyrics_markup}}
+        {{/}}
+      }
+    `
+  end
+
+  layout = Lydown::Rendering.layout_info(context, movement: name)
+  ragged_right =  layout[:ragged_right] == "true"
+  ragged_last =   layout[:ragged_last] == "true"
+  `
+  {{?n = movement['bar_number']}}
+  \set Score.currentBarNumber = {{n}}
+  \set Score.barNumberVisibility = #all-bar-numbers-visible
+  \bar ""
+  {{/}}
+
+  \new OrchestraGroup \with {
+  } <<
+  `
+
+  first_staff = true
+  staff_group_hierarchy.each do |group|
+    `
+    \new {{group[:class]}} \with {
+      {{?first_staff}}
+      \consists "Bar_number_engraver"
+      {{/}}
+      {{group[:config]}}
+    } <<
+    `
+
+    group[:parts].each do |part_name|
+      part = movement['parts'][part_name]
+      __render__(:part, context: context, name: part_name, part: part,
+        movement_name: name, movement: movement)
+    end
+    first_staff = false
+
+    `
+    >>
+    `
+  end
+
+  `
+  >>
+  `
+
+  if midi_mode
+    `
+    \midi {
+      {{? tempo = context.get_setting(:midi_tempo, movement: name)}}
+        \tempo {{tempo}}
+      {{/}}
+    }
+    `
+  end
+
+  `
+
+    \layout {
+      {{?ragged_right}}ragged-right = ##t{{/}}
+      {{?ragged_last}}ragged-last = ##t{{/}}
+
+      {{?score_mode && (empty_staves == 'hide')}}
+      \context {
+        \RemoveEmptyStaffContext
+        \override VerticalAxisGroup #'remove-first = ##t
+      }
+      {{/}}
+
+      {{?layout[:system_count]}}
+      system-count = {{layout[:system_count]}}
+      {{/}}
+
+      {{?hide_bar_numbers}}
+      \context {
+        \Score
+        \omit BarNumber
+      }
+      {{/}}
+
+      {{?layout[:indent]}}
+      indent = {{Lydown::Rendering::Layout.fmt(layout[:indent])}}
+      {{/}}
+    }
+  }
+  `
+else # tacet
+`
+  \score {
+    \header {
+      piece = {{movement_title.inspect}}
+      {{?lyrics_markup}}
+      lyrics-markup = {{lyrics_markup}}
+      {{/}}
+    }
+    \tacetScore
+  }
+`
+end
+
+if page_breaks[:after]
+`
+\pageBreak
+`
+end