pixbooster

package module
v0.1.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 6, 2024 License: LGPL-2.1 Imports: 24 Imported by: 0

README

Caddy Pixbooster

On-the-fly image conversion for maximal network performances

DO NOT USE IN PRODUCTION!

This work is at its very early stages and should only be used for testing.

Desription

Pixbooster does two things:

  1. it adds modern files format sources (WebP, AVIF and JXL) to the HTML,
  2. it serve those files by converting the orignal ones on the fly, from saved files after.
How <img> is handled

When Pixbooster meet a <img> tag out of any picture tag, it wrap this <img> in a new <picture> and add <source> tags for each modern formats.

So:

<img src="test.jpg" style="width: 100px" title="test" alt="alt">

became:

<picture style="width: 100px" title="test"><source srcset="test.jpg.pixbooster.jxl" type="image/jxl"/><source srcset="test.jpg.pixbooster.avif" type="image/avif"/><source srcset="test.jpg.pixbooster.webp" type="image/webp"/><img src="test.jpg" style="width: 100px" title="test" alt="alt"/></picture>

The pixbooster is afterward used by Pixbooster to know which files it have to generate.

How <picture> is handled

When Pixbooster met a <picture>, it generate a new <source> for each <source> it contains and for each modern formats.

So:

<picture>
    <source srcset="test3.png" type="image/png"  media="(min-width: 800px)">
    <img src="test2.png" style="width: 100px" title="test" alt="alt">
</picture>

became:

<picture>
    <source media="(min-width: 800px)" srcset="test3.png.pixbooster.jxl" type="image/jxl"/><source media="(min-width: 800px)" srcset="test3.png.pixbooster.avif" type="image/avif"/><source media="(min-width: 800px)" srcset="test3.png.pixbooster.webp" type="image/webp"/><source srcset="test3.png" type="image/png" media="(min-width: 800px)"/>
    <img src="test2.png" style="width: 100px" title="test" alt="alt"/>
</picture>

How to test

Clone
$ git clone https://github.com/PixyBlue/caddy-pixbooster.git
$ cd caddy-pixbooster
Configure

Here is a Caddyfile sample for tests:

{
    debug
}

http://localhost:8080 {
    root ./public
    route {
        pixbooster
    }
    file_server
}

pixbooster accept some options to disable some image formats to be treaten or to be produce:

  • nojpg, nopng, nowebpinput make Pixbooster ignore respectively JPEG, PNG and WebP files in the incomming HTML,
  • nowebpouput, noavif, nojxl disable adding sources respectively for WebP, AVIF and JXL formats in the incomming HTML and avoid the conversion of such files from request URL.
Provide some contents
$ mkdir public
$ echo '<!DOCTYPE html>
<html>

<head>
    <title>Foo</title>
</head>

<body>
    <img src="test.jpg" style="width: 100px" title="test" alt="alt">
    <img src="test5.png" srcset="test6.png 2x, test7.png 1x" style="width: 100px" title="test" alt="alt">
    <picture>
        <source srcset="test3.png" type="image/png" media="(min-width: 800px)">
        <img src="test2.png" style="width: 100px" title="test" alt="alt">
    </picture>
</body>

</html>' > public/index.html

Add needed picture files to public.

Build & Run
$ CGO_ENABLED=1 xcaddy run --config Caddyfile #CGO is required to enable convertion to the WebP format
See the magic
$ curl http://localhost:8080

Detailed configuration

Syntax
pixbooster [nowebpoutput|noavif|nojxl|nojpg|nopng] {
	[nowebpoutput|noavif|nojxl|nojpg|nopng]
	quality <integer between 0 and 100>
    storage <path where to store optimized files>
	webp {
		quality <integer between 0 and 100>
		lossless
		exact
	}
	avif {
		quality <integer between 0 and 100>
		qualityalpha <integer between 0 and 100>
		speed <integer between 0 and 10>
	}
	jxl {
		quality <integer between 0 and 100>
		effort <integer between 0 and 10>
	}
}

Pixbooster must be enabled in a route directive.

Samples

The Caddfyfile configuration enable you to access to all options offered by the libraries we use. Here is a complete sample:

http://localhost:8080 {
    route {
        pixbooster {
            nowebpoutput
            nojxl
            avif {
                quality 65
                speed 7
            }
        }
    }
}

TODO ?

  • Provide JXL polyfill
  • Add data-pixbooster-quality html attribute to force quality setting on individual picture
  • Handle CSS
  • Completly avoid CGO to support WebP output

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Pixbooster 

type Pixbooster struct {

	// Path where to store the modern image files. Optional.
	Storage string `json:"storage,omitempty"`
	// Disable Webp output if present.
	Nowebpoutput bool `json:"nowebpoutput,omitempty"`
	// Disable treatment of Webp files in the incomming HTML if present.
	Nowebpinput bool `json:"nowebpinput,omitempty"`
	// Disable Avif output  if present.
	Noavif bool `json:"noavif,omitempty"`
	// Disable JXL output if present.
	Nojxl bool `json:"nojxl,omitempty"`
	// Disable treatment of JPEG files in the incomming HTML if present.
	Nojpeg bool `json:"nojpeg,omitempty"`
	// Disable treatment of PNG files in the incomming HTML if present.
	Nopng bool `json:"nopng,omitempty"`

	// Quality of output pictures, a integer between 0 and 100. Optional.
	Quality int `json:"quality,omitempty"`
	// Set specific Webp ouput options.
	WebpConfig WebpConfig `json:"webp_config,omitempty"`
	// Set specific Avif ouput options.
	AvifConfig avif.Options `json:"avif_config,omitempty"`
	// Set specific JXL ouput options.
	JxlConfig jpegxl.Options `json:"jxl_config,omitempty"`
	// contains filtered or unexported fields
}

Pixbooster allows your server to provide pictures in modern file formats (webp, avif, jxl) on the fly without requiring you to change your html.

func (Pixbooster) CaddyModule 

func (Pixbooster) CaddyModule() caddy.ModuleInfo

func (*Pixbooster) Provision 

func (p *Pixbooster) Provision(ctx caddy.Context) error

func (Pixbooster) ServeHTTP 

func (p Pixbooster) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error

func (*Pixbooster) UnmarshalCaddyfile 

func (p *Pixbooster) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

UnmarshalCaddyfile implements caddyfile.Unmarshaler. Syntax: 

pixbooster [nowebpoutput|noavif|nojxl|nojpg|nopng] {
	[nowebpoutput|noavif|nojxl|nojpg|nopng]
	quality <integer between 0 and 100>
	storage <directory> Path to the directory where to store generated picture files
	webp {
		quality <integer between 0 and 100>
		lossless
		exact
	}
	avif {
		quality <integer between 0 and 100>
		qualityalpha <integer between 0 and 100>
		speed <integer between 0 and 10>
	}
	jxl {
		quality <integer between 0 and 100>
		effort <integer between 0 and 10>
	}
}

The 'quality' value is inherited by webp.quality, avif.quality, and jxl.quality if not specified. The 'speed' and 'effort' values should be integers between 0 and 10. The 'lossless' and 'exact' flags are set to true if specified. All directives are optional.

type WebpConfig added in v0.1.2 

type WebpConfig struct {
	// Quality of output pictures, a integer between 0 and 100. Optional.
	Quality int `json:"quality,omitempty"`
	// Enable lossless quality compression if present.
	Lossless bool `json:"lossless,omitempty"`
	Exact    bool `json:"exact,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.