Implementation for LRC Lyrics Export Functionality #27852

glopezsalgado · 2025-04-26T02:07:18Z

Resolves: #24813

This implements LRC file export for lyrics, including timestamps and metadata. The exporter appears in MuseScore's export dialog and generates standard .lrc files with [mm:ss.xx] formatted lyrics. Handles repeats and preserves score metadata (title/composer). Tested manually

I signed the CLA
The title of the PR describes the problem it addresses
Each commit's message describes its purpose and effects, and references the issue it resolves
If changes are extensive, there is a sequence of easily reviewable commits
The code in the PR follows the coding rules
There are no unnecessary changes
The code compiles and runs on my machine, preferably after each commit individually
I created a unit test or vtest to verify the changes I made (if applicable)

… LRC lyrics file export feature.

…ule dependency, to add the LRC file export feature.

…format (.lrc) in export writers, to add the LRC lyrics file export feature.

…ctional changes made.

…es made.

… made.

…al changes made.

…anges made.

…es made.

…ional changes made.

…ure.

…file export feature.

…at const TYPES and added the following test steps for LRC export workflow: Open export dialog, Select LRC format, Execute export, Verify output file.

…rt modules, implementing INotationWriter interface for LRC format, and registering the exporter in imagesexport module. The implemented INotationWriter interface for LRC format extracts lyrics with timestamps from the score, formats output in standard LRC format, and handles metadata (title, composer).

…d lyrics extraction from score, formatted output in standard LRC format, and implemented the INotationWriter interface.

cbjeukendrup · 2025-04-26T02:29:40Z

It looks like you used an editor that automatically formats every file you open or touch, but not according to our code style. You will have to undo these formatting changes unfortunately.

Also, there is currently a conflict between your branch and the master branch. To fix it, you have to rebase your branch, and then force-push:

git pull --rebase upstream master
# At this point, you'll have to resolve the conflicts.
# After the rebase has been completed successfully, run:
git push -f

cbjeukendrup · 2025-04-26T13:22:05Z

src/project/internal/notationwritersregister.cpp

@@ -21,20 +21,23 @@
 */

 #include "notationwritersregister.h"
+#include "importexport/lyrics/exportlrc.h"


This include does nothing. Instead, you need to register the lyrics writer from the lyrics export module file (which you will have to create), like how it's done in imagesexportmodule.cpp

cbjeukendrup · 2025-04-26T13:24:50Z

src/importexport/midi/internal/midiexport/exportLRC.h

You have src/importexport/midi/internal/midiexport/exportLRC.{h,cpp} and you have src/importexport/lyrics/exportlrc.{h,cpp}, which look almost identical. It looks like only the latter should be kept.

cbjeukendrup · 2025-04-26T13:25:34Z

src/importexport/midi/internal/midiexport/exportLRC.cpp

@@ -0,0 +1,126 @@
+// CREATED BHY


This file does not have the correct copyright header. Look at other files what it should be.

cbjeukendrup · 2025-04-26T13:26:53Z

src/importexport/midi/internal/midiexport/exportLRC.cpp

+#include "exportLRC.h"
+#include "engraving/dom/chordrest.h"
+#include "engraving/dom/lyrics.h"
+#include "engraving/dom/masterscore.h"
+#include "engraving/compat/midi/compatmidirender.h"
+#include <QFile>


Please sort the includes like this:

The header file corresponding to the cpp file

blank line

std includes

blank line

Qt includes

blank line

other includes, alphabetically

Suggested change

#include "exportLRC.h"

#include "engraving/dom/chordrest.h"

#include "engraving/dom/lyrics.h"

#include "engraving/dom/masterscore.h"

#include "engraving/compat/midi/compatmidirender.h"

#include <QFile>

#include "exportLRC.h"

#include <QFile>

#include "engraving/compat/midi/compatmidirender.h"

#include "engraving/dom/chordrest.h"

#include "engraving/dom/lyrics.h"

#include "engraving/dom/masterscore.h"

(EDIT: I see I posted this comment on the wrong file, namely the one in midiexport, while only the one in lyrics should be kept. But it applies to that one as well.)

cbjeukendrup · 2025-04-26T13:28:14Z

src/importexport/lyrics/exportlrc.h

@@ -0,0 +1,30 @@
+#ifndef EXPORTLRC_H
+#define EXPORTLRC_H


Same here about the copyright header and the order of the includes. And additionally, nowadays we prefer using #pragma once in new files, instead of #ifndef....

cbjeukendrup · 2025-04-26T13:33:39Z

src/importexport/lyrics/CMakeLists.txt

+    project
+    notation


I don't think linking to project and notation is necessary

cbjeukendrup · 2025-04-26T13:33:52Z

src/importexport/lyrics/CMakeLists.txt

@@ -0,0 +1,8 @@
+declare_module(iex_lyrics)


Copyright header, again

cbjeukendrup · 2025-04-26T13:37:12Z

src/importexport/lyrics/CMakeLists.txt

Instead of naming the module folder just lyrics and the module just iex_lyrics, I would call the folder lyricsexport and the module iex_lyricsexport.

cbjeukendrup · 2025-04-26T13:42:04Z

src/importexport/lyrics/CMakeLists.txt

@@ -0,0 +1,8 @@
+declare_module(iex_lyrics)
+set(MODULE_SRC exportlrc.cpp exportlrc.h)


You will have to add lyricsexportmodule.{h,cpp} files here, just like imagesexportmodule.{h,cpp}. You will also need make sure that the main executable is linked to iex_lyricsexport (see src/app/CMakeLists.txt) and that the module is loaded at runtime (see appfactory.cpp).

cbjeukendrup · 2025-04-26T13:42:58Z

src/importexport/imagesexport/imagesexportmodule.cpp

+        writers->reg({"pdf"}, std::make_shared<PdfWriter>(iocContext()));
+        writers->reg({"svg"}, std::make_shared<SvgWriter>(iocContext()));
+        writers->reg({"png"}, std::make_shared<PngWriter>(iocContext()));
+        writers->reg({"lrc"}, std::make_shared<mu::iex::lrc::ExportLRC>());


This is not the right place for this. The lyrics export has nothing to do with the images export module.

glopezsalgado added 16 commits April 25, 2025 19:57

Integrated LRC file type exporter into CMake build system, to add the…

8fcbe80

… LRC lyrics file export feature.

Added include path to lyrics module headers and linked iex_lyrics mod…

fa0d5e3

…ule dependency, to add the LRC file export feature.

Added include for exportlrc.h and added the registration for the LRC …

a516370

…format (.lrc) in export writers, to add the LRC lyrics file export feature.

Modified whitespace/formatting in imagesexportconfiguration.h. No fun…

b847b95

…ctional changes made.

Modified whitespace/formatting in exportmidi.cpp. No functional chang…

f0ef41b

…es made.

Modified whitespace/formatting in exportmidi.h. No functional changes…

959a4b3

… made.

Modified whitespace/formatting in notationmidireader.cpp. No function…

5b43b8f

…al changes made.

Modified whitespace/formatting in inotationwriter.h. No functional ch…

5c76aab

…anges made.

Modified whitespace/formatting in exporttype.cpp. No functional chang…

0d564fe

…es made.

Modified whitespace/formatting in notationreadersregister.h. No funct…

1f46f27

…ional changes made.

Added include for exportlrc.h, to add the LRC lyrics file export feat…

143f2a8

…ure.

Registered LRC file format in m_exportTypeList to add the LRC lyrics …

05d731f

…file export feature.

Added automated testing for LRC export by included LRC in export form…

59b6b10

…at const TYPES and added the following test steps for LRC export workflow: Open export dialog, Select LRC format, Execute export, Verify output file.

Implemented LRC lyrics file export core functionality. Add timestampe…

aee7270

…d lyrics extraction from score, formatted output in standard LRC format, and implemented the INotationWriter interface.

Implemented LRC lyrics file export core functionality. Add timestampe…

49add35

…d lyrics extraction from score, formatted output in standard LRC format, and implemented the INotationWriter interface.

cbjeukendrup requested changes Apr 26, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implementation for LRC Lyrics Export Functionality #27852

Implementation for LRC Lyrics Export Functionality #27852

glopezsalgado commented Apr 26, 2025

cbjeukendrup commented Apr 26, 2025

cbjeukendrup Apr 26, 2025

cbjeukendrup Apr 26, 2025

cbjeukendrup Apr 26, 2025

cbjeukendrup Apr 26, 2025

cbjeukendrup Apr 26, 2025

cbjeukendrup Apr 26, 2025

cbjeukendrup Apr 26, 2025

cbjeukendrup Apr 26, 2025

cbjeukendrup Apr 26, 2025

cbjeukendrup Apr 26, 2025

		@@ -0,0 +1,8 @@
		declare_module(iex_lyrics)
		set(MODULE_SRC exportlrc.cpp exportlrc.h)

Implementation for LRC Lyrics Export Functionality #27852

Are you sure you want to change the base?

Implementation for LRC Lyrics Export Functionality #27852

Conversation

glopezsalgado commented Apr 26, 2025

cbjeukendrup commented Apr 26, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment