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
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
|
{* UltraStar Deluxe - Karaoke Game
*
* UltraStar Deluxe is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
* $URL$
* $Id$
*}
unit USong;
interface
{$IFDEF FPC}
{$MODE Delphi}
{$ENDIF}
{$I switches.inc}
uses
{$IFDEF MSWINDOWS}
Windows,
{$ELSE}
{$IFNDEF DARWIN}
syscall,
{$ENDIF}
baseunix,
UnixType,
{$ENDIF}
SysUtils,
Classes,
UPlatform,
ULog,
UTexture,
UCommon,
{$IFDEF DARWIN}
cthreads,
{$ENDIF}
{$IFDEF USE_PSEUDO_THREAD}
PseudoThread,
{$ENDIF}
UCatCovers,
UXMLSong,
UUnicodeUtils,
UTextEncoding,
UFilesystem,
UPath;
Const
DEFAULT_FADE_IN_TIME = 10;
DEFAULT_FADE_OUT_TIME = 4;
type
TSingMode = ( smNormal, smPartyMode, smPlaylistRandom, smMedley );
TMedleySource = ( msNone, msCalculated, msTag );
TBPM = record
BPM: real;
StartBeat: real;
end;
TScore = record
Name: UTF8String;
Score: integer;
Date: UTF8String;
end;
{ used to hold header tags that are not supported by this version of
usdx (e.g. some tags from ultrastar 0.7.0) when songs are loaded in
songeditor. They will be written the end of the song header }
TCustomHeaderTag = record
Tag: UTF8String;
Content: UTF8String;
end;
TMedley = record
Source: TMedleySource; //source of the information
StartBeat: integer; //start beat of medley
EndBeat: integer; //end beat of medley
FadeIn: integer; //start beat of fadein deprecated!
FadeOut: integer; //end beat of fadeout deprecated!
FadeIn_time: real; //FadeIn-Time in seconds
FadeOut_time: real; //FadeOut-Time in seconds
end;
TSong = class
private
FileLineNo : integer; // line, which is read last, for error reporting
function DecodeFilename(Filename: RawByteString): IPath;
function Solmizate(Note: integer; Type_: integer): string;
procedure ParseNote(LineNumber: integer; TypeP: char; StartP, DurationP, NoteP: integer; LyricS: UTF8String);
procedure NewSentence(LineNumberP: integer; Param1, Param2: integer);
function ParseLyricStringParam(const Line: RawByteString; var LinePos: integer): RawByteString;
function ParseLyricIntParam(const Line: RawByteString; var LinePos: integer): integer;
function ParseLyricFloatParam(const Line: RawByteString; var LinePos: integer): real;
function ParseLyricCharParam(const Line: RawByteString; var LinePos: integer): AnsiChar;
function ParseLyricText(const Line: RawByteString; var LinePos: integer): RawByteString;
function ReadTXTHeader(SongFile: TTextFileStream; ReadCustomTags: Boolean): boolean;
function ReadXMLHeader(const aFileName: IPath): boolean;
function GetFolderCategory(const aFileName: IPath): UTF8String;
function FindSongFile(Dir: IPath; Mask: UTF8String): IPath;
public
Path: IPath; // kust path component of file (only set if file was found)
Folder: UTF8String; // for sorting by folder (only set if file was found)
FileName: IPath; // just name component of file (only set if file was found)
// filenames
Cover: IPath;
Mp3: IPath;
Background: IPath;
Video: IPath;
// sorting methods
Genre: UTF8String;
Edition: UTF8String;
Language: UTF8String;
Year: Integer;
Title: UTF8String;
Artist: UTF8String;
Creator: UTF8String;
CoverTex: TTexture;
VideoGAP: real;
NotesGAP: integer;
Start: real; // in seconds
Finish: integer; // in miliseconds
Relative: boolean;
Resolution: integer;
BPM: array of TBPM;
GAP: real; // in miliseconds
Encoding: TEncoding;
PreviewStart: real; //in seconds
CustomTags: array of TCustomHeaderTag;
Score: array[0..2] of array of TScore;
// these are used when sorting is enabled
Visible: boolean; // false if hidden, true if visible
Main: boolean; // false for songs, true for category buttons
OrderNum: integer; // has a number of category for category buttons and songs
OrderTyp: integer; // type of sorting for this button (0=name)
CatNumber: integer; // Count of Songs in Category for Cats and Number of Song in Category for Songs
Base : array[0..1] of integer;
Rel : array[0..1] of integer;
Mult : integer;
MultBPM : integer;
LastError: AnsiString;
Medley: TMedley; //infos for medley-mode and preview start
function GetErrorLineNo: integer;
property ErrorLineNo: integer read GetErrorLineNo;
constructor Create(); overload;
constructor Create(const aFileName : IPath); overload;
function LoadSong: boolean;
function LoadXMLSong: boolean;
function Analyse(const ReadCustomTags: Boolean = false): boolean;
function AnalyseXML(): boolean;
procedure Clear();
procedure FindRefrainStart;
procedure SetMedleyMode;
function ReadMedleyFile(MedleyFilePath: IPath): boolean; //deprecated!
end;
implementation
uses
StrUtils,
TextGL,
UIni,
UPathUtils,
UMusic, //needed for Lines
UNote;
const
DEFAULT_ENCODING = encAuto;
constructor TSong.Create();
begin
inherited;
// to-do : special create for category "songs"
//dirty fix to fix folders=on
Self.Path := PATH_NONE();
Self.FileName := PATH_NONE();
Self.Cover := PATH_NONE();
Self.Mp3 := PATH_NONE();
Self.Background:= PATH_NONE();
Self.Video := PATH_NONE();
end;
// This may be changed, when we rewrite song select code.
// it is some kind of dirty, but imho the best possible
// solution as we do atm not support nested categorys.
// it works like the folder sorting in 1.0.1a
// folder is set to the first folder under the songdir
// so songs ~/.ultrastardx/songs/punk is in the same
// category as songs in shared/ultrastardx/songs are.
// note: folder is just the name of a category it has
// nothing to do with the path used for file loading
function TSong.GetFolderCategory(const aFileName: IPath): UTF8String;
var
I: Integer;
CurSongPath: IPath;
CurSongPathRel: IPath;
begin
Result := 'Unknown'; //default folder category, if we can't locate the song dir
for I := 0 to SongPaths.Count-1 do
begin
CurSongPath := SongPaths[I] as IPath;
if (aFileName.IsChildOf(CurSongPath, false)) then
begin
if (aFileName.IsChildOf(CurSongPath, true)) then
begin
// songs are in the "root" of the songdir => use songdir for the categorys name
Result := CurSongPath.RemovePathDelim.ToUTF8;
end
else
begin
// use the first subdirectory below CurSongPath as the category name
CurSongPathRel := aFileName.GetRelativePath(CurSongPath.AppendPathDelim);
Result := CurSongPathRel.SplitDirs[0].RemovePathDelim.ToUTF8;
end;
Exit;
end;
end;
end;
constructor TSong.Create(const aFileName: IPath);
begin
inherited Create();
Mult := 1;
MultBPM := 4;
LastError := '';
Self.Path := aFileName.GetPath;
Self.FileName := aFileName.GetName;
Self.Folder := GetFolderCategory(aFileName);
(*
if (aFileName.IsFile) then
begin
if ReadTXTHeader(aFileName) then
begin
LoadSong();
end
else
begin
Log.LogError('Error Loading SongHeader, abort Song Loading');
Exit;
end;
end;
*)
end;
function TSong.FindSongFile(Dir: IPath; Mask: UTF8String): IPath;
var
Iter: IFileIterator;
FileInfo: TFileInfo;
FileName: IPath;
begin
Iter := FileSystem.FileFind(Dir.Append(Mask), faDirectory);
if (Iter.HasNext) then
Result := Iter.Next.Name
else
Result := PATH_NONE;
end;
function TSong.DecodeFilename(Filename: RawByteString): IPath;
begin
Result := UPath.Path(DecodeStringUTF8(Filename, Encoding));
end;
type
EUSDXParseException = class(Exception);
{**
* Parses the Line string starting from LinePos for a parameter.
* Leading whitespace is trimmed, same applies to the first trailing whitespace.
* After the call LinePos will point to the position after the first trailing
* whitespace.
*
* Raises an EUSDXParseException if no string was found.
*
* Example:
* ParseLyricParam(Line:'Param0 Param1 Param2', LinePos:8, ...)
* -> Param:'Param1', LinePos:16 (= start of 'Param2')
*}
function TSong.ParseLyricStringParam(const Line: RawByteString; var LinePos: integer): RawByteString;
var
Start: integer;
OldLinePos: integer;
const
Whitespace = [#9, ' '];
begin
OldLinePos := LinePos;
Start := 0;
while (LinePos <= Length(Line)) do
begin
if (Line[LinePos] in Whitespace) then
begin
// check for end of param
if (Start > 0) then
Break;
end
// check for beginning of param
else if (Start = 0) then
begin
Start := LinePos;
end;
Inc(LinePos);
end;
// check if param was found
if (Start = 0) then
begin
LinePos := OldLinePos;
raise EUSDXParseException.Create('String expected');
end
else
begin
// copy param without trailing whitespace
Result := Copy(Line, Start, LinePos-Start);
// skip first trailing whitespace (if not at EOL)
if (LinePos <= Length(Line)) then
Inc(LinePos);
end;
end;
function TSong.ParseLyricIntParam(const Line: RawByteString; var LinePos: integer): integer;
var
Str: RawByteString;
OldLinePos: integer;
begin
OldLinePos := LinePos;
Str := ParseLyricStringParam(Line, LinePos);
try
Result := StrToInt(Str);
except // on EConvertError
LinePos := OldLinePos;
raise EUSDXParseException.Create('Integer expected');
end;
end;
function TSong.ParseLyricFloatParam(const Line: RawByteString; var LinePos: integer): real;
var
Str: RawByteString;
OldLinePos: integer;
begin
OldLinePos := LinePos;
Str := ParseLyricStringParam(Line, LinePos);
try
Result := StrToFloat(Str);
except // on EConvertError
LinePos := OldLinePos;
raise EUSDXParseException.Create('Float expected');
end;
end;
function TSong.ParseLyricCharParam(const Line: RawByteString; var LinePos: integer): AnsiChar;
var
Str: RawByteString;
OldLinePos: integer;
begin
OldLinePos := LinePos;
Str := ParseLyricStringParam(Line, LinePos);
if (Length(Str) <> 1) then
begin
LinePos := OldLinePos;
raise EUSDXParseException.Create('Character expected');
end;
Result := Str[1];
end;
{**
* Returns the rest of the line from LinePos as lyric text.
* Leading and trailing whitespace is not trimmed.
*}
function TSong.ParseLyricText(const Line: RawByteString; var LinePos: integer): RawByteString;
begin
if (LinePos > Length(Line)) then
Result := ''
else
begin
Result := Copy(Line, LinePos, Length(Line)-LinePos+1);
LinePos := Length(Line)+1;
end;
end;
//Load TXT Song
function TSong.LoadSong(): boolean;
var
CurLine: RawByteString;
LinePos: integer;
Count: integer;
Both: boolean;
Param0: AnsiChar;
Param1: integer;
Param2: integer;
Param3: integer;
ParamLyric: UTF8String;
I: integer;
NotesFound: boolean;
SongFile: TTextFileStream;
FileNamePath: IPath;
begin
Result := false;
LastError := '';
FileNamePath := Path.Append(FileName);
if not FileNamePath.IsFile() then
begin
LastError := 'ERROR_CORRUPT_SONG_FILE_NOT_FOUND';
Log.LogError('File not found: "' + FileNamePath.ToNative + '"', 'TSong.LoadSong()');
Exit;
end;
MultBPM := 4; // multiply beat-count of note by 4
Mult := 1; // accuracy of measurement of note
Rel[0] := 0;
Both := false;
if Length(Player) = 2 then
Both := true;
try
// Open song file for reading.....
SongFile := TMemTextFileStream.Create(FileNamePath, fmOpenRead);
try
//Search for Note Beginning
FileLineNo := 0;
NotesFound := false;
while (SongFile.ReadLine(CurLine)) do
begin
Inc(FileLineNo);
if (Length(CurLine) > 0) and (CurLine[1] in [':', 'F', '*']) then
begin
NotesFound := true;
Break;
end;
end;
if (not NotesFound) then
begin //Song File Corrupted - No Notes
Log.LogError('Could not load txt File, no notes found: ' + FileNamePath.ToNative);
LastError := 'ERROR_CORRUPT_SONG_NO_NOTES';
Exit;
end;
SetLength(Lines, 0); //just a fix.. for medley-mod
SetLength(Lines, 2);
for Count := 0 to High(Lines) do
begin
Lines[Count].High := 0;
Lines[Count].Number := 1;
Lines[Count].Current := 0;
Lines[Count].Resolution := self.Resolution;
Lines[Count].NotesGAP := self.NotesGAP;
Lines[Count].ScoreValue := 0;
//Add first line and set some standard values to fields
//see procedure NewSentence for further explantation
//concerning most of these values
SetLength(Lines[Count].Line, 1);
Lines[Count].Line[0].HighNote := -1;
Lines[Count].Line[0].LastLine := false;
Lines[Count].Line[0].BaseNote := High(Integer);
Lines[Count].Line[0].TotalNotes := 0;
end;
while true do
begin
LinePos := 0;
Param0 := ParseLyricCharParam(CurLine, LinePos);
if (Param0 = 'E') then
begin
Break
end
else if (Param0 in [':', '*', 'F']) then
begin
// read notes
Param1 := ParseLyricIntParam(CurLine, LinePos);
Param2 := ParseLyricIntParam(CurLine, LinePos);
Param3 := ParseLyricIntParam(CurLine, LinePos);
ParamLyric := ParseLyricText(CurLine, LinePos);
//Check for ZeroNote
if Param2 = 0 then
Log.LogError('Found zero-length note at "'+Param0+' '+IntToStr(Param1)+' '+IntToStr(Param2)+' '+IntToStr(Param3)+ParamLyric+'" -> Note ignored!')
else
begin
// add notes
if not Both then
// P1
ParseNote(0, Param0, (Param1+Rel[0]) * Mult, Param2 * Mult, Param3, ParamLyric)
else
begin
// P1 + P2
ParseNote(0, Param0, (Param1+Rel[0]) * Mult, Param2 * Mult, Param3, ParamLyric);
ParseNote(1, Param0, (Param1+Rel[1]) * Mult, Param2 * Mult, Param3, ParamLyric);
end;
end; //Zeronote check
end // if
else if Param0 = '-' then
begin
// reads sentence
Param1 := ParseLyricIntParam(CurLine, LinePos);
if self.Relative then
Param2 := ParseLyricIntParam(CurLine, LinePos); // read one more data for relative system
// new sentence
if not Both then
// P1
NewSentence(0, (Param1 + Rel[0]) * Mult, Param2)
else
begin
// P1 + P2
NewSentence(0, (Param1 + Rel[0]) * Mult, Param2);
NewSentence(1, (Param1 + Rel[1]) * Mult, Param2);
end;
end // if
else if Param0 = 'B' then
begin
SetLength(self.BPM, Length(self.BPM) + 1);
self.BPM[High(self.BPM)].StartBeat := ParseLyricFloatParam(CurLine, LinePos);
self.BPM[High(self.BPM)].StartBeat := self.BPM[High(self.BPM)].StartBeat + Rel[0];
self.BPM[High(self.BPM)].BPM := ParseLyricFloatParam(CurLine, LinePos);
self.BPM[High(self.BPM)].BPM := self.BPM[High(self.BPM)].BPM * Mult * MultBPM;
end;
// Read next line in File
if (not SongFile.ReadLine(CurLine)) then
Break;
Inc(FileLineNo);
end; // while
finally
SongFile.Free;
end;
except
on E: Exception do
begin
Log.LogError(Format('Error loading file: "%s" in line %d,%d: %s',
[FileNamePath.ToNative, FileLineNo, LinePos, E.Message]));
Exit;
end;
end;
for I := 0 to High(Lines) do
begin
if ((Both) or (I = 0)) then
begin
if (Length(Lines[I].Line) < 2) then
begin
LastError := 'ERROR_CORRUPT_SONG_NO_BREAKS';
Log.LogError('Error loading file: Can''t find any linebreaks in "' + FileNamePath.ToNative + '"');
exit;
end;
if (Lines[I].Line[Lines[I].High].HighNote < 0) then
begin
SetLength(Lines[I].Line, Lines[I].Number - 1);
Lines[I].High := Lines[I].High - 1;
Lines[I].Number := Lines[I].Number - 1;
Log.LogError('Error loading Song, sentence w/o note found in last line before E: ' + FileNamePath.ToNative);
end;
end;
end;
for Count := 0 to High(Lines) do
begin
if (High(Lines[Count].Line) >= 0) then
Lines[Count].Line[High(Lines[Count].Line)].LastLine := true;
end;
Result := true;
end;
//Load XML Song
function TSong.LoadXMLSong(): boolean;
var
Count: integer;
Both: boolean;
Param1: integer;
Param2: integer;
Param3: integer;
ParamS: string;
I, J: integer;
NoteIndex: integer;
NoteType: char;
SentenceEnd, Rest, Time: integer;
Parser: TParser;
FileNamePath: IPath;
begin
Result := false;
LastError := '';
FileNamePath := Path.Append(FileName);
if not FileNamePath.IsFile() then
begin
Log.LogError('File not found: "' + FileNamePath.ToNative + '"', 'TSong.LoadSong()');
exit;
end;
MultBPM := 4; // multiply beat-count of note by 4
Mult := 1; // accuracy of measurement of note
Lines[0].ScoreValue := 0;
self.Relative := false;
Rel[0] := 0;
Both := false;
if Length(Player) = 2 then
Both := true;
Parser := TParser.Create;
Parser.Settings.DashReplacement := '~';
for Count := 0 to High(Lines) do
begin
Lines[Count].High := 0;
Lines[Count].Number := 1;
Lines[Count].Current := 0;
Lines[Count].Resolution := self.Resolution;
Lines[Count].NotesGAP := self.NotesGAP;
Lines[Count].ScoreValue := 0;
//Add first line and set some standard values to fields
//see procedure NewSentence for further explantation
//concerning most of these values
SetLength(Lines[Count].Line, 1);
Lines[Count].Line[0].HighNote := -1;
Lines[Count].Line[0].LastLine := false;
Lines[Count].Line[0].BaseNote := High(Integer);
Lines[Count].Line[0].TotalNotes := 0;
end;
//Try to Parse the Song
if Parser.ParseSong(FileNamePath) then
begin
//Writeln('XML Inputfile Parsed succesful');
//Start write parsed information to Song
//Notes Part
for I := 0 to High(Parser.SongInfo.Sentences) do
begin
//Add Notes
for J := 0 to High(Parser.SongInfo.Sentences[I].Notes) do
begin
case Parser.SongInfo.Sentences[I].Notes[J].NoteTyp of
NT_Normal: NoteType := ':';
NT_Golden: NoteType := '*';
NT_Freestyle: NoteType := 'F';
end;
Param1:=Parser.SongInfo.Sentences[I].Notes[J].Start; //Note Start
Param2:=Parser.SongInfo.Sentences[I].Notes[J].Duration; //Note Duration
Param3:=Parser.SongInfo.Sentences[I].Notes[J].Tone; //Note Tone
ParamS:=' ' + Parser.SongInfo.Sentences[I].Notes[J].Lyric; //Note Lyric
if not Both then
// P1
ParseNote(0, NoteType, (Param1+Rel[0]) * Mult, Param2 * Mult, Param3, ParamS)
else
begin
// P1 + P2
ParseNote(0, NoteType, (Param1+Rel[0]) * Mult, Param2 * Mult, Param3, ParamS);
ParseNote(1, NoteType, (Param1+Rel[1]) * Mult, Param2 * Mult, Param3, ParamS);
end;
end; //J Forloop
//Add Sentence break
if (I < High(Parser.SongInfo.Sentences)) then
begin
SentenceEnd := Parser.SongInfo.Sentences[I].Notes[High(Parser.SongInfo.Sentences[I].Notes)].Start + Parser.SongInfo.Sentences[I].Notes[High(Parser.SongInfo.Sentences[I].Notes)].Duration;
Rest := Parser.SongInfo.Sentences[I+1].Notes[0].Start - SentenceEnd;
//Calculate Time
case Rest of
0, 1: Time := Parser.SongInfo.Sentences[I+1].Notes[0].Start;
2: Time := Parser.SongInfo.Sentences[I+1].Notes[0].Start - 1;
3: Time := Parser.SongInfo.Sentences[I+1].Notes[0].Start - 2;
else
if (Rest >= 4) then
Time := SentenceEnd + 2
else //Sentence overlapping :/
Time := Parser.SongInfo.Sentences[I+1].Notes[0].Start;
end;
// new sentence
if not Both then // P1
NewSentence(0, (Time + Rel[0]) * Mult, Param2)
else
begin // P1 + P2
NewSentence(0, (Time + Rel[0]) * Mult, Param2);
NewSentence(1, (Time + Rel[1]) * Mult, Param2);
end;
end;
end;
//End write parsed information to Song
Parser.Free;
end
else
begin
Log.LogError('Could not parse inputfile: ' + FileNamePath.ToNative);
exit;
end;
for Count := 0 to High(Lines) do
begin
Lines[Count].Line[High(Lines[Count].Line)].LastLine := true;
end;
Result := true;
end;
function TSong.ReadXMLHeader(const aFileName : IPath): boolean;
var
Done : byte;
Parser : TParser;
FileNamePath: IPath;
begin
Result := true;
Done := 0;
//Parse XML
Parser := TParser.Create;
Parser.Settings.DashReplacement := '~';
FileNamePath := Self.Path.Append(Self.FileName);
if Parser.ParseSong(FileNamePath) then
begin
//-----------
//Required Attributes
//-----------
//Title
self.Title := Parser.SongInfo.Header.Title;
//Add Title Flag to Done
Done := Done or 1;
//Artist
self.Artist := Parser.SongInfo.Header.Artist;
//Add Artist Flag to Done
Done := Done or 2;
//MP3 File //Test if Exists
Self.Mp3 := FindSongFile(Self.Path, '*.mp3');
//Add Mp3 Flag to Done
if (Self.Path.Append(Self.Mp3).IsFile()) then
Done := Done or 4;
//Beats per Minute
SetLength(self.BPM, 1);
self.BPM[0].StartBeat := 0;
self.BPM[0].BPM := (Parser.SongInfo.Header.BPM * Parser.SongInfo.Header.Resolution/4 ) * Mult * MultBPM;
//Add BPM Flag to Done
if self.BPM[0].BPM <> 0 then
Done := Done or 8;
//---------
//Additional Header Information
//---------
// Gap
self.GAP := Parser.SongInfo.Header.Gap;
//Cover Picture
self.Cover := FindSongFile(Path, '*[CO].jpg');
//Background Picture
self.Background := FindSongFile(Path, '*[BG].jpg');
// Video File
// self.Video := Value
// Video Gap
// self.VideoGAP := StrtoFloatI18n( Value )
//Genre Sorting
self.Genre := Parser.SongInfo.Header.Genre;
//Edition Sorting
self.Edition := Parser.SongInfo.Header.Edition;
//Year Sorting
//Parser.SongInfo.Header.Year
//Language Sorting
self.Language := Parser.SongInfo.Header.Language;
end
else
Log.LogError('File incomplete or not SingStar XML (A): ' + aFileName.ToNative);
Parser.Free;
//Check if all Required Values are given
if (Done <> 15) then
begin
Result := false;
if (Done and 8) = 0 then //No BPM Flag
Log.LogError('BPM tag missing: ' + self.FileName.ToNative)
else if (Done and 4) = 0 then //No MP3 Flag
Log.LogError('MP3 tag/file missing: ' + self.FileName.ToNative)
else if (Done and 2) = 0 then //No Artist Flag
Log.LogError('Artist tag missing: ' + self.FileName.ToNative)
else if (Done and 1) = 0 then //No Title Flag
Log.LogError('Title tag missing: ' + self.FileName.ToNative)
else //unknown Error
Log.LogError('File incomplete or not SingStar XML (B - '+ inttostr(Done) +'): ' + aFileName.ToNative);
end;
end;
{**
* "International" StrToFloat variant. Uses either ',' or '.' as decimal
* separator.
*}
function StrToFloatI18n(const Value: string): extended;
var
TempValue : string;
begin
TempValue := Value;
if (Pos(',', TempValue) <> 0) then
TempValue[Pos(',', TempValue)] := '.';
Result := StrToFloatDef(TempValue, 0);
end;
function TSong.ReadTXTHeader(SongFile: TTextFileStream; ReadCustomTags: Boolean): boolean;
var
Line, Identifier: string;
Value: string;
SepPos: integer; // separator position
Done: byte; // bit-vector of mandatory fields
MedleyFlags: byte; //bit-vector for medley/preview tags
EncFile: IPath; // encoded filename
FullFileName: string;
{ adds a custom header tag to the song
if there is no ':' in the read line, Tag should be empty
and the whole line should be in Content }
procedure AddCustomTag(const Tag, Content: String);
var Len: Integer;
begin
if ReadCustomTags then
begin
Len := Length(CustomTags);
SetLength(CustomTags, Len + 1);
CustomTags[Len].Tag := DecodeStringUTF8(Tag, Encoding);
CustomTags[Len].Content := DecodeStringUTF8(Content, Encoding);
end;
end;
begin
Result := true;
Done := 0;
MedleyFlags := 0;
FullFileName := Path.Append(Filename).ToNative;
//Read first Line
SongFile.ReadLine(Line);
if (Length(Line) <= 0) then
begin
Log.LogError('File starts with empty line: ' + FullFileName,
'TSong.ReadTXTHeader');
Result := false;
Exit;
end;
// check if file begins with a UTF-8 BOM, if so set encoding to UTF-8
if (CheckReplaceUTF8BOM(Line)) then
Encoding := encUTF8;
//Read Lines while Line starts with # or its empty
while (Length(Line) = 0) or (Line[1] = '#') do
begin
//Increase Line Number
Inc (FileLineNo);
SepPos := Pos(':', Line);
//Line has no Seperator, ignore non header field
if (SepPos = 0) then
begin
AddCustomTag('', Copy(Line, 2, Length(Line) - 1));
// read next line
if (not SongFile.ReadLine(Line)) then
begin
Result := false;
Log.LogError('File incomplete or not Ultrastar txt (A): ' + FullFileName);
Break;
end;
Continue;
end;
//Read Identifier and Value
Identifier := UpperCase(Trim(Copy(Line, 2, SepPos - 2))); //Uppercase is for Case Insensitive Checks
Value := Trim(Copy(Line, SepPos + 1, Length(Line) - SepPos));
//Check the Identifier (If Value is given)
if (Length(Value) = 0) then
begin
Log.LogWarn('Empty field "'+Identifier+'" in file ' + FullFileName,
'TSong.ReadTXTHeader');
AddCustomTag(Identifier, '');
end
else
begin
//-----------
//Required Attributes
//-----------
if (Identifier = 'TITLE') then
begin
DecodeStringUTF8(Value, Title, Encoding);
//Add Title Flag to Done
Done := Done or 1;
end
else if (Identifier = 'ARTIST') then
begin
DecodeStringUTF8(Value, Artist, Encoding);
//Add Artist Flag to Done
Done := Done or 2;
end
//MP3 File
else if (Identifier = 'MP3') then
begin
EncFile := DecodeFilename(Value);
if (Self.Path.Append(EncFile).IsFile) then
begin
self.Mp3 := EncFile;
//Add Mp3 Flag to Done
Done := Done or 4;
end;
end
//Beats per Minute
else if (Identifier = 'BPM') then
begin
SetLength(self.BPM, 1);
self.BPM[0].StartBeat := 0;
self.BPM[0].BPM := StrToFloatI18n( Value ) * Mult * MultBPM;
if self.BPM[0].BPM <> 0 then
begin
//Add BPM Flag to Done
Done := Done or 8;
end;
end
//---------
//Additional Header Information
//---------
// Gap
else if (Identifier = 'GAP') then
begin
self.GAP := StrToFloatI18n(Value);
end
//Cover Picture
else if (Identifier = 'COVER') then
begin
self.Cover := DecodeFilename(Value);
end
//Background Picture
else if (Identifier = 'BACKGROUND') then
begin
self.Background := DecodeFilename(Value);
end
// Video File
else if (Identifier = 'VIDEO') then
begin
EncFile := DecodeFilename(Value);
if (self.Path.Append(EncFile).IsFile) then
self.Video := EncFile
else
Log.LogError('Can''t find video file in song: ' + FullFileName);
end
// Video Gap
else if (Identifier = 'VIDEOGAP') then
begin
self.VideoGAP := StrToFloatI18n( Value )
end
//Genre Sorting
else if (Identifier = 'GENRE') then
begin
DecodeStringUTF8(Value, Genre, Encoding)
end
//Edition Sorting
else if (Identifier = 'EDITION') then
begin
DecodeStringUTF8(Value, Edition, Encoding)
end
//Creator Tag
else if (Identifier = 'CREATOR') then
begin
DecodeStringUTF8(Value, Creator, Encoding)
end
//Language Sorting
else if (Identifier = 'LANGUAGE') then
begin
DecodeStringUTF8(Value, Language, Encoding)
end
//Language Sorting
else if (Identifier = 'YEAR') then
begin
TryStrtoInt(Value, self.Year)
end
// Song Start
else if (Identifier = 'START') then
begin
self.Start := StrToFloatI18n( Value )
end
// Song Ending
else if (Identifier = 'END') then
begin
TryStrtoInt(Value, self.Finish)
end
// Resolution
else if (Identifier = 'RESOLUTION') then
begin
TryStrtoInt(Value, self.Resolution)
end
// Notes Gap
else if (Identifier = 'NOTESGAP') then
begin
TryStrtoInt(Value, self.NotesGAP)
end
// Relative Notes
else if (Identifier = 'RELATIVE') then
begin
if (UpperCase(Value) = 'YES') then
self.Relative := true;
end
// File encoding
else if (Identifier = 'ENCODING') then
begin
self.Encoding := ParseEncoding(Value, DEFAULT_ENCODING);
end
// PreviewStart
else if (Identifier = 'PREVIEWSTART') then
begin
self.PreviewStart := StrToFloatI18n( Value );
MedleyFlags := MedleyFlags or 1;
end
// MedleyStartBeat
else if (Identifier = 'MEDLEYSTARTBEAT') then
begin
if TryStrtoInt(Value, self.Medley.StartBeat) then
MedleyFlags := MedleyFlags or 2;
end
// MedleyEndBeat
else if (Identifier = 'MEDLEYENDBEAT') then
begin
if TryStrtoInt(Value, self.Medley.EndBeat) then
MedleyFlags := MedleyFlags or 4;
end
// unsupported tag
else
begin
AddCustomTag(Identifier, Value);
end;
end; // End check for non-empty Value
// read next line
if (not SongFile.ReadLine(Line)) then
begin
Result := false;
Log.LogError('File incomplete or not Ultrastar txt (A): ' + FullFileName);
Break;
end;
end; // while
if self.Cover.IsUnset then
self.Cover := FindSongFile(Path, '*[CO].jpg');
//Check if all Required Values are given
if (Done <> 15) then
begin
Result := false;
if (Done and 8) = 0 then //No BPM Flag
Log.LogError('BPM tag missing: ' + FullFileName)
else if (Done and 4) = 0 then //No MP3 Flag
Log.LogError('MP3 tag/file missing: ' + FullFileName)
else if (Done and 2) = 0 then //No Artist Flag
Log.LogError('Artist tag missing: ' + FullFileName)
else if (Done and 1) = 0 then //No Title Flag
Log.LogError('Title tag missing: ' + FullFileName)
else //unknown Error
Log.LogError('File incomplete or not Ultrastar txt (B - '+ inttostr(Done) +'): ' + FullFileName);
end else
begin //check medley tags
if (MedleyFlags and 6)=6 then //MedleyStartBeat and MedleyEndBeat are both set
begin
if Medley.StartBeat >= Medley.EndBeat then
MedleyFlags := MedleyFlags - 6;
end;
CurrentSong := self;
if ((MedleyFlags and 1)=0) or (self.PreviewStart<=0) then //PreviewStart is not set or <=0
begin
if (MedleyFlags and 2)=2 then
self.PreviewStart := GetTimeFromBeat(CurrentSong.Medley.StartBeat) //fallback to MedleyStart
else
self.PreviewStart := 0; //else set it to 0, it will be set in FindRefrainStart
end;
if (MedleyFlags and 6)=6 then
begin
self.Medley.Source := msTag;
//calculate fade time
self.Medley.FadeIn_time := GetTimeFromBeat(CurrentSong.Medley.StartBeat) -
DEFAULT_FADE_IN_TIME;
self.Medley.FadeOut_time := GetTimeFromBeat(CurrentSong.Medley.FadeOut) -
DEFAULT_FADE_OUT_TIME;
end else
self.Medley.Source := msNone;
end;
end;
function TSong.GetErrorLineNo: integer;
begin
if (LastError='ERROR_CORRUPT_SONG_ERROR_IN_LINE') then
Result := FileLineNo
else
Result := -1;
end;
function TSong.Solmizate(Note: integer; Type_: integer): string;
begin
case (Type_) of
1: // european
begin
case (Note mod 12) of
0..1: Result := ' do ';
2..3: Result := ' re ';
4: Result := ' mi ';
5..6: Result := ' fa ';
7..8: Result := ' sol ';
9..10: Result := ' la ';
11: Result := ' si ';
end;
end;
2: // japanese
begin
case (Note mod 12) of
0..1: Result := ' do ';
2..3: Result := ' re ';
4: Result := ' mi ';
5..6: Result := ' fa ';
7..8: Result := ' so ';
9..10: Result := ' la ';
11: Result := ' shi ';
end;
end;
3: // american
begin
case (Note mod 12) of
0..1: Result := ' do ';
2..3: Result := ' re ';
4: Result := ' mi ';
5..6: Result := ' fa ';
7..8: Result := ' sol ';
9..10: Result := ' la ';
11: Result := ' ti ';
end;
end;
end; // case
end;
procedure TSong.ParseNote(LineNumber: integer; TypeP: char; StartP, DurationP, NoteP: integer; LyricS: UTF8String);
begin
if (Ini.Solmization <> 0) then
LyricS := Solmizate(NoteP, Ini.Solmization);
with Lines[LineNumber].Line[Lines[LineNumber].High] do
begin
SetLength(Note, Length(Note) + 1);
HighNote := High(Note);
Note[HighNote].Start := StartP;
if HighNote = 0 then
begin
if Lines[LineNumber].Number = 1 then
Start := -100;
//Start := Note[HighNote].Start;
end;
Note[HighNote].Length := DurationP;
// back to the normal system with normal, golden and now freestyle notes
case TypeP of
'F': Note[HighNote].NoteType := ntFreestyle;
':': Note[HighNote].NoteType := ntNormal;
'*': Note[HighNote].NoteType := ntGolden;
end;
//add this notes value ("notes length" * "notes scorefactor") to the current songs entire value
Inc(Lines[LineNumber].ScoreValue, Note[HighNote].Length * ScoreFactor[Note[HighNote].NoteType]);
//and to the current lines entire value
Inc(TotalNotes, Note[HighNote].Length * ScoreFactor[Note[HighNote].NoteType]);
Note[HighNote].Tone := NoteP;
//if a note w/ a deeper pitch then the current basenote is found
//we replace the basenote w/ the current notes pitch
if Note[HighNote].Tone < BaseNote then
BaseNote := Note[HighNote].Tone;
Note[HighNote].Color := 1; // default color to 1 for editor
DecodeStringUTF8(LyricS, Note[HighNote].Text, Encoding);
Lyric := Lyric + Note[HighNote].Text;
End_ := Note[HighNote].Start + Note[HighNote].Length;
end; // with
end;
procedure TSong.NewSentence(LineNumberP: integer; Param1, Param2: integer);
var
I: integer;
begin
if (Lines[LineNumberP].Line[Lines[LineNumberP].High].HighNote <> -1) then
begin //create a new line
SetLength(Lines[LineNumberP].Line, Lines[LineNumberP].Number + 1);
Inc(Lines[LineNumberP].High);
Inc(Lines[LineNumberP].Number);
end
else
begin //use old line if it there were no notes added since last call of NewSentence
Log.LogError('Error loading Song, sentence w/o note found in line ' +
InttoStr(FileLineNo) + ': ' + Filename.ToNative);
end;
Lines[LineNumberP].Line[Lines[LineNumberP].High].HighNote := -1;
//set the current lines value to zero
//it will be incremented w/ the value of every added note
Lines[LineNumberP].Line[Lines[LineNumberP].High].TotalNotes := 0;
//basenote is the pitch of the deepest note, it is used for note drawing.
//if a note with a less value than the current sentences basenote is found,
//basenote will be set to this notes pitch. Therefore the initial value of
//this field has to be very high.
Lines[LineNumberP].Line[Lines[LineNumberP].High].BaseNote := High(Integer);
if self.Relative then
begin
Lines[LineNumberP].Line[Lines[LineNumberP].High].Start := Param1;
Rel[LineNumberP] := Rel[LineNumberP] + Param2;
end
else
Lines[LineNumberP].Line[Lines[LineNumberP].High].Start := Param1;
Lines[LineNumberP].Line[Lines[LineNumberP].High].LastLine := false;
end;
procedure TSong.Clear();
begin
//Main Information
Title := '';
Artist := '';
//Sortings:
Genre := 'Unknown';
Edition := 'Unknown';
Language := 'Unknown';
Year := 0;
// set to default encoding
Encoding := DEFAULT_ENCODING;
// clear custom header tags
SetLength(CustomTags, 0);
//Required Information
Mp3 := PATH_NONE;
SetLength(BPM, 0);
GAP := 0;
Start := 0;
Finish := 0;
//Additional Information
Background := PATH_NONE;
Cover := PATH_NONE;
Video := PATH_NONE;
VideoGAP := 0;
NotesGAP := 0;
Resolution := 4;
Creator := '';
Relative := false;
Medley.Source := msNone;
end;
function TSong.Analyse(const ReadCustomTags: Boolean): boolean;
var
SongFile: TTextFileStream;
begin
Result := false;
//Reset LineNo
FileLineNo := 0;
//Open File and set File Pointer to the beginning
SongFile := TMemTextFileStream.Create(Self.Path.Append(Self.FileName), fmOpenRead);
try
//Clear old Song Header
Self.clear;
//Read Header
Result := Self.ReadTxTHeader(SongFile, ReadCustomTags);
//Load Song (for testing)
Result := Result and Self.LoadSong;
finally
SongFile.Free;
end;
end;
function TSong.AnalyseXML(): boolean;
begin
Result := false;
//Reset LineNo
FileLineNo := 0;
//Clear old Song Header
self.clear;
//Read Header
Result := self.ReadXMLHeader( FileName );
//Load Song (for testing)
Result := Result and self.LoadXMLSong;
end;
{* new procedure for preview
tries find out the beginning of a refrain
and the end... *}
procedure TSong.FindRefrainStart();
Const
MEDLEY_MIN_DURATION = 30; //minimum duration of a medley-song in seconds
Type
TSeries = record
start: integer; //Start sentence of series
end_: integer; //End sentence of series
len: integer; //Length of sentence series
end;
var
I, J, K, num_lines: integer;
sentences: array of UTF8String;
series: array of TSeries;
temp_series: TSeries;
max: integer;
len_lines, len_notes: integer;
found_end: boolean;
begin
if Medley.Source = msTag then //will be deleted soon
Exit;
num_lines := Length(Lines[0].Line);
SetLength(sentences, num_lines);
//build sentences array
for I := 0 to num_lines - 1 do
begin
sentences[I] := '';
for J := 0 to Length(Lines[0].Line[I].Note) - 1 do
begin
sentences[I] := sentences[I] + Lines[0].Line[I].Note[J].Text;
end;
end;
//find equal sentences series
SetLength(series, 0);
for I := 0 to num_lines - 2 do
begin
for J := I+1 to num_lines - 1 do
begin
if sentences[I]=sentences[J] then
begin
temp_series.start := I;
temp_series.end_ := I;
if (J+J-I-1>num_lines-1) then
max:=num_lines-1-J
else
max:=J-I-1;
for K := 1 to max do
begin
if sentences[I+K]=sentences[J+K] then
temp_series.end_ := I+K
else
break;
end;
temp_series.len := temp_series.end_ - temp_series.start + 1;
SetLength(series, Length(series)+1);
series[Length(series)-1] := temp_series;
end;
end;
end;
//search for longest sequence
if Length(series)>0 then
begin
max := 0;
for I := 0 to Length(series) - 1 do
begin
if series[I].len > series[max].len then
max := I;
end;
end;
len_lines := length(Lines[0].Line);
if (Length(series)>0) and (series[max].len > 3) then
begin
Medley.StartBeat := Lines[0].Line[series[max].start].Note[0].Start;
len_notes := length(Lines[0].Line[series[max].end_].Note);
Medley.EndBeat := Lines[0].Line[series[max].end_].Note[len_notes-1].Start +
Lines[0].Line[series[max].end_].Note[len_notes-1].Length;
CurrentSong := self;
found_end := false;
//set end if duration > MEDLEY_MIN_DURATION
if GetTimeFromBeat(Medley.StartBeat)+ MEDLEY_MIN_DURATION >
GetTimeFromBeat(Medley.EndBeat) then
begin
found_end := true;
end;
//estimate the end: just go MEDLEY_MIN_DURATION
//ahead an set to a line end (if possible)
if not found_end then
begin
for I := series[max].start+1 to len_lines-1 do
begin
len_notes := length(Lines[0].Line[I].Note);
for J := 0 to len_notes - 1 do
begin
if GetTimeFromBeat(Medley.StartBeat)+ MEDLEY_MIN_DURATION >
GetTimeFromBeat(Lines[0].Line[I].Note[J].Start+
Lines[0].Line[I].Note[J].Length) then
begin
found_end := true;
Medley.EndBeat := Lines[0].Line[I].Note[len_notes-1].Start+
Lines[0].Line[I].Note[len_notes-1].Length;
break;
end;
end;
end;
end;
if found_end then
begin
Medley.Source := msCalculated;
Medley.FadeIn := Medley.StartBeat - round(GetMidBeat(DEFAULT_FADE_IN_TIME));
Medley.FadeOut := Medley.EndBeat + round(GetMidBeat(DEFAULT_FADE_OUT_TIME));
//calculate fade time
Medley.FadeIn_time := GetTimeFromBeat(Medley.StartBeat) - GetTimeFromBeat(Medley.FadeIn);
Medley.FadeOut_time := GetTimeFromBeat(Medley.FadeOut) - GetTimeFromBeat(Medley.EndBeat);
end;
end;
//set PreviewStart if not set
if PreviewStart=0 then
begin
len_notes := length(Lines[0].Line[len_lines-1].Note);
if Medley.Source = msCalculated then
PreviewStart := GetTimeFromBeat(Medley.StartBeat)
else
PreviewStart := (GetTimeFromBeat(Lines[0].Line[len_lines-1].Note[len_notes-1].start+
Lines[0].Line[len_lines-1].Note[len_notes-1].length))/4;
end;
end;
//sets a song to medley-mod:
//converts all unneeded notes into freestyle
//updates score values
procedure TSong.SetMedleyMode;
var
pl, line, note: integer;
LF: TLineFragment;
start: integer;
end_: integer;
begin
start := self.Medley.StartBeat;
end_ := self.Medley.EndBeat;
for pl := 0 to Length(Lines) - 1 do
begin
Lines[pl].ScoreValue := 0;
for line := 0 to Length(Lines[pl].Line) - 1 do
begin
Lines[pl].Line[line].TotalNotes := 0;
for note := 0 to Length(Lines[pl].Line[line].Note) - 1 do
begin
LF := Lines[pl].Line[line].Note[note];
if LF.Start < start then //check start
Lines[pl].Line[line].Note[note].NoteType := ntFreestyle
else if LF.Start>= end_ then //check end
Lines[pl].Line[line].Note[note].NoteType := ntFreestyle
else
begin
//add this notes value ("notes length" * "notes scorefactor") to the current songs entire value
Inc(Lines[pl].ScoreValue, LF.Length * ScoreFactor[LF.NoteType]);
//and to the current lines entire value
Inc(Lines[pl].Line[line].TotalNotes, LF.Length * ScoreFactor[LF.NoteType]);
end;
end;
end;
end;
end;
//reads the txtm
//whole function is deprecated
//TODO: write a tool to convert existing txtm
function TSong.ReadMedleyFile(MedleyFilePath: IPath): boolean;
var
Line, Identifier: string;
Value: string;
SepPos: integer; // separator position
Done: byte; // bit-vector of mandatory fields
EncFile: IPath; // encoded filename
FullFileName: string;
LineNo: integer;
MedleyFile: TTextFileStream;
found_fadeIn, found_fadeOut: boolean;
begin
Result := true;
Done := 0;
MedleyFile := TMemTextFileStream.Create(MedleyFilePath, fmOpenRead);
FullFileName := MedleyFilePath.ToNative;
//set standard values
found_fadeIn := false;
found_fadeOut := false;
//Read first Line
MedleyFile.ReadLine(Line);
if (Length(Line) <= 0) then
begin
Log.LogError('File starts with empty line: ' + FullFileName,
'TSong.ReadMedleyFile');
Result := false;
Exit;
end;
// check if file begins with a UTF-8 BOM, if so set encoding to UTF-8
if (CheckReplaceUTF8BOM(Line)) then
Encoding := encUTF8;
//Read Lines while Line starts with # or its empty
while (Length(Line) = 0) or (Line[1] = '#') do
begin
//Increase Line Number
Inc (LineNo);
SepPos := Pos(':', Line);
//Line has no Seperator, ignore non header field
if (SepPos = 0) then
begin
// read next line
if (not MedleyFile.ReadLine(Line)) then
begin
Result := false;
Log.LogError('File incomplete or not Ultrastar txtm (A): ' + FullFileName);
Break;
end;
Continue;
end;
//Read Identifier and Value
Identifier := UpperCase(Trim(Copy(Line, 2, SepPos - 2))); //Uppercase is for Case Insensitive Checks
Value := Trim(Copy(Line, SepPos + 1, Length(Line) - SepPos));
//Check the Identifier (If Value is given)
if (Length(Value) = 0) then
begin
Log.LogWarn('Empty field "'+Identifier+'" in file ' + FullFileName,
'TSong.ReadMedleyFile');
end
else
begin
//-----------
//Required Attributes
//-----------
if (Identifier = 'START') then
begin
if TryStrtoInt(Value, self.Medley.StartBeat) then
//Add START flag to Done
Done := Done or 1;
end
else if (Identifier = 'END') then
begin
if TryStrtoInt(Value, self.Medley.EndBeat) then
//Add END Flag to Done
Done := Done or 2;
end
//---------
//Additional Header Information
//---------
else if (Identifier = 'FADE_IN') then
begin
if TryStrtoInt(Value, self.Medley.FadeIn) then
found_fadeIn := true;
end
else if (Identifier = 'FADE_OUT') then
begin
if TryStrtoInt(Value, self.Medley.FadeOut) then
found_fadeOut := true;
end
end; // End check for non-empty Value
// read next line
if (not MedleyFile.ReadLine(Line)) then
begin
Result := false;
Log.LogError('File incomplete or not Ultrastar txtm (A): ' + FullFileName);
Break;
end;
end; // while
//Check if all Required Values are given
if (Done <> 3) then
begin
Result := false;
if (Done and 2) = 0 then //No End Flag
Log.LogError('END tag missing: ' + FullFileName)
else if (Done and 1) = 0 then //No Start Flag
Log.LogError('START tag missing: ' + FullFileName)
else //unknown Error
Log.LogError('File incomplete or not Ultrastar txtm (B - '+ inttostr(Done) +'): ' + FullFileName);
Self.Medley.Source := msNone;
end else if self.Medley.StartBeat>=self.Medley.EndBeat then
begin
Log.LogError('Failed to load MEDLEY-TAGS (Start>=End): ' + FullFileName);
self.Medley.Source := msNone;
Result := false;
end else if found_fadeIn and (self.Medley.FadeIn>=self.Medley.StartBeat) then
begin
Log.LogError('Failed to load MEDLEY-TAGS (FadeIn>=Start): ' + FullFileName);
self.Medley.Source := msNone;
Result := false;
end else if found_fadeOut and (self.Medley.EndBeat>=self.Medley.FadeOut) then
begin
Log.LogError('Failed to load MEDLEY-TAGS (End>=FadeOut): ' + FullFileName);
self.Medley.Source := msNone;
Result := false;
end else
begin
self.Medley.Source := msTag;
CurrentSong := self;
if not found_fadeIn then //set FadeIn if not defined
begin // TODO: what if FadeIn < song start?
self.Medley.FadeIn := self.Medley.StartBeat - round(GetMidBeat(DEFAULT_FADE_IN_TIME));
end;
if not found_fadeOut then //set FadeOut if not defined
begin // TODO: what if FadeOut > song end?
self.Medley.FadeOut := self.Medley.EndBeat + round(GetMidBeat(DEFAULT_FADE_OUT_TIME));
end;
//calculate fade time
self.Medley.FadeIn_time := GetTimeFromBeat(CurrentSong.Medley.StartBeat) -
GetTimeFromBeat(CurrentSong.Medley.FadeIn);
self.Medley.FadeOut_time := GetTimeFromBeat(CurrentSong.Medley.FadeOut) -
GetTimeFromBeat(CurrentSong.Medley.EndBeat);
//set PreviewStart
if self.PreviewStart<=0 then //PreviewStart is not set or <=0
self.PreviewStart := GetTimeFromBeat(CurrentSong.Medley.StartBeat); //fallback to MedleyStart
end;
end;
end.
|