ruffle/render/wgpu/src/surface.rs

mod commands;
pub mod target;

use crate::backend::RenderTargetMode;
use crate::blend::ComplexBlend;
use crate::buffer_pool::TexturePool;
use crate::mesh::Mesh;
use crate::surface::commands::{chunk_blends, Chunk, CommandRenderer};
use crate::utils::{remove_srgb, supported_sample_count};
use crate::{
    ColorAdjustments, Descriptors, FilterVertex, MaskState, Pipelines, Transforms, UniformBuffer,
};
use ruffle_render::commands::CommandList;
use ruffle_render::filters::Filter;
use ruffle_render::quality::StageQuality;
use std::sync::Arc;
use swf::{BlurFilter, ColorMatrixFilter};
use target::CommandTarget;
use tracing::instrument;
use wgpu::util::DeviceExt;

use crate::utils::run_copy_pipeline;

pub use crate::surface::commands::LayerRef;

#[derive(Debug)]
pub struct Surface {
    size: wgpu::Extent3d,
    quality: StageQuality,
    sample_count: u32,
    pipelines: Arc<Pipelines>,
    format: wgpu::TextureFormat,
    actual_surface_format: wgpu::TextureFormat,
}

impl Surface {
    pub fn new(
        descriptors: &Descriptors,
        quality: StageQuality,
        width: u32,
        height: u32,
        surface_format: wgpu::TextureFormat,
    ) -> Self {
        let size = wgpu::Extent3d {
            width,
            height,
            depth_or_array_layers: 1,
        };
        let frame_buffer_format = remove_srgb(surface_format);

        let sample_count =
            supported_sample_count(&descriptors.adapter, quality, frame_buffer_format);
        let pipelines = descriptors.pipelines(sample_count, frame_buffer_format);
        Self {
            size,
            quality,
            sample_count,
            pipelines,
            format: frame_buffer_format,
            actual_surface_format: surface_format,
        }
    }

    #[allow(clippy::too_many_arguments)]
    #[instrument(level = "debug", skip_all)]
    pub fn draw_commands_and_copy_to<'frame, 'global: 'frame>(
        &mut self,
        frame_view: &wgpu::TextureView,
        render_target_mode: RenderTargetMode,
        descriptors: &'global Descriptors,
        uniform_buffers: &'frame mut UniformBuffer<'global, Transforms>,
        color_buffers: &'frame mut UniformBuffer<'global, ColorAdjustments>,
        uniform_encoder: &'frame mut wgpu::CommandEncoder,
        draw_encoder: &'frame mut wgpu::CommandEncoder,
        meshes: &'global Vec<Mesh>,
        commands: CommandList,
        layer: LayerRef,
        texture_pool: &mut TexturePool,
    ) {
        let target = self.draw_commands(
            render_target_mode,
            descriptors,
            meshes,
            commands,
            uniform_buffers,
            color_buffers,
            uniform_encoder,
            draw_encoder,
            layer,
            texture_pool,
        );

        run_copy_pipeline(
            descriptors,
            self.format,
            self.actual_surface_format,
            self.size,
            frame_view,
            target.color_view(),
            target.whole_frame_bind_group(descriptors),
            target.globals(),
            1,
            draw_encoder,
        );
    }

    #[allow(clippy::too_many_arguments)]
    #[instrument(level = "debug", skip_all)]
    pub fn draw_commands<'frame, 'global: 'frame>(
        &mut self,
        render_target_mode: RenderTargetMode,
        descriptors: &'global Descriptors,
        meshes: &'global Vec<Mesh>,
        commands: CommandList,
        uniform_buffers: &'frame mut UniformBuffer<'global, Transforms>,
        color_buffers: &'frame mut UniformBuffer<'global, ColorAdjustments>,
        uniform_encoder: &'frame mut wgpu::CommandEncoder,
        draw_encoder: &'frame mut wgpu::CommandEncoder,
        nearest_layer: LayerRef<'frame>,
        texture_pool: &mut TexturePool,
    ) -> CommandTarget {
        let target = CommandTarget::new(
            descriptors,
            texture_pool,
            self.size,
            self.format,
            self.sample_count,
            render_target_mode,
            draw_encoder,
        );

        let mut num_masks = 0;
        let mut mask_state = MaskState::NoMask;
        let chunks = chunk_blends(
            commands.commands,
            descriptors,
            uniform_buffers,
            color_buffers,
            uniform_encoder,
            draw_encoder,
            meshes,
            self.quality,
            target.width(),
            target.height(),
            match nearest_layer {
                LayerRef::Current => LayerRef::Parent(&target),
                layer => layer,
            },
            texture_pool,
        );

        for chunk in chunks {
            match chunk {
                Chunk::Draw(chunk, needs_depth) => {
                    let mut render_pass =
                        draw_encoder.begin_render_pass(&wgpu::RenderPassDescriptor {
                            label: create_debug_label!(
                                "Chunked draw calls {}",
                                if needs_depth {
                                    "(with depth)"
                                } else {
                                    "(Depthless)"
                                }
                            )
                            .as_deref(),
                            color_attachments: &[target.color_attachments()],
                            depth_stencil_attachment: if needs_depth {
                                target.depth_attachment(descriptors, texture_pool)
                            } else {
                                None
                            },
                        });
                    render_pass.set_bind_group(0, target.globals().bind_group(), &[]);
                    let mut renderer = CommandRenderer::new(
                        &self.pipelines,
                        descriptors,
                        uniform_buffers,
                        color_buffers,
                        uniform_encoder,
                        render_pass,
                        num_masks,
                        mask_state,
                        needs_depth,
                    );

                    for command in &chunk {
                        renderer.execute(command);
                    }

                    num_masks = renderer.num_masks();
                    mask_state = renderer.mask_state();
                }
                Chunk::Blend(texture, blend_mode, needs_depth) => {
                    let parent = match blend_mode {
                        ComplexBlend::Alpha | ComplexBlend::Erase => match nearest_layer {
                            LayerRef::None => {
                                // An Alpha or Erase with no Layer above it should be ignored
                                continue;
                            }
                            LayerRef::Current => &target,
                            LayerRef::Parent(layer) => layer,
                        },
                        _ => &target,
                    };

                    let parent_blend_buffer =
                        parent.update_blend_buffer(descriptors, texture_pool, draw_encoder);

                    let blend_bind_group =
                        descriptors
                            .device
                            .create_bind_group(&wgpu::BindGroupDescriptor {
                                label: create_debug_label!(
                                    "Complex blend binds {:?} {}",
                                    blend_mode,
                                    if needs_depth {
                                        "(with depth)"
                                    } else {
                                        "(Depthless)"
                                    }
                                )
                                .as_deref(),
                                layout: &descriptors.bind_layouts.blend,
                                entries: &[
                                    wgpu::BindGroupEntry {
                                        binding: 0,
                                        resource: wgpu::BindingResource::TextureView(
                                            parent_blend_buffer.view(),
                                        ),
                                    },
                                    wgpu::BindGroupEntry {
                                        binding: 1,
                                        resource: wgpu::BindingResource::TextureView(
                                            texture.view(),
                                        ),
                                    },
                                    wgpu::BindGroupEntry {
                                        binding: 2,
                                        resource: wgpu::BindingResource::Sampler(
                                            descriptors.bitmap_samplers.get_sampler(false, false),
                                        ),
                                    },
                                ],
                            });

                    let mut render_pass =
                        draw_encoder.begin_render_pass(&wgpu::RenderPassDescriptor {
                            label: create_debug_label!(
                                "Complex blend {:?} {}",
                                blend_mode,
                                if needs_depth {
                                    "(with depth)"
                                } else {
                                    "(Depthless)"
                                }
                            )
                            .as_deref(),
                            color_attachments: &[target.color_attachments()],
                            depth_stencil_attachment: if needs_depth {
                                target.depth_attachment(descriptors, texture_pool)
                            } else {
                                None
                            },
                        });
                    render_pass.set_bind_group(0, target.globals().bind_group(), &[]);

                    if needs_depth {
                        match mask_state {
                            MaskState::NoMask => {}
                            MaskState::DrawMaskStencil => {
                                render_pass.set_stencil_reference(num_masks - 1);
                            }
                            MaskState::DrawMaskedContent => {
                                render_pass.set_stencil_reference(num_masks);
                            }
                            MaskState::ClearMaskStencil => {
                                render_pass.set_stencil_reference(num_masks);
                            }
                        }
                        render_pass.set_pipeline(
                            self.pipelines.complex_blends[blend_mode].pipeline_for(mask_state),
                        );
                    } else {
                        render_pass.set_pipeline(
                            self.pipelines.complex_blends[blend_mode].depthless_pipeline(),
                        );
                    }

                    if descriptors.limits.max_push_constant_size > 0 {
                        render_pass.set_push_constants(
                            wgpu::ShaderStages::VERTEX,
                            0,
                            bytemuck::cast_slice(&[Transforms {
                                world_matrix: [
                                    [self.size.width as f32, 0.0, 0.0, 0.0],
                                    [0.0, self.size.height as f32, 0.0, 0.0],
                                    [0.0, 0.0, 1.0, 0.0],
                                    [0.0, 0.0, 0.0, 1.0],
                                ],
                            }]),
                        );
                        render_pass.set_bind_group(1, &blend_bind_group, &[]);
                    } else {
                        render_pass.set_bind_group(
                            1,
                            target.whole_frame_bind_group(descriptors),
                            &[0],
                        );
                        render_pass.set_bind_group(2, &blend_bind_group, &[]);
                    }

                    render_pass.set_vertex_buffer(0, descriptors.quad.vertices_pos.slice(..));
                    render_pass.set_index_buffer(
                        descriptors.quad.indices.slice(..),
                        wgpu::IndexFormat::Uint32,
                    );

                    render_pass.draw_indexed(0..6, 0, 0..1);
                    drop(render_pass);
                }
            }
        }

        // If nothing happened, ensure it's cleared so we don't operate on garbage data
        target.ensure_cleared(draw_encoder);

        target
    }

    pub fn quality(&self) -> StageQuality {
        self.quality
    }

    pub fn sample_count(&self) -> u32 {
        self.sample_count
    }

    pub fn size(&self) -> wgpu::Extent3d {
        self.size
    }

    #[allow(clippy::too_many_arguments)]
    pub fn apply_filter(
        &self,
        descriptors: &Descriptors,
        draw_encoder: &mut wgpu::CommandEncoder,
        texture_pool: &mut TexturePool,
        source_texture: &wgpu::Texture,
        source_point: (u32, u32),
        source_size: (u32, u32),
        filter: Filter,
    ) -> CommandTarget {
        let target = match filter {
            Filter::ColorMatrixFilter(filter) => self.apply_color_matrix(
                descriptors,
                texture_pool,
                draw_encoder,
                source_texture,
                source_point,
                source_size,
                &filter,
            ),
            Filter::BlurFilter(filter) => self.apply_blur(
                descriptors,
                texture_pool,
                draw_encoder,
                source_texture,
                source_point,
                source_size,
                &filter,
            ),
            _ => {
                tracing::warn!("Unsupported filter {filter:?}");
                // Apply a default color matrix - it's essentially a blit
                self.apply_color_matrix(
                    descriptors,
                    texture_pool,
                    draw_encoder,
                    source_texture,
                    source_point,
                    source_size,
                    &Default::default(),
                )
            }
        };

        // We're about to perform a copy, so make sure that we've applied
        // a clear (in case no other draw commands were issued, we still need
        // the background clear color applied)
        target.ensure_cleared(draw_encoder);
        target
    }

    #[allow(clippy::too_many_arguments)]
    pub fn apply_color_matrix(
        &self,
        descriptors: &Descriptors,
        texture_pool: &mut TexturePool,
        draw_encoder: &mut wgpu::CommandEncoder,
        source_texture: &wgpu::Texture,
        source_point: (u32, u32),
        source_size: (u32, u32),
        filter: &ColorMatrixFilter,
    ) -> CommandTarget {
        let target = CommandTarget::new(
            descriptors,
            texture_pool,
            wgpu::Extent3d {
                width: source_size.0,
                height: source_size.1,
                depth_or_array_layers: 1,
            },
            self.format,
            self.sample_count,
            RenderTargetMode::FreshWithColor(wgpu::Color::TRANSPARENT),
            draw_encoder,
        );
        let source_view = source_texture.create_view(&Default::default());
        let buffer = descriptors
            .device
            .create_buffer_init(&wgpu::util::BufferInitDescriptor {
                label: create_debug_label!("Filter arguments").as_deref(),
                contents: bytemuck::cast_slice(&filter.matrix),
                usage: wgpu::BufferUsages::UNIFORM,
            });
        let vertices = create_filter_vertices(
            &descriptors.device,
            source_texture,
            source_point,
            source_size,
        );
        let filter_group = descriptors
            .device
            .create_bind_group(&wgpu::BindGroupDescriptor {
                label: create_debug_label!("Filter group").as_deref(),
                layout: &descriptors.bind_layouts.color_matrix_filter,
                entries: &[
                    wgpu::BindGroupEntry {
                        binding: 0,
                        resource: wgpu::BindingResource::TextureView(&source_view),
                    },
                    wgpu::BindGroupEntry {
                        binding: 1,
                        resource: wgpu::BindingResource::Sampler(
                            descriptors.bitmap_samplers.get_sampler(false, false),
                        ),
                    },
                    wgpu::BindGroupEntry {
                        binding: 2,
                        resource: buffer.as_entire_binding(),
                    },
                ],
            });
        let mut render_pass = draw_encoder.begin_render_pass(&wgpu::RenderPassDescriptor {
            label: create_debug_label!("Color matrix filter").as_deref(),
            color_attachments: &[target.color_attachments()],
            depth_stencil_attachment: None,
        });
        render_pass.set_pipeline(&self.pipelines.color_matrix_filter);

        render_pass.set_bind_group(0, &filter_group, &[]);

        render_pass.set_vertex_buffer(0, vertices.slice(..));
        render_pass.set_index_buffer(
            descriptors.quad.indices.slice(..),
            wgpu::IndexFormat::Uint32,
        );
        render_pass.draw_indexed(0..6, 0, 0..1);
        drop(render_pass);
        target
    }

    #[allow(clippy::too_many_arguments)]
    pub fn apply_blur(
        &self,
        descriptors: &Descriptors,
        texture_pool: &mut TexturePool,
        draw_encoder: &mut wgpu::CommandEncoder,
        source_texture: &wgpu::Texture,
        source_point: (u32, u32),
        source_size: (u32, u32),
        filter: &BlurFilter,
    ) -> CommandTarget {
        // FIXME - this should be larger than the source texture. Figure out exactly how much larger
        let targets = [
            CommandTarget::new(
                descriptors,
                texture_pool,
                wgpu::Extent3d {
                    width: source_size.0,
                    height: source_size.1,
                    depth_or_array_layers: 1,
                },
                self.format,
                self.sample_count,
                RenderTargetMode::FreshWithColor(wgpu::Color::TRANSPARENT),
                draw_encoder,
            ),
            CommandTarget::new(
                descriptors,
                texture_pool,
                wgpu::Extent3d {
                    width: source_size.0,
                    height: source_size.1,
                    depth_or_array_layers: 1,
                },
                self.format,
                self.sample_count,
                RenderTargetMode::FreshWithColor(wgpu::Color::TRANSPARENT),
                draw_encoder,
            ),
        ];

        // TODO: Vertices should be per pass, and each pass needs diff sizes
        let vertices = create_filter_vertices(
            &descriptors.device,
            source_texture,
            source_point,
            source_size,
        );

        let source_view = source_texture.create_view(&Default::default());
        for i in 0..2 {
            let blur_x = (filter.blur_x.to_f32() - 1.0).max(0.0);
            let blur_y = (filter.blur_y.to_f32() - 1.0).max(0.0);
            let current = &targets[i % 2];
            let (previous_view, previous_vertices, previous_width, previous_height) = if i == 0 {
                (
                    &source_view,
                    vertices.slice(..),
                    source_texture.width() as f32,
                    source_texture.height() as f32,
                )
            } else {
                let previous = &targets[(i - 1) % 2];
                (
                    previous.color_view(),
                    descriptors.quad.filter_vertices.slice(..),
                    previous.width() as f32,
                    previous.height() as f32,
                )
            };
            let buffer = descriptors
                .device
                .create_buffer_init(&wgpu::util::BufferInitDescriptor {
                    label: create_debug_label!("Filter arguments").as_deref(),
                    contents: bytemuck::cast_slice(&[
                        blur_x * ((i as u32) % 2) as f32,
                        blur_y * (((i as u32) % 2) + 1) as f32,
                        previous_width,
                        previous_height,
                    ]),
                    usage: wgpu::BufferUsages::UNIFORM,
                });
            let filter_group = descriptors
                .device
                .create_bind_group(&wgpu::BindGroupDescriptor {
                    label: create_debug_label!("Filter group").as_deref(),
                    layout: &descriptors.bind_layouts.blur_filter,
                    entries: &[
                        wgpu::BindGroupEntry {
                            binding: 0,
                            resource: wgpu::BindingResource::TextureView(previous_view),
                        },
                        wgpu::BindGroupEntry {
                            binding: 1,
                            resource: wgpu::BindingResource::Sampler(
                                descriptors.bitmap_samplers.get_sampler(false, true),
                            ),
                        },
                        wgpu::BindGroupEntry {
                            binding: 2,
                            resource: buffer.as_entire_binding(),
                        },
                    ],
                });
            let mut render_pass = draw_encoder.begin_render_pass(&wgpu::RenderPassDescriptor {
                label: create_debug_label!("Blur filter").as_deref(),
                color_attachments: &[current.color_attachments()],
                depth_stencil_attachment: None,
            });
            render_pass.set_pipeline(&self.pipelines.blur_filter);

            render_pass.set_bind_group(0, &filter_group, &[]);

            render_pass.set_vertex_buffer(0, previous_vertices);
            render_pass.set_index_buffer(
                descriptors.quad.indices.slice(..),
                wgpu::IndexFormat::Uint32,
            );
            render_pass.draw_indexed(0..6, 0, 0..1);
        }

        targets
            .into_iter()
            .last()
            .expect("Targets should not be empty")
    }
}

fn create_filter_vertices(
    device: &wgpu::Device,
    source_texture: &wgpu::Texture,
    source_point: (u32, u32),
    source_size: (u32, u32),
) -> wgpu::Buffer {
    let source_width = source_texture.width() as f32;
    let source_height = source_texture.height() as f32;
    let left = source_point.0;
    let top = source_point.1;
    let right = left + source_size.0;
    let bottom = top + source_size.1;
    device.create_buffer_init(&wgpu::util::BufferInitDescriptor {
        label: create_debug_label!("Filter vertices").as_deref(),
        contents: bytemuck::cast_slice(&[
            FilterVertex {
                position: [0.0, 0.0],
                uv: [left as f32 / source_width, top as f32 / source_height],
            },
            FilterVertex {
                position: [1.0, 0.0],
                uv: [right as f32 / source_width, top as f32 / source_height],
            },
            FilterVertex {
                position: [1.0, 1.0],
                uv: [right as f32 / source_width, bottom as f32 / source_height],
            },
            FilterVertex {
                position: [0.0, 1.0],
                uv: [left as f32 / source_width, bottom as f32 / source_height],
            },
        ]),
        usage: wgpu::BufferUsages::VERTEX,
    })
}