Blender V5.3
sequencer_preview.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
10#include "DNA_sound_types.h"
11
12#include "BLI_listbase.hh"
13#include "BLI_task_c.hh"
14#include "BLI_threads.hh"
15
16#include "BKE_context.hh"
17#include "BKE_global.hh"
18#include "BKE_sound.hh"
19
20#include "WM_api.hh"
21#include "WM_types.hh"
22
23#include "ED_screen.hh"
24
25#include "MEM_guardedalloc.h"
26
27#include "sequencer_intern.hh"
28
29namespace blender::ed::vse {
30
31struct PreviewJobAudio;
32
42
47 int lr; /* Sample left or right. */
49 bool waveform; /* Reload sound or waveform. */
50};
51
57
58static void free_preview_job(void *data)
59{
60 PreviewJob *pj = static_cast<PreviewJob *>(data);
61
63 pj->previews.free_no_destruct();
64 MEM_delete(pj);
65}
66
67static void free_read_sound_waveform_task(TaskPool *__restrict task_pool, void *data)
68{
69 UNUSED_VARS(task_pool);
70
71 ReadSoundWaveformTask *task = static_cast<ReadSoundWaveformTask *>(data);
72
73 /* The job audio has already been removed from the list, now we just need to free it. */
74 MEM_delete(task->preview_job_audio);
75
77 task->wm_job->processed++;
79
81
82 MEM_delete(task);
83}
84
85static void execute_read_sound_waveform_task(TaskPool *__restrict /*task_pool*/, void *task_data)
86{
87 ReadSoundWaveformTask *task = static_cast<ReadSoundWaveformTask *>(task_data);
88 PreviewJobAudio *audio_job = task->preview_job_audio;
89 BKE_sound_read_waveform(audio_job->bmain, audio_job->sound, task->stop);
90}
91
92/* Only this runs inside thread. */
93static void preview_startjob(void *data, wmJobWorkerStatus *worker_status)
94{
95 TaskPool *task_pool = BLI_task_pool_create(nullptr, TASK_PRIORITY_LOW);
96 PreviewJob *pj = static_cast<PreviewJob *>(data);
97
98 while (true) {
99 /* Wait until there's either a new audio job to process or one of the previously submitted jobs
100 * is done. */
102
103 while (pj->previews.is_empty() && pj->processed != pj->total) {
104
105 float current_progress = (pj->total > 0) ? float(pj->processed) / float(pj->total) : 1.0f;
106
107 if (current_progress != worker_status->progress) {
108 worker_status->progress = current_progress;
109 worker_status->do_update = true;
110 }
111
113 }
114
115 if (pj->processed == pj->total) {
116 pj->running = false;
118 break;
119 }
120
121 if (G.is_break) {
122 worker_status->stop = true;
123 }
124
125 if (worker_status->stop) {
126 for (PreviewJobAudio &previewjb : pj->previews) {
128 }
129
130 pj->previews.free_no_destruct();
131 pj->processed = 0;
132 pj->total = 0;
133 pj->running = false;
134
136 break;
137 }
138
140 for (PreviewJobAudio &previewjb : pj->previews.items_mutable()) {
142 "read sound waveform task");
143 task->wm_job = pj;
144 task->preview_job_audio = &previewjb;
145 task->stop = &worker_status->stop;
146 new_tasks.append(task);
147
148 BLI_remlink(&pj->previews, &previewjb);
149 }
150
152
153 for (ReadSoundWaveformTask *task : new_tasks) {
156 }
157 }
158
160 BLI_task_pool_free(task_pool);
161}
162
163static void preview_endjob(void *data)
164{
165 PreviewJob *pj = static_cast<PreviewJob *>(data);
166
168}
169
170void sequencer_preview_add_sound(const bContext *C, const Strip *strip)
171{
172 wmJob *wm_job;
173 PreviewJob *pj;
174 ScrArea *area = CTX_wm_area(C);
175
176 wm_job = WM_jobs_get(CTX_wm_manager(C),
179 "Generating strip previews...",
182
183 /* Get the preview job if it exists. */
184 pj = static_cast<PreviewJob *>(WM_jobs_customdata_get(wm_job));
185
186 if (pj) {
188
189 /* If the job exists but is not running, bail and try again on the next draw call. */
190 if (!pj->running) {
192
193 /* Clear the sound loading tag to that it can be reattempted. */
196 return;
197 }
198 }
199 else { /* There's no existing preview job. */
200 pj = MEM_new_zeroed<PreviewJob>("preview rebuild job");
201
202 pj->mutex = BLI_mutex_alloc();
205 pj->running = true;
207
210 WM_jobs_callbacks(wm_job, preview_startjob, nullptr, nullptr, preview_endjob);
211 }
212
213 PreviewJobAudio *audiojob = MEM_new_zeroed<PreviewJobAudio>("preview_audio");
214 audiojob->bmain = CTX_data_main(C);
215 audiojob->sound = strip->sound;
216
217 BLI_addtail(&pj->previews, audiojob);
218 pj->total++;
220
222
223 if (!WM_jobs_is_running(wm_job)) {
224 G.is_break = false;
226 }
227
228 ED_area_tag_redraw(area);
229}
230
231} // namespace blender::ed::vse
Read Blender memory allocation and freeing.
#define C
Definition RandGen.cpp:29
#define ND_SEQUENCER
Definition WM_types.hh:456
#define ND_SPACE_SEQUENCER
Definition WM_types.hh:578
#define NC_SCENE
Definition WM_types.hh:391
#define UNUSED_VARS(...)
void append(const T &value)
void sequencer_preview_add_sound(const bContext *C, const Strip *strip)
static void preview_startjob(void *data, wmJobWorkerStatus *worker_status)
static void free_preview_job(void *data)
static void preview_endjob(void *data)
static void execute_read_sound_waveform_task(TaskPool *__restrict, void *task_data)
static void free_read_sound_waveform_task(TaskPool *__restrict task_pool, void *data)
void WM_main_add_notifier(uint type, void *reference)
ScrArea * CTX_wm_area(const bContext *C)
Scene * CTX_data_sequencer_scene(const bContext *C)
void WM_jobs_callbacks(wmJob *wm_job, wm_jobs_start_callback startjob, void(*initjob)(void *), void(*update)(void *), void(*endjob)(void *))
Definition wm_jobs.cc:407
void BLI_condition_init(ThreadCondition *cond)
Definition threads.cc:578
@ TASK_PRIORITY_LOW
Definition BLI_task_c.hh:60
@ WM_JOB_TYPE_SEQ_BUILD_PREVIEW
Definition WM_api.hh:2033
void BLI_mutex_unlock(ThreadMutex *mutex)
Definition threads.cc:353
ThreadMutex * BLI_mutex_alloc()
Definition threads.cc:368
wmWindow * CTX_wm_window(const bContext *C)
void BLI_condition_wait(ThreadCondition *cond, ThreadMutex *mutex)
Definition threads.cc:583
void WM_jobs_customdata_set(wmJob *wm_job, void *customdata, void(*free)(void *customdata))
Definition wm_jobs.cc:377
@ WM_JOB_PROGRESS
Definition WM_api.hh:1997
void WM_jobs_start(wmWindowManager *wm, wmJob *wm_job)
Definition wm_jobs.cc:498
void BLI_task_pool_work_and_wait(TaskPool *pool)
Definition task_pool.cc:455
Global G
Definition blender.cc:57
void * WM_jobs_customdata_get(wmJob *wm_job)
Definition wm_jobs.cc:369
void BLI_condition_notify_one(ThreadCondition *cond)
Definition threads.cc:593
void BLI_mutex_lock(ThreadMutex *mutex)
Definition threads.cc:348
void * MEM_new_zeroed(size_t len, const char *str) ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2)
void BLI_remlink(ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition listbase.cc:138
BMesh const char void * data
wmWindowManager * CTX_wm_manager(const bContext *C)
void WM_event_add_notifier(const bContext *C, uint type, void *reference)
void BLI_task_pool_free(TaskPool *pool)
Definition task_pool.cc:441
TaskPool * BLI_task_pool_create(void *userdata, eTaskPriority priority)
Definition task_pool.cc:404
void BKE_sound_runtime_clear_waveform_loading_tag(bSound *sound)
void BLI_addtail(ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition listbase.cc:118
void BKE_sound_read_waveform(Main *bmain, bSound *sound, bool *stop)
Main * CTX_data_main(const bContext *C)
wmJob * WM_jobs_get(wmWindowManager *wm, wmWindow *win, const void *owner, const char *name, const eWM_JobFlag flag, const eWM_JobType job_type)
Definition wm_jobs.cc:228
void BLI_mutex_free(ThreadMutex *mutex)
Definition threads.cc:375
pthread_cond_t ThreadCondition
pthread_mutex_t ThreadMutex
void BLI_task_pool_push(TaskPool *pool, TaskRunFunction run, void *taskdata, bool free_taskdata, TaskFreeFunction freedata)
Definition task_pool.cc:446
void WM_jobs_timer(wmJob *wm_job, double time_step, uint note, uint endnote, void(*timer_step)(void *))
Definition wm_jobs.cc:393
bool WM_jobs_is_running(const wmJob *wm_job)
Definition wm_jobs.cc:358
void ED_area_tag_redraw(ScrArea *area)
Definition area.cc:784
KERNEL_FEATURE_LIGHT_PASSES KERNEL_FEATURE_PATH_GUIDING float
ListBaseT< PreviewJobAudio > previews