byblos

package module

Go to main page

Versions in this module

v0

v0.4.0

Aug 19, 2026

Changes in this version

+ const MaxSkewDeg

+ func ValidatePages(pages []PageSource) error

+ type RasterRefusal struct

+ Class string

+ Page int

+ Reason string

+ func (e *RasterRefusal) Error() string

+ func (e *RasterRefusal) Unwrap() error

v0.3.0

Aug 17, 2026

Changes in this version

+ func BuildFromPages(w io.Writer, pages []PageSource) error

+ func BuildFromPagesContext(ctx context.Context, w io.Writer, pages []PageSource) error

+ func BuildPDFContext(ctx context.Context, w io.Writer, pages []BuildPage) error

+ func OptimizeContext(ctx context.Context, w io.Writer, r io.ReadSeeker, opts OptimizeOptions) error

+ func ReplaceImagesContext(ctx context.Context, w io.Writer, r io.ReadSeeker, subs map[int]EncodedImage) error

+ func StampTextLayerContext(ctx context.Context, w io.Writer, r io.ReadSeeker, tl TextLayer) error

+ func WriteProvenanceContext(ctx context.Context, r io.ReadSeeker, w io.Writer, p Provenance) error

+ type Diagnostic struct

+ Message string

+ Severity Severity

type ImageRef

+ PlacementDeg float64

+ Substitutable bool

type PageGeometry

+ RasterQuad *[8]float64

type PageInfo

+ Diagnostics []Diagnostic

+ Rotate int

+ func InspectContext(ctx context.Context, r io.ReadSeeker) ([]PageInfo, error)

type PageProvenance

+ Straightened *PageStraighten

type PageRaster

+ Bitonal bool

+ ObjNr int

+ RasterQuad *[8]float64

+ func ExtractPageRasterContext(ctx context.Context, r io.ReadSeeker, page int) (*PageRaster, error)

+ type PageSource = pdfdoc.PageSource

+ type PageStraighten struct

+ Deg float64

type Provenance

+ func ReadProvenanceContext(ctx context.Context, r io.ReadSeeker) (*Provenance, error)

+ func RecordExtractionContext(ctx context.Context, r io.ReadSeeker) (Provenance, error)

+ type Severity uint8

+ const SeverityError

+ const SeverityWarning

+ func (s Severity) String() string

+ type StraightenSpec = pdfdoc.StraightenSpec

v0.2.0

Aug 6, 2026

Changes in this version

+ var ErrUnsupportedJBIG2Feature = errors.New("byblos: JBIG2 stream uses a feature byblos does not decode")

+ func DownsampleDeclaredBPC(img image.Image, declaredBPC int, srcDPI, dstDPI float64) (image.Image, error)

type Bitmap

+ func DecodeJBIG2Generic(data []byte) (*Bitmap, error)

type ImageRef

+ Filter string

v0.1.0

Aug 4, 2026

Changes in this version

+ const CapabilityJBIG2Generic

+ const Version

+ var ErrNotImplemented = errors.New("byblos: not implemented")

+ var ErrNotSingleRaster = errors.New("byblos: page is not a single raster")

+ var ErrUnstampableRune = errors.New("byblos: rune is outside the glyphless font's coverage")

+ var ErrUnsupportedImageCodec = errors.New("byblos: page raster uses an image codec byblos cannot decode")

+ func BuildPDF(w io.Writer, pages []BuildPage) error

+ func Capabilities() []string

+ func Downsample(img image.Image, srcDPI, dstDPI float64) (image.Image, error)

+ func EncodeJBIG2Generic(b *Bitmap) ([]byte, error)

+ func Optimize(w io.Writer, r io.ReadSeeker, opts OptimizeOptions) error

+ func QuantizePNG(img image.Image, colors int) ([]byte, error)

+ func ReplaceImages(w io.Writer, r io.ReadSeeker, subs map[int]EncodedImage) error

+ func ResetExtractStats()

+ func StampTextLayer(w io.Writer, r io.ReadSeeker, tl TextLayer) error

+ func UpgradeCandidates(p *Provenance, current []string) []string

+ func WriteProvenance(r io.ReadSeeker, w io.Writer, p Provenance) error

+ type Bitmap struct

+ Height int

+ Pix []byte

+ Stride int

+ Width int

+ func NewBitmap(w, h int) *Bitmap

+ func Sauvola(img image.Image) (*Bitmap, error)

+ func (b *Bitmap) At(x, y int) uint8

+ func (b *Bitmap) Bounds() image.Rectangle

+ func (b *Bitmap) Clone() *Bitmap

+ func (b *Bitmap) Equal(o *Bitmap) bool

+ func (b *Bitmap) Set(x, y int, v uint8)

+ type BuildPage struct

+ DPI float64

+ HeightPt float64

+ Image EncodedImage

+ WidthPt float64

+ type ColorSpace = pdfdoc.ColorSpace

+ type DecodeParms = pdfdoc.DecodeParms

+ type EncodedImage = pdfdoc.EncodedImage

+ func QuantizeIndexed(img image.Image, colors int) (EncodedImage, error)

+ type ExtractCounters struct

+ Attempted uint64

+ Diverted uint64

+ Extracted uint64

+ Failed uint64

+ Partial uint64

+ Reasons map[string]uint64

+ func ExtractStats() ExtractCounters

+ func (c ExtractCounters) DivertRate() float64

+ func (c ExtractCounters) UnhandledRate() float64

+ type ImageRef struct

+ Bitonal bool

+ Bounds image.Rectangle

+ Height int

+ ObjNr int

+ Placement [6]float64

+ Width int

+ type NotImplemented struct

+ Capability string

+ Issue string

+ Why string

+ func (e *NotImplemented) Error() string

+ func (e *NotImplemented) Unwrap() error

+ type OptimizeOptions struct

+ JPEGQuality int

+ Linearize bool

+ RecompressJPEG bool

+ type PageGeometry struct

+ ClipBox *[4]float64

+ PageBox [4]float64

+ RasterBox [4]float64

+ func (g PageGeometry) CoversPage() bool

+ type PageInfo struct

+ Bounds image.Rectangle

+ Images []ImageRef

+ Index int

+ TextChars int

+ func Inspect(r io.ReadSeeker) ([]PageInfo, error)

+ type PageProvenance struct

+ Applied []string

+ Diverted string

+ DroppedAnnots int

+ Geometry *PageGeometry

+ Placement []float64

+ type PageRaster struct

+ Bounds image.Rectangle

+ DroppedAnnots int

+ Image image.Image

+ Page image.Rectangle

+ func ExtractPageRaster(r io.ReadSeeker, page int) (*PageRaster, error)

+ func (p PageRaster) CoversPage() bool

+ type PositionedWord struct

+ Bounds image.Rectangle

+ Text string

+ type Provenance struct

+ Capabilities []string

+ Optimized string

+ Pages []PageProvenance

+ ProcessedAt time.Time

+ Version string

+ func ReadProvenance(r io.ReadSeeker) (*Provenance, error)

+ func RecordExtraction(r io.ReadSeeker) (Provenance, error)

+ type TextLayer struct

+ Pages [][]PositionedWord

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL