Display music metadata in the level editor #2674

jamescdericco · 2023-11-11T18:38:33Z

When navigating or hovering over menu items in the level editor music object settings file browser, information about a song's author, license, and title will now be displayed in the menu item help text at the bottom of the screen.

This pull request adds:

A software implementation
author, license and title data for most SuperTux music files in data/music
Updated authorship data in the game credits and data/AUTHORS
A realignment of the display of menu item help text that fixes cropping of long (>4 line) menu item help texts that occur for some songs. (this is in a separate commit)

The author, license and title fields are option for music files. SuperTux simply omits the display of any fields that are not present in music files, and if none of these fields are defined for a music file (like christmas_theme.music, currently), then help text does not display for that song.

tobbi · 2023-11-26T17:03:21Z

src/editor/object_option.cpp

@@ -440,7 +442,7 @@ FileObjectOption::to_string() const
 void
 FileObjectOption::add_to_menu(Menu& menu) const
 {
-  menu.add_file(get_text(), m_value_pointer, m_filter, m_basedir, m_path_relative_to_basedir);
+  menu.add_file(get_text(), m_value_pointer, m_filter, m_basedir, m_path_relative_to_basedir, -1, m_generate_help_text_for_file);


m_generate_help_text_for_file somehow suggests that this is boolean. No idea if I can think of another name, though.

src/gui/menu_filesystem.cpp

src/gui/menu.cpp

src/editor/object_settings.cpp

Vankata453 · 2023-11-26T17:14:10Z

src/editor/object_settings.cpp

+
+    std::string help_text =
+        title_or_filename + (author.empty() ? "" : "\n by " + author)
+        + (license.empty() ? "" : "\nLicense: " + license);


fmt::format should be used here to support translations.

fmt::format(fmt::runtime(_("{} by {}")), title_or_filename, author) in one variable, if an author is provided. If not, only copy the title to this variable (by the way, if no info is provided, maybe nothing should be shown at all?).

"\n" + fmt::format(fmt::runtime(_("License: {}")), license) in another variable, if license is provided. If not, keep empty.

Return the two variables concatenated.

Hi @Vankata453, good catch: I updated the code to support translations. However, while I wrote the code, I discovered that there's an issue preventing "{}" substitutions from working in the current Git master version. I reported this issue in issue #2700.

I am currently working on code changes based on your recommendation. There are some differences I would lke to make to your suggestions. Notably, I would like to translate just the word License with _("License") + ": {}" to take advantage of an existing .po file msgid "License" translations.

There may be an issue with _("{} by {}") msgid for some languages like Japanese, where it seems that the order of the first two arguments should be swapped, relative to the English message. For example, '"Piano Man" by Billy Joel' is Birī Joeru no `piano man' in Japanese (according to Google Translate). I'll lookup how to support argument swapping with tinygettext.

Currently, there is a newline separating the TITLE and the "by AUTHOR" parts. Do you know if _("{}\nby {}") works?

Notably, I would like to translate just the word License with _("License") + ": {}" to take advantage of an existing .po file msgid "License" translations.

Seems fine.

Currently, there is a newline separating the TITLE and the "by AUTHOR" parts. Do you know if _("{}\nby {}") works?

I believe it should.

src/editor/object_settings.cpp

jamescdericco · 2023-11-27T17:28:01Z

Thanks for all your feedback @tobbi and @Vankata453! I pushed commits that fix all the easy code style changes, I will work on resolving your remaining feedback tomorrow.

MatusGuy · 2023-11-27T17:30:17Z

i have enabled workflows in this pr

mrkubax10 · 2023-12-07T17:09:23Z

What is the current state of this PR?

jamescdericco · 2023-12-11T22:24:06Z

What is the current state of this PR?

@mrkubax10 I am resolving remaining feedback on this PR. In particular, right now I am working on supporting translations.

tobbi · 2023-12-26T11:27:13Z

Looking good! My only style complaint would be that m_generate_help_text_for_file sounds like it's a bool parameter, not a function. But that's not important.

MatusGuy · 2023-12-26T11:30:29Z

May I suggest something like help_text_for_file_generator or help_text_generator

src/gui/menu_filesystem.cpp

tobbi · 2024-03-03T03:00:03Z

What still needs to get done here?

jamescdericco · 2024-03-04T03:42:21Z

What still needs to get done here?

To Do

WIP: Finish refactor to use item_processor
Plan how to remove English phrases from the author field to support translation
Add music metadata for music added to SuperTux master recently (since December)

This feature was functionally complete, but refactoring it to use the Vankata's item_processor parameter (instead of the separate specific generate_help_text_for_file) and rebasing it on the latest master is still a work in progress. Also, there are English phrases within the author field data that should be translated (some author values include a lot of info, including roles different contributors had for a given song). Finally, there are a few new music files added to SuperTux since December that need the metadata fields added to their .music files.

Current Progress on Refactoring

Last week I worked on the refactoring, and I am planning on continuing the refactor this week. UPDATE March 4: I fixed the illegal instruction exception by fixing return statements in the item_processor function. Now I am continuing to debug other issues until the refactored code works. My current work is held up by a tricky illegal instruction exception issue when the item_processor callback returns in my local refactored code, which I am going to try solving this week by rebuilding and updating my development container to fix potential ABI compatibility issues. Last week I tried using Google's AddressSanitizer to search for memory corruption, but it didn't report any issues in my testing.

bruhmoent · 2024-07-06T14:46:48Z

Is this done?

jamescdericco · 2024-07-09T22:18:40Z

Is this done?

This is work in progress. All functionality and translations are complete. Still left to do are updating music metadata, like title, author and license, for recent music added to the game, and refactor to extract music help text item processor function out of object_settings.cpp. I'm planning on resuming my work for this PR this week.

tobbi · 2024-07-09T22:19:42Z

Thank you! 👍

…erTux#2617) Whenever any of author, title and license fields are defined for music files, help text showing this music metadata is displayed when hovering over ".music" files in the level editor music object file browser. This commit adds both the software implementation and author, title, and license values added to SuperTux music files in data/music. The game credits and data/AUTHORS are updated in some cases where there is new authorship data. Fixes SuperTux#2617.

jamescdericco · 2024-08-02T21:07:44Z

This pull request is ready for code review and merging! I completed all the remaining work that I mentioned in my last status update 3 weeks ago. The code now uses m_item_processor, resolving feedback provided by @Vankata453. My testing passed for the level editor, as well as regression tests for story mode. It looks good to merge by me, but it would be good for this to get reviewed by other contributors.

Vankata453

Works great! You can see all important information about a music file:

Left 2 minor code-related comments. If you agree with any of them, I am also up to make the changes listed (if you want me to, of course). Offering that, so you don't have to do any code-related work on this no more if you don't want to, seeing the effort you put in throughout all this time, encouraged by all the previous comments.

src/gui/menu_filesystem_item_processor_music_help.cpp

src/supertux/menu/editor_converters_menu.cpp

Co-authored-by: Vankata453 <[email protected]>

Resolves code review issue pointing out that this standalone function is out of place among the classes of the src/gui folder. item_processor is now specified using an anonymous function in the method ObjectSettings::add_music().

jamescdericco · 2024-08-02T23:35:19Z

Works great! You can see all important information about a music file:

Left 2 minor code-related comments. If you agree with any of them, I am also up to make the changes listed (if you want me to, of course). Offering that, so you don't have to do any code-related work on this no more if you don't want to, seeing the effort you put in throughout all this time, encouraged by all the previous comments.

Thanks for the feedback: I fixed both of them! I enabled "Allow edits by maintainers" for this PR so you are welcome to add commits to the PR repo if you prefer. However, I am happy to fix any additional feedback you mention here on GitHub.

[ci skip]

jamescdericco force-pushed the 2617-music-author branch 5 times, most recently from a254832 to f595359 Compare November 26, 2023 16:26

jamescdericco marked this pull request as ready for review November 26, 2023 16:32

jamescdericco marked this pull request as draft November 26, 2023 16:41

jamescdericco force-pushed the 2617-music-author branch from f595359 to 32ff1d7 Compare November 26, 2023 16:43

jamescdericco marked this pull request as ready for review November 26, 2023 16:44

jamescdericco force-pushed the 2617-music-author branch from 32ff1d7 to 2bc9f35 Compare November 26, 2023 16:47

jamescdericco mentioned this pull request Nov 26, 2023

.music files should have an "author" entry. #2617

Open

tobbi reviewed Nov 26, 2023

View reviewed changes

Vankata453 reviewed Nov 26, 2023

View reviewed changes

jamescdericco force-pushed the 2617-music-author branch from 08ca4ec to 60276d2 Compare December 8, 2023 20:32

jamescdericco force-pushed the 2617-music-author branch from 39b5cef to b85fb20 Compare December 19, 2023 19:37

Vankata453 requested changes Dec 26, 2023

View reviewed changes

src/gui/menu_filesystem.cpp Outdated Show resolved Hide resolved

jamescdericco force-pushed the 2617-music-author branch 2 times, most recently from fafa7f2 to a0db7f7 Compare January 16, 2024 17:00

mrkubax10 added involves:editor type:feature category:code status:needs-work In progress, but no one is currently working on it (New volunteers welcome) labels Jan 29, 2024

jamescdericco force-pushed the 2617-music-author branch 2 times, most recently from 82cca71 to b919e6b Compare May 10, 2024 14:45

jamescdericco force-pushed the 2617-music-author branch from d776cbe to 5fd0d6d Compare May 15, 2024 14:53

jamescdericco force-pushed the 2617-music-author branch 7 times, most recently from abecc37 to 4969e2f Compare July 19, 2024 20:46

jamescdericco force-pushed the 2617-music-author branch 4 times, most recently from 8f50cda to d613c1f Compare August 2, 2024 18:30

jamescdericco force-pushed the 2617-music-author branch from d613c1f to c579652 Compare August 2, 2024 20:57

Vankata453 reviewed Aug 2, 2024

View reviewed changes

src/gui/menu_filesystem_item_processor_music_help.cpp Outdated Show resolved Hide resolved

src/supertux/menu/editor_converters_menu.cpp Outdated Show resolved Hide resolved

jamescdericco and others added 2 commits August 2, 2024 18:29

editor_converters_menu.cpp: Fix indentation code style

1065b33

Co-authored-by: Vankata453 <[email protected]>

tobbi added 3 commits August 3, 2024 09:10

Add new line to salcon.music

c4de5c7

[ci skip]

Add new line to forest2.music

bc615f9

[ci skip]

Add new line to forest3.music

8bd4900

[ci skip]

jamescdericco requested a review from Vankata453 August 9, 2024 20:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Display music metadata in the level editor #2674

Display music metadata in the level editor #2674

jamescdericco commented Nov 11, 2023 •

edited

Loading

tobbi Nov 26, 2023

Vankata453 Nov 26, 2023

jamescdericco Dec 12, 2023

Vankata453 Dec 12, 2023

jamescdericco commented Nov 27, 2023

MatusGuy commented Nov 27, 2023

mrkubax10 commented Dec 7, 2023

jamescdericco commented Dec 11, 2023

tobbi commented Dec 26, 2023

MatusGuy commented Dec 26, 2023

tobbi commented Mar 3, 2024

jamescdericco commented Mar 4, 2024 •

edited

Loading

bruhmoent commented Jul 6, 2024

jamescdericco commented Jul 9, 2024

tobbi commented Jul 9, 2024

jamescdericco commented Aug 2, 2024

Vankata453 left a comment

jamescdericco commented Aug 2, 2024

Display music metadata in the level editor #2674

Are you sure you want to change the base?

Display music metadata in the level editor #2674

Conversation

jamescdericco commented Nov 11, 2023 • edited Loading

tobbi Nov 26, 2023

Choose a reason for hiding this comment

Vankata453 Nov 26, 2023

Choose a reason for hiding this comment

jamescdericco Dec 12, 2023

Choose a reason for hiding this comment

Vankata453 Dec 12, 2023

Choose a reason for hiding this comment

jamescdericco commented Nov 27, 2023

MatusGuy commented Nov 27, 2023

mrkubax10 commented Dec 7, 2023

jamescdericco commented Dec 11, 2023

tobbi commented Dec 26, 2023

MatusGuy commented Dec 26, 2023

tobbi commented Mar 3, 2024

jamescdericco commented Mar 4, 2024 • edited Loading

To Do

Current Progress on Refactoring

bruhmoent commented Jul 6, 2024

jamescdericco commented Jul 9, 2024

tobbi commented Jul 9, 2024

jamescdericco commented Aug 2, 2024

Vankata453 left a comment

Choose a reason for hiding this comment

jamescdericco commented Aug 2, 2024

jamescdericco commented Nov 11, 2023 •

edited

Loading

jamescdericco commented Mar 4, 2024 •

edited

Loading