-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathruby.html
839 lines (676 loc) · 95.5 KB
/
ruby.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
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
57
58
59
60
61
62
63
64
65
66
67
68
69
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
<!DOCTYPE html>
<html dir="ltr" lang="en">
<head>
<meta charset="UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Extended Module: Ruby parsing library</title>
<meta name="keywords" content="kaitai,struct,binary,format,parsing,decoding,java,javascript,python,ruby,library,metadata">
<meta name="description" content="Kaitai Struct is a formal language for binary format specification that can be compiled into parser code">
<link rel="stylesheet" href="//kaitai.io/styles/bootstrap.min.css">
<link rel="stylesheet" href="//kaitai.io/styles/bootstrap-theme.min.css">
<link href='https://fonts.googleapis.com/css?family=Exo:400,700' rel='stylesheet' type='text/css'>
<link href='https://fonts.googleapis.com/css?family=Share+Tech+Mono' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
<link rel="stylesheet" href="//kaitai.io/styles/main.css" type="text/css">
<link rel="stylesheet" href="/pygments-default.css" type="text/css">
<style>
.diagram-img {
display: block;
max-width: 100%;
height: auto;
margin: 0 auto;
}
section.format {
padding: 30px 0;
}
section#format-meta, section#format-index-header {
background: #e3eef7;
}
section#format-diagram, section#format-index-footer {
background: #e9f8dd;
}
section#format-ksy, section#format-lang {
background: #d1eadd;
}
section#format-index .row {
padding-bottom: 10px;
}
</style>
</head>
<body data-spy="scroll" data-target="#main-navbar" data-offset="100">
<nav class="navbar navbar-inverse navbar-fixed-top" id="main-navbar">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#main-navbar-collapse" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="navbar-brand">Kaitai Struct</span>
</div>
<div class="collapse navbar-collapse" id="main-navbar-collapse">
<ul class="nav navbar-nav">
<li><a href="//kaitai.io/#what-is-it">What is it?</a></li>
<li><a href="//kaitai.io/#quick-start">Quick Start</a></li>
<li><a href="//kaitai.io/#download">Download</a></li>
<li><a href="//kaitai.io/news/">News</a></li>
<li class="active"><a href="//formats.kaitai.io/">Format Gallery</a></li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li><a href="https://ide.kaitai.io/">Try it — Web IDE</a></li>
<li><a href="//doc.kaitai.io/">Documentation</a></li>
</ul>
</div>
</div>
</nav>
<nav>
<div class="container">
<ol class="breadcrumb">
<li><a href="../">Format Gallery</a></li>
<li>Multimedia Files</li>
<li class="active">Extended Module</li>
</ol>
</div>
</nav>
<section id="format-meta" class="format">
<div class="container">
<h1>Extended Module:
Ruby parsing library
</h1>
<div class="row">
<div class="col-md-8">
<p><p>XM (standing for eXtended Module) is a popular module music file
format, that was introduced in 1994 in FastTracker2 by Triton demo
group. Akin to MOD files, it bundles both digital samples
(instruments) and instructions on which note to play at what time
(patterns), which provides good audio quality with relatively small
file size. Audio is reproducible without relying on the sound of
particular hardware samplers or synths.</p>
</p>
</div>
<div class="col-md-4">
<div class="panel panel-info">
<div class="panel-heading">
<h3 class="panel-title">Application</h3>
</div>
<div class="panel-body">
["FastTracker 2", "Protracker", "MilkyTracker", "libmodplug", "Mikmod"]
</div>
<div class="panel-heading">
<h3 class="panel-title">File extension</h3>
</div>
<div class="panel-body">
xm
</div>
<div class="panel-heading">
<h3 class="panel-title">KS implementation details</h3>
</div>
<div class="panel-body">
License: <a href="https://spdx.org/licenses/Unlicense.html">Unlicense</a>
</div>
<div class="panel-heading">
<h3 class="panel-title">References</h3>
</div>
<div class="panel-body">
<ul>
<li><a href="https://www.nationalarchives.gov.uk/pronom/fmt/323">PRONOM fmt/323</a></li>
<li><a href="https://www.wikidata.org/wiki/Q376852">Wikidata Q376852</a></li>
<li><a href="http://fileformats.archiveteam.org/wiki/Extended_Module">Extended Module in Just Solve the File Format Problem</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="row">
<div class="col-md-12">
<p>
This page hosts a formal specification of Extended Module
using <a href="//kaitai.io">Kaitai Struct</a>. This
specification can be automatically translated into a
variety of programming languages to get a parsing library.
</p>
<ul class="nav nav-pills">
<li>
<a href="index.html" title="Extended Module parsing Overview library">Overview</a></li>
<li>
<a href="cpp_stl_11.html" title="Extended Module parsing C++11/STL library">C++11/STL</a></li>
<li>
<a href="cpp_stl_98.html" title="Extended Module parsing C++98/STL library">C++98/STL</a></li>
<li>
<a href="csharp.html" title="Extended Module parsing C# library">C#</a></li>
<li>
<a href="go.html" title="Extended Module parsing Go library">Go</a></li>
<li>
<a href="graphviz.html" title="Extended Module parsing GraphViz library">GraphViz</a></li>
<li>
<a href="java.html" title="Extended Module parsing Java library">Java</a></li>
<li>
<a href="javascript.html" title="Extended Module parsing JavaScript library">JavaScript</a></li>
<li>
<a href="lua.html" title="Extended Module parsing Lua library">Lua</a></li>
<li>
<a href="nim.html" title="Extended Module parsing Nim library">Nim</a></li>
<li>
<a href="perl.html" title="Extended Module parsing Perl library">Perl</a></li>
<li>
<a href="php.html" title="Extended Module parsing PHP library">PHP</a></li>
<li>
<a href="python.html" title="Extended Module parsing Python library">Python</a></li>
<li class="active">
<a href="ruby.html" title="Extended Module parsing Ruby library">Ruby</a></li>
</ul>
</div>
</div>
</div>
</section>
<section id="format-usage" class="format">
<div class="container">
<h2>Usage</h2>
<h3>Runtime library</h3>
<p>All parsing code for Ruby generated by Kaitai Struct depends on the
<a
href="https://github.com/kaitai-io/kaitai_struct_ruby_runtime/"
target="_blank" rel="noopener">
Ruby runtime library</a>. You have to
install it before you can parse data.</p>
<p>The Ruby runtime library can be installed <a href="https://rubygems.org/gems/kaitai-struct"
target="_blank" rel="noopener">from RubyGems</a>:</p>
<pre><code>gem install kaitai-struct</code></pre>
<h3>Code</h3>
<p>Parse a local file and get structure in memory:</p>
<div class="highlight"><pre><span></span><span class="n">data</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">FasttrackerXmModule</span><span class="o">.</span><span class="n">from_file</span><span class="p">(</span><span class="s2">"path/to/local/file.xm"</span><span class="p">)</span>
</pre></div>
<p>Or parse structure from a string of bytes:</p>
<div class="highlight"><pre><span></span><span class="n">bytes</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"</span><span class="se">\x00\x01\x02</span><span class="s2">..."</span>
<span class="n">data</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">FasttrackerXmModule</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">Stream</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="n">bytes</span><span class="p">))</span>
</pre></div>
<p>After that, one can get various attributes from the structure by invoking getter methods like:</p>
<div class="highlight"><pre><span></span><span class="n">data</span><span class="o">.</span><span class="n">preheader</span><span class="w"> </span><span class="c1"># => get preheader</span>
</pre></div>
</div>
</section>
<section id="format-lang" class="format">
<div class="container">
<h2>
Ruby source code to parse Extended Module
</h2>
<h3>fasttracker_xm_module.rb</h3>
<div class="row">
<div class="pull-right">
<p>
<a href="src/ruby/fasttracker_xm_module.rb" download="fasttracker_xm_module.rb" class="btn btn-success">Download <i class="fa fa-download"></i></a>
</p>
</div>
</div>
<div class="row">
<div class="highlight"><pre><span></span><span class="c1"># This is a generated file! Please edit source .ksy file and use kaitai-struct-compiler to rebuild</span>
<span class="nb">require</span><span class="w"> </span><span class="s1">'kaitai/struct/struct'</span>
<span class="k">unless</span><span class="w"> </span><span class="no">Gem</span><span class="o">::</span><span class="no">Version</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">VERSION</span><span class="p">)</span><span class="w"> </span><span class="o">>=</span><span class="w"> </span><span class="no">Gem</span><span class="o">::</span><span class="no">Version</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="s1">'0.9'</span><span class="p">)</span>
<span class="w"> </span><span class="k">raise</span><span class="w"> </span><span class="s2">"Incompatible Kaitai Struct Ruby API: 0.9 or later is required, but you have </span><span class="si">#{</span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">VERSION</span><span class="si">}</span><span class="s2">"</span>
<span class="k">end</span>
<span class="c1">##</span>
<span class="c1"># XM (standing for eXtended Module) is a popular module music file</span>
<span class="c1"># format, that was introduced in 1994 in FastTracker2 by Triton demo</span>
<span class="c1"># group. Akin to MOD files, it bundles both digital samples</span>
<span class="c1"># (instruments) and instructions on which note to play at what time</span>
<span class="c1"># (patterns), which provides good audio quality with relatively small</span>
<span class="c1"># file size. Audio is reproducible without relying on the sound of</span>
<span class="c1"># particular hardware samplers or synths.</span>
<span class="c1"># @see http://sid.ethz.ch/debian/milkytracker/milkytracker-0.90.85%2Bdfsg/resources/reference/xm-form.txt</span>
<span class="c1"># ftp://ftp.modland.com/pub/documents/format_documentation/FastTracker%202%20v2.04%20(.xm).html</span>
<span class="c1"># Source</span>
<span class="k">class</span><span class="w"> </span><span class="nc">FasttrackerXmModule</span><span class="w"> </span><span class="o"><</span><span class="w"> </span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">Struct</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">initialize</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kp">nil</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">self</span><span class="p">)</span>
<span class="w"> </span><span class="k">super</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="p">)</span>
<span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="vi">@preheader</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">Preheader</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="vi">@_io</span><span class="p">,</span><span class="w"> </span><span class="nb">self</span><span class="p">,</span><span class="w"> </span><span class="vi">@_root</span><span class="p">)</span>
<span class="w"> </span><span class="vi">@_raw_header</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_bytes</span><span class="p">((</span><span class="n">preheader</span><span class="o">.</span><span class="n">header_size</span><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="mi">4</span><span class="p">))</span>
<span class="w"> </span><span class="n">_io__raw_header</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">Stream</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="vi">@_raw_header</span><span class="p">)</span>
<span class="w"> </span><span class="vi">@header</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">Header</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="n">_io__raw_header</span><span class="p">,</span><span class="w"> </span><span class="nb">self</span><span class="p">,</span><span class="w"> </span><span class="vi">@_root</span><span class="p">)</span>
<span class="w"> </span><span class="vi">@patterns</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">[]</span>
<span class="w"> </span><span class="p">(</span><span class="n">header</span><span class="o">.</span><span class="n">num_patterns</span><span class="p">)</span><span class="o">.</span><span class="n">times</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="o">|</span><span class="n">i</span><span class="o">|</span>
<span class="w"> </span><span class="vi">@patterns</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="no">Pattern</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="vi">@_io</span><span class="p">,</span><span class="w"> </span><span class="nb">self</span><span class="p">,</span><span class="w"> </span><span class="vi">@_root</span><span class="p">)</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="vi">@instruments</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">[]</span>
<span class="w"> </span><span class="p">(</span><span class="n">header</span><span class="o">.</span><span class="n">num_instruments</span><span class="p">)</span><span class="o">.</span><span class="n">times</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="o">|</span><span class="n">i</span><span class="o">|</span>
<span class="w"> </span><span class="vi">@instruments</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="no">Instrument</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="vi">@_io</span><span class="p">,</span><span class="w"> </span><span class="nb">self</span><span class="p">,</span><span class="w"> </span><span class="vi">@_root</span><span class="p">)</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="nb">self</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">Preheader</span><span class="w"> </span><span class="o"><</span><span class="w"> </span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">Struct</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">initialize</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kp">nil</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">self</span><span class="p">)</span>
<span class="w"> </span><span class="k">super</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="p">)</span>
<span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="vi">@signature0</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_bytes</span><span class="p">(</span><span class="mi">17</span><span class="p">)</span>
<span class="w"> </span><span class="k">raise</span><span class="w"> </span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">ValidationNotEqualError</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="o">[</span><span class="mi">69</span><span class="p">,</span><span class="w"> </span><span class="mi">120</span><span class="p">,</span><span class="w"> </span><span class="mi">116</span><span class="p">,</span><span class="w"> </span><span class="mi">101</span><span class="p">,</span><span class="w"> </span><span class="mi">110</span><span class="p">,</span><span class="w"> </span><span class="mi">100</span><span class="p">,</span><span class="w"> </span><span class="mi">101</span><span class="p">,</span><span class="w"> </span><span class="mi">100</span><span class="p">,</span><span class="w"> </span><span class="mi">32</span><span class="p">,</span><span class="w"> </span><span class="mi">77</span><span class="p">,</span><span class="w"> </span><span class="mi">111</span><span class="p">,</span><span class="w"> </span><span class="mi">100</span><span class="p">,</span><span class="w"> </span><span class="mi">117</span><span class="p">,</span><span class="w"> </span><span class="mi">108</span><span class="p">,</span><span class="w"> </span><span class="mi">101</span><span class="p">,</span><span class="w"> </span><span class="mi">58</span><span class="p">,</span><span class="w"> </span><span class="mi">32</span><span class="o">].</span><span class="n">pack</span><span class="p">(</span><span class="s1">'C*'</span><span class="p">),</span><span class="w"> </span><span class="n">signature0</span><span class="p">,</span><span class="w"> </span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="s2">"/types/preheader/seq/0"</span><span class="p">)</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="n">signature0</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="o">[</span><span class="mi">69</span><span class="p">,</span><span class="w"> </span><span class="mi">120</span><span class="p">,</span><span class="w"> </span><span class="mi">116</span><span class="p">,</span><span class="w"> </span><span class="mi">101</span><span class="p">,</span><span class="w"> </span><span class="mi">110</span><span class="p">,</span><span class="w"> </span><span class="mi">100</span><span class="p">,</span><span class="w"> </span><span class="mi">101</span><span class="p">,</span><span class="w"> </span><span class="mi">100</span><span class="p">,</span><span class="w"> </span><span class="mi">32</span><span class="p">,</span><span class="w"> </span><span class="mi">77</span><span class="p">,</span><span class="w"> </span><span class="mi">111</span><span class="p">,</span><span class="w"> </span><span class="mi">100</span><span class="p">,</span><span class="w"> </span><span class="mi">117</span><span class="p">,</span><span class="w"> </span><span class="mi">108</span><span class="p">,</span><span class="w"> </span><span class="mi">101</span><span class="p">,</span><span class="w"> </span><span class="mi">58</span><span class="p">,</span><span class="w"> </span><span class="mi">32</span><span class="o">].</span><span class="n">pack</span><span class="p">(</span><span class="s1">'C*'</span><span class="p">)</span>
<span class="w"> </span><span class="vi">@module_name</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">Stream</span><span class="o">::</span><span class="n">bytes_terminate</span><span class="p">(</span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_bytes</span><span class="p">(</span><span class="mi">20</span><span class="p">),</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="kp">false</span><span class="p">))</span><span class="o">.</span><span class="n">force_encoding</span><span class="p">(</span><span class="s2">"utf-8"</span><span class="p">)</span>
<span class="w"> </span><span class="vi">@signature1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_bytes</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="w"> </span><span class="k">raise</span><span class="w"> </span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">ValidationNotEqualError</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="o">[</span><span class="mi">26</span><span class="o">].</span><span class="n">pack</span><span class="p">(</span><span class="s1">'C*'</span><span class="p">),</span><span class="w"> </span><span class="n">signature1</span><span class="p">,</span><span class="w"> </span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="s2">"/types/preheader/seq/2"</span><span class="p">)</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="n">signature1</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="o">[</span><span class="mi">26</span><span class="o">].</span><span class="n">pack</span><span class="p">(</span><span class="s1">'C*'</span><span class="p">)</span>
<span class="w"> </span><span class="vi">@tracker_name</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">Stream</span><span class="o">::</span><span class="n">bytes_terminate</span><span class="p">(</span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_bytes</span><span class="p">(</span><span class="mi">20</span><span class="p">),</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="kp">false</span><span class="p">))</span><span class="o">.</span><span class="n">force_encoding</span><span class="p">(</span><span class="s2">"utf-8"</span><span class="p">)</span>
<span class="w"> </span><span class="vi">@version_number</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">Version</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="vi">@_io</span><span class="p">,</span><span class="w"> </span><span class="nb">self</span><span class="p">,</span><span class="w"> </span><span class="vi">@_root</span><span class="p">)</span>
<span class="w"> </span><span class="vi">@header_size</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u4le</span>
<span class="w"> </span><span class="nb">self</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">Version</span><span class="w"> </span><span class="o"><</span><span class="w"> </span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">Struct</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">initialize</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kp">nil</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">self</span><span class="p">)</span>
<span class="w"> </span><span class="k">super</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="p">)</span>
<span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="vi">@minor</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u1</span>
<span class="w"> </span><span class="vi">@major</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u1</span>
<span class="w"> </span><span class="nb">self</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">value</span>
<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="vi">@value</span><span class="w"> </span><span class="k">unless</span><span class="w"> </span><span class="vi">@value</span><span class="o">.</span><span class="n">nil?</span>
<span class="w"> </span><span class="vi">@value</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">((</span><span class="n">major</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="mi">8</span><span class="p">)</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">minor</span><span class="p">)</span>
<span class="w"> </span><span class="vi">@value</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># currently 0x04</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:minor</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># currently 0x01</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:major</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:signature0</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># Module name, padded with zeroes</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:module_name</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:signature1</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># Tracker name</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:tracker_name</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># Format versions below [0x01, 0x04] have a LOT of differences. Check this field!</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:version_number</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># Header size << Calculated FROM THIS OFFSET, not from the beginning of the file! >></span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:header_size</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">Pattern</span><span class="w"> </span><span class="o"><</span><span class="w"> </span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">Struct</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">initialize</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kp">nil</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">self</span><span class="p">)</span>
<span class="w"> </span><span class="k">super</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="p">)</span>
<span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="vi">@header</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">Header</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="vi">@_io</span><span class="p">,</span><span class="w"> </span><span class="nb">self</span><span class="p">,</span><span class="w"> </span><span class="vi">@_root</span><span class="p">)</span>
<span class="w"> </span><span class="vi">@packed_data</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_bytes</span><span class="p">(</span><span class="n">header</span><span class="o">.</span><span class="n">main</span><span class="o">.</span><span class="n">len_packed_pattern</span><span class="p">)</span>
<span class="w"> </span><span class="nb">self</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">Header</span><span class="w"> </span><span class="o"><</span><span class="w"> </span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">Struct</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">initialize</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kp">nil</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">self</span><span class="p">)</span>
<span class="w"> </span><span class="k">super</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="p">)</span>
<span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="vi">@header_length</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u4le</span>
<span class="w"> </span><span class="vi">@_raw_main</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_bytes</span><span class="p">((</span><span class="n">header_length</span><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="mi">4</span><span class="p">))</span>
<span class="w"> </span><span class="n">_io__raw_main</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">Stream</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="vi">@_raw_main</span><span class="p">)</span>
<span class="w"> </span><span class="vi">@main</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">HeaderMain</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="n">_io__raw_main</span><span class="p">,</span><span class="w"> </span><span class="nb">self</span><span class="p">,</span><span class="w"> </span><span class="vi">@_root</span><span class="p">)</span>
<span class="w"> </span><span class="nb">self</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">HeaderMain</span><span class="w"> </span><span class="o"><</span><span class="w"> </span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">Struct</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">initialize</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kp">nil</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">self</span><span class="p">)</span>
<span class="w"> </span><span class="k">super</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="p">)</span>
<span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="vi">@packing_type</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u1</span>
<span class="w"> </span><span class="k">case</span><span class="w"> </span><span class="n">_root</span><span class="o">.</span><span class="n">preheader</span><span class="o">.</span><span class="n">version_number</span><span class="o">.</span><span class="n">value</span>
<span class="w"> </span><span class="k">when</span><span class="w"> </span><span class="mi">258</span>
<span class="w"> </span><span class="vi">@num_rows_raw</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u1</span>
<span class="w"> </span><span class="k">else</span>
<span class="w"> </span><span class="vi">@num_rows_raw</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u2le</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="vi">@len_packed_pattern</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u2le</span>
<span class="w"> </span><span class="nb">self</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">num_rows</span>
<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="vi">@num_rows</span><span class="w"> </span><span class="k">unless</span><span class="w"> </span><span class="vi">@num_rows</span><span class="o">.</span><span class="n">nil?</span>
<span class="w"> </span><span class="vi">@num_rows</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="n">num_rows_raw</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="p">(</span><span class="n">_root</span><span class="o">.</span><span class="n">preheader</span><span class="o">.</span><span class="n">version_number</span><span class="o">.</span><span class="n">value</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="mi">258</span><span class="w"> </span><span class="o">?</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">))</span>
<span class="w"> </span><span class="vi">@num_rows</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># Packing type (always 0)</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:packing_type</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># Number of rows in pattern (1..256)</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:num_rows_raw</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># Packed pattern data size</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:len_packed_pattern</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># Pattern header length</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:header_length</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:main</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:_raw_main</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:header</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:packed_data</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">Flags</span><span class="w"> </span><span class="o"><</span><span class="w"> </span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">Struct</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">initialize</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kp">nil</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">self</span><span class="p">)</span>
<span class="w"> </span><span class="k">super</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="p">)</span>
<span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="vi">@reserved</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_bits_int_be</span><span class="p">(</span><span class="mi">15</span><span class="p">)</span>
<span class="w"> </span><span class="vi">@freq_table_type</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_bits_int_be</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span><span class="w"> </span><span class="o">!=</span><span class="w"> </span><span class="mi">0</span>
<span class="w"> </span><span class="nb">self</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:reserved</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># 0 = Amiga frequency table (see below); 1 = Linear frequency table</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:freq_table_type</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">Header</span><span class="w"> </span><span class="o"><</span><span class="w"> </span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">Struct</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">initialize</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kp">nil</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">self</span><span class="p">)</span>
<span class="w"> </span><span class="k">super</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="p">)</span>
<span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="vi">@song_length</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u2le</span>
<span class="w"> </span><span class="vi">@restart_position</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u2le</span>
<span class="w"> </span><span class="vi">@num_channels</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u2le</span>
<span class="w"> </span><span class="vi">@num_patterns</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u2le</span>
<span class="w"> </span><span class="vi">@num_instruments</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u2le</span>
<span class="w"> </span><span class="vi">@flags</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">Flags</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="vi">@_io</span><span class="p">,</span><span class="w"> </span><span class="nb">self</span><span class="p">,</span><span class="w"> </span><span class="vi">@_root</span><span class="p">)</span>
<span class="w"> </span><span class="vi">@default_tempo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u2le</span>
<span class="w"> </span><span class="vi">@default_bpm</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u2le</span>
<span class="w"> </span><span class="vi">@pattern_order_table</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">[]</span>
<span class="w"> </span><span class="p">(</span><span class="mi">256</span><span class="p">)</span><span class="o">.</span><span class="n">times</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="o">|</span><span class="n">i</span><span class="o">|</span>
<span class="w"> </span><span class="vi">@pattern_order_table</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u1</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="nb">self</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># Song length (in pattern order table)</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:song_length</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:restart_position</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># (2,4,6,8,10,...,32)</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:num_channels</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># (max 256)</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:num_patterns</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># (max 128)</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:num_instruments</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:flags</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:default_tempo</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:default_bpm</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># max 256</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:pattern_order_table</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># XM's notion of "instrument" typically constitutes of a</span>
<span class="w"> </span><span class="c1"># instrument metadata and one or several samples. Metadata</span>
<span class="w"> </span><span class="c1"># includes:</span>
<span class="w"> </span><span class="c1"># </span>
<span class="w"> </span><span class="c1"># * instrument's name</span>
<span class="w"> </span><span class="c1"># * instruction of which sample to use for which note</span>
<span class="w"> </span><span class="c1"># * volume and panning envelopes and looping instructions</span>
<span class="w"> </span><span class="c1"># * vibrato settings</span>
<span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">Instrument</span><span class="w"> </span><span class="o"><</span><span class="w"> </span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">Struct</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">initialize</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kp">nil</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">self</span><span class="p">)</span>
<span class="w"> </span><span class="k">super</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="p">)</span>
<span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="vi">@header_size</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u4le</span>
<span class="w"> </span><span class="vi">@_raw_header</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_bytes</span><span class="p">((</span><span class="n">header_size</span><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="mi">4</span><span class="p">))</span>
<span class="w"> </span><span class="n">_io__raw_header</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">Stream</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="vi">@_raw_header</span><span class="p">)</span>
<span class="w"> </span><span class="vi">@header</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">Header</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="n">_io__raw_header</span><span class="p">,</span><span class="w"> </span><span class="nb">self</span><span class="p">,</span><span class="w"> </span><span class="vi">@_root</span><span class="p">)</span>
<span class="w"> </span><span class="vi">@samples_headers</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">[]</span>
<span class="w"> </span><span class="p">(</span><span class="n">header</span><span class="o">.</span><span class="n">num_samples</span><span class="p">)</span><span class="o">.</span><span class="n">times</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="o">|</span><span class="n">i</span><span class="o">|</span>
<span class="w"> </span><span class="vi">@samples_headers</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="no">SampleHeader</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="vi">@_io</span><span class="p">,</span><span class="w"> </span><span class="nb">self</span><span class="p">,</span><span class="w"> </span><span class="vi">@_root</span><span class="p">)</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="vi">@samples</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">[]</span>
<span class="w"> </span><span class="p">(</span><span class="n">header</span><span class="o">.</span><span class="n">num_samples</span><span class="p">)</span><span class="o">.</span><span class="n">times</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="o">|</span><span class="n">i</span><span class="o">|</span>
<span class="w"> </span><span class="vi">@samples</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="no">SamplesData</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="vi">@_io</span><span class="p">,</span><span class="w"> </span><span class="nb">self</span><span class="p">,</span><span class="w"> </span><span class="vi">@_root</span><span class="p">,</span><span class="w"> </span><span class="n">samples_headers</span><span class="o">[</span><span class="n">i</span><span class="o">]</span><span class="p">)</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="nb">self</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">Header</span><span class="w"> </span><span class="o"><</span><span class="w"> </span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">Struct</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">initialize</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kp">nil</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">self</span><span class="p">)</span>
<span class="w"> </span><span class="k">super</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="p">)</span>
<span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="vi">@name</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">Stream</span><span class="o">::</span><span class="n">bytes_terminate</span><span class="p">(</span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_bytes</span><span class="p">(</span><span class="mi">22</span><span class="p">),</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="kp">false</span><span class="p">))</span><span class="o">.</span><span class="n">force_encoding</span><span class="p">(</span><span class="s2">"utf-8"</span><span class="p">)</span>
<span class="w"> </span><span class="vi">@type</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u1</span>
<span class="w"> </span><span class="vi">@num_samples</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u2le</span>
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">num_samples</span><span class="w"> </span><span class="o">></span><span class="w"> </span><span class="mi">0</span>
<span class="w"> </span><span class="vi">@extra_header</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">ExtraHeader</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="vi">@_io</span><span class="p">,</span><span class="w"> </span><span class="nb">self</span><span class="p">,</span><span class="w"> </span><span class="vi">@_root</span><span class="p">)</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="nb">self</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:name</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># Usually zero, but this seems pretty random, don't assume it's zero</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:type</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:num_samples</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:extra_header</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">ExtraHeader</span><span class="w"> </span><span class="o"><</span><span class="w"> </span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">Struct</span>
<span class="w"> </span><span class="no">TYPE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="ss">:type_true</span><span class="p">,</span>
<span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="ss">:type_sustain</span><span class="p">,</span>
<span class="w"> </span><span class="mi">2</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="ss">:type_loop</span><span class="p">,</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="no">I__TYPE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">TYPE</span><span class="o">.</span><span class="n">invert</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">initialize</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kp">nil</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">self</span><span class="p">)</span>
<span class="w"> </span><span class="k">super</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="p">)</span>
<span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="vi">@len_sample_header</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u4le</span>
<span class="w"> </span><span class="vi">@idx_sample_per_note</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">[]</span>
<span class="w"> </span><span class="p">(</span><span class="mi">96</span><span class="p">)</span><span class="o">.</span><span class="n">times</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="o">|</span><span class="n">i</span><span class="o">|</span>
<span class="w"> </span><span class="vi">@idx_sample_per_note</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u1</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="vi">@volume_points</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">[]</span>
<span class="w"> </span><span class="p">(</span><span class="mi">12</span><span class="p">)</span><span class="o">.</span><span class="n">times</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="o">|</span><span class="n">i</span><span class="o">|</span>
<span class="w"> </span><span class="vi">@volume_points</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="no">EnvelopePoint</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="vi">@_io</span><span class="p">,</span><span class="w"> </span><span class="nb">self</span><span class="p">,</span><span class="w"> </span><span class="vi">@_root</span><span class="p">)</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="vi">@panning_points</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">[]</span>
<span class="w"> </span><span class="p">(</span><span class="mi">12</span><span class="p">)</span><span class="o">.</span><span class="n">times</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="o">|</span><span class="n">i</span><span class="o">|</span>
<span class="w"> </span><span class="vi">@panning_points</span><span class="w"> </span><span class="o"><<</span><span class="w"> </span><span class="no">EnvelopePoint</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="vi">@_io</span><span class="p">,</span><span class="w"> </span><span class="nb">self</span><span class="p">,</span><span class="w"> </span><span class="vi">@_root</span><span class="p">)</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="vi">@num_volume_points</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u1</span>
<span class="w"> </span><span class="vi">@num_panning_points</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u1</span>
<span class="w"> </span><span class="vi">@volume_sustain_point</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u1</span>
<span class="w"> </span><span class="vi">@volume_loop_start_point</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u1</span>
<span class="w"> </span><span class="vi">@volume_loop_end_point</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u1</span>
<span class="w"> </span><span class="vi">@panning_sustain_point</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u1</span>
<span class="w"> </span><span class="vi">@panning_loop_start_point</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u1</span>
<span class="w"> </span><span class="vi">@panning_loop_end_point</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u1</span>
<span class="w"> </span><span class="vi">@volume_type</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">Stream</span><span class="o">::</span><span class="n">resolve_enum</span><span class="p">(</span><span class="no">TYPE</span><span class="p">,</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u1</span><span class="p">)</span>
<span class="w"> </span><span class="vi">@panning_type</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">Stream</span><span class="o">::</span><span class="n">resolve_enum</span><span class="p">(</span><span class="no">TYPE</span><span class="p">,</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u1</span><span class="p">)</span>
<span class="w"> </span><span class="vi">@vibrato_type</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u1</span>
<span class="w"> </span><span class="vi">@vibrato_sweep</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u1</span>
<span class="w"> </span><span class="vi">@vibrato_depth</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u1</span>
<span class="w"> </span><span class="vi">@vibrato_rate</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u1</span>
<span class="w"> </span><span class="vi">@volume_fadeout</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u2le</span>
<span class="w"> </span><span class="vi">@reserved</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u2le</span>
<span class="w"> </span><span class="nb">self</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># Envelope frame-counters work in range 0..FFFFh (0..65535 dec).</span>
<span class="w"> </span><span class="c1"># BUT! FT2 only itself supports only range 0..FFh (0..255 dec).</span>
<span class="w"> </span><span class="c1"># Some other trackers (like SoundTracker for Unix), however, can use the full range 0..FFFF, so it should be supported.</span>
<span class="w"> </span><span class="c1"># !!TIP: This is also a good way to detect if the module has been made with FT2 or not. (In case the tracker name is brain- deadly left unchanged!)</span>
<span class="w"> </span><span class="c1"># Of course it does not help if all instruments have the values inside FT2 supported range.</span>
<span class="w"> </span><span class="c1"># The value-field of the envelope point is ranged between 00..3Fh (0..64 dec).</span>
<span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">EnvelopePoint</span><span class="w"> </span><span class="o"><</span><span class="w"> </span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">Struct</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">initialize</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kp">nil</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">self</span><span class="p">)</span>
<span class="w"> </span><span class="k">super</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="p">)</span>
<span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="vi">@x</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u2le</span>
<span class="w"> </span><span class="vi">@y</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u2le</span>
<span class="w"> </span><span class="nb">self</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># Frame number of the point</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:x</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># Value of the point</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:y</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:len_sample_header</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># Index of sample that should be used for any particular</span>
<span class="w"> </span><span class="c1"># note. In the simplest case, where it's only one sample</span>
<span class="w"> </span><span class="c1"># is available, it's an array of full of zeroes.</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:idx_sample_per_note</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># Points for volume envelope. Only `num_volume_points` will be actually used.</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:volume_points</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># Points for panning envelope. Only `num_panning_points` will be actually used.</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:panning_points</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:num_volume_points</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:num_panning_points</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:volume_sustain_point</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:volume_loop_start_point</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:volume_loop_end_point</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:panning_sustain_point</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:panning_loop_start_point</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:panning_loop_end_point</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:volume_type</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:panning_type</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:vibrato_type</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:vibrato_sweep</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:vibrato_depth</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:vibrato_rate</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:volume_fadeout</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:reserved</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># The saved data uses simple delta-encoding to achieve better compression ratios (when compressed with pkzip, etc.)</span>
<span class="w"> </span><span class="c1"># Pseudocode for converting the delta-coded data to normal data,</span>
<span class="w"> </span><span class="c1"># old = 0;</span>
<span class="w"> </span><span class="c1"># for i in range(data_len):</span>
<span class="w"> </span><span class="c1"># new = sample[i] + old;</span>
<span class="w"> </span><span class="c1"># sample[i] = new;</span>
<span class="w"> </span><span class="c1"># old = new;</span>
<span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">SamplesData</span><span class="w"> </span><span class="o"><</span><span class="w"> </span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">Struct</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">initialize</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kp">nil</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">self</span><span class="p">,</span><span class="w"> </span><span class="n">header</span><span class="p">)</span>
<span class="w"> </span><span class="k">super</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="p">)</span>
<span class="w"> </span><span class="vi">@header</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">header</span>
<span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="vi">@data</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_bytes</span><span class="p">((</span><span class="n">header</span><span class="o">.</span><span class="n">sample_length</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="p">(</span><span class="n">header</span><span class="o">.</span><span class="n">type</span><span class="o">.</span><span class="n">is_sample_data_16_bit</span><span class="w"> </span><span class="p">?</span><span class="w"> </span><span class="mi">2</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">)))</span>
<span class="w"> </span><span class="nb">self</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:data</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:header</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">SampleHeader</span><span class="w"> </span><span class="o"><</span><span class="w"> </span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">Struct</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">initialize</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kp">nil</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">self</span><span class="p">)</span>
<span class="w"> </span><span class="k">super</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="p">)</span>
<span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="vi">@sample_length</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u4le</span>
<span class="w"> </span><span class="vi">@sample_loop_start</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u4le</span>
<span class="w"> </span><span class="vi">@sample_loop_length</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u4le</span>
<span class="w"> </span><span class="vi">@volume</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u1</span>
<span class="w"> </span><span class="vi">@fine_tune</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_s1</span>
<span class="w"> </span><span class="vi">@type</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">LoopType</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="vi">@_io</span><span class="p">,</span><span class="w"> </span><span class="nb">self</span><span class="p">,</span><span class="w"> </span><span class="vi">@_root</span><span class="p">)</span>
<span class="w"> </span><span class="vi">@panning</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u1</span>
<span class="w"> </span><span class="vi">@relative_note_number</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_s1</span>
<span class="w"> </span><span class="vi">@reserved</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_u1</span>
<span class="w"> </span><span class="vi">@name</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">Stream</span><span class="o">::</span><span class="n">bytes_terminate</span><span class="p">(</span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_bytes</span><span class="p">(</span><span class="mi">22</span><span class="p">),</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="kp">false</span><span class="p">))</span><span class="o">.</span><span class="n">force_encoding</span><span class="p">(</span><span class="s2">"utf-8"</span><span class="p">)</span>
<span class="w"> </span><span class="nb">self</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">LoopType</span><span class="w"> </span><span class="o"><</span><span class="w"> </span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">Struct</span>
<span class="w"> </span><span class="no">LOOP_TYPE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="ss">:loop_type_none</span><span class="p">,</span>
<span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="ss">:loop_type_forward</span><span class="p">,</span>
<span class="w"> </span><span class="mi">2</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="ss">:loop_type_ping_pong</span><span class="p">,</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="no">I__LOOP_TYPE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">LOOP_TYPE</span><span class="o">.</span><span class="n">invert</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">initialize</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kp">nil</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">self</span><span class="p">)</span>
<span class="w"> </span><span class="k">super</span><span class="p">(</span><span class="n">_io</span><span class="p">,</span><span class="w"> </span><span class="n">_parent</span><span class="p">,</span><span class="w"> </span><span class="n">_root</span><span class="p">)</span>
<span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="n">_read</span>
<span class="w"> </span><span class="vi">@reserved0</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_bits_int_be</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span>
<span class="w"> </span><span class="vi">@is_sample_data_16_bit</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_bits_int_be</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span><span class="w"> </span><span class="o">!=</span><span class="w"> </span><span class="mi">0</span>
<span class="w"> </span><span class="vi">@reserved1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_bits_int_be</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
<span class="w"> </span><span class="vi">@loop_type</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">Kaitai</span><span class="o">::</span><span class="no">Struct</span><span class="o">::</span><span class="no">Stream</span><span class="o">::</span><span class="n">resolve_enum</span><span class="p">(</span><span class="no">LOOP_TYPE</span><span class="p">,</span><span class="w"> </span><span class="vi">@_io</span><span class="o">.</span><span class="n">read_bits_int_be</span><span class="p">(</span><span class="mi">2</span><span class="p">))</span>
<span class="w"> </span><span class="nb">self</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:reserved0</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:is_sample_data_16_bit</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:reserved1</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:loop_type</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:sample_length</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:sample_loop_start</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:sample_loop_length</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:volume</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># -16..+15</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:fine_tune</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:type</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># (0-255)</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:panning</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:relative_note_number</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:reserved</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:name</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="c1">##</span>
<span class="w"> </span><span class="c1"># Instrument size << header that is >></span>
<span class="w"> </span><span class="c1"># << "Instrument Size" field tends to be more than the actual size of the structure documented here (it includes also the extended instrument sample header above). So remember to check it and skip the additional bytes before the first sample header >></span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:header_size</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:header</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:samples_headers</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:samples</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:_raw_header</span>
<span class="w"> </span><span class="k">end</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:preheader</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:header</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:patterns</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:instruments</span>
<span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:_raw_header</span>
<span class="k">end</span>
</pre></div>
</div>
</div>
</section>
<footer id="main-footer">
<div class="container">
© 2015–2025 Kaitai Project and <a href="https://github.com/kaitai-io/kaitai_struct_formats/graphs/contributors">format repo contributors</a>
<h3>Contacts</h3>
<div class="row">
<div class="col-sm-4">
<i class="fa fa-fw fa-2x fa-github"></i> <a href="https://github.com/kaitai-io/kaitai_struct">GitHub</a>
</div>
<div class="col-sm-4">
<i class="fa fa-fw fa-2x fa-twitter"></i> <a href="https://twitter.com/kaitai_io">@kaitai_io</a>
</div>
<div class="col-sm-4">
Gitter: <a href="https://gitter.im/kaitai_struct/Lobby">kaitai_struct</a>
</div>
</div>
</div>
</footer>
<script src="//kaitai.io/js/jquery-1.12.3.min.js"></script>
<script src="//kaitai.io/js/bootstrap.min.js"></script>
</body>
</html>