librashader_test/render/
wgpu.rs

1use crate::render::{CommonFrameOptions, RenderTest};
2use anyhow::anyhow;
3use image::RgbaImage;
4use librashader::runtime::wgpu::*;
5use librashader::runtime::{Size, Viewport};
6use librashader_runtime::image::{Image, UVDirection};
7use std::io::{Cursor, Write};
8use std::ops::DerefMut;
9use std::path::Path;
10use std::sync::Arc;
11use wgpu::{Adapter, Device, Instance, Queue, Texture};
12use wgpu_types::{
13    BufferAddress, BufferDescriptor, BufferUsages, CommandEncoderDescriptor, ImageCopyBuffer,
14    ImageDataLayout, Maintain, TextureDescriptor, TextureDimension, TextureFormat, TextureUsages,
15};
16
17use librashader::presets::ShaderPreset;
18use librashader::runtime::{FilterChainParameters, RuntimeParameters};
19use parking_lot::Mutex;
20
21pub struct Wgpu {
22    _instance: Instance,
23    _adapter: Adapter,
24    device: Arc<Device>,
25    queue: Arc<Queue>,
26    image: Image,
27    texture: Arc<Texture>,
28}
29
30struct BufferDimensions {
31    height: usize,
32    unpadded_bytes_per_row: usize,
33    padded_bytes_per_row: usize,
34}
35
36impl BufferDimensions {
37    fn new(width: usize, height: usize) -> Self {
38        let bytes_per_pixel = std::mem::size_of::<u32>();
39        let unpadded_bytes_per_row = width * bytes_per_pixel;
40        let align = wgpu::COPY_BYTES_PER_ROW_ALIGNMENT as usize;
41        let padded_bytes_per_row_padding = (align - unpadded_bytes_per_row % align) % align;
42        let padded_bytes_per_row = unpadded_bytes_per_row + padded_bytes_per_row_padding;
43        Self {
44            height,
45            unpadded_bytes_per_row,
46            padded_bytes_per_row,
47        }
48    }
49}
50
51impl RenderTest for Wgpu {
52    fn new(path: &Path) -> anyhow::Result<Self>
53    where
54        Self: Sized,
55    {
56        Wgpu::new(path)
57    }
58
59    fn image_size(&self) -> Size<u32> {
60        self.image.size
61    }
62
63    fn render_with_preset_and_params(
64        &mut self,
65        preset: ShaderPreset,
66        frame_count: usize,
67        output_size: Option<Size<u32>>,
68        param_setter: Option<&dyn Fn(&RuntimeParameters)>,
69        frame_options: Option<CommonFrameOptions>,
70    ) -> anyhow::Result<image::RgbaImage> {
71        let mut chain = FilterChain::load_from_preset(
72            preset,
73            Arc::clone(&self.device),
74            Arc::clone(&self.queue),
75            Some(&FilterChainOptions {
76                force_no_mipmaps: false,
77                enable_cache: true,
78                adapter_info: None,
79            }),
80        )?;
81        if let Some(setter) = param_setter {
82            setter(&chain.parameters());
83        }
84        let mut cmd = self
85            .device
86            .create_command_encoder(&CommandEncoderDescriptor { label: None });
87
88        let output_tex = self.device.create_texture(&TextureDescriptor {
89            label: None,
90            size: output_size.map_or(self.texture.size(), |size| size.into()),
91            mip_level_count: 1,
92            sample_count: 1,
93            dimension: TextureDimension::D2,
94            format: TextureFormat::Rgba8Unorm,
95            usage: TextureUsages::RENDER_ATTACHMENT | TextureUsages::COPY_SRC,
96            view_formats: &[wgpu::TextureFormat::Rgba8Unorm],
97        });
98
99        let buffer_dimensions =
100            BufferDimensions::new(output_tex.width() as usize, output_tex.height() as usize);
101        let output_buf = Arc::new(self.device.create_buffer(&BufferDescriptor {
102            label: None,
103            size: (buffer_dimensions.padded_bytes_per_row * buffer_dimensions.height)
104                as BufferAddress, // 4bpp
105            usage: BufferUsages::COPY_DST | BufferUsages::MAP_READ,
106            mapped_at_creation: false,
107        }));
108
109        let view = output_tex.create_view(&wgpu::TextureViewDescriptor::default());
110        let output = WgpuOutputView::new_from_raw(
111            &view,
112            output_tex.size().into(),
113            TextureFormat::Rgba8Unorm,
114        );
115
116        let viewport = Viewport::new_render_target_sized_origin(output, None)?;
117        let options = frame_options.map(|options| FrameOptions {
118            clear_history: options.clear_history,
119            frame_direction: options.frame_direction,
120            rotation: options.rotation,
121            total_subframes: options.total_subframes,
122            current_subframe: options.current_subframe,
123            aspect_ratio: options.aspect_ratio,
124            frametime_delta: options.frametime_delta,
125            frames_per_second: options.frames_per_second,
126        });
127
128        for frame in 0..=frame_count {
129            chain.frame(
130                Arc::clone(&self.texture),
131                &viewport,
132                &mut cmd,
133                frame,
134                options.as_ref(),
135            )?;
136        }
137
138        cmd.copy_texture_to_buffer(
139            output_tex.as_image_copy(),
140            ImageCopyBuffer {
141                buffer: &output_buf,
142                layout: ImageDataLayout {
143                    offset: 0,
144                    bytes_per_row: Some(buffer_dimensions.padded_bytes_per_row as u32),
145                    rows_per_image: None,
146                },
147            },
148            output_tex.size(),
149        );
150
151        let si = self.queue.submit([cmd.finish()]);
152        self.device.poll(Maintain::WaitForSubmissionIndex(si));
153
154        let capturable = Arc::clone(&output_buf);
155
156        let pixels = Arc::new(Mutex::new(Vec::new()));
157
158        let pixels_async = Arc::clone(&pixels);
159        output_buf
160            .slice(..)
161            .map_async(wgpu::MapMode::Read, move |r| {
162                if r.is_ok() {
163                    let buffer = capturable.slice(..).get_mapped_range();
164                    let mut pixels = pixels_async.lock();
165                    pixels.resize(buffer.len(), 0);
166
167                    let mut cursor = Cursor::new(pixels.deref_mut());
168                    for chunk in buffer.chunks(buffer_dimensions.padded_bytes_per_row) {
169                        cursor
170                            .write_all(&chunk[..buffer_dimensions.unpadded_bytes_per_row])
171                            .unwrap()
172                    }
173
174                    cursor.into_inner();
175                }
176                capturable.unmap();
177            });
178
179        self.device.poll(Maintain::Wait);
180
181        if pixels.lock().len() == 0 {
182            return Err(anyhow!("failed to copy pixels from buffer"));
183        }
184
185        let image = RgbaImage::from_raw(
186            output_tex.width(),
187            output_tex.height(),
188            pixels.lock().to_vec(),
189        )
190        .ok_or(anyhow!("Unable to create image from data"))?;
191
192        Ok(image)
193    }
194}
195
196impl Wgpu {
197    pub fn new(image: &Path) -> anyhow::Result<Self> {
198        pollster::block_on(async {
199            let instance = wgpu::Instance::default();
200            let adapter = instance
201                .request_adapter(&wgpu::RequestAdapterOptions {
202                    power_preference: wgpu::PowerPreference::default(),
203                    compatible_surface: None,
204                    force_fallback_adapter: false,
205                })
206                .await
207                .ok_or(anyhow!("Couldn't request WGPU adapter"))?;
208
209            let (device, queue) = adapter
210                .request_device(
211                    &wgpu::DeviceDescriptor {
212                        required_features: wgpu::Features::ADDRESS_MODE_CLAMP_TO_BORDER
213                            | wgpu::Features::PIPELINE_CACHE
214                            | wgpu::Features::TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES
215                            | wgpu::Features::FLOAT32_FILTERABLE,
216                        required_limits: wgpu::Limits::default(),
217                        label: None,
218                        memory_hints: Default::default(),
219                    },
220                    None,
221                )
222                .await?;
223            let (image, texture) = Self::load_image(&device, &queue, image)?;
224
225            Ok(Self {
226                _instance: instance,
227                _adapter: adapter,
228                device: Arc::new(device),
229                queue: Arc::new(queue),
230                image: image,
231                texture: Arc::new(texture),
232            })
233        })
234    }
235
236    fn load_image(device: &Device, queue: &Queue, path: &Path) -> anyhow::Result<(Image, Texture)> {
237        let image = Image::load(path, UVDirection::TopLeft)?;
238        let texture = device.create_texture(&TextureDescriptor {
239            size: image.size.into(),
240            mip_level_count: 1,
241            sample_count: 1,
242            dimension: TextureDimension::D2,
243            usage: TextureUsages::TEXTURE_BINDING | TextureUsages::COPY_DST,
244            format: wgpu::TextureFormat::Rgba8Unorm,
245            view_formats: &[wgpu::TextureFormat::Rgba8Unorm],
246            label: None,
247        });
248
249        queue.write_texture(
250            wgpu::ImageCopyTexture {
251                texture: &texture,
252                mip_level: 0,
253                origin: wgpu::Origin3d::ZERO,
254                aspect: wgpu::TextureAspect::All,
255            },
256            &image.bytes,
257            wgpu::ImageDataLayout {
258                offset: 0,
259                bytes_per_row: Some(4 * image.size.width),
260                rows_per_image: None,
261            },
262            image.size.into(),
263        );
264
265        let si = queue.submit([]);
266
267        device.poll(Maintain::WaitForSubmissionIndex(si));
268
269        Ok((image, texture))
270    }
271}
librashader_test/render/wgpu.rs

librashader_test/render/
wgpu.rs
