Added PLUGIN development!!!

- Added new API functions in `lib.rs` for better integration with external modules.
- Implemented conversion from `Error` to `String` in `errors.rs` for improved error handling.
- Simplified iterator implementations in `iterators.rs` by consolidating macro usage.
- Updated `Map` struct methods in `mod.rs` for better safety and usability, including new `get_string` and `set_string` methods.
- Improved test coverage in `tests.rs` for various map functionalities.
- Refactored `node/mod.rs` to streamline frame handling and caching options.
- Introduced `PluginConfigFlags` in `plugin.rs` for enhanced plugin configuration.
- Cleaned up `vsscript/mod.rs` and `tests.rs` for consistency and clarity.

Author: animafps

.github/workflows/ci.yml

@@ -10,21 +10,50 @@ jobs:
     env: 
       LD_LIBRARY_PATH: /usr/local/lib
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v5
         with:
           submodules: recursive
-      - name: Build vapoursynth
+      - name: Cache cargo
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+      - name: Cache zimg
+        uses: actions/cache@v4
+        id: cache-zimg
+        with:
+          path: /usr/local/lib/libzimg*
+          key: ${{ runner.os }}-zimg-3.0.6
+      - name: Cache vapoursynth
+        uses: actions/cache@v4
+        id: cache-vapoursynth
+        with:
+          path: |
+            /usr/local/lib/libvapoursynth*
+            /usr/local/include/vapoursynth
+          key: ${{ runner.os }}-vapoursynth-${{ hashFiles('rustsynth-sys/vapoursynth/**') }}
+      - name: Install system dependencies
         run: |
           sudo apt-get update
-          sudo apt-get install g++ make autoconf automake libtool pkg-config nasm git
+          sudo apt-get --yes install g++ make autoconf automake libtool pkg-config nasm git libclang-dev python3 python3-dev
+          pip install Cython
+      - name: Build zimg
+        if: steps.cache-zimg.outputs.cache-hit != 'true'
+        run: |
           git clone --branch release-3.0.6 --depth 1 https://github.com/sekrit-twc/zimg.git
-          cd zimg   
+          cd zimg
           ./autogen.sh
           ./configure
           make
           sudo make install
-          cd ..
-          sudo apt-get install cython3
+      - name: Build vapoursynth
+        if: steps.cache-vapoursynth.outputs.cache-hit != 'true'
+        run: |
           cd rustsynth-sys/vapoursynth
           ./autogen.sh
           ./configure
@@ -46,9 +75,18 @@ jobs:
     name: macOS - build, test and lint
     runs-on: macos-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v5
         with:
           submodules: recursive
+      - uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
       - name: Install VapourSynth
         run: |
           brew install vapoursynth

.github/workflows/docs.yml

@@ -18,9 +18,22 @@ jobs:
     name: Build and Release Docs
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v5
         with:
           submodules: recursive
+      - uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+      - name: Ensure libclang
+        run: |
+          apt update
+          apt install --yes libclang-dev
       - name: Run doc
         run: |
           cargo doc --workspace --no-deps

Cargo.lock

@@ -1,3 +1,3 @@
 [workspace]
 resolver = "2"
-members = ["rustsynth", "rustsynth-sys", "rustsynth-derive"]
+members = ["rustsynth", "rustsynth-sys", "rustsynth-derive", "example"]

Cargo.toml

@@ -4,7 +4,7 @@ Fork of [vapoursynth-rs](https://github.com/YaLTeR/vapoursynth-rs) for the lates
 
 **[support and dev discord](https://discord.com/invite/5z3YhWstQr)**
 
-[Docs for main branch](https://rustsynth.animafps.xyz/rustsynth/index.html)
+[Docs for main branch](https://animafps.github.io/rustsynth/rustsynth/index.html)
 
 ## rustsynth
 

README.md

@@ -0,0 +1,69 @@
+use rustsynth::{
+    core::CoreRef,
+    filter::{
+        traits::{Filter},
+        FilterDependency, FilterMode, RequestPattern,
+    },
+    frame::{Frame, FrameContext},
+    map::Map,
+    node::Node,
+};
+use rustsynth_derive::vapoursynth_plugin;
+
+#[vapoursynth_plugin]
+mod plugin {
+    use rustsynth::{ffi, plugin::PluginConfigFlags, MakeVersion};
+    use rustsynth_derive::vapoursynth_filter;
+    const NAMESPACE: &'static str = "example";
+    const ID: &'static str = "com.example.invert";
+    const NAME: &'static str = "Example Plugin";
+    const PLUGIN_VER: i32 = MakeVersion!(1,0);
+    const API_VER: i32 = ffi::VAPOURSYNTH_API_VERSION;
+    const FLAGS: i32 = PluginConfigFlags::NONE.bits();
+
+    #[vapoursynth_filter(video)]
+    struct Invert {
+        input_node: Node,
+    }
+
+    // Just implement the trait methods and the macro handles all C FFI
+    impl Filter for Invert {
+        const NAME: &'static str = "Invert";
+        const ARGS: &'static str = "clip:vnode;";
+        const RETURNTYPE: &'static str = "clip:vnode;";
+        const MODE: FilterMode = FilterMode::Parallel;
+
+        fn from_args(args: &Map, _core: &CoreRef) -> Result<Self, String> {
+            let input_node = args.get_node("clip")?;
+            Ok(Self { input_node })
+        }
+
+        fn get_dependencies(&self) -> Vec<FilterDependency> {
+            vec![FilterDependency {
+                source: self.input_node.clone(),
+                request_pattern: RequestPattern::StrictSpatial,
+            }]
+        }
+
+        fn request_input_frames(&self, n: i32, frame_ctx: FrameContext) {
+            self.get_dependencies()[0]
+                .source
+                .request_frame_filter(n, &frame_ctx);
+        }
+
+        fn process_frame<'core>(
+            &mut self,
+            n: i32,
+            _frame_data: &[u8; 4],
+            frame_ctx: FrameContext,
+            core: CoreRef<'core>,
+        ) -> Result<Frame<'core>, String> {
+            let src = self.input_node.get_frame_filter(n, &frame_ctx).unwrap();
+            // simple pass through
+            Ok(src)
+        }
+    }
+
+    // Register all filters in this plugin
+    rustsynth::register_filters!(Invert);
+}