keyframes.h

#ifndef KEYFRAMES_H
#define KEYFRAMES_H
 
#include <stdlib.h>
#include <stdint.h>
#include <stdbool.h>
 
#include "color.h"
 
#define FRAMERATE_MIN  (1U)
 
#define FRAMERATE_MAX  (128U)
 
#define TIMESTEP_FINISHED   ((timestep_t) 0U)
 
#define TIMESTEP_INDEFINITE ((timestep_t) UINT32_MAX)
 
#define GROUP_CHILDREN_MAX_COUNT    (16)
 
typedef enum e_schedule_type
{
    SCHEDULE_TYPE_NONE,     
    SCHEDULE_TYPE_FIXED,    
    SCHEDULE_TYPE_RELATIVE, 
    SCHEDULE_TYPE_INTERVAL, 
} schedule_type_t;
 
typedef enum e_keyframe_flag
{
    KEYFRAME_FLAG_NONE = 0UL,                
    KEYFRAME_FLAG_INITIALIZED = (1UL << 30), 
    KEYFRAME_FLAG_GROUP = (1UL << 31),       
} keyframe_flag_t;
 
typedef uint32_t timestep_t;
 
typedef uint8_t framerate_t;
 
typedef struct st_keyframe_base keyframe_base_t;    // Defined ahead for use in the api struct.
 
typedef struct st_keyframe_base_api
{
    bool (* render_frame)(keyframe_base_t * const p_keyframe, timestep_t time, color_rgb_t * p_color_out);
 
    void (* render_init)(keyframe_base_t * const p_keyframe, framerate_t framerate, color_rgb_t current_color);
 
    keyframe_base_t * (* clone)(keyframe_base_t const * const p_keyframe);
} keyframe_base_api_t;
 
typedef struct st_keyframe_schedule
{
    schedule_type_t type;           
    union
    {
        uint64_t fixed_time;        
        uint64_t relative_time;     
        struct
        {
            uint64_t start;         
            uint64_t end;           
            bool start_is_relative; 
            bool end_is_relative;   
        } interval;
    };
} keyframe_schedule_t;
 
struct st_keyframe_base
{
    keyframe_base_api_t const * const p_api;
    uint32_t flags;
    struct
    {
        keyframe_schedule_t schedule;              
        int32_t             repeat_count;          
        bool                schedule_is_repeating; 
    } modifiers;
};
 
typedef struct st_keyframe_group
{
    keyframe_base_t base;
 
    uint8_t children_len;       
    uint8_t current_child_idx;  
    keyframe_base_t * const children[GROUP_CHILDREN_MAX_COUNT];
} keyframe_group_t;
 
typedef struct st_keyframe_blink
{
    keyframe_base_t base;
    struct
    {
        color_t color1;          
        color_t color2;          
        float   period;          
        uint8_t duty_cycle;      
        bool    color1_provided; 
        bool    color2_provided; 
    } args;
    struct
    {
        timestep_t  transition_time; 
        timestep_t  finish_time;     
    } state;
} keyframe_blink_t;
 
typedef struct st_keyframe_set
{
    keyframe_base_t base;
    struct
    {
        color_t color; 
    } args;
} keyframe_set_t;
 
#include "keyframe_fade.h"
 
keyframe_base_t * keyframe_blink_parse(char * p_str);
keyframe_base_t * keyframe_blink_ctor(keyframe_blink_t * p_blink);
 
keyframe_base_t * keyframe_fade_parse(char * p_str);
keyframe_base_t * keyframe_fade_ctor(keyframe_fade_t * p_fade);
 
keyframe_base_t * keyframe_set_parse(char * p_str);
keyframe_base_t * keyframe_set_ctor(keyframe_set_t * p_set);
 
#endif // KEYFRAMES_H