koharu-diffusion 0.62.0-alpha.1

Safe Rust bindings for stable-diffusion.cpp with runtime dynamic loading.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

use std::{cell::Cell, fmt, marker::PhantomData, path::PathBuf, ptr::NonNull};

use crate::{
    Error, Result, RgbImage,
    context::RawImages,
    ffi::{NativeCall, optional_cstring, path_cstring},
    image::raw_rgb_image,
    sys,
};

/// Model and backend settings for an ESRGAN upscaler.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct UpscalerParams {
    pub model_path: PathBuf,
    pub direct_convolution: bool,
    pub n_threads: i32,
    pub tile_size: i32,
    pub backend: Option<String>,
    pub params_backend: Option<String>,
}

impl UpscalerParams {
    #[must_use]
    pub fn new(model_path: impl Into<PathBuf>) -> Self {
        Self {
            model_path: model_path.into(),
            direct_convolution: false,
            n_threads: crate::physical_core_count(),
            tile_size: 128,
            backend: None,
            params_backend: None,
        }
    }
}

/// An owning ESRGAN upscaler context.
pub struct Upscaler {
    pointer: NonNull<sys::upscaler_ctx_t>,
    _not_sync: PhantomData<Cell<()>>,
}

unsafe impl Send for Upscaler {}

impl fmt::Debug for Upscaler {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter
            .debug_struct("Upscaler")
            .field("pointer", &self.pointer)
            .finish_non_exhaustive()
    }
}

impl Upscaler {
    pub fn new(params: &UpscalerParams) -> Result<Self> {
        if params.n_threads <= 0 {
            return Err(Error::InvalidParameter {
                name: "n_threads",
                reason: "must be greater than zero",
            });
        }
        let model_path = path_cstring(&params.model_path, "upscaler model_path")?;
        let backend = optional_cstring(params.backend.as_deref(), "backend")?;
        let params_backend = optional_cstring(params.params_backend.as_deref(), "params_backend")?;
        let _call = NativeCall::enter();
        let pointer = unsafe {
            sys::new_upscaler_ctx(
                model_path.as_ptr(),
                params.direct_convolution,
                params.n_threads,
                params.tile_size,
                backend
                    .as_ref()
                    .map_or(std::ptr::null(), |value| value.as_ptr()),
                params_backend
                    .as_ref()
                    .map_or(std::ptr::null(), |value| value.as_ptr()),
            )
        };
        let pointer = NonNull::new(pointer).ok_or(Error::UpscalerCreationFailed)?;
        Ok(Self {
            pointer,
            _not_sync: PhantomData,
        })
    }

    /// Returns the scale factor encoded by the loaded model.
    #[must_use]
    pub fn factor(&self) -> i32 {
        let _call = NativeCall::enter();
        unsafe { sys::get_upscale_factor(self.pointer.as_ptr()) }
    }

    /// Upscales an image and returns the native output as owned Rust images.
    pub fn upscale(&mut self, image: &RgbImage, requested_factor: u32) -> Result<Vec<RgbImage>> {
        if requested_factor == 0 {
            return Err(Error::InvalidParameter {
                name: "requested_factor",
                reason: "must be greater than zero",
            });
        }
        let image = raw_rgb_image(image)?;
        let _call = NativeCall::enter();
        let mut output = RawImages::default();
        let succeeded = unsafe {
            sys::upscale(
                self.pointer.as_ptr(),
                image,
                requested_factor,
                &raw mut output.pointer,
                &raw mut output.count,
            )
        };
        if !succeeded {
            return Err(Error::UpscaleFailed);
        }
        output.copy("upscaled image")
    }
}

impl Drop for Upscaler {
    fn drop(&mut self) {
        let _call = NativeCall::enter();
        unsafe { sys::free_upscaler_ctx(self.pointer.as_ptr()) };
    }
}