Removed movie making from CircuitExploxer, moved to braynsMediaMaker plugin

Author: Cyrille Favreau

plugins/CircuitExplorer/plugin/CircuitExplorerPlugin.cpp

@@ -410,24 +410,6 @@ void CircuitExplorerPlugin::init()
                     _attachCircuitSimulationHandler(s);
                 });
 
-        PLUGIN_INFO << "Registering 'export-frames-to-disk' endpoint"
-                    << std::endl;
-        _api->getActionInterface()->registerNotification<ExportFramesToDisk>(
-            "export-frames-to-disk",
-            [&](const ExportFramesToDisk& s) { _exportFramesToDisk(s); });
-
-        PLUGIN_INFO << "Registering 'get-export-frames-progress' endpoint"
-                    << std::endl;
-        actionInterface->registerRequest<FrameExportProgress>(
-            "get-export-frames-progress", [&](void) -> FrameExportProgress {
-                return _getFrameExportProgress();
-            });
-
-        PLUGIN_INFO << "Registering 'make-movie' endpoint" << std::endl;
-        actionInterface->registerNotification<MakeMovieParameters>(
-            "make-movie",
-            [&](const MakeMovieParameters& params) { _makeMovie(params); });
-
         PLUGIN_INFO << "Registering 'trace-anterograde' endpoint" << std::endl;
         _api->getActionInterface()
             ->registerRequest<AnterogradeTracing, AnterogradeTracingResult>(
@@ -484,43 +466,6 @@ void CircuitExplorerPlugin::preRender()
     if (_dirty)
         _api->getScene().markModified();
     _dirty = false;
-
-    if (_exportFramesToDiskDirty && _accumulationFrameNumber == 0)
-    {
-        const auto& ai = _exportFramesToDiskPayload.animationInformation;
-        if (_frameNumber >= ai.size())
-            _exportFramesToDiskDirty = false;
-        else
-        {
-            const uint64_t i = 11 * _frameNumber;
-            // Camera position
-            CameraDefinition cd;
-            const auto& ci = _exportFramesToDiskPayload.cameraInformation;
-            cd.origin = {ci[i], ci[i + 1], ci[i + 2]};
-            cd.direction = {ci[i + 3], ci[i + 4], ci[i + 5]};
-            cd.up = {ci[i + 6], ci[i + 7], ci[i + 8]};
-            cd.apertureRadius = ci[i + 9];
-            cd.focusDistance = ci[i + 10];
-            _setCamera(cd);
-
-            // Animation parameters
-            _api->getParametersManager().getAnimationParameters().setFrame(
-                ai[_frameNumber]);
-        }
-    }
-}
-
-void CircuitExplorerPlugin::postRender()
-{
-    if (_exportFramesToDiskDirty &&
-        _accumulationFrameNumber == _exportFramesToDiskPayload.spp)
-    {
-        _doExportFrameToDisk();
-        ++_frameNumber;
-        _accumulationFrameNumber = 0;
-    }
-    else
-        ++_accumulationFrameNumber;
 }
 
 void CircuitExplorerPlugin::_setMaterialExtraAttributes(
@@ -1047,203 +992,6 @@ void CircuitExplorerPlugin::_attachCircuitSimulationHandler(
     }
 }
 
-void CircuitExplorerPlugin::_exportFramesToDisk(
-    const ExportFramesToDisk& payload)
-{
-    _exportFramesToDiskPayload = payload;
-    _exportFramesToDiskDirty = true;
-    _frameNumber = payload.startFrame;
-    _accumulationFrameNumber = 0;
-    auto& frameBuffer = _api->getEngine().getFrameBuffer();
-    frameBuffer.clear();
-    PLUGIN_INFO << "-----------------------------------------------------------"
-                   "---------------------"
-                << std::endl;
-    PLUGIN_INFO << "Movie settings     :" << std::endl;
-    PLUGIN_INFO << "- Number of frames : "
-                << payload.animationInformation.size() - payload.startFrame
-                << std::endl;
-    PLUGIN_INFO << "- Samples per pixel: " << payload.spp << std::endl;
-    PLUGIN_INFO << "- Frame size       : " << frameBuffer.getSize()
-                << std::endl;
-    PLUGIN_INFO << "- Export folder    : " << payload.path << std::endl;
-    PLUGIN_INFO << "- Start frame      : " << payload.startFrame << std::endl;
-    PLUGIN_INFO << "-----------------------------------------------------------"
-                   "---------------------"
-                << std::endl;
-}
-
-void CircuitExplorerPlugin::_doExportFrameToDisk()
-{
-    auto& frameBuffer = _api->getEngine().getFrameBuffer();
-    auto image = frameBuffer.getImage();
-    auto fif = _exportFramesToDiskPayload.format == "jpg"
-                   ? FIF_JPEG
-                   : FreeImage_GetFIFFromFormat(
-                         _exportFramesToDiskPayload.format.c_str());
-    if (fif == FIF_JPEG)
-        image.reset(FreeImage_ConvertTo24Bits(image.get()));
-    else if (fif == FIF_UNKNOWN)
-        throw std::runtime_error("Unknown format: " +
-                                 _exportFramesToDiskPayload.format);
-
-    int flags = _exportFramesToDiskPayload.quality;
-    if (fif == FIF_TIFF)
-        flags = TIFF_NONE;
-
-    brayns::freeimage::MemoryPtr memory(FreeImage_OpenMemory());
-
-    FreeImage_SaveToMemory(fif, image.get(), memory.get(), flags);
-
-    BYTE* pixels = nullptr;
-    DWORD numPixels = 0;
-    FreeImage_AcquireMemory(memory.get(), &pixels, &numPixels);
-
-    char frame[7];
-    sprintf(frame, "%05d", _frameNumber);
-    std::string filename = _exportFramesToDiskPayload.path + '/' + frame + "." +
-                           _exportFramesToDiskPayload.format;
-    std::ofstream file;
-    file.open(filename, std::ios_base::binary);
-    if (!file.is_open())
-        PLUGIN_THROW("Failed to create " + filename);
-
-    file.write((char*)pixels, numPixels);
-    file.close();
-
-    frameBuffer.clear();
-
-    PLUGIN_INFO << "Frame saved to " << filename << std::endl;
-}
-
-FrameExportProgress CircuitExplorerPlugin::_getFrameExportProgress()
-{
-    FrameExportProgress result;
-    const size_t totalNumberOfFrames =
-        (_exportFramesToDiskPayload.animationInformation.size() -
-         _exportFramesToDiskPayload.startFrame) *
-        _exportFramesToDiskPayload.spp;
-    const float currentProgress =
-        _frameNumber * _exportFramesToDiskPayload.spp +
-        _accumulationFrameNumber;
-
-    result.progress = currentProgress / float(totalNumberOfFrames);
-    return result;
-}
-
-void CircuitExplorerPlugin::_makeMovie(const MakeMovieParameters& params)
-{
-    // Find ffmpeg executable path
-    std::array<char, 256> buffer;
-    std::string ffmpegPath;
-    std::unique_ptr<FILE, decltype(&pclose)> pipe(popen("which ffmpeg", "r"),
-                                                  pclose);
-    if (!pipe)
-    {
-        PLUGIN_ERROR << "Could not launch movie creation: ffmpeg not found"
-                     << std::endl;
-        return;
-    }
-    while (fgets(buffer.data(), buffer.size(), pipe.get()) != nullptr)
-    {
-        ffmpegPath += buffer.data();
-    }
-
-    // Remove new lines
-    size_t pos = std::string::npos;
-    do
-    {
-        pos = ffmpegPath.find("\n");
-        if (pos != std::string::npos)
-        {
-            ffmpegPath.replace(pos, pos + 2, "");
-        }
-    } while (pos != std::string::npos);
-
-    // Get sanitetized string inputs
-    std::string sanitizedFramesFolder = params.framesFolderPath;
-    const std::string slash =
-        sanitizedFramesFolder[sanitizedFramesFolder.length() - 1] == '/' ? ""
-                                                                         : "/";
-
-    std::string sanitizedFramesExt = params.framesFileExtension;
-    std::string sanitizedOutputPath = params.outputMoviePath;
-
-    sanitizedFramesFolder = _sanitizeString(sanitizedFramesFolder);
-    sanitizedFramesExt = _sanitizeString(sanitizedFramesExt);
-    sanitizedOutputPath = _sanitizeString(sanitizedOutputPath);
-
-    const std::string inputParam =
-        sanitizedFramesFolder + slash + "%05d." + sanitizedFramesExt;
-    const std::string filterParam =
-        "scale=" + std::to_string(static_cast<int>(params.dimensions[0])) +
-        ":" + std::to_string(static_cast<int>(params.dimensions[1])) +
-        ",format=yuv420p";
-    const pid_t pid = fork();
-
-    if (pid == 0)
-    {
-        execl(ffmpegPath.c_str(), "ffmpeg", "-y", "-hide_banner", "-loglevel",
-              "0", "-r", std::to_string(params.fpsRate).c_str(), "-i",
-              inputParam.c_str(), "-vf", filterParam.c_str(), "-crf", "0",
-              "-codec:v", "libx264", sanitizedOutputPath.c_str(),
-              static_cast<char*>(nullptr));
-    }
-    else
-    {
-        int status = 0;
-        if (waitpid(pid, &status, 0) > 0)
-        {
-            // If we could not make the movie, inform and stop execution
-            if (WIFEXITED(status) && WEXITSTATUS(status))
-            {
-                if (WEXITSTATUS(status) == 127)
-                {
-                    PLUGIN_ERROR << "Could not create media video file. FFMPEG "
-                                    "returned with error "
-                                 << status << std::endl;
-                    return;
-                }
-            }
-        }
-        else
-        {
-            PLUGIN_ERROR << "Could not create media video file. "
-                            "Could not launch FFMPEG."
-                         << std::endl;
-            return;
-        }
-    }
-
-    if (params.eraseFrames)
-    {
-        DIR* dir;
-        struct dirent* ent;
-        const std::regex fileNameRegex("[0-9]{5}." +
-                                       params.framesFileExtension);
-        if ((dir = opendir(params.framesFolderPath.c_str())) != nullptr)
-        {
-            while ((ent = readdir(dir)) != nullptr)
-            {
-                std::string fileName(ent->d_name);
-                if (std::regex_match(fileName, fileNameRegex))
-                {
-                    const std::string fullPath =
-                        sanitizedFramesFolder + slash + fileName;
-                    PLUGIN_INFO << "Cleaning frame " << fullPath << std::endl;
-                    remove(fullPath.c_str());
-                }
-            }
-            closedir(dir);
-        }
-        else
-        {
-            PLUGIN_ERROR << "make-movie: Could not clean up frames"
-                         << std::endl;
-        }
-    }
-}
-
 AnterogradeTracingResult CircuitExplorerPlugin::_traceAnterogrades(
     const AnterogradeTracing& payload)
 {

plugins/CircuitExplorer/plugin/CircuitExplorerPlugin.h

@@ -46,7 +46,6 @@ class CircuitExplorerPlugin : public brayns::ExtensionPlugin
      * @brief preRender Updates the scene according to latest data load
      */
     void preRender() final;
-    void postRender() final;
 
 private:
     // Rendering
@@ -68,26 +67,19 @@ class CircuitExplorerPlugin : public brayns::ExtensionPlugin
     void _attachCircuitSimulationHandler(
         const AttachCircuitSimulationHandler& payload);
 
-    // Movie production
-    void _exportFramesToDisk(const ExportFramesToDisk& payload);
-    void _doExportFrameToDisk();
-    FrameExportProgress _getFrameExportProgress();
-    void _makeMovie(const MakeMovieParameters& params);
-
     // Anterograde tracing
-    AnterogradeTracingResult _traceAnterogrades(const AnterogradeTracing& payload);
+    AnterogradeTracingResult _traceAnterogrades(
+        const AnterogradeTracing& payload);
 
     // Add geometry
-    void _createShapeMaterial(brayns::ModelPtr& model,
-                              const size_t id,
+    void _createShapeMaterial(brayns::ModelPtr& model, const size_t id,
                               const brayns::Vector3d& color,
                               const double& opacity);
     AddShapeResult _addSphere(const AddSphere& payload);
     AddShapeResult _addPill(const AddPill& payload);
     AddShapeResult _addCylinder(const AddCylinder& payload);
     AddShapeResult _addBox(const AddBox& payload);
 
-
     // Predefined models
     void _addGrid(const AddGrid& payload);
     void _addColumn(const AddColumn& payload);
@@ -96,10 +88,5 @@ class CircuitExplorerPlugin : public brayns::ExtensionPlugin
     SynapseAttributes _synapseAttributes;
 
     bool _dirty{false};
-
-    ExportFramesToDisk _exportFramesToDiskPayload;
-    bool _exportFramesToDiskDirty{false};
-    uint16_t _frameNumber{0};
-    int16_t _accumulationFrameNumber{0};
 };
 #endif