Merge pull request #37 from SnowflakePowered/preset-context

Preset context

librashader-build-script/Cargo.toml

@@ -7,7 +7,7 @@ publish = false
 
 [dependencies]
 cbindgen = "0.26.0"
-clap = { version = "4.1.0", features = ["derive"] }
+clap = { version = "=4.1.0", features = ["derive"] }
 
 
 [package.metadata.release]

librashader-build-script/src/main.rs

@@ -73,8 +73,7 @@ pub fn main() {
             let ext = ext.replace("_capi", "");
             fs::rename(output_dir.join(artifact), output_dir.join(ext)).unwrap();
         }
-    }
-    else if cfg!(target_family = "unix") {
+    } else if cfg!(target_family = "unix") {
         let artifacts = &["liblibrashader_capi.so", "liblibrashader_capi.a"];
         for artifact in artifacts {
             let ext = artifact.strip_prefix("lib").unwrap();

librashader-cache/Cargo.toml

@@ -2,7 +2,7 @@
 name = "librashader-cache"
 edition = "2021"
 license = "MPL-2.0 OR GPL-3.0-only"
-version = "0.2.0-beta.7"
+version = "0.2.0-beta.8"
 authors = ["Ronny Chan <ronny@ronnychan.ca>"]
 repository = "https://github.com/SnowflakePowered/librashader"
 readme = "../README.md"
@@ -12,8 +12,8 @@ description = "RetroArch shaders for all."
 
 [dependencies]
 serde = { version = "1.0" }
-librashader-reflect = { path = "../librashader-reflect", version = "0.2.0-beta.7", features = ["serialize"] }
-librashader-preprocess = { path = "../librashader-preprocess", version = "0.2.0-beta.7" }
+librashader-reflect = { path = "../librashader-reflect", version = "0.2.0-beta.8", features = ["serialize"] }
+librashader-preprocess = { path = "../librashader-preprocess", version = "0.2.0-beta.8" }
 platform-dirs = "0.3.0"
 blake3 = { version = "1.3.3" }
 thiserror = "1.0.38"

librashader-capi/Cargo.toml

@@ -3,7 +3,7 @@ name = "librashader-capi"
 edition = "2021"
 
 license = "MPL-2.0 OR GPL-3.0-only"
-version = "0.2.0-beta.7"
+version = "0.2.0-beta.8"
 authors = ["Ronny Chan <ronny@ronnychan.ca>"]
 repository = "https://github.com/SnowflakePowered/librashader"
 readme = "../README.md"
@@ -23,7 +23,7 @@ runtime-d3d12 = ["windows", "librashader/runtime-d3d12", "windows/Win32_Graphics
 runtime-vulkan = ["ash", "librashader/runtime-vk"]
 
 [dependencies]
-librashader = { path = "../librashader", version = "0.2.0-beta.7", features = ["internal"] }
+librashader = { path = "../librashader", version = "0.2.0-beta.8" }
 thiserror = "1.0.37"
 paste = "1.0.9"
 gl = { version = "0.14.0", optional = true }

librashader-capi/cbindgen.toml

@@ -68,15 +68,7 @@ typedef void D3D12_CPU_DESCRIPTOR_HANDLE;
 
 [parse]
 parse_deps = true
-include = ["librashader",
-    "librashader-presets",
-    "librashader-preprocess",
-    "librashader-reflect",
-    "librashader-runtime-gl",
-    "librashader-runtime-vk",
-    "librashader-runtime-d3d11",
-    "librashader-runtime-d3d12",
-]
+include = ["librashader"]
 expand = ["librashader-capi"]
 
 [struct]
@@ -99,6 +91,20 @@ include = [
     "PFN_libra_preset_print",
     "PFN_libra_preset_get_runtime_params",
     "PFN_libra_preset_free_runtime_params",
+    "PFN_libra_preset_create_with_context",
+
+    "PFN_libra_preset_ctx_create",
+    "PFN_libra_preset_ctx_free",
+    "PFN_libra_preset_ctx_set_core_name",
+    "PFN_libra_preset_ctx_set_content_dir",
+    "PFN_libra_preset_ctx_set_param",
+    "PFN_libra_preset_ctx_set_core_rotation",
+    "PFN_libra_preset_ctx_set_user_rotation",
+    "PFN_libra_preset_ctx_set_screen_orientation",
+    "PFN_libra_preset_ctx_set_allow_rotation",
+    "PFN_libra_preset_ctx_set_view_aspect_orientation",
+    "PFN_libra_preset_ctx_set_core_aspect_orientation",
+    "PFN_libra_preset_ctx_set_runtime",
 
     # error
     "PFN_libra_error_errno",
@@ -154,6 +160,9 @@ exclude = ["Option_ID3D11DeviceContext"]
 [export.rename]
 "LibrashaderError" = "_libra_error"
 "ShaderPreset" = "_shader_preset"
+
+"WildcardContext" = "_preset_ctx"
+
 "FilterChainGL" = "_filter_chain_gl"
 "FilterChainVulkan" = "_filter_chain_vk"
 "FilterChainD3D11" = "_filter_chain_d3d11"
@@ -180,4 +189,4 @@ exclude = ["Option_ID3D11DeviceContext"]
 # hack to get proper pointer indirection for COM pointers
 "ID3D12Device" = "ID3D12Device *"
 "ID3D12Resource" = "ID3D12Resource *"
-"ID3D12GraphicsCommandList" = "ID3D12GraphicsCommandList *"
+"ID3D12GraphicsCommandList" = "ID3D12GraphicsCommandList *"

librashader-capi/src/ctypes.rs

@@ -1,37 +1,93 @@
 //! Binding types for the librashader C API.
 use crate::error::LibrashaderError;
+use librashader::presets::context::{Orientation, VideoDriver, WildcardContext};
 use librashader::presets::ShaderPreset;
 use std::mem::MaybeUninit;
 use std::ptr::NonNull;
 
 /// A handle to a shader preset object.
 pub type libra_shader_preset_t = Option<NonNull<ShaderPreset>>;
 
+/// A handle to a preset wildcard context object.
+pub type libra_preset_ctx_t = Option<NonNull<WildcardContext>>;
+
 /// A handle to a librashader error object.
 pub type libra_error_t = Option<NonNull<LibrashaderError>>;
 
+/// An enum representing orientation for use in preset contexts.
+#[repr(u32)]
+#[derive(Debug, Copy, Clone)]
+pub enum LIBRA_PRESET_CTX_ORIENTATION {
+    Vertical = 0,
+    Horizontal,
+}
+impl From<LIBRA_PRESET_CTX_ORIENTATION> for Orientation {
+    fn from(value: LIBRA_PRESET_CTX_ORIENTATION) -> Self {
+        match value {
+            LIBRA_PRESET_CTX_ORIENTATION::Vertical => Orientation::Vertical,
+            LIBRA_PRESET_CTX_ORIENTATION::Horizontal => Orientation::Horizontal,
+        }
+    }
+}
+
+// An enum representing graphics runtimes (video drivers) for use in preset contexts.
+#[repr(u32)]
+#[derive(Debug, Copy, Clone)]
+pub enum LIBRA_PRESET_CTX_RUNTIME {
+    None = 0,
+    GlCore,
+    Vulkan,
+    D3D11,
+    D3D12,
+    Metal,
+}
+
+impl From<LIBRA_PRESET_CTX_RUNTIME> for VideoDriver {
+    fn from(value: LIBRA_PRESET_CTX_RUNTIME) -> Self {
+        match value {
+            LIBRA_PRESET_CTX_RUNTIME::None => VideoDriver::None,
+            LIBRA_PRESET_CTX_RUNTIME::GlCore => VideoDriver::GlCore,
+            LIBRA_PRESET_CTX_RUNTIME::Vulkan => VideoDriver::Vulkan,
+            LIBRA_PRESET_CTX_RUNTIME::D3D11 => VideoDriver::Direct3D11,
+            LIBRA_PRESET_CTX_RUNTIME::D3D12 => VideoDriver::Direct3D12,
+            LIBRA_PRESET_CTX_RUNTIME::Metal => VideoDriver::Metal,
+        }
+    }
+}
+
+#[cfg(feature = "runtime-opengl")]
+use librashader::runtime::gl::FilterChain as FilterChainGL;
+
 /// A handle to a OpenGL filter chain.
 #[cfg(feature = "runtime-opengl")]
 #[doc(cfg(feature = "runtime-opengl"))]
-pub type libra_gl_filter_chain_t = Option<NonNull<librashader::runtime::gl::capi::FilterChainGL>>;
+pub type libra_gl_filter_chain_t = Option<NonNull<FilterChainGL>>;
+
+/// A handle to a Direct3D 11 filter chain.
+#[cfg(all(target_os = "windows", feature = "runtime-d3d11"))]
+use librashader::runtime::d3d11::FilterChain as FilterChainD3D11;
 
 /// A handle to a Direct3D 11 filter chain.
 #[cfg(all(target_os = "windows", feature = "runtime-d3d11"))]
 #[doc(cfg(all(target_os = "windows", feature = "runtime-d3d11")))]
 pub type libra_d3d11_filter_chain_t =
-    Option<NonNull<librashader::runtime::d3d11::capi::FilterChainD3D11>>;
+    Option<NonNull<FilterChainD3D11>>;
 
+#[cfg(all(target_os = "windows", feature = "runtime-d3d12"))]
+use librashader::runtime::d3d12::FilterChain as FilterChainD3D12;
 /// A handle to a Direct3D 12 filter chain.
 #[cfg(all(target_os = "windows", feature = "runtime-d3d12"))]
 #[doc(cfg(all(target_os = "windows", feature = "runtime-d3d12")))]
 pub type libra_d3d12_filter_chain_t =
-    Option<NonNull<librashader::runtime::d3d12::capi::FilterChainD3D12>>;
+    Option<NonNull<FilterChainD3D12>>;
 
+#[cfg(feature = "runtime-vulkan")]
+use librashader::runtime::vk::FilterChain as FilterChainVulkan;
 /// A handle to a Vulkan filter chain.
 #[cfg(feature = "runtime-vulkan")]
 #[doc(cfg(feature = "runtime-vulkan"))]
 pub type libra_vk_filter_chain_t =
-    Option<NonNull<librashader::runtime::vk::capi::FilterChainVulkan>>;
+    Option<NonNull<FilterChainVulkan>>;
 
 /// Defines the output viewport for a rendered frame.
 #[repr(C)]
@@ -87,3 +143,35 @@ macro_rules! config_struct {
 pub(crate) use config_set_field;
 pub(crate) use config_struct;
 pub(crate) use config_version_set;
+
+#[doc(hidden)]
+#[deny(deprecated)]
+#[deprecated = "Forward declarations for cbindgen, do not use."]
+mod __cbindgen_opaque_forward_declarations {
+    macro_rules! typedef_struct {
+        ($($(#[$($attrss:tt)*])* $name:ident;)*) => {
+            $($(#[$($attrss)*])*
+                #[allow(unused)]
+                #[doc(hidden)]
+                #[deny(deprecated)]
+                #[deprecated]
+                pub struct $name;
+            )*
+        };
+    }
+
+    typedef_struct! {
+        /// Opaque struct for a preset context.
+        WildcardContext;
+        /// Opaque struct for a shader preset.
+        ShaderPreset;
+        /// Opaque struct for an OpenGL filter chain.
+        FilterChainGL;
+        /// Opaque struct for a Direct3D 11 filter chain.
+        FilterChainD3D11;
+        /// Opaque struct for a Direct3D 12 filter chain.
+        FilterChainD3D12;
+        /// Opaque struct for a Vulkan filter chain.
+        FilterChainVulkan;
+    }
+}

librashader-capi/src/error.rs

@@ -5,7 +5,7 @@ use std::mem::MaybeUninit;
 use std::ptr::NonNull;
 use thiserror::Error;
 
-/// The error type for librashader.
+/// The error type for librashader C API.
 #[non_exhaustive]
 #[derive(Error, Debug)]
 pub enum LibrashaderError {

librashader-capi/src/lib.rs

@@ -68,6 +68,7 @@
 #![feature(pointer_is_aligned)]
 #![feature(vec_into_raw_parts)]
 #![deny(unsafe_op_in_unsafe_fn)]
+#![deny(deprecated)]
 
 pub mod ctypes;
 pub mod error;
@@ -80,6 +81,7 @@ pub mod reflect;
 
 pub mod runtime;
 pub mod version;
+pub mod wildcard;
 
 pub use version::LIBRASHADER_ABI_VERSION;
 pub use version::LIBRASHADER_API_VERSION;

librashader-capi/src/presets.rs

@@ -1,5 +1,5 @@
 //! librashader preset C API (`libra_preset_*`).
-use crate::ctypes::libra_shader_preset_t;
+use crate::ctypes::{libra_preset_ctx_t, libra_shader_preset_t};
 use crate::error::{assert_non_null, assert_some_ptr, LibrashaderError};
 use crate::ffi::extern_fn;
 use librashader::presets::ShaderPreset;
@@ -55,7 +55,6 @@ extern_fn! {
 
         let filename = unsafe { CStr::from_ptr(filename) };
         let filename = filename.to_str()?;
-        println!("loading {filename}");
 
         let preset = ShaderPreset::try_parse(filename)?;
         unsafe {
@@ -66,14 +65,57 @@ extern_fn! {
     }
 }
 
+extern_fn! {
+    /// Load a preset with the given wildcard context.
+    ///
+    /// The wildcard context is immediately invalidated and must be recreated after
+    /// the preset is created.
+    ///
+    /// Path information variables `PRESET_DIR` and `PRESET` will automatically be filled in.
+    /// ## Safety
+    ///  - `filename` must be either null or a valid, aligned pointer to a string path to the shader preset.
+    ///  - `context` must be either null or a valid, aligned pointer to a initialized `libra_preset_ctx_t`.
+    ///  - `context` is  invalidated after this function returns.
+    ///  - `out` must be either null, or an aligned pointer to an uninitialized or invalid `libra_shader_preset_t`.
+    /// ## Returns
+    ///  - If any parameters are null, `out` is unchanged, and this function returns `LIBRA_ERR_INVALID_PARAMETER`.
+    fn libra_preset_create_with_context(
+        filename: *const c_char,
+        context: *mut libra_preset_ctx_t,
+        out: *mut MaybeUninit<libra_shader_preset_t>
+    ) {
+        assert_non_null!(filename);
+        assert_non_null!(context);
+        assert_non_null!(out);
+
+        let filename = unsafe { CStr::from_ptr(filename) };
+        let filename = filename.to_str()?;
+
+        let mut context = unsafe {
+            let context_ptr = &mut *context;
+            let context = context_ptr.take();
+            Box::from_raw(context.unwrap().as_ptr())
+        };
+
+        context.add_path_defaults(filename);
+
+        let preset = ShaderPreset::try_parse_with_context(filename, *context)?;
+        unsafe {
+            out.write(MaybeUninit::new(NonNull::new(Box::into_raw(Box::new(
+                preset,
+            )))))
+        }
+    }
+}
+
 extern_fn! {
     /// Free the preset.
     ///
     /// If `preset` is null, this function does nothing. The resulting value in `preset` then becomes
     /// null.
     ///
     /// ## Safety
-    /// - `preset` must be a valid and aligned pointer to a shader preset.
+    /// - `preset` must be a valid and aligned pointer to a `libra_shader_preset_t`.
     fn libra_preset_free(preset: *mut libra_shader_preset_t) {
         assert_non_null!(preset);
         unsafe {
@@ -88,7 +130,7 @@ extern_fn! {
     /// Set the value of the parameter in the preset.
     ///
     /// ## Safety
-    /// - `preset` must be null or a valid and aligned pointer to a shader preset.
+    /// - `preset` must be null or a valid and aligned pointer to a `libra_shader_preset_t`.
     /// - `name` must be null or a valid and aligned pointer to a string.
     fn libra_preset_set_param(
         preset: *mut libra_shader_preset_t,
@@ -135,7 +177,7 @@ extern_fn! {
     /// Pretty print the shader preset.
     ///
     /// ## Safety
-    /// - `preset` must be null or a valid and aligned pointer to a shader preset.
+    /// - `preset` must be null or a valid and aligned pointer to a `libra_shader_preset_t`.
     fn libra_preset_print(preset: *mut libra_shader_preset_t) |preset| {
         assert_some_ptr!(preset);
         println!("{preset:#?}");
@@ -146,7 +188,7 @@ extern_fn! {
     /// Get a list of runtime parameters.
     ///
     /// ## Safety
-    /// - `preset` must be null or a valid and aligned pointer to a shader preset.
+    /// - `preset` must be null or a valid and aligned pointer to a `libra_shader_preset_t`.
     /// - `out` must be an aligned pointer to a `libra_preset_parameter_list_t`.
     /// - The output struct should be treated as immutable. Mutating any struct fields
     ///   in the returned struct may at best cause memory leaks, and at worse