Mike-Solar
295ea1bfe5
- OakUndoCommand/OakUndoStack become neutral by-value handles
{ctx, addref, release, abi_version}; a handle is a shared_ptr
equivalent at the ABI level, internals untouched (box owns/observes
flag; containers adopt, boxes created by factories own)
- oaknode command factories and undoable variants return/write value
handles; timeline command classes hold value handles; task import
take_command returns a value handle
- tests updated everywhere; suites green: oakundo 22, oaktimeline 117,
oaktask 106, oaknode 96, oakrender 44, oakcodec 18, oakcommon 193,
oakaudio 36
227 lines
6.6 KiB
C
227 lines
6.6 KiB
C
/***
|
|
|
|
Oak Video Editor - 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 OAK_EDITOR_NODE_KEYFRAME_H
|
|
#define OAK_EDITOR_NODE_KEYFRAME_H
|
|
|
|
#include <stdint.h>
|
|
|
|
#include "node/error.h"
|
|
#include "node/node.h"
|
|
#include "undo/undocommand.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @file keyframe.h
|
|
* @brief C ABI for olive::NodeKeyframe (src/node/src/keyframe.h).
|
|
*
|
|
* An OakNodeKeyframe is a reinterpreted olive::NodeKeyframe. Handles
|
|
* created by oaknode_keyframe_create() are owned and must be released
|
|
* with oaknode_keyframe_free(); keyframes attached to a node input's
|
|
* track are owned by the node.
|
|
*
|
|
* Every setter comes in a live variant and an undoable variant (suffix
|
|
* _undoable) returning an owned, un-executed OakUndoCommand.
|
|
*/
|
|
|
|
/**
|
|
* @brief Interpolation type of a keyframe (olive::NodeKeyframe::Type).
|
|
*/
|
|
typedef enum oaknode_keyframe_type {
|
|
OAKNODE_KEYFRAME_INVALID = -1,
|
|
OAKNODE_KEYFRAME_LINEAR = 0,
|
|
OAKNODE_KEYFRAME_HOLD = 1,
|
|
OAKNODE_KEYFRAME_BEZIER = 2
|
|
} oaknode_keyframe_type;
|
|
|
|
/**
|
|
* @brief Bezier handle selector (olive::NodeKeyframe::BezierType).
|
|
*/
|
|
typedef enum oaknode_keyframe_bezier {
|
|
OAKNODE_KEYFRAME_IN_HANDLE = 0,
|
|
OAKNODE_KEYFRAME_OUT_HANDLE = 1
|
|
} oaknode_keyframe_bezier;
|
|
|
|
/**
|
|
* @brief Opaque keyframe handle (olive::NodeKeyframe).
|
|
*/
|
|
typedef struct OakNodeKeyframe OakNodeKeyframe;
|
|
|
|
/**
|
|
* @brief Create a standalone keyframe (owned; release with
|
|
* oaknode_keyframe_free()).
|
|
*
|
|
* `value` may be NULL (null variant); OAKNODE_VALUE_STRING is rejected
|
|
* (use oaknode_keyframe_set_value_string() after creation). `type` is an
|
|
* oaknode_keyframe_type. `parent_or_null` may be NULL.
|
|
*
|
|
* @return Keyframe handle, or NULL on invalid argument or allocation
|
|
* failure.
|
|
*/
|
|
OakNodeKeyframe *oaknode_keyframe_create(int64_t time_num, int64_t time_den,
|
|
const oaknode_value *value, int type,
|
|
int track, int element,
|
|
const char *input_id,
|
|
OakNodeNode *parent_or_null);
|
|
|
|
/**
|
|
* @brief Destroy an OWNED keyframe. NULL is a no-op. Never free a
|
|
* keyframe that is attached to a node's track.
|
|
*/
|
|
void oaknode_keyframe_free(OakNodeKeyframe *keyframe);
|
|
|
|
/**
|
|
* @brief The keyframe's time as a rational (numerator/denominator).
|
|
*
|
|
* @return OAKNODE_OK or a negative OAKNODE_E_* error code.
|
|
*/
|
|
int oaknode_keyframe_get_time(const OakNodeKeyframe *keyframe,
|
|
int64_t *out_num, int64_t *out_den);
|
|
|
|
/**
|
|
* @brief Set the keyframe's time directly (live).
|
|
*/
|
|
int oaknode_keyframe_set_time(OakNodeKeyframe *keyframe, int64_t time_num,
|
|
int64_t time_den);
|
|
|
|
/**
|
|
* @brief Create a set-time command (olive::NodeParamSetKeyframeTimeCommand).
|
|
*/
|
|
int oaknode_keyframe_set_time_undoable(OakNodeKeyframe *keyframe,
|
|
int64_t time_num, int64_t time_den,
|
|
OakUndoCommand *out_command);
|
|
|
|
/**
|
|
* @brief Read the keyframe's value mapped into `out`. Values without a
|
|
* POD representation fail with OAKNODE_E_FAILED.
|
|
*/
|
|
int oaknode_keyframe_get_value(const OakNodeKeyframe *keyframe,
|
|
oaknode_value *out);
|
|
|
|
/**
|
|
* @brief Set the keyframe's value directly (live).
|
|
* OAKNODE_VALUE_STRING is rejected (use
|
|
* oaknode_keyframe_set_value_string()).
|
|
*/
|
|
int oaknode_keyframe_set_value(OakNodeKeyframe *keyframe,
|
|
const oaknode_value *v);
|
|
|
|
/**
|
|
* @brief Create a set-value command
|
|
* (olive::NodeParamSetKeyframeValueCommand).
|
|
*/
|
|
int oaknode_keyframe_set_value_undoable(OakNodeKeyframe *keyframe,
|
|
const oaknode_value *v,
|
|
OakUndoCommand *out_command);
|
|
|
|
/**
|
|
* @brief Read a string value. Two-stage getter.
|
|
*
|
|
* @return Required buffer size in bytes including the terminating NUL
|
|
* (non-negative), or a negative OAKNODE_E_* error code.
|
|
*/
|
|
int oaknode_keyframe_get_value_string(const OakNodeKeyframe *keyframe,
|
|
char *buf, int buf_size);
|
|
|
|
/**
|
|
* @brief Set a string value directly (live).
|
|
*/
|
|
int oaknode_keyframe_set_value_string(OakNodeKeyframe *keyframe,
|
|
const char *value);
|
|
|
|
/**
|
|
* @brief Create a set-string-value command.
|
|
*/
|
|
int oaknode_keyframe_set_value_string_undoable(OakNodeKeyframe *keyframe,
|
|
const char *value,
|
|
OakUndoCommand *out_command);
|
|
|
|
/**
|
|
* @brief The keyframe's interpolation type (oaknode_keyframe_type).
|
|
*/
|
|
int oaknode_keyframe_get_type(const OakNodeKeyframe *keyframe, int *out_type);
|
|
|
|
/**
|
|
* @brief Set the interpolation type directly (live,
|
|
* NodeKeyframe::set_type(), which adjusts neighbouring bezier handles).
|
|
*/
|
|
int oaknode_keyframe_set_type(OakNodeKeyframe *keyframe, int type);
|
|
|
|
/**
|
|
* @brief Create a set-type command (same semantics as the live variant).
|
|
*/
|
|
int oaknode_keyframe_set_type_undoable(OakNodeKeyframe *keyframe, int type,
|
|
OakUndoCommand *out_command);
|
|
|
|
/**
|
|
* @brief A bezier control point (`handle` is an
|
|
* oaknode_keyframe_bezier).
|
|
*/
|
|
int oaknode_keyframe_get_bezier_control(const OakNodeKeyframe *keyframe,
|
|
int handle, double *out_x,
|
|
double *out_y);
|
|
|
|
/**
|
|
* @brief Set a bezier control point directly (live).
|
|
*/
|
|
int oaknode_keyframe_set_bezier_control(OakNodeKeyframe *keyframe, int handle,
|
|
double x, double y);
|
|
|
|
/**
|
|
* @brief Create a set-bezier-control command.
|
|
*/
|
|
int oaknode_keyframe_set_bezier_control_undoable(OakNodeKeyframe *keyframe,
|
|
int handle, double x, double y,
|
|
OakUndoCommand *out_command);
|
|
|
|
/**
|
|
* @brief The keyframe's track index.
|
|
*/
|
|
int oaknode_keyframe_get_track(const OakNodeKeyframe *keyframe,
|
|
int *out_track);
|
|
|
|
/**
|
|
* @brief The keyframe's element index.
|
|
*/
|
|
int oaknode_keyframe_get_element(const OakNodeKeyframe *keyframe,
|
|
int *out_element);
|
|
|
|
/**
|
|
* @brief The id of the input this keyframe belongs to. Two-stage getter.
|
|
*/
|
|
int oaknode_keyframe_get_input(const OakNodeKeyframe *keyframe, char *buf,
|
|
int buf_size);
|
|
|
|
/**
|
|
* @brief The node this keyframe belongs to (borrowed handle), or NULL
|
|
* when orphaned. OAKNODE_OK either way.
|
|
*/
|
|
int oaknode_keyframe_get_parent(const OakNodeKeyframe *keyframe,
|
|
OakNodeNode **out_node);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif //OAK_EDITOR_NODE_KEYFRAME_H
|