live_set 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40ccc8116bfe826b52087a95ccdda582b948c7312be95eb282f17c5da7a24c86
-  data.tar.gz: e97386a24aa9dbcee91080e07cd2c9cc4331b65dab5b5080cbd0665b058de37a
+  metadata.gz: 9caef58c0bed30ead696f9d64848c74038aa520d83a2c47796cb0081c0ad6b14
+  data.tar.gz: 85906715baa37c0ed5a2fd4f0a101e37d5c5728a4385f0754d120514b18d7b89
 SHA512:
-  metadata.gz: 90def6a620d141ee67449c7c4f66345d65aea8cad97a5ce0a37a8095e223b2ffc214825a5c10e81aa96e62c141fb6ba0df05cc0f3bb56bbf9f115238cad4fed3
-  data.tar.gz: 1f2e4ffa6e835d7021fe5e2d124a758b9cc629071cc1f5d1517cf20915640932966a433f867b92dc1083261aecb8b8fc748c5031dadaef0935a327af4ef9760a
+  metadata.gz: 88404bf0b8d04663da0d7a334a8affd9d930df965af1b3fed1b3a2b9286881380ecba7882badbf71d0612674a3f77775a436a6e5a505a4bb9b25801522ad5ab6
+  data.tar.gz: d633040d514b77e4984e936c4676fd5f124ee30da405b6c612f916edbd33625cbacb0a1d35812aaae393f03436cab2054144e54a75db1214ba64196c92511cf4

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Change Log
 
+
+## 0.2.1
+
+* Corrected missing help method for the `live_set` command.
+* Prompts user if they want the extra directory renamed to `Ableton Project Info-`.
+
+
+## 0.2.0
+
+* Checks `Ableton Project Info` validity all up the directory tree.
+* Reports the clips in the set, and their sizes.
+* Generates a warning if the total size of the clips might cause freezing to fail.
+
+
 ## 0.1.0
 
 * Initial release.

data/README.md

@@ -1,7 +1,14 @@
 # `Live_set` [![Gem Version](https://badge.fury.io/rb/live_set.svg)](https://badge.fury.io/rb/live_set)
 
-This program can report the version of an Ableton Live set,
-and it can changes an Ableton Live set from Live 12 format to Live 11 format.
+This program can:
+
+1. Report the version compatibility of an Ableton Live set.
+2. Display the location and size of the samples in each track.
+3. Shows frozen tracks.
+4. Make a copy of an Ableton Live 12 set and save to Live 11 format.
+5. Detect environmental problems, for example unwanted directories called `Ableton Project Info` in parent directories.
+6. Detect sets that are too large to be frozen, which means they are too large to transfer to Push 3 Standalone.
+7. Detect tracks that are not frozen, which means they are not ready to be transferred to Push 3 Standalone.
 
 This program has successfully converted the Ableton Live 12 demo project to Live 11.
 
@@ -14,19 +21,24 @@ Simply type:
 $ gem install live_set
 ```
 
+If the above does not work because you need to install Ruby, please
+[follow these instructions](https://www.mslinn.com/ruby/1000-ruby-setup.html).
+
 
 ## Usage
 
-```shell
+```text
 $ live_set
-Displays information about a Live set or converts a Live 12 set to Live 11 format.
+Displays information about a Live set or converts a copy of a Live 12 set in Live 11 format.
+Also verifies that 'Ableton Project Info' is in the same directory as the .als file,
+and there is no parent directory with a directory of that name.
 
 Syntax: live_set OPTIONS PATH_TO_ALS_FILE
 
 Environment variables used in PATH_TO_ALS_FILE are expanded.
 
 Options are:
-  -11 Convert the Live 12 set to Live 11 format.
+  -11 Convert a copy of the Live 12 set to Live 11 format.
   -f Overwrite any existing Live 11 set.
   -h Display this help message.
 
@@ -36,24 +48,53 @@ Example:
 
 ### Report
 
-Report the version of the Ableton Live set:
-
-```shell
-$ live_set $path/to/my_set.als
-/mnt/c/media/Ableton/Projects/fu Project/fu.als
-  Created by Live v11.0_11300
-  Major version 11.0_11300
-  Revision 5ac24cad7c51ea0671d49e6b4885371f15b57c1e
-  SchemaChangeCount 3
-Tracks:
-  Drums / complete
-  Bass
-  Guitar
-  Horns
-  Keys
-  Vocal Backing
-  Vocal Lead
-  Strings
+Report the version of the [Ableton Live 12 Demo Project](https://help.ableton.com/hc/en-us/articles/209774005-Location-of-the-default-Demo-Set):
+
+```text
+$ live_set "$ableton_media/Projects/Ableton Live 12 Demo Project/Ableton Live 12 Demo.als"
+/mnt/e/media/Ableton/Projects/Ableton Live 12 Demo Project/Ableton Live 12 Demo.als
+  Created by Ableton Live 12.0
+  Major version 5
+  Minor version v12.0_12049
+  SchemaChangeCount 7
+  Revision 5094b92fa547974769f44cf233f1474777d9434a
+Total set size: 312.5 MB
+Warning: some tracks are not frozen, so this set should not be transferred to Push 3 Standalone.
+4 tracks:
+  Track 'Vocal Main' (12 clips, totaling 154.0 MB)
+    Samples/Imported/Vocal Patience Main.wav   12.8 MB  2024-01-31 22:00:34
+    Samples/Imported/Vocal Patience Main.wav   12.8 MB  2024-01-31 22:00:34
+    Samples/Imported/Vocal Patience Main.wav   12.8 MB  2024-01-31 22:00:34
+    Samples/Imported/Vocal Patience Main.wav   12.8 MB  2024-01-31 22:00:34
+    Samples/Imported/Vocal Patience Main.wav   12.8 MB  2024-01-31 22:00:34
+    Samples/Imported/Vocal Patience Main.wav   12.8 MB  2024-01-31 22:00:34
+    Samples/Imported/Vocal Patience Main.wav   12.8 MB  2024-01-31 22:00:34
+    Samples/Imported/Vocal Patience Main.wav   12.8 MB  2024-01-31 22:00:34
+    Samples/Imported/Vocal Patience Main.wav   12.8 MB  2024-01-31 22:00:34
+    Samples/Imported/Vocal Patience Main.wav   12.8 MB  2024-01-31 22:00:34
+    Samples/Imported/Vocal Patience Main.wav   12.8 MB  2024-01-31 22:00:34
+    Samples/Imported/Vocal Patience Main.wav   12.8 MB  2024-01-31 22:00:34
+
+  Track 'Vocal Harmony' (12 clips, totaling 154.0 MB)
+    Samples/Imported/Vocal Patience Harmony.wav   12.8 MB  2024-01-31 22:00:04
+    Samples/Imported/Vocal Patience Harmony.wav   12.8 MB  2024-01-31 22:00:04
+    Samples/Imported/Vocal Patience Harmony.wav   12.8 MB  2024-01-31 22:00:04
+    Samples/Imported/Vocal Patience Harmony.wav   12.8 MB  2024-01-31 22:00:04
+    Samples/Imported/Vocal Patience Harmony.wav   12.8 MB  2024-01-31 22:00:04
+    Samples/Imported/Vocal Patience Harmony.wav   12.8 MB  2024-01-31 22:00:04
+    Samples/Imported/Vocal Patience Harmony.wav   12.8 MB  2024-01-31 22:00:04
+    Samples/Imported/Vocal Patience Harmony.wav   12.8 MB  2024-01-31 22:00:04
+    Samples/Imported/Vocal Patience Harmony.wav   12.8 MB  2024-01-31 22:00:04
+    Samples/Imported/Vocal Patience Harmony.wav   12.8 MB  2024-01-31 22:00:04
+    Samples/Imported/Vocal Patience Harmony.wav   12.8 MB  2024-01-31 22:00:04
+    Samples/Imported/Vocal Patience Harmony.wav   12.8 MB  2024-01-31 22:00:04
+
+  Track 'Vocal Hum' (1 clips, totaling 2.9 MB)
+    Samples/Imported/Vocal Patience Hum.wav    2.9 MB  2024-01-31 22:03:22
+
+  Track 'Vocal Adlib' (2 clips, totaling 1.7 MB)
+    Samples/Imported/Vocal Patience Adlib.wav  827.9 kB  2024-01-31 22:00:22
+    Samples/Imported/Vocal Patience Adlib.wav  827.9 kB  2024-01-31 22:00:22
 ```
 
 
@@ -68,18 +109,19 @@ $ live_set -11 -f path/to/my_set.als
 
 ## Development
 
-After checking out this git repository, install dependencies by typing:
+After checking out this git repository, install dependencies by running `bin/setup`:
 
-```shell
+```text
+$ git clone https://github.com/mslinn/live_set
+$ cd live_set
 $ bin/setup
+$ code .  # Run Visual Studio Code
 ```
 
-You should do the above before running Visual Studio Code.
-
 
 ### Run the Tests
 
-```shell
+```text
 $ bundle exec rake test
 ```
 
@@ -106,7 +148,7 @@ $ bin/console
 
 To install this gem onto your local machine, type:
 
-```shell
+```text
 $ bundle exec rake install
 ```
 

data/als_notes.md

@@ -0,0 +1,58 @@
+# ALS Filetype Notes
+
+```xml
+$ zcat '/mnt/e/media/Ableton/Projects/fu Project/fu.als' | less -N
+      3   <LiveSet>
+      8     <Tracks>
+      9       <AudioTrack Id="8">
+     44         <DeviceChain>
+    247           <MainSequencer>
+    278             <ClipSlotList>
+    279               <ClipSlot Id="14">
+    280                 <LomId Value="0" />
+    281                 <ClipSlot>
+    282                   <Value>
+    283                     <AudioClip Id="0" Time="0">
+    353                       <SampleRef>
+    354                         <FileRef>
+    355                           <RelativePathType Value="3" />
+    356                           <RelativePath Value="Samples/Imported/song1.mp3" />
+    357                           <Path Value="E:/media/Ableton/Projects/fu Project/Samples/Imported/song1.mp3" />
+    358                           <Type Value="1" />
+    359                           <LivePackName Value="" />
+    360                           <LivePackId Value="" />
+    361                           <OriginalFileSize Value="3626186" />  # Bytes
+    362                           <OriginalCrc Value="47766" />
+    363                         </FileRef>
+    364                         <LastModDate Value="1707598944" />  # Epoch timestamp -> Sat Feb 10 16:02:24 EST 2024
+    365                         <SourceContext />
+    366                         <SampleUsageHint Value="0" />
+    367                         <DefaultDuration Value="10809120" />
+    368                         <DefaultSampleRate Value="48000" />
+    369                       </SampleRef>
+```
+
+
+```text
+@audiotrack = LiveSet.Tracks.AudioTrack.
+  DeviceChain.MainSequencer.ClipSlotList.ClipSlot.children.
+    ClipSlot.Value.children. # Passed to LiveAudioClip
+      SampleRef.FileRef
+        Path['Value']  # Absolute path
+        RelativePath['Value']
+        OriginalFileSize['Value'] # Bytes
+```
+
+
+Clip paths can look like this:
+
+```text
+    # @audio_track.DeviceChain.FreezeSequencer.ClipSlotList.ClipSlot
+    # @audio_track.DeviceChain.Mixer.ClipSlotList.ClipSlot
+    # @audio_track.xpath('//Path').map{|x| x['Value']}.uniq # Gives results like:
+    #   "E:/media/Ableton/Projects/fu Project/Samples/Processed/Freeze/Freeze Guitar [2024-03-12 133812].wav"
+    #   "E:/media/Ableton/Projects/fu Project/Samples/Imported/smooth_operator_horns.mp3"
+    #   "/Reverb Default.adv"
+    #   "/Users/nsh/Library/Application Support/Ableton/Live 11 Core Library/Devices/Audio Effects/Simple Delay/Dotted Eighth Note.adv"
+    #   "E:/media/Ableton/Projects/fu Project/Audio Effects/Color Limiter/Ableton Folder Info/Color Limiter.amxd"
+```

data/exe/als_delta

@@ -0,0 +1,8 @@
+#!/bin/env ruby
+
+if ENV['VO_DEBUGGING']
+  require_relative '../lib/live_set'
+else
+  require 'live_set'
+end
+als_delta

data/exe/live_set

@@ -5,11 +5,4 @@ if ENV['VO_DEBUGGING']
 else
   require 'live_set'
 end
-
-require 'colorator'
-require_relative '../lib/options'
-
-def common(command)
-  @options = parse_options command
-  help_show 'Ableton Live set name must be provided.' if ARGV.empty?
-end
+live_set

data/lib/als_delta/als_delta_class.rb

@@ -0,0 +1,60 @@
+require 'date'
+require 'fileutils'
+require 'highline'
+require 'shellwords'
+require_relative '../common/run'
+
+class AlsDelta
+  include Run
+
+  def initialize(set_name, **options)
+    @options = options
+    @loglevel  = "-loglevel #{@options[:loglevel]}"
+    @loglevel += ' -stats' unless @options[:loglevel] == 'quiet'
+    @set_name = set_name
+
+    @set_dir = File.dirname set_name
+    @set_name_only = File.basename set_name, '.als'
+  end
+
+  def backup_name
+    @backup_name = if @options[:keep]
+                     timestamp = Time.now.getutc.strftime '%Y-%m-%d_%H:%M:%S'
+                     "#{@set_dir}/#{@set_name_only}_#{timestamp}.als"
+                   else
+                     "#{@set_dir}/#{@set_name_only}_backup.als"
+                   end
+  end
+
+  def backup_set
+    @backup_name = backup_name
+    puts "Backing up Live set to '#{@backup_name}'"
+    FileUtils.cp @set_name, @backup_name
+  end
+
+  def cleanup
+    return if @options[:keep] || !@backup_name
+    return unless File.exist? @backup_name
+
+    puts "Deleting '#{@backup_name}'"
+    File.delete @backup_name
+  end
+
+  def show
+    backup_set
+    loop do
+      puts 'Press any key to display the changes to the Live set XML file, or press Esc to exit.'
+      character = $stdin.getch
+      exit if character.ord == 27
+      output = run_capture_stdout "GZIP=--no-name zdiff #{@set_name.shellescape} #{@backup_name.shellescape}"
+      if output.empty?
+        puts 'There were no changes to the saved live set.'
+      else
+        puts output.join("\n")
+        backup_set
+      end
+    rescue StandardError => e
+      puts e
+    end
+  end
+end

data/lib/als_delta/als_delta_options.rb

@@ -0,0 +1,58 @@
+require 'colorator'
+require 'optparse'
+
+VERBOSITY = %w[trace debug verbose info warning error fatal panic quiet].freeze unless defined? VERBOSITY
+
+def common(command)
+  @options = parse_options command
+  help_als_delta 'An Ableton Live set name must be provided.' if ARGV.empty?
+end
+
+def help_als_delta(msg = nil)
+  printf "Error: #{msg}\n\n".yellow unless msg.nil?
+  msg = <<~END_HELP
+    ls_delta: Shows changes to an .als file.
+    Press enter to compare with previous version.
+
+    Syntax: ls_delta OPTIONS PATH_TO_ALS_FILE
+
+    Environment variables used in PATH_TO_ALS_FILE are expanded.
+
+    Options are:
+      -k Keep each backup (default is to delete them)
+      -h Display this help message.
+
+    Example:
+    ls_delta $path/to/my_v12_set.als
+  END_HELP
+  printf msg.cyan
+  exit 1
+end
+
+def parse_options
+  options = { keep: false, loglevel: 'warning' }
+  opts = do_parse
+  opts.order!(into: options)
+
+  help_als_delta "Invalid verbosity value (#{options[:verbose]}), must be one of one of: #{VERBOSITY.join ', '}." \
+    if options[:verbose] && !options[:verbose] in VERBOSITY
+
+  options
+end
+
+private
+
+def do_parse
+  OptionParser.new do |parser|
+    parser.program_name = File.basename __FILE__
+    @parser = parser
+
+    parser.on('-k', '--keep', 'Keep all backups')
+    parser.on('-l', '--loglevel LOGLEVEL', Integer, "Logging level (#{VERBOSITY.join ', '})")
+    parser.on('-v', '--verbose VERBOSE', 'Verbosity')
+
+    parser.on_tail('-h', '--help', 'Show this message') do
+      help_als_delta
+    end
+  end
+end

data/lib/common/common.rb

@@ -0,0 +1,17 @@
+# require 'colorator'
+
+# def common(command)
+#   @options = parse_options command
+#   help_live_set 'The path for the Ableton Set must be provided.' if ARGV.empty?
+# end
+
+# def show
+#   common :show
+#   help_live_set "Too many parameters specified.\n#{ARGV}" if ARGV.length > 2
+
+#   set_name = ARGV.join ' '
+#   help "#{set_name} does not exist" unless File.exist? set_name
+#   help "#{set_name} is a directory" if File.directory? set_name
+
+#   LiveSet.new(set_name, **@options).show
+# end

data/lib/common/run.rb

@@ -0,0 +1,21 @@
+require 'open3'
+
+module Run
+  # @return true if the command succeeded
+  def run(command)
+    # printf "Run #{command}\n".yellow
+    $stdout.sync = true
+    system(*command)
+  end
+
+  # @return String array containing resulting lines of running command
+  def run_capture_stdout(command)
+    # printf "Run #{command}\n".yellow
+    stdout_str, status = Open3.capture2 command
+    unless status.success?
+      printf "Error: #{command} returned #{status}"
+      exit status.to_i
+    end
+    stdout_str.strip.split
+  end
+end

data/lib/common/util.rb

@@ -0,0 +1,39 @@
+class Array
+  # Convert an Array of Array into a String, formatted as a table.
+  def columnize(separator = '  ')
+    each { |row| row.is_a? Array or raise NoMethodError, 'Must be called on an Array of Array.' }
+    result = ''
+    l = []
+    each { |row| row.each_with_index { |f, i| l[i] = [l[i] || 0, f.to_s.length].max } }
+    each do |row|
+      row.each_with_index { |f, i| result << "#{f.to_s.ljust l[i]}#{separator}" }
+      result << "\n"
+    end
+    result
+  end
+end
+
+class String
+  def to_bool
+    return true if casecmp('true').zero?
+    return false if casecmp('false').zero?
+
+    nil
+  end
+
+  def expand_env
+    gsub(/\$([a-zA-Z_][a-zA-Z0-9_]*)|\${\g<1>}|%\g<1>%/) do
+      ENV.fetch(Regexp.last_match(1), nil)
+    end
+  end
+end
+
+def human_file_size(number, decimal_places = 1)
+  ByteSize.new(number).to_s(decimal_places)
+end
+
+def require_directory(dir)
+  Dir[File.join(dir, '*.rb')].sort.each do |file|
+    require file
+  end
+end

data/lib/live_set/live_set_all_tracks.rb

@@ -0,0 +1,34 @@
+class AllTracks
+  def initialize(tracks)
+    @tracks = tracks
+    @track_instances = tracks.map { |track| LiveAudioTrack.new track }
+  end
+
+  def all_frozen
+    @track_instances.all?(&:frozen)
+  end
+
+  def message
+    if @tracks.empty?
+      'No tracks'
+    else
+      summary + '  ' + @track_instances.map { |x| x.show_track(all_frozen) }.join("\n  ") # rubocop:disable Style/StringConcatenation
+    end
+  end
+
+  def summary
+    all_frozen_msg = all_frozen ? ' (All are frozen)'.yellow : ''
+    push_warning = all_frozen ? '' : "\nWarning: some tracks are not frozen, so this set should not be transferred to Push 3 Standalone.".red
+    total_size = @track_instances.sum(&:track_size)
+    size_warning = if total_size >= 2_000_000_000
+                     "\nWarning: This set is too large to be frozen and too large too large to transfer to Push 3 Standalone.".red
+                   else
+                     ''
+                   end
+    total_set_size = "Total set size: #{human_file_size total_size}".yellow
+    <<~END_MSG
+      #{total_set_size}#{size_warning}#{push_warning}
+      #{@track_instances.count} tracks#{all_frozen_msg}:
+    END_MSG
+  end
+end

data/lib/live_set/live_set_audio_clip.rb

@@ -0,0 +1,26 @@
+require 'date'
+
+class LiveAudioClip
+  attr_reader :file_size
+
+  # @param audio_clip is an inner <ClipSlot/> element from an Ableton Live .als file as parsed by Nokogiri
+  def initialize(id, need_refreeze, clip_slot)
+    @id                 = id
+    @need_refreeze      = need_refreeze
+
+    @audio_clip         = clip_slot.Value.AudioClip
+    @file_ref           = @audio_clip.SampleRef.FileRef
+    @last_modified      = Time.at(@audio_clip.SampleRef.LastModDate['Value'].to_i).utc.to_datetime
+
+    @absolute_path      = @file_ref.Path['Value']
+    @file_size          = @file_ref.OriginalFileSize['Value'].to_i
+    @file_type          = @file_ref.Type['Value'] # What do these values mean?
+    @live_pack_name     = @file_ref.LivePackName['Value']
+    @relative_path      = @file_ref.RelativePath['Value']
+    @relative_path_type = @file_ref.RelativePathType['Value'] # What do these values mean?
+  end
+
+  def show_clip
+    ["    #{@relative_path}", human_file_size(@file_size).rjust(8, ' '), @last_modified.strftime('%Y-%m-%d %H:%M:%S')]
+  end
+end

data/lib/live_set/live_set_audio_track.rb

@@ -0,0 +1,34 @@
+class LiveAudioTrack
+  attr_reader :frozen, :track_size
+
+  # @param audio_track is an <AudioTrack/> element from an Ableton Live .als file as parsed by Nokogiri
+  def initialize(audio_track)
+    @audio_track = audio_track
+    @id = @audio_track['Id']
+
+    @frozen = @audio_track.Freeze['Value'].to_bool
+
+    @clip_slots = @audio_track.DeviceChain.MainSequencer.ClipSlotList
+    @audio_clips = @clip_slots.ClipSlot.map do |clip_slot|
+      clip_slot_id = clip_slot['Id']
+      need_refreeze = clip_slot.NeedRefreeze['Value'].to_bool
+      inner_clip_slot = clip_slot.ClipSlot
+      LiveAudioClip.new clip_slot_id, need_refreeze, inner_clip_slot if inner_clip_slot.respond_to?(:Value) && !inner_clip_slot.Value.children.empty?
+    end
+    @audio_clips.compact!
+    @track_size = @audio_clips.sum(&:file_size) || 0
+  end
+
+  def show_track(all_frozen)
+    name = @audio_track.Name.EffectiveName['Value']
+    frozen = !all_frozen && @audio_track.frozen? ? ' **frozen**' : ''
+    "Track '#{name}'#{frozen} (#{@audio_clips.length} clips, totaling #{human_file_size @track_size})\n" + show_clips
+  end
+
+  def show_clips
+    return '' if @track_size.zero?
+
+    result = @audio_clips.map(&:show_clip)
+    result.columnize '  '
+  end
+end

data/lib/{llive_set_class.rb → live_set/live_set_class.rb}

@@ -1,14 +1,11 @@
+require 'bytesize'
 require 'nokogiri'
+require 'pathname'
 require 'zlib'
 
-class String
-  def to_bool
-    return true if casecmp('true').zero?
-    return false if casecmp('false').zero?
-
-    nil
-  end
-end
+# See https://www.ionos.ca/digitalguide/websites/web-development/xpath-tutorial/
+# See https://www.scrapingbee.com/webscraping-questions/selenium/how-to-find-elements-by-xpath-selenium
+# See https://nokogiri.org/tutorials/searching_a_xml_html_document.html#slop-1
 
 class LiveSet
   def initialize(set_name, **options)
@@ -21,9 +18,14 @@ class LiveSet
 
     @ableton = @xml_doc.Ableton
     @minor_version = @ableton['MinorVersion']
+
+    @live_set = @ableton.LiveSet
+    @tracks = AllTracks.new @live_set.Tracks.AudioTrack
+    @scenes = @live_set.Scenes.map { |scene| LiveScene.new scene }
   end
 
   def show
+    check_abelton_project_info
     puts <<~END_SHOW
       #{@set_name}
         Created by #{@ableton['Creator']}
@@ -31,16 +33,8 @@ class LiveSet
         Minor version v#{@minor_version}
         SchemaChangeCount #{@ableton['SchemaChangeCount']}
         Revision #{@ableton['Revision']}
+      #{@tracks.message}
     END_SHOW
-    tracks = @ableton.LiveSet.Tracks.AudioTrack
-    track_msg = if tracks.empty?
-                  'No tracks'
-                else
-                  all_frozen = all_tracks_frozen(tracks)
-                  track_summary(tracks) +
-                    tracks.map { |x| show_track x, all_frozen }.join("\n  ")
-                end
-    puts track_msg
   end
 
   def modify_als
@@ -72,25 +66,4 @@ class LiveSet
     end
     Zlib::GzipWriter.open(new_set_path) { |gz| gz.write new_contents }
   end
-
-  private
-
-  def all_tracks_frozen(tracks)
-    tracks.all? { |track| track_is_frozen track }
-  end
-
-  def track_is_frozen(track)
-    track.Freeze['Value'].to_bool
-  end
-
-  def track_summary(tracks)
-    all_frozen_msg = all_tracks_frozen(tracks) ? ' (All are frozen)' : ''
-    "#{tracks.count} tracks#{all_frozen_msg}:\n  "
-  end
-
-  def show_track(audio_track, all_frozen)
-    name = audio_track.Name.EffectiveName['Value']
-    frozen = !all_frozen && track_is_frozen(audio_track) ? ' **frozen**' : ''
-    "#{name}#{frozen}"
-  end
 end

data/lib/live_set/live_set_class_private.rb

@@ -0,0 +1,29 @@
+require 'colorator'
+require 'highline'
+
+class LiveSet
+  private
+
+  def check_abelton_project_info
+    set_directory = File.realpath(File.dirname(@set_name))
+    api_path = File.join(set_directory, 'Ableton Project Info')
+    puts "Warning: '#{api_path}' is not present".red unless File.exist? api_path
+    puts "Warning: '#{api_path}' is not a directory".red unless Dir.exist? api_path
+
+    cur_dir = Pathname.new(set_directory).parent
+    while cur_dir
+      project_info_path = File.join(cur_dir, 'Ableton Project Info')
+      add_dash_suffix(project_info_path) if File.exist? project_info_path
+      break if cur_dir.to_path == '/'
+
+      cur_dir = cur_dir.parent
+    end
+  end
+
+  def add_dash_suffix(cur_dir, path)
+    puts "Warning: 'Ableton Project Info' exists in parent directory '#{cur_dir.to_path}'".red
+    return unless HighLine.agree("\nDo you want the directory to be disabled by suffixing a dash to its name? ", character = true)
+
+    File.rename path, "#{path}-"
+  end
+end

data/lib/{options.rb → live_set/live_set_options.rb}

@@ -1,12 +1,14 @@
 require 'colorator'
 require 'optparse'
 
-VERBOSITY = %w[trace debug verbose info warning error fatal panic quiet].freeze
+VERBOSITY = %w[trace debug verbose info warning error fatal panic quiet].freeze unless defined? VERBOSITY
 
-def help_show(msg = nil)
+def help_live_set(msg = nil)
   printf "Error: #{msg}\n\n".yellow unless msg.nil?
   msg = <<~END_HELP
-    Displays information about a Live set or converts a Live 12 set to Live 11 format.
+    Live_sete displays information about an Ableton Live set or converts a Live 12 set to Live 11 format.
+    If the special folder called 'Ableton Project Info' is not present in the same folder as the .als file, a warning is generated.
+    Similarly, if 'Ableton Project Info' is present in any parent folder, a warning is issued.
 
     Syntax: live_set OPTIONS PATH_TO_ALS_FILE
 
@@ -14,7 +16,7 @@ def help_show(msg = nil)
 
     Options are:
       -11 Convert the Live 12 set to Live 11 format.
-      -f Overwrite any existing Live 11 set.
+      -f If -11 is specified, overwrite any existing Live 11 set.
       -h Display this help message.
 
     Example:
@@ -29,13 +31,12 @@ def parse_options
   opts = do_parse
   opts.order!(into: options)
 
-  help_show "Invalid verbosity value (#{options[:verbose]}), must be one of one of: #{VERBOSITY.join ', '}." \
+  live_set "Invalid verbosity value (#{options[:verbose]}), must be one of one of: #{VERBOSITY.join ', '}." \
     if options[:verbose] && !options[:verbose] in VERBOSITY
 
   options
 end
 
-
 private
 
 def do_parse
@@ -47,10 +48,10 @@ def do_parse
     parser.on('-f', '--force', 'Overwrite the output set if it already exists')
     parser.on('-s', '--show', 'Display information about the Ableton Live set')
     parser.on('-l', '--loglevel LOGLEVEL', Integer, "Logging level (#{VERBOSITY.join ', '})")
-    parser.on('-v', '--verbose VERBOSE', 'Zoom percentage')
+    parser.on('-v', '--verbose VERBOSE', 'Verbosity')
 
     parser.on_tail('-h', '--help', 'Show this message') do
-      help_show
+      live_set
     end
   end
 end

data/lib/live_set/live_set_scene.rb

@@ -0,0 +1,9 @@
+class LiveScene
+  # @param live_scene is an XML element as parsed by Nokogiri
+  def initialize(live_scene)
+    @live_scene = live_scene
+    @id = @live_scene['Id']
+    @name = @live_scene.Name['Value']
+    @tempo = @live_scene.Tempo['Value'] if @live_scene.IsTempoEnabled['Value'].to_bool
+  end
+end

data/lib/live_set/version.rb

@@ -1,3 +1,3 @@
 module LiveSetVersion
-  VERSION = '0.1.0'.freeze unless defined? VERSION
+  VERSION = '0.2.1'.freeze unless defined? VERSION
 end

data/lib/live_set.rb

@@ -1,29 +1,50 @@
-require_relative 'live_set/version'
+require_relative 'live_set/live_set_options'
+require_relative 'common/util'
+require_directory "#{__dir__}/common"
 
-# Require all Ruby files in 'lib/', except this file
-Dir[File.join(__dir__, '*.rb')].sort.each do |file|
-  # puts "Requiring #{file}"
-  require file unless file.end_with?('/live_set.rb')
+def common(command)
+  @options = parse_options command
+  help_live_set 'Ableton Live set name must be provided.' if ARGV.empty?
 end
 
-def help(msg = nil)
-  puts "Error: #{msg}" if msg
-  puts 'List files in ableton set'
-  exit 1
+def als_delta
+  require_directory "#{__dir__}/als_delta"
+
+  help_als_delta if ARGV.empty?
+
+  @options = parse_options
+
+  set_name = ARGV.join(' ').expand_env
+  help_als_delta "#{set_name} does not exist" unless File.exist? set_name
+  help_als_delta "#{set_name} is a directory" if File.directory? set_name
+
+  trap('SIGINT') { throw :ctrl_c }
+
+  als_delta = AlsDelta.new set_name, **@options
+  catch :ctrl_c do
+    als_delta.show
+    als_delta.cleanup
+  rescue Exception # rubocop:disable Lint/RescueException
+    als_delta.cleanup
+  end
 end
 
-help_show if ARGV.empty?
+def live_set
+  require_directory "#{__dir__}/live_set"
+
+  help_live_set if ARGV.empty?
 
-@options = parse_options
+  @options = parse_options
 
-set_name = expand_env ARGV.join(' ')
-help_show "#{set_name} does not exist" unless File.exist? set_name
-help_show "#{set_name} is a directory" if File.directory? set_name
+  set_name = ARGV.join(' ').expand_env
+  help_live_set "#{set_name} does not exist" unless File.exist? set_name
+  help_live_set "#{set_name} is a directory" if File.directory? set_name
 
-live_set = LiveSet.new set_name, **@options
+  live_set = LiveSet.new set_name, **@options
 
-if @options[:convert11]
-  live_set.modify_als
-else
-  live_set.show
+  if @options[:convert11]
+    live_set.modify_als
+  else
+    live_set.show
+  end
 end

data/live_set.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |spec|
 
   spec.authors               = ['Mike Slinn']
   spec.bindir                = 'exe'
-  spec.executables           = %w[live_set]
+  spec.executables           = %w[als_delta live_set]
   spec.description           = <<~END_DESC
     Reports the version of an Ableton Live set, and optionally changes it to v11 format.
   END_DESC
@@ -31,6 +31,8 @@ Gem::Specification.new do |spec|
   spec.summary               = 'Reports the version of an Ableton Live set, and optionally changes it to v11 format.'
   spec.version               = LiveSetVersion::VERSION
 
+  spec.add_dependency 'bytesize'
   spec.add_dependency 'colorator'
+  spec.add_dependency 'highline'
   spec.add_dependency 'nokogiri'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: live_set
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-14 00:00:00.000000000 Z
+date: 2024-03-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bytesize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: colorator
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -45,6 +73,7 @@ description: 'Reports the version of an Ableton Live set, and optionally changes
 email:
 - mslinn@mslinn.com
 executables:
+- als_delta
 - live_set
 extensions: []
 extra_rdoc_files: []
@@ -53,13 +82,23 @@ files:
 - CHANGELOG.md
 - README.md
 - Rakefile
+- als_notes.md
+- exe/als_delta
 - exe/live_set
-- lib/common.rb
+- lib/als_delta/als_delta_class.rb
+- lib/als_delta/als_delta_options.rb
+- lib/common/common.rb
+- lib/common/run.rb
+- lib/common/util.rb
 - lib/live_set.rb
+- lib/live_set/live_set_all_tracks.rb
+- lib/live_set/live_set_audio_clip.rb
+- lib/live_set/live_set_audio_track.rb
+- lib/live_set/live_set_class.rb
+- lib/live_set/live_set_class_private.rb
+- lib/live_set/live_set_options.rb
+- lib/live_set/live_set_scene.rb
 - lib/live_set/version.rb
-- lib/llive_set_class.rb
-- lib/options.rb
-- lib/util.rb
 - live_set.gemspec
 homepage: https://github.com/mslinn/live_set
 licenses:

data/lib/common.rb

@@ -1,18 +0,0 @@
-require 'colorator'
-require_relative 'options'
-
-def common(command)
-  @options = parse_options command
-  help_show 'The path for the Ableton Set must be provided.' if ARGV.empty?
-end
-
-def show
-  common :show
-  help_show "Too many parameters specified.\n#{ARGV}" if ARGV.length > 2
-
-  set_name = ARGV.join ' '
-  help "#{set_name} does not exist" unless File.exist? set_name
-  help "#{set_name} is a directory" if File.directory? set_name
-
-  LiveSet.new(set_name, **@options).show
-end

data/lib/util.rb

@@ -1,5 +0,0 @@
-def self.expand_env(str)
-  str.gsub(/\$([a-zA-Z_][a-zA-Z0-9_]*)|\${\g<1>}|%\g<1>%/) do
-    ENV.fetch(Regexp.last_match(1), nil)
-  end
-end