Sound: Make sound handles only be in evaluated datablocks

Quite straightforward change, which makes it so audio handles are
only created inside of evaluated datablocks.

Exception is adding sound strip to the sequencer, which needs an
audio handle to query length and number of channels. This is done
by temporarily loading sound file into an original datablock, and
then tossing it away.

There is an assert in sound.c which verifies that audio system is
used from an evaluated domain, which should help porting all the
cases which are likely missed by this commit.

Some annoying parts:

- `BKE_sound_update_scene()` is iterating over all bases, and does
  special ID tags to see whether sound has been handled or not
  already. This can not be done the old fashion now.

  Ideally, this will be done as a speaker datablock evaluation,
  but seems that would require a lock since audio API is not safe
  for threading. So this is not a desired way i'd say.

  Possible solution here would be to iterate over ID datablocks
  using dependency graph query API.

- Frame jump needs to call `BKE_sound_seek_scene()` directly
  because there might be some flags assigned to the scene which
  could be clear after operator execution is over.

  Need to verify if that's the case though. This is a bit hairy
  code, so sticking to a safest and known to work approach for
  now.

- Removed check for format when opening new sound file.
  Maybe we can have some utility function which queries channel
  and duration information, leaving the caller's code clean and
  tidy.

Tested following cases:
- Adding/removing/moving sequencer's sound strips.
- Adding/moving speakers in viewport.
- Rendering audio.

Reviewers: brecht

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

1 files changed, 20 insertions, 35 deletions

diff --git a/source/blender/editors/sound/sound_ops.c b/source/blender/editors/sound/sound_ops.c
index 25c05e2d1d0..8ac49e447fe 100644
--- a/source/blender/editors/sound/sound_ops.c
+++ b/source/blender/editors/sound/sound_ops.c
@@ -62,6 +62,8 @@
 #  include <AUD_Special.h>
 #endif
 
+#include "DEG_depsgraph_query.h"
+
 #include "ED_sound.h"
 #include "ED_util.h"
 
@@ -88,7 +90,6 @@ static int sound_open_exec(bContext *C, wmOperator *op)
   bSound *sound;
   PropertyPointerRNA *pprop;
   PointerRNA idptr;
-  AUD_SoundInfo info;
   Main *bmain = CTX_data_main(C);
 
   RNA_string_get(op->ptr, "filepath", path);
@@ -98,29 +99,8 @@ static int sound_open_exec(bContext *C, wmOperator *op)
     sound_open_init(C, op);
   }
 
-  if (sound->playback_handle == NULL) {
-    if (op->customdata) {
-      MEM_freeN(op->customdata);
-    }
-    BKE_id_free(bmain, sound);
-    BKE_report(op->reports, RPT_ERROR, "Unsupported audio format");
-    return OPERATOR_CANCELLED;
-  }
-
-  info = AUD_getInfo(sound->playback_handle);
-
-  if (info.specs.channels == AUD_CHANNELS_INVALID) {
-    BKE_id_free(bmain, sound);
-    if (op->customdata) {
-      MEM_freeN(op->customdata);
-    }
-    BKE_report(op->reports, RPT_ERROR, "Unsupported audio format");
-    return OPERATOR_CANCELLED;
-  }
-
   if (RNA_boolean_get(op->ptr, "mono")) {
     sound->flags |= SOUND_FLAGS_MONO;
-    BKE_sound_load(bmain, sound);
   }
 
   if (RNA_boolean_get(op->ptr, "cache")) {
@@ -140,6 +120,8 @@ static int sound_open_exec(bContext *C, wmOperator *op)
     RNA_property_update(C, &pprop->ptr, pprop->prop);
   }
 
+  DEG_relations_tag_update(bmain);
+
   MEM_freeN(op->customdata);
   return OPERATOR_FINISHED;
 }
@@ -361,8 +343,9 @@ static int sound_mixdown_exec(bContext *C, wmOperator *op)
 #ifdef WITH_AUDASPACE
   char path[FILE_MAX];
   char filename[FILE_MAX];
-  Scene *scene;
-  Main *bmain;
+  Depsgraph *depsgraph = CTX_data_depsgraph(C);
+  Scene *scene_eval = DEG_get_evaluated_scene(depsgraph);
+  Main *bmain = CTX_data_main(C);
   int split;
 
   int bitrate, accuracy;
@@ -380,18 +363,20 @@ static int sound_mixdown_exec(bContext *C, wmOperator *op)
   container = RNA_enum_get(op->ptr, "container");
   codec = RNA_enum_get(op->ptr, "codec");
   split = RNA_boolean_get(op->ptr, "split_channels");
-  scene = CTX_data_scene(C);
-  bmain = CTX_data_main(C);
-  specs.channels = scene->r.ffcodecdata.audio_channels;
-  specs.rate = scene->r.ffcodecdata.audio_mixrate;
+  specs.channels = scene_eval->r.ffcodecdata.audio_channels;
+  specs.rate = scene_eval->r.ffcodecdata.audio_mixrate;
 
   BLI_strncpy(filename, path, sizeof(filename));
   BLI_path_abs(filename, BKE_main_blendfile_path(bmain));
 
+  const double fps = (((double)scene_eval->r.frs_sec) / (double)scene_eval->r.frs_sec_base);
+  const int start_frame = scene_eval->r.sfra;
+  const int end_frame = scene_eval->r.efra;
+
   if (split) {
-    result = AUD_mixdown_per_channel(scene->sound_scene,
-                                     SFRA * specs.rate / FPS,
-                                     (EFRA - SFRA + 1) * specs.rate / FPS,
+    result = AUD_mixdown_per_channel(scene_eval->sound_scene,
+                                     start_frame * specs.rate / fps,
+                                     (end_frame - start_frame + 1) * specs.rate / fps,
                                      accuracy,
                                      filename,
                                      specs,
@@ -400,9 +385,9 @@ static int sound_mixdown_exec(bContext *C, wmOperator *op)
                                      bitrate);
   }
   else {
-    result = AUD_mixdown(scene->sound_scene,
-                         SFRA * specs.rate / FPS,
-                         (EFRA - SFRA + 1) * specs.rate / FPS,
+    result = AUD_mixdown(scene_eval->sound_scene,
+                         start_frame * specs.rate / fps,
+                         (end_frame - start_frame + 1) * specs.rate / fps,
                          accuracy,
                          filename,
                          specs,
@@ -411,7 +396,7 @@ static int sound_mixdown_exec(bContext *C, wmOperator *op)
                          bitrate);
   }
 
-  BKE_sound_reset_scene_specs(scene);
+  BKE_sound_reset_scene_specs(scene_eval);
 
   if (result) {
     BKE_report(op->reports, RPT_ERROR, result);