flpdf 0.6.0

A pure-Rust PDF toolkit modeled on qpdf — read, rewrite, linearize, and inspect PDFs.
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
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
//! Decode and re-encode PDF stream filters.
//!
//! qpdf correspondence: `QPDFStreamFilter.cc` and `QPDF_Stream.cc` filter names, full `/DecodeParms` handles, and reverse decode-pipeline construction (`libqpdf/QPDF_Stream.cc:380-482`).
//!
//! Crypt decryption remains owned by
//! `reader::resolver::inspect_stream_encryption` and
//! `reader::resolver::pipe_stream_data_from_input`; this module preserves
//! qpdf's filterability and no-stage pipeline contract.

use crate::object_handle::ObjectHandle;
use crate::pipeline::ascii85_decoder::Ascii85Decoder;
use crate::pipeline::ascii_hex::AsciiHexDecoder;
use crate::pipeline::buffer::Buffer;
use crate::pipeline::dct::PlDct;
use crate::pipeline::flate::{Flate, FlateAction, DEFAULT_OUT_BUFFER_SIZE};
use crate::pipeline::lzw::LzwDecoder;
use crate::pipeline::png_filter::{PngFilter, PngFilterAction};
use crate::pipeline::run_length::{RunLength, RunLengthAction};
use crate::pipeline::tiff_predictor::{TiffPredictor, TiffPredictorAction};
use crate::pipeline::{Pipeline, PipelineError, PipelineRef, PipelineResult};
use crate::{Error, Result};
use std::collections::BTreeMap;
use std::sync::{Arc, Mutex, MutexGuard, OnceLock};

type FilterWarningCallback = Box<dyn FnMut(&str, i32) -> PipelineResult<()> + 'static>;

pub(crate) fn normalize_filter_name(name: &[u8]) -> &[u8] {
    match name {
        b"Fl" => b"FlateDecode",
        b"LZW" => b"LZWDecode",
        b"A85" => b"ASCII85Decode",
        b"AHx" => b"ASCIIHexDecode",
        b"RL" => b"RunLengthDecode",
        b"CCF" => b"CCITTFaxDecode",
        b"DCT" => b"DCTDecode",
        name => name,
    }
}

/// `QPDF_Stream::filterable`'s `warn("stream filter type is not name or
/// array")` (`libqpdf/QPDF_Stream.cc:413`). flpdf raises the same text as an
/// error instead of a warning; see plan decision D3 of `flpdf-25kg.3.4`.
pub(crate) const FILTER_TYPE_ERROR: &str = "stream filter type is not name or array";

/// `QPDF_Stream::filterable`'s `warn("stream /DecodeParms length is
/// inconsistent with filters")` (`libqpdf/QPDF_Stream.cc:459`), raised as an
/// error rather than a warning just as [`FILTER_TYPE_ERROR`] is.
///
/// qpdf validates every filter name against `filter_factories` first, keeps
/// constructing the known factories after an unknown one, and returns false
/// after that pass (`QPDF_Stream.cc:425-435`). Thus `:459`'s condition is never
/// evaluated for a stream whose `/Filter` names an unimplemented codec. The
/// canonical handle reader makes the same factory decision before reading
/// `/DecodeParms`, through `prepare_stream_filter_plan`.
pub(crate) const DECODE_PARMS_LENGTH_ERROR: &str =
    "stream /DecodeParms length is inconsistent with filters";
fn map_pipeline_error(error: PipelineError) -> Error {
    Error::Unsupported(error.into_string_lossy())
}

/// Rust equivalent of qpdf's `QPDFStreamFilter` extension boundary.
///
/// Ordinary stream consumers use `ObjectHandle::pipe_stream_data` directly;
/// this trait only supplies qpdf's filter construction and classification hooks.
pub trait StreamFilter: 'static {
    /// Port of `QPDFStreamFilter::setDecodeParms`
    /// (`libqpdf/QPDFStreamFilter.cc:3-7`), whose whole body is
    /// `return decode_parms.isNull();` — documented at
    /// `include/qpdf/QPDFStreamFilter.hh:41-42` as "The default implementation
    /// accepts a null object and rejects everything else". A missing
    /// `/DecodeParms` key is represented by the same null `ObjectHandle`.
    fn set_decode_params(&mut self, decode_params: &ObjectHandle) -> Result<bool> {
        decode_params.try_is_null()
    }

    /// Construct the same stage with a downstream pipeline that may already
    /// own inner stages. This is the Rust ownership seam used by
    /// `QPDF_Stream::pipeStreamData`'s reverse chain construction.
    fn get_decode_pipeline<'a>(&mut self, next: PipelineRef<'a>)
        -> Result<OwnedDecodePipeline<'a>>;

    /// Whether this filter is a specialized compression codec for qpdf's
    /// stream capability classification.
    fn is_specialized_compression(&self) -> bool {
        false
    }

    /// Whether this filter is a lossy compression codec for qpdf's stream
    /// capability classification.
    fn is_lossy_compression(&self) -> bool {
        false
    }
}

/// Result of constructing a stage around a downstream pipeline that may
/// already own inner stages. `NoStage` returns the downstream slot so the
/// caller can keep threading it through a filter such as qpdf's `Crypt`.
pub enum OwnedDecodePipeline<'a> {
    Stage(Box<dyn Pipeline + 'a>),
    NoStage(PipelineRef<'a>),
}

/// Rust equivalent of qpdf's `SF_FlateLzwDecode`.
///
/// One filter serves `FlateDecode` and `LZWDecode`, owns the shared predictor
/// parameters, and builds the decode chain codec-then-predictor.
struct FlateLzwStreamFilter {
    lzw: bool,
    predictor: i32,
    columns: i32,
    colors: i32,
    bits_per_component: i32,
    early_code_change: bool,
    warning_callback: Option<FilterWarningCallback>,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
enum PredictorKind {
    Png,
    Tiff,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
struct PredictorGeometry {
    kind: PredictorKind,
    columns: u32,
    colors: u32,
    bits_per_component: u32,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
enum PredictorAction {
    #[cfg(test)]
    Encode,
    Decode,
}

impl FlateLzwStreamFilter {
    /// Construct with the PDF specification defaults qpdf uses.
    fn new(lzw: bool) -> Self {
        Self {
            lzw,
            predictor: 1,
            columns: 1,
            colors: 1,
            bits_per_component: 8,
            early_code_change: true,
            warning_callback: None,
        }
    }
}

/// Mirror `QIntC::to_uint`, whose range failure is a `std::runtime_error`.
fn to_uint(value: i32) -> Result<u32> {
    u32::try_from(value).map_err(|_| {
        Error::Unsupported(format!(
            "integer out of range converting {value} from a 4-byte signed type to a 4-byte unsigned type"
        ))
    })
}

impl StreamFilter for FlateLzwStreamFilter {
    fn set_decode_params(&mut self, decode_params: &ObjectHandle) -> Result<bool> {
        // The one early return SF_FlateLzwDecode::setDecodeParms has
        // (SF_FlateLzwDecode.cc:24-26), for a null /DecodeParms. Every other
        // shape walks the keys and then falls through to the trailing check at
        // :68-70, which a present-but-empty parameter set reaches.
        if decode_params.try_is_null()? {
            return Ok(true);
        }

        let mut filterable = true;
        for key in decode_params.try_get_keys()? {
            let value = decode_params.try_get_key(&key)?;
            let key = key.as_slice();
            match key {
                b"/Predictor" => {
                    let Some(_) = value.try_as_integer()? else {
                        filterable = false;
                        continue;
                    };
                    let predictor = value.try_get_int_value_as_int()?;
                    self.predictor = predictor;
                    if !((predictor == 1) || (predictor == 2) || (10..=15).contains(&predictor)) {
                        filterable = false;
                    }
                }
                b"/Columns" | b"/Colors" | b"/BitsPerComponent" => {
                    let Some(_) = value.try_as_integer()? else {
                        filterable = false;
                        continue;
                    };
                    // qpdf stores these without range validation and defers
                    // rejection to pipeline construction.
                    let parameter = value.try_get_int_value_as_int()?;
                    match key {
                        b"/Columns" => self.columns = parameter,
                        b"/Colors" => self.colors = parameter,
                        _ => self.bits_per_component = parameter,
                    }
                }
                // qpdf consults /EarlyChange only for LZW streams.
                b"/EarlyChange" if self.lzw => {
                    let Some(_) = value.try_as_integer()? else {
                        filterable = false;
                        continue;
                    };
                    let early_change = value.try_get_int_value_as_int()?;
                    self.early_code_change = early_change == 1;
                    if !((early_change == 0) || (early_change == 1)) {
                        filterable = false;
                    }
                }
                _ => {}
            }
        }

        if (self.predictor > 1) && (self.columns == 0) {
            filterable = false;
        }

        Ok(filterable)
    }

    /// Mirrors `SF_FlateLzwDecode::getDecodePipeline`
    /// (`libqpdf/SF_FlateLzwDecode.cc:75-110`): a predictor stage first when
    /// the parameters call for one, with `next` reassigned to it, then the
    /// codec wrapping whichever `next` resulted. The codec is what the caller
    /// receives.
    fn get_decode_pipeline<'a>(
        &mut self,
        next: PipelineRef<'a>,
    ) -> Result<OwnedDecodePipeline<'a>> {
        let next: PipelineRef<'a> = match self.decode_predictor_geometry()? {
            Some(geometry) => make_predictor_pipeline(geometry, next, PredictorAction::Decode)?,
            None => next,
        };
        let stage: Box<dyn Pipeline + 'a> = if self.lzw {
            Box::new(LzwDecoder::new("lzw decode", next, self.early_code_change))
        } else {
            let mut flate = Flate::new(
                "stream inflate",
                next,
                FlateAction::Inflate,
                DEFAULT_OUT_BUFFER_SIZE,
            )
            .map_err(map_pipeline_error)?;
            if let Some(callback) = self.warning_callback.take() {
                flate.set_warn_callback(callback);
            }
            Box::new(flate)
        };
        Ok(OwnedDecodePipeline::Stage(stage))
    }
}

impl FlateLzwStreamFilter {
    fn set_warning_callback(&mut self, callback: FilterWarningCallback) {
        self.warning_callback = Some(callback);
    }

    /// Resolve the predictor geometry the decode chain needs, if any.
    ///
    /// This reproduces the failures `SF_FlateLzwDecode::getDecodePipeline`
    /// raises while constructing the chain, so both the preflight and the
    /// decode itself reject exactly the same parameters.
    fn decode_predictor_geometry(&self) -> Result<Option<PredictorGeometry>> {
        let kind = if (10..=15).contains(&self.predictor) {
            Some(PredictorKind::Png)
        } else if self.predictor == 2 {
            Some(PredictorKind::Tiff)
        } else {
            None
        };
        kind.map(|kind| {
            Ok(PredictorGeometry {
                kind,
                columns: to_uint(self.columns)?,
                colors: to_uint(self.colors)?,
                bits_per_component: to_uint(self.bits_per_component)?,
            })
        })
        .transpose()
    }
}

fn make_predictor_pipeline<'a>(
    geometry: PredictorGeometry,
    next: impl Into<PipelineRef<'a>>,
    action: PredictorAction,
) -> Result<PipelineRef<'a>> {
    let next = next.into();
    let pipeline = match (geometry.kind, action) {
        #[cfg(test)]
        (PredictorKind::Png, PredictorAction::Encode) => Box::new(
            PngFilter::new(
                "png encode",
                next,
                PngFilterAction::Encode,
                geometry.columns,
                geometry.colors,
                geometry.bits_per_component,
            )
            .map_err(map_pipeline_error)?,
        ) as Box<dyn Pipeline + 'a>,
        (PredictorKind::Png, PredictorAction::Decode) => Box::new(
            PngFilter::new(
                "png decode",
                next,
                PngFilterAction::Decode,
                geometry.columns,
                geometry.colors,
                geometry.bits_per_component,
            )
            .map_err(map_pipeline_error)?,
        ) as Box<dyn Pipeline + 'a>,
        #[cfg(test)]
        (PredictorKind::Tiff, PredictorAction::Encode) => Box::new(
            TiffPredictor::new(
                "tiff encode",
                next,
                TiffPredictorAction::Encode,
                geometry.columns,
                geometry.colors,
                geometry.bits_per_component,
            )
            .map_err(map_pipeline_error)?,
        ) as Box<dyn Pipeline + 'a>,
        (PredictorKind::Tiff, PredictorAction::Decode) => Box::new(
            TiffPredictor::new(
                "tiff decode",
                next,
                TiffPredictorAction::Decode,
                geometry.columns,
                geometry.colors,
                geometry.bits_per_component,
            )
            .map_err(map_pipeline_error)?,
        ) as Box<dyn Pipeline + 'a>,
    };
    Ok(PipelineRef::Owned(pipeline))
}

struct Ascii85StreamFilter;

impl StreamFilter for Ascii85StreamFilter {
    /// Mirrors `SF_ASCII85Decode::getDecodePipeline`
    /// (`libqpdf/qpdf/SF_ASCII85Decode.hh:14-19`), a single `Pl_ASCII85Decoder`.
    fn get_decode_pipeline<'a>(
        &mut self,
        next: PipelineRef<'a>,
    ) -> Result<OwnedDecodePipeline<'a>> {
        Ok(OwnedDecodePipeline::Stage(Box::new(Ascii85Decoder::new(
            "ascii85 decode",
            next,
        ))))
    }
}

struct AsciiHexStreamFilter;

impl StreamFilter for AsciiHexStreamFilter {
    /// Mirrors `SF_ASCIIHexDecode::getDecodePipeline`
    /// (`libqpdf/qpdf/SF_ASCIIHexDecode.hh:14-19`), a single
    /// `Pl_ASCIIHexDecoder`.
    fn get_decode_pipeline<'a>(
        &mut self,
        next: PipelineRef<'a>,
    ) -> Result<OwnedDecodePipeline<'a>> {
        Ok(OwnedDecodePipeline::Stage(Box::new(AsciiHexDecoder::new(
            "asciiHex decode",
            next,
        ))))
    }
}

struct RunLengthStreamFilter;

impl StreamFilter for RunLengthStreamFilter {
    /// Mirrors `SF_RunLengthDecode::getDecodePipeline`
    /// (`libqpdf/qpdf/SF_RunLengthDecode.hh:14-20`), a single `Pl_RunLength`
    /// in its decode action.
    fn get_decode_pipeline<'a>(
        &mut self,
        next: PipelineRef<'a>,
    ) -> Result<OwnedDecodePipeline<'a>> {
        Ok(OwnedDecodePipeline::Stage(Box::new(RunLength::new(
            "runlength decode",
            next,
            RunLengthAction::Decode,
        ))))
    }

    fn is_specialized_compression(&self) -> bool {
        true
    }
}

struct DctStreamFilter;

impl StreamFilter for DctStreamFilter {
    /// Mirrors `SF_DCTDecode::getDecodePipeline`
    /// (`libqpdf/qpdf/SF_DCTDecode.hh:14-19`), a single `Pl_DCT` decode stage.
    fn get_decode_pipeline<'a>(
        &mut self,
        next: PipelineRef<'a>,
    ) -> Result<OwnedDecodePipeline<'a>> {
        Ok(OwnedDecodePipeline::Stage(Box::new(PlDct::new(
            "DCT decode",
            next,
        ))))
    }

    fn is_specialized_compression(&self) -> bool {
        true
    }

    fn is_lossy_compression(&self) -> bool {
        true
    }
}

/// Port of the anonymous-namespace `SF_Crypt` in `libqpdf/QPDF_Stream.cc:27-58`.
///
/// It decodes nothing. Its whole contribution is deciding filterability from
/// `/DecodeParms`, which is why qpdf lists it in `filter_factories`
/// (`QPDF_Stream.cc:85-94`) beside that table's six codec filters even though
/// its `getDecodePipeline` returns `nullptr`.
struct CryptStreamFilter;

impl StreamFilter for CryptStreamFilter {
    /// Port of `SF_Crypt::setDecodeParms` (`QPDF_Stream.cc:33-50`).
    ///
    /// Every key must be `Type` or `Name`, and a present `Type` must name
    /// `/CryptFilterDecodeParms`. Observed against qpdf 11.9.0 on 2026-08-08
    /// through `qpdf --show-object=4 --filtered-stream-data` over a stream
    /// whose `/Filter` is `/Crypt`: `<< /Name /Identity >>`,
    /// `<< /Type /CryptFilterDecodeParms >>` and `<< >>` exit 0, while
    /// `<< /Type /Foo >>`, `<< /Foo 1 >>` and
    /// `<< /Type /CryptFilterDecodeParms /Foo 1 >>` exit 2 with "unable to
    /// filter stream data".
    ///
    /// The key test and its short-circuit order stay inside the loop, as qpdf
    /// evaluates them. In particular, `hasKey` and
    /// `isDictionaryOfType` are reached only for an allowed key, after
    /// `getKeys` has inspected the parameter object; this preserves warning
    /// and resolution timing for non-dictionary and malformed inputs.
    fn set_decode_params(&mut self, decode_params: &ObjectHandle) -> Result<bool> {
        if decode_params.try_is_null()? {
            return Ok(true);
        }
        let mut filterable = true;
        for key in decode_params.try_get_keys()? {
            let is_allowed_key = (key.as_slice() == b"/Type") || (key.as_slice() == b"/Name");
            if is_allowed_key
                && (!decode_params.try_has_key(b"/Type")?
                    || decode_params.try_is_dictionary_of_type(b"CryptFilterDecodeParms", b"")?)
            {
                // qpdf handles these two in decryptStream.
            } else {
                filterable = false;
            }
        }
        Ok(filterable)
    }

    /// Port of `SF_Crypt::getDecodePipeline` (`QPDF_Stream.cc:52-56`), whose
    /// whole body returns `nullptr`: a `Crypt` stage contributes no decode
    /// stage, because decryption happens in `decryptStream` instead.
    ///
    /// A caller that installs this `None` must therefore already be reading
    /// through a decrypting source; qpdf's filter loop
    /// (`QPDF_Stream.cc:559-568`) runs after `decryptStream` has been applied
    /// to the source bytes. Without such a source the stage is not merely
    /// absent but wrong, and silently so — ciphertext would pass through as
    /// plaintext with neither an error nor a warning, which is why the
    /// decode route below refuses instead of returning the bytes.
    fn get_decode_pipeline<'a>(
        &mut self,
        _next: PipelineRef<'a>,
    ) -> Result<OwnedDecodePipeline<'a>> {
        Ok(OwnedDecodePipeline::NoStage(_next))
    }
}

pub(crate) trait RegisteredStreamFilter {
    fn set_decode_params(&mut self, decode_params: &ObjectHandle) -> Result<bool>;

    fn get_decode_pipeline<'a>(&mut self, next: PipelineRef<'a>)
        -> Result<OwnedDecodePipeline<'a>>;

    fn set_warning_callback(&mut self, _callback: FilterWarningCallback) {}

    fn is_specialized_compression(&self) -> bool;

    fn is_lossy_compression(&self) -> bool;
}

struct CustomStreamFilter {
    inner: Box<dyn StreamFilter>,
}

impl RegisteredStreamFilter for CustomStreamFilter {
    fn set_decode_params(&mut self, decode_params: &ObjectHandle) -> Result<bool> {
        self.inner.set_decode_params(decode_params)
    }

    fn get_decode_pipeline<'a>(
        &mut self,
        next: PipelineRef<'a>,
    ) -> Result<OwnedDecodePipeline<'a>> {
        self.inner.get_decode_pipeline(next)
    }

    fn is_specialized_compression(&self) -> bool {
        self.inner.is_specialized_compression()
    }

    fn is_lossy_compression(&self) -> bool {
        self.inner.is_lossy_compression()
    }
}

struct BuiltinStreamFilter<T> {
    inner: T,
}

impl<T: StreamFilter> RegisteredStreamFilter for BuiltinStreamFilter<T> {
    fn set_decode_params(&mut self, decode_params: &ObjectHandle) -> Result<bool> {
        self.inner.set_decode_params(decode_params)
    }

    fn get_decode_pipeline<'a>(
        &mut self,
        next: PipelineRef<'a>,
    ) -> Result<OwnedDecodePipeline<'a>> {
        self.inner.get_decode_pipeline(next)
    }

    fn is_specialized_compression(&self) -> bool {
        self.inner.is_specialized_compression()
    }

    fn is_lossy_compression(&self) -> bool {
        self.inner.is_lossy_compression()
    }
}

struct BuiltinFlateStreamFilter {
    inner: FlateLzwStreamFilter,
}

impl RegisteredStreamFilter for BuiltinFlateStreamFilter {
    fn set_decode_params(&mut self, decode_params: &ObjectHandle) -> Result<bool> {
        self.inner.set_decode_params(decode_params)
    }

    fn get_decode_pipeline<'a>(
        &mut self,
        next: PipelineRef<'a>,
    ) -> Result<OwnedDecodePipeline<'a>> {
        self.inner.get_decode_pipeline(next)
    }

    fn set_warning_callback(&mut self, callback: FilterWarningCallback) {
        self.inner.set_warning_callback(callback);
    }

    fn is_specialized_compression(&self) -> bool {
        self.inner.is_specialized_compression()
    }

    fn is_lossy_compression(&self) -> bool {
        self.inner.is_lossy_compression()
    }
}

type CustomFilterFactory = Arc<dyn Fn() -> Result<Box<dyn StreamFilter>> + Send + Sync + 'static>;

#[derive(Clone)]
enum FilterFactory {
    Builtin(fn() -> Box<dyn RegisteredStreamFilter>),
    Custom(CustomFilterFactory),
}

static FILTER_FACTORIES: OnceLock<Mutex<BTreeMap<Vec<u8>, FilterFactory>>> = OnceLock::new();

fn filter_factories() -> &'static Mutex<BTreeMap<Vec<u8>, FilterFactory>> {
    FILTER_FACTORIES.get_or_init(|| {
        Mutex::new(BTreeMap::from([
            (
                b"/Crypt".to_vec(),
                FilterFactory::Builtin(|| {
                    Box::new(BuiltinStreamFilter {
                        inner: CryptStreamFilter,
                    })
                }),
            ),
            (
                b"/FlateDecode".to_vec(),
                FilterFactory::Builtin(|| {
                    Box::new(BuiltinFlateStreamFilter {
                        inner: FlateLzwStreamFilter::new(false),
                    })
                }),
            ),
            (
                b"/LZWDecode".to_vec(),
                FilterFactory::Builtin(|| {
                    Box::new(BuiltinFlateStreamFilter {
                        inner: FlateLzwStreamFilter::new(true),
                    })
                }),
            ),
            (
                b"/ASCII85Decode".to_vec(),
                FilterFactory::Builtin(|| {
                    Box::new(BuiltinStreamFilter {
                        inner: Ascii85StreamFilter,
                    })
                }),
            ),
            (
                b"/ASCIIHexDecode".to_vec(),
                FilterFactory::Builtin(|| {
                    Box::new(BuiltinStreamFilter {
                        inner: AsciiHexStreamFilter,
                    })
                }),
            ),
            (
                b"/RunLengthDecode".to_vec(),
                FilterFactory::Builtin(|| {
                    Box::new(BuiltinStreamFilter {
                        inner: RunLengthStreamFilter,
                    })
                }),
            ),
            (
                b"/DCTDecode".to_vec(),
                FilterFactory::Builtin(|| {
                    Box::new(BuiltinStreamFilter {
                        inner: DctStreamFilter,
                    })
                }),
            ),
        ]))
    })
}

fn registry_guard() -> MutexGuard<'static, BTreeMap<Vec<u8>, FilterFactory>> {
    filter_factories()
        .lock()
        .unwrap_or_else(std::sync::PoisonError::into_inner)
}

/// Register a qpdf-shaped decode filter factory for the canonical internal name.
///
/// The name is stored exactly as supplied, including its leading slash. qpdf's
/// `QPDF::registerStreamFilter` is process-global and replaces an existing
/// factory with the same key (`include/qpdf/QPDF.hh:186-194`,
/// `libqpdf/QPDF.cc:295-300`). The factory is cloned out of the registry before
/// invocation, so user code may register another filter while a factory runs.
pub fn register_stream_filter<F, S>(name: impl AsRef<[u8]>, factory: F)
where
    F: Fn() -> Result<S> + Send + Sync + 'static,
    S: StreamFilter + 'static,
{
    let factory =
        Arc::new(move || factory().map(|filter| Box::new(filter) as Box<dyn StreamFilter>));
    let key = name.as_ref().to_vec();
    let previous = {
        let mut registry = registry_guard();
        registry.insert(key, FilterFactory::Custom(factory))
    };
    drop(previous);
}

/// Construct the filter registered under `filter_name`, if any.
///
/// The PDF object model stores decoded name bytes without its separator slash;
/// a decoded slash is therefore part of the payload and must not be mistaken
/// for that separator. qpdf's registry stores canonical internal names with
/// one separator slash. Alias expansion is performed before this lookup,
/// matching `QPDF_Stream::filterable`.
pub(crate) fn stream_filter_for(
    filter_name: &[u8],
) -> Result<Option<Box<dyn RegisteredStreamFilter>>> {
    let normalized = normalize_filter_name(filter_name);
    let mut key = Vec::with_capacity(normalized.len() + 1);
    key.push(b'/');
    key.extend_from_slice(normalized);
    let factory = registry_guard().get(&key).cloned();
    match factory {
        None => Ok(None),
        Some(FilterFactory::Builtin(factory)) => Ok(Some(factory())),
        Some(FilterFactory::Custom(factory)) => {
            Ok(Some(Box::new(CustomStreamFilter { inner: factory()? })))
        }
    }
}

pub(crate) fn encode_flate(data: &[u8]) -> Result<Vec<u8>> {
    let mut sink = Buffer::new("stream data buffer", None);
    {
        let mut flate = Flate::new(
            "compress stream",
            &mut sink,
            FlateAction::Deflate,
            DEFAULT_OUT_BUFFER_SIZE,
        )
        .map_err(map_pipeline_error)?;
        flate.write(data).map_err(map_pipeline_error)?;
        flate.finish().map_err(map_pipeline_error)?;
    }
    sink.take_buffer().map_err(map_pipeline_error)
}

/// Resolve the predictor geometry a writer must apply for `/DecodeParms`.
///
/// Returns `Ok(None)` when the parameters select no predictor. The
/// parameters are validated through the same `SF_FlateLzwDecode` state the
/// decode path uses, so both directions accept exactly the same dictionaries.
#[cfg(test)]
fn predictor_encode_geometry(
    filter_name: &[u8],
    decode_params: &ObjectHandle,
) -> Result<Option<PredictorGeometry>> {
    // qpdf's default QPDFStreamFilter::setDecodeParms accepts only a null
    // object. ASCII85, ASCIIHex, and RunLength inherit that contract; only
    // SF_FlateLzwDecode consumes predictor parameters. Validate the registered
    // non-Flate filter here so encoding cannot produce bytes for a stream that
    // the inverse decode path rejects.
    if !matches!(filter_name, b"FlateDecode" | b"LZWDecode") {
        let Some(mut filter) = stream_filter_for(filter_name)? else {
            // Let the codec encoder report an unknown or passthrough filter.
            return Ok(None);
        };
        if !filter.set_decode_params(decode_params)? {
            return Err(Error::Unsupported(format!(
                "stream filter {} does not support supplied /DecodeParms",
                String::from_utf8_lossy(filter_name)
            )));
        }
        return Ok(None);
    }

    let mut filter = FlateLzwStreamFilter::new(filter_name == b"LZWDecode");
    if !filter.set_decode_params(decode_params)? {
        return Err(Error::Unsupported(format!(
            "stream filter {} does not support supplied /DecodeParms",
            String::from_utf8_lossy(filter_name)
        )));
    }
    filter.decode_predictor_geometry()
}

/// Apply the predictor selected by `/DecodeParms` before a codec's encode step.
#[cfg(test)]
pub(crate) fn encode_predictor(
    data: &[u8],
    filter_name: &[u8],
    decode_params: &ObjectHandle,
) -> Result<Vec<u8>> {
    let Some(geometry) = predictor_encode_geometry(filter_name, decode_params)? else {
        return Ok(data.to_vec());
    };
    encode_predictor_stage(data, geometry)
}

#[cfg(test)]
fn encode_predictor_stage(data: &[u8], geometry: PredictorGeometry) -> Result<Vec<u8>> {
    let mut sink = Buffer::new("stream data buffer", None);
    {
        let mut predictor = make_predictor_pipeline(geometry, &mut sink, PredictorAction::Encode)?;
        predictor.write(data).map_err(map_pipeline_error)?;
        predictor.finish().map_err(map_pipeline_error)?;
    }
    sink.take_buffer().map_err(map_pipeline_error)
}

#[cfg(test)]
mod tests {
    use super::{FlateLzwStreamFilter, StreamFilter};
    use crate::ObjectHandle;

    #[test]
    fn flate_filter_consumes_qpdf_canonical_slash_prefixed_keys() {
        let mut filter = FlateLzwStreamFilter::new(false);
        let params =
            ObjectHandle::dictionary(vec![(b"/Predictor".to_vec(), ObjectHandle::integer(2))]);

        assert!(filter.set_decode_params(&params).unwrap());
        assert_eq!(filter.predictor, 2);
    }

    #[test]
    fn flate_setter_rejects_non_integer_geometry_parameters() {
        for key in [b"/Predictor".as_slice(), b"/Columns"] {
            let params = ObjectHandle::dictionary(vec![(
                key.to_vec(),
                ObjectHandle::name(b"not-an-integer".to_vec()),
            )]);
            let mut filter = FlateLzwStreamFilter::new(false);
            assert!(!filter.set_decode_params(&params).unwrap());
        }

        let params = ObjectHandle::dictionary(vec![(
            b"/EarlyChange".to_vec(),
            ObjectHandle::name(b"not-an-integer".to_vec()),
        )]);
        let mut filter = FlateLzwStreamFilter::new(true);
        assert!(!filter.set_decode_params(&params).unwrap());
    }

    #[test]
    fn flate_reader_preserves_canonical_key_matching_and_ignores_raw_unknown_keys() {
        fn decode_params(key: &[u8]) -> ObjectHandle {
            let params = ObjectHandle::dictionary(vec![]);
            params
                .replace_key(key, ObjectHandle::integer(2))
                .expect("decode parameter dictionary is mutable");
            params
        }

        let canonical = decode_params(b"/Predictor");
        let raw = decode_params(b"Predictor");
        let special_unknown = decode_params(b"/Predictor B");

        let mut canonical_filter = FlateLzwStreamFilter::new(false);
        assert!(canonical_filter.set_decode_params(&canonical).unwrap());
        assert_eq!(canonical_filter.predictor, 2);

        let mut raw_filter = FlateLzwStreamFilter::new(false);
        assert!(raw_filter.set_decode_params(&raw).unwrap());
        assert_eq!(raw_filter.predictor, 1);

        let mut special_filter = FlateLzwStreamFilter::new(false);
        assert!(special_filter.set_decode_params(&special_unknown).unwrap());
        assert_eq!(special_filter.predictor, 1);
    }

    #[test]
    fn flate_setter_warns_only_when_qpdf_reads_an_integer_parameter() {
        let (huge, recorder) = crate::object_handle::warning_emission_tests::handle_resolving(
            crate::object_handle::ObjectValue::Integer(i64::MAX),
        );
        let params = ObjectHandle::dictionary(vec![
            (b"Columns".to_vec(), huge.clone()),
            (b"Foo".to_vec(), huge.clone()),
            (b"EarlyChange".to_vec(), huge),
        ]);
        let mut filter = FlateLzwStreamFilter::new(false);

        assert!(filter.set_decode_params(&params).unwrap());
        assert_eq!(
            crate::object_handle::warning_emission_tests::warnings(&recorder),
            vec!["object 3 0: requested value of integer is too big; returning INT_MAX"]
        );
    }

    #[test]
    fn base_stream_filter_accepts_only_null_decode_parameters() {
        let mut filter = super::AsciiHexStreamFilter;
        assert!(filter.set_decode_params(&ObjectHandle::null()).unwrap());
        assert!(!filter
            .set_decode_params(&ObjectHandle::dictionary(vec![]))
            .unwrap());
    }

    #[test]
    fn crypt_reader_preserves_qpdf_name_and_type_validation() {
        fn decode_params(entries: Vec<(Vec<u8>, ObjectHandle)>) -> ObjectHandle {
            ObjectHandle::dictionary(entries)
        }

        let mut identity_filter = super::CryptStreamFilter;
        let identity = decode_params(vec![(
            b"/Name".to_vec(),
            ObjectHandle::name(b"Identity".to_vec()),
        )]);
        assert!(identity_filter.set_decode_params(&identity).unwrap());

        let mut valid_type_filter = super::CryptStreamFilter;
        let valid_type = decode_params(vec![(
            b"/Type".to_vec(),
            ObjectHandle::name(b"CryptFilterDecodeParms".to_vec()),
        )]);
        assert!(valid_type_filter.set_decode_params(&valid_type).unwrap());

        let mut unknown_key_filter = super::CryptStreamFilter;
        let unknown_key = decode_params(vec![(b"/Foo".to_vec(), ObjectHandle::integer(1))]);
        assert!(!unknown_key_filter.set_decode_params(&unknown_key).unwrap());

        let mut invalid_type_filter = super::CryptStreamFilter;
        let invalid_type = decode_params(vec![(
            b"/Type".to_vec(),
            ObjectHandle::name(b"Foo".to_vec()),
        )]);
        assert!(!invalid_type_filter
            .set_decode_params(&invalid_type)
            .unwrap());

        let mut null_filter = super::CryptStreamFilter;
        assert!(null_filter
            .set_decode_params(&ObjectHandle::null())
            .unwrap());
    }

    #[test]
    fn crypt_setter_reads_a_non_dictionary_once_before_accepting_empty_keys() {
        let (params, recorder) = crate::object_handle::warning_emission_tests::handle_resolving(
            crate::object_handle::ObjectValue::Integer(1),
        );
        let mut filter = super::CryptStreamFilter;

        assert!(filter.set_decode_params(&params).unwrap());
        assert_eq!(
            crate::object_handle::warning_emission_tests::warnings(&recorder),
            vec![
                "object 3 0: operation for dictionary attempted on object of type integer: treating as empty"
            ]
        );
    }

    #[test]
    fn lzw_reader_consumes_only_canonical_early_change_keys() {
        fn decode_params(_filter_name: &[u8], key: &[u8], value: i64) -> ObjectHandle {
            let params = ObjectHandle::dictionary(vec![]);
            params
                .replace_key(key, ObjectHandle::integer(value))
                .expect("decode parameter dictionary is mutable");
            params
        }

        for (value, expected_filterable, expected_early_change) in
            [(0, true, false), (1, true, true), (2, false, false)]
        {
            let params = decode_params(b"LZWDecode", b"/EarlyChange", value);
            let mut filter = FlateLzwStreamFilter::new(true);
            assert_eq!(
                filter.set_decode_params(&params).unwrap(),
                expected_filterable
            );
            assert_eq!(filter.early_code_change, expected_early_change);
        }

        let raw = decode_params(b"LZWDecode", b"EarlyChange", 0);
        let mut raw_filter = FlateLzwStreamFilter::new(true);
        assert!(raw_filter.set_decode_params(&raw).unwrap());
        assert!(raw_filter.early_code_change);

        let flate = decode_params(b"FlateDecode", b"/EarlyChange", 0);
        let mut flate_filter = FlateLzwStreamFilter::new(false);
        assert!(flate_filter.set_decode_params(&flate).unwrap());
        assert!(flate_filter.early_code_change);
    }

    #[test]
    fn encode_predictor_uses_the_tiff_stream_filter_pipeline() {
        let params = ObjectHandle::dictionary(vec![
            (b"/Predictor".to_vec(), ObjectHandle::integer(2)),
            (b"/Columns".to_vec(), ObjectHandle::integer(2)),
            (b"/Colors".to_vec(), ObjectHandle::integer(1)),
            (b"/BitsPerComponent".to_vec(), ObjectHandle::integer(8)),
        ]);

        assert_eq!(
            super::encode_predictor(&[10, 20], b"FlateDecode", &params).unwrap(),
            [10, 10]
        );
    }

    #[test]
    fn encode_predictor_leaves_unknown_filter_data_unchanged() {
        assert_eq!(
            super::encode_predictor(b"payload", b"UnknownFilter", &ObjectHandle::null()).unwrap(),
            b"payload"
        );
    }
}