Skip to content
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

support building static libraries #21

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

support building static libraries #21

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6595b2e
support building static libraries
csukuangfj Nov 26, 2023
f685d6b
Remove soversion
csukuangfj Nov 27, 2023
290533e
Fix for iOS
csukuangfj Nov 27, 2023
23dcd9e
Fix linker warnings
csukuangfj Nov 27, 2023
42253dd
Enable soname optionally
csukuangfj Nov 28, 2023
6383e46
Fix cmake warnings
csukuangfj Nov 28, 2023
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
175 changes: 111 additions & 64 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,27 +17,34 @@ if(MSVC)

elseif(NOT APPLE)
# Linux flags
string(APPEND CMAKE_CXX_FLAGS " -Wall -Wextra -Wl,-rpath,'$ORIGIN'")
string(APPEND CMAKE_CXX_FLAGS " -Wall -Wextra ")
string(APPEND CMAKE_C_FLAGS " -Wall -Wextra")
endif()

option(BUILD_SHARED_LIBS "Whether to build shared libraries" ON)
option(BUILD_PIPER_PHONMIZE_EXE "Whether to build piper_phonemize_exe" ON)
option(BUILD_PIPER_PHONMIZE_TESTS "Whether to build tests" ON)
option(ENABLE_PIPER_PHONMIZE_SONAME "Whether to enable soname" ON)

add_library(
piper_phonemize SHARED
piper_phonemize
src/phonemize.cpp
src/phoneme_ids.cpp
src/tashkeel.cpp
src/shared.cpp
)

set_target_properties(piper_phonemize PROPERTIES
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did you remove this?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

piper-phonemize is used as a subproject in sherpa-onnx and it is always compiled from source along with sherpa-onnx.

We don't need to manage the version of piper-phonemize via soname.

In addition, setting soname will produce two more symlink files. If I use cp /path/to/install/lib/lib*.so* /some/dest/dir, it will dereference the symlink files and copy the real file, which means there are two more copies of the lib.

I don't see the need to keep the soname. I cannot think of a use case where we only update the version of
piper-phonemize without updating the main project where piper-phonemize is used.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other people have requested this, so I'd like to keep it. We could make it an option, though.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other people have requested this, so I'd like to keep it. We could make it an option, though.

Ok, I will create an option, defaulting to ON.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other people have requested this, so I'd like to keep it. We could make it an option, though.

Done.

if(ENABLE_PIPER_PHONMIZE_SONAME)
set_target_properties(piper_phonemize PROPERTIES
VERSION ${PROJECT_VERSION}
SOVERSION ${PROJECT_VERSION_MAJOR}
)
)
endif()

# ---- onnxruntime ---

# Look for onnxruntime files in <root>/lib
if(NOT DEFINED ONNXRUNTIME_DIR)
if(NOT DEFINED ONNXRUNTIME_DIR AND NOT DEFINED ENV{SHERPA_ONNXRUNTIME_LIB_DIR})
if(NOT DEFINED ONNXRUNTIME_VERSION)
set(ONNXRUNTIME_VERSION "1.14.1")
endif()
Expand Down Expand Up @@ -107,7 +114,7 @@ if(NOT DEFINED ESPEAK_NG_DIR)
URL "https://github.com/rhasspy/espeak-ng/archive/refs/heads/master.zip"
CMAKE_ARGS -DCMAKE_INSTALL_PREFIX:PATH=${ESPEAK_NG_DIR}
CMAKE_ARGS -DUSE_ASYNC:BOOL=OFF
CMAKE_ARGS -DBUILD_SHARED_LIBS:BOOL=ON
CMAKE_ARGS -DBUILD_SHARED_LIBS:BOOL=${BUILD_SHARED_LIBS}
CMAKE_ARGS -DUSE_MBROLA:BOOL=OFF
CMAKE_ARGS -DUSE_LIBSONIC:BOOL=OFF
CMAKE_ARGS -DUSE_LIBPCAUDIO:BOOL=OFF
Expand All @@ -130,73 +137,107 @@ target_include_directories(
${ONNXRUNTIME_DIR}/include
)

target_link_directories(
piper_phonemize PUBLIC
${ESPEAK_NG_DIR}/lib
${ONNXRUNTIME_DIR}/lib
)
if(DEFINED ENV{SHERPA_ONNXRUNTIME_INCLUDE_DIR})
target_include_directories(
piper_phonemize PUBLIC
$ENV{SHERPA_ONNXRUNTIME_INCLUDE_DIR}
)
endif()

if(EXISTS ${ESPEAK_NG_DIR}/lib)
target_link_directories(
piper_phonemize PUBLIC
${ESPEAK_NG_DIR}/lib
)
endif()

if(EXISTS ${ONNXRUNTIME_DIR}/lib)
target_link_directories(
piper_phonemize PUBLIC
${ONNXRUNTIME_DIR}/lib
)
endif()

if(DEFINED ENV{SHERPA_ONNXRUNTIME_LIB_DIR})
target_link_directories(
piper_phonemize PUBLIC
$ENV{SHERPA_ONNXRUNTIME_LIB_DIR}
)
endif()

target_link_libraries(
piper_phonemize
espeak-ng
onnxruntime
)

target_compile_features(piper_phonemize PUBLIC cxx_std_17)

# ---- Declare executable ----

add_executable(piper_phonemize_exe src/main.cpp src/phoneme_ids.cpp)

if(NOT WIN32)
set_property(TARGET piper_phonemize_exe PROPERTY OUTPUT_NAME piper_phonemize)
if(NOT BUILD_SHARED_LIBS)
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is to fix the following link errors:

[ 45%] Built target piper_phonemize
[ 54%] Linking CXX executable piper_phonemize
Undefined symbols for architecture x86_64:
  "_ucd_isalnum", referenced from:
      _TranslateClauseWithTerminator in libespeak-ng.a(translate.c.o)
      _ReadClause in libespeak-ng.a(readclause.c.o)
  "_ucd_isalpha", referenced from:
      _TranslateChar in libespeak-ng.a(translate.c.o)
      _CombineFlag in libespeak-ng.a(translate.c.o)
      _GetTranslatedPhonemeString in libespeak-ng.a(dictionary.c.o)
      _TranslateRules in libespeak-ng.a(dictionary.c.o)
      _MatchRule in libespeak-ng.a(dictionary.c.o)
      _ReadClause in libespeak-ng.a(readclause.c.o)
      _IsAlpha in libespeak-ng.a(common.c.o)
      ...
  "_ucd_isdigit", referenced from:
      _TranslateClauseWithTerminator in libespeak-ng.a(translate.c.o)
      _ReadClause in libespeak-ng.a(readclause.c.o)

target_link_libraries(piper_phonemize ucd)
endif()

target_compile_features(piper_phonemize_exe PUBLIC cxx_std_17)
target_compile_features(piper_phonemize PUBLIC cxx_std_17)

target_include_directories(
piper_phonemize_exe PUBLIC
"$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/src>"
${ESPEAK_NG_DIR}/include
)
if(BUILD_PIPER_PHONMIZE_EXE)
# ---- Declare executable ----

target_link_directories(
piper_phonemize_exe PUBLIC
${ESPEAK_NG_DIR}/lib
)
add_executable(piper_phonemize_exe src/main.cpp src/phoneme_ids.cpp)

target_link_libraries(piper_phonemize_exe PUBLIC
piper_phonemize
espeak-ng
)
if(NOT WIN32)
set_property(TARGET piper_phonemize_exe PROPERTY OUTPUT_NAME piper_phonemize)
endif()

# ---- Declare test ----
target_compile_features(piper_phonemize_exe PUBLIC cxx_std_17)

include(CTest)
enable_testing()
add_executable(test_piper_phonemize src/test.cpp src/phoneme_ids.cpp)
add_test(
NAME test_piper_phonemize
COMMAND test_piper_phonemize "${ESPEAK_NG_DIR}/share/espeak-ng-data" "${CMAKE_SOURCE_DIR}/etc/libtashkeel_model.ort"
)
target_include_directories(
piper_phonemize_exe PUBLIC
"$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/src>"
${ESPEAK_NG_DIR}/include
)

target_compile_features(test_piper_phonemize PUBLIC cxx_std_17)
if(EXISTS ${ESPEAK_NG_DIR}/lib)
target_link_directories(
piper_phonemize_exe PUBLIC
${ESPEAK_NG_DIR}/lib
)
endif()

target_include_directories(
test_piper_phonemize PUBLIC
"$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/src>"
${ESPEAK_NG_DIR}/include
)
target_link_libraries(piper_phonemize_exe PUBLIC
piper_phonemize
espeak-ng
)
endif()

target_link_directories(
test_piper_phonemize PUBLIC
${ESPEAK_NG_DIR}/lib
)
if(BUILD_PIPER_PHONMIZE_TESTS)
# ---- Declare test ----

include(CTest)
enable_testing()
add_executable(test_piper_phonemize src/test.cpp src/phoneme_ids.cpp)
add_test(
NAME test_piper_phonemize
COMMAND test_piper_phonemize "${ESPEAK_NG_DIR}/share/espeak-ng-data" "${CMAKE_SOURCE_DIR}/etc/libtashkeel_model.ort"
)

target_compile_features(test_piper_phonemize PUBLIC cxx_std_17)

target_include_directories(
test_piper_phonemize PUBLIC
"$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/src>"
${ESPEAK_NG_DIR}/include
)

if(EXISTS ${ESPEAK_NG_DIR}/lib)
target_link_directories(
test_piper_phonemize PUBLIC
${ESPEAK_NG_DIR}/lib
)
endif()

target_link_libraries(test_piper_phonemize PUBLIC
piper_phonemize
espeak-ng
)
target_link_libraries(test_piper_phonemize PUBLIC
piper_phonemize
espeak-ng
)
endif()

# ---- Declare install targets ----

Expand All @@ -213,9 +254,11 @@ install(
PATTERN "*.h"
PATTERN "*.hpp")

install(
TARGETS piper_phonemize_exe
ARCHIVE DESTINATION ${CMAKE_INSTALL_BINDIR})
if(BUILD_PIPER_PHONMIZE_EXE)
install(
TARGETS piper_phonemize_exe
ARCHIVE DESTINATION ${CMAKE_INSTALL_BINDIR})
endif()

install(
FILES ${CMAKE_SOURCE_DIR}/etc/libtashkeel_model.ort
Expand All @@ -226,10 +269,14 @@ install(
DIRECTORY ${ESPEAK_NG_DIR}/
DESTINATION ${CMAKE_INSTALL_PREFIX})

install(
DIRECTORY ${ONNXRUNTIME_DIR}/include/
DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
if(EXISTS ${ONNXRUNTIME_DIR}/include)
install(
DIRECTORY ${ONNXRUNTIME_DIR}/include/
DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
endif()

install(
DIRECTORY ${ONNXRUNTIME_DIR}/lib/
DESTINATION ${CMAKE_INSTALL_LIBDIR})
if(EXISTS ${ONNXRUNTIME_DIR}/lib)
install(
DIRECTORY ${ONNXRUNTIME_DIR}/lib/
DESTINATION ${CMAKE_INSTALL_LIBDIR})
endif()