Improved SDL <> Juce Message Manager handling

.clang-format

@@ -42,7 +42,7 @@ IndentWidth: 4
 IndentWrappedFunctionNames: true
 IndentPPDirectives: BeforeHash
 KeepEmptyLinesAtTheStartOfBlocks: false
-LambdaBodyIndentation: Signature
+LambdaBodyIndentation: OuterScope
 MaxEmptyLinesToKeep: 1
 NamespaceIndentation: None
 PackConstructorInitializers: Never

examples/render/source/main.cpp

@@ -221,10 +221,10 @@ struct Application : yup::YUPApplication
         window->setVisible (true);
         window->toFront();
 
-        window2 = std::make_unique<CustomWindow2>();
-        window2->centreWithSize ({ 300, 300 });
-        window2->setVisible (true);
-        window2->toFront();
+        //window2 = std::make_unique<CustomWindow2>();
+        //window2->centreWithSize ({ 300, 300 });
+        //window2->setVisible (true);
+        //window2->toFront();
     }
 
     void shutdown() override
@@ -233,14 +233,14 @@ struct Application : yup::YUPApplication
 
         window.reset();
 
-        window2.reset();
+        //window2.reset();
 
         YUP_PROFILE_STOP();
     }
 
 private:
     std::unique_ptr<CustomWindow> window;
-    std::unique_ptr<CustomWindow2> window2;
+    //std::unique_ptr<CustomWindow2> window2;
 };
 
 START_JUCE_APPLICATION (Application)

modules/juce_core/juce_core.h

@@ -202,6 +202,13 @@
 #define JUCE_PROFILING_CATEGORIES
 #endif
 
+/** Config: JUCE_PROFILING_FILE_PREFIX
+    If provided, it will be used as prefix for profilation files generated. By default it will use "yup-profile".
+*/
+#ifndef JUCE_PROFILING_FILE_PREFIX
+#define JUCE_PROFILING_FILE_PREFIX "yup-profile"
+#endif
+
 #ifndef JUCE_STRING_UTF_TYPE
 #define JUCE_STRING_UTF_TYPE 8
 #endif

modules/juce_core/memory/juce_ReferenceCountedObject.h

@@ -144,7 +144,7 @@ class JUCE_API ReferenceCountedObject
     /** Resets the reference count to zero without deleting the object.
         You should probably never need to use this!
     */
-    void resetReferenceCount() noexcept
+    void resetReferenceCount() const noexcept
     {
         refCount = 0;
     }

modules/juce_core/profiling/juce_Profiler.cpp

@@ -77,64 +77,63 @@ void Profiler::startTracing (uint32 sizeInKilobytes)
 {
     perfetto::TraceConfig traceConfig;
     traceConfig.add_buffers()->set_size_kb (sizeInKilobytes);
+
     auto dataSourceConfig = traceConfig.add_data_sources()->mutable_config();
     dataSourceConfig->set_name ("track_event");
 
-    session = perfetto::Tracing::NewTrace();
-    session->Setup (traceConfig);
-    session->StartBlocking();
-}
-
-//==============================================================================
-
-void Profiler::stopTracing()
-{
-    if (session == nullptr)
-        return;
-
-    perfetto::TrackEvent::Flush();
-
-    session->StopBlocking();
-    std::vector<char> traceData (session->ReadTraceBlocking());
-
     String fileName;
     fileName
-        << "yup-profile"
+        << JUCE_PROFILING_FILE_PREFIX
 #if JUCE_DEBUG
         << "-DEBUG-"
 #else
         << "-RELEASE-"
 #endif
-        << Time::getCurrentTime().formatted ("%Y-%m-%d_%H%M%S")
+        << Time::getCurrentTime().formatted ("%Y%m%d%H%M%S")
+        << "-" << String::toHexString (static_cast<uint16> (Random::getSystemRandom().nextInt()))
         << ".pftrace";
 
-    const auto destination = File::getSpecialLocation (File::userHomeDirectory) // TODO - make it configurable
-                                 .getChildFile (fileName);
+    File destination;
+    if (outputFolder != File() && outputFolder.isDirectory())
+        destination = outputFolder;
+    else
+        destination = File::getSpecialLocation (File::userHomeDirectory);
+
+    destination = destination.getChildFile (fileName);
 
     if (destination.existsAsFile())
         destination.deleteFile();
 
-    if (auto output = destination.createOutputStream(); output != nullptr && output->openedOk())
-    {
-        output->write (traceData.data(), traceData.size());
+    fileDescriptor = open (destination.getFullPathName().toRawUTF8(), O_RDWR | O_CREAT | O_TRUNC, 0600);
 
-        String message;
-        message
-            << "Trace written in " << destination.getFullPathName() << ". "
-            << "To read this trace in text form, `./tools/traceconv text " << destination.getFullPathName() << "`";
+    session = perfetto::Tracing::NewTrace();
+    session->Setup (traceConfig, fileDescriptor);
+    session->StartBlocking();
+}
 
-        DBG (message);
-    }
-    else
-    {
-        DBG ("Failed to write trace file. Check for missing permissions.");
+//==============================================================================
+
+void Profiler::stopTracing()
+{
+    if (session == nullptr)
+        return;
 
-        jassertfalse;
-    }
+    perfetto::TrackEvent::Flush();
+
+    session->StopBlocking();
+
+    close (fileDescriptor);
 
     Profiler::deleteInstance();
 }
 
+//==============================================================================
+
+void Profiler::setOutputFolder (const File& newOutputFolder)
+{
+    outputFolder = newOutputFolder;
+}
+
 } // namespace juce
 
 #endif

modules/juce_core/profiling/juce_Profiler.h

@@ -46,6 +46,8 @@ class JUCE_API Profiler
 
         This method starts the tracing process using a default buffer size. The tracing session is managed internally
         and will continue until `stopTracing()` is called.
+
+        @see YUP_PROFILE_START
     */
     void startTracing();
 
@@ -54,16 +56,30 @@ class JUCE_API Profiler
         This method allows you to specify the buffer size used for tracing. The buffer size is defined in kilobytes.
 
         @param sizeInKilobytes The size of the tracing buffer in kilobytes.
+
+        @see YUP_PROFILE_START
     */
     void startTracing (uint32 sizeInKilobytes);
 
     /** Stops the current tracing session.
 
         This method stops the tracing process and finalizes the trace data.
         Once tracing is stopped, the data can be retrieved and analyzed.
+
+        @see YUP_PROFILE_STOP
     */
     void stopTracing();
 
+    /** Define the output folder of the traces.
+
+        Call this method as erly as possible to
+
+        @param newOutputFolder The output folder where to save traces.
+
+        @see YUP_PROFILE_SET_OUTPUT_FOLDER
+     */
+    void setOutputFolder (const File& newOutputFolder);
+
     /** A constexpr function that prettifies a function name at compile time.
 
         This template function accepts a function name and formats it in a  more readable manner at compile time.
@@ -84,6 +100,8 @@ class JUCE_API Profiler
     Profiler();
 
     std::unique_ptr<perfetto::TracingSession> session;
+    File outputFolder;
+    int fileDescriptor;
 
     JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Profiler);
 };
@@ -153,6 +171,9 @@ constexpr auto Profiler::compileTimePrettierFunction (F func)
 */
 #define YUP_PROFILE_STOP(...) ::juce::Profiler::getInstance()->stopTracing()
 
+/** Define the output folder of the traces. */
+#define YUP_PROFILE_SET_OUTPUT_FOLDER(path) ::juce::Profiler::getInstance()->setOutputFolder (path)
+
 #if ! YUP_PROFILE_DISABLE_TRACE
 /** Records a profiling trace event.
 
@@ -167,7 +188,7 @@ constexpr auto Profiler::compileTimePrettierFunction (F func)
     constexpr auto JUCE_JOIN_MACRO (juce_pfn_, __LINE__) = ::juce::Profiler::compileTimePrettierFunction ([] { return PERFETTO_DEBUG_FUNCTION_IDENTIFIER(); }); \
     TRACE_EVENT (category, ::perfetto::StaticString (JUCE_JOIN_MACRO (juce_pfn_, __LINE__).data()), ##__VA_ARGS__)
 
-#define YUP_PROFILE_NAMED_TRACE(category, name, ...)                                                                                                                        \
+#define YUP_PROFILE_NAMED_TRACE(category, name, ...)                                                                                                            \
     TRACE_EVENT (category, ::perfetto::StaticString (#name), ##__VA_ARGS__)
 
 /** Records a profiling internal trace event.
@@ -176,18 +197,18 @@ constexpr auto Profiler::compileTimePrettierFunction (F func)
 
     @param ... Optional additional arguments for the trace event.
 */
-#define YUP_PROFILE_INTERNAL_TRACE(...)                                                                                                                        \
+#define YUP_PROFILE_INTERNAL_TRACE(...)                                                                                                                         \
     constexpr auto JUCE_JOIN_MACRO (juce_pfn_, __LINE__) = ::juce::Profiler::compileTimePrettierFunction ([] { return PERFETTO_DEBUG_FUNCTION_IDENTIFIER(); }); \
     TRACE_EVENT ("yup", ::perfetto::StaticString (JUCE_JOIN_MACRO (juce_pfn_, __LINE__).data()), ##__VA_ARGS__)
 
-#define YUP_PROFILE_NAMED_INTERNAL_TRACE(name, ...)                                                                                                                        \
+#define YUP_PROFILE_NAMED_INTERNAL_TRACE(name, ...)                                                                                                             \
     TRACE_EVENT ("yup", ::perfetto::StaticString (#name), ##__VA_ARGS__)
 
 #else
 #define YUP_PROFILE_TRACE(category, ...)
-#define YUP_PROFILE_NAMED_TRACE(category, name, ...)                                                                                                                        \
+#define YUP_PROFILE_NAMED_TRACE(category, name, ...)
 #define YUP_PROFILE_INTERNAL_TRACE(...)
-#define YUP_PROFILE_NAMED_INTERNAL_TRACE(name, ...)                                                                                                                        \
+#define YUP_PROFILE_NAMED_INTERNAL_TRACE(name, ...)
 
 #endif
 // clang-format on

modules/juce_events/native/juce_MessageQueue_apple.h

@@ -110,21 +110,13 @@ class InternalMessageQueue
     {
         YUP_PROFILE_INTERNAL_TRACE();
 
-        auto timeoutDetector = TimeoutDetector (1.0 / 60.0);
-
         if (! deliverNextMessage())
             return;
 
-        if (! timeoutDetector.hasTimedOut())
+        for (int i = 3; --i >= 0;)
         {
-            for (int i = 3; --i >= 0;)
-            {
-                if (! deliverNextMessage())
-                    break;
-
-                if (timeoutDetector.hasTimedOut())
-                    break;
-            }
+            if (! deliverNextMessage())
+                break;
         }
 
         wakeUp();

modules/yup_graphics/native/yup_GraphicsContext_metal.cpp

@@ -78,7 +78,7 @@ class LowLevelRenderContextMetal : public GraphicsContext
         m_swapchain.contentsScale = dpiScale (window);
         m_swapchain.maximumDrawableCount = 2;
 #if ! TARGET_OS_IOS
-        m_swapchain.displaySyncEnabled = YES;
+        m_swapchain.displaySyncEnabled = NO;
 #endif
 
 #if TARGET_OS_IOS

modules/yup_gui/artboard/yup_Artboard.cpp

@@ -110,14 +110,19 @@ void Artboard::setNumberInput (const String& name, double value)
 
 //==============================================================================
 
+void Artboard::refreshDisplay (double lastFrameTimeSeconds)
+{
+    if (! paused)
+        advanceAndApply (static_cast<float> (lastFrameTimeSeconds));
+}
+
+//==============================================================================
+
 void Artboard::paint (Graphics& g)
 {
-    if (rivFile == nullptr || scene == nullptr)
+    if (scene == nullptr)
         return;
 
-    if (! paused && getNativeComponent() != nullptr)
-        scene->advanceAndApply (1.0f / getNativeComponent()->getDesiredFrameRate());
-
     auto* renderer = g.getRenderer();
 
     renderer->save();

modules/yup_gui/artboard/yup_Artboard.h

@@ -47,6 +47,7 @@ class JUCE_API Artboard : public Component
     virtual void propertyChanged (const String& eventName, const String& propertyName, const var& oldValue, const var& newValue);
 
     //==============================================================================
+    void refreshDisplay (double lastFrameTimeSeconds) override;
     void paint (Graphics& g) override;
     void resized() override;
     void mouseEnter (const MouseEvent& event) override;
@@ -71,6 +72,7 @@ class JUCE_API Artboard : public Component
     int artboardIndex = -1;
     int animationIndex = -1;
     int stateMachineIndex = -1;
+    float animationTime = 0.0f;
 
     bool useStateMachines = true;
     bool paused = false;

modules/yup_gui/component/yup_ComponentNative.h

@@ -107,11 +107,18 @@ class JUCE_API ComponentNative
             return *this;
         }
 
+        Options& withUpdateOnlyFocused (bool onlyWhenFocused) noexcept
+        {
+            updateOnlyWhenFocused = onlyWhenFocused;
+            return *this;
+        }
+
         Flags flags = defaultFlags;                      ///<
         std::optional<GraphicsContext::Api> graphicsApi; ///<
         std::optional<float> framerateRedraw;            ///<
         std::optional<Color> clearColor;                 ///<
         std::optional<RelativeTime> doubleClickTime;     ///<
+        bool updateOnlyWhenFocused = false;              ///<
     };
 
     //==============================================================================