Class: Wavesync::CueChunk

Inherits:
Object
  • Object
show all
Defined in:
lib/wavesync/cue_chunk.rb

Constant Summary collapse

RIFF_HEADER_SIZE = 
12
CHUNK_ID_SIZE = 
4
CHUNK_SIZE_FIELD_SIZE = 
4
CUE_CHUNK_ID = 
'cue '
LIST_CHUNK_ID = 
'LIST'
ADTL_LIST_TYPE = 
'adtl'
LABL_CHUNK_ID = 
'labl'
DATA_CHUNK_ID = 
'data'
CUE_HEADER_SIZE = 
4
BYTES_PER_CUE_POINT = 
24
UINT32_LE = 
'V'

Class Method Summary collapse

Class Method Details

.append_to_file(filepath, cue_points) ⇒ Object

: (String filepath, Array[Integer, sample_offset: Integer, label: String?] cue_points) -> void



70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/wavesync/cue_chunk.rb', line 70

def self.append_to_file(filepath, cue_points)
  return if cue_points.empty?

  File.open(filepath, 'ab') do |file|
    write_cue_chunk(file, cue_points)
    labeled_cue_points = cue_points.select { |cue_point| cue_point[:label] }
    write_adtl_chunk(file, labeled_cue_points) if labeled_cue_points.any?
  end

  update_riff_size(filepath)
end

.read(filepath) ⇒ Object

: (String filepath) -> Array[Integer, sample_offset: Integer, label: String?]



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/wavesync/cue_chunk.rb', line 20

def self.read(filepath)
  cue_points = [] #: Array[{identifier: Integer, sample_offset: Integer, label: String?}]
  labels = {} #: Hash[Integer, String]

  File.open(filepath, 'rb') do |file|
    file.seek(RIFF_HEADER_SIZE)

    until file.eof?
      chunk_id = file.read(CHUNK_ID_SIZE)
      break if chunk_id.nil? || chunk_id.length < CHUNK_ID_SIZE

      chunk_size_bytes = file.read(CHUNK_SIZE_FIELD_SIZE)
      break if chunk_size_bytes.nil?

      chunk_size = chunk_size_bytes.unpack1(UINT32_LE).to_i
      chunk_data_start = file.tell

      if chunk_id == CUE_CHUNK_ID
        num_cues = file.read(4)&.unpack1(UINT32_LE).to_i
        num_cues.times do
          identifier = file.read(4)&.unpack1(UINT32_LE)&.to_i
          file.read(16) # skip position, fcc_chunk, chunk_start, block_start
          sample_offset = file.read(4)&.unpack1(UINT32_LE)&.to_i
          cue_points << { identifier: identifier, sample_offset: sample_offset, label: nil } if identifier && sample_offset
        end
      elsif chunk_id == LIST_CHUNK_ID && chunk_size >= 4
        list_type = file.read(4)
        read_adtl_labels(file, chunk_data_start + chunk_size, labels) if list_type == ADTL_LIST_TYPE
      end

      chunk_padding = chunk_size.odd? ? 1 : 0
      file.seek(chunk_data_start + chunk_size + chunk_padding)
    end
  end

  cue_points.map { |cue_point| { identifier: cue_point[:identifier], sample_offset: cue_point[:sample_offset], label: labels[cue_point[:identifier]] } }
end

.read_adtl_labels(file, list_end, labels) ⇒ Object

: (untyped file, Integer list_end, Hash[Integer, String] labels) -> void



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/wavesync/cue_chunk.rb', line 169

def self.read_adtl_labels(file, list_end, labels)
  while file.tell < list_end - 8
    sub_id = file.read(CHUNK_ID_SIZE)
    break if sub_id.nil? || sub_id.length < CHUNK_ID_SIZE

    sub_size_bytes = file.read(CHUNK_SIZE_FIELD_SIZE)
    break if sub_size_bytes.nil?

    sub_size = sub_size_bytes.unpack1(UINT32_LE).to_i
    sub_data_start = file.tell

    if sub_id == LABL_CHUNK_ID && sub_size >= 4
      identifier = file.read(4)&.unpack1(UINT32_LE)&.to_i
      text_size = sub_size - 4
      text = text_size.positive? ? (file.read(text_size) || '') : ''
      labels[identifier] = text.delete("\x00") if identifier
    end

    sub_padding = sub_size.odd? ? 1 : 0
    file.seek(sub_data_start + sub_size + sub_padding)
  end
end

.same?(cue_points_a, cue_points_b) ⇒ Boolean

: (Array[Integer, sample_offset: Integer, label: String?] cue_points_a, Array[Integer, sample_offset: Integer, label: String?] cue_points_b) -> bool

Returns:

  • (Boolean) 


59
60
61
 
# File 'lib/wavesync/cue_chunk.rb', line 59

def self.same?(cue_points_a, cue_points_b)
  to_comparable(cue_points_a) == to_comparable(cue_points_b)
end

.to_comparable(cue_points) ⇒ Object

: (Array[Integer, sample_offset: Integer, label: String?] cue_points) -> Array[Integer, label: String?]



64
65
66
67
 
# File 'lib/wavesync/cue_chunk.rb', line 64

def self.to_comparable(cue_points)
  mapped = cue_points.map { |cp| { sample_offset: cp[:sample_offset], label: cp[:label] } } #: Array[{sample_offset: Integer, label: String?}]
  mapped.sort_by { |cp| cp[:sample_offset] }
end

.update_riff_size(filepath) ⇒ Object

: (String filepath) -> void



193
194
195
196
197
198
199
200
201
 
# File 'lib/wavesync/cue_chunk.rb', line 193

def self.update_riff_size(filepath)
  File.open(filepath, 'r+b') do |file|
    file.seek(0, IO::SEEK_END)
    file_size = file.tell
    riff_size = file_size - 8
    file.seek(4)
    file.write([riff_size].pack(UINT32_LE))
  end
end

.write(source_filepath, output_filepath, cue_points) ⇒ Object

: (String source_filepath, String output_filepath, Array[Integer, sample_offset: Integer, label: String?] cue_points) -> void



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/wavesync/cue_chunk.rb', line 83

def self.write(source_filepath, output_filepath, cue_points)
  File.open(source_filepath, 'rb') do |input|
    File.open(output_filepath, 'wb') do |output|
      output.write(input.read(RIFF_HEADER_SIZE))

      until input.eof?
        chunk_id = input.read(CHUNK_ID_SIZE)
        break if chunk_id.nil? || chunk_id.length < CHUNK_ID_SIZE

        chunk_size_bytes = input.read(CHUNK_SIZE_FIELD_SIZE)
        break if chunk_size_bytes.nil?

        chunk_size = chunk_size_bytes.unpack1(UINT32_LE).to_i
        chunk_padding = chunk_size.odd? ? 1 : 0

        if chunk_id == CUE_CHUNK_ID
          input.read(chunk_size + chunk_padding)
        elsif chunk_id == LIST_CHUNK_ID && chunk_size >= 4
          list_type = input.read(4)
          if list_type == ADTL_LIST_TYPE
            input.read(chunk_size - 4 + chunk_padding)
          else
            output.write(chunk_id)
            output.write(chunk_size_bytes)
            output.write(list_type)
            output.write(input.read(chunk_size - 4 + chunk_padding))
          end
        else
          output.write(chunk_id)
          output.write(chunk_size_bytes)
          output.write(input.read(chunk_size + chunk_padding))
        end
      end

      unless cue_points.empty?
        write_cue_chunk(output, cue_points)
        labeled_cue_points = cue_points.select { |cue_point| cue_point[:label] }
        write_adtl_chunk(output, labeled_cue_points) if labeled_cue_points.any?
      end
    end
  end

  update_riff_size(output_filepath)
end

.write_adtl_chunk(output, cue_points) ⇒ Object

: (untyped output, Array[Integer, sample_offset: Integer, label: String?] cue_points) -> void



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/wavesync/cue_chunk.rb', line 146

def self.write_adtl_chunk(output, cue_points)
  labl_entries = cue_points.map do |cue_point|
    text = "#{cue_point[:label]}\x00"
    data_size = 4 + text.length
    pad = data_size.odd? ? 1 : 0
    { identifier: cue_point[:identifier], text: text, data_size: data_size, pad: pad }
  end #: Array[{identifier: Integer, text: String, data_size: Integer, pad: Integer}]

  adtl_data_size = 4 + labl_entries.sum { |entry| 8 + entry[:data_size] + entry[:pad] }
  output.write(LIST_CHUNK_ID)
  output.write([adtl_data_size].pack(UINT32_LE))
  output.write(ADTL_LIST_TYPE)

  labl_entries.each do |entry|
    output.write(LABL_CHUNK_ID)
    output.write([entry[:data_size]].pack(UINT32_LE))
    output.write([entry[:identifier]].pack(UINT32_LE))
    output.write(entry[:text])
    output.write("\x00") if entry[:pad] == 1
  end
end

.write_cue_chunk(output, cue_points) ⇒ Object

: (untyped output, Array[Integer, sample_offset: Integer, label: String?] cue_points) -> void



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/wavesync/cue_chunk.rb', line 129

def self.write_cue_chunk(output, cue_points)
  chunk_size = CUE_HEADER_SIZE + (cue_points.size * BYTES_PER_CUE_POINT)
  output.write(CUE_CHUNK_ID)
  output.write([chunk_size].pack(UINT32_LE))
  output.write([cue_points.size].pack(UINT32_LE))
  cue_points.each_with_index do |cue_point, index|
    identifier = cue_point[:identifier] || (index + 1)
    output.write([identifier].pack(UINT32_LE))
    output.write([0].pack(UINT32_LE))
    output.write(DATA_CHUNK_ID)
    output.write([0].pack(UINT32_LE))
    output.write([0].pack(UINT32_LE))
    output.write([cue_point[:sample_offset]].pack(UINT32_LE))
  end
end