librashader-runtime-gl 0.11.4

use crate::binding::{GlUniformStorage, UniformLocation, VariableLocation};
use crate::error::FilterChainError;
use crate::filter_pass::{FilterPass, UniformOffset};
use crate::gl::state::EnterFixedFunctionState;
use crate::gl::{
    CompileProgram, DrawQuad, FramebufferInterface, GLFramebuffer, GLInterface, LoadLut,
    OutputFramebuffer, UboRing,
};
use crate::options::{FilterChainOptionsGL, FrameOptionsGL};
use crate::samplers::SamplerSet;
use crate::texture::InputTexture;
use crate::util::{gl_get_version, gl_u16_to_version};
use crate::{error, GLImage};
use librashader_common::Viewport;

use librashader_reflect::back::glsl::GlslVersion;
use librashader_reflect::back::targets::GLSL;
use librashader_reflect::back::{CompileReflectShader, CompileShader};
use librashader_reflect::front::SpirvCompilation;
use librashader_reflect::reflect::semantics::{ShaderSemantics, UniformMeta};

use glow::HasContext;
use librashader_cache::CachedCompilation;
use librashader_common::map::FastHashMap;
use librashader_pack::{PassResource, ShaderPresetPack, TextureResource};
use librashader_reflect::reflect::cross::SpirvCross;
use librashader_reflect::reflect::presets::{CompilePresetTarget, ShaderPassArtifact};
use librashader_reflect::reflect::ReflectShader;
use librashader_runtime::binding::BindingUtil;
use librashader_runtime::framebuffer::{FramebufferInit, FramebufferPool};
use librashader_runtime::quad::QuadType;
use librashader_runtime::render_target::RenderTarget;
use librashader_runtime::scaling::ScaleFramebuffer;

use std::collections::VecDeque;
use std::sync::Arc;

pub(crate) struct FilterChainImpl<T: GLInterface> {
    pub(crate) common: FilterCommon,
    passes: Box<[FilterPass<T>]>,
    draw_quad: T::DrawQuad,
    output_framebuffers: FramebufferPool<GLFramebuffer>,
    feedback_framebuffers: FramebufferPool<GLFramebuffer>,
    history_framebuffers: VecDeque<GLFramebuffer>,
    render_target: OutputFramebuffer,
    default_options: FrameOptionsGL,
    draw_last_pass_feedback: bool,
}

#[derive(Copy, Clone)]
pub(crate) struct GLCaps {
    pub framebuffer_srgb: bool,
    pub primitive_restart: bool,
}

pub(crate) struct FilterCommon {
    // semantics: ReflectSemantics,
    pub config: RuntimeParameters,
    pub luts: FastHashMap<usize, InputTexture>,
    pub samplers: SamplerSet,
    pub output_textures: Box<[InputTexture]>,
    pub feedback_textures: Box<[InputTexture]>,
    pub history_textures: Box<[InputTexture]>,
    pub disable_mipmaps: bool,
    pub caps: GLCaps,
    pub context: Arc<glow::Context>,
}

impl<T: GLInterface> FilterChainImpl<T> {
    fn reflect_uniform_location(
        ctx: &glow::Context,
        pipeline: glow::Program,
        meta: &dyn UniformMeta,
    ) -> VariableLocation {
        let mut location = VariableLocation {
            ubo: None,
            push: None,
        };

        let offset = meta.offset();

        if offset.ubo.is_some() {
            let vert_name = format!("LIBRA_UBO_VERTEX_INSTANCE.{}", meta.id());
            let frag_name = format!("LIBRA_UBO_FRAGMENT_INSTANCE.{}", meta.id());
            unsafe {
                let vertex = ctx.get_uniform_location(pipeline, &vert_name);
                let fragment = ctx.get_uniform_location(pipeline, &frag_name);
                location.ubo = Some(UniformLocation { vertex, fragment })
            }
        }

        if offset.push.is_some() {
            let vert_name = format!("LIBRA_PUSH_VERTEX_INSTANCE.{}", meta.id());
            let frag_name = format!("LIBRA_PUSH_FRAGMENT_INSTANCE.{}", meta.id());
            unsafe {
                let vertex = ctx.get_uniform_location(pipeline, &vert_name);
                let fragment = ctx.get_uniform_location(pipeline, &frag_name);
                location.push = Some(UniformLocation { vertex, fragment })
            }
        }

        location
    }
}

mod compile {
    use super::*;

    #[cfg(feature = "nightly")]
    pub type ShaderPassMeta =
        ShaderPassArtifact<impl CompileReflectShader<GLSL, SpirvCompilation, SpirvCross>>;

    #[cfg(not(feature = "nightly"))]
    pub type ShaderPassMeta = ShaderPassArtifact<
        Box<dyn CompileReflectShader<GLSL, SpirvCompilation, SpirvCross> + Send>,
    >;

    #[cfg_attr(feature = "nightly", define_opaque(ShaderPassMeta))]
    pub fn compile_passes(
        shaders: Vec<PassResource>,
        textures: &[TextureResource],
        disable_cache: bool,
    ) -> Result<(Vec<ShaderPassMeta>, ShaderSemantics), FilterChainError> {
        let (passes, semantics) = if !disable_cache {
            GLSL::compile_preset_passes::<
                CachedCompilation<SpirvCompilation>,
                SpirvCross,
                FilterChainError,
            >(shaders, textures.iter().map(|t| &t.meta))?
        } else {
            GLSL::compile_preset_passes::<SpirvCompilation, SpirvCross, FilterChainError>(
                shaders,
                textures.iter().map(|t| &t.meta),
            )?
        };

        Ok((passes, semantics))
    }
}

use compile::{compile_passes, ShaderPassMeta};
use librashader_runtime::parameters::RuntimeParameters;

impl<T: GLInterface> FilterChainImpl<T> {
    /// Load a filter chain from a pre-parsed `ShaderPreset`.
    pub(crate) unsafe fn load_from_pack(
        preset: ShaderPresetPack,
        context: Arc<glow::Context>,
        options: Option<&FilterChainOptionsGL>,
    ) -> error::Result<Self> {
        let config = RuntimeParameters::new(&preset);
        let disable_cache = options.map_or(false, |o| o.disable_cache);
        let (passes, semantics) = compile_passes(preset.passes, &preset.textures, disable_cache)?;
        let version = options.map_or_else(
            || gl_get_version(&context),
            |o| gl_u16_to_version(&context, o.glsl_version),
        );

        // initialize passes
        let filters = Self::init_passes(&context, version, passes, &semantics, disable_cache)?;

        let default_filter = filters.first().map(|f| f.meta.filter).unwrap_or_default();
        let default_wrap = filters
            .first()
            .map(|f| f.meta.wrap_mode)
            .unwrap_or_default();

        fn version_at_least(version: &glow::Version, major: u32, minor: u32) -> bool {
            version.major > major || (version.major == major && version.minor >= minor)
        }

        let gl_version = context.version();
        let extensions = context.supported_extensions();
        let caps = GLCaps {
            framebuffer_srgb: if !gl_version.is_embedded {
                gl_version.major >= 3
            } else {
                extensions.contains("GL_EXT_sRGB_write_control")
            },
            primitive_restart: !gl_version.is_embedded && version_at_least(gl_version, 3, 1),
        };

        let samplers = SamplerSet::new(&context)?;

        // load luts
        let luts = T::LoadLut::load_luts(&context, preset.textures)?;

        let framebuffer_gen = || T::FramebufferInterface::new(&context, 1);
        let input_gen = || InputTexture {
            image: Default::default(),
            filter: default_filter,
            mip_filter: default_filter,
            wrap_mode: default_wrap,
        };

        let framebuffer_init = FramebufferInit::new(
            filters.iter().map(|f| &f.reflection.meta),
            &framebuffer_gen,
            &input_gen,
        );

        // initialize output framebuffers
        let (output_framebuffers, output_textures) = framebuffer_init.init_output_framebuffers()?;

        // initialize feedback framebuffers
        let (feedback_framebuffers, feedback_textures) = framebuffer_init.init_feedback_framebuffers()?;

        // initialize history
        let (history_framebuffers, history_textures) = framebuffer_init.init_history()?;

        // create vertex objects
        let draw_quad = T::DrawQuad::new(&context)?;

        let render_target = OutputFramebuffer::new(&context);

        Ok(FilterChainImpl {
            draw_last_pass_feedback: framebuffer_init.uses_final_pass_as_feedback(),
            passes: filters,
            output_framebuffers,
            feedback_framebuffers,
            history_framebuffers,
            draw_quad,
            common: FilterCommon {
                config,
                disable_mipmaps: options.map_or(false, |o| o.force_no_mipmaps),
                luts,
                samplers,
                output_textures,
                feedback_textures,
                history_textures,
                caps,
                context,
            },
            default_options: Default::default(),
            render_target,
        })
    }

    fn init_passes(
        context: &glow::Context,
        version: GlslVersion,
        passes: Vec<ShaderPassMeta>,
        semantics: &ShaderSemantics,
        disable_cache: bool,
    ) -> error::Result<Box<[FilterPass<T>]>> {
        let mut filters = Vec::new();

        // initialize passes
        for (index, (config, mut reflect)) in passes.into_iter().enumerate() {
            let reflection = reflect.reflect(index, semantics)?;
            let glsl = reflect.compile(version)?;

            let (program, ubo_location) =
                T::CompileShader::compile_program(context, glsl, !disable_cache)?;

            let ubo_ring = if let Some(ubo) = &reflection.ubo {
                let ring = T::UboRing::new(&context, ubo.size)?;
                Some(ring)
            } else {
                None
            };

            let uniform_storage = GlUniformStorage::new(
                reflection.ubo.as_ref().map_or(0, |ubo| ubo.size as usize),
                reflection
                    .push_constant
                    .as_ref()
                    .map_or(0, |push| push.size as usize),
            );

            let uniform_bindings = reflection.meta.create_binding_map(|param| {
                UniformOffset::new(
                    Self::reflect_uniform_location(&context, program, param),
                    param.offset(),
                )
            });

            filters.push(FilterPass {
                reflection,
                program,
                ubo_location,
                ubo_ring,
                uniform_storage,
                uniform_bindings,
                source: config.data,
                meta: config.meta,
            });
        }

        Ok(filters.into_boxed_slice())
    }

    fn push_history(&mut self, input: &GLImage) -> error::Result<()> {
        if let Some(mut back) = self.history_framebuffers.pop_back() {
            if back.size != input.size || (input.format != 0 && input.format != back.format) {
                // eprintln!("[history] resizing");
                T::FramebufferInterface::init(&mut back, input.size, input.format)?;
            }

            back.copy_from::<T::FramebufferInterface>(input)?;
            self.history_framebuffers.push_front(back)
        }

        Ok(())
    }

    /// Process a frame with the input image.
    ///
    /// When this frame returns, GL_FRAMEBUFFER is bound to 0.
    pub unsafe fn frame(
        &mut self,
        frame_count: usize,
        viewport: &Viewport<&GLImage>,
        input: &GLImage,
        options: Option<&FrameOptionsGL>,
    ) -> error::Result<()> {
        let state_gl = Arc::clone(&self.common.context);
        // Flags guard
        let flags = EnterFixedFunctionState::new(&state_gl, &self.common.caps);

        // limit number of passes to those enabled.
        let max = std::cmp::min(self.passes.len(), self.common.config.passes_enabled());
        let passes = &mut self.passes[0..max];

        if let Some(options) = options {
            if options.clear_history {
                for framebuffer in &self.history_framebuffers {
                    framebuffer.clear::<T::FramebufferInterface, true>()
                }
            }
        }

        if passes.is_empty() {
            return Ok(());
        }

        let options = options.unwrap_or(&self.default_options);

        // do not need to rebind FBO 0 here since first `draw` will
        // bind automatically.
        self.draw_quad
            .bind_vertices(&self.common.context, QuadType::Offscreen);

        let filter = passes[0].meta.filter;
        let wrap_mode = passes[0].meta.wrap_mode;

        // update history
        for (texture, fbo) in self
            .common
            .history_textures
            .iter_mut()
            .zip(self.history_framebuffers.iter())
        {
            texture.image = fbo.as_texture(filter, wrap_mode).image;
        }

        // shader_gl3: 2067
        let original = InputTexture {
            image: *input,
            filter,
            mip_filter: filter,
            wrap_mode,
        };

        let mut source = original;

        let passes_len = passes.len();

        // Refresh inputs for feedback textures.
        // Don't need to do this for outputs because they are yet to be bound.
        //
        // Feedback scaling + refresh must complete before drawing any pass, because
        // a pass may sample any pass's feedback image.
        <GLFramebuffer as ScaleFramebuffer<T::FramebufferInterface>>::scale_feedback_framebuffers(
            source.image.size,
            viewport.output.size,
            original.image.size,
            &mut self.feedback_framebuffers,
            passes,
            |index, pass, fbo| {
                self.common.feedback_textures[index].image =
                    fbo.as_texture(pass.meta.filter, pass.meta.wrap_mode).image;
                Ok(())
            },
        )?;

        self.draw_quad
            .bind_vertices(&self.common.context, QuadType::Offscreen);

        // rescale render buffers to ensure all bindings are valid, then draw each pass.
        <GLFramebuffer as ScaleFramebuffer<T::FramebufferInterface>>::scale_output_framebuffers(
            source.image.size,
            viewport.output.size,
            original.image.size,
            &mut self.output_framebuffers,
            passes,
            |index, pass, target, size| {
                source.filter = pass.meta.filter;
                source.mip_filter = pass.meta.filter;
                source.wrap_mode = pass.meta.wrap_mode;

                let is_last = index == passes_len - 1;

                if !is_last {
                    pass.draw(
                        index,
                        &self.common,
                        pass.meta.get_frame_count(frame_count),
                        options,
                        viewport,
                        &original,
                        &source,
                        RenderTarget::identity(target)?,
                        None,
                    )?;

                    let target = target.as_texture(pass.meta.filter, pass.meta.wrap_mode);
                    self.common.output_textures[index] = target;
                    source = target;
                    return Ok(());
                }

                self.draw_quad
                    .bind_vertices(&self.common.context, QuadType::Final);

                let final_viewport = self
                    .render_target
                    .ensure::<T::FramebufferInterface>(viewport.output)?;

                // When feedback is enabled, render the last pass to the intermediate
                // framebuffer first then render to the viewport with the OutputSize semantic
                // overridden to the FB scale.
                //
                // Shaders need to see the pass's declared scale rather than the viewport size,
                // or they won't render correctly for feedback.
                let output_size_override = if self.draw_last_pass_feedback {
                    pass.draw(
                        index,
                        &self.common,
                        pass.meta.get_frame_count(frame_count),
                        options,
                        viewport,
                        &original,
                        &source,
                        RenderTarget::viewport_with_output(target, viewport),
                        None,
                    )?;
                    Some(size)
                } else {
                    None
                };

                pass.draw(
                    index,
                    &self.common,
                    pass.meta.get_frame_count(frame_count),
                    options,
                    viewport,
                    &original,
                    &source,
                    RenderTarget::viewport_with_output(final_viewport, viewport),
                    output_size_override,
                )?;
                self.common.output_textures[index] = viewport
                    .output
                    .as_texture(pass.meta.filter, pass.meta.wrap_mode);
                Ok(())
            },
        )?;

        // swap feedback framebuffers with output
        for index in 0..passes_len {
            if self.feedback_framebuffers.contains(index) {
                std::mem::swap(&mut self.output_framebuffers[index], &mut self.feedback_framebuffers[index]);
            }
        }

        self.push_history(input)?;

        self.draw_quad.unbind_vertices(&self.common.context);

        drop(flags);

        Ok(())
    }
}