LibOverride: Add initial support for adding new NLA tracks.

Also makes NLA tracks and strips overridable.

User can either edit existing strips in existing NLA tracks (but not add or remove them), and/or add new NLA tracks after those comming from the linked data.

Most of the work was as usual checking operators and adding protections against illegal operations in override context.

Note that since we can only rely on indices to deal with local added tracks, we forbid any local track being before any linked/original track.

Maniphest Tasks: T72629

Differential Revision: https://developer.blender.org/D9611

2 files changed, 92 insertions, 24 deletions

diff --git a/source/blender/editors/space_nla/nla_channels.c b/source/blender/editors/space_nla/nla_channels.c
index 561de5e82a6..9832ca975cf 100644
--- a/source/blender/editors/space_nla/nla_channels.c
+++ b/source/blender/editors/space_nla/nla_channels.c
@@ -292,7 +292,7 @@ static int mouse_nla_channels(
           /* TODO: make this use the operator instead of calling the function directly
            * however, calling the operator requires that we supply the args,
            * and that works with proper buttons only */
-          BKE_nla_action_pushdown(adt);
+          BKE_nla_action_pushdown(adt, ID_IS_OVERRIDE_LIBRARY(ale->id));
         }
         else {
           /* when in tweakmode, this button becomes the toggle for mapped editing */
@@ -516,7 +516,7 @@ static int nlachannels_pushdown_exec(bContext *C, wmOperator *op)
   }
 
   /* 'push-down' action - only usable when not in TweakMode */
-  BKE_nla_action_pushdown(adt);
+  BKE_nla_action_pushdown(adt, ID_IS_OVERRIDE_LIBRARY(id));
 
   struct Main *bmain = CTX_data_main(C);
   DEG_id_tag_update_ex(bmain, id, ID_RECALC_ANIMATION);
@@ -648,19 +648,21 @@ bool nlaedit_add_tracks_existing(bAnimContext *ac, bool above_sel)
       NlaTrack *nlt = (NlaTrack *)ale->data;
       AnimData *adt = ale->adt;
 
+      const bool is_liboverride = ID_IS_OVERRIDE_LIBRARY(ale->id);
+
       /* check if just adding a new track above this one,
        * or whether we're adding a new one to the top of the stack that this one belongs to
        */
       if (above_sel) {
         /* just add a new one above this one */
-        BKE_nlatrack_add(adt, nlt);
+        BKE_nlatrack_add(adt, nlt, is_liboverride);
         ale->update = ANIM_UPDATE_DEPS;
         added = true;
       }
       else if ((lastAdt == NULL) || (adt != lastAdt)) {
         /* add one track to the top of the owning AnimData's stack,
          * then don't add anymore to this stack */
-        BKE_nlatrack_add(adt, NULL);
+        BKE_nlatrack_add(adt, NULL, is_liboverride);
         lastAdt = adt;
         ale->update = ANIM_UPDATE_DEPS;
         added = true;
@@ -698,7 +700,7 @@ bool nlaedit_add_tracks_empty(bAnimContext *ac)
     /* ensure it is empty */
     if (BLI_listbase_is_empty(&adt->nla_tracks)) {
       /* add new track to this AnimData block then */
-      BKE_nlatrack_add(adt, NULL);
+      BKE_nlatrack_add(adt, NULL, ID_IS_OVERRIDE_LIBRARY(ale->id));
       ale->update = ANIM_UPDATE_DEPS;
       added = true;
     }
@@ -796,6 +798,11 @@ static int nlaedit_delete_tracks_exec(bContext *C, wmOperator *UNUSED(op))
       NlaTrack *nlt = (NlaTrack *)ale->data;
       AnimData *adt = ale->adt;
 
+      if (BKE_nlatrack_is_nonlocal_in_liboverride(ale->id, nlt)) {
+        /* No deletion of non-local tracks of override data. */
+        continue;
+      }
+
       /* if track is currently 'solo', then AnimData should have its
        * 'has solo' flag disabled
        */
diff --git a/source/blender/editors/space_nla/nla_edit.c b/source/blender/editors/space_nla/nla_edit.c
index ed8e5ad76e9..3fa1b614a03 100644
--- a/source/blender/editors/space_nla/nla_edit.c
+++ b/source/blender/editors/space_nla/nla_edit.c
@@ -649,6 +649,7 @@ static int nlaedit_add_actionclip_exec(bContext *C, wmOperator *op)
     NlaTrack *nlt = (NlaTrack *)ale->data;
     AnimData *adt = ale->adt;
     NlaStrip *strip = NULL;
+    const bool is_liboverride = ID_IS_OVERRIDE_LIBRARY(ale->id);
 
     /* Sanity check: only apply actions of the right type for this ID.
      * NOTE: in the case that this hasn't been set,
@@ -671,12 +672,12 @@ static int nlaedit_add_actionclip_exec(bContext *C, wmOperator *op)
     strip->start = cfra;
 
     /* firstly try adding strip to our current track, but if that fails, add to a new track */
-    if (BKE_nlatrack_add_strip(nlt, strip) == 0) {
+    if (BKE_nlatrack_add_strip(nlt, strip, is_liboverride) == 0) {
       /* trying to add to the current failed (no space),
        * so add a new track to the stack, and add to that...
        */
-      nlt = BKE_nlatrack_add(adt, NULL);
-      BKE_nlatrack_add_strip(nlt, strip);
+      nlt = BKE_nlatrack_add(adt, NULL, is_liboverride);
+      BKE_nlatrack_add_strip(nlt, strip, is_liboverride);
     }
 
     /* auto-name it */
@@ -886,6 +887,7 @@ static int nlaedit_add_sound_exec(bContext *C, wmOperator *UNUSED(op))
     AnimData *adt = ale->adt;
     NlaTrack *nlt = (NlaTrack *)ale->data;
     NlaStrip *strip;
+    const bool is_liboverride = ID_IS_OVERRIDE_LIBRARY(ale->id);
 
     /* does this belong to speaker - assumed to live on Object level only */
     if ((GS(ale->id->name) != ID_OB) || (ob->type != OB_SPEAKER)) {
@@ -899,12 +901,12 @@ static int nlaedit_add_sound_exec(bContext *C, wmOperator *UNUSED(op))
     strip->end += cfra;
 
     /* firstly try adding strip to our current track, but if that fails, add to a new track */
-    if (BKE_nlatrack_add_strip(nlt, strip) == 0) {
+    if (BKE_nlatrack_add_strip(nlt, strip, is_liboverride) == 0) {
       /* trying to add to the current failed (no space),
        * so add a new track to the stack, and add to that...
        */
-      nlt = BKE_nlatrack_add(adt, NULL);
-      BKE_nlatrack_add_strip(nlt, strip);
+      nlt = BKE_nlatrack_add(adt, NULL, is_liboverride);
+      BKE_nlatrack_add_strip(nlt, strip, is_liboverride);
     }
 
     /* auto-name it */
@@ -966,6 +968,11 @@ static int nlaedit_add_meta_exec(bContext *C, wmOperator *UNUSED(op))
     AnimData *adt = ale->adt;
     NlaStrip *strip;
 
+    if (BKE_nlatrack_is_nonlocal_in_liboverride(ale->id, nlt)) {
+      /* No making metastrips in non-local tracks of override data. */
+      continue;
+    }
+
     /* create meta-strips from the continuous chains of selected strips */
     BKE_nlastrips_make_metas(&nlt->strips, 0);
 
@@ -1030,6 +1037,11 @@ static int nlaedit_remove_meta_exec(bContext *C, wmOperator *UNUSED(op))
   for (ale = anim_data.first; ale; ale = ale->next) {
     NlaTrack *nlt = (NlaTrack *)ale->data;
 
+    if (BKE_nlatrack_is_nonlocal_in_liboverride(ale->id, nlt)) {
+      /* No removing metastrips from non-local tracks of override data. */
+      continue;
+    }
+
     /* clear all selected meta-strips, regardless of whether they are temporary or not */
     BKE_nlastrips_clear_metas(&nlt->strips, 1, 0);
 
@@ -1096,6 +1108,11 @@ static int nlaedit_duplicate_exec(bContext *C, wmOperator *op)
     NlaStrip *strip, *nstrip, *next;
     NlaTrack *track;
 
+    /* Note: We allow this operator in override context because it is almost always (from possible
+     * default user interactions) paired with the transform one, which will ensure that the new
+     * strip ends up in a valid (local) track. */
+
+    const bool is_liboverride = ID_IS_OVERRIDE_LIBRARY(ale->id);
     for (strip = nlt->strips.first; strip; strip = next) {
       next = strip->next;
 
@@ -1106,13 +1123,13 @@ static int nlaedit_duplicate_exec(bContext *C, wmOperator *op)
 
         /* in case there's no space in the track above,
          * or we haven't got a reference to it yet, try adding */
-        if (BKE_nlatrack_add_strip(nlt->next, nstrip) == 0) {
+        if (BKE_nlatrack_add_strip(nlt->next, nstrip, is_liboverride) == 0) {
           /* need to add a new track above the one above the current one
            * - if the current one is the last one, nlt->next will be NULL, which defaults to adding
            *   at the top of the stack anyway...
            */
-          track = BKE_nlatrack_add(adt, nlt->next);
-          BKE_nlatrack_add_strip(track, nstrip);
+          track = BKE_nlatrack_add(adt, nlt->next, is_liboverride);
+          BKE_nlatrack_add_strip(track, nstrip, is_liboverride);
         }
 
         /* deselect the original and the active flag */
@@ -1209,6 +1226,11 @@ static int nlaedit_delete_exec(bContext *C, wmOperator *UNUSED(op))
     NlaTrack *nlt = (NlaTrack *)ale->data;
     NlaStrip *strip, *nstrip;
 
+    if (BKE_nlatrack_is_nonlocal_in_liboverride(ale->id, nlt)) {
+      /* No deletion of strips in non-local tracks of override data. */
+      continue;
+    }
+
     for (strip = nlt->strips.first; strip; strip = nstrip) {
       nstrip = strip->next;
 
@@ -1359,6 +1381,11 @@ static int nlaedit_split_exec(bContext *C, wmOperator *UNUSED(op))
     AnimData *adt = ale->adt;
     NlaStrip *strip, *next;
 
+    if (BKE_nlatrack_is_nonlocal_in_liboverride(ale->id, nlt)) {
+      /* No splitting of strips in non-local tracks of override data. */
+      continue;
+    }
+
     for (strip = nlt->strips.first; strip; strip = next) {
       next = strip->next;
 
@@ -1502,6 +1529,12 @@ static int nlaedit_swap_exec(bContext *C, wmOperator *op)
 
     NlaStrip *strip, *stripN = NULL;
     NlaStrip *area = NULL, *sb = NULL;
+    const bool is_liboverride = ID_IS_OVERRIDE_LIBRARY(ale->id);
+
+    if (BKE_nlatrack_is_nonlocal_in_liboverride(ale->id, nlt)) {
+      /* No re-ordering of strips whithin non-local tracks of override data. */
+      continue;
+    }
 
     /* make temporary metastrips so that entire islands of selections can be moved around */
     BKE_nlastrips_make_metas(&nlt->strips, 1);
@@ -1610,8 +1643,8 @@ static int nlaedit_swap_exec(bContext *C, wmOperator *op)
       }
 
       /* add strips back to track now */
-      BKE_nlatrack_add_strip(nlt, area);
-      BKE_nlatrack_add_strip(nlt, sb);
+      BKE_nlatrack_add_strip(nlt, area, is_liboverride);
+      BKE_nlatrack_add_strip(nlt, sb, is_liboverride);
     }
 
     /* clear (temp) metastrips */
@@ -1674,11 +1707,19 @@ static int nlaedit_move_up_exec(bContext *C, wmOperator *UNUSED(op))
     NlaTrack *nltn = nlt->next;
     NlaStrip *strip, *stripn;
 
+    const bool is_liboverride = ID_IS_OVERRIDE_LIBRARY(ale->id);
+
     /* if this track has no tracks after it, skip for now... */
     if (nltn == NULL) {
       continue;
     }
 
+    if (BKE_nlatrack_is_nonlocal_in_liboverride(ale->id, nlt) ||
+        BKE_nlatrack_is_nonlocal_in_liboverride(ale->id, nltn)) {
+      /* No moving of strips in non-local tracks of override data. */
+      continue;
+    }
+
     /* for every selected strip, try to move */
     for (strip = nlt->strips.first; strip; strip = stripn) {
       stripn = strip->next;
@@ -1689,7 +1730,7 @@ static int nlaedit_move_up_exec(bContext *C, wmOperator *UNUSED(op))
           /* remove from its current track, and add to the one above
            * (it 'should' work, so no need to worry) */
           BLI_remlink(&nlt->strips, strip);
-          BKE_nlatrack_add_strip(nltn, strip);
+          BKE_nlatrack_add_strip(nltn, strip, is_liboverride);
         }
       }
     }
@@ -1751,11 +1792,19 @@ static int nlaedit_move_down_exec(bContext *C, wmOperator *UNUSED(op))
     NlaTrack *nltp = nlt->prev;
     NlaStrip *strip, *stripn;
 
+    const bool is_liboverride = ID_IS_OVERRIDE_LIBRARY(ale->id);
+
     /* if this track has no tracks before it, skip for now... */
     if (nltp == NULL) {
       continue;
     }
 
+    if (BKE_nlatrack_is_nonlocal_in_liboverride(ale->id, nlt) ||
+        BKE_nlatrack_is_nonlocal_in_liboverride(ale->id, nltp)) {
+      /* No moving of strips in non-local tracks of override data. */
+      continue;
+    }
+
     /* for every selected strip, try to move */
     for (strip = nlt->strips.first; strip; strip = stripn) {
       stripn = strip->next;
@@ -1766,7 +1815,7 @@ static int nlaedit_move_down_exec(bContext *C, wmOperator *UNUSED(op))
           /* remove from its current track, and add to the one above
            * (it 'should' work, so no need to worry) */
           BLI_remlink(&nlt->strips, strip);
-          BKE_nlatrack_add_strip(nltp, strip);
+          BKE_nlatrack_add_strip(nltp, strip, is_liboverride);
         }
       }
     }
@@ -2023,11 +2072,11 @@ static int nlaedit_apply_scale_exec(bContext *C, wmOperator *UNUSED(op))
       /* strip must be selected, and must be action-clip only
        * (transitions don't have scale) */
       if ((strip->flag & NLASTRIP_FLAG_SELECT) && (strip->type == NLASTRIP_TYPE_CLIP)) {
-        /* if the referenced action is used by other strips,
-         * make this strip use its own copy */
-        if (strip->act == NULL) {
+        if (strip->act == NULL || ID_IS_OVERRIDE_LIBRARY(strip->act) || ID_IS_LINKED(strip->act)) {
           continue;
         }
+        /* if the referenced action is used by other strips,
+         * make this strip use its own copy */
         if (strip->act->id.us > 1) {
           /* make a copy of the Action to work on */
           bAction *act = (bAction *)BKE_id_copy(bmain, &strip->act->id);
@@ -2200,6 +2249,8 @@ static int nlaedit_snap_exec(bContext *C, wmOperator *op)
     NlaStrip *strip, *stripn;
     NlaTrack *track;
 
+    const bool is_liboverride = ID_IS_OVERRIDE_LIBRARY(ale->id);
+
     /* create meta-strips from the continuous chains of selected strips */
     BKE_nlastrips_make_metas(&nlt->strips, 1);
 
@@ -2255,10 +2306,10 @@ static int nlaedit_snap_exec(bContext *C, wmOperator *op)
       BLI_remlink(&tmp_strips, strip);
 
       /* in case there's no space in the current track, try adding */
-      if (BKE_nlatrack_add_strip(nlt, strip) == 0) {
+      if (BKE_nlatrack_add_strip(nlt, strip, is_liboverride) == 0) {
         /* need to add a new track above the current one */
-        track = BKE_nlatrack_add(adt, nlt);
-        BKE_nlatrack_add_strip(track, strip);
+        track = BKE_nlatrack_add(adt, nlt, is_liboverride);
+        BKE_nlatrack_add_strip(track, strip, is_liboverride);
 
         /* clear temp meta-strips on this new track,
          * as we may not be able to get back to it */
@@ -2375,6 +2426,11 @@ static int nla_fmodifier_add_exec(bContext *C, wmOperator *op)
     NlaTrack *nlt = (NlaTrack *)ale->data;
     NlaStrip *strip;
 
+    if (BKE_nlatrack_is_nonlocal_in_liboverride(ale->id, nlt)) {
+      /* No adding f-modifiers to strips in non-local tracks of override data. */
+      continue;
+    }
+
     for (strip = nlt->strips.first; strip; strip = strip->next) {
       /* can F-Modifier be added to the current strip? */
       if (active_only) {
@@ -2552,6 +2608,11 @@ static int nla_fmodifier_paste_exec(bContext *C, wmOperator *op)
     NlaTrack *nlt = (NlaTrack *)ale->data;
     NlaStrip *strip;
 
+    if (BKE_nlatrack_is_nonlocal_in_liboverride(ale->id, nlt)) {
+      /* No pasting in non-local tracks of override data. */
+      continue;
+    }
+
     for (strip = nlt->strips.first; strip; strip = strip->next) {
       /* can F-Modifier be added to the current strip? */
       if (active_only) {