oak-editor/global/global.h

/***

  Olive - Non-Linear Video Editor
  Copyright (C) 2019  Olive Team

  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 OLIVEGLOBAL_H
#define OLIVEGLOBAL_H

#include <memory>
#include "undo/undo.h"

#include <QTimer>
#include <QFile>
#include <QTranslator>

/**
 * @brief The Olive Global class
 *
 * A resource for various global functions used throughout Olive.
 */
class OliveGlobal : public QObject {
  Q_OBJECT
public:
  /**
     * @brief OliveGlobal Constructor
     *
     * Creates Olive Global object. Also sets some default runtime settings and the application name.
     */
  OliveGlobal();

  /**
     * @brief Returns the file dialog filter used when interfacing with Olive project files.
     *
     * @return The file filter string used by QFileDialog to limit the files shown to Olive (*.ove) files.
     */
  const QString& get_project_file_filter();

  /**
     * @brief Change the current active project filename
     *
     * Triggered to change the current active project filename. Call this before calling any internal project
     * saving or loading functions in order to set which file to work with (OliveGlobal::open_project() and
     * OliveGlobal::save_project_as() do this automatically). Also updates the main window title to reflect the
     * project filename.
     *
     * @param s
     *
     * The URL of the project file to work with. Can be an empty string, in which case Olive will treat the project
     * as an unsaved project.
     */
  void update_project_filename(const QString& s);

  /**
     * @brief Check whether an auto-recovery file exists and ask the user if they want to load it.
     *
     * Usually called on initialization. Checks if an auto-recovery file exists (meaning the last session of Olive
     * didn't close correctly). If it finds one, asks the user if they want to load it. If so, loads the auto-recovery
     * project.
     */
  void check_for_autorecovery_file();

  /**
     * @brief Get whether the project is currently being rendered or not. Useful for determining whether to treat the
     * render as online or offline.
     *
     * @return
     *
     * TRUE if the project is being exported, FALSE if not.
     */
  bool is_exporting();

  /**
     * @brief Set the application state depending on if the user is exporting a video
     *
     * Some background functions shouldn't run while Olive is exporting a video. This function will disable/enable them
     * as necessary.
     *
     * The current functions are as follows:
     * * Auto-recovery interval. Olive saves an auto-recovery just before exporting anyway and seeing as the user
     * cannot make changes while rendering, there's no reason to continue saving auto-recovery files.
     * * Audio device playback. Olive uses the same internal audio buffer for exporting as it does for playback, but
     * this buffer does not need to be forwarded to the output device when exporting.
     *
     * @param rendering
     *
     * **TRUE** if Olive is about to export a video. **FALSE** if Olive has finished exporting.
     */
  void set_export_state(bool rendering);

  /**
     * @brief Set the application's "modified" state
     *
     * Primarily controls whether the application prompts the user to save the project upon closing or not. Also
     * technically controls whether to create autorecovery files as they'll only be generated if there are unsaved
     * changes.
     *
     * @param modified
     *
     * TRUE if the project has been modified, FALSE if it has not.
     */
  void set_modified(bool modified);

  /**
     * @brief Get application's current "modified" state
     *
     * Currently just a wrapper around MainWindow::isWindowModified(), but use this instead in case it changes.
     * This value is used to determine whether the currently open project has unsaved changes.
     *
     * @return
     *
     * TRUE if the project has been modified since the last save.
     */
  bool is_modified();

  /**
     * @brief Set a project to load just after launching
     *
     * Called by main() if Olive was called with a project file as a running argument. Sets up Olive to load the
     * specified project once its finished initializing.
     *
     * @param s
     *
     * The URL of the project file to load.
     */
  void load_project_on_launch(const QString& s);

  /**
     * @brief Retrieves the URL of the config file containing the autorecovery projects
     * @return The URL as a string
     */
  QString get_recent_project_list_file();

  /**
     * @brief (Re)load translation file from olive::config
     */
  void load_translation_from_config();

  /**
     * @brief Set native UI styling on a given widget
     *
     * @param w
     *
     * The widget to set styling on.
     */
  static void SetNativeStyling(QWidget* w);

  /**
     * @brief Adds a project URL to the recent projects list
     *
     * @param url
     *
     * The project URL to add
     */
  void add_recent_project(const QString& url);

  /**
     * @brief Load recent projects from file
     *
     * Should be called on application startup.
     */
  void load_recent_projects();

  /**
     * @brief Total count of recent projects
     *
     * @return
     *
     * Number of recent projects in the list
     */
  int recent_project_count();

  /**
     * @brief Get the recent project at a given index
     *
     * @param index
     *
     * @return
     *
     * The recent project at index
     */
  const QString& recent_project(int index);

  /**
     * @brief Retrieves the filename of the autorecovery file to save to during this session
     *
     * @return
     *
     * A URL pointing to the autorecovery file
     */
  const QString& get_autorecovery_filename();

  /**
     * @brief Returns whether a Sequence is currently active or not, and optionally displays a messagebox if not
     *
     * Checks whether a Sequence is active and can display a messagebox if not to inform users to make one active in
     * order to perform said action.
     *
     * @return
     *
     * TRUE if there is an active Sequence, FALSE if not.
     */
  bool CheckForActiveSequence(bool show_msg = true);


  void ShowEffectMenu(EffectType type, olive::TrackType subtype, const QVector<Clip*> selected_clips);

public slots:
  /**
     * @brief Undo user's last action
     */
  void undo();

  /**
     * @brief Redo user's last action
     */
  void redo();

  /**
     * @brief Paste contents of clipboard
     *
     * Pastes contents of clipboard. Seeing as several types of data can be copied into the clipboard, this
     * function will automatically determine what type of data is in the clipboard and paste it in the correct
     * location (e.g. clip data will go to the Timeline, effect data will go to Effect Controls).
     */
  void paste();

  /**
     * @brief Paste contents of clipboard, making space for it when possible
     *
     * Pastes contents of clipboard (same as paste()). If the clipboard contains clip data, the clips are cut at the
     * current playhead and ripple forward to make space for the clips in the clipboard. Can be considered
     * semi-non-destructive as a result (as opposed to paste() overwriting clips). If the clipboard contains effect
     * data, the functionality is identical to paste().
     */
  void paste_insert();

  /**
     * @brief Create new project.
     *
     * Confirms whether the current project can be closed, and if so, clears all current project data and resets
     * program state. Standard `File > New` behavior.
     */
  void new_project();

  /**
     * @brief Open a project from file.
     *
     * Confirms whether the current project can be closed, and if so, shows an open file dialog to allow the user to
     * select a project file and then triggers a project load with it.
     */
  void OpenProject();

  /**
     * @brief Import project from file
     *
     * Imports an Olive project into the current project, effectively merging them.
     *
     * @param fn
     *
     * The filename of the project to import.
     */
  void ImportProject(const QString& fn);

  /**
     * @brief Open recent project from list
     *
     * Triggers a project load from the internal recent projects list.
     *
     * @param index
     *
     * Index in the list of the project file to load
     */
  void open_recent(int index);

  /**
     * @brief Shows a save file dialog and saves the project as the resulting filename
     *
     * Shows a save file dialog for the user to save their current project as a different filename from the current
     * one. Also triggered by save_project() if the file hasn't been saved yet.
     *
     * @return **TRUE** if the user saved the project. **FALSE** if they cancelled out of the save file dialog. Useful
     * if a user is closing an unsaved project, clicks "Yes" to save, we know if they actually saved or not and won't
     * continue closing the project if they didn't.
     */
  bool save_project_as();

  /**
     * @brief Saves the current project to file
     *
     * If the project has been saved already, this function will overwrite the project file with the current project
     * data. Calls save_project_as() if the file has not been saved before.
     *
     * @return **TRUE** if the project has been saved before and was successfully overwritten. Otherwise returns the
     * value of save_project_as(). Useful if the user closing an unsaved project, clicks "Yes" to save, we know if they
     * actually saved or not and won't continue closing the project if they didn't.
     */
  bool save_project();

  /**
     * @brief Determine whether the current project can be closed.
     *
     * Queried any time the current project is going to be closed (e.g. starting a new project, loading a project,
     * exiting Olive, etc.) If the project has unsaved changes, this function asks the user whether they want to save or
     * not. If the user does, calls save_project() (which may in turn call save_project_as() if the project has never
     * been saved).
     *
     * @return **TRUE** if the project can be closed. FALSE if not. If the project does NOT have unsaved changes, always
     * returns **TRUE**. If it does and the user clicks YES, this returns the result of save_project(). If the user
     * clicks NO, this returns **TRUE**. If the user clicks CANCEL, this returns **FALSE**.
     */
  bool can_close_project();

  /**
     * @brief Opens the NewSequenceDialog to create a new Sequence
     */
  void open_new_sequence_dialog();

  /**
     * @brief Open a file dialog for importing files into the project
     */
  void open_import_dialog();

  /**
     * @brief Open the Export dialog to trigger an export of the current sequence.
     */
  void open_export_dialog();

  /**
     * @brief Open the About Olive dialog.
     */
  void open_about_dialog();

  /**
     * @brief Open the Debug Log window.
     */
  void open_debug_log();

  /**
     * @brief Open the Speed/Duration dialog.
     */
  void open_speed_dialog();

  /**
     * @brief Open the auto-cut silence dialog.
     */
  void open_autocut_silence_dialog();

  /**
     * @brief Open the Action Search overlay.
     */
  void open_action_search();

  /**
     * @brief Clears the current undo stack.
     *
     * Clears all current commands in the undo stack. Mostly used for debugging.
     */
  void clear_undo_stack();

  /**
     * @brief Function called when Olive has finished starting up
     *
     * Sets up some last things for Olive that must be run after Olive has completed initialization. If a project was
     * loaded as a command line argument, it's loaded here.
     */
  void finished_initialize();

  /**
     * @brief Save an auto-recovery file of the current project.
     *
     * Call this function to save the current state of the project as an auto-recovery project. Called regularly by
     * `autorecovery_timer`.
     */
  void save_autorecovery_file();

  /**
     * @brief Opens the Preferences dialog
     */
  void open_preferences();

  /**
     * @brief Clear the recent projects list
     *
     * Also saves the cleared recent projects to the config file making it permanent.
     */
  void clear_recent_projects();

  /**
     * @brief Slot for when the primary sequence has changed.
     *
     * Usually by opening a sequence or bringing a corresponding
     * Timeline widget on top.
     */
  void PrimarySequenceChanged();

private:
  /**
     * @brief Internal function to handle loading a project from file
     *
     * Start loading a project. Doesn't check if the current project can be closed, doesn't check if the project exists.
     * In most cases, you'll want open_project() to be end-user friendly.
     *
     * @param fn
     *
     * The URL to the project to load.
     *
     * @param autorecovery
     *
     * Whether this file is an autorecovery file. If it is, after the load Olive will set the project URL to a new file
     * beside the original project file so that it does not overwrite the original and so that the user is not working
     * on the autorecovery project in Olive's application data directory.
     */
  void OpenProjectWorker(QString fn, bool autorecovery);

  /**
     * @brief Create a LoadDialog and start a LoadThread to load data from a project
     *
     * Loads data from an Olive project file creating a LoadDialog to show visual information and a LoadThread to load
     * outside of the main/GUI thread.
     *
     * All project loading functions eventually lead to this one and there's no reason to use it directly. Instead use
     * one of the following functions:
     *
     * * OpenProject() - to check if the current project can be closed and prompt the user for the new project file
     * * OpenProjectWorker() - if you already have the filename and wish to close the current project and open it
     * * ImportProject() - to import a project file into this one, effectively merging them both
     *
     * @param fn
     *
     * The URL of the project file to open
     *
     * @param autorecovery
     *
     * TRUE if this file is an autorecovery file, in which case it's loaded slightly differently
     *
     * @param clear
     *
     * TRUE if the current project should be closed before opening, FALSE if the project should be imported into the
     * currently open one.
     */
  void LoadProject(const QString& fn, bool autorecovery);

  /**
     * @brief Indiscriminately clear the project without prompting the user
     *
     * Will clear the entire project without prompting to save. This is dangerous, use new_project() instead for
     * anything initiated by the user.
     */
  void ClearProject();

  /**
     * @brief Saves current recent project list to the configuration file
     *
     * This should be called whenever the recent projects change so the changes can be persistent.
     */
  void save_recent_projects();

  /**
     * @brief Internal pasting function
     */
  void PasteInternal(Sequence* s, bool insert);

  /**
     * @brief File filter used for any file dialogs relating to Olive project files.
     */
  QString project_file_filter;

  /**
     * @brief Regular interval to save an auto-recovery project.
     */
  QTimer autorecovery_timer;

  /**
     * @brief Internal variable set to **TRUE** by main() if a project file was set as an argument
     */
  bool enable_load_project_on_init;

  /**
     * @brief Internal translator object that interfaces with the currently loaded language file
     */
  std::unique_ptr<QTranslator> translator;

  /**
     * @brief Internal variable for whether the project has changed since the last autorecovery
     *
     * Set by set_modified(), which should be called alongside any change made to the project file and is "unset" when
     * an autorecovery file is made. Provides an extra layer of abstraction from the application "modified" state to
     * prevents an autorecovery file saving multiple times if the project hasn't actually changed since the last
     * autorecovery, but still hasn't been saved into the original file yet.
     */
  bool changed_since_last_autorecovery;

  /**
     * @brief Internal variable for rendering state (set by set_rendering_state() and accessed by is_rendering() ).
     */
  bool rendering_;

  /**
     * @brief Internal variable for the filename to the autorecovery project file
     */
  QString autorecovery_filename;

  /**
     * @brief Internal list of recent projects
     */
  QStringList recent_projects;

  /**
   * @brief Internal array of selected clips that a menu created by ShowEffectMenu will act on
   */
  QVector<Clip*> effect_menu_selected_clips;

private slots:
  /**
   * @brief Receiver for a menu initiated by ShowEffectMenu
   *
   * Adds the selected effect/node to the clips in
   *
   * @param q
   */
  void EffectMenuAction(QAction* q);
};

namespace olive {
/**
     * @brief Object resource for various global functions used throughout Olive
     */
extern std::unique_ptr<OliveGlobal> Global;

/**
     * @brief Currently active project filename
     *
     * Filename for the currently active project. Empty means the file has not
     * been saved yet.
     */
extern QString ActiveProjectFilename;

/**
     * @brief Current application name
     */
extern QString AppName;
}

#endif // OLIVEGLOBAL_H