mirror of
https://github.com/GraphiteEditor/Graphite.git
synced 2026-09-30 06:18:12 +08:00
Wire the async source runtimes into the hosts
This commit is contained in:
@@ -97,6 +97,11 @@ impl App {
|
|||||||
});
|
});
|
||||||
let desktop_wrapper = DesktopWrapper::new(rand::rng().random(), Arc::new(resource_storage), dirs::app_autosave_documents_dir(), wgpu_context.clone(), wake);
|
let desktop_wrapper = DesktopWrapper::new(rand::rng().random(), Arc::new(resource_storage), dirs::app_autosave_documents_dir(), wgpu_context.clone(), wake);
|
||||||
|
|
||||||
|
let completion_render_sender = start_render_sender.clone();
|
||||||
|
DesktopWrapper::set_completion_notifier(move || {
|
||||||
|
let _ = completion_render_sender.try_send(());
|
||||||
|
});
|
||||||
|
|
||||||
Self {
|
Self {
|
||||||
render_state: None,
|
render_state: None,
|
||||||
wgpu_context,
|
wgpu_context,
|
||||||
|
|||||||
@@ -52,6 +52,10 @@ impl DesktopWrapper {
|
|||||||
executor.execute()
|
executor.execute()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn set_completion_notifier(notifier: impl Fn() + Send + Sync + 'static) {
|
||||||
|
graphite_editor::node_graph_executor::set_completion_notifier(Arc::new(notifier));
|
||||||
|
}
|
||||||
|
|
||||||
pub async fn execute_node_graph() -> NodeGraphExecutionResult {
|
pub async fn execute_node_graph() -> NodeGraphExecutionResult {
|
||||||
let result = graphite_editor::node_graph_executor::run_node_graph().await;
|
let result = graphite_editor::node_graph_executor::run_node_graph().await;
|
||||||
match result {
|
match result {
|
||||||
|
|||||||
@@ -59,6 +59,9 @@ pub struct NodeGraphExecutor {
|
|||||||
runtime_io: NodeRuntimeIO,
|
runtime_io: NodeRuntimeIO,
|
||||||
current_execution_id: u64,
|
current_execution_id: u64,
|
||||||
futures: VecDeque<(u64, ExecutionContext)>,
|
futures: VecDeque<(u64, ExecutionContext)>,
|
||||||
|
/// The most recently consumed plain render execution, kept so a runtime-replayed response with the same id
|
||||||
|
/// (sent after an async source completion) finds its context again.
|
||||||
|
last_execution_context: Option<(u64, ExecutionContext)>,
|
||||||
node_graph_hash: u64,
|
node_graph_hash: u64,
|
||||||
/// Full path from the root document network to the node currently being inspected by the Data panel, or empty if nothing is selected.
|
/// Full path from the root document network to the node currently being inspected by the Data panel, or empty if nothing is selected.
|
||||||
/// The last element is the inspect target itself; preceding elements identify the nested subnetwork the node lives in,
|
/// The last element is the inspect target itself; preceding elements identify the nested subnetwork the node lives in,
|
||||||
@@ -108,6 +111,7 @@ impl NodeGraphExecutor {
|
|||||||
let node_executor = Self {
|
let node_executor = Self {
|
||||||
futures: Default::default(),
|
futures: Default::default(),
|
||||||
runtime_io: NodeRuntimeIO::with_channels(request_sender, response_receiver),
|
runtime_io: NodeRuntimeIO::with_channels(request_sender, response_receiver),
|
||||||
|
last_execution_context: None,
|
||||||
node_graph_hash: 0,
|
node_graph_hash: 0,
|
||||||
current_execution_id: 0,
|
current_execution_id: 0,
|
||||||
previous_node_to_inspect: Vec::new(),
|
previous_node_to_inspect: Vec::new(),
|
||||||
@@ -377,9 +381,19 @@ impl NodeGraphExecutor {
|
|||||||
|
|
||||||
let execution_context = if self.futures.front().is_some_and(|&(queued_execution_id, _)| queued_execution_id == execution_id) {
|
let execution_context = if self.futures.front().is_some_and(|&(queued_execution_id, _)| queued_execution_id == execution_id) {
|
||||||
let (_, execution_context) = self.futures.pop_front().expect("front was just matched");
|
let (_, execution_context) = self.futures.pop_front().expect("front was just matched");
|
||||||
|
self.last_execution_context = Some((execution_id, execution_context.clone()));
|
||||||
execution_context
|
execution_context
|
||||||
} else {
|
} else {
|
||||||
panic!("InvalidGenerationId")
|
// A runtime-replayed response re-uses an already consumed id; only plain renders may re-apply.
|
||||||
|
match &self.last_execution_context {
|
||||||
|
Some((last_execution_id, execution_context)) if *last_execution_id == execution_id => {
|
||||||
|
if execution_context.export_config.is_some() || execution_context.measure_fill.is_some() {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
execution_context.clone()
|
||||||
|
}
|
||||||
|
_ => panic!("InvalidGenerationId"),
|
||||||
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
// TODO: Eventually remove this document upgrade code
|
// TODO: Eventually remove this document upgrade code
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ use graphene_std::ops::ConvertAsync;
|
|||||||
use graphene_std::platform_application_io::canvas_utils::{Canvas, CanvasSurface, CanvasSurfaceHandle};
|
use graphene_std::platform_application_io::canvas_utils::{Canvas, CanvasSurface, CanvasSurfaceHandle};
|
||||||
use graphene_std::raster_types::Raster;
|
use graphene_std::raster_types::Raster;
|
||||||
use graphene_std::renderer::{Render, RenderParams, RenderSvgSegmentList, SvgRender, SvgSegment};
|
use graphene_std::renderer::{Render, RenderParams, RenderSvgSegmentList, SvgRender, SvgSegment};
|
||||||
use graphene_std::runtime::{DynGraphRuntime, DynSpawner, GraphRuntime, NoopSpawner, RuntimeHandle};
|
use graphene_std::runtime::{DynGraphRuntime, DynNotifier, DynSpawner, GraphRuntime, RuntimeHandle, SourceFuture, Spawner};
|
||||||
use graphene_std::transform::RenderQuality;
|
use graphene_std::transform::RenderQuality;
|
||||||
use graphene_std::vector::Vector;
|
use graphene_std::vector::Vector;
|
||||||
use graphene_std::vector::style::RenderMode;
|
use graphene_std::vector::style::RenderMode;
|
||||||
@@ -43,6 +43,8 @@ pub struct NodeRuntime {
|
|||||||
update_thumbnails: bool,
|
update_thumbnails: bool,
|
||||||
#[expect(dead_code, reason = "read once the host wires a notifier onto the runtime")]
|
#[expect(dead_code, reason = "read once the host wires a notifier onto the runtime")]
|
||||||
graph_runtime: Arc<DynGraphRuntime>,
|
graph_runtime: Arc<DynGraphRuntime>,
|
||||||
|
/// The last plain render request, replayed when an async source completion marks the graph dirty.
|
||||||
|
last_render: Option<ExecutionRequest>,
|
||||||
|
|
||||||
editor_api: Arc<PlatformEditorApi>,
|
editor_api: Arc<PlatformEditorApi>,
|
||||||
resources: ResourceRegistry,
|
resources: ResourceRegistry,
|
||||||
@@ -122,9 +124,57 @@ impl NodeGraphUpdateSender for InternalNodeGraphUpdateSender {
|
|||||||
// TODO: Replace with `core::cell::LazyCell` (<https://doc.rust-lang.org/core/cell/struct.LazyCell.html>) or similar
|
// TODO: Replace with `core::cell::LazyCell` (<https://doc.rust-lang.org/core/cell/struct.LazyCell.html>) or similar
|
||||||
pub static NODE_RUNTIME: once_cell::sync::Lazy<Mutex<Option<NodeRuntime>>> = once_cell::sync::Lazy::new(|| Mutex::new(None));
|
pub static NODE_RUNTIME: once_cell::sync::Lazy<Mutex<Option<NodeRuntime>>> = once_cell::sync::Lazy::new(|| Mutex::new(None));
|
||||||
|
|
||||||
|
#[cfg(not(target_family = "wasm"))]
|
||||||
|
pub struct TokioSpawner(Option<tokio::runtime::Runtime>);
|
||||||
|
|
||||||
|
#[cfg(not(target_family = "wasm"))]
|
||||||
|
impl TokioSpawner {
|
||||||
|
pub fn new() -> Self {
|
||||||
|
Self(Some(tokio::runtime::Runtime::new().expect("Failed to start the async source runtime")))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(not(target_family = "wasm"))]
|
||||||
|
impl Default for TokioSpawner {
|
||||||
|
fn default() -> Self {
|
||||||
|
Self::new()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(not(target_family = "wasm"))]
|
||||||
|
impl Spawner for TokioSpawner {
|
||||||
|
fn spawn(&self, task: SourceFuture) {
|
||||||
|
self.0.as_ref().expect("runtime lives until drop").spawn(task);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Dropping a tokio runtime blocks on its tasks, which panics inside an async context; the tests drop
|
||||||
|
/// [`NodeRuntime`] from one, so shut down in the background instead.
|
||||||
|
#[cfg(not(target_family = "wasm"))]
|
||||||
|
impl Drop for TokioSpawner {
|
||||||
|
fn drop(&mut self) {
|
||||||
|
if let Some(runtime) = self.0.take() {
|
||||||
|
runtime.shutdown_background();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(target_family = "wasm")]
|
||||||
|
pub struct WasmSpawner;
|
||||||
|
|
||||||
|
#[cfg(target_family = "wasm")]
|
||||||
|
impl Spawner for WasmSpawner {
|
||||||
|
fn spawn(&self, task: SourceFuture) {
|
||||||
|
wasm_bindgen_futures::spawn_local(task);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
impl NodeRuntime {
|
impl NodeRuntime {
|
||||||
pub fn new(receiver: Receiver<GraphRuntimeRequest>, sender: Sender<NodeGraphUpdate>) -> Self {
|
pub fn new(receiver: Receiver<GraphRuntimeRequest>, sender: Sender<NodeGraphUpdate>) -> Self {
|
||||||
let spawner: Box<DynSpawner> = Box::new(NoopSpawner);
|
#[cfg(not(target_family = "wasm"))]
|
||||||
|
let spawner: Box<DynSpawner> = Box::new(TokioSpawner::new());
|
||||||
|
#[cfg(target_family = "wasm")]
|
||||||
|
let spawner: Box<DynSpawner> = Box::new(WasmSpawner);
|
||||||
let graph_runtime: Arc<DynGraphRuntime> = Arc::new(GraphRuntime::new(spawner));
|
let graph_runtime: Arc<DynGraphRuntime> = Arc::new(GraphRuntime::new(spawner));
|
||||||
let mut executor = DynamicExecutor::default();
|
let mut executor = DynamicExecutor::default();
|
||||||
executor.set_runtime(Arc::clone(&graph_runtime));
|
executor.set_runtime(Arc::clone(&graph_runtime));
|
||||||
@@ -138,6 +188,7 @@ impl NodeRuntime {
|
|||||||
resources: ResourceRegistry::default(),
|
resources: ResourceRegistry::default(),
|
||||||
update_thumbnails: true,
|
update_thumbnails: true,
|
||||||
graph_runtime: Arc::clone(&graph_runtime),
|
graph_runtime: Arc::clone(&graph_runtime),
|
||||||
|
last_render: None,
|
||||||
|
|
||||||
editor_api: PlatformEditorApi {
|
editor_api: PlatformEditorApi {
|
||||||
editor_preferences: Box::new(EditorPreferences::default()),
|
editor_preferences: Box::new(EditorPreferences::default()),
|
||||||
@@ -188,6 +239,10 @@ impl NodeRuntime {
|
|||||||
}
|
}
|
||||||
|
|
||||||
let for_export = execution_request.render_config.for_export;
|
let for_export = execution_request.render_config.for_export;
|
||||||
|
if !for_export {
|
||||||
|
self.last_render = Some(execution_request.clone());
|
||||||
|
}
|
||||||
|
|
||||||
execution = Some(request);
|
execution = Some(request);
|
||||||
|
|
||||||
// If we get an export request we always execute it immedeatly otherwise it could get deduplicated
|
// If we get an export request we always execute it immedeatly otherwise it could get deduplicated
|
||||||
@@ -207,6 +262,10 @@ impl NodeRuntime {
|
|||||||
eyedropper.render_config.pointer = execution.render_config.pointer;
|
eyedropper.render_config.pointer = execution.render_config.pointer;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if self.executor.take_dirty() && execution.is_none() {
|
||||||
|
execution = self.last_render.clone().map(GraphRuntimeRequest::ExecutionRequest);
|
||||||
|
}
|
||||||
|
|
||||||
let requests = [preferences, graph, eyedropper, execution].into_iter().flatten();
|
let requests = [preferences, graph, eyedropper, execution].into_iter().flatten();
|
||||||
|
|
||||||
for request in requests {
|
for request in requests {
|
||||||
@@ -582,6 +641,13 @@ pub(crate) fn replace_application_io(application_io: PlatformApplicationIo) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn set_completion_notifier(notifier: Arc<DynNotifier>) {
|
||||||
|
let node_runtime = NODE_RUNTIME.lock();
|
||||||
|
if let Some(node_runtime) = &*node_runtime {
|
||||||
|
node_runtime.graph_runtime.set_notifier(notifier);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
impl NodeRuntime {
|
impl NodeRuntime {
|
||||||
pub(crate) fn replace_application_io(&mut self, application_io: PlatformApplicationIo) {
|
pub(crate) fn replace_application_io(&mut self, application_io: PlatformApplicationIo) {
|
||||||
self.editor_api = PlatformEditorApi {
|
self.editor_api = PlatformEditorApi {
|
||||||
|
|||||||
@@ -10,18 +10,28 @@ use interpreted_executor::dynamic_executor::DynamicExecutor;
|
|||||||
use std::error::Error;
|
use std::error::Error;
|
||||||
use std::io::Cursor;
|
use std::io::Cursor;
|
||||||
use std::path::{Path, PathBuf};
|
use std::path::{Path, PathBuf};
|
||||||
|
use std::sync::mpsc::Receiver;
|
||||||
use std::time::Duration;
|
use std::time::Duration;
|
||||||
|
|
||||||
fn execute_to_final(executor: &DynamicExecutor, render_config: RenderConfig) -> Result<TaggedValue, Box<dyn Error>> {
|
const SOURCE_COMPLETION_TIMEOUT: Duration = Duration::from_secs(30);
|
||||||
match executor.execute(render_config)? {
|
|
||||||
GPoll::Final(value) => Ok(value),
|
fn execute_until_final(executor: &DynamicExecutor, render_config: RenderConfig, completion: &Receiver<()>) -> Result<TaggedValue, Box<dyn Error>> {
|
||||||
GPoll::Fallback(boxed) => {
|
loop {
|
||||||
let (value, error) = *boxed;
|
while completion.try_recv().is_ok() {}
|
||||||
log::warn!("Node graph evaluation reported an error alongside its fallback output: {error:?}");
|
match executor.execute(render_config)? {
|
||||||
Ok(value)
|
GPoll::Final(value) => return Ok(value),
|
||||||
|
GPoll::Fallback(boxed) => {
|
||||||
|
let (value, error) = *boxed;
|
||||||
|
log::warn!("Node graph evaluation reported an error alongside its fallback output: {error:?}");
|
||||||
|
return Ok(value);
|
||||||
|
}
|
||||||
|
GPoll::Partial(_) | GPoll::Pending => {
|
||||||
|
completion
|
||||||
|
.recv_timeout(SOURCE_COMPLETION_TIMEOUT)
|
||||||
|
.map_err(|_| format!("Timed out after {}s waiting for async sources to complete", SOURCE_COMPLETION_TIMEOUT.as_secs()))?;
|
||||||
|
}
|
||||||
|
GPoll::Error(error) => return Err(format!("Node graph evaluation failed: {error:?}").into()),
|
||||||
}
|
}
|
||||||
GPoll::Partial(_) | GPoll::Pending => Err("Node graph evaluation did not complete".into()),
|
|
||||||
GPoll::Error(error) => Err(format!("Node graph evaluation failed: {error:?}").into()),
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -52,6 +62,7 @@ pub fn export_document(
|
|||||||
scale: f64,
|
scale: f64,
|
||||||
(width, height): (Option<u32>, Option<u32>),
|
(width, height): (Option<u32>, Option<u32>),
|
||||||
transparent: bool,
|
transparent: bool,
|
||||||
|
completion: &Receiver<()>,
|
||||||
) -> Result<(), Box<dyn Error>> {
|
) -> Result<(), Box<dyn Error>> {
|
||||||
// Determine export format based on file type
|
// Determine export format based on file type
|
||||||
let export_format = match file_type {
|
let export_format = match file_type {
|
||||||
@@ -73,7 +84,7 @@ pub fn export_document(
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Execute the graph
|
// Execute the graph
|
||||||
let result = execute_to_final(executor, render_config)?;
|
let result = execute_until_final(executor, render_config, completion)?;
|
||||||
|
|
||||||
// Handle the result based on output type
|
// Handle the result based on output type
|
||||||
match result {
|
match result {
|
||||||
@@ -172,6 +183,7 @@ pub fn export_gif(
|
|||||||
scale: f64,
|
scale: f64,
|
||||||
(width, height): (Option<u32>, Option<u32>),
|
(width, height): (Option<u32>, Option<u32>),
|
||||||
animation: AnimationParams,
|
animation: AnimationParams,
|
||||||
|
completion: &Receiver<()>,
|
||||||
) -> Result<(), Box<dyn Error>> {
|
) -> Result<(), Box<dyn Error>> {
|
||||||
use image::codecs::gif::{GifEncoder, Repeat};
|
use image::codecs::gif::{GifEncoder, Repeat};
|
||||||
use image::{Frame, RgbaImage};
|
use image::{Frame, RgbaImage};
|
||||||
@@ -211,7 +223,7 @@ pub fn export_gif(
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Execute the graph for this frame
|
// Execute the graph for this frame
|
||||||
let result = execute_to_final(executor, render_config)?;
|
let result = execute_until_final(executor, render_config, completion)?;
|
||||||
|
|
||||||
// Extract RGBA data from result
|
// Extract RGBA data from result
|
||||||
let (data, img_width, img_height) = match result {
|
let (data, img_width, img_height) = match result {
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ use graph_craft::graphene_compiler::Compiler;
|
|||||||
use graph_craft::proto::ProtoNetwork;
|
use graph_craft::proto::ProtoNetwork;
|
||||||
use graph_craft::util::load_network;
|
use graph_craft::util::load_network;
|
||||||
use graphene_std::application_io::{ApplicationIo, NodeGraphUpdateMessage, NodeGraphUpdateSender};
|
use graphene_std::application_io::{ApplicationIo, NodeGraphUpdateMessage, NodeGraphUpdateSender};
|
||||||
use graphene_std::runtime::{DynGraphRuntime, DynSpawner, GraphRuntime, NoopSpawner, RuntimeHandle};
|
use graphene_std::runtime::{DynGraphRuntime, DynSpawner, GraphRuntime, RuntimeHandle, SourceFuture, Spawner};
|
||||||
use interpreted_executor::dynamic_executor::DynamicExecutor;
|
use interpreted_executor::dynamic_executor::DynamicExecutor;
|
||||||
use interpreted_executor::util::wrap_network_in_scope;
|
use interpreted_executor::util::wrap_network_in_scope;
|
||||||
use std::error::Error;
|
use std::error::Error;
|
||||||
@@ -28,6 +28,29 @@ impl NodeGraphUpdateSender for UpdateLogger {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
struct TokioSpawner(Option<tokio::runtime::Runtime>);
|
||||||
|
|
||||||
|
impl TokioSpawner {
|
||||||
|
fn new() -> Self {
|
||||||
|
Self(Some(tokio::runtime::Runtime::new().expect("Failed to start the async source runtime")))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Spawner for TokioSpawner {
|
||||||
|
fn spawn(&self, task: SourceFuture) {
|
||||||
|
self.0.as_ref().expect("runtime lives until drop").spawn(task);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Dropping a tokio runtime blocks on its tasks, which panics inside the async main; shut down in the background instead.
|
||||||
|
impl Drop for TokioSpawner {
|
||||||
|
fn drop(&mut self) {
|
||||||
|
if let Some(runtime) = self.0.take() {
|
||||||
|
runtime.shutdown_background();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[derive(Debug, Parser)]
|
#[derive(Debug, Parser)]
|
||||||
#[clap(name = "graphene-cli", version)]
|
#[clap(name = "graphene-cli", version)]
|
||||||
pub struct App {
|
pub struct App {
|
||||||
@@ -179,7 +202,11 @@ fn main() -> Result<(), Box<dyn Error>> {
|
|||||||
let preferences = EditorPreferences {
|
let preferences = EditorPreferences {
|
||||||
max_render_region_size: EditorPreferences::default().max_render_region_size,
|
max_render_region_size: EditorPreferences::default().max_render_region_size,
|
||||||
};
|
};
|
||||||
let graph_runtime: Arc<DynGraphRuntime> = Arc::new(GraphRuntime::new(Box::new(NoopSpawner) as Box<DynSpawner>));
|
let graph_runtime: Arc<DynGraphRuntime> = Arc::new(GraphRuntime::new(Box::new(TokioSpawner::new()) as Box<DynSpawner>));
|
||||||
|
let (completion_sender, completion_receiver) = std::sync::mpsc::channel();
|
||||||
|
graph_runtime.set_notifier(Arc::new(move || {
|
||||||
|
let _ = completion_sender.send(());
|
||||||
|
}));
|
||||||
let editor_api = Arc::new(PlatformEditorApi {
|
let editor_api = Arc::new(PlatformEditorApi {
|
||||||
application_io: Some(application_io_for_api),
|
application_io: Some(application_io_for_api),
|
||||||
node_graph_message_sender: Box::new(UpdateLogger {}),
|
node_graph_message_sender: Box::new(UpdateLogger {}),
|
||||||
@@ -226,9 +253,9 @@ fn main() -> Result<(), Box<dyn Error>> {
|
|||||||
// Perform export based on file type
|
// Perform export based on file type
|
||||||
if file_type == export::FileType::Gif {
|
if file_type == export::FileType::Gif {
|
||||||
let animation = export::AnimationParams::new(fps, frames, duration);
|
let animation = export::AnimationParams::new(fps, frames, duration);
|
||||||
export::export_gif(&executor, wgpu_executor_ref.clone(), output, scale, (width, height), animation)?;
|
export::export_gif(&executor, wgpu_executor_ref.clone(), output, scale, (width, height), animation, &completion_receiver)?;
|
||||||
} else {
|
} else {
|
||||||
export::export_document(&executor, wgpu_executor_ref.clone(), output, file_type, scale, (width, height), transparent)?;
|
export::export_document(&executor, wgpu_executor_ref.clone(), output, file_type, scale, (width, height), transparent, &completion_receiver)?;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
_ => unreachable!("All other commands should be handled before this match statement is run"),
|
_ => unreachable!("All other commands should be handled before this match statement is run"),
|
||||||
|
|||||||
Reference in New Issue
Block a user