jixel 0.5.12

JPEG XL encoder
Documentation
/*
 * // Copyright (c) Radzivon Bartoshyk 5/2026. All rights reserved.
 * //
 * // Redistribution and use in source and binary forms, with or without modification,
 * // are permitted provided that the following conditions are met:
 * //
 * // 1.  Redistributions of source code must retain the above copyright notice, this
 * // list of conditions and the following disclaimer.
 * //
 * // 2.  Redistributions in binary form must reproduce the above copyright notice,
 * // this list of conditions and the following disclaimer in the documentation
 * // and/or other materials provided with the distribution.
 * //
 * // 3.  Neither the name of the copyright holder nor the names of its
 * // contributors may be used to endorse or promote products derived from
 * // this software without specific prior written permission.
 * //
 * // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * // FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * // DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * // CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * // OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

//! Lossy frame encoding. The entry point selects a modular or VarDCT arm;
//! each stage owns its coding decisions, serialization and tests.

mod ac_entropy;
mod ac_groups;
mod chroma;
mod dc_entropy;
pub(crate) use dc_entropy::{MaDcBudget, dc_wp_proxy_bits, learn_ma_dc_arm};
mod dc_groups;
#[cfg(feature = "extraslow")]
mod dc_polish;
mod dc_rdo;
mod dc_smoothing;
mod dc_tokens;
mod encoder;
mod extra_channels;
pub(crate) mod extra_levels;
mod extra_tree;
mod function_quality;
mod header;
#[cfg(feature = "extraslow")]
mod loop_arbiter;
#[cfg(feature = "extraslow")]
mod loop_group_map;
mod metadata;
mod modular;
#[cfg(feature = "extraslow")]
mod quant_field_loop;
mod quantization;
mod sections;
mod vardct;
mod vardct_encoder;
mod variants;

pub(crate) use chroma::{
    ChromaGradientSumsFn, is_screen_content, selected_chroma_gradient_sums_fn,
};
pub(crate) use dc_tokens::{
    DC_PREDICTOR_WEIGHTED, DcPlanePrice, collect_dc_tokens_with_gradient, price_dc_plane,
    write_context_tree, write_tree_tokens,
};
pub(crate) use encoder::{encode_frame, encode_modular_crop_frame};
pub(crate) use header::write_quant_scales;
pub(crate) use metadata::{ac_metadata_context, collect_ac_metadata_tokens};
pub(crate) use quantization::epf_sharpness_id;
pub(crate) use sections::{combine_sections, combined_sections_size};

const K_BLOCK_DIM: usize = 8;
const K_TILE_DIM: usize = 64;
pub(crate) const K_GROUP_DIM: usize = 256;
pub(crate) const K_DC_GROUP_DIM: usize = 2048;
const K_GROUP_DIM_IN_BLOCKS: usize = 32; // = K_GROUP_DIM / K_BLOCK_DIM
const K_TILE_DIM_IN_BLOCKS: usize = 8; // = K_TILE_DIM / K_BLOCK_DIM

#[allow(dead_code)]
struct ImageDim {
    xsize: usize,
    ysize: usize,
    xsize_blocks: usize,
    ysize_blocks: usize,
    xsize_groups: usize,
    ysize_groups: usize,
    xsize_dc_groups: usize,
    ysize_dc_groups: usize,
    num_groups: usize,
    num_dc_groups: usize,
}

impl ImageDim {
    fn new(xsize: usize, ysize: usize) -> Self {
        let xsize_blocks = xsize.div_ceil(K_BLOCK_DIM);
        let ysize_blocks = ysize.div_ceil(K_BLOCK_DIM);
        let xsize_groups = xsize.div_ceil(K_GROUP_DIM);
        let ysize_groups = ysize.div_ceil(K_GROUP_DIM);
        let xsize_dc_groups = xsize.div_ceil(K_DC_GROUP_DIM);
        let ysize_dc_groups = ysize.div_ceil(K_DC_GROUP_DIM);
        Self {
            xsize,
            ysize,
            xsize_blocks,
            ysize_blocks,
            xsize_groups,
            ysize_groups,
            xsize_dc_groups,
            ysize_dc_groups,
            num_groups: xsize_groups * ysize_groups,
            num_dc_groups: xsize_dc_groups * ysize_dc_groups,
        }
    }
}