aviutl2 0.31.0

AviUtl2 SDKのRustラッパー
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
use crate::{
    common::{AnyResult, LeakManager},
    generic::{
        GenericPlugin, ProjectFile,
        binding::{HostAppHandle, PluginRegistry},
    },
};

#[doc(hidden)]
pub struct InternalGenericPluginState<T: Send + Sync + GenericPlugin> {
    plugin_registry: PluginRegistry,

    register_plugin_done: std::sync::Arc<std::sync::atomic::AtomicBool>,
    global_leak_manager: LeakManager,

    instance: T,
    is_edit_handle_ready: std::sync::Arc<std::sync::atomic::AtomicBool>,
}

impl<T: Send + Sync + GenericPlugin> InternalGenericPluginState<T> {
    pub fn new(instance: T) -> Self {
        Self {
            plugin_registry: PluginRegistry::new(),
            register_plugin_done: std::sync::Arc::new(std::sync::atomic::AtomicBool::new(false)),
            global_leak_manager: LeakManager::new(),
            instance,
            is_edit_handle_ready: std::sync::Arc::new(std::sync::atomic::AtomicBool::new(false)),
        }
    }
}

pub trait GenericSingleton
where
    Self: 'static + Send + Sync + crate::generic::GenericPlugin,
{
    fn __get_singleton_state() -> &'static std::sync::RwLock<
        Option<crate::generic::__bridge::InternalGenericPluginState<Self>>,
    >;
    fn with_instance<R>(f: impl FnOnce(&Self) -> R) -> R {
        let lock = Self::__get_singleton_state();
        let guard = lock.read().unwrap();
        let state = guard.as_ref().expect("Plugin not initialized");
        f(&state.instance)
    }
    fn with_instance_mut<R>(f: impl FnOnce(&mut Self) -> R) -> R {
        let lock = Self::__get_singleton_state();
        let mut guard = lock.write().unwrap();
        let state = guard.as_mut().expect("Plugin not initialized");
        f(&mut state.instance)
    }
}

pub unsafe fn create_table<T: GenericSingleton>() -> *mut aviutl2_sys::plugin2::COMMON_PLUGIN_TABLE
{
    let plugin_state = T::__get_singleton_state();
    let mut plugin_state = plugin_state.write().unwrap();
    let plugin_state = plugin_state.as_mut().expect("Plugin not initialized");
    tracing::info!(
        "Creating plugin table for plugin: {}",
        std::any::type_name::<T>()
    );
    let info = plugin_state.instance.plugin_info();
    let table = Box::new(aviutl2_sys::plugin2::COMMON_PLUGIN_TABLE {
        name: plugin_state
            .global_leak_manager
            .leak_as_wide_string(&info.name),
        information: plugin_state
            .global_leak_manager
            .leak_as_wide_string(&info.information),
    });
    Box::into_raw(table)
}

pub unsafe fn create_table_unwind<T: GenericSingleton>()
-> *mut aviutl2_sys::plugin2::COMMON_PLUGIN_TABLE {
    match crate::utils::catch_unwind_with_panic_info(|| unsafe { create_table::<T>() }) {
        Ok(table) => table,
        Err(panic_info) => {
            tracing::error!("Panic occurred during table creation: {}", panic_info);
            let _ = crate::logger::write_error_log(&panic_info);
            std::ptr::null_mut()
        }
    }
}

pub unsafe fn initialize_plugin_c<T: GenericSingleton>(version: u32) -> bool {
    match initialize_plugin::<T>(version) {
        Ok(_) => true,
        Err(e) => {
            tracing::error!("Failed to initialize plugin: {}", e);
            let _ = crate::logger::write_error_log(&format!("{e}"));
            false
        }
    }
}

pub unsafe fn initialize_plugin_c_unwind<T: GenericSingleton>(version: u32) -> bool {
    match crate::utils::catch_unwind_with_panic_info(|| unsafe {
        initialize_plugin_c::<T>(version)
    }) {
        Ok(result) => result,
        Err(panic_info) => {
            tracing::error!(
                "Panic occurred during plugin initialization: {}",
                panic_info
            );
            let _ = crate::logger::write_error_log(&panic_info);
            false
        }
    }
}

pub(crate) fn initialize_plugin<T: GenericSingleton>(version: u32) -> AnyResult<()> {
    crate::common::ensure_minimum_aviutl2_version(version.into())?;
    let plugin_state = T::__get_singleton_state();
    let info = crate::common::AviUtl2Info {
        version: version.into(),
    };
    let internal = T::new(info)?;
    let plugin = InternalGenericPluginState::new(internal);
    *plugin_state.write().unwrap() = Some(plugin);

    Ok(())
}
fn register_plugin_impl<T: GenericSingleton>(
    host: *mut aviutl2_sys::plugin2::HOST_APP_TABLE,
    unwind: bool,
) {
    let plugin_state = T::__get_singleton_state();
    let mut plugin_state = plugin_state.write().unwrap();
    let plugin_state = plugin_state.as_mut().expect("Plugin not initialized");

    let mut handle = unsafe {
        HostAppHandle::new(
            host,
            &mut plugin_state.global_leak_manager,
            plugin_state.register_plugin_done.clone(),
            &mut plugin_state.plugin_registry,
            plugin_state.is_edit_handle_ready.clone(),
        )
    };
    if unwind {
        let result =
            crate::utils::catch_unwind_with_panic_info(std::panic::AssertUnwindSafe(|| {
                T::register(&mut plugin_state.instance, &mut handle)
            }));
        if let Err(panic_info) = result {
            tracing::error!(
                "Panic occurred during plugin registration: {:?}",
                panic_info
            );
            let _ = crate::logger::write_error_log(&format!(
                "Panic during plugin registration: {}",
                panic_info
            ));
            return;
        }
        handle.register_project_load_handler(on_project_load_unwind::<T>);
        handle.register_project_save_handler(on_project_save_unwind::<T>);
        handle.register_clear_cache_handler(on_clear_cache_unwind::<T>);
        handle.register_change_scene_handler(on_change_scene_unwind::<T>);
    } else {
        T::register(&mut plugin_state.instance, &mut handle);
        handle.register_project_load_handler(on_project_load::<T>);
        handle.register_project_save_handler(on_project_save::<T>);
        handle.register_clear_cache_handler(on_clear_cache::<T>);
        handle.register_change_scene_handler(on_change_scene::<T>);
    }
    plugin_state
        .register_plugin_done
        .store(true, std::sync::atomic::Ordering::SeqCst);

    fn on_project_load_impl<T: GenericSingleton>(project: *mut aviutl2_sys::plugin2::PROJECT_FILE) {
        {
            // on_project_loadはプロジェクトの初期化時に呼ばれるので、RegisterPluginが終わった合図として使う。
            let state = T::__get_singleton_state();
            let guard = state.read().unwrap();
            let plugin_state = guard.as_ref().expect("Plugin not initialized");
            plugin_state
                .is_edit_handle_ready
                .store(true, std::sync::atomic::Ordering::SeqCst);
        }
        <T as GenericSingleton>::with_instance_mut(|instance| unsafe {
            let mut project = ProjectFile::from_raw(project);
            instance.on_project_load(&mut project);
        });
    }
    extern "C" fn on_project_load<T: GenericSingleton>(
        project: *mut aviutl2_sys::plugin2::PROJECT_FILE,
    ) {
        on_project_load_impl::<T>(project);
    }
    extern "C" fn on_project_load_unwind<T: GenericSingleton>(
        project: *mut aviutl2_sys::plugin2::PROJECT_FILE,
    ) {
        if let Err(panic_info) =
            crate::utils::catch_unwind_with_panic_info(|| on_project_load_impl::<T>(project))
        {
            tracing::error!("Panic occurred during on_project_load: {}", panic_info);
            let _ = crate::logger::write_error_log(&panic_info);
        }
    }

    fn on_project_save_impl<T: GenericSingleton>(project: *mut aviutl2_sys::plugin2::PROJECT_FILE) {
        <T as GenericSingleton>::with_instance_mut(|instance| unsafe {
            let mut project = ProjectFile::from_raw(project);
            instance.on_project_save(&mut project);
        });
    }
    extern "C" fn on_project_save<T: GenericSingleton>(
        project: *mut aviutl2_sys::plugin2::PROJECT_FILE,
    ) {
        on_project_save_impl::<T>(project);
    }
    extern "C" fn on_project_save_unwind<T: GenericSingleton>(
        project: *mut aviutl2_sys::plugin2::PROJECT_FILE,
    ) {
        if let Err(panic_info) =
            crate::utils::catch_unwind_with_panic_info(|| on_project_save_impl::<T>(project))
        {
            tracing::error!("Panic occurred during on_project_save: {}", panic_info);
            let _ = crate::logger::write_error_log(&panic_info);
        }
    }

    fn on_clear_cache_impl<T: GenericSingleton>(
        edit_section: *mut aviutl2_sys::plugin2::EDIT_SECTION,
    ) {
        <T as GenericSingleton>::with_instance_mut(|instance| unsafe {
            let edit_section = crate::generic::EditSection::from_raw(edit_section);
            instance.on_clear_cache(&edit_section);
        });
    }
    extern "C" fn on_clear_cache<T: GenericSingleton>(
        edit_section: *mut aviutl2_sys::plugin2::EDIT_SECTION,
    ) {
        on_clear_cache_impl::<T>(edit_section);
    }
    extern "C" fn on_clear_cache_unwind<T: GenericSingleton>(
        edit_section: *mut aviutl2_sys::plugin2::EDIT_SECTION,
    ) {
        if let Err(panic_info) =
            crate::utils::catch_unwind_with_panic_info(|| on_clear_cache_impl::<T>(edit_section))
        {
            tracing::error!("Panic occurred during on_clear_cache: {}", panic_info);
            let _ = crate::logger::write_error_log(&panic_info);
        }
    }

    fn on_change_scene_impl<T: GenericSingleton>(
        edit_section: *mut aviutl2_sys::plugin2::EDIT_SECTION,
    ) {
        <T as GenericSingleton>::with_instance_mut(|instance| unsafe {
            let edit_section = crate::generic::EditSection::from_raw(edit_section);
            instance.on_change_scene(&edit_section);
        });
    }
    extern "C" fn on_change_scene<T: GenericSingleton>(
        edit_section: *mut aviutl2_sys::plugin2::EDIT_SECTION,
    ) {
        on_change_scene_impl::<T>(edit_section);
    }
    extern "C" fn on_change_scene_unwind<T: GenericSingleton>(
        edit_section: *mut aviutl2_sys::plugin2::EDIT_SECTION,
    ) {
        if let Err(panic_info) =
            crate::utils::catch_unwind_with_panic_info(|| on_change_scene_impl::<T>(edit_section))
        {
            tracing::error!("Panic occurred during on_change_scene: {}", panic_info);
            let _ = crate::logger::write_error_log(&panic_info);
        }
    }
}

pub unsafe fn register_plugin<T: GenericSingleton>(
    host: *mut aviutl2_sys::plugin2::HOST_APP_TABLE,
) {
    register_plugin_impl::<T>(host, false);
}

pub unsafe fn register_plugin_unwind<T: GenericSingleton>(
    host: *mut aviutl2_sys::plugin2::HOST_APP_TABLE,
) {
    if let Err(panic_info) =
        crate::utils::catch_unwind_with_panic_info(|| register_plugin_impl::<T>(host, true))
    {
        tracing::error!("Panic occurred during register_plugin: {}", panic_info);
        let _ = crate::logger::write_error_log(&panic_info);
    }
}
pub unsafe fn uninitialize_plugin<T: GenericSingleton>() {
    let plugin_state = T::__get_singleton_state();
    let mut plugin_state = plugin_state.write().unwrap();
    plugin_state.take();
}

pub unsafe fn uninitialize_plugin_c_unwind<T: GenericSingleton>() {
    match crate::utils::catch_unwind_with_panic_info(|| unsafe { uninitialize_plugin::<T>() }) {
        Ok(()) => {}
        Err(panic_info) => {
            tracing::error!(
                "Panic occurred during plugin uninitialization: {}",
                panic_info
            );
            let _ = crate::logger::write_error_log(&panic_info);
        }
    }
}

/// 汎用プラグインを登録するマクロ。
///
/// # Arguments
///
/// - `unwind`: panic時にunwindするかどうか。デフォルトは`true`。
#[macro_export]
macro_rules! register_generic_plugin {
    ($struct:ident, $($key:ident = $value:expr),* $(,)?) => {
        $crate::__internal_module! {
            #[unsafe(no_mangle)]
            unsafe extern "C" fn RequiredVersion() -> u32 {
                $crate::MINIMUM_AVIUTL2_VERSION.into()
            }

            #[unsafe(no_mangle)]
            unsafe extern "C" fn InitializeLogger(logger: *mut $crate::sys::logger2::LOG_HANDLE) {
                $crate::comptime_if::comptime_if! {
                    if unwind where (unwind = true, $( $key = $value ),* ) {
                        $crate::logger::__initialize_logger_unwind(logger)
                    } else {
                        $crate::logger::__initialize_logger(logger)
                    }
                }
            }

            #[unsafe(no_mangle)]
            unsafe extern "C" fn InitializeConfig(
                config: *mut $crate::sys::config2::CONFIG_HANDLE
            ) {
                $crate::comptime_if::comptime_if! {
                    if unwind where (unwind = true, $( $key = $value ),* ) {
                        $crate::config::__initialize_config_handle_unwind(config)
                    } else {
                        $crate::config::__initialize_config_handle(config)
                    }
                }
            }

            #[unsafe(no_mangle)]
            unsafe extern "C" fn InitializeCache(
                cache: *mut $crate::sys::cache2::CACHE_HANDLE
            ) {
                $crate::comptime_if::comptime_if! {
                    if unwind where (unwind = true, $( $key = $value ),* ) {
                        $crate::cache::__initialize_cache_unwind(cache)
                    } else {
                        $crate::cache::__initialize_cache(cache)
                    }
                }
            }

            #[unsafe(no_mangle)]
            unsafe extern "C" fn InitializePlugin(version: u32) -> bool {
                unsafe {
                    $crate::comptime_if::comptime_if! {
                        if unwind where (unwind = true, $( $key = $value ),* ) {
                            $crate::generic::__bridge::initialize_plugin_c_unwind::<$struct>(version)
                        } else {
                            $crate::generic::__bridge::initialize_plugin_c::<$struct>(version)
                        }
                    }
                }
            }

            #[unsafe(no_mangle)]
            unsafe extern "C" fn GetCommonPluginTable() -> *mut $crate::sys::plugin2::COMMON_PLUGIN_TABLE {
                $crate::comptime_if::comptime_if! {
                    if unwind where (unwind = true, $( $key = $value ),* ) {
                        unsafe { $crate::generic::__bridge::create_table_unwind::<$struct>() }
                    } else {
                        unsafe { $crate::generic::__bridge::create_table::<$struct>() }
                    }
                }
            }

            #[unsafe(no_mangle)]
            unsafe extern "C" fn UninitializePlugin() {
                unsafe {
                    $crate::comptime_if::comptime_if! {
                        if unwind where (unwind = true, $( $key = $value ),* ) {
                            $crate::generic::__bridge::uninitialize_plugin_c_unwind::<$struct>()
                        } else {
                            $crate::generic::__bridge::uninitialize_plugin::<$struct>()
                        }
                    }
                };
            }

            #[unsafe(no_mangle)]
            unsafe extern "C" fn RegisterPlugin(host: *mut aviutl2::sys::plugin2::HOST_APP_TABLE) {
                $crate::comptime_if::comptime_if! {
                    if unwind where (unwind = true, $( $key = $value ),* ) {
                        unsafe { $crate::generic::__bridge::register_plugin_unwind::<$struct>(host) };
                    } else {
                        unsafe { $crate::generic::__bridge::register_plugin::<$struct>(host) };
                    }
                }
            }
        }
    };
    ($struct:ident, $($key:ident),* $(,)?) => {
        $crate::register_generic_plugin!($struct, $( $key = true ),* );
    };
    ($struct:ident) => {
        $crate::register_generic_plugin!($struct, );
    };
}