Import Finale's .musx file format

CMakeLists.txt

@@ -85,6 +85,7 @@ option(MUE_BUILD_IMPEXP_CAPELLA_MODULE "Build importexport capella module" ON)
 option(MUE_BUILD_IMPEXP_MIDI_MODULE "Build importexport midi module" ON)
 option(MUE_BUILD_IMPEXP_MUSEDATA_MODULE "Build importexport musedata module" ON)
 option(MUE_BUILD_IMPEXP_MUSICXML_MODULE "Build importexport musicxml module" ON)
+option(MUE_BUILD_IMPEXP_FINALE_MODULE "Build importexport finale module" ON)
 option(MUE_BUILD_IMPEXP_OVE_MODULE "Build importexport ove module" ON)
 option(MUE_BUILD_IMPEXP_AUDIOEXPORT_MODULE "Build importexport audioexport module" ON)
 option(MUE_BUILD_IMPEXP_IMAGESEXPORT_MODULE "Build importexport imagesexport module" ON)

SetupConfigure.cmake

@@ -177,6 +177,7 @@ if(BUILD_CONFIGURATION STREQUAL "APP-WEB")
     set(MUE_BUILD_IMPEXP_MIDI_MODULE OFF)
     set(MUE_BUILD_IMPEXP_MUSEDATA_MODULE OFF)
     set(MUE_BUILD_IMPEXP_MUSICXML_MODULE OFF)
+    set(MUE_BUILD_IMPEXP_FINALE_MODULE OFF)
     set(MUE_BUILD_IMPEXP_OVE_MODULE OFF)
     set(MUE_BUILD_IMPEXP_AUDIOEXPORT_MODULE OFF)
     set(MUE_BUILD_IMPEXP_IMAGESEXPORT_MODULE OFF)
@@ -244,6 +245,7 @@ if(BUILD_CONFIGURATION STREQUAL "VTEST")
     set(MUE_BUILD_IMPEXP_MIDI_MODULE OFF)
     set(MUE_BUILD_IMPEXP_MUSEDATA_MODULE OFF)
     set(MUE_BUILD_IMPEXP_MUSICXML_MODULE OFF)
+    set(MUE_BUILD_IMPEXP_FINALE_MODULE OFF)
     set(MUE_BUILD_IMPEXP_OVE_MODULE OFF)
     set(MUE_BUILD_IMPEXP_AUDIOEXPORT_MODULE OFF)
     set(MUE_BUILD_IMPEXP_IMAGESEXPORT_MODULE ON)

src/app/CMakeLists.txt

@@ -156,6 +156,7 @@ add_to_link_if_exists(iex_audioexport)
 add_to_link_if_exists(iex_bb)
 add_to_link_if_exists(iex_bww)
 add_to_link_if_exists(iex_capella)
+add_to_link_if_exists(iex_finale)
 add_to_link_if_exists(iex_guitarpro)
 add_to_link_if_exists(iex_imagesexport)
 add_to_link_if_exists(iex_lyricsexport)
@@ -175,8 +176,7 @@ add_to_link_if_exists(palette)
 add_to_link_if_exists(playback)
 add_to_link_if_exists(preferences)
 add_to_link_if_exists(print)
-add_to_link_if_exists(project)     
-
+add_to_link_if_exists(project)
 
 set(MSCORE_APPEND_SRC)
 

src/app/app_config.h.in

@@ -40,6 +40,7 @@
 #cmakedefine MUE_BUILD_IMPEXP_MIDI_MODULE ${MUE_BUILD_IMPEXP_MIDI_MODULE})
 #cmakedefine MUE_BUILD_IMPEXP_MUSEDATA_MODULE ${MUE_BUILD_IMPEXP_MUSEDATA_MODULE})
 #cmakedefine MUE_BUILD_IMPEXP_MUSICXML_MODULE ${MUE_BUILD_IMPEXP_MUSICXML_MODULE})
+#cmakedefine MUE_BUILD_IMPEXP_FINALE_MODULE ${MUE_BUILD_IMPEXP_FINALE_MODULE})
 #cmakedefine MUE_BUILD_IMPEXP_OVE_MODULE ${MUE_BUILD_IMPEXP_OVE_MODULE})
 #cmakedefine MUE_BUILD_IMPEXP_AUDIOEXPORT_MODULE ${MUE_BUILD_IMPEXP_AUDIOEXPORT_MODULE})
 #cmakedefine MUE_BUILD_IMPEXP_IMAGESEXPORT_MODULE ${MUE_BUILD_IMPEXP_IMAGESEXPORT_MODULE})

src/app/appfactory.cpp

@@ -166,6 +166,9 @@
 #else
 #include "stubs/importexport/musicxml/musicxmlmodule.h"
 #endif
+#ifdef MUE_BUILD_IMPEXP_FINALE_MODULE
+#include "importexport/finale/finalemodule.h"
+#endif
 #ifdef MUE_BUILD_IMPEXP_OVE_MODULE
 #include "importexport/ove/ovemodule.h"
 #else
@@ -352,6 +355,9 @@ std::shared_ptr<muse::IApplication> AppFactory::newGuiApp(const CmdOptions& opti
 #endif
     app->addModule(new mu::iex::musicxml::MusicXmlModule());
     app->addModule(new mu::iex::ove::OveModule());
+#ifdef MUE_BUILD_IMPEXP_FINALE_MODULE
+    app->addModule(new mu::iex::finale::FinaleModule());
+#endif
 #ifdef MUE_BUILD_IMPEXP_AUDIOEXPORT_MODULE
     app->addModule(new mu::iex::audioexport::AudioExportModule());
 #endif
@@ -474,6 +480,9 @@ static void addConsoleModules(std::shared_ptr<ConsoleApp> app)
 #endif
     app->addModule(new mu::iex::musicxml::MusicXmlModule());
     app->addModule(new mu::iex::ove::OveModule());
+#ifdef MUE_BUILD_IMPEXP_FINALE_MODULE
+    app->addModule(new mu::iex::finale::FinaleModule());
+#endif
 #ifdef MUE_BUILD_IMPEXP_AUDIOEXPORT_MODULE
     app->addModule(new mu::iex::audioexport::AudioExportModule());
 #endif

src/engraving/rendering/score/beamtremololayout.h

@@ -24,8 +24,8 @@
 
 #include <vector>
 
-#include "dom/beambase.h"
-#include "types/types.h"
+#include "../../dom/beambase.h"
+#include "../../types/types.h"
 
 #include "layoutcontext.h"
 

src/importexport/CMakeLists.txt

@@ -57,6 +57,9 @@ if (MUE_BUILD_IMPEXP_MUSICXML_MODULE)
 else()
     add_subdirectory(../stubs/importexport/musicxml stubs/musicxml)
 endif()
+if (MUE_BUILD_IMPEXP_FINALE_MODULE)
+    add_subdirectory(finale)
+endif()
 if (MUE_BUILD_IMPEXP_OVE_MODULE)
     add_subdirectory(ove)
 else()

src/importexport/finale/CMakeLists.txt

@@ -0,0 +1,77 @@
+# SPDX-License-Identifier: GPL-3.0-only
+# MuseScore-Studio-CLA-applies
+#
+# MuseScore Studio
+# .musx Import Module (Experimental)
+
+muse_create_module(iex_finale)
+
+include(FetchContent)
+include(GetCompilerInfo)
+
+# turn on for reference and debugging as needed
+set(MUSX_DISPLAY_NODE_NAMES OFF CACHE BOOL "Log node names to trace as they are processed" FORCE)
+
+set(musx_BUILD_TESTING OFF CACHE BOOL "Do not build tests for musx")
+FetchContent_Declare(
+    musx
+    GIT_REPOSITORY https://github.com/rpatters1/musxdom.git
+    GIT_TAG        main
+    DOWNLOAD_EXTRACT_TIMESTAMP TRUE
+)
+
+FetchContent_MakeAvailable(musx)
+
+set(smufl_mapping_BUILD_TESTING OFF CACHE BOOL "Do not build tests for musx")
+FetchContent_Declare(
+    smufl_mapping
+    GIT_REPOSITORY https://github.com/rpatters1/smufl-mapping.git
+    GIT_TAG        main
+    DOWNLOAD_EXTRACT_TIMESTAMP TRUE
+)
+
+FetchContent_MakeAvailable(smufl_mapping)
+
+if (CC_IS_MSVC)
+    include(FindZlibStatic)
+    target_link_libraries(iex_finale PRIVATE zlibstat)
+    target_include_directories(iex_finale PRIVATE ${DEPENDENCIES_INC}/zlib)
+endif ()
+
+target_sources(iex_finale PRIVATE
+    third_party/score_encoder.h
+    internal/notationfinalereader.cpp
+    internal/notationfinalereader.h
+    internal/finaleconfiguration.cpp
+    internal/finaleconfiguration.h
+    internal/finaletypesconv.cpp
+    internal/finaletypesconv.h
+    internal/musxxmldom.h
+    internal/importfinale.cpp
+    internal/importfinale.h
+    internal/importfinaleentries.cpp
+    internal/importfinalelogger.cpp
+    internal/importfinalelogger.h
+    internal/importfinalescoremap.cpp
+    internal/importfinaleparser.cpp
+    internal/importfinaleparser.h
+    internal/importfinalestyles.cpp
+    internal/importfinalesmartshapes.cpp
+    internal/importfinaletext.cpp
+    internal/importfinalearticulations.cpp
+    internal/text/finaletextconv.cpp
+    internal/text/finaletextconv.h
+    ifinaleconfiguration.h
+    finalemodule.cpp
+    finalemodule.h
+)
+
+target_link_libraries(iex_finale PRIVATE
+    musx              # Link musxdom library
+    smufl_mapping     # Link smufl_mapping library
+    engraving         # MuseScore expects importers to link to "engraving" usually
+)
+
+if (MUE_BUILD_IMPORTEXPORT_TESTS)
+    add_subdirectory(tests)
+endif()

src/importexport/finale/finalemodule.cpp

@@ -0,0 +1,57 @@
+/*
+ * SPDX-License-Identifier: GPL-3.0-only
+ * MuseScore-Studio-CLA-applies
+ *
+ * MuseScore Studio
+ * Music Composition & Notation
+ *
+ * Copyright (C) 2021 MuseScore Limited
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * 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.  If not, see <https://www.gnu.org/licenses/>.
+ */
+#include "finalemodule.h"
+
+#include "modularity/ioc.h"
+
+#include "project/inotationreadersregister.h"
+#include "internal/finaleconfiguration.h"
+#include "internal/notationfinalereader.h"
+
+using namespace muse::modularity;
+using namespace mu::iex::finale;
+using namespace mu::project;
+
+std::string FinaleModule::moduleName() const
+{
+    return "iex_finale";
+}
+
+void FinaleModule::registerExports()
+{
+    m_configuration = std::make_shared<FinaleConfiguration>();
+
+    ioc()->registerExport<IFinaleConfiguration>(moduleName(), m_configuration);
+}
+
+void FinaleModule::resolveImports()
+{
+    auto readers = ioc()->resolve<INotationReadersRegister>(moduleName());
+    if (readers) {
+        readers->reg({ "musx", "enigmaxml" }, std::make_shared<NotationFinaleReader>(iocContext()));
+    }
+}
+
+void FinaleModule::onInit(const muse::IApplication::RunMode&)
+{
+    m_configuration->init();
+}

src/importexport/finale/finalemodule.h

@@ -0,0 +1,41 @@
+/*
+ * SPDX-License-Identifier: GPL-3.0-only
+ * MuseScore-Studio-CLA-applies
+ *
+ * MuseScore Studio
+ * Music Composition & Notation
+ *
+ * Copyright (C) 2025 MuseScore Limited
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * 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.  If not, see <https://www.gnu.org/licenses/>.
+ */
+#pragma once
+
+#include "modularity/imodulesetup.h"
+#include "global/iapplication.h"
+
+namespace mu::iex::finale {
+class FinaleConfiguration;
+class FinaleModule : public muse::modularity::IModuleSetup
+{
+public:
+
+    std::string moduleName() const override;
+    void registerExports() override;
+    void resolveImports() override;
+    void onInit(const muse::IApplication::RunMode&) override;
+
+private:
+    std::shared_ptr<FinaleConfiguration> m_configuration;
+};
+} // namespace mu::iex::finale

src/importexport/finale/ifinaleconfiguration.h

@@ -0,0 +1,48 @@
+/*
+ * SPDX-License-Identifier: GPL-3.0-only
+ * MuseScore-Studio-CLA-applies
+ *
+ * MuseScore Studio
+ * Music Composition & Notation
+ *
+ * Copyright (C) 2025 MuseScore Limited
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * 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.  If not, see <https://www.gnu.org/licenses/>.
+ */
+#pragma once
+
+#include "modularity/imoduleinterface.h"
+#include "async/channel.h"
+
+namespace mu::iex::finale {
+class IFinaleConfiguration : MODULE_GLOBAL_EXPORT_INTERFACE
+{
+    INTERFACE_ID(IFinaleConfiguration)
+
+public:
+    virtual ~IFinaleConfiguration() = default;
+
+    enum class ImportPositionsType {
+        None, AdjustmentsOnly, All
+    };
+
+    virtual ImportPositionsType importPositionsType() const = 0;
+    virtual bool convertTextSymbols() const = 0;
+
+    virtual void setImportPositionsType(ImportPositionsType importPositionsType) = 0;
+    virtual void setConvertTextSymbols(bool convert) = 0;
+
+    virtual muse::async::Channel<ImportPositionsType> importPositionsTypeChanged() const = 0;
+    virtual muse::async::Channel<bool> convertTextSymbolsChanged() const = 0;
+};
+}