tef-animation 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 92421ddea4eb5a58abffa7fdb3ec987f645281d7
-  data.tar.gz: c2fc1d82fdffc6ecc435ed47554f3dca0bb5834b
+SHA256:
+  metadata.gz: 1db58af80b8a46f264d810c4119617e776dcb4036374041ce2051753003442d7
+  data.tar.gz: 823d5ada4c84f7e5e83e04943a7005516deb343a140c7e0352d3bd9570b06fbf
 SHA512:
-  metadata.gz: df1fd4e30609e37ee34281ccad04a759af87155757af7886d163c7082caa3e9427854b09353d042342ebd2e8e5d00c4ec3b79289bb7c7ecbff21353d1abb9e10
-  data.tar.gz: 96069806358729bff76ecebe28a925caf52d8587acc9ba05dc7950595e9ad1f3b5980b32a16ca84a074fd5f9ef896eda0c5d496061ab1c8c08f42806051cead0
+  metadata.gz: f95e1a8b015fe89f8df92a51b7bb04683d69fc9f0e4bd5016350abc2f208379643371e2e25111491b0520a7acbfb43de17e2392bdb712eecca2c95d628833d8a
+  data.tar.gz: a5dff21053dee87aae002e2213c76b831fad03b7c48ee08b72e654474696a363f52adb9609a200d12dc96ad9c0fc46c0154cf00726f57d153a1f661fea0438d0

data/lib/tef/Animation/Animatable.rb

@@ -149,6 +149,8 @@ module TEF
 				@animatable_colors = {}
 				@animatable_coordinates = {}
 
+				@animatable_pending_strings = [];
+
 				self.class.get_attr_list.each do |key, val|
 					@animatable_attributes[key] = Value.new(val)
 				end
@@ -206,6 +208,11 @@ module TEF
 				self.death_time = Time.at(0)
 			end
 
+			def is_dead?
+				return false if @death_time.nil?
+				return @death_time < Time.now();
+			end
+
 			# Quickly configure this object.
 			#
 			# This is a convenience function to very quickly and easily
@@ -225,6 +232,11 @@ module TEF
 				raise ArgumentError, 'Config must be a hash!' unless h.is_a? Hash
 
 				h.each do |key, data|
+					if(key == :die_after)
+						die_in(data.to_f);
+						next;
+					end
+
 					value = 	@animatable_attributes[key] ||
 								@animatable_colors[key] ||
 								@animatable_coordinates[key]
@@ -245,6 +257,10 @@ module TEF
 				''
 			end
 
+			def send_string(str)
+				@animatable_pending_strings << str;
+			end
+
 			private def all_animatable_attributes
 				out =  @animatable_attributes.values
 				out += @animatable_coordinates.values.map(&:animatable_attributes)
@@ -337,6 +353,18 @@ module TEF
 
 				out_elements
 			end
+
+			def get_setss_strings()
+				return [] unless @module_id
+
+				out =  @animatable_pending_strings.map do |str|
+					"#{@module_id} #{str}"
+				end
+
+				@animatable_pending_strings.clear
+
+				return out;
+			end
 		end
 
 		class Box < Animatable

data/lib/tef/Animation/Animation_Handler.rb

@@ -62,6 +62,26 @@ module TEF
 				key
 			end
 
+			private def internal_set_object(key, new_obj)
+				key = clean_key key
+
+				@active_animations[key]&.module_id = nil;
+
+				if new_obj.nil?
+					@pending_deletions[key] = true
+					@pending_creations.delete key
+
+				elsif new_obj.is_a? Animatable
+					new_obj.module_id = key
+
+					@active_animations[key] = new_obj
+					@pending_creations[key] = new_obj.creation_string
+					@pending_deletions.delete key
+				else
+					raise ArgumentError, 'New animation object is of invalid type'
+				end
+			end
+
 			# @return [Animatable] Returns the Animatable with matching key.
 			def [](key)
 				@active_animations[clean_key key]
@@ -77,25 +97,28 @@ module TEF
 			#  either replace it with the given {Animatable}, or, if nil was
 			#  given, will delete the animation entry.
 			def []=(key, new_obj)
-				@animation_mutex.synchronize {
-					key = clean_key key
-
-					@active_animations[key]&.module_id = nil;
+				@animation_mutex.synchronize do
+					internal_set_object(key, new_obj)
+				end
+			end
 
-					if new_obj.nil?
-						@pending_deletions[key] = true
-						@pending_creations.delete key
+			def append_to_set(new_obj, set_no = 200)
+				@animation_mutex.synchronize do
+					start_no = { S: set_no, M: 0 };
 
-					elsif new_obj.is_a? Animatable
-						new_obj.module_id = key
+					until(@active_animations[clean_key start_no].nil? ||
+							@active_animations[clean_key start_no].is_dead?) do
+						start_no[:M] += 1
+					end
 
-						@active_animations[key] = new_obj
-						@pending_creations[key] = new_obj.creation_string
-						@pending_deletions.delete key
-					else
-						raise ArgumentError, 'New animation object is of invalid type'
+					if(start_no[:M] >= 255)
+						raise ArgumentError, 'No more space for new animations!'
 					end
-				}
+
+					internal_set_object(start_no, new_obj)
+				end
+
+				new_obj
 			end
 
 			# Internal function to join an Array of strings and send it onto
@@ -125,10 +148,11 @@ module TEF
 			# using the main synch time, rather than using relative time.
 			private def update_deaths
 				death_reconfigs = [];
+				deletions = []
 
-				@animation_mutex.synchronize {
+				@animation_mutex.synchronize do
 					@active_animations.each do |key, animation|
-						if (!animation.death_time.nil?) && animation.death_time < Time.now()
+						if animation.is_dead?
 							@pending_deletions[key] = :silent
 						end
 
@@ -137,14 +161,14 @@ module TEF
 
 						death_reconfigs << new_death
 					end
-				}
 
-				deletions = []
-				@pending_deletions.each do |key, val|
-					deletions << "#{key};" unless val == :silent
-					@active_animations.delete key
+					@pending_deletions.each do |key, val|
+						deletions << "#{key};" unless val == :silent
+						@active_animations.delete key
+					end
+					@pending_deletions = {}
+
 				end
-				@pending_deletions = {}
 
 				join_and_send('DTIME', death_reconfigs)
 				join_and_send('DELETE', deletions)
@@ -222,11 +246,11 @@ module TEF
 			private def update_colors
 				pending_changes = []
 
-				@animation_mutex.synchronize {
+				@animation_mutex.synchronize do
 					@active_animations.each do |key, anim|
 						pending_changes += anim.get_setc_strings
 					end
-				}
+				end
 
 				return if pending_changes.empty?
 				x_logd "Pending changes are #{pending_changes}"
@@ -234,6 +258,16 @@ module TEF
 				join_and_send 'CSET', pending_changes
 			end
 
+			private def update_strings
+				@animation_mutex.synchronize do
+					@active_animations.values.each do |anim|
+						anim.get_setss_strings().each do |str|
+							@furcoms.send_message 'SSET', str
+						end
+					end
+				end
+			end
+
 			# Update tick.
 			#
 			# Calling this function will send all updates and changes over the
@@ -252,6 +286,7 @@ module TEF
 
 				update_values
 				update_colors
+				update_strings
 			end
 		end
 	end

data/lib/tef/Animation/Eyes.rb

@@ -8,15 +8,34 @@ module TEF
 		class Eye < Animatable
 			animatable_color :outer_color, 0
 			animatable_color :inner_color, 1
+			animatable_color :blush, 2
 
-			animatable_attr :iris_x, 0x10
-			animatable_attr :iris_y, 0x11
-			animatable_attr :top, 0x12
-			animatable_attr :bottom, 0x13
-			animatable_attr :eye_closure, 0x14
+			animatable_attr :iris_x, 0x0
+
+			animatable_attr :angry, 0x100
+			animatable_attr :happy, 0x101
+			animatable_attr :heart, 0x102
+			animatable_attr :surprised, 0x103
+			animatable_attr :shy, 0x104
 
 			def initialize()
 				super();
+
+				@last_mood = :relaxed;
+				@animatable_colors[:blush].configure({ target: 0xFF000000, delay_a: 1 });
+			end
+
+			def set_mood(mood, amount: 1)
+				if @last_mood != :relaxed
+					@animatable_attributes[@last_mood].add = 0;
+				end
+
+				return if mood.nil?
+				@last_mood = mood.to_sym;
+
+				return if @last_mood == :relaxed
+
+				self.configure({ @last_mood.to_sym => { add: amount, dampen: 0.1 }});
 			end
 		end
 	end

data/lib/tef/Animation/String.rb

@@ -0,0 +1,29 @@
+
+require_relative 'Animatable.rb'
+
+module TEF
+	module Animation
+		class StringDisplay < Animatable
+			animatable_color :color, 0
+
+			animatable_attr :x, 1
+			animatable_attr :y, 2
+			animatable_attr :alignment, 3
+
+			attr_reader :string
+
+			def initialize()
+				super();
+
+				self.string = "";
+			end
+
+			def string=(new_string)
+				return if new_string == @string
+				@string = new_string
+				
+				@animatable_pending_strings = [new_string]
+			end
+		end
+	end
+end

data/lib/tef/Sequencing/AudacityLabelReader.rb

@@ -0,0 +1,52 @@
+
+module TEF
+	module Sequencing
+
+		# Audacity label reader helper.
+		#
+		# This class is meant to read in an exported list of Labels, as
+		# generated by audacity. It provides proper data conversion and a few
+		# convenience functions.
+		class AudacityReader
+			# Initialize a new reader.
+			#
+			# This will read in the given file and process it.
+			# Note that since Audacity does not export the name of different
+			# label tracks, it simply exports all labels, each label track should
+			# begin with a label called "TRACK: Name".
+			# This serves as a means to separate label tracks.
+			#
+			# @param [String] file The file to read.
+			#  Should be a tab-separated list of start and end time and label name.
+			def initialize(file)
+				@tracks = Hash.new({});
+
+				File.open(file, 'r') do |f|
+					current_track = 'default';
+					@tracks['default'] = [];
+
+					f.each do |line|
+						m = /^(?<start>[\.\d]+)\s+(?<stop>[\d\.]+)\s+(?<text>\S.+)/.match line
+						next unless m;
+
+						if(m[:text] =~ /TRACK:\s*(\S.+)/)
+							current_track = $1;
+							@tracks[current_track] = [];
+						else
+							@tracks[current_track] << { start: m[:start].to_f, stop: m[:stop].to_f, text: m[:text] }
+						end
+					end
+				end
+			end
+
+			# @return [Array<{start: Numeric, stop: Numeric, text: String}] The
+			#  corresponding list of labels for the given track, or an empty
+			#  array if the track did not exist.
+			def [](name)
+				return [] if @tracks[name].nil?
+
+				return @tracks[name]
+			end
+		end
+	end
+end

data/lib/tef/Sequencing/BaseSequence.rb

@@ -33,7 +33,7 @@ module TEF
 			# purposes. Can be:
 			# - :uninitialized (right after construction)
 			# - :running (after having called setup())
-			# - :torn_down (after teardown() was called)
+			# - :idle (after teardown() was called)
 			attr_reader :state
 
 			# Initialize a BaseSequence.
@@ -50,7 +50,10 @@ module TEF
 				@end_time   ||= options[:end_time];
 
 				@offset = offset;
-				@slope  = slope;
+				@slope  = slope.round(6);
+				# Explanation: For some bizarre reason, rounding is necessary
+				# to avoid a glitch in the timing math. 6 digits of precision
+				# should be precise enough anyways.
 
 				@state = :uninitialized
 
@@ -60,17 +63,29 @@ module TEF
 			def parent_start_time
 				@offset + @start_time / @slope
 			end
+			def parent_end_time
+				return nil if @end_time.nil?
+
+				@offset + @end_time / @slope
+			end
+
+			def parent_end_time=(new_time)
+				if(new_time.nil?)
+					@end_time = nil;
+					return;
+				end
+
+				@end_time = (new_time - @offset) * @slope;
+			end
 
 			def setup()
-				raise 'Program had to be uninitialized!' unless @state == :uninitialized
+				return unless @state == :idle
 				@state = :running
 			end
 
 			def teardown()
 				return unless @state == :running
-				@state = :torn_down
-
-				@opts_hash = nil;
+				@state = :idle
 			end
 
 			# Look for the next possible event that this sequence wants to
@@ -83,32 +98,40 @@ module TEF
 			# @note When using BaseSequence as base class, the user
 			#  shall overload {#overload_append_events} rather than this function!
 			def append_events(collector)
+				return if @state == :uninitialized
+
 				local_collector = collector.offset_collector(@offset, @slope);
 
+				# Return if the collector has events before our start time
 				return if local_collector.has_events? &&
 							 local_collector.event_time < @start_time
-				return if @state == :torn_down
 
-				if @state == :uninitialized
+				if !@end_time.nil?
+					if @state == :running
+	 					local_collector.add_event({
+	 						time: [@end_time, local_collector.start_time + 0.01].max,
+	 						code: proc { self.teardown() }
+	 					})
+					end
+
+					return if local_collector.start_time >= @end_time
+ 				end
+
+				if @state == :idle
 					local_collector.add_event({
 						time: [@start_time, local_collector.start_time + 0.01].max,
 						code: proc { self.setup() }
 					});
 				end
 
-				if @state == :running
-					overload_append_events(local_collector)
-				end
-
-				if !@end_time.nil?
-					local_collector.add_event({
-						time: @end_time,
-						code: proc { self.teardown() }
-					})
-				end
+				overload_append_events(local_collector)
 			end
 
 			def overload_append_events(_collector) end
+
+			def destroy!()
+				teardown() if @state == :running
+			end
 		end
 	end
 end

data/lib/tef/Sequencing/EventCollector.rb

@@ -41,8 +41,9 @@ module TEF
 			# This should only be done via {EventCollector#offset_collector}!
 			def initialize(parent, total_offset, total_slope)
 				@parent = parent
+
 				@total_offset = total_offset
-				@total_slope  = total_slope
+				@total_slope  = total_slope.to_f
 			end
 
 			# @param [Time, nil] global_time Time to convert
@@ -50,7 +51,7 @@ module TEF
 			def convert_to_local(global_time)
 				return nil if global_time.nil?
 
-				(global_time - @total_offset) * @total_slope
+				((global_time - @total_offset) * @total_slope).round(3)
 			end
 
 			# @param [Numeric, nil] local_time Time (abstract) to convert back
@@ -59,7 +60,7 @@ module TEF
 			def convert_to_global(local_time)
 				return nil if local_time.nil?
 
-				@total_offset + (local_time.to_f / @total_slope)
+				@total_offset + (local_time.to_f.round(3) / @total_slope)
 			end
 
 			# (see EventCollector#start_time)
@@ -133,8 +134,11 @@ module TEF
 			# and set the event list to [event], else append the event
 			# to the event list.
 			def add_event(event)
+				event = event.clone
+
 				return if event[:time] <= @start_time
 				return if (!@event_time.nil?) && (event[:time] > @event_time)
+				return unless event[:code].is_a? Proc
 
 				if (!@event_time.nil?) && (event[:time] == @event_time)
 					@current_events << event

data/lib/tef/Sequencing/SequencePlayer.rb

@@ -108,7 +108,15 @@ module TEF
 				loop do
 					@sequenceMutex.synchronize do
 						@retryCollecting = false
-						@activeSequences.delete_if { |k, seq| seq.state == :torn_down }
+						@activeSequences.delete_if do |k, seq|
+							if(seq.parent_end_time <= Time.now())
+								seq.destroy!()
+								true
+							else
+								false
+							end
+						end
+
 						@activeSequences.each { |k, seq| seq.append_events @collector }
 					end
 

data/lib/tef/Sequencing/Sheet.rb

@@ -25,6 +25,11 @@ module TEF
 			#  execution!
 			attr_accessor :end_time
 
+			# If set non-nil, determines the timespan after which a given
+			# sequence will repeat itself. Does not influence start_time and
+			# end_time.
+			attr_accessor :repeat_time
+
 			# @return [Numeric, nil] Tempo of the sheet. Defines the execution
 			#  speed in BPM. If left nil, the execution speed of the parent
 			#  sheet is used.
@@ -38,6 +43,7 @@ module TEF
 			# @see SheetSequence#at
 			# @see SheetSequence#after
 			# @see SheetSequence#play
+			attr_reader :fill_block
 			attr_reader :setup_block
 			attr_reader :teardown_block
 
@@ -47,13 +53,17 @@ module TEF
 			# {#start_time}, {#end_time} and by supplying at least a
 			# {#sequence}
 			def initialize()
-				@start_time = 0;
+				@start_time = nil;
 				@end_time = nil;
+				@repeat_time = nil;
 
 				@tempo = nil
 
+				@fill_block = nil;
 				@setup_block = nil;
 				@teardown_block = nil;
+
+				yield(self) if(block_given?)
 			end
 
 			# Configure a block to call when setting up the {SheetSequence}.
@@ -64,10 +74,14 @@ module TEF
 			# @see SheetSequence#at
 			# @see SheetSequence#after
 			# @see SheetSequence#play
-			def sequence(&block)
+			def setup(&block)
 				@setup_block = block;
 			end
 
+			def notes(&block)
+				@fill_block = block;
+			end
+
 			# Configure the block to call when the {SheetSequence} is about to
 			# be torn down. Use this to stop or delete any resources allocated
 			# to the sheet.

data/lib/tef/Sequencing/SheetSequence.rb

@@ -13,7 +13,6 @@ module TEF
 		# Think of the {Sheet} as being the script for a play or movie, while
 		# the {SheetSequence} has the job of actually performing everything.
 		class SheetSequence < BaseSequence
-
 			# Initialize a SheetSequence.
 			#
 			# This is mostly done via {Player#[]=} by passing a {Sheet}.
@@ -24,36 +23,43 @@ module TEF
 			# The user may also call {#at} and {#after} manually to add additional
 			# events.
 			def initialize(offset, slope, **options)
-				super(offset, slope, **options);
-
 				raise ArgumentError, 'Sheet must be supplied!' unless options[:sheet]
 
 				@sheet = options[:sheet]
 
 				if @sheet.tempo
-					@slope *= @sheet.tempo / (60 * (options[:top_slope] || 1))
+					slope *= (@sheet.tempo / (60.to_f * (options[:top_slope] || 1)))
 				end
 
-				@start_time = @sheet.start_time
-				@end_time = @sheet.end_time
+				super(offset, slope, **options);
 
 				@notes = []
 				@latest_note_time = nil;
 
 				@subprograms = []
-
 				@active_music = []
+
+				@start_time = @sheet.start_time
+				@end_time = @sheet.end_time
+
+				if block = @sheet.fill_block
+					instance_exec(@opts_hash, &block)
+
+					@start_time ||= @notes[0]&.dig(:time) || 0;
+					@end_time	||= @notes[-1]&.dig(:time) || 0;
+
+					@state = :idle;
+				end
 			end
 
 			def setup()
+				return unless @state == :idle
+
 				super();
 
 				if block = @sheet.setup_block
-					instance_exec(@opts_hash[:sheet_options], &block)
+					instance_exec(@opts_hash, &block)
 				end
-
-				return unless @end_time.nil?
-				@end_time = (@notes[-1]&.dig(:time) || 0) + 0.01
 			end
 
 			def teardown()
@@ -65,12 +71,18 @@ module TEF
 
 				@subprograms.each(&:teardown)
 
-				@active_music.each { |pid| Process.kill('QUIT', pid); }
+				@active_music.each do |pid|
+					self.kill pid
+				end
 
-				@subprograms = nil;
-				@notes = nil;
+				super();
+			end
 
+			def destroy!()
 				super();
+
+				@notes = nil;
+				@subprograms.each(&:destroy!)
 			end
 
 			# Insert an event or subsheet into the event list.
@@ -91,6 +103,14 @@ module TEF
 			# the {Sheet#teardown} block. Sub-Sequences as well as notes
 			# played by {#play} are automatically torn down.
 			def at(time, **options, &block)
+				time = time.to_f
+
+				if repeat_time = @sheet.repeat_time
+					time = time % repeat_time
+				end
+
+				time = time.round(3);
+
 				@latest_note_time = time;
 
 				options[:sequence] = SheetSequence if options[:sheet]
@@ -101,6 +121,10 @@ module TEF
 
 					prog = prog.new(time, options[:slope], **options)
 
+					if e_time = options[:end_time]
+						prog.parent_end_time = e_time;
+					end
+
 					i = @subprograms.bsearch_index { |s| s.parent_start_time > prog.parent_start_time }
 					@subprograms.insert((i || -1), prog);
 
@@ -138,7 +162,7 @@ module TEF
 
 				Thread.new do
 					@active_music << play_pid
-					Process.wait(@active_music)
+					Process.wait(play_pid)
 					@active_music.delete play_pid
 				end
 
@@ -148,22 +172,36 @@ module TEF
 			# Shorthand to kill
 			def kill(pid)
 				Process.kill('QUIT', pid);
+			rescue Errno::ESRCH
+				return false
 			end
 
 			private def overload_append_events(collector)
 				i = 0
-				loop do
-					next_program = @subprograms[i]
-					break if next_program.nil?
-					break if collector.event_time &&
-								(collector.event_time < next_program.parent_start_time)
-
-					next_program.append_events collector
-
-					if next_program.state == :torn_down
-						@subprograms.delete_at i
-					else
-						i += 1
+
+				if(@sheet.repeat_time)
+					repeat_cycle = (collector.start_time / @sheet.repeat_time).floor
+					repeat_shift_time = repeat_cycle * @sheet.repeat_time
+
+					# This will wrap around and thusly implement the repeating nature
+					# of this sequence
+					collector = collector.offset_collector(repeat_shift_time, 1);
+				end
+
+				@subprograms.each do |program|
+					if(collector.event_time &&
+						(collector.event_time < program.parent_start_time))
+						next
+					end
+
+					program.append_events collector
+				end
+
+				return if @notes.empty?
+
+				if(@sheet.repeat_time)
+					if(collector.start_time >= @notes[-1][:time])
+						collector = collector.offset_collector(@sheet.repeat_time, 1);
 					end
 				end
 
@@ -172,13 +210,9 @@ module TEF
 
 				note_time = @notes[i][:time]
 
-				next_note = @notes[i];
-				loop do
-					collector.add_event next_note;
-
-					next_note = @notes[i += 1]
-					break unless next_note
-					break if next_note[:time] != note_time
+				until (note = @notes[i])&.dig(:time) != note_time
+					i += 1;
+					collector.add_event note
 				end
 			end
 		end

data/lib/tef/animation.rb

@@ -1,6 +1,7 @@
 
 require_relative 'Animation/Animation_Handler.rb'
 require_relative 'Animation/Eyes.rb'
+require_relative 'Animation/String.rb'
 
 require_relative 'ParameterStack/Stack.rb'
 
@@ -9,3 +10,5 @@ require_relative 'ProgramSelection/SequenceCollection.rb'
 require_relative 'ProgramSelection/SoundCollection.rb'
 
 require_relative 'Sequencing/SequencePlayer.rb'
+
+require_relative 'Sequencing/AudacityLabelReader.rb'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tef-animation
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - TheSystem
@@ -65,6 +65,7 @@ files:
 - lib/tef/Animation/Color.rb
 - lib/tef/Animation/Coordinate.rb
 - lib/tef/Animation/Eyes.rb
+- lib/tef/Animation/String.rb
 - lib/tef/Animation/Value.rb
 - lib/tef/ParameterStack/Override.rb
 - lib/tef/ParameterStack/Stack.rb
@@ -72,6 +73,7 @@ files:
 - lib/tef/ProgramSelection/ProgramSelector.rb
 - lib/tef/ProgramSelection/SequenceCollection.rb
 - lib/tef/ProgramSelection/SoundCollection.rb
+- lib/tef/Sequencing/AudacityLabelReader.rb
 - lib/tef/Sequencing/BaseSequence.rb
 - lib/tef/Sequencing/EventCollector.rb
 - lib/tef/Sequencing/SequencePlayer.rb
@@ -97,8 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: TEF Animation and Sequencing code