Add automatically created `**fb` spine #53

WolfgangDrescher · 2022-11-27T00:03:14Z

See humdrum-tools/verovio-humdrum-viewer#658.

This PR adds a basic implementation for a figured bass filter to automatically add **fb spines to the kern score. Ideally this filter should be implemented into Verovio to allow dynamic score manipulation with this filter in the browser.

These are my first lines of code in C++, so any feedback or code review is welcome. And please excuse me if I didn't follow conventions of the programming language. ~~I had a more generic solution but I couldn't compile it because I have no knowledge of pointers and references.~~

I always compile the whole lib with make, this takes some time. Is there a way to compile only tool-figuredbass.cpp and then run the binary (bin/figuredbass)?

Todos:

Questions:

What should the name of this new command ideally be? I saw that fb is already existing.
Would it be possible to display negative intervals? Currently - is reserved for flats in **fb spines.
Should there be a difference between 1 and 8 for compound intervals?
Is there a reference to the rhythmical timing available in NoteGrid? I found getNoteDuration but we would also need the position of the note relative to the time signature.
Is there anything I need to consider if I want to have this filter available in Verovio?
Is it possible to display the numbers under the lyrics in VHV? Can we add this option to this filter?

Remove octave and doubled intervals, use compound interval, sort intervals

WolfgangDrescher · 2022-11-29T00:59:54Z

Missing 7 when running bin/figuredbass -i -a -c.

!!!COM: Bach, Johann Sebastian
!!!OTL: Sinfonia 11
!!!ONM: 11
!!!SCT: BWV 797
**kern	**kern	**kern
*staff3	*staff2	*staff1
*clefF4	*clefG2	*clefG2
*k[b-e-]	*k[b-e-]	*k[b-e-]
*g	*g	*g
*M3/8	*M3/8	*M3/8
=1	=1	=1
4G	4.r	16r
.	.	16ddL
.	.	16b-
.	.	16g
8E-	.	8ggJ
=2	=2	=2
4D	16r	4.ff
.	16aL	.
.	16f	.
.	16d	.
8B-	[8ddJ	.
=3	=3	=3
4G	8.dd]L	4.ee-
.	16b-	.
8A	[8ccJ	.
=4	=4	=4
16B-L	8.cc]L	4.dd
16d	.	.
16B-	.	.
16G	16a	.
[8gJ	8b-J	.
=5	=5	=5
8.g]L	4.a	4cc
16e	.	.
8f#J	.	8dd
=6	=6	=6
4g	16aL	8.b-L
.	16f#J	.
.	[4g	.
.	.	16b-
8c	.	8ee-J
=7	=7	=7
4d	4g]	8.aL
.	.	16b-
8D	8f#	8ccJ
=8	=8	=8
16GL	4.g	4.b-
16D	.	.
16BB-	.	.
16GG	.	.
8GJ	.	.
*-	*-	*-

WolfgangDrescher · 2022-11-29T01:03:14Z

Same here. Missing 7 when running bin/figuredbass -a -c.

WolfgangDrescher · 2022-11-29T09:41:50Z

Fixed missing 7 with eef094d.

… not changing

WolfgangDrescher · 2022-11-29T17:50:21Z

An idea how to implement the feature to show only figures on certain beats would be something like the following. This is currently still far from perfect and e.g. completely ignores upbeats.

// tool-figuredbass.cpp line 95
for (int i=0; i<(int)grid.getSliceCount(); i++) {
	int usedBaseVoiceIndex = baseQ;
	NoteCell* baseCell = grid.cell(usedBaseVoiceIndex, i);
	if(tpqQ != 0) {
		int tpq = infile.tpq();
		int starttime = baseCell->getToken()->getDurationFromStart(tpq).getInteger();
		if(fmod(starttime, tpq / tpqQ) != 0) {
			continue;
		}
	}
	// ...
}

WolfgangDrescher · 2023-01-16T09:28:27Z

I cannot get this running in the JS toolkit. Is there something I am missing? From my side this is ready to merge now. Everything else I can contribute in new PRs.

I observed some problems with the numbers in some of the demo data available in VHV but I will open new issues for these and fix them in individual pull requests as this thread is getting long…

Fixes craigsapp#58

Closes craigsapp#56

# Conflicts: # include/humlib.h # src/humlib.cpp

Closes craigsapp#57 in d7f1db7

See craigsapp#57

WolfgangDrescher · 2023-01-19T21:46:19Z

Do you have any idea how to debug the fb filter in Verovio? I did set log level to LOG_DEBUG but there was nothing logged in the JavaScript console. I observed that when I try to render a score that was dynamically modified with an added line !!!filter: fb for everything after this verovio somewhat crashed and will not run renderToSVG anymore (no exception thrown). So at least it is doing somthing.…

Could tool-figuredbass.o in the Makefile be relevant for this?

craigsapp · 2023-01-20T00:25:04Z

For the problem of not running in Javascript, I am thinking that you need to register the tool for use as a filter in the src/tool-filter.cpp file.

Could tool-figuredbass.o in the Makefile be relevant for this?

I don't find tool-figuredbass.o in my directories. That is probably the old name for the class file before you changed it to tool-fb.cpp? In any case it should not cause a problem, since the list of *.cpp files are used to generate the list of object files (so if there is no src/tool-figuredbass.cpp file, then it will not be included in the final code library).

To be certain, you can run:
make clean
or
rm -f obj/*.o

to remove all compiled files, and then re-run make to recompile all of the existing files in src.

But if you mean it crashes in Javascript but not on the command line, here is some discussion about that (how I debug):

I don't know how to debug verovio in a web browser. There are debugging tools for javascript in browsers, but I don't think they work very well on WASM-compiled C++ code since the Javascript code is basically like assembly code and not human readable (but I have not tried to use them because I suspect they will not be useful).

You can compile it into the command-line version of verovio, and run test input through that version which will be a little more easy. There is a debugging system in XCode (but I only use command-line compiling, so I have never used it).

If you run it on the command line and the program generates a segmentation fault, then there should be a diagnostic file in ~/Library/Logs/DiagnosticReports which starts with the string "verovio" and then date that it crashed. There is a stack trace list in that file which shows all of the function calls that were open when the crash happened (newer MacOS diagnostic files make it more difficult to find that information, so opening it up from the command line such as open verovio-2022-etc.extension will open it up in a more user friendly way to see the last function it was running before crashing.

I am suspecting that your code is trying to access an array element that it should not. If you use vector::at(), then the program will crash if it accesses memory outside of the vector's memory array. If you use vector::operator[], then a memory access error will not occur, but you will end up with strange problems in strange locations (in that case see valgrind below).

I will otherwise put lots of print statements in places where I think the problem is, and then gradually narrow down the point (which usually does not take long, especially when I know which function is causing the problem).

If I get stuck, it is likely some memory access problem, and in that case I would use valgrind to find the problem:
https://valgrind.org
But that does not run on MacOS due to security (at least the last time I checked). I run it in linux. If the Javascript version of verovio crashes but the command-line one does not, then that is the time when I run valgrind because it is most likely a memory access error.

WolfgangDrescher · 2023-01-20T23:40:00Z

I don't find tool-figuredbass.o in my directories.

May bad. I meant the new tool-fb.o file.

But if you mean it crashes in Javascript but not on the command line

Thank you, this already helped. It does not crash when using bin/fb directly. But when I build verovio with the updated humlib.cpp and pass a kern file with an included line !!!filter: fb to the verovio binary it will actually not exit the program:

bool Tool_fb::run(HumdrumFile &infile)
{
    cerr << "1" << endl;
    initialize();
    cerr << "2" << endl;
    processFile(infile);
    cerr << "3" << endl;
    return true;
}

Output:

$ ./verovio /paht/to/test.krn
1
2
3

But it does not exit and I have no idea why. infile.insertDataSpineBefore() and infile.appendDataSpine() should work as expected when running humlib inside verovio, shouldn't they?

craigsapp · 2023-01-21T00:56:50Z

If the program (verovio Javascript and/or verovio/fb CLI) does not exit, then the most likely case is there is a while loop which is getting stuck in an infinite loop.

But it does not exit and I have no idea why. infile.insertDataSpineBefore() and infile.appendDataSpine() should work as expected when running humlib inside verovio, shouldn't they?

I am not guaranteeing that either of these functions is bug free :-)

I will checkout the current version of fb from your branch and see if I can track down any problems.

craigsapp · 2023-01-21T06:06:13Z

The problem is that you need to add this line at the end of the Tool_fb:processFile() function:

     m_humdrum_text << infile;

I cannot remember if this is a feature or a bug, but it seems that when using the HumFilter or Tool_filter classes (or using them in verovio), they require the output of the filter to be placed in the m_humdrum_text string stream.

After adding that line, the fb filter is working in verovio for me.

I was thinking that it could be related to the insertion direction. When using HumdrumFile::insertDataSpineBefore() I go backwards on the line rather than forwards. Going backwards on the line. I made that change before adding the m_humdrum_text line above, so I don't know if that is also a factor (but I think it would have crashed going left to right on the line rather than getting stuck).

# Conflicts: # include/humlib.h # src/humlib.cpp

WolfgangDrescher · 2023-01-21T16:13:58Z

The problem is that you need to add this line at the end of the Tool_fb:processFile() function:

Perfect, this fixed it and now it's also running for my project.

This PR is ready to merge now. This was the last issue I wanted to address. I will open new PRs when I find a solution for #59 and #60.

Next I will add a PR on vhv-documentation with some details about this filter.

craigsapp · 2023-01-21T16:56:46Z

Next I will add a PR on vhv-documentation with some details about this filter.

I created a page for the fb filter:

https://doc.verovio.humdrum.org/filter/fb

craigsapp · 2023-01-21T17:19:54Z

The fb tool is now online on VHV:

https://verovio.humdrum.org/?file=chorales/chor001.krn&filter=fb%20-f

(Also added to verovio)

WolfgangDrescher added 21 commits November 27, 2022 00:25

Add basic implementation for figuredbass filter

889e18e

Fix typo

91946d2

Remove unused var

e1a6c3a

Refactor with classes

a33cd71

Remove FiguredBassTrack and FiguredBassSlice

ec80ffe

Add intervallsatz feature

fd096f1

Add feature to sort figured bass numbers by interval

6a4f4b4

Fix compound octave

7ec9c5d

Add feature for lowest note as base

25b50a9

Remove cout

f7ee3fc

Refactor var names

5896b8e

Rename nonCompoundIntervalsQ to compoundQ

7940156

Rename noAccidentalsQ to accidentalsQ

7d8579f

Improve accidentals support

8769e03

Remove accidentals that are already present in the key signature

16c03a2

Add feature to normalize figured bass numbers

d73e246

Remove octave and doubled intervals, use compound interval, sort intervals

Add feature for abbreviated figures

deff304

Remove unused if section

f1f049e

Remove option flags as parameters

6565197

Fix missing accidentals for abbreviated figures

31703c4

Fix missing accidentals for octaves and unisons

7b36474

Fix missing 7

eef094d

WolfgangDrescher added 2 commits November 29, 2022 10:52

Improve text

bd9c99f

Add feature to hide intervals when they are sustained and the base is…

0591008

… not changing

WolfgangDrescher marked this pull request as ready for review November 29, 2022 19:10

WolfgangDrescher marked this pull request as draft November 29, 2022 19:13

WolfgangDrescher marked this pull request as ready for review January 16, 2023 09:28

WolfgangDrescher added 16 commits January 16, 2023 12:39

Fix getString to frequency

404b433

Fix --lowest option

6273e0f

Improve variable name for usedBaseKernTrack

bda171c

Improvements for sustained notes

75e09b4

Fix -t for chords

834cc93

Rename -t option to ties

357c786

Update humlib.h and humlib.cpp

5ce0978

Fix missing 1 in unisono

46a1c93

Fixes craigsapp#58

Ignore grace notes

bd09768

Closes craigsapp#56

Handle spine splits to get lowest pitch for base track

d7f1db7

Merge branch 'master' into figuredbass

02fee56

# Conflicts: # include/humlib.h # src/humlib.cpp

Remove cerr

e71c45b

Closes craigsapp#57 in d7f1db7

Add braces

8fa386b

Fix spine split when there is a rest in primary token

f79f52c

See craigsapp#57

Handle spine splits with --lowest flag

bc7d0d7

Update humlib.h and humlib.cpp

5b44429

WolfgangDrescher added 3 commits January 21, 2023 09:34

Rename m_processTrack with m_selectedKernSpines

eff5056

Add infile content to m_humdrum_text

8e1c055

Merge branch 'master' into figuredbass

fa906a0

# Conflicts: # include/humlib.h # src/humlib.cpp

craigsapp merged commit ec63ae7 into craigsapp:master Jan 21, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add automatically created `**fb` spine #53

Add automatically created `**fb` spine #53

WolfgangDrescher commented Nov 27, 2022 •

edited

Loading

WolfgangDrescher commented Nov 29, 2022

WolfgangDrescher commented Nov 29, 2022

WolfgangDrescher commented Nov 29, 2022

WolfgangDrescher commented Nov 29, 2022

WolfgangDrescher commented Jan 16, 2023

WolfgangDrescher commented Jan 19, 2023

craigsapp commented Jan 20, 2023

WolfgangDrescher commented Jan 20, 2023 •

edited

Loading

craigsapp commented Jan 21, 2023

craigsapp commented Jan 21, 2023

WolfgangDrescher commented Jan 21, 2023

craigsapp commented Jan 21, 2023

craigsapp commented Jan 21, 2023 •

edited

Loading

Add automatically created **fb spine #53

Add automatically created **fb spine #53

Conversation

WolfgangDrescher commented Nov 27, 2022 • edited Loading

WolfgangDrescher commented Nov 29, 2022

WolfgangDrescher commented Nov 29, 2022

WolfgangDrescher commented Nov 29, 2022

WolfgangDrescher commented Nov 29, 2022

WolfgangDrescher commented Jan 16, 2023

WolfgangDrescher commented Jan 19, 2023

craigsapp commented Jan 20, 2023

WolfgangDrescher commented Jan 20, 2023 • edited Loading

craigsapp commented Jan 21, 2023

craigsapp commented Jan 21, 2023

WolfgangDrescher commented Jan 21, 2023

craigsapp commented Jan 21, 2023

craigsapp commented Jan 21, 2023 • edited Loading

Add automatically created `**fb` spine #53

Add automatically created `**fb` spine #53

WolfgangDrescher commented Nov 27, 2022 •

edited

Loading

WolfgangDrescher commented Jan 20, 2023 •

edited

Loading

craigsapp commented Jan 21, 2023 •

edited

Loading