feat(IPC): Add Linux/Wine platform support to ARAIPCConnection

CMakeLists.txt

@@ -1,7 +1,7 @@
 # ======================
 # ARA Library CMake Integration
 #
-# Copyright (c) 2020-2025, Celemony Software GmbH, All Rights Reserved.
+# Copyright (c) 2020-2026, Celemony Software GmbH, All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -41,6 +41,14 @@ project(ARA_Library
     LANGUAGES C CXX
 )
 
+# language standards
+
+set(CMAKE_C_STANDARD 11)
+set(CMAKE_C_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_EXTENSIONS OFF)
+
 # ======================
 
 add_subdirectory("${ARA_API_DIR}" "${CMAKE_CURRENT_BINARY_DIR}/ARA_API.build" EXCLUDE_FROM_ALL)
@@ -55,13 +63,6 @@ function(configure_ARA_Library_target target)
     # file grouping
     ara_group_target_files(${target})
 
-    # language standards
-    target_compile_features(${target}
-        PUBLIC
-            cxx_std_11
-            c_std_11
-    )
-
     # ARA_API dependency
     target_link_libraries(${target} PUBLIC ARA_API)
 
@@ -85,6 +86,14 @@ function(configure_ARA_Library_target target)
             PRIVATE
                 -DNOMINMAX=1
         )
+        # /Zc:__cplusplus, added in Visual Studio 2017 version 15.7, is required to make __cplusplus
+        # accurate, see https://devblogs.microsoft.com/cppblog/msvc-now-correctly-reports-__cplusplus/
+        if(MSVC AND (MSVC_VERSION GREATER_EQUAL 1914))
+            target_compile_options(${target}
+                PRIVATE
+                    "/Zc:__cplusplus"
+            )
+        endif()
     elseif(APPLE)
         if(XCODE)
             set_target_properties(${target} PROPERTIES
@@ -167,8 +176,6 @@ configure_ARA_Library_target(ARA_PlugIn_Library)
 
 # ======================
 
-if(FALSE)
-
 add_library(ARA_IPC_Library ${ARA_LIBRARY_TARGET_TYPE}
     "${CMAKE_CURRENT_SOURCE_DIR}/IPC/ARAIPC.h"
     "${CMAKE_CURRENT_SOURCE_DIR}/IPC/ARAIPCEncoding.h"
@@ -199,4 +206,3 @@ target_link_libraries(ARA_IPC_Library PRIVATE
 )
 
 configure_ARA_Library_target(ARA_IPC_Library)
-endif()

ChangeLog.txt

@@ -1,6 +1,18 @@
-Proposed Features which have been postponed to a later subrelease:
-- generic ARA IPC library, providing a proxy host and a proxy plug-in,
-  based on the IPC Example from earlier SDK releases
+This is a development build of the ARA Library 3.0.
+=== PRELIMINARY - DO NOT USE FOR SHIPPING PRODUCTS! ===
+
+
+Changes since previous releases:
+- initial draft of ARA generator plug-ins that operate merely based on content descriptions (no sample input)
+- initial draft of lyrics-related content types, tailored to support singing voice synthesis
+- initial draft of region sequence persistency
+- added isPlaybackRegionPreservingAudioSourceSignal(), superseding isAudioModificationPreservingAudioSourceSignal()
+- initial draft of generic ARA IPC library providing a proxy host and a proxy plug-in,
+  based on heavily refactored IPC Example from earlier SDK releases
+- dropped support for ARA 1 and 2.0 Draft APIs
+  If previously optionally supporting obsolete ARA 1 persistency, now exclusively use ARA 2 persistency.
+- C++17 is now consistently required on all platforms
+- fixed inconsistent spelling of "timestretch" in various identifiers
 
 
 === ARA SDK 2.3 release (aka 2.3.001) (2025/11/07) ===

Debug/ARAContentLogger.h

@@ -2,7 +2,7 @@
 //! \file       ARAContentLogger.h
 //!             class to conveniently log (and validate) ARA content
 //! \project    ARA SDK Library
-//! \copyright  Copyright (c) 2018-2025, Celemony Software GmbH, All Rights Reserved.
+//! \copyright  Copyright (c) 2018-2026, Celemony Software GmbH, All Rights Reserved.
 //! \license    Licensed under the Apache License, Version 2.0 (the "License");
 //!             you may not use this file except in compliance with the License.
 //!             You may obtain a copy of the License at
@@ -40,13 +40,8 @@ namespace ARA {
 
 struct ContentLogger
 {
-#if __cplusplus >= 201703L
     template <typename ControllerType, typename ModelObjectRefType>
     using ContentReaderRef = decltype ((static_cast<ControllerType*> (nullptr)->*ContentReaderFunctionMapper<ControllerType, ModelObjectRefType>::createContentReader) (nullptr, kARAContentTypeNotes, nullptr));
-#else
-    template <typename ControllerType, typename ModelObjectRefType>
-    using ContentReaderRef = typename std::result_of<decltype (ContentReaderFunctionMapper<ControllerType, ModelObjectRefType>::createContentReader) (ControllerType, ModelObjectRefType, ARAContentType, const ARAContentTimeRange*)>::type;
-#endif
 
     template <ARAContentType contentType, typename ControllerType, typename ModelObjectRefType>
 #if ARA_VALIDATE_API_CALLS
@@ -60,12 +55,13 @@ struct ContentLogger
 
     // array of all content types defined in the api
 
-    static inline constexpr std::array<ARAContentType, 6> getAllContentTypes () noexcept
+    static inline constexpr std::array<ARAContentType, 7> getAllContentTypes () noexcept
     {
         return { { kARAContentTypeNotes,
                    kARAContentTypeTempoEntries, kARAContentTypeBarSignatures,
                    kARAContentTypeStaticTuning,
-                   kARAContentTypeKeySignatures, kARAContentTypeSheetChords
+                   kARAContentTypeKeySignatures, kARAContentTypeSheetChords,
+                   kARAContentTypeLyricEntries
                } };
     }
 
@@ -93,6 +89,7 @@ struct ContentLogger
             case kARAContentTypeStaticTuning:  return ContentTypeMapper<kARAContentTypeStaticTuning>::enumName;
             case kARAContentTypeKeySignatures: return ContentTypeMapper<kARAContentTypeKeySignatures>::enumName;
             case kARAContentTypeSheetChords:   return ContentTypeMapper<kARAContentTypeSheetChords>::enumName;
+            case kARAContentTypeLyricEntries:  return ContentTypeMapper<kARAContentTypeLyricEntries>::enumName;
             default: ARA_INTERNAL_ASSERT (false); return "kARAContentType???";
         }
     }
@@ -107,6 +104,7 @@ struct ContentLogger
             case kARAContentTypeStaticTuning:  return ContentTypeMapper<kARAContentTypeStaticTuning>::typeName;
             case kARAContentTypeKeySignatures: return ContentTypeMapper<kARAContentTypeKeySignatures>::typeName;
             case kARAContentTypeSheetChords:   return ContentTypeMapper<kARAContentTypeSheetChords>::typeName;
+            case kARAContentTypeLyricEntries:  return ContentTypeMapper<kARAContentTypeLyricEntries>::typeName;
             default: ARA_INTERNAL_ASSERT (false); return "ARAContent???";
         }
     }
@@ -193,14 +191,22 @@ struct ContentLogger
             (logGivenName && logParsedName) ? " aka " : "", (logGivenName && logParsedName) ? parsedChordName.c_str () : "", chordData.position);
     }
 
+    static inline void logEvent (ARAInt32 idx, const ARAContentLyricsEntry& lyricsEntry)
+    {
+        ARA_LOG ("%s[%i] %s%s, %i %s phonemes%s, position = %.3f", getTypeNameForContentType (kARAContentTypeLyricEntries), idx,
+            (lyricsEntry.continuesPreviousWord) ? "-" : "", lyricsEntry.lyrics,
+            lyricsEntry.phonemeCount, getNameForContentGrade (lyricsEntry.phonemesGrade),
+            (lyricsEntry.phonemeOffsets) ? " w/ offsets": "", lyricsEntry.position);
+    }
+
     // internal helper for log ()
 
-    template <ARAContentType contentType, typename ContentReader, typename std::enable_if<contentType != kARAContentTypeTempoEntries, bool>::type = true>
+    template <ARAContentType contentType, typename ContentReader, std::enable_if_t<contentType != kARAContentTypeTempoEntries, bool> = true>
     static inline void logEventIteration (ContentReader& reader, ARAInt32 i)
     {
         logEvent (i, reader[i]);
     }
-    template <ARAContentType contentType, typename ContentReader, typename std::enable_if<contentType == kARAContentTypeTempoEntries, bool>::type = true>
+    template <ARAContentType contentType, typename ContentReader, std::enable_if_t<contentType == kARAContentTypeTempoEntries, bool> = true>
     static inline void logEventIteration (ContentReader& reader, ARAInt32 i)
     {
         const auto event { reader[i] };
@@ -252,6 +258,7 @@ struct ContentLogger
             case kARAContentTypeStaticTuning:  return log<kARAContentTypeStaticTuning> (controller, modelObjectRef, range, logIfNotAvailable);
             case kARAContentTypeKeySignatures: return log<kARAContentTypeKeySignatures> (controller, modelObjectRef, range, logIfNotAvailable);
             case kARAContentTypeSheetChords:   return log<kARAContentTypeSheetChords> (controller, modelObjectRef, range, logIfNotAvailable);
+            case kARAContentTypeLyricEntries:  return log<kARAContentTypeLyricEntries> (controller, modelObjectRef, range, logIfNotAvailable);
             default: ARA_INTERNAL_ASSERT (false); return false;
         }
     }
@@ -321,6 +328,11 @@ struct ContentLogger
             log<kARAContentTypeKeySignatures> (controller, modelObjectRef, range, false);
             log<kARAContentTypeSheetChords> (controller, modelObjectRef, range, false);
         }
+        if (scopeFlags.affectLyrics ())
+        {
+            ARA_LOG ("lyrics scope updated, related content is:");
+            log<kARAContentTypeLyricEntries> (controller, modelObjectRef, range, false);
+        }
     }
 };
 

Debug/ARAContentValidator.h

@@ -2,7 +2,7 @@
 //! \file       ARAContentValidator.h
 //!             utility classes vor validating content readers
 //! \project    ARA SDK Library
-//! \copyright  Copyright (c) 2018-2025, Celemony Software GmbH, All Rights Reserved.
+//! \copyright  Copyright (c) 2018-2026, Celemony Software GmbH, All Rights Reserved.
 //! \license    Licensed under the Apache License, Version 2.0 (the "License");
 //!             you may not use this file except in compliance with the License.
 //!             You may obtain a copy of the License at
@@ -137,6 +137,25 @@ struct ContentReaderValidatorImplementation<kARAContentTypeSheetChords>
     }
 };
 
+template <>
+struct ContentReaderValidatorImplementation<kARAContentTypeLyricEntries>
+{
+    static inline void validateEventCount (ARAInt32 eventCount) { ARA_VALIDATE_API_CONDITION (eventCount >= 0); }
+
+    static inline void validateEvent (const ARAContentLyricsEntry* event)
+    {
+        ARA_VALIDATE_API_CONDITION ((event->continuesPreviousWord == kARAFalse) || (event->lyrics != nullptr));
+        ARA_VALIDATE_API_CONDITION ((event->phonemeCount == 0) || (event->phonemes != nullptr));
+        ARA_VALIDATE_API_CONDITION ((event->phonemeCount != 0) || (event->phonemes == nullptr));
+        ARA_VALIDATE_API_CONDITION ((event->phonemeCount != 0) || (event->phonemeOffsets == nullptr));        
+    }
+
+    static inline void validateEventSequence (const ARAContentLyricsEntry* event, const ARAContentLyricsEntry* prevEvent)
+    {
+        ARA_VALIDATE_API_CONDITION (prevEvent->position < event->position);
+    }
+};
+
 
 /*******************************************************************************/
 // ContentReaderValidator

Debug/ARADebug.c

@@ -2,7 +2,7 @@
 //! \file       ARADebug.c
 //!             debug helpers for the ARA SDK Library
 //! \project    ARA SDK Library
-//! \copyright  Copyright (c) 2012-2025, Celemony Software GmbH, All Rights Reserved.
+//! \copyright  Copyright (c) 2012-2026, Celemony Software GmbH, All Rights Reserved.
 //! \license    Licensed under the Apache License, Version 2.0 (the "License");
 //!             you may not use this file except in compliance with the License.
 //!             You may obtain a copy of the License at
@@ -256,6 +256,7 @@ void ARASetExternalAssertReference(ARAAssertFunction * address)
     _Pragma("GCC diagnostic push")
     _Pragma("GCC diagnostic ignored \"-Wmissing-noreturn\"")
 #endif
+void ARAAssertionFailure(ARAAssertCategory category, const void * problematicArgument, const char * file, int line, const char * diagnosis);
 void ARAAssertionFailure(ARAAssertCategory category, const void * problematicArgument, const char * file, int line, const char * diagnosis)
 {
 #if ARA_ENABLE_INTERNAL_ASSERTS

Debug/ARADebug.h

@@ -2,7 +2,7 @@
 //! \file       ARADebug.h
 //!             debug helpers for the ARA SDK Library
 //! \project    ARA SDK Library
-//! \copyright  Copyright (c) 2012-2025, Celemony Software GmbH, All Rights Reserved.
+//! \copyright  Copyright (c) 2012-2026, Celemony Software GmbH, All Rights Reserved.
 //! \license    Licensed under the Apache License, Version 2.0 (the "License");
 //!             you may not use this file except in compliance with the License.
 //!             You may obtain a copy of the License at
@@ -97,22 +97,20 @@ extern "C"
 // prevent unused variable warnings
 /*******************************************************************************/
 
-#if defined(__cplusplus) && (__cplusplus >= 201703L)
-    #define ARA_MAYBE_UNUSED_VAR(var) var [[maybe_unused]]
-#elif defined(__GNUC__)
-    #define ARA_MAYBE_UNUSED_VAR(var) var __attribute__((unused))
-#elif defined(_MSC_VER)
-    #define ARA_MAYBE_UNUSED_VAR(var) var; (false ? (void)var : (void)false)
-#else
-    #define ARA_MAYBE_UNUSED_VAR(var) var; (void)var
-#endif
+#if !defined(__cplusplus)
+    #if defined(__GNUC__)
+        #define ARA_MAYBE_UNUSED_VAR(var) var __attribute__((unused))
+    #elif defined(_MSC_VER)
+        #define ARA_MAYBE_UNUSED_VAR(var) var; (false ? (void)var : (void)false)
+    #else
+        #define ARA_MAYBE_UNUSED_VAR(var) var; (void)var
+    #endif
 
-#if defined(__cplusplus) && (__cplusplus >= 201703L)
-    #define ARA_MAYBE_UNUSED_ARG(var) var [[maybe_unused]]
-#elif defined(__GNUC__)
-    #define ARA_MAYBE_UNUSED_ARG(var) var __attribute__((unused))
-#else
-    #define ARA_MAYBE_UNUSED_ARG(var) var
+    #if defined(__GNUC__)
+        #define ARA_MAYBE_UNUSED_ARG(var) var __attribute__((unused))
+    #else
+        #define ARA_MAYBE_UNUSED_ARG(var) var
+    #endif
 #endif
 
 

Dispatch/ARAContentReader.h

@@ -2,7 +2,7 @@
 //! \file       ARAContentReader.h
 //!             content reading utility classes
 //! \project    ARA SDK Library
-//! \copyright  Copyright (c) 2018-2025, Celemony Software GmbH, All Rights Reserved.
+//! \copyright  Copyright (c) 2018-2026, Celemony Software GmbH, All Rights Reserved.
 //! \license    Licensed under the Apache License, Version 2.0 (the "License");
 //!             you may not use this file except in compliance with the License.
 //!             You may obtain a copy of the License at
@@ -51,6 +51,7 @@ struct ContentTypeMapper;
     ARA_SPECIALIZE_CONTENT_TYPE_MAPPER (kARAContentTypeStaticTuning, ARAContentTuning)
     ARA_SPECIALIZE_CONTENT_TYPE_MAPPER (kARAContentTypeKeySignatures, ARAContentKeySignature)
     ARA_SPECIALIZE_CONTENT_TYPE_MAPPER (kARAContentTypeSheetChords, ARAContentChord)
+    ARA_SPECIALIZE_CONTENT_TYPE_MAPPER (kARAContentTypeLyricEntries, ARAContentLyricsEntry)
 
 #undef ARA_SPECIALIZE_CONTENT_TYPE_MAPPER