Skip to content

feat: add support for tuning alterations #2838

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kulek1 wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

feat: add support for tuning alterations #2838

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 58 additions & 38 deletions packages/alphatab/scripts/Serializer.setProperty.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,47 +95,67 @@ function generateSetPropertyBody(serializable: TypeSchema, importer: (name: stri
caseStatements.push(ts.factory.createReturnStatement(ts.factory.createTrue()));
} else if (prop.type.isArray) {
const arrayItemType = prop.type.arrayItemType!;
const collectionAddMethod =
(prop.jsDocTags.filter(t => t.tagName.text === 'json_add').map(t => t.comment ?? '')[0] as string) ??
`${fieldName}.push`;

// obj.fieldName = [];
// for(const i of value) {
// obj.addFieldName(Type.FromJson(i));
// }
// or
// for(const __li of value) {
// obj.fieldName.push(Type.FromJson(__li));
// }

const itemSerializer = `${arrayItemType.typeAsString}Serializer`;
importer(itemSerializer, findSerializerModule(arrayItemType));
importer(arrayItemType.typeAsString, arrayItemType.modulePath);

const loopItems = [
createNodeFromSource<ts.ExpressionStatement>(
`obj.${fieldName} = [];`,
if (arrayItemType.isEnumType) {
importer(arrayItemType.typeAsString, arrayItemType.modulePath);
importer('JsonHelper', '@coderline/alphatab/io/JsonHelper');
const parseEnumArray = createNodeFromSource<ts.ExpressionStatement>(
`obj.${fieldName} = (v as number[]).map(i => JsonHelper.parseEnum<${arrayItemType.typeAsString}>(i, ${arrayItemType.typeAsString})!);`,
ts.SyntaxKind.ExpressionStatement
),
createNodeFromSource<ts.ForOfStatement>(
`for(const o of (v as (Map<string, unknown> | null)[])) {
const i = new ${arrayItemType.typeAsString}();
${itemSerializer}.fromJson(i, o);
obj.${collectionAddMethod}(i)
}`,
ts.SyntaxKind.ForOfStatement
)
];

if (prop.type.isNullable || prop.type.isOptional) {
caseStatements.push(
ts.factory.createIfStatement(
ts.factory.createIdentifier('v'),
ts.factory.createBlock(loopItems, true)
)
);
if (prop.type.isNullable || prop.type.isOptional) {
caseStatements.push(
ts.factory.createIfStatement(
ts.factory.createIdentifier('v'),
ts.factory.createBlock([parseEnumArray], true)
)
);
} else {
caseStatements.push(parseEnumArray);
}
} else {
caseStatements.push(...loopItems);
const collectionAddMethod =
(prop.jsDocTags.filter(t => t.tagName.text === 'json_add').map(t => t.comment ?? '')[
0
] as string) ?? `${fieldName}.push`;

// obj.fieldName = [];
// for(const i of value) {
// obj.addFieldName(Type.FromJson(i));
// }
// or
// for(const __li of value) {
// obj.fieldName.push(Type.FromJson(__li));
// }

const itemSerializer = `${arrayItemType.typeAsString}Serializer`;
importer(itemSerializer, findSerializerModule(arrayItemType));
importer(arrayItemType.typeAsString, arrayItemType.modulePath);

const loopItems = [
createNodeFromSource<ts.ExpressionStatement>(
`obj.${fieldName} = [];`,
ts.SyntaxKind.ExpressionStatement
),
createNodeFromSource<ts.ForOfStatement>(
`for(const o of (v as (Map<string, unknown> | null)[])) {
const i = new ${arrayItemType.typeAsString}();
${itemSerializer}.fromJson(i, o);
obj.${collectionAddMethod}(i)
}`,
ts.SyntaxKind.ForOfStatement
)
];

if (prop.type.isNullable || prop.type.isOptional) {
caseStatements.push(
ts.factory.createIfStatement(
ts.factory.createIdentifier('v'),
ts.factory.createBlock(loopItems, true)
)
);
} else {
caseStatements.push(...loopItems);
}
}
caseStatements.push(ts.factory.createReturnStatement(ts.factory.createTrue()));
} else if (prop.type.isMap) {
Expand Down
30 changes: 29 additions & 1 deletion packages/alphatab/scripts/Serializer.toJson.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,35 @@ function generateToJsonBody(serializable: TypeSchema, importer: (name: string, m
}
} else if (prop.type.isArray) {
const arrayItemType = prop.type.arrayItemType!;
if (arrayItemType.isOwnType && !arrayItemType.isEnumType) {
if (arrayItemType.isEnumType) {
const serializeStatement = createNodeFromSource<ts.ExpressionStatement>(
`
o.set(${JSON.stringify(jsonName)}, obj.${fieldName});
`,
ts.SyntaxKind.ExpressionStatement
);
if (prop.type.isNullable) {
propertyStatements.push(
createNodeFromSource<ts.IfStatement>(
`if(obj.${fieldName} !== null) {
o.set(${JSON.stringify(jsonName)}, obj.${fieldName});
}`,
ts.SyntaxKind.IfStatement
)
);
} else if (prop.type.isOptional) {
propertyStatements.push(
createNodeFromSource<ts.IfStatement>(
`if(obj.${fieldName} !== undefined) {
o.set(${JSON.stringify(jsonName)}, obj.${fieldName});
}`,
ts.SyntaxKind.IfStatement
)
);
} else {
propertyStatements.push(serializeStatement);
}
} else if (arrayItemType.isOwnType) {
const itemSerializer = `${arrayItemType.typeAsString}Serializer`;
importer(itemSerializer, findSerializerModule(arrayItemType));
if (prop.type.isNullable) {
Expand Down
19 changes: 16 additions & 3 deletions packages/alphatab/src/exporter/AlphaTexExporter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -512,7 +512,12 @@ export class AlphaTexExporter extends ScoreExporter {
if (data.bars.length === 0) {
const bar: AlphaTexBarNode = {
nodeType: AlphaTexNodeType.Bar,
metaData: this._handler.buildBarMetaDataNodes(data, undefined, 0, false),
metaData: this._handler.buildBarMetaDataNodes(
data,
undefined,
0,
false
),
beats: [],
pipe: undefined
};
Expand All @@ -533,7 +538,12 @@ export class AlphaTexExporter extends ScoreExporter {
private _bar(score: AlphaTexScoreNode, data: Bar, voiceIndex: number, isMultiVoice: boolean) {
const bar: AlphaTexBarNode = {
nodeType: AlphaTexNodeType.Bar,
metaData: this._handler.buildBarMetaDataNodes(data.staff, data, voiceIndex, isMultiVoice),
metaData: this._handler.buildBarMetaDataNodes(
data.staff,
data,
voiceIndex,
isMultiVoice
),
beats: [],
pipe: undefined
};
Expand Down Expand Up @@ -677,7 +687,10 @@ export class AlphaTexExporter extends ScoreExporter {
} else if (data.isPiano) {
note.noteValue = {
nodeType: AlphaTexNodeType.Ident,
text: Tuning.getTextForTuning(data.realValueWithoutHarmonic, true)
text: Tuning.getTextForTuning(
data.realValueWithoutHarmonic,
true
)
} as AlphaTexIdentifier;
} else if (data.isStringed) {
note.noteValue = {
Expand Down
35 changes: 32 additions & 3 deletions packages/alphatab/src/exporter/GpifWriter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ import { SlideOutType } from '@coderline/alphatab/model/SlideOutType';
import type { Staff } from '@coderline/alphatab/model/Staff';
import type { Track } from '@coderline/alphatab/model/Track';
import { TripletFeel } from '@coderline/alphatab/model/TripletFeel';
import { Tuning } from '@coderline/alphatab/model/Tuning';
import { Tuning, TuningAccidentalMode } from '@coderline/alphatab/model/Tuning';
import { VibratoType } from '@coderline/alphatab/model/VibratoType';
import type { Voice } from '@coderline/alphatab/model/Voice';
import { WahPedal } from '@coderline/alphatab/model/WahPedal';
Expand Down Expand Up @@ -1300,6 +1300,7 @@ export class GpifWriter {
private _writeStaffNode(parent: XmlNode, staff: Staff) {
const staffNode = parent.addElement('Staff');
const properties = staffNode.addElement('Properties');
const tuningAccidentalMode = this._getTuningAccidentalMode(staff);

this._writeSimplePropertyNode(properties, 'CapoFret', 'Fret', staff.capo.toString());
this._writeSimplePropertyNode(properties, 'FretCount', 'Fret', '24');
Expand All @@ -1326,7 +1327,9 @@ export class GpifWriter {
tuningProperty.addElement('Pitches').innerText = tuning.slice().reverse().join(' ');
tuningProperty.addElement('Label').setCData(tuningName);
tuningProperty.addElement('LabelVisible').innerText = tuningName ? 'true' : 'false';
tuningProperty.addElement('Flat');
if (tuningAccidentalMode !== TuningAccidentalMode.Sharp) {
tuningProperty.addElement('Flat');
}

if (staff.isPercussion) {
tuningProperty.addElement('Instrument').innerText = 'Undefined';
Expand Down Expand Up @@ -1388,12 +1391,38 @@ export class GpifWriter {
staff.tuning.map(_ => '0').join('')
);

this._writeSimplePropertyNode(properties, 'TuningFlat', 'Enable', null);
if (tuningAccidentalMode !== TuningAccidentalMode.Sharp) {
this._writeSimplePropertyNode(properties, 'TuningFlat', 'Enable', null);
}

this._writeDiagramCollection(properties, staff, 'DiagramCollection');
this._writeDiagramCollection(properties, staff, 'DiagramWorkingSet');
}

private _getTuningAccidentalMode(staff: Staff): TuningAccidentalMode | undefined {
if (staff.stringTuning.accidentalModes === undefined) {
return undefined;
}
let mode: TuningAccidentalMode | null = null;
for (let i = 0; i < staff.tuning.length; i++) {
const flatName = Tuning.getTextForTuning(staff.tuning[i], false, TuningAccidentalMode.Flat);
const sharpName = Tuning.getTextForTuning(staff.tuning[i], false, TuningAccidentalMode.Sharp);
if (flatName === sharpName) {
continue;
}

const stringMode = staff.stringTuning.getAccidentalMode(i);
if (mode === null) {
mode = stringMode;
} else if (mode !== stringMode) {
// GPIF has one alteration preference for the whole tuning.
// Keep the legacy flat output when the model contains mixed modes.
return TuningAccidentalMode.Flat;
}
}
return mode ?? undefined;
}

private _writeDiagramCollection(properties: XmlNode, staff: Staff, name: string) {
const diagramCollectionProperty = properties.addElement('Property');
diagramCollectionProperty.attributes.set('name', name);
Expand Down
9 changes: 9 additions & 0 deletions packages/alphatab/src/generated/model/TuningSerializer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
// </auto-generated>
import { Tuning } from "@coderline/alphatab/model/Tuning";
import { JsonHelper } from "@coderline/alphatab/io/JsonHelper";
import { TuningAccidentalMode } from "@coderline/alphatab/model/Tuning";
/**
* @internal
*/
Expand All @@ -23,6 +24,9 @@ export class TuningSerializer {
o.set("isstandard", obj.isStandard);
o.set("name", obj.name);
o.set("tunings", obj.tunings);
if (obj.accidentalModes !== undefined) {
o.set("accidentalmodes", obj.accidentalModes);
}
return o;
}
public static setProperty(obj: Tuning, property: string, v: unknown): boolean {
Expand All @@ -36,6 +40,11 @@ export class TuningSerializer {
case "tunings":
obj.tunings = v! as number[];
return true;
case "accidentalmodes":
if (v) {
obj.accidentalModes = (v as number[]).map(i => JsonHelper.parseEnum<TuningAccidentalMode>(i, TuningAccidentalMode)!);
}
return true;
}
return false;
}
Expand Down
1 change: 1 addition & 0 deletions packages/alphatab/src/importer/AlphaTexImporter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -785,6 +785,7 @@ export class AlphaTexImporter extends ScoreImporter implements IAlphaTexImporter
staff.isPercussion = true;
staff.stringTuning.reset();
staff.stringTuning.tunings = [0, 0, 0, 0, 0, 0];
staff.stringTuning.accidentalModes = undefined;
if (!this._state.staffHasExplicitDisplayTransposition.has(staff)) {
staff.displayTranspositionPitch = 0;
}
Expand Down
Loading