Class: Deftones::Source::GrainPlayer

Inherits:
Player show all
Defined in:
lib/deftones/source/grain_player.rb

Constant Summary collapse

WINDOWS = 
%i[linear hann hamming blackman].freeze

Instance Attribute Summary collapse

Attributes inherited from Player

#autostart, #buffer, #curve, #fade_in, #fade_out, #loop, #loop_end, #loop_start, #playback_rate, #reverse

Attributes inherited from Core::Source

#mute, #onstop, #volume

Instance Method Summary collapse

Methods inherited from Player

#dispose, #envelope_gain, #fadeIn=, #fadeOut=, #fade_in_gain, #fade_out_gain, #integrated_position_at_frame, #loaded, #loaded?, #loopEnd=, #loopStart=, #loop_end_frame, #looped_position, #looped_reverse_position, #multichannel_process?, #notify_stop, #onstop, #onstop=, #playbackRate=, #resolve_buffer_position, #restart, #reverse_position, #sample_positions_for, #seek, #shaped_gain, #start, #state

Methods inherited from Core::Source

#active_at?, #apply_volume!, #cancel_stop, #clear_transport_event, #dispose, #mute?, #notify_stop_in_window, #number_of_inputs, #render, #render_block, #resolve_time, #resolve_transport_time, #restart, #schedule_transport_event, #source_type, #start, #state, #stop, #sync, #synced?, #unsync, #uses_legacy_render_for_block?

Constructor Details

#initialize(grain_size: 0.05, overlap: 0.5, jitter: 0.002, detune: 0.0, window: :linear, jitter_seed: nil, rng: nil, **options) ⇒ GrainPlayer

Returns a new instance of GrainPlayer.



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/deftones/source/grain_player.rb', line 12

def initialize(grain_size: 0.05, overlap: 0.5, jitter: 0.002, detune: 0.0,
               window: :linear, jitter_seed: nil, rng: nil, **options)
  super(**options)
  @grain_size = grain_size.to_f
  @overlap = overlap.to_f
  @jitter = jitter.to_f
  @detune = Core::Signal.new(value: detune, units: :number, context: context)
  @window = normalize_window(window)
  @jitter_seed = jitter_seed
  @rng = rng
  @grain_random_cache = {}
end

Instance Attribute Details

#detune ⇒ Object

Returns the value of attribute detune.



8
9
10
 
# File 'lib/deftones/source/grain_player.rb', line 8

def detune
  @detune
end

#grain_size ⇒ Object

Returns the value of attribute grain_size.



9
10
11
 
# File 'lib/deftones/source/grain_player.rb', line 9

def grain_size
  @grain_size
end

#jitter ⇒ Object

Returns the value of attribute jitter.



9
10
11
 
# File 'lib/deftones/source/grain_player.rb', line 9

def jitter
  @jitter
end

#overlap ⇒ Object

Returns the value of attribute overlap.



9
10
11
 
# File 'lib/deftones/source/grain_player.rb', line 9

def overlap
  @overlap
end

#window ⇒ Object Also known as: grainWindow

Returns the value of attribute window.



10
11
12
 
# File 'lib/deftones/source/grain_player.rb', line 10

def window
  @window
end

Instance Method Details

#active_grain_count(grain_duration, grain_interval) ⇒ Object (private) 



143
144
145
 
# File 'lib/deftones/source/grain_player.rb', line 143

def active_grain_count(grain_duration, grain_interval)
  [(grain_duration / grain_interval).ceil + 1, 1].max
end

#detune_ratio(cents) ⇒ Object (private) 



240
241
242
 
# File 'lib/deftones/source/grain_player.rb', line 240

def detune_ratio(cents)
  2.0**(cents.to_f / 1200.0)
end

#grain_anchor_offset(grain_index, playback_rate, grain_interval) ⇒ Object (private) 



160
161
162
 
# File 'lib/deftones/source/grain_player.rb', line 160

def grain_anchor_offset(grain_index, playback_rate, grain_interval)
  grain_index * grain_interval * @buffer.sample_rate * playback_rate
end

#grain_duration_seconds ⇒ Object (private) 



131
132
133
 
# File 'lib/deftones/source/grain_player.rb', line 131

def grain_duration_seconds
  [@grain_size.to_f, context.sample_time].max
end

#grain_index_at(current_time, grain_interval) ⇒ Object (private) 



147
148
149
 
# File 'lib/deftones/source/grain_player.rb', line 147

def grain_index_at(current_time, grain_interval)
  ((current_time - @start_time) / grain_interval).floor
end

#grain_interval_seconds(grain_duration, overlap_duration) ⇒ Object (private) 



139
140
141
 
# File 'lib/deftones/source/grain_player.rb', line 139

def grain_interval_seconds(grain_duration, overlap_duration)
  [grain_duration - overlap_duration, context.sample_time].max
end

#grain_jitter_offset(grain_index) ⇒ Object (private) 



164
165
166
167
168
 
# File 'lib/deftones/source/grain_player.rb', line 164

def grain_jitter_offset(grain_index)
  return 0.0 if @jitter.zero?

  ((grain_random(grain_index) * 2.0) - 1.0) * @jitter * @buffer.sample_rate
end

#grain_logical_position(grain_index, grain_elapsed, playback_rate, detune_ratio, grain_interval) ⇒ Object (private) 



155
156
157
158
 
# File 'lib/deftones/source/grain_player.rb', line 155

def grain_logical_position(grain_index, grain_elapsed, playback_rate, detune_ratio, grain_interval)
  anchor = @seek_position + grain_anchor_offset(grain_index, playback_rate, grain_interval)
  anchor + grain_jitter_offset(grain_index) + (grain_elapsed * @buffer.sample_rate * detune_ratio)
end

#grain_random(grain_index) ⇒ Object (private) 



170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/deftones/source/grain_player.rb', line 170

def grain_random(grain_index)
  return @grain_random_cache[grain_index] if @grain_random_cache.key?(grain_index)

  @grain_random_cache[grain_index] =
    if @rng
      @rng.rand
    elsif @jitter_seed
      Random.new(@jitter_seed.to_i + grain_index).rand
    else
      Math.sin((grain_index + 1) * 12_989.0).abs % 1.0
    end
end

#grain_start_time(grain_index, grain_interval) ⇒ Object (private) 



151
152
153
 
# File 'lib/deftones/source/grain_player.rb', line 151

def grain_start_time(grain_index, grain_interval)
  @start_time + (grain_index * grain_interval)
end

#grain_window_gain(grain_elapsed, grain_duration, overlap_duration) ⇒ Object (private) 



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/deftones/source/grain_player.rb', line 183

def grain_window_gain(grain_elapsed, grain_duration, overlap_duration)
  return overlapped_linear_gain(grain_elapsed, grain_duration, overlap_duration) if @window == :linear

  progress = (grain_elapsed / grain_duration).clamp(0.0, 1.0)
  case @window
  when :hann
    0.5 - (0.5 * Math.cos(2.0 * Math::PI * progress))
  when :hamming
    0.54 - (0.46 * Math.cos(2.0 * Math::PI * progress))
  when :blackman
    0.42 - (0.5 * Math.cos(2.0 * Math::PI * progress)) + (0.08 * Math.cos(4.0 * Math::PI * progress))
  else
    overlapped_linear_gain(grain_elapsed, grain_duration, overlap_duration)
  end
end

#granular_sample(current_time, playback_rate:, detune_ratio:, grain_duration:, overlap_duration:, grain_interval:, active_grains:, channel_index: nil) ⇒ Object (private) 



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/deftones/source/grain_player.rb', line 108

def granular_sample(current_time, playback_rate:, detune_ratio:, grain_duration:, overlap_duration:, grain_interval:,
                    active_grains:, channel_index: nil)
  current_grain = grain_index_at(current_time, grain_interval)
  first_grain = [current_grain - active_grains, 0].max

  (first_grain..current_grain).sum(0.0) do |grain_index|
    grain_elapsed = current_time - grain_start_time(grain_index, grain_interval)
    next 0.0 if grain_elapsed.negative? || grain_elapsed >= grain_duration

    logical_position = grain_logical_position(grain_index, grain_elapsed, playback_rate, detune_ratio, grain_interval)
    sample_position = resolve_buffer_position(logical_position)
    next 0.0 if sample_position.negative?

    sample =
      if channel_index.nil?
        @buffer.sample_at(sample_position)
      else
        @buffer.sample_at(sample_position, channel_index)
      end
    sample * grain_window_gain(grain_elapsed, grain_duration, overlap_duration)
  end
end

#natural_stop_time(playback_rate, grain_duration) ⇒ Object (private) 



224
225
226
 
# File 'lib/deftones/source/grain_player.rb', line 224

def natural_stop_time(playback_rate, grain_duration)
  @start_time + (playable_frame_span / (@buffer.sample_rate * playback_rate)) + grain_duration
end

#naturally_finished?(current_time, playback_rate, grain_duration) ⇒ Boolean (private)

Returns:

  • (Boolean) 


217
218
219
220
221
222
 
# File 'lib/deftones/source/grain_player.rb', line 217

def naturally_finished?(current_time, playback_rate, grain_duration)
  return false if @loop
  return false unless playback_rate.positive?

  current_time >= natural_stop_time(playback_rate, grain_duration)
end

#normalize_window(window) ⇒ Object (private)

Raises:

  • (ArgumentError) 


207
208
209
210
211
212
 
# File 'lib/deftones/source/grain_player.rb', line 207

def normalize_window(window)
  normalized = window.to_sym
  return normalized if WINDOWS.include?(normalized)

  raise ArgumentError, "Unsupported grain window: #{window}"
end

#overlap_duration_seconds(grain_duration) ⇒ Object (private) 



135
136
137
 
# File 'lib/deftones/source/grain_player.rb', line 135

def overlap_duration_seconds(grain_duration)
  @overlap.to_f.clamp(0.0, grain_duration)
end

#overlapped_linear_gain(grain_elapsed, grain_duration, overlap_duration) ⇒ Object (private) 



199
200
201
202
203
204
205
 
# File 'lib/deftones/source/grain_player.rb', line 199

def overlapped_linear_gain(grain_elapsed, grain_duration, overlap_duration)
  return 1.0 if overlap_duration <= 0.0

  fade_in = (grain_elapsed / overlap_duration).clamp(0.0, 1.0)
  fade_out = ((grain_duration - grain_elapsed) / overlap_duration).clamp(0.0, 1.0)
  [fade_in, fade_out].min
end

#playable_frame_span ⇒ Object (private) 



228
229
230
231
232
233
234
 
# File 'lib/deftones/source/grain_player.rb', line 228

def playable_frame_span
  return [@buffer.frames - @seek_position, 0.0].max unless @reverse

  min_position = @loop_start * @buffer.sample_rate
  max_position = loop_end_frame || (@buffer.frames - 1)
  [max_position - min_position - @seek_position, 0.0].max
end

#positive_rate(value) ⇒ Object (private) 



236
237
238
 
# File 'lib/deftones/source/grain_player.rb', line 236

def positive_rate(value)
  [value.to_f.abs, Float::EPSILON].max
end

#process(_input_buffer, num_frames, start_frame, _cache) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/deftones/source/grain_player.rb', line 33

def process(_input_buffer, num_frames, start_frame, _cache)
  rates = @playback_rate.process(num_frames, start_frame)
  detunes = @detune.process(num_frames, start_frame)
  grain_duration = grain_duration_seconds
  overlap_duration = overlap_duration_seconds(grain_duration)
  grain_interval = grain_interval_seconds(grain_duration, overlap_duration)
  active_grains = active_grain_count(grain_duration, grain_interval)
  return process_multichannel_buffer(num_frames, start_frame, rates, detunes, grain_duration, overlap_duration, grain_interval, active_grains) if multichannel_process?

  Array.new(num_frames) do |index|
    current_time = (start_frame + index).to_f / context.sample_rate
    notify_stop(current_time) if @stop_time && current_time >= @stop_time
    next 0.0 unless active_at?(current_time)

    rate = positive_rate(rates[index])
    output = granular_sample(
      current_time,
      playback_rate: rate,
      detune_ratio: detune_ratio(detunes[index]),
      grain_duration: grain_duration,
      overlap_duration: overlap_duration,
      grain_interval: grain_interval,
      active_grains: active_grains
    )

    if naturally_finished?(current_time, rate, grain_duration)
      @stop_time ||= current_time
      notify_stop(current_time)
      next 0.0
    end

    output * envelope_gain(current_time)
  end
end

#process_multichannel_buffer(num_frames, start_frame, rates, detunes, grain_duration, overlap_duration, grain_interval, active_grains) ⇒ Object (private) 



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/deftones/source/grain_player.rb', line 70

def process_multichannel_buffer(num_frames, start_frame, rates, detunes, grain_duration, overlap_duration, grain_interval, active_grains)
  output = Array.new(@buffer.channels) { Array.new(num_frames, 0.0) }

  num_frames.times do |index|
    current_time = (start_frame + index).to_f / context.sample_rate
    notify_stop(current_time) if @stop_time && current_time >= @stop_time
    next unless active_at?(current_time)

    rate = positive_rate(rates[index])
    detune = detune_ratio(detunes[index])

    @buffer.channels.times do |channel_index|
      output[channel_index][index] = granular_sample(
        current_time,
        playback_rate: rate,
        detune_ratio: detune,
        grain_duration: grain_duration,
        overlap_duration: overlap_duration,
        grain_interval: grain_interval,
        active_grains: active_grains,
        channel_index: channel_index
      )
    end

    if naturally_finished?(current_time, rate, grain_duration)
      @stop_time ||= current_time
      notify_stop(current_time)
    else
      gain = envelope_gain(current_time)
      @buffer.channels.times do |channel_index|
        output[channel_index][index] *= gain
      end
    end
  end

  Core::AudioBlock.from_channel_data(output)
end