kreuzberg 4.3.1

High-performance document intelligence library for Rust. Extract text, metadata, and structured data from PDFs, Office documents, images, and 75+ formats with async/sync APIs.
Documentation
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
use crate::error::{KreuzbergError, Result};
use crate::types::{ExtractionConfig, ImagePreprocessingMetadata};
use image::{DynamicImage, ImageBuffer, Rgb};

use super::dpi::calculate_smart_dpi;
use super::resize::resize_image;

const PDF_POINTS_PER_INCH: f64 = 72.0;

/// Result of image normalization
pub struct NormalizeResult {
    /// Processed RGB image data (height * width * 3 bytes)
    pub rgb_data: Vec<u8>,
    /// Image dimensions (width, height)
    pub dimensions: (usize, usize),
    /// Preprocessing metadata
    pub metadata: ImagePreprocessingMetadata,
}

/// Normalize image DPI based on extraction configuration
///
/// # Arguments
/// * `rgb_data` - RGB image data as a flat `Vec<u8>` (height * width * 3 bytes, row-major)
/// * `width` - Image width in pixels
/// * `height` - Image height in pixels
/// * `config` - Extraction configuration containing DPI settings
/// * `current_dpi` - Optional current DPI of the image (defaults to 72 if None)
///
/// # Returns
/// * `NormalizeResult` containing processed image data and metadata
pub fn normalize_image_dpi(
    rgb_data: &[u8],
    width: usize,
    height: usize,
    config: &ExtractionConfig,
    current_dpi: Option<f64>,
) -> Result<NormalizeResult> {
    if width > 65536 || height > 65536 {
        return Err(KreuzbergError::validation(format!(
            "Image dimensions {}x{} exceed maximum 65536x65536",
            width, height
        )));
    }

    let expected_size = height * width * 3;
    if rgb_data.len() != expected_size {
        return Err(KreuzbergError::validation(format!(
            "RGB data size {} does not match expected size {} for {}x{} image",
            rgb_data.len(),
            expected_size,
            width,
            height
        )));
    }

    let current_dpi = current_dpi.unwrap_or(PDF_POINTS_PER_INCH);
    let original_dpi = (current_dpi, current_dpi);
    let max_memory_mb = 2048.0;

    let (target_dpi, auto_adjusted, calculated_dpi) =
        calculate_target_dpi(width as u32, height as u32, current_dpi, config, max_memory_mb);

    let scale_factor = f64::from(target_dpi) / current_dpi;

    if !needs_resize(width as u32, height as u32, scale_factor, config) {
        return Ok(create_skip_result(
            rgb_data.to_vec(),
            width,
            height,
            original_dpi,
            config,
            target_dpi,
            scale_factor,
            auto_adjusted,
            calculated_dpi,
        ));
    }

    let (new_width, new_height, final_scale, dimension_clamped) =
        calculate_new_dimensions(width as u32, height as u32, scale_factor, config);

    perform_resize(
        rgb_data,
        width as u32,
        height as u32,
        new_width,
        new_height,
        final_scale,
        original_dpi,
        target_dpi,
        auto_adjusted,
        dimension_clamped,
        calculated_dpi,
        config,
    )
}

/// Calculate target DPI based on configuration
fn calculate_target_dpi(
    width: u32,
    height: u32,
    current_dpi: f64,
    config: &ExtractionConfig,
    max_memory_mb: f64,
) -> (i32, bool, Option<i32>) {
    if config.auto_adjust_dpi {
        let approx_width_points = f64::from(width) * PDF_POINTS_PER_INCH / current_dpi;
        let approx_height_points = f64::from(height) * PDF_POINTS_PER_INCH / current_dpi;

        let optimal_dpi = calculate_smart_dpi(
            approx_width_points,
            approx_height_points,
            config.target_dpi,
            config.max_image_dimension,
            max_memory_mb,
        );

        (optimal_dpi, optimal_dpi != config.target_dpi, Some(optimal_dpi))
    } else {
        (config.target_dpi, false, None)
    }
}

/// Check if resize is needed
fn needs_resize(width: u32, height: u32, scale_factor: f64, config: &ExtractionConfig) -> bool {
    let max_dimension = width.max(height);
    let exceeds_max = i32::try_from(max_dimension).map_or(true, |dim| dim > config.max_image_dimension);

    (scale_factor - 1.0).abs() >= 0.05 || exceeds_max
}

/// Calculate new dimensions after scaling
#[allow(clippy::cast_possible_truncation, clippy::cast_sign_loss)]
fn calculate_new_dimensions(
    original_width: u32,
    original_height: u32,
    scale_factor: f64,
    config: &ExtractionConfig,
) -> (u32, u32, f64, bool) {
    let mut new_width = (f64::from(original_width) * scale_factor).round() as u32;
    let mut new_height = (f64::from(original_height) * scale_factor).round() as u32;
    let mut final_scale = scale_factor;
    let mut dimension_clamped = false;

    let max_new_dimension = new_width.max(new_height);
    if let Ok(max_dim_i32) = i32::try_from(max_new_dimension)
        && max_dim_i32 > config.max_image_dimension
    {
        let dimension_scale = f64::from(config.max_image_dimension) / f64::from(max_new_dimension);
        new_width = (f64::from(new_width) * dimension_scale).round() as u32;
        new_height = (f64::from(new_height) * dimension_scale).round() as u32;
        final_scale *= dimension_scale;
        dimension_clamped = true;
    }

    (new_width, new_height, final_scale, dimension_clamped)
}

/// Create result when resize is skipped
#[allow(clippy::too_many_arguments)]
fn create_skip_result(
    rgb_data: Vec<u8>,
    width: usize,
    height: usize,
    original_dpi: (f64, f64),
    config: &ExtractionConfig,
    target_dpi: i32,
    scale_factor: f64,
    auto_adjusted: bool,
    calculated_dpi: Option<i32>,
) -> NormalizeResult {
    NormalizeResult {
        rgb_data,
        dimensions: (width, height),
        metadata: ImagePreprocessingMetadata {
            original_dimensions: (width, height),
            original_dpi,
            target_dpi: config.target_dpi,
            scale_factor,
            auto_adjusted,
            final_dpi: target_dpi,
            new_dimensions: None,
            resample_method: "NONE".to_string(),
            dimension_clamped: false,
            calculated_dpi,
            skipped_resize: true,
            resize_error: None,
        },
    }
}

/// Perform the actual resize operation
#[allow(clippy::too_many_arguments)]
fn perform_resize(
    rgb_data: &[u8],
    original_width: u32,
    original_height: u32,
    new_width: u32,
    new_height: u32,
    final_scale: f64,
    original_dpi: (f64, f64),
    target_dpi: i32,
    auto_adjusted: bool,
    dimension_clamped: bool,
    calculated_dpi: Option<i32>,
    config: &ExtractionConfig,
) -> Result<NormalizeResult> {
    let img_buffer = ImageBuffer::<Rgb<u8>, Vec<u8>>::from_raw(original_width, original_height, rgb_data.to_vec())
        .ok_or_else(|| {
            KreuzbergError::parsing(format!(
                "Failed to create image buffer from {}x{} RGB data",
                original_width, original_height
            ))
        })?;

    let image = DynamicImage::ImageRgb8(img_buffer);

    let resized = resize_image(&image, new_width, new_height, final_scale)?;

    let rgb_image = resized.to_rgb8();
    let result_rgb_data = rgb_image.into_raw();

    let metadata = ImagePreprocessingMetadata {
        original_dimensions: (original_width as usize, original_height as usize),
        original_dpi,
        target_dpi: config.target_dpi,
        scale_factor: final_scale,
        auto_adjusted,
        final_dpi: target_dpi,
        new_dimensions: Some((new_width as usize, new_height as usize)),
        resample_method: if final_scale < 1.0 { "LANCZOS3" } else { "CATMULLROM" }.to_string(),
        dimension_clamped,
        calculated_dpi,
        skipped_resize: false,
        resize_error: None,
    };

    Ok(NormalizeResult {
        rgb_data: result_rgb_data,
        dimensions: (new_width as usize, new_height as usize),
        metadata,
    })
}

#[cfg(test)]
mod tests {
    use super::*;

    fn create_test_rgb_data(width: usize, height: usize) -> Vec<u8> {
        let mut data = Vec::with_capacity(width * height * 3);
        for _ in 0..width * height {
            data.push(255);
            data.push(0);
            data.push(0);
        }
        data
    }

    #[test]
    fn test_normalize_image_dpi_skip_resize() {
        let config = ExtractionConfig {
            target_dpi: 72,
            max_image_dimension: 4096,
            auto_adjust_dpi: false,
            min_dpi: 72,
            max_dpi: 600,
        };

        let rgb_data = create_test_rgb_data(100, 100);
        let result = normalize_image_dpi(&rgb_data, 100, 100, &config, Some(72.0));

        assert!(result.is_ok());
        let normalized = result.unwrap();
        assert_eq!(normalized.dimensions, (100, 100));
        assert!(normalized.metadata.skipped_resize);
    }

    #[test]
    fn test_normalize_image_dpi_upscale() {
        let config = ExtractionConfig {
            target_dpi: 300,
            max_image_dimension: 4096,
            auto_adjust_dpi: false,
            min_dpi: 72,
            max_dpi: 600,
        };

        let rgb_data = create_test_rgb_data(100, 100);
        let result = normalize_image_dpi(&rgb_data, 100, 100, &config, Some(72.0));

        assert!(result.is_ok());
        let normalized = result.unwrap();
        assert!(!normalized.metadata.skipped_resize);
        assert!(normalized.dimensions.0 > 100);
        assert!(normalized.dimensions.1 > 100);
    }

    #[test]
    fn test_normalize_image_dpi_downscale() {
        let config = ExtractionConfig {
            target_dpi: 72,
            max_image_dimension: 4096,
            auto_adjust_dpi: false,
            min_dpi: 72,
            max_dpi: 600,
        };

        let rgb_data = create_test_rgb_data(1000, 1000);
        let result = normalize_image_dpi(&rgb_data, 1000, 1000, &config, Some(300.0));

        assert!(result.is_ok());
        let normalized = result.unwrap();
        assert!(!normalized.metadata.skipped_resize);
        assert!(normalized.dimensions.0 < 1000);
        assert!(normalized.dimensions.1 < 1000);
    }

    #[test]
    fn test_normalize_image_dpi_dimension_clamp() {
        let config = ExtractionConfig {
            target_dpi: 300,
            max_image_dimension: 500,
            auto_adjust_dpi: false,
            min_dpi: 72,
            max_dpi: 600,
        };

        let rgb_data = create_test_rgb_data(1000, 1000);
        let result = normalize_image_dpi(&rgb_data, 1000, 1000, &config, Some(300.0));

        assert!(result.is_ok());
        let normalized = result.unwrap();
        assert!(normalized.metadata.dimension_clamped);
        assert!(normalized.dimensions.0 <= 500);
        assert!(normalized.dimensions.1 <= 500);
    }

    #[test]
    fn test_normalize_image_dpi_auto_adjust() {
        let config = ExtractionConfig {
            target_dpi: 300,
            max_image_dimension: 4096,
            auto_adjust_dpi: true,
            min_dpi: 72,
            max_dpi: 600,
        };

        let rgb_data = create_test_rgb_data(100, 100);
        let result = normalize_image_dpi(&rgb_data, 100, 100, &config, Some(72.0));

        assert!(result.is_ok());
        let normalized = result.unwrap();
        assert!(normalized.metadata.calculated_dpi.is_some());
    }

    #[test]
    fn test_normalize_image_dpi_invalid_dimensions() {
        let config = ExtractionConfig::default();
        let rgb_data = create_test_rgb_data(100, 100);

        let result = normalize_image_dpi(&rgb_data, 100000, 100000, &config, None);
        assert!(result.is_err());
    }

    #[test]
    fn test_normalize_image_dpi_invalid_data_size() {
        let config = ExtractionConfig::default();
        let rgb_data = vec![0u8; 100];

        let result = normalize_image_dpi(&rgb_data, 100, 100, &config, None);
        assert!(result.is_err());
    }

    #[test]
    fn test_needs_resize_threshold() {
        let config = ExtractionConfig {
            target_dpi: 300,
            max_image_dimension: 4096,
            auto_adjust_dpi: false,
            min_dpi: 72,
            max_dpi: 600,
        };

        assert!(!needs_resize(100, 100, 1.02, &config));

        assert!(needs_resize(100, 100, 1.10, &config));
    }

    #[test]
    fn test_calculate_new_dimensions_no_clamp() {
        let config = ExtractionConfig::default();

        let (new_w, new_h, scale, clamped) = calculate_new_dimensions(100, 100, 2.0, &config);

        assert_eq!(new_w, 200);
        assert_eq!(new_h, 200);
        assert!((scale - 2.0).abs() < 0.01);
        assert!(!clamped);
    }

    #[test]
    fn test_calculate_new_dimensions_with_clamp() {
        let config = ExtractionConfig {
            target_dpi: 300,
            max_image_dimension: 100,
            auto_adjust_dpi: false,
            min_dpi: 72,
            max_dpi: 600,
        };

        let (new_w, new_h, _scale, clamped) = calculate_new_dimensions(100, 100, 2.0, &config);

        assert!(new_w <= 100);
        assert!(new_h <= 100);
        assert!(clamped);
    }
}