Mike-Solar
e9f173916f
The full pure-C facade used by the app: node/project/timeline/viewer/ undo/task/events/serializer/playback/preview/renderer/gizmo/color/ audio/footage/proxy/encoding/exporter/config/disk/ipc/plugin/worker families, plus undo-group semantics, display renderer handles, NodeFactory accessors, and per-family pure-C engine tests.
155 lines
4.9 KiB
C
155 lines
4.9 KiB
C
/***
|
|
|
|
Oak - Non-Linear Video Editor
|
|
Copyright (C) 2026 Oak 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 OAKENGINE_DISK_H
|
|
#define OAKENGINE_DISK_H
|
|
|
|
#include "export.h"
|
|
#include "init.h"
|
|
#include "project.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @file disk.h
|
|
* @brief C ABI for the engine's disk cache singleton (olive::DiskManager)
|
|
*
|
|
* A thin facade over DiskManager's instance lifecycle, default/custom cache
|
|
* path management, cache clearing, settings dialog dispatch and project
|
|
* invalidation. The opaque folder handle returned by
|
|
* oakengine_disk_get_open_folder() is a borrowed pointer to the engine's
|
|
* internal DiskCacheFolder for that path; it must not be freed and becomes
|
|
* invalid when the DiskManager instance is destroyed.
|
|
*
|
|
* Conventions match the other facade families:
|
|
* - 0 (OAKENGINE_OK) / negative OAKENGINE_E_* codes.
|
|
* - String output uses the buf/size convention.
|
|
* - Booleans are int (1/0).
|
|
*/
|
|
|
|
/**
|
|
* @brief Callback invoked when the engine requests the disk cache settings
|
|
* dialog for a folder.
|
|
*
|
|
* `folder_path` is the UTF-8 path of the cache folder. `parent_window` is a
|
|
* borrowed pointer to the QWidget that should act as the dialog's parent (may
|
|
* be NULL). `userdata` is the value passed to
|
|
* oakengine_disk_set_settings_handler().
|
|
*/
|
|
typedef void (*oakengine_disk_settings_fn)(const char *folder_path,
|
|
void *parent_window,
|
|
void *userdata);
|
|
|
|
/**
|
|
* @brief Create the DiskManager singleton.
|
|
*
|
|
* Safe to call when the instance already exists (no-op). Returns
|
|
* OAKENGINE_OK or OAKENGINE_E_FAILED.
|
|
*/
|
|
OAKENGINE_API int oakengine_disk_create_instance(void);
|
|
|
|
/**
|
|
* @brief Destroy the DiskManager singleton.
|
|
*
|
|
* Safe to call when no instance exists (no-op). Returns OAKENGINE_OK.
|
|
*/
|
|
OAKENGINE_API int oakengine_disk_destroy_instance(void);
|
|
|
|
/**
|
|
* @brief Register the handler used to show the disk cache settings dialog.
|
|
*
|
|
* The engine calls this handler when the user requests the settings dialog.
|
|
* Passing NULL clears the handler. Returns OAKENGINE_OK.
|
|
*/
|
|
OAKENGINE_API int oakengine_disk_set_settings_handler(
|
|
oakengine_disk_settings_fn fn, void *userdata);
|
|
|
|
/**
|
|
* @brief Show the disk cache settings dialog for `path`.
|
|
*
|
|
* If `path` is NULL or empty, the default cache folder is used. The actual
|
|
* dialog is shown by the handler registered with
|
|
* oakengine_disk_set_settings_handler(); if no handler is registered the
|
|
* request is logged and skipped. Returns OAKENGINE_OK or an error code.
|
|
*/
|
|
OAKENGINE_API int oakengine_disk_show_settings_dialog(const char *path,
|
|
void *parent_window);
|
|
|
|
/**
|
|
* @brief Show a confirmation dialog before changing the disk cache location.
|
|
*
|
|
* Returns 1 if the user confirms, 0 otherwise. `parent_window` may be NULL.
|
|
*/
|
|
OAKENGINE_API int oakengine_disk_show_change_confirmation_dialog(
|
|
void *parent_window);
|
|
|
|
/**
|
|
* @brief Clear the disk cache in `path`.
|
|
*
|
|
* Returns 1 on success, 0 on failure. The folder is opened if necessary.
|
|
*/
|
|
OAKENGINE_API int oakengine_disk_clear_cache(const char *path);
|
|
|
|
/**
|
|
* @brief Get the default cache folder path (buf/size convention).
|
|
*
|
|
* Returns the string length on success, or a negative OAKENGINE_E_* code when
|
|
* no DiskManager instance exists.
|
|
*/
|
|
OAKENGINE_API int oakengine_disk_get_default_cache_path(char *buf,
|
|
int buf_size);
|
|
|
|
/**
|
|
* @brief Set the default cache folder path.
|
|
*
|
|
* The default folder's path is updated and will be persisted when the
|
|
* DiskManager instance is destroyed. Returns OAKENGINE_OK or an error code.
|
|
*/
|
|
OAKENGINE_API int oakengine_disk_set_default_cache_path(const char *path);
|
|
|
|
/**
|
|
* @brief Get or create a borrowed opaque handle to the cache folder for
|
|
* `path`.
|
|
*
|
|
* Returns NULL if no DiskManager instance exists or if `path` is invalid. If
|
|
* `path` is NULL or empty, the default cache folder is returned. The returned
|
|
* handle is a borrowed pointer whose lifetime follows the DiskManager
|
|
* instance; it must not be freed.
|
|
*/
|
|
OAKENGINE_API void *oakengine_disk_get_open_folder(const char *path);
|
|
|
|
/**
|
|
* @brief Emit the invalidate_project signal on the DiskManager instance.
|
|
*
|
|
* This tells consumers of the disk cache that `project` has changed and any
|
|
* cached data for it should be discarded. Returns OAKENGINE_OK or an error
|
|
* code.
|
|
*/
|
|
OAKENGINE_API int oakengine_disk_invalidate_project(
|
|
OakEngineProject *project);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* OAKENGINE_DISK_H */
|