CoreServices.h

/*
    ------------------------------------------------------------------

    This file is part of the Open Ephys GUI
    Copyright (C) 2024 Open Ephys

    ------------------------------------------------------------------

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    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 <http://www.gnu.org/licenses/>.

*/

#ifndef CORESERVICES_H_INCLUDED
#define CORESERVICES_H_INCLUDED

#include "../JuceLibraryCode/JuceHeader.h"
#include "Processors/PluginManager/OpenEphysPlugin.h"

#include "Utils/Utils.h"

class GenericEditor;
class GenericProcessor;
class SpikeChannel;
class Spike;
class PopupManager;

namespace CoreServices
{
/** Issues a signal chain update; this should be called whenever a plugin's
* are changed in a way that would affect downstream plugins.
* 
* For example, if a plugin adds a new EventChannel, updateSignalChain() must
* be called in order for downstream plugins to register this change.
*/
PLUGIN_API void updateSignalChain (GenericProcessor* source);
PLUGIN_API void updateSignalChain (GenericEditor* source);

/** Saves the recoveryConfig.xml settings file*/
PLUGIN_API void saveRecoveryConfig();

/** Loads signal chain from a given path*/
PLUGIN_API void loadSignalChain (String path);

/** Returns true if the GUI is acquiring data */
PLUGIN_API bool getAcquisitionStatus();

/** Activates or deactivates data acquisition */
PLUGIN_API void setAcquisitionStatus (bool enable);

/** Returns true is the GUI is recording */
PLUGIN_API bool getRecordingStatus();

/** Activates or deactivates recording for all Record Nodes */
PLUGIN_API void setRecordingStatus (bool enable);

/** Sends a status message that appears in the GUI's MessageCenter.
* These messages are meant to notify the user about a status change,
* and they are not recorded.
* To send a message that's written to disk (while acquisition + recording are active),
* use GenericProcessor::broadcastMessage()
*/
PLUGIN_API void sendStatusMessage (const String& text);

/** Sends a status message that appears in the GUI's MessageCenter.
* These messages are meant to notify the user about a status change,
* and they are not recorded.
* To send a message that's written to disk (while acquisition + recording are active),
* use GenericProcessor::broadcastMessage()
*/
PLUGIN_API void sendStatusMessage (const char* text);

/** Highlights a plugin's editor in the EditorViewport, without updating the signal chain.
* It will also make the editor visible if it's not currently seen by the user.*/
PLUGIN_API void highlightEditor (GenericEditor* ed);

/** Returns the number of milliseconds shown in the recording clock */
PLUGIN_API juce::int64 getRecordingTime();

/** Returns the number of milliseconds since midnight Jan 1st 1970 UTC */
PLUGIN_API juce::int64 getSystemTime();

/** Sets new default recording directory. This will only affect new Record Nodes */
PLUGIN_API void setRecordingParentDirectory (String dir);

/** Returns the default recording directory.*/
PLUGIN_API File getRecordingParentDirectory();

/** Gets the basename for the recording directory (does not affect prepend/append text) */
PLUGIN_API String getRecordingDirectoryBaseText();

/** Sets new basename for the recording directory (does not affect prepend/append text) */
PLUGIN_API void setRecordingDirectoryBaseText (String text);

/** Returns the full name of the current recording directory (empty string if none has started) */
PLUGIN_API String getRecordingDirectoryName();

/** Creates new directory the next time recording is started.
* This will apply to all Record Nodes*/
PLUGIN_API void createNewRecordingDirectory();

/** Set the text to be prepended to the name of newly created recording directories. */
PLUGIN_API String getRecordingDirectoryPrependText();

/** Set the text to be appended to the name of newly created recording directories. */
PLUGIN_API String getRecordingDirectoryAppendText();

/** Set the text to be prepended to the name of newly created recording directories. */
PLUGIN_API void setRecordingDirectoryPrependText (String text);

/** Set the text to be appended to the name of newly reated recording directories. */
PLUGIN_API void setRecordingDirectoryAppendText (String text);

/** Get array of available record engines */
PLUGIN_API std::vector<RecordEngineManager*> getAvailableRecordEngines();

/** Gets the ID of the default Record Engine*/
PLUGIN_API String getDefaultRecordEngineId();

/** Sets a specific RecordEngine to be used based on its id. 
* Returns true if there is an engine with the specified ID and it's possible to
* change the current engine or false otherwise. */
PLUGIN_API bool setDefaultRecordEngine (String id);

/** Returns an array of IDs for Record Nodes currently in the signal chain*/
PLUGIN_API Array<int> getAvailableRecordNodeIds();

/** Returns true if all record nodes are in a "synchronized" state*/
PLUGIN_API bool allRecordNodesAreSynchronized();

/** Returns a pointer to a processor based off Id, returns nullptr if not found*/
PLUGIN_API GenericProcessor* getProcessorById (uint16_t nodeId);

/** Returns a pointer to a processor based off name, returns nullptr if not found*/
PLUGIN_API GenericProcessor* getProcessorByName (String processorName, bool onlySearchSources = false);

/** Returns IDs for all processors upstream of a given node */
PLUGIN_API std::vector<int> getPredecessorProcessorIds (GenericProcessor* node);

namespace RecordNode
{
    /** Sets the recording directory for a specific Record Node, based on its numeric ID.
* If applyToAll=true, the nodeId is ignored, and the setting is applied to all Record Nodes
* in the signal chain. */
    PLUGIN_API void setRecordingDirectory (String dir, int nodeId, bool applyToAll = false);

    /** Returns the recording directory for a specific Record Node */
    PLUGIN_API File getRecordingDirectory (int nodeId);

    /** Returns the free space available (in kB) for a Record Node's directory */
    PLUGIN_API float getFreeSpaceAvailable (int nodeId);

    /** Sets the RecordEngine for a specific Record Nodes.
* If applyToAll=true, the nodeId is ignored, and the setting is applied to all Record Nodes
* in the signal chain. */
    PLUGIN_API void setRecordEngine (String id, int nodeId, bool applyToAll = false);

    /** Returns the active RecordEngine for a specific Record Node*/
    PLUGIN_API String getRecordEngineId (int nodeId);

    /** Returns the recording number for a specific Record Node (number of times recording 
* was stopped and re-started).*/
    PLUGIN_API int getRecordingNumber (int nodeId);

    /** Returns the experiment number for a specific Record Node (number of times acquisition
* was stopped and re-started).*/
    PLUGIN_API int getExperimentNumber (int nodeId);

    /** Instructs a specific Record Node to creates new directory the next time recording is started.*/
    PLUGIN_API void createNewRecordingDirectory (int nodeId);

    /** Checks whether incoming data streams are synchronized .*/
    PLUGIN_API bool isSynchronized (int nodeId);

    // FUNCTIONS BELOW ARE NOT YET IMPLEMENTED:

    /** Toggles recording for a specific Record Node.*/
    //PLUGIN_API void setRecordingStatus(int nodeId, bool status);

    /** Gets the recording status for a specific Record Node.*/
    //PLUGIN_API bool getRecordingStatus(int nodeId);

}; // namespace RecordNode

/** Returns data for an application resource (stored in BinaryData object) */
//PLUGIN_API const char* getApplicationResource(const char* name, int& size);

/** Gets the default directory for user-initiated file saving/loading */
PLUGIN_API File getDefaultUserSaveDirectory();

/** Gets the save directory for GUI-related file saving/loading */
PLUGIN_API File getSavedStateDirectory();

/** Gets the GUI version */
PLUGIN_API String getGUIVersion();

/** Gets the GUI's undo manager */
PLUGIN_API UndoManager* getUndoManager();

/** Gets the GUI's popup manager */
PLUGIN_API PopupManager* getPopupManager();

namespace PluginInstaller
{
    /** Installs or updates a specific plugin with a specific version number.
    * If version number is not specified, it will install the latest version */
    PLUGIN_API bool installPlugin (String plugin, String version = String());
} // namespace PluginInstaller

}; // namespace CoreServices

#endif // CORESERVICES_H_INCLUDED