blenkernel/intern/nla.cc

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2009 Blender Authors, Joshua Leung. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#include <cfloat>
#include <cmath>
#include <cstddef>
#include <cstdio>
#include <cstdlib>
#include <cstring>
 
#include "CLG_log.h"
 
#include "MEM_guardedalloc.h"
 
#include "BLI_ghash.h"
#include "BLI_listbase.h"
#include "BLI_string.h"
#include "BLI_string_utils.hh"
#include "BLI_utildefines.h"
 
#include "BLT_translation.hh"
 
#include "DNA_anim_types.h"
#include "DNA_scene_types.h"
#include "DNA_sound_types.h"
#include "DNA_speaker_types.h"
 
#include "BKE_action.hh"
#include "BKE_anim_data.hh"
#include "BKE_fcurve.hh"
#include "BKE_global.hh"
#include "BKE_lib_id.hh"
#include "BKE_lib_query.hh"
#include "BKE_main.hh"
#include "BKE_nla.hh"
#include "BKE_sound.h"
 
#include "BLO_read_write.hh"
 
#include "RNA_access.hh"
#include "RNA_prototypes.hh"
 
#include "ANIM_nla.hh"
 
#include "nla_private.h"
 
static CLG_LogRef LOG = {"bke.nla"};
 
using namespace blender;
 
static void nla_tweakmode_find_active(const ListBase /*NlaTrack*/ *nla_tracks,
                                      NlaTrack **r_track_of_active_strip,
                                      NlaStrip **r_active_strip);
 
/* *************************************************** */
/* Data Management */
 
/* Freeing ------------------------------------------- */
 
void BKE_nlastrip_free(NlaStrip *strip, const bool do_id_user)
{
  NlaStrip *cs, *csn;
 
  /* sanity checks */
  if (strip == nullptr) {
    return;
  }
 
  /* free child-strips */
  for (cs = static_cast<NlaStrip *>(strip->strips.first); cs; cs = csn) {
    csn = cs->next;
    BKE_nlastrip_remove_and_free(&strip->strips, cs, do_id_user);
  }
 
  /* remove reference to action */
  if (strip->act != nullptr && do_id_user) {
    id_us_min(&strip->act->id);
  }
 
  /* free own F-Curves */
  BKE_fcurves_free(&strip->fcurves);
 
  /* free own F-Modifiers */
  free_fmodifiers(&strip->modifiers);
 
  /* free the strip itself */
  MEM_freeN(strip);
}
 
void BKE_nlatrack_free(NlaTrack *nlt, const bool do_id_user)
{
  NlaStrip *strip, *stripn;
 
  /* sanity checks */
  if (nlt == nullptr) {
    return;
  }
 
  /* free strips */
  for (strip = static_cast<NlaStrip *>(nlt->strips.first); strip; strip = stripn) {
    stripn = strip->next;
    BKE_nlastrip_remove_and_free(&nlt->strips, strip, do_id_user);
  }
 
  /* free NLA track itself now */
  MEM_freeN(nlt);
}
 
void BKE_nla_tracks_free(ListBase *tracks, bool do_id_user)
{
  NlaTrack *nlt, *nltn;
 
  /* sanity checks */
  if (ELEM(nullptr, tracks, tracks->first)) {
    return;
  }
 
  /* free tracks one by one */
  for (nlt = static_cast<NlaTrack *>(tracks->first); nlt; nlt = nltn) {
    nltn = nlt->next;
    BKE_nlatrack_remove_and_free(tracks, nlt, do_id_user);
  }
 
  /* clear the list's pointers to be safe */
  BLI_listbase_clear(tracks);
}
 
/* Copying ------------------------------------------- */
 
NlaStrip *BKE_nlastrip_copy(Main *bmain,
                            NlaStrip *strip,
                            const bool use_same_action,
                            const int flag)
{
  NlaStrip *strip_d;
  NlaStrip *cs_d;
 
  const bool do_id_user = (flag & LIB_ID_CREATE_NO_USER_REFCOUNT) == 0;
 
  /* sanity check */
  if (strip == nullptr) {
    return nullptr;
  }
 
  /* make a copy */
  strip_d = static_cast<NlaStrip *>(MEM_dupallocN(strip));
  strip_d->next = strip_d->prev = nullptr;
 
  /* handle action */
  if (strip_d->act) {
    if (use_same_action) {
      if (do_id_user) {
        /* increase user-count of action */
        id_us_plus(&strip_d->act->id);
      }
    }
    else {
      /* use a copy of the action instead (user count shouldn't have changed yet) */
      BKE_id_copy_ex(bmain, &strip_d->act->id, (ID **)&strip_d->act, flag);
    }
  }
 
  /* copy F-Curves and modifiers */
  BKE_fcurves_copy(&strip_d->fcurves, &strip->fcurves);
  copy_fmodifiers(&strip_d->modifiers, &strip->modifiers);
 
  /* make a copy of all the child-strips, one at a time */
  BLI_listbase_clear(&strip_d->strips);
 
  LISTBASE_FOREACH (NlaStrip *, cs, &strip->strips) {
    cs_d = BKE_nlastrip_copy(bmain, cs, use_same_action, flag);
    BLI_addtail(&strip_d->strips, cs_d);
  }
 
  /* return the strip */
  return strip_d;
}
 
NlaTrack *BKE_nlatrack_copy(Main *bmain,
                            NlaTrack *nlt,
                            const bool use_same_actions,
                            const int flag)
{
  NlaStrip *strip_d;
  NlaTrack *nlt_d;
 
  /* sanity check */
  if (nlt == nullptr) {
    return nullptr;
  }
 
  /* make a copy */
  nlt_d = static_cast<NlaTrack *>(MEM_dupallocN(nlt));
  nlt_d->next = nlt_d->prev = nullptr;
 
  /* make a copy of all the strips, one at a time */
  BLI_listbase_clear(&nlt_d->strips);
 
  LISTBASE_FOREACH (NlaStrip *, strip, &nlt->strips) {
    strip_d = BKE_nlastrip_copy(bmain, strip, use_same_actions, flag);
    BLI_addtail(&nlt_d->strips, strip_d);
  }
 
  /* return the copy */
  return nlt_d;
}
 
void BKE_nla_tracks_copy(Main *bmain, ListBase *dst, const ListBase *src, const int flag)
{
  NlaTrack *nlt_d;
 
  /* sanity checks */
  if (ELEM(nullptr, dst, src)) {
    return;
  }
 
  /* clear out the destination list first for precautions... */
  BLI_listbase_clear(dst);
 
  /* copy each NLA-track, one at a time */
  LISTBASE_FOREACH (NlaTrack *, nlt, src) {
    /* make a copy, and add the copy to the destination list */
    /* XXX: we need to fix this sometime. */
    nlt_d = BKE_nlatrack_copy(bmain, nlt, true, flag);
    BLI_addtail(dst, nlt_d);
  }
}
 
static NlaStrip *find_active_strip_from_listbase(const NlaStrip *active_strip,
                                                 const ListBase /*NlaStrip*/ *strips_source,
                                                 const ListBase /*NlaStrip*/ *strips_dest)
{
  BLI_assert_msg(BLI_listbase_count(strips_source) == BLI_listbase_count(strips_dest),
                 "Expecting the same number of source and destination strips");
 
  NlaStrip *strip_dest = static_cast<NlaStrip *>(strips_dest->first);
  LISTBASE_FOREACH (const NlaStrip *, strip_source, strips_source) {
    if (strip_dest == nullptr) {
      /* The tracks are assumed to have an equal number of strips, but this is
       * not the case. Not sure when this might happen, but it's better to not
       * crash. */
      break;
    }
    if (strip_source == active_strip) {
      return strip_dest;
    }
 
    const bool src_is_meta = strip_source->type == NLASTRIP_TYPE_META;
    const bool dst_is_meta = strip_dest->type == NLASTRIP_TYPE_META;
    BLI_assert_msg(src_is_meta == dst_is_meta,
                   "Expecting topology of source and destination strips to be equal");
    if (src_is_meta && dst_is_meta) {
      NlaStrip *found_in_meta = find_active_strip_from_listbase(
          active_strip, &strip_source->strips, &strip_dest->strips);
      if (found_in_meta != nullptr) {
        return found_in_meta;
      }
    }
 
    strip_dest = strip_dest->next;
  }
 
  return nullptr;
}
 
/* Set adt_dest->actstrip to the strip with the same index as
 * adt_source->actstrip. Note that this always sets `adt_dest->actstrip`; sets
 * to nullptr when `adt_source->actstrip` cannot be found. */
static void update_active_strip(AnimData *adt_dest,
                                NlaTrack *track_dest,
                                const AnimData *adt_source,
                                const NlaTrack *track_source)
{
  BLI_assert(BLI_listbase_count(&track_source->strips) == BLI_listbase_count(&track_dest->strips));
 
  NlaStrip *active_strip = find_active_strip_from_listbase(
      adt_source->actstrip, &track_source->strips, &track_dest->strips);
  adt_dest->actstrip = active_strip;
}
 
/* Set adt_dest->act_track to the track with the same index as adt_source->act_track. */
static void update_active_track(AnimData *adt_dest, const AnimData *adt_source)
{
  adt_dest->act_track = nullptr;
  adt_dest->actstrip = nullptr;
  if (adt_source->act_track == nullptr && adt_source->actstrip == nullptr) {
    return;
  }
 
  BLI_assert(BLI_listbase_count(&adt_source->nla_tracks) ==
             BLI_listbase_count(&adt_dest->nla_tracks));
 
  NlaTrack *track_dest = static_cast<NlaTrack *>(adt_dest->nla_tracks.first);
  LISTBASE_FOREACH (NlaTrack *, track_source, &adt_source->nla_tracks) {
    if (track_source == adt_source->act_track) {
      adt_dest->act_track = track_dest;
    }
 
    /* Only search for the active strip if it hasn't been found yet. */
    if (adt_dest->actstrip == nullptr && adt_source->actstrip != nullptr) {
      update_active_strip(adt_dest, track_dest, adt_source, track_source);
    }
 
    track_dest = track_dest->next;
  }
 
#ifndef NDEBUG
  {
    const bool source_has_actstrip = adt_source->actstrip != nullptr;
    const bool dest_has_actstrip = adt_dest->actstrip != nullptr;
    BLI_assert_msg(source_has_actstrip == dest_has_actstrip,
                   "Active strip did not copy correctly");
  }
#endif
}
 
void BKE_nla_tracks_copy_from_adt(Main *bmain,
                                  AnimData *adt_dest,
                                  const AnimData *adt_source,
                                  const int flag)
{
  adt_dest->act_track = nullptr;
  adt_dest->actstrip = nullptr;
 
  BKE_nla_tracks_copy(bmain, &adt_dest->nla_tracks, &adt_source->nla_tracks, flag);
  update_active_track(adt_dest, adt_source);
}
 
/* Adding ------------------------------------------- */
 
NlaTrack *BKE_nlatrack_new()
{
  /* allocate new track */
  NlaTrack *nlt = static_cast<NlaTrack *>(MEM_callocN(sizeof(NlaTrack), "NlaTrack"));
 
  /* set settings requiring the track to not be part of the stack yet */
  nlt->flag = NLATRACK_SELECTED | NLATRACK_OVERRIDELIBRARY_LOCAL;
 
  return nlt;
}
 
void BKE_nlatrack_insert_before(ListBase *nla_tracks,
                                NlaTrack *next,
                                NlaTrack *new_track,
                                bool is_liboverride)
{
 
  if (is_liboverride) {
    /* Currently, all library override tracks are assumed to be grouped together at the start of
     * the list. Non overridden must be placed after last library track. */
    if (next != nullptr && (next->flag & NLATRACK_OVERRIDELIBRARY_LOCAL) == 0) {
      BKE_nlatrack_insert_after(nla_tracks, next, new_track, is_liboverride);
      return;
    }
  }
 
  BLI_insertlinkbefore(nla_tracks, next, new_track);
  new_track->index = BLI_findindex(nla_tracks, new_track);
 
  /* Must have unique name, but we need to seed this. */
  STRNCPY(new_track->name, "NlaTrack");
 
  BLI_uniquename(nla_tracks,
                 new_track,
                 DATA_("NlaTrack"),
                 '.',
                 offsetof(NlaTrack, name),
                 sizeof(new_track->name));
}
 
void BKE_nlatrack_insert_after(ListBase *nla_tracks,
                               NlaTrack *prev,
                               NlaTrack *new_track,
                               const bool is_liboverride)
{
  BLI_assert(nla_tracks);
  BLI_assert(new_track);
 
  if (prev == nullptr) {
    NlaTrack *first_track = (NlaTrack *)nla_tracks->first;
    if (first_track != nullptr && (first_track->flag & NLATRACK_OVERRIDELIBRARY_LOCAL) == 0) {
      prev = first_track;
    }
  }
 
  /* In liboverride case, we only add local tracks after all those coming from the linked data,
   * so we need to find the first local track. */
  if (is_liboverride && prev != nullptr && (prev->flag & NLATRACK_OVERRIDELIBRARY_LOCAL) == 0) {
    NlaTrack *first_local = prev->next;
    for (; first_local != nullptr && (first_local->flag & NLATRACK_OVERRIDELIBRARY_LOCAL) == 0;
         first_local = first_local->next)
    {
    }
    prev = first_local != nullptr ? first_local->prev : prev;
  }
 
  /* Add track to stack, and make it the active one. */
  BLI_insertlinkafter(nla_tracks, prev, new_track);
  new_track->index = BLI_findindex(nla_tracks, new_track);
 
  /* must have unique name, but we need to seed this */
  BLI_uniquename(nla_tracks,
                 new_track,
                 DATA_("NlaTrack"),
                 '.',
                 offsetof(NlaTrack, name),
                 sizeof(new_track->name));
}
 
NlaTrack *BKE_nlatrack_new_before(ListBase *nla_tracks, NlaTrack *next, bool is_liboverride)
{
  NlaTrack *new_track = BKE_nlatrack_new();
 
  BKE_nlatrack_insert_before(nla_tracks, next, new_track, is_liboverride);
 
  return new_track;
}
 
NlaTrack *BKE_nlatrack_new_after(ListBase *nla_tracks, NlaTrack *prev, bool is_liboverride)
{
  NlaTrack *new_track = BKE_nlatrack_new();
 
  BKE_nlatrack_insert_after(nla_tracks, prev, new_track, is_liboverride);
 
  return new_track;
}
 
NlaTrack *BKE_nlatrack_new_head(ListBase *nla_tracks, bool is_liboverride)
{
  return BKE_nlatrack_new_before(nla_tracks, (NlaTrack *)nla_tracks->first, is_liboverride);
}
 
NlaTrack *BKE_nlatrack_new_tail(ListBase *nla_tracks, const bool is_liboverride)
{
  return BKE_nlatrack_new_after(nla_tracks, (NlaTrack *)nla_tracks->last, is_liboverride);
}
 
float BKE_nla_clip_length_get_nonzero(const NlaStrip *strip)
{
  if (strip->actend <= strip->actstart) {
    return 1.0f;
  }
  return strip->actend - strip->actstart;
}
 
void BKE_nla_clip_length_ensure_nonzero(const float *actstart, float *r_actend)
{
  if (*r_actend <= *actstart) {
    *r_actend = *actstart + 1.0f;
  }
}
 
NlaStrip *BKE_nlastrip_new(bAction *act, ID &animated_id)
{
  using namespace blender::animrig;
 
  NlaStrip *strip;
 
  /* sanity checks */
  if (act == nullptr) {
    return nullptr;
  }
 
  /* allocate new strip */
  strip = static_cast<NlaStrip *>(MEM_callocN(sizeof(NlaStrip), "NlaStrip"));
 
  /* generic settings
   * - selected flag to highlight this to the user
   * - (XXX) disabled Auto-Blends, as this was often causing some unwanted effects
   */
  strip->flag = NLASTRIP_FLAG_SELECT | NLASTRIP_FLAG_SYNC_LENGTH;
 
  /* Disable sync for actions with a manual frame range, since it only syncs to range anyway. */
  if (act->flag & ACT_FRAME_RANGE) {
    strip->flag &= ~NLASTRIP_FLAG_SYNC_LENGTH;
  }
 
  /* Enable cyclic time for known cyclic actions. */
  Action &action = act->wrap();
  if (action.is_cyclic()) {
    strip->flag |= NLASTRIP_FLAG_USR_TIME_CYCLIC;
  }
 
  /* Assign the Action, and automatically choose a suitable slot. The caller can change the slot to
   * something more specific later, if necessary. */
  nla::assign_action(*strip, action, animated_id);
 
  /* determine initial range */
  const float2 frame_range = action.get_frame_range();
  strip->actstart = frame_range[0];
  strip->actend = frame_range[1];
  BKE_nla_clip_length_ensure_nonzero(&strip->actstart, &strip->actend);
  strip->start = strip->actstart;
  strip->end = strip->actend;
 
  /* strip should be referenced as-is */
  strip->scale = 1.0f;
  strip->repeat = 1.0f;
 
  /* return the new strip */
  return strip;
}
 
NlaStrip *BKE_nlastack_add_strip(const OwnedAnimData owned_adt,
                                 bAction *act,
                                 const bool is_liboverride)
{
  NlaStrip *strip;
  NlaTrack *nlt;
  AnimData *adt = &owned_adt.adt;
 
  /* sanity checks */
  if (ELEM(nullptr, adt, act)) {
    return nullptr;
  }
 
  /* create a new NLA strip */
  strip = BKE_nlastrip_new(act, owned_adt.owner_id);
  if (strip == nullptr) {
    return nullptr;
  }
 
  /* firstly try adding strip to last track, but if that fails, add to a new track */
  if (BKE_nlatrack_add_strip(
          static_cast<NlaTrack *>(adt->nla_tracks.last), strip, is_liboverride) == 0)
  {
    /* trying to add to the last track failed (no track or no space),
     * so add a new track to the stack, and add to that...
     */
    nlt = BKE_nlatrack_new_tail(&adt->nla_tracks, is_liboverride);
    BKE_nlatrack_set_active(&adt->nla_tracks, nlt);
    BKE_nlatrack_add_strip(nlt, strip, is_liboverride);
    STRNCPY(nlt->name, act->id.name + 2);
  }
 
  /* automatically name it too */
  BKE_nlastrip_validate_name(adt, strip);
 
  /* returns the strip added */
  return strip;
}
 
NlaStrip *BKE_nla_add_soundstrip(Main *bmain, Scene *scene, Speaker *speaker)
{
  NlaStrip *strip = static_cast<NlaStrip *>(MEM_callocN(sizeof(NlaStrip), "NlaSoundStrip"));
 
/* if speaker has a sound, set the strip length to the length of the sound,
 * otherwise default to length of 10 frames
 */
#ifdef WITH_AUDASPACE
  if (speaker->sound) {
    SoundInfo info;
    if (BKE_sound_info_get(bmain, speaker->sound, &info)) {
      strip->end = float(ceil(double(info.length) * FPS));
    }
  }
  else
#endif
  {
    strip->end = 10.0f;
    /* quiet compiler warnings */
    UNUSED_VARS(bmain, scene, speaker);
  }
 
  /* general settings */
  strip->type = NLASTRIP_TYPE_SOUND;
 
  strip->flag = NLASTRIP_FLAG_SELECT;
  strip->extendmode = NLASTRIP_EXTEND_NOTHING; /* nothing to extend... */
 
  /* strip should be referenced as-is */
  strip->scale = 1.0f;
  strip->repeat = 1.0f;
 
  /* return this strip */
  return strip;
}
 
void BKE_nla_strip_foreach_id(NlaStrip *strip, LibraryForeachIDData *data)
{
  BKE_LIB_FOREACHID_PROCESS_IDSUPER(data, strip->act, IDWALK_CB_USER);
 
  LISTBASE_FOREACH (FCurve *, fcu, &strip->fcurves) {
    BKE_LIB_FOREACHID_PROCESS_FUNCTION_CALL(data, BKE_fcurve_foreach_id(fcu, data));
  }
 
  LISTBASE_FOREACH (NlaStrip *, substrip, &strip->strips) {
    BKE_LIB_FOREACHID_PROCESS_FUNCTION_CALL(data, BKE_nla_strip_foreach_id(substrip, data));
  }
}
 
/* Removing ------------------------------------------ */
 
void BKE_nlatrack_remove(ListBase *tracks, NlaTrack *nlt)
{
  BLI_assert(tracks);
  BLI_remlink(tracks, nlt);
}
 
void BKE_nlatrack_remove_and_free(ListBase *tracks, NlaTrack *nlt, bool do_id_user)
{
  BKE_nlatrack_remove(tracks, nlt);
  BKE_nlatrack_free(nlt, do_id_user);
}
 
/* *************************************************** */
/* NLA Evaluation <-> Editing Stuff */
 
/* Strip Mapping ------------------------------------- */
 
/* non clipped mapping for strip-time <-> global time (for Action-Clips)
 * invert = convert action-strip time to global time
 */
static float nlastrip_get_frame_actionclip(NlaStrip *strip, float cframe, short mode)
{
  float scale;
  // float repeat; // UNUSED
 
  /* get number of repeats */
  if (IS_EQF(strip->repeat, 0.0f)) {
    strip->repeat = 1.0f;
  }
  // repeat = strip->repeat; /* UNUSED */
 
  /* scaling */
  if (IS_EQF(strip->scale, 0.0f)) {
    strip->scale = 1.0f;
  }
 
  /* Scale must be positive - we've got a special flag for reversing. */
  scale = fabsf(strip->scale);
 
  /* length of referenced action */
  const float actlength = BKE_nla_clip_length_get_nonzero(strip);
 
  /* reversed = play strip backwards */
  if (strip->flag & NLASTRIP_FLAG_REVERSE) {
    /* FIXME: this won't work right with Graph Editor? */
    if (mode == NLATIME_CONVERT_MAP) {
      return strip->end - scale * (cframe - strip->actstart);
    }
    if (mode == NLATIME_CONVERT_UNMAP) {
      return (strip->end + (strip->actstart * scale - cframe)) / scale;
    }
    /* if (mode == NLATIME_CONVERT_EVAL) */
    if (IS_EQF(float(cframe), strip->end) && IS_EQF(strip->repeat, floorf(strip->repeat))) {
      /* This case prevents the motion snapping back to the first frame at the end of the strip
       * by catching the case where repeats is a whole number, which means that the end of the
       * strip could also be interpreted as the end of the start of a repeat. */
      return strip->actstart;
    }
 
    /* - the 'fmod(..., actlength * scale)' is needed to get the repeats working
     * - the '/ scale' is needed to ensure that scaling influences the timing within the repeat
     */
    return strip->actend - fmodf(cframe - strip->start, actlength * scale) / scale;
  }
 
  if (mode == NLATIME_CONVERT_MAP) {
    return strip->start + scale * (cframe - strip->actstart);
  }
  if (mode == NLATIME_CONVERT_UNMAP) {
    return strip->actstart + (cframe - strip->start) / scale;
  }
  /* if (mode == NLATIME_CONVERT_EVAL) */
  if (IS_EQF(cframe, strip->end) && IS_EQF(strip->repeat, floorf(strip->repeat))) {
    /* This case prevents the motion snapping back to the first frame at the end of the strip
     * by catching the case where repeats is a whole number, which means that the end of the
     * strip could also be interpreted as the end of the start of a repeat. */
    return strip->actend;
  }
 
  /* - the 'fmod(..., actlength * scale)' is needed to get the repeats working
   * - the '/ scale' is needed to ensure that scaling influences the timing within the repeat
   */
  return strip->actstart + fmodf(cframe - strip->start, actlength * scale) / scale;
}
 
/* non clipped mapping for strip-time <-> global time (for Transitions)
 * invert = convert action-strip time to global time
 */
static float nlastrip_get_frame_transition(NlaStrip *strip, float cframe, short mode)
{
  float length;
 
  /* length of strip */
  length = strip->end - strip->start;
 
  /* reversed = play strip backwards */
  if (strip->flag & NLASTRIP_FLAG_REVERSE) {
    if (mode == NLATIME_CONVERT_MAP) {
      return strip->end - (length * cframe);
    }
 
    return (strip->end - cframe) / length;
  }
 
  if (mode == NLATIME_CONVERT_MAP) {
    return (length * cframe) + strip->start;
  }
 
  return (cframe - strip->start) / length;
}
 
float nlastrip_get_frame(NlaStrip *strip, float cframe, short mode)
{
  switch (strip->type) {
    case NLASTRIP_TYPE_META:       /* Meta - for now, does the same as transition
                                    * (is really just an empty container). */
    case NLASTRIP_TYPE_TRANSITION: /* transition */
      return nlastrip_get_frame_transition(strip, cframe, mode);
 
    case NLASTRIP_TYPE_CLIP: /* action-clip (default) */
    default:
      return nlastrip_get_frame_actionclip(strip, cframe, mode);
  }
}
 
float BKE_nla_tweakedit_remap(AnimData *adt, float cframe, short mode)
{
  NlaStrip *strip;
 
  /* Sanity checks:
   * - Obviously we've got to have some starting data.
   * - When not in tweak-mode, the active Action does not have any scaling applied :)
   * - When in tweak-mode, if the no-mapping flag is set, do not map.
   */
  if ((adt == nullptr) || (adt->flag & ADT_NLA_EDIT_ON) == 0 || (adt->flag & ADT_NLA_EDIT_NOMAP)) {
    return cframe;
  }
 
  /* if the active-strip info has been stored already, access this, otherwise look this up
   * and store for (very probable) future usage
   */
  if (adt->act_track == nullptr) {
    if (adt->actstrip) {
      adt->act_track = BKE_nlatrack_find_tweaked(adt);
    }
    else {
      adt->act_track = BKE_nlatrack_find_active(&adt->nla_tracks);
    }
  }
  if (adt->actstrip == nullptr) {
    adt->actstrip = BKE_nlastrip_find_active(adt->act_track);
  }
  strip = adt->actstrip;
 
  /* Sanity checks:
   * - In rare cases, we may not be able to find this strip for some reason (internal error)
   * - For now, if the user has defined a curve to control the time, this correction cannot be
   *   performed reliably.
   */
  if ((strip == nullptr) || (strip->flag & NLASTRIP_FLAG_USR_TIME)) {
    return cframe;
  }
 
  /* perform the correction now... */
  return nlastrip_get_frame(strip, cframe, mode);
}
 
/* *************************************************** */
/* NLA API */
 
/* List of Strips ------------------------------------ */
/* (these functions are used for NLA-Tracks and also for nested/meta-strips) */
 
bool BKE_nlastrips_has_space(ListBase *strips, float start, float end)
{
  /* sanity checks */
  if ((strips == nullptr) || IS_EQF(start, end)) {
    return false;
  }
  if (start > end) {
    puts("BKE_nlastrips_has_space() error... start and end arguments swapped");
    std::swap(start, end);
  }
 
  /* loop over NLA strips checking for any overlaps with this area... */
  LISTBASE_FOREACH (NlaStrip *, strip, strips) {
    /* if start frame of strip is past the target end-frame, that means that
     * we've gone past the window we need to check for, so things are fine
     */
    if (strip->start >= end) {
      return true;
    }
 
    /* if the end of the strip is greater than either of the boundaries, the range
     * must fall within the extents of the strip
     */
    if ((strip->end > start) || (strip->end > end)) {
      return false;
    }
  }
 
  /* if we are still here, we haven't encountered any overlapping strips */
  return true;
}
 
void BKE_nlastrips_sort_strips(ListBase *strips)
{
  ListBase tmp = {nullptr, nullptr};
  NlaStrip *strip, *stripn;
 
  /* sanity checks */
  if (ELEM(nullptr, strips, strips->first)) {
    return;
  }
 
  /* we simply perform insertion sort on this list, since it is assumed that per track,
   * there are only likely to be at most 5-10 strips
   */
  for (strip = static_cast<NlaStrip *>(strips->first); strip; strip = stripn) {
    short not_added = 1;
 
    stripn = strip->next;
 
    /* remove this strip from the list, and add it to the new list, searching from the end of
     * the list, assuming that the lists are in order
     */
    BLI_remlink(strips, strip);
 
    LISTBASE_FOREACH_BACKWARD (NlaStrip *, sstrip, &tmp) {
      /* check if add after */
      if (sstrip->start <= strip->start) {
        BLI_insertlinkafter(&tmp, sstrip, strip);
        not_added = 0;
        break;
      }
    }
 
    /* add before first? */
    if (not_added) {
      BLI_addhead(&tmp, strip);
    }
  }
 
  /* reassign the start and end points of the strips */
  strips->first = tmp.first;
  strips->last = tmp.last;
}
 
void BKE_nlastrips_add_strip_unsafe(ListBase *strips, NlaStrip *strip)
{
  bool not_added = true;
 
  /* sanity checks */
  BLI_assert(!ELEM(nullptr, strips, strip));
 
  /* find the right place to add the strip to the nominated track */
  LISTBASE_FOREACH (NlaStrip *, ns, strips) {
    /* if current strip occurs after the new strip, add it before */
    if (ns->start >= strip->start) {
      BLI_insertlinkbefore(strips, ns, strip);
      not_added = false;
      break;
    }
  }
  if (not_added) {
    /* just add to the end of the list of the strips then... */
    BLI_addtail(strips, strip);
  }
}
 
bool BKE_nlastrips_add_strip(ListBase *strips, NlaStrip *strip)
{
  if (ELEM(nullptr, strips, strip)) {
    return false;
  }
 
  if (!BKE_nlastrips_has_space(strips, strip->start, strip->end)) {
    return false;
  }
 
  BKE_nlastrips_add_strip_unsafe(strips, strip);
  return true;
}
 
/* Meta-Strips ------------------------------------ */
 
void BKE_nlastrips_make_metas(ListBase *strips, bool is_temp)
{
  NlaStrip *mstrip = nullptr;
  NlaStrip *strip, *stripn;
 
  /* sanity checks */
  if (ELEM(nullptr, strips, strips->first)) {
    return;
  }
 
  /* group all continuous chains of selected strips into meta-strips */
  for (strip = static_cast<NlaStrip *>(strips->first); strip; strip = stripn) {
    stripn = strip->next;
 
    if (strip->flag & NLASTRIP_FLAG_SELECT) {
      /* if there is an existing meta-strip, add this strip to it, otherwise, create a new one */
      if (mstrip == nullptr) {
        /* add a new meta-strip, and add it before the current strip that it will replace... */
        mstrip = static_cast<NlaStrip *>(MEM_callocN(sizeof(NlaStrip), "Meta-NlaStrip"));
        mstrip->type = NLASTRIP_TYPE_META;
        BLI_insertlinkbefore(strips, strip, mstrip);
 
        /* set flags */
        mstrip->flag = NLASTRIP_FLAG_SELECT;
 
        /* set temp flag if appropriate (i.e. for transform-type editing) */
        if (is_temp) {
          mstrip->flag |= NLASTRIP_FLAG_TEMP_META;
        }
 
        /* set default repeat/scale values to prevent warnings */
        mstrip->repeat = mstrip->scale = 1.0f;
 
        /* make its start frame be set to the start frame of the current strip */
        mstrip->start = strip->start;
      }
 
      /* remove the selected strips from the track, and add to the meta */
      BLI_remlink(strips, strip);
      BLI_addtail(&mstrip->strips, strip);
 
      /* expand the meta's dimensions to include the newly added strip- i.e. its last frame */
      mstrip->end = strip->end;
    }
    else {
      /* current strip wasn't selected, so the end of 'island' of selected strips has been
       * reached, so stop adding strips to the current meta.
       */
      mstrip = nullptr;
    }
  }
}
 
void BKE_nlastrips_clear_metastrip(ListBase *strips, NlaStrip *strip)
{
  NlaStrip *cs, *csn;
 
  /* sanity check */
  if (ELEM(nullptr, strips, strip)) {
    return;
  }
 
  /* move each one of the meta-strip's children before the meta-strip
   * in the list of strips after unlinking them from the meta-strip
   */
  for (cs = static_cast<NlaStrip *>(strip->strips.first); cs; cs = csn) {
    csn = cs->next;
    BLI_remlink(&strip->strips, cs);
    BLI_insertlinkbefore(strips, strip, cs);
  }
 
  /* free the meta-strip now */
  BKE_nlastrip_remove_and_free(strips, strip, true);
}
 
void BKE_nlastrips_clear_metas(ListBase *strips, bool only_sel, bool only_temp)
{
  NlaStrip *strip, *stripn;
 
  /* sanity checks */
  if (ELEM(nullptr, strips, strips->first)) {
    return;
  }
 
  /* remove meta-strips fitting the criteria of the arguments */
  for (strip = static_cast<NlaStrip *>(strips->first); strip; strip = stripn) {
    stripn = strip->next;
 
    /* check if strip is a meta-strip */
    if (strip->type == NLASTRIP_TYPE_META) {
      /* if check if selection and 'temporary-only' considerations are met */
      if ((!only_sel) || (strip->flag & NLASTRIP_FLAG_SELECT)) {
        if ((!only_temp) || (strip->flag & NLASTRIP_FLAG_TEMP_META)) {
          BKE_nlastrips_clear_metastrip(strips, strip);
        }
      }
    }
  }
}
 
bool BKE_nlameta_add_strip(NlaStrip *mstrip, NlaStrip *strip)
{
  /* sanity checks */
  if (ELEM(nullptr, mstrip, strip)) {
    return false;
  }
 
  /* firstly, check if the meta-strip has space for this */
  if (BKE_nlastrips_has_space(&mstrip->strips, strip->start, strip->end) == 0) {
    return false;
  }
 
  /* check if this would need to be added to the ends of the meta,
   * and subsequently, if the neighboring strips allow us enough room
   */
  if (strip->start < mstrip->start) {
    /* check if strip to the left (if it exists) ends before the
     * start of the strip we're trying to add
     */
    if ((mstrip->prev == nullptr) || (mstrip->prev->end <= strip->start)) {
      /* add strip to start of meta's list, and expand dimensions */
      BLI_addhead(&mstrip->strips, strip);
      mstrip->start = strip->start;
 
      return true;
    }
    /* failed... no room before */
    return false;
  }
  if (strip->end > mstrip->end) {
    /* check if strip to the right (if it exists) starts before the
     * end of the strip we're trying to add
     */
    if ((mstrip->next == nullptr) || (mstrip->next->start >= strip->end)) {
      /* add strip to end of meta's list, and expand dimensions */
      BLI_addtail(&mstrip->strips, strip);
      mstrip->end = strip->end;
 
      return true;
    }
    /* failed... no room after */
    return false;
  }
 
  /* just try to add to the meta-strip (no dimension changes needed) */
  return BKE_nlastrips_add_strip(&mstrip->strips, strip);
}
 
void BKE_nlameta_flush_transforms(NlaStrip *mstrip)
{
  float oStart, oEnd, offset;
  float oLen, nLen;
  short scaleChanged = 0;
 
  /* sanity checks
   * - strip must exist
   * - strip must be a meta-strip with some contents
   */
  if (ELEM(nullptr, mstrip, mstrip->strips.first)) {
    return;
  }
  if (mstrip->type != NLASTRIP_TYPE_META) {
    return;
  }
 
  /* get the original start/end points, and calculate the start-frame offset
   * - these are simply the start/end frames of the child strips,
   *   since we assume they weren't transformed yet
   */
  oStart = ((NlaStrip *)mstrip->strips.first)->start;
  oEnd = ((NlaStrip *)mstrip->strips.last)->end;
  offset = mstrip->start - oStart;
 
  /* check if scale changed */
  oLen = oEnd - oStart;
  nLen = mstrip->end - mstrip->start;
  scaleChanged = !IS_EQF(oLen, nLen);
 
  /* optimization:
   * don't flush if nothing changed yet
   * TODO: maybe we need a flag to say always flush?
   */
  if (IS_EQF(oStart, mstrip->start) && IS_EQF(oEnd, mstrip->end) && !scaleChanged) {
    return;
  }
 
  /* for each child-strip, calculate new start/end points based on this new info */
  LISTBASE_FOREACH (NlaStrip *, strip, &mstrip->strips) {
    if (scaleChanged) {
      float p1, p2;
 
      if (oLen) {
        /* Compute positions of endpoints relative to old extents of strip. */
        p1 = (strip->start - oStart) / oLen;
        p2 = (strip->end - oStart) / oLen;
      }
      else {
        /* WORKAROUND: in theory, a strip should never be zero length. However,
         * zero-length strips are nevertheless showing up here (see issue #113552).
         * This is a stop-gap fix to handle that and prevent a divide by zero. A
         * proper fix will need to track down and fix the source(s) of these
         * zero-length strips. */
        p1 = 0.0f;
        p2 = 1.0f;
      }
 
      /* Apply new strip endpoints using the proportions,
       * then wait for second pass to flush scale properly. */
      strip->start = (p1 * nLen) + mstrip->start;
      strip->end = (p2 * nLen) + mstrip->start;
 
      /* Recompute the playback scale, given the new start & end frame of the strip. */
      const double action_len = strip->actend - strip->actstart;
      const double repeated_len = action_len * strip->repeat;
      const double strip_len = strip->end - strip->start;
      strip->scale = strip_len / repeated_len;
    }
    else {
      /* just apply the changes in offset to both ends of the strip */
      strip->start += offset;
      strip->end += offset;
    }
  }
 
  /* apply a second pass over child strips, to finish up unfinished business */
  LISTBASE_FOREACH (NlaStrip *, strip, &mstrip->strips) {
    /* only if scale changed, need to perform RNA updates */
    if (scaleChanged) {
      /* use RNA updates to compute scale properly */
      PointerRNA ptr = RNA_pointer_create(nullptr, &RNA_NlaStrip, strip);
 
      RNA_float_set(&ptr, "frame_start", strip->start);
      RNA_float_set(&ptr, "frame_end", strip->end);
    }
 
    /* finally, make sure the strip's children (if it is a meta-itself), get updated */
    BKE_nlameta_flush_transforms(strip);
  }
}
 
/* NLA-Tracks ---------------------------------------- */
 
NlaTrack *BKE_nlatrack_find_active(ListBase *tracks)
{
  /* sanity check */
  if (ELEM(nullptr, tracks, tracks->first)) {
    return nullptr;
  }
 
  /* try to find the first active track */
  LISTBASE_FOREACH (NlaTrack *, nlt, tracks) {
    if (nlt->flag & NLATRACK_ACTIVE) {
      return nlt;
    }
  }
 
  /* none found */
  return nullptr;
}
 
NlaTrack *BKE_nlatrack_find_tweaked(AnimData *adt)
{
  /* sanity check */
  if (adt == nullptr) {
    return nullptr;
  }
 
  /* Since the track itself gets disabled, we want the first disabled... */
  LISTBASE_FOREACH (NlaTrack *, nlt, &adt->nla_tracks) {
    if (nlt->flag & (NLATRACK_ACTIVE | NLATRACK_DISABLED)) {
      /* For good measure, make sure that strip actually exists there */
      if (BLI_findindex(&nlt->strips, adt->actstrip) != -1) {
        return nlt;
      }
      if (G.debug & G_DEBUG) {
        printf("%s: Active strip (%p, %s) not in NLA track found (%p, %s)\n",
               __func__,
               adt->actstrip,
               (adt->actstrip) ? adt->actstrip->name : "<None>",
               nlt,
               nlt->name);
      }
    }
  }
 
  /* Not found! */
  return nullptr;
}
 
void BKE_nlatrack_solo_toggle(AnimData *adt, NlaTrack *nlt)
{
  /* sanity check */
  if (ELEM(nullptr, adt, adt->nla_tracks.first)) {
    return;
  }
 
  /* firstly, make sure 'solo' flag for all tracks is disabled */
  LISTBASE_FOREACH (NlaTrack *, nt, &adt->nla_tracks) {
    if (nt != nlt) {
      nt->flag &= ~NLATRACK_SOLO;
    }
  }
 
  /* now, enable 'solo' for the given track if appropriate */
  if (nlt) {
    /* toggle solo status */
    nlt->flag ^= NLATRACK_SOLO;
 
    /* set or clear solo-status on AnimData */
    if (nlt->flag & NLATRACK_SOLO) {
      adt->flag |= ADT_NLA_SOLO_TRACK;
    }
    else {
      adt->flag &= ~ADT_NLA_SOLO_TRACK;
    }
  }
  else {
    adt->flag &= ~ADT_NLA_SOLO_TRACK;
  }
}
 
void BKE_nlatrack_set_active(ListBase *tracks, NlaTrack *nlt_a)
{
  /* sanity check */
  if (ELEM(nullptr, tracks, tracks->first)) {
    return;
  }
 
  /* deactivate all the rest */
  LISTBASE_FOREACH (NlaTrack *, nlt, tracks) {
    nlt->flag &= ~NLATRACK_ACTIVE;
  }
 
  /* set the given one as the active one */
  if (nlt_a) {
    nlt_a->flag |= NLATRACK_ACTIVE;
  }
}
 
bool BKE_nlatrack_has_space(NlaTrack *nlt, float start, float end)
{
  /* sanity checks
   * - track must exist
   * - track must be editable
   * - bounds cannot be equal (0-length is nasty)
   */
  if ((nlt == nullptr) || (nlt->flag & NLATRACK_PROTECTED) || IS_EQF(start, end)) {
    return false;
  }
 
  if (start > end) {
    puts("BKE_nlatrack_has_space() error... start and end arguments swapped");
    std::swap(start, end);
  }
 
  /* check if there's any space left in the track for a strip of the given length */
  return BKE_nlastrips_has_space(&nlt->strips, start, end);
}
 
bool BKE_nlatrack_has_strips(ListBase *tracks)
{
  /* sanity checks */
  if (BLI_listbase_is_empty(tracks)) {
    return false;
  }
 
  /* Check each track for NLA strips. */
  LISTBASE_FOREACH (NlaTrack *, track, tracks) {
    if (BLI_listbase_count(&track->strips) > 0) {
      return true;
    }
  }
 
  /* none found */
  return false;
}
 
void BKE_nlatrack_sort_strips(NlaTrack *nlt)
{
  /* sanity checks */
  if (ELEM(nullptr, nlt, nlt->strips.first)) {
    return;
  }
 
  /* sort the strips with a more generic function */
  BKE_nlastrips_sort_strips(&nlt->strips);
}
 
bool BKE_nlatrack_add_strip(NlaTrack *nlt, NlaStrip *strip, const bool is_liboverride)
{
  /* sanity checks */
  if (ELEM(nullptr, nlt, strip)) {
    return false;
  }
 
  /*
   * Do not allow adding strips if this track is locked, or not a local one in liboverride case.
   */
  if (nlt->flag & NLATRACK_PROTECTED ||
      (is_liboverride && (nlt->flag & NLATRACK_OVERRIDELIBRARY_LOCAL) == 0))
  {
    return false;
  }
 
  /* try to add the strip to the track using a more generic function */
  return BKE_nlastrips_add_strip(&nlt->strips, strip);
}
 
void BKE_nlatrack_remove_strip(NlaTrack *track, NlaStrip *strip)
{
  BLI_assert(track);
  BKE_nlastrip_remove(&track->strips, strip);
}
 
bool BKE_nlatrack_get_bounds(NlaTrack *nlt, float bounds[2])
{
  NlaStrip *strip;
 
  /* initialize bounds */
  if (bounds) {
    bounds[0] = bounds[1] = 0.0f;
  }
  else {
    return false;
  }
 
  /* sanity checks */
  if (ELEM(nullptr, nlt, nlt->strips.first)) {
    return false;
  }
 
  /* lower bound is first strip's start frame */
  strip = static_cast<NlaStrip *>(nlt->strips.first);
  bounds[0] = strip->start;
 
  /* upper bound is last strip's end frame */
  strip = static_cast<NlaStrip *>(nlt->strips.last);
  bounds[1] = strip->end;
 
  /* done */
  return true;
}
 
bool BKE_nlatrack_is_nonlocal_in_liboverride(const ID *id, const NlaTrack *nlt)
{
  return (ID_IS_OVERRIDE_LIBRARY(id) &&
          (nlt == nullptr || (nlt->flag & NLATRACK_OVERRIDELIBRARY_LOCAL) == 0));
}
 
/* NLA Strips -------------------------------------- */
 
static NlaStrip *nlastrip_find_active(ListBase /*NlaStrip*/ *strips)
{
  LISTBASE_FOREACH (NlaStrip *, strip, strips) {
    if (strip->flag & NLASTRIP_FLAG_ACTIVE) {
      return strip;
    }
 
    if (strip->type != NLASTRIP_TYPE_META) {
      continue;
    }
 
    NlaStrip *inner_active = nlastrip_find_active(&strip->strips);
    if (inner_active != nullptr) {
      return inner_active;
    }
  }
 
  return nullptr;
}
 
float BKE_nlastrip_compute_frame_from_previous_strip(NlaStrip *strip)
{
  float limit_prev = MINAFRAMEF;
 
  /* Find the previous end frame, with a special case if the previous strip was a transition : */
  if (strip->prev) {
    if (strip->prev->type == NLASTRIP_TYPE_TRANSITION) {
      limit_prev = strip->prev->start + NLASTRIP_MIN_LEN_THRESH;
    }
    else {
      limit_prev = strip->prev->end;
    }
  }
 
  return limit_prev;
}
 
float BKE_nlastrip_compute_frame_to_next_strip(NlaStrip *strip)
{
  float limit_next = MAXFRAMEF;
 
  /* Find the next begin frame, with a special case if the next strip's a transition : */
  if (strip->next) {
    if (strip->next->type == NLASTRIP_TYPE_TRANSITION) {
      limit_next = strip->next->end - NLASTRIP_MIN_LEN_THRESH;
    }
    else {
      limit_next = strip->next->start;
    }
  }
 
  return limit_next;
}
 
NlaStrip *BKE_nlastrip_next_in_track(NlaStrip *strip, bool skip_transitions)
{
  NlaStrip *next = strip->next;
  while (next != nullptr) {
    if (skip_transitions && (next->type == NLASTRIP_TYPE_TRANSITION)) {
      next = next->next;
    }
    else {
      return next;
    }
  }
  return nullptr;
}
 
NlaStrip *BKE_nlastrip_prev_in_track(NlaStrip *strip, bool skip_transitions)
{
  NlaStrip *prev = strip->prev;
  while (prev != nullptr) {
    if (skip_transitions && (prev->type == NLASTRIP_TYPE_TRANSITION)) {
      prev = prev->prev;
    }
    else {
      return prev;
    }
  }
  return nullptr;
}
 
NlaStrip *BKE_nlastrip_find_active(NlaTrack *nlt)
{
  if (nlt == nullptr) {
    return nullptr;
  }
 
  return nlastrip_find_active(&nlt->strips);
}
 
void BKE_nlastrip_remove(ListBase *strips, NlaStrip *strip)
{
  BLI_assert(strips);
  BLI_remlink(strips, strip);
}
 
void BKE_nlastrip_remove_and_free(ListBase *strips, NlaStrip *strip, const bool do_id_user)
{
  BKE_nlastrip_remove(strips, strip);
  BKE_nlastrip_free(strip, do_id_user);
}
 
void BKE_nlastrip_set_active(AnimData *adt, NlaStrip *strip)
{
  /* sanity checks */
  if (adt == nullptr) {
    return;
  }
 
  /* Loop over tracks, deactivating. */
  LISTBASE_FOREACH (NlaTrack *, nlt, &adt->nla_tracks) {
    LISTBASE_FOREACH (NlaStrip *, nls, &nlt->strips) {
      if (nls != strip) {
        nls->flag &= ~NLASTRIP_FLAG_ACTIVE;
      }
      else {
        nls->flag |= NLASTRIP_FLAG_ACTIVE;
      }
    }
  }
}
 
static NlaStrip *nlastrip_find_by_name(ListBase /*NlaStrip*/ *strips, const char *name)
{
  LISTBASE_FOREACH (NlaStrip *, strip, strips) {
    if (STREQ(strip->name, name)) {
      return strip;
    }
 
    if (strip->type != NLASTRIP_TYPE_META) {
      continue;
    }
 
    NlaStrip *inner_strip = nlastrip_find_by_name(&strip->strips, name);
    if (inner_strip != nullptr) {
      return inner_strip;
    }
  }
 
  return nullptr;
}
 
NlaStrip *BKE_nlastrip_find_by_name(NlaTrack *nlt, const char *name)
{
  return nlastrip_find_by_name(&nlt->strips, name);
}
 
bool BKE_nlastrip_within_bounds(NlaStrip *strip, float min, float max)
{
  const float stripLen = (strip) ? strip->end - strip->start : 0.0f;
  const float boundsLen = fabsf(max - min);
 
  /* sanity checks */
  if ((strip == nullptr) || IS_EQF(stripLen, 0.0f) || IS_EQF(boundsLen, 0.0f)) {
    return false;
  }
 
  /* only ok if at least part of the strip is within the bounding window
   * - first 2 cases cover when the strip length is less than the bounding area
   * - second 2 cases cover when the strip length is greater than the bounding area
   */
  if ((stripLen < boundsLen) &&
      !(IN_RANGE(strip->start, min, max) || IN_RANGE(strip->end, min, max)))
  {
    return false;
  }
  if ((stripLen > boundsLen) &&
      !(IN_RANGE(min, strip->start, strip->end) || IN_RANGE(max, strip->start, strip->end)))
  {
    return false;
  }
 
  /* should be ok! */
  return true;
}
 
float BKE_nlastrip_distance_to_frame(const NlaStrip *strip, const float timeline_frame)
{
  if (timeline_frame < strip->start) {
    return strip->start - timeline_frame;
  }
  if (strip->end < timeline_frame) {
    return timeline_frame - strip->end;
  }
  return 0.0f;
}
 
/* Ensure that strip doesn't overlap those around it after resizing
 * by offsetting those which follow. */
static void nlastrip_fix_resize_overlaps(NlaStrip *strip)
{
  /* next strips - do this first, since we're often just getting longer */
  if (strip->next) {
    NlaStrip *nls = strip->next;
    float offset = 0.0f;
 
    if (nls->type == NLASTRIP_TYPE_TRANSITION) {
      /* transition strips should grow/shrink to accommodate the resized strip,
       * but if the strip's bounds now exceed the transition, we're forced to
       * offset everything to maintain the balance
       */
      if (strip->end <= nls->start) {
        /* grow the transition to fill the void */
        nls->start = strip->end;
      }
      else if (strip->end < nls->end) {
        /* shrink the transition to give the strip room */
        nls->start = strip->end;
      }
      else {
        /* Shrink transition down to 1 frame long (so that it can still be found),
         * then offset everything else by the remaining deficit to give the strip room. */
        nls->start = nls->end - 1.0f;
 
        /* XXX: review whether preventing fractional values is good here... */
        offset = ceilf(strip->end - nls->start);
 
        /* apply necessary offset to ensure that the strip has enough space */
        for (; nls; nls = nls->next) {
          nls->start += offset;
          nls->end += offset;
        }
      }
    }
    else if (strip->end > nls->start) {
      /* NOTE: need to ensure we don't have a fractional frame offset, even if that leaves a gap,
       * otherwise it will be very hard to get rid of later
       */
      offset = ceilf(strip->end - nls->start);
 
      /* apply to times of all strips in this direction */
      for (; nls; nls = nls->next) {
        nls->start += offset;
        nls->end += offset;
      }
    }
  }
 
  /* previous strips - same routine as before */
  /* NOTE: when strip bounds are recalculated, this is not considered! */
  if (strip->prev) {
    NlaStrip *nls = strip->prev;
    float offset = 0.0f;
 
    if (nls->type == NLASTRIP_TYPE_TRANSITION) {
      /* transition strips should grow/shrink to accommodate the resized strip,
       * but if the strip's bounds now exceed the transition, we're forced to
       * offset everything to maintain the balance
       */
      if (strip->start >= nls->end) {
        /* grow the transition to fill the void */
        nls->end = strip->start;
      }
      else if (strip->start > nls->start) {
        /* shrink the transition to give the strip room */
        nls->end = strip->start;
      }
      else {
        /* Shrink transition down to 1 frame long (so that it can still be found),
         * then offset everything else by the remaining deficit to give the strip room. */
        nls->end = nls->start + 1.0f;
 
        /* XXX: review whether preventing fractional values is good here... */
        offset = ceilf(nls->end - strip->start);
 
        /* apply necessary offset to ensure that the strip has enough space */
        for (; nls; nls = nls->prev) {
          nls->start -= offset;
          nls->end -= offset;
        }
      }
    }
    else if (strip->start < nls->end) {
      /* NOTE: need to ensure we don't have a fractional frame offset, even if that leaves a gap,
       * otherwise it will be very hard to get rid of later
       */
      offset = ceilf(nls->end - strip->start);
 
      /* apply to times of all strips in this direction */
      for (; nls; nls = nls->prev) {
        nls->start -= offset;
        nls->end -= offset;
      }
    }
  }
}
 
void BKE_nlastrip_recalculate_bounds_sync_action(NlaStrip *strip)
{
  float prev_actstart;
 
  if (strip == nullptr || strip->type != NLASTRIP_TYPE_CLIP) {
    return;
  }
 
  prev_actstart = strip->actstart;
 
  const float2 frame_range = strip->act->wrap().get_frame_range_of_slot(strip->action_slot_handle);
  strip->actstart = frame_range[0];
  strip->actend = frame_range[1];
 
  BKE_nla_clip_length_ensure_nonzero(&strip->actstart, &strip->actend);
 
  /* Set start such that key's do not visually move, to preserve the overall animation result. */
  strip->start += (strip->actstart - prev_actstart) * strip->scale;
 
  BKE_nlastrip_recalculate_bounds(strip);
}
void BKE_nlastrip_recalculate_bounds(NlaStrip *strip)
{
  float mapping;
 
  /* sanity checks
   * - must have a strip
   * - can only be done for action clips
   */
  if ((strip == nullptr) || (strip->type != NLASTRIP_TYPE_CLIP)) {
    return;
  }
 
  /* calculate new length factors */
  const float actlen = BKE_nla_clip_length_get_nonzero(strip);
 
  mapping = strip->scale * strip->repeat;
 
  /* adjust endpoint of strip in response to this */
  if (IS_EQF(mapping, 0.0f) == 0) {
    strip->end = (actlen * mapping) + strip->start;
  }
 
  /* make sure we don't overlap our neighbors */
  nlastrip_fix_resize_overlaps(strip);
}
 
void BKE_nlastrip_recalculate_blend(NlaStrip *strip)
{
 
  /* check if values need to be re-calculated. */
  if (strip->blendin == 0 && strip->blendout == 0) {
    return;
  }
 
  const double strip_len = strip->end - strip->start;
  double blend_in = strip->blendin;
  double blend_out = strip->blendout;
 
  double blend_in_max = strip_len - blend_out;
 
  CLAMP_MIN(blend_in_max, 0);
 
  /* blend-out is limited to the length of the strip. */
  CLAMP(blend_in, 0, blend_in_max);
  CLAMP(blend_out, 0, strip_len - blend_in);
 
  strip->blendin = blend_in;
  strip->blendout = blend_out;
}
 
/* Animated Strips ------------------------------------------- */
 
bool BKE_nlatrack_has_animated_strips(NlaTrack *nlt)
{
  /* sanity checks */
  if (ELEM(nullptr, nlt, nlt->strips.first)) {
    return false;
  }
 
  /* check each strip for F-Curves only (don't care about whether the flags are set) */
  LISTBASE_FOREACH (NlaStrip *, strip, &nlt->strips) {
    if (strip->fcurves.first) {
      return true;
    }
  }
 
  /* none found */
  return false;
}
 
bool BKE_nlatracks_have_animated_strips(ListBase *tracks)
{
  /* sanity checks */
  if (ELEM(nullptr, tracks, tracks->first)) {
    return false;
  }
 
  /* check each track, stopping on the first hit */
  LISTBASE_FOREACH (NlaTrack *, nlt, tracks) {
    if (BKE_nlatrack_has_animated_strips(nlt)) {
      return true;
    }
  }
 
  /* none found */
  return false;
}
 
void BKE_nlastrip_validate_fcurves(NlaStrip *strip)
{
  FCurve *fcu;
 
  /* sanity checks */
  if (strip == nullptr) {
    return;
  }
 
  /* if controlling influence... */
  if (strip->flag & NLASTRIP_FLAG_USR_INFLUENCE) {
    /* try to get F-Curve */
    fcu = BKE_fcurve_find(&strip->fcurves, "influence", 0);
 
    /* add one if not found */
    if (fcu == nullptr) {
      /* make new F-Curve */
      fcu = BKE_fcurve_create();
      BLI_addtail(&strip->fcurves, fcu);
 
      /* set default flags */
      fcu->flag = (FCURVE_VISIBLE | FCURVE_SELECTED);
      fcu->auto_smoothing = U.auto_smoothing_new;
 
      /* store path - make copy, and store that */
      fcu->rna_path = BLI_strdupn("influence", 9);
 
      /* insert keyframe to ensure current value stays on first refresh */
      fcu->bezt = static_cast<BezTriple *>(
          MEM_callocN(sizeof(BezTriple), "nlastrip influence bezt"));
      fcu->totvert = 1;
 
      fcu->bezt->vec[1][0] = strip->start;
      fcu->bezt->vec[1][1] = strip->influence;
 
      /* Respect User Preferences for default interpolation and handles. */
      fcu->bezt->h1 = fcu->bezt->h2 = U.keyhandles_new;
      fcu->bezt->ipo = U.ipo_new;
    }
  }
 
  /* if controlling time... */
  if (strip->flag & NLASTRIP_FLAG_USR_TIME) {
    /* try to get F-Curve */
    fcu = BKE_fcurve_find(&strip->fcurves, "strip_time", 0);
 
    /* add one if not found */
    if (fcu == nullptr) {
      /* make new F-Curve */
      fcu = BKE_fcurve_create();
      BLI_addtail(&strip->fcurves, fcu);
 
      /* set default flags */
      fcu->flag = (FCURVE_VISIBLE | FCURVE_SELECTED);
      fcu->auto_smoothing = U.auto_smoothing_new;
 
      /* store path - make copy, and store that */
      fcu->rna_path = BLI_strdupn("strip_time", 10);
 
      /* TODO: insert a few keyframes to ensure default behavior? */
    }
  }
}
 
bool BKE_nlastrip_has_curves_for_property(const PointerRNA *ptr, const PropertyRNA *prop)
{
  /* sanity checks */
  if (ELEM(nullptr, ptr, prop)) {
    return false;
  }
 
  /* 1) Must be NLA strip */
  if (ptr->type == &RNA_NlaStrip) {
    /* 2) Must be one of the predefined properties */
    static PropertyRNA *prop_influence = nullptr;
    static PropertyRNA *prop_time = nullptr;
    static bool needs_init = true;
 
    /* Init the properties on first use */
    if (needs_init) {
      prop_influence = RNA_struct_type_find_property(&RNA_NlaStrip, "influence");
      prop_time = RNA_struct_type_find_property(&RNA_NlaStrip, "strip_time");
 
      needs_init = false;
    }
 
    /* Check if match */
    if (ELEM(prop, prop_influence, prop_time)) {
      return true;
    }
  }
 
  /* No criteria met */
  return false;
}
 
/* Sanity Validation ------------------------------------ */
 
static bool nla_editbone_name_check(void *arg, const char *name)
{
  return BLI_ghash_haskey((GHash *)arg, (const void *)name);
}
 
void BKE_nlastrip_validate_name(AnimData *adt, NlaStrip *strip)
{
  GHash *gh;
 
  /* sanity checks */
  if (ELEM(nullptr, adt, strip)) {
    return;
  }
 
  /* give strip a default name if none already */
  if (strip->name[0] == 0) {
    switch (strip->type) {
      case NLASTRIP_TYPE_CLIP: /* act-clip */
        STRNCPY(strip->name, (strip->act) ? (strip->act->id.name + 2) : DATA_("<No Action>"));
        break;
      case NLASTRIP_TYPE_TRANSITION: /* transition */
        STRNCPY(strip->name, DATA_("Transition"));
        break;
      case NLASTRIP_TYPE_META: /* meta */
        STRNCPY(strip->name, DATA_("Meta"));
        break;
      default:
        STRNCPY(strip->name, DATA_("NLA Strip"));
        break;
    }
  }
 
  /* build a hash-table of all the strips in the tracks
   * - this is easier than iterating over all the tracks+strips hierarchy every time
   *   (and probably faster)
   */
  gh = BLI_ghash_str_new("nlastrip_validate_name gh");
 
  LISTBASE_FOREACH (NlaTrack *, nlt, &adt->nla_tracks) {
    LISTBASE_FOREACH (NlaStrip *, tstrip, &nlt->strips) {
      /* don't add the strip of interest */
      if (tstrip == strip) {
        continue;
      }
 
      /* Use the name of the strip as the key, and the strip as the value,
       * since we're mostly interested in the keys. */
      BLI_ghash_insert(gh, tstrip->name, tstrip);
    }
  }
 
  /* If the hash-table has a match for this name, try other names...
   * - In an extreme case, it might not be able to find a name,
   *   but then everything else in Blender would fail too :).
   */
  BLI_uniquename_cb(nla_editbone_name_check,
                    (void *)gh,
                    DATA_("NlaStrip"),
                    '.',
                    strip->name,
                    sizeof(strip->name));
 
  /* free the hash... */
  BLI_ghash_free(gh, nullptr, nullptr);
}
 
/* ---- */
 
/* Get strips which overlap the given one at the start/end of its range
 * - strip: strip that we're finding overlaps for
 * - track: nla-track that the overlapping strips should be found from
 * - start, end: frames for the offending endpoints
 */
static void nlastrip_get_endpoint_overlaps(NlaStrip *strip,
                                           NlaTrack *track,
                                           float **start,
                                           float **end)
{
  /* find strips that overlap over the start/end of the given strip,
   * but which don't cover the entire length
   */
  /* TODO: this scheme could get quite slow for doing this on many strips... */
  LISTBASE_FOREACH (NlaStrip *, nls, &track->strips) {
    /* Check if strip overlaps (extends over or exactly on)
     * the entire range of the strip we're validating. */
    if ((nls->start <= strip->start) && (nls->end >= strip->end)) {
      *start = nullptr;
      *end = nullptr;
      return;
    }
 
    /* check if strip doesn't even occur anywhere near... */
    if (nls->end < strip->start) {
      continue; /* skip checking this strip... not worthy of mention */
    }
    if (nls->start > strip->end) {
      return; /* the range we're after has already passed */
    }
 
    /* if this strip is not part of an island of continuous strips, it can be used
     * - this check needs to be done for each end of the strip we try and use...
     */
    if ((nls->next == nullptr) || IS_EQF(nls->next->start, nls->end) == 0) {
      if ((nls->end > strip->start) && (nls->end < strip->end)) {
        *start = &nls->end;
      }
    }
    if ((nls->prev == nullptr) || IS_EQF(nls->prev->end, nls->start) == 0) {
      if ((nls->start < strip->end) && (nls->start > strip->start)) {
        *end = &nls->start;
      }
    }
  }
}
 
/* Determine auto-blending for the given strip */
static void BKE_nlastrip_validate_autoblends(NlaTrack *nlt, NlaStrip *nls)
{
  float *ps = nullptr, *pe = nullptr;
  float *ns = nullptr, *ne = nullptr;
 
  /* sanity checks */
  if (ELEM(nullptr, nls, nlt)) {
    return;
  }
  if ((nlt->prev == nullptr) && (nlt->next == nullptr)) {
    return;
  }
  if ((nls->flag & NLASTRIP_FLAG_AUTO_BLENDS) == 0) {
    return;
  }
 
  /* get test ranges */
  if (nlt->prev) {
    nlastrip_get_endpoint_overlaps(nls, nlt->prev, &ps, &pe);
  }
  if (nlt->next) {
    nlastrip_get_endpoint_overlaps(nls, nlt->next, &ns, &ne);
  }
 
  /* set overlaps for this strip
   * - don't use the values obtained though if the end in question
   *   is directly followed/preceded by another strip, forming an
   *   'island' of continuous strips
   */
  if ((ps || ns) && ((nls->prev == nullptr) || IS_EQF(nls->prev->end, nls->start) == 0)) {
    /* start overlaps - pick the largest overlap */
    if (((ps && ns) && (*ps > *ns)) || (ps)) {
      nls->blendin = *ps - nls->start;
    }
    else {
      nls->blendin = *ns - nls->start;
    }
  }
  else { /* no overlap allowed/needed */
    nls->blendin = 0.0f;
  }
 
  if ((pe || ne) && ((nls->next == nullptr) || IS_EQF(nls->next->start, nls->end) == 0)) {
    /* end overlaps - pick the largest overlap */
    if (((pe && ne) && (*pe > *ne)) || (pe)) {
      nls->blendout = nls->end - *pe;
    }
    else {
      nls->blendout = nls->end - *ne;
    }
  }
  else { /* no overlap allowed/needed */
    nls->blendout = 0.0f;
  }
}
 
static bool nlastrip_validate_transition_start_end(ListBase *strips, NlaStrip *strip)
{
 
  if (!(strip->type == NLASTRIP_TYPE_TRANSITION)) {
    return true;
  }
  if (strip->prev) {
    strip->start = strip->prev->end;
  }
  if (strip->next) {
    strip->end = strip->next->start;
  }
  if (strip->start >= strip->end || strip->prev == nullptr || strip->next == nullptr) {
    BKE_nlastrip_remove_and_free(strips, strip, true);
    return false;
  }
  return true;
}
 
void BKE_nla_validate_state(AnimData *adt)
{
  /* sanity checks */
  if (ELEM(nullptr, adt, adt->nla_tracks.first)) {
    return;
  }
 
  /* Adjust blending values for auto-blending,
   * and also do an initial pass to find the earliest strip. */
  LISTBASE_FOREACH (NlaTrack *, nlt, &adt->nla_tracks) {
    LISTBASE_FOREACH_MUTABLE (NlaStrip *, strip, &nlt->strips) {
 
      if (!nlastrip_validate_transition_start_end(&nlt->strips, strip)) {
        printf(
            "While moving NLA strips, a transition strip could no longer be applied to the new "
            "positions and was removed.\n");
        continue;
      }
 
      /* auto-blending first */
      BKE_nlastrip_validate_autoblends(nlt, strip);
      BKE_nlastrip_recalculate_blend(strip);
    }
  }
}
 
/* Action Stashing -------------------------------------- */
 
/* name of stashed tracks - the translation stuff is included here to save extra work */
#define STASH_TRACK_NAME DATA_("[Action Stash]")
 
bool BKE_nla_action_is_stashed(AnimData *adt, bAction *act)
{
  LISTBASE_FOREACH (NlaTrack *, nlt, &adt->nla_tracks) {
    if (strstr(nlt->name, STASH_TRACK_NAME)) {
      LISTBASE_FOREACH (NlaStrip *, strip, &nlt->strips) {
        if (strip->act == act) {
          return true;
        }
      }
    }
  }
 
  return false;
}
 
bool BKE_nla_action_stash(const OwnedAnimData owned_adt, const bool is_liboverride)
{
  NlaTrack *prev_track = nullptr;
  NlaTrack *nlt;
  NlaStrip *strip;
  AnimData *adt = &owned_adt.adt;
 
  /* sanity check */
  if (ELEM(nullptr, adt, adt->action)) {
    CLOG_ERROR(&LOG, "Invalid argument - %p %p", adt, adt->action);
    return false;
  }
 
  /* do not add if it is already stashed */
  if (BKE_nla_action_is_stashed(adt, adt->action)) {
    return false;
  }
 
  /* create a new track, and add this immediately above the previous stashing track */
  for (prev_track = static_cast<NlaTrack *>(adt->nla_tracks.last); prev_track;
       prev_track = prev_track->prev)
  {
    if (strstr(prev_track->name, STASH_TRACK_NAME)) {
      break;
    }
  }
 
  nlt = BKE_nlatrack_new_after(&adt->nla_tracks, prev_track, is_liboverride);
  BKE_nlatrack_set_active(&adt->nla_tracks, nlt);
  BLI_assert(nlt != nullptr);
 
  /* We need to ensure that if there wasn't any previous instance,
   * it must go to be bottom of the stack. */
  if (prev_track == nullptr) {
    BLI_remlink(&adt->nla_tracks, nlt);
    BLI_addhead(&adt->nla_tracks, nlt);
  }
 
  STRNCPY(nlt->name, STASH_TRACK_NAME);
  BLI_uniquename(
      &adt->nla_tracks, nlt, STASH_TRACK_NAME, '.', offsetof(NlaTrack, name), sizeof(nlt->name));
 
  /* add the action as a strip in this new track
   * NOTE: a new user is created here
   */
  strip = BKE_nlastrip_new(adt->action, owned_adt.owner_id);
  BLI_assert(strip != nullptr);
 
  animrig::nla::assign_action_slot_handle(*strip, adt->slot_handle, owned_adt.owner_id);
 
  BKE_nlatrack_add_strip(nlt, strip, is_liboverride);
  BKE_nlastrip_validate_name(adt, strip);
 
  /* mark the stash track and strip so that they doesn't disturb the stack animation,
   * and are unlikely to draw attention to itself (or be accidentally bumped around)
   *
   * NOTE: this must be done *after* adding the strip to the track, or else
   *       the strip locking will prevent the strip from getting added
   */
  nlt->flag |= (NLATRACK_MUTED | NLATRACK_PROTECTED);
  strip->flag &= ~(NLASTRIP_FLAG_SELECT | NLASTRIP_FLAG_ACTIVE);
 
  /* also mark the strip for auto syncing the length, so that the strips accurately
   * reflect the length of the action
   * XXX: we could do with some extra flags here to prevent repeats/scaling options from working!
   */
  strip->flag |= NLASTRIP_FLAG_SYNC_LENGTH;
 
  /* succeeded */
  return true;
}
 
/* Core Tools ------------------------------------------- */
 
void BKE_nla_action_pushdown(const OwnedAnimData owned_adt, const bool is_liboverride)
{
  NlaStrip *strip;
  AnimData *adt = &owned_adt.adt;
 
  /* sanity checks */
  /* TODO: need to report the error for this */
  if (ELEM(nullptr, adt, adt->action)) {
    return;
  }
 
  /* if the action is empty, we also shouldn't try to add to stack,
   * as that will cause us grief down the track
   */
  /* TODO: what about modifiers? */
  animrig::Action &action = adt->action->wrap();
  if (!action.has_keyframes(adt->slot_handle)) {
    CLOG_ERROR(&LOG, "action has no data");
    return;
  }
 
  /* Add a new NLA strip to the track, which references the active action + slot.*/
  strip = BKE_nlastack_add_strip(owned_adt, &action, is_liboverride);
  if (strip == nullptr) {
    return;
  }
  animrig::nla::assign_action_slot_handle(*strip, adt->slot_handle, owned_adt.owner_id);
 
  /* Clear reference to action now that we've pushed it onto the stack. */
  const bool unassign_ok = animrig::unassign_action(owned_adt.owner_id);
  BLI_assert_msg(unassign_ok,
                 "Expecting un-assigning an action to always work when pushing down an NLA strip");
  UNUSED_VARS_NDEBUG(unassign_ok);
 
  /* copy current "action blending" settings from adt to the strip,
   * as it was keyframed with these settings, so omitting them will
   * change the effect [#54233]. */
  strip->blendmode = adt->act_blendmode;
  strip->influence = adt->act_influence;
  strip->extendmode = adt->act_extendmode;
 
  if (adt->act_influence < 1.0f) {
    /* enable "user-controlled" influence (which will insert a default keyframe)
     * so that the influence doesn't get lost on the new update
     *
     * NOTE: An alternative way would have been to instead hack the influence
     * to not get always get reset to full strength if NLASTRIP_FLAG_USR_INFLUENCE
     * is disabled but auto-blending isn't being used. However, that approach
     * is a bit hacky/hard to discover, and may cause backwards compatibility issues,
     * so it's better to just do it this way.
     */
    strip->flag |= NLASTRIP_FLAG_USR_INFLUENCE;
    BKE_nlastrip_validate_fcurves(strip);
  }
 
  /* make strip the active one... */
  BKE_nlastrip_set_active(adt, strip);
}
 
static void nla_tweakmode_find_active(const ListBase /*NlaTrack*/ *nla_tracks,
                                      NlaTrack **r_track_of_active_strip,
                                      NlaStrip **r_active_strip)
{
  NlaTrack *activeTrack = nullptr;
  NlaStrip *activeStrip = nullptr;
 
  /* go over the tracks, finding the active one, and its active strip
   * - if we cannot find both, then there's nothing to do
   */
  LISTBASE_FOREACH (NlaTrack *, nlt, nla_tracks) {
    /* check if active */
    if (nlt->flag & NLATRACK_ACTIVE) {
      /* store reference to this active track */
      activeTrack = nlt;
 
      /* now try to find active strip */
      activeStrip = BKE_nlastrip_find_active(nlt);
      break;
    }
  }
 
  /* There are situations where we may have multiple strips selected and we want to enter
   * tweak-mode on all of those at once. Usually in those cases,
   * it will usually just be a single strip per AnimData.
   * In such cases, compromise and take the last selected track and/or last selected strip,
   * #28468.
   */
  if (activeTrack == nullptr) {
    /* try last selected track for active strip */
    LISTBASE_FOREACH_BACKWARD (NlaTrack *, nlt, nla_tracks) {
      if (nlt->flag & NLATRACK_SELECTED) {
        /* assume this is the active track */
        activeTrack = nlt;
 
        /* try to find active strip */
        activeStrip = BKE_nlastrip_find_active(nlt);
        break;
      }
    }
  }
  if ((activeTrack) && (activeStrip == nullptr)) {
    /* No active strip in active or last selected track;
     * compromise for first selected (assuming only single). */
    LISTBASE_FOREACH (NlaStrip *, strip, &activeTrack->strips) {
      if (strip->flag & (NLASTRIP_FLAG_SELECT | NLASTRIP_FLAG_ACTIVE)) {
        activeStrip = strip;
        break;
      }
    }
  }
 
  *r_track_of_active_strip = activeTrack;
  *r_active_strip = activeStrip;
}
 
bool BKE_nla_tweakmode_enter(const OwnedAnimData owned_adt)
{
  NlaTrack *activeTrack = nullptr;
  NlaStrip *activeStrip = nullptr;
  AnimData &adt = owned_adt.adt;
 
  /* verify that data is valid */
  if (ELEM(nullptr, adt.nla_tracks.first)) {
    return false;
  }
 
  /* If block is already in tweak-mode, just leave, but we should report
   * that this block is in tweak-mode (as our return-code). */
  if (adt.flag & ADT_NLA_EDIT_ON) {
    return true;
  }
 
  nla_tweakmode_find_active(&adt.nla_tracks, &activeTrack, &activeStrip);
 
  if (ELEM(nullptr, activeTrack, activeStrip, activeStrip->act)) {
    if (G.debug & G_DEBUG) {
      printf("NLA tweak-mode enter - neither active requirement found\n");
      printf("\tactiveTrack = %p, activeStrip = %p\n", (void *)activeTrack, (void *)activeStrip);
    }
    return false;
  }
 
  /* Go over all the tracks, tagging each strip that uses the same
   * action as the active strip, but leaving everything else alone.
   */
  LISTBASE_FOREACH (NlaTrack *, nlt, &adt.nla_tracks) {
    LISTBASE_FOREACH (NlaStrip *, strip, &nlt->strips) {
      if (strip->act == activeStrip->act) {
        strip->flag |= NLASTRIP_FLAG_TWEAKUSER;
      }
      else {
        strip->flag &= ~NLASTRIP_FLAG_TWEAKUSER;
      }
    }
  }
 
  /* Untag tweaked track. This leads to non tweaked actions being drawn differently than the
   * tweaked action. */
  activeStrip->flag &= ~NLASTRIP_FLAG_TWEAKUSER;
 
  /* go over all the tracks after AND INCLUDING the active one, tagging them as being disabled
   * - the active track needs to also be tagged, otherwise, it'll overlap with the tweaks going
   * on.
   */
  activeTrack->flag |= NLATRACK_DISABLED;
  if ((adt.flag & ADT_NLA_EVAL_UPPER_TRACKS) == 0) {
    for (NlaTrack *nlt = activeTrack->next; nlt; nlt = nlt->next) {
      nlt->flag |= NLATRACK_DISABLED;
    }
  }
 
  /* handle AnimData level changes:
   * - 'real' active action to temp storage (no need to change user-counts).
   * - Action of active strip set to be the 'active action', and have its user-count incremented.
   * - Editing-flag for this AnimData block should also get turned on
   *   (for more efficient restoring).
   * - Take note of the active strip for mapping-correction of keyframes
   *   in the action being edited.
   */
  adt.tmpact = adt.action;
  adt.tmp_slot_handle = adt.slot_handle;
  STRNCPY(adt.tmp_slot_name, adt.slot_name);
 
  /* Don't go through the regular animrig::unassign_action() call, as the old Action is still being
   * used by this ID. But do reset the action pointer, as Action::assign_id() doesn't like it when
   * another Action is already assigned. */
  adt.action = nullptr;
 
  if (activeStrip->act) {
    animrig::Action &strip_action = activeStrip->act->wrap();
    if (strip_action.is_action_layered()) {
      animrig::Slot *strip_slot = strip_action.slot_for_handle(activeStrip->action_slot_handle);
      if (animrig::assign_action_and_slot(&strip_action, strip_slot, owned_adt.owner_id) !=
          animrig::ActionSlotAssignmentResult::OK)
      {
        printf("NLA tweak-mode enter - could not assign slot %s\n",
               strip_slot ? strip_slot->name : "-unassigned-");
      }
    }
    else {
      adt.action = activeStrip->act;
      id_us_plus(&adt.action->id);
    }
  }
 
  adt.act_track = activeTrack;
  adt.actstrip = activeStrip;
  adt.flag |= ADT_NLA_EDIT_ON;
 
  /* done! */
  return true;
}
 
static bool is_nla_in_tweakmode(AnimData *adt)
{
  return adt && (adt->flag & ADT_NLA_EDIT_ON);
}
 
static void nla_tweakmode_exit_sync_strip_lengths(AnimData *adt)
{
  NlaStrip *active_strip = adt->actstrip;
  if (!active_strip || !active_strip->act) {
    return;
  }
 
  /* sync the length of the user-strip with the new state of the action
   * but only if the user has explicitly asked for this to happen
   * (see #34645 for things to be careful about)
   */
  if (active_strip->flag & NLASTRIP_FLAG_SYNC_LENGTH) {
    BKE_nlastrip_recalculate_bounds_sync_action(active_strip);
  }
 
  /* Sync strip extents of strips using the same Action as the tweaked strip. */
  LISTBASE_FOREACH (NlaTrack *, nlt, &adt->nla_tracks) {
    LISTBASE_FOREACH (NlaStrip *, strip, &nlt->strips) {
      if ((strip->flag & NLASTRIP_FLAG_SYNC_LENGTH) && active_strip->act == strip->act) {
        BKE_nlastrip_recalculate_bounds_sync_action(strip);
      }
    }
  }
}
 
static void nla_tweakmode_exit_nofollowptr(AnimData *adt)
{
  BKE_nla_tweakmode_clear_flags(adt);
 
  adt->action = adt->tmpact;
  adt->slot_handle = adt->tmp_slot_handle;
 
  adt->tmpact = nullptr;
  adt->tmp_slot_handle = animrig::Slot::unassigned;
  STRNCPY(adt->slot_name, adt->tmp_slot_name);
 
  adt->act_track = nullptr;
  adt->actstrip = nullptr;
}
 
void BKE_nla_tweakmode_exit_nofollowptr(AnimData *adt)
{
  if (!is_nla_in_tweakmode(adt)) {
    return;
  }
 
  nla_tweakmode_exit_nofollowptr(adt);
}
 
void BKE_nla_tweakmode_exit(const OwnedAnimData owned_adt)
{
  if (!is_nla_in_tweakmode(&owned_adt.adt)) {
    return;
  }
 
  if (owned_adt.adt.action) {
    /* The Action will be replaced with adt->tmpact, and thus needs to be unassigned first. */
 
    /* The high-level function animrig::unassign_action() will check whether NLA tweak mode is
     * enabled, and if so, refuse to work (and rightfully so). However, exiting tweak mode is not
     * just setting a flag (see BKE_animdata_action_editable(), it checks for the tmpact pointer as
     * well). Because of that, here we call the low-level generic assignment function, to
     * circumvent that check and unconditionally unassign the tweaked Action. */
    const bool unassign_ok = animrig::generic_assign_action(owned_adt.owner_id,
                                                            nullptr,
                                                            owned_adt.adt.action,
                                                            owned_adt.adt.slot_handle,
                                                            owned_adt.adt.slot_name);
    BLI_assert_msg(unassign_ok,
                   "When exiting tweak mode, unassigning the tweaked Action should work");
    UNUSED_VARS_NDEBUG(unassign_ok);
  }
 
  nla_tweakmode_exit_sync_strip_lengths(&owned_adt.adt);
  nla_tweakmode_exit_nofollowptr(&owned_adt.adt);
 
  /* nla_tweakmode_exit_nofollowptr() does not follow any pointers, and thus cannot update the slot
   * user map. So it has to be done here now. This is safe to do here, as slot->users_add()
   * gracefully handles duplicates. */
  if (owned_adt.adt.action && owned_adt.adt.slot_handle != animrig::Slot::unassigned) {
    animrig::Action &action = owned_adt.adt.action->wrap();
    BLI_assert_msg(action.is_action_layered(),
                   "when a slot is assigned, the action should layered");
    animrig::Slot *slot = action.slot_for_handle(owned_adt.adt.slot_handle);
    if (slot) {
      slot->users_add(owned_adt.owner_id);
    }
  }
}
 
void BKE_nla_tweakmode_clear_flags(AnimData *adt)
{
  LISTBASE_FOREACH (NlaTrack *, nlt, &adt->nla_tracks) {
    nlt->flag &= ~NLATRACK_DISABLED;
 
    LISTBASE_FOREACH (NlaStrip *, strip, &nlt->strips) {
      strip->flag &= ~NLASTRIP_FLAG_TWEAKUSER;
    }
  }
  adt->flag &= ~ADT_NLA_EDIT_ON;
}
 
void BKE_nla_debug_print_flags(AnimData *adt, ID *owner_id)
{
  if (!adt) {
    adt = BKE_animdata_from_id(owner_id);
  }
  printf("\033[38;5;214mNLA state");
  if (owner_id) {
    printf(" for %s", owner_id->name);
  }
  printf("\033[0m\n");
 
  if (!adt) {
    printf("  - ADT is nil!\n");
    return;
  }
 
  printf("  - ADT flags:");
  if (adt->flag & ADT_NLA_SOLO_TRACK)
    printf(" SOLO_TRACK");
  if (adt->flag & ADT_NLA_EVAL_OFF)
    printf(" EVAL_OFF");
  if (adt->flag & ADT_NLA_EDIT_ON)
    printf(" EDIT_ON");
  if (adt->flag & ADT_NLA_EDIT_NOMAP)
    printf(" EDIT_NOMAP");
  if (adt->flag & ADT_NLA_SKEYS_COLLAPSED)
    printf(" SKEYS_COLLAPSED");
  if (adt->flag & ADT_NLA_EVAL_UPPER_TRACKS)
    printf(" EVAL_UPPER_TRACKS");
  if ((adt->flag & (ADT_NLA_SOLO_TRACK | ADT_NLA_EVAL_OFF | ADT_NLA_EDIT_ON | ADT_NLA_EDIT_NOMAP |
                    ADT_NLA_SKEYS_COLLAPSED | ADT_NLA_EVAL_UPPER_TRACKS)) == 0)
    printf(" -");
  printf("\n");
 
  if (BLI_listbase_is_empty(&adt->nla_tracks)) {
    printf("  - No tracks\n");
    return;
  }
  printf("  - Active track: %s (#%d)\n",
         adt->act_track ? adt->act_track->name : "-nil-",
         adt->act_track ? adt->act_track->index : 0);
  printf("  - Active strip: %s\n", adt->actstrip ? adt->actstrip->name : "-nil-");
 
  LISTBASE_FOREACH (NlaTrack *, nlt, &adt->nla_tracks) {
    printf("  - Track #%d %s: ", nlt->index, nlt->name);
    if (nlt->flag & NLATRACK_ACTIVE)
      printf("ACTIVE ");
    if (nlt->flag & NLATRACK_SELECTED)
      printf("SELECTED ");
    if (nlt->flag & NLATRACK_MUTED)
      printf("MUTED ");
    if (nlt->flag & NLATRACK_SOLO)
      printf("SOLO ");
    if (nlt->flag & NLATRACK_PROTECTED)
      printf("PROTECTED ");
    if (nlt->flag & NLATRACK_DISABLED)
      printf("DISABLED ");
    if (nlt->flag & NLATRACK_TEMPORARILY_ADDED)
      printf("TEMPORARILY_ADDED ");
    if (nlt->flag & NLATRACK_OVERRIDELIBRARY_LOCAL)
      printf("OVERRIDELIBRARY_LOCAL ");
    printf("\n");
 
    LISTBASE_FOREACH (NlaStrip *, strip, &nlt->strips) {
      printf("    - Strip %s: ", strip->name);
      if (strip->flag & NLASTRIP_FLAG_ACTIVE)
        printf("ACTIVE ");
      if (strip->flag & NLASTRIP_FLAG_SELECT)
        printf("SELECT ");
      if (strip->flag & NLASTRIP_FLAG_TWEAKUSER)
        printf("TWEAKUSER ");
      if (strip->flag & NLASTRIP_FLAG_USR_INFLUENCE)
        printf("USR_INFLUENCE ");
      if (strip->flag & NLASTRIP_FLAG_USR_TIME)
        printf("USR_TIME ");
      if (strip->flag & NLASTRIP_FLAG_USR_TIME_CYCLIC)
        printf("USR_TIME_CYCLIC ");
      if (strip->flag & NLASTRIP_FLAG_SYNC_LENGTH)
        printf("SYNC_LENGTH ");
      if (strip->flag & NLASTRIP_FLAG_AUTO_BLENDS)
        printf("AUTO_BLENDS ");
      if (strip->flag & NLASTRIP_FLAG_REVERSE)
        printf("REVERSE ");
      if (strip->flag & NLASTRIP_FLAG_MUTED)
        printf("MUTED ");
      if (strip->flag & NLASTRIP_FLAG_INVALID_LOCATION)
        printf("INVALID_LOCATION ");
      if (strip->flag & NLASTRIP_FLAG_NO_TIME_MAP)
        printf("NO_TIME_MAP ");
      if (strip->flag & NLASTRIP_FLAG_TEMP_META)
        printf("TEMP_META ");
      if (strip->flag & NLASTRIP_FLAG_EDIT_TOUCHED)
        printf("EDIT_TOUCHED ");
      printf("\n");
    }
  }
}
 
static void blend_write_nla_strips(BlendWriter *writer, ListBase *strips)
{
  BLO_write_struct_list(writer, NlaStrip, strips);
  LISTBASE_FOREACH (NlaStrip *, strip, strips) {
    /* write the strip's F-Curves and modifiers */
    BKE_fcurve_blend_write_listbase(writer, &strip->fcurves);
    BKE_fmodifiers_blend_write(writer, &strip->modifiers);
 
    /* write the strip's children */
    blend_write_nla_strips(writer, &strip->strips);
  }
}
 
static void blend_data_read_nla_strips(BlendDataReader *reader, ListBase *strips)
{
  LISTBASE_FOREACH (NlaStrip *, strip, strips) {
    /* strip's child strips */
    BLO_read_struct_list(reader, NlaStrip, &strip->strips);
    blend_data_read_nla_strips(reader, &strip->strips);
 
    /* strip's F-Curves */
    BLO_read_struct_list(reader, FCurve, &strip->fcurves);
    BKE_fcurve_blend_read_data_listbase(reader, &strip->fcurves);
 
    /* strip's F-Modifiers */
    BLO_read_struct_list(reader, FModifier, &strip->modifiers);
    BKE_fmodifiers_blend_read_data(reader, &strip->modifiers, nullptr);
  }
}
 
void BKE_nla_blend_write(BlendWriter *writer, ListBase *tracks)
{
  /* write all the tracks */
  LISTBASE_FOREACH (NlaTrack *, nlt, tracks) {
    /* write the track first */
    BLO_write_struct(writer, NlaTrack, nlt);
 
    /* write the track's strips */
    blend_write_nla_strips(writer, &nlt->strips);
  }
}
 
void BKE_nla_blend_read_data(BlendDataReader *reader, ID *id_owner, ListBase *tracks)
{
  LISTBASE_FOREACH (NlaTrack *, nlt, tracks) {
    /* If linking from a library, clear 'local' library override flag. */
    if (ID_IS_LINKED(id_owner)) {
      nlt->flag &= ~NLATRACK_OVERRIDELIBRARY_LOCAL;
    }
 
    /* relink list of strips */
    BLO_read_struct_list(reader, NlaStrip, &nlt->strips);
 
    /* relink strip data */
    blend_data_read_nla_strips(reader, &nlt->strips);
  }
}
 
void BKE_nla_liboverride_post_process(ID *id, AnimData *adt)
{
  /* TODO(Sybren): replace these two parameters with an OwnedAnimData struct. */
  BLI_assert(id);
  BLI_assert(adt);
 
  /* The 'id' parameter is unused as it's not necessary here, but still can be useful when
   * debugging. And with the NLA complexity the way it is, debugging comfort is kinda nice. */
  UNUSED_VARS_NDEBUG(id);
 
  const bool is_tweak_mode = (adt->flag & ADT_NLA_EDIT_ON);
  const bool has_tracks = !BLI_listbase_is_empty(&adt->nla_tracks);
 
  if (!has_tracks) {
    if (is_tweak_mode) {
      /* No tracks, so it's impossible to actually be in tweak mode. */
      BKE_nla_tweakmode_exit({*id, *adt});
    }
    return;
  }
 
  if (!is_tweak_mode) {
    /* Library-linked data should already have been cleared of NLA Tweak Mode flags, and the
     * overrides also didn't set tweak mode enabled. Assuming here that the override-added
     * tracks/strips are consistent with the override's tweak mode flag. */
    return;
  }
 
  /* In tweak mode, with tracks, so ensure that the active track/strip pointers are correct. Since
   * these pointers may come from a library, but the override may have added other tracks and
   * strips (one of which is in tweak mode), always look up the current pointer values.  */
  nla_tweakmode_find_active(&adt->nla_tracks, &adt->act_track, &adt->actstrip);
  if (!adt->act_track || !adt->actstrip) {
    /* Could not find the active track/strip, so better to exit tweak mode. */
    BKE_nla_tweakmode_exit({*id, *adt});
  }
}
 
static bool visit_strip(NlaStrip *strip, blender::FunctionRef<bool(NlaStrip *)> callback)
{
  if (!callback(strip)) {
    return false;
  }
 
  /* Recurse into sub-strips. */
  LISTBASE_FOREACH (NlaStrip *, sub_strip, &strip->strips) {
    if (!visit_strip(sub_strip, callback)) {
      return false;
    }
  }
  return true;
}
 
namespace blender::bke::nla {
 
bool foreach_strip(ID *id, blender::FunctionRef<bool(NlaStrip *)> callback)
{
  const AnimData *adt = BKE_animdata_from_id(id);
  if (!adt) {
    /* Having no NLA trivially means that we've looped through all the strips. */
    return true;
  }
  return foreach_strip_adt(*adt, callback);
}
 
bool foreach_strip_adt(const AnimData &adt, blender::FunctionRef<bool(NlaStrip *)> callback)
{
  LISTBASE_FOREACH (NlaTrack *, nlt, &adt.nla_tracks) {
    LISTBASE_FOREACH (NlaStrip *, strip, &nlt->strips) {
      if (!visit_strip(strip, callback)) {
        return false;
      }
    }
  }
  return true;
}
 
}  // namespace blender::bke::nla