      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

    extern crate bit_vec;
    extern crate byteorder;
    extern crate crc;
    extern crate crossbeam;
    extern crate libc;
    extern crate libz_sys;

    use std::collections::{HashMap, HashSet};
    use std::fs::{File, copy};
    use std::io::{BufWriter, Write, stderr, stdout};
    use std::path::{Path, PathBuf};

    pub mod deflate {
        pub mod deflate;
        pub mod stream;
    }
    pub mod png;

    #[derive(Clone,Debug)]
    /// Options controlling the output of the `optimize` function
    pub struct Options {
        /// Whether the input file should be backed up before writing the output
        pub backup: bool,
        /// Path to write the output file to
        pub out_file: PathBuf,
        /// Used only in CLI interface
        pub out_dir: Option<PathBuf>,
        /// Write to stdout instead of a file
        pub stdout: bool,
        /// Attempt to fix errors when decoding the input file
        pub fix_errors: bool,
        /// Don't actually write any output, just calculate the best results
        pub pretend: bool,
        /// Used only in CLI interface
        pub recursive: bool,
        /// Overwrite existing output files
        pub clobber: bool,
        /// Create new output files if they don't exist
        pub create: bool,
        /// Write to output even if there was no improvement in compression
        pub force: bool,
        /// Ensure the output file has the same permissions as the input file
        pub preserve_attrs: bool,
        /// How verbose the console logging should be (`None` for quiet, `Some(0)` for normal, `Some(1)` for verbose)
        pub verbosity: Option<u8>,
        /// Which filters to try on the file (0-5)
        pub filter: HashSet<u8>,
        /// Whether to change the interlacing type of the file
        /// `None` will not change the current interlacing type
        /// `Some(x)` will change the file to interlacing mode `x`
        pub interlace: Option<u8>,
        /// Which zlib compression levels to try on the file (1-9)
        pub compression: HashSet<u8>,
        /// Which zlib memory levels to try on the file (1-9)
        pub memory: HashSet<u8>,
        /// Which zlib compression strategies to try on the file (0-3)
        pub strategies: HashSet<u8>,
        /// Window size to use when compressing the file, as `2^window` bytes
        /// Doesn't affect compression but may affect speed and memory usage
        /// 15 is recommended default, 8-15 are valid values
        pub window: u8,
        /// Whether to attempt bit depth reduction
        pub bit_depth_reduction: bool,
        /// Whether to attempt color type reduction
        pub color_type_reduction: bool,
        /// Whether to attempt palette reduction
        pub palette_reduction: bool,
        /// Whether to perform IDAT recoding
        /// If any type of reduction is performed, IDAT recoding will be performed
        /// regardless of this setting
        pub idat_recoding: bool,
        /// Which headers to strip from the PNG file, if any
        pub strip: png::Headers,
        /// Whether to use heuristics to pick the best filter and compression
        /// Intended for use with `-o 1` from the CLI interface
        pub use_heuristics: bool,
    }

    /// Perform optimization on the input file using the options provided
    pub fn optimize(filepath: &Path, opts: &Options) -> Result<(), String> {
        // Decode PNG from file
        if opts.verbosity.is_some() {
            writeln!(&mut stderr(), "Processing: {}", filepath.to_str().unwrap()).ok();
        }
        let in_file = Path::new(filepath);
        let mut png = match png::PngData::new(&in_file) {
            Ok(x) => x,
            Err(x) => return Err(x),
        };

        // Print png info
        let idat_original_size = png.idat_data.len();
        let file_original_size = filepath.metadata().unwrap().len() as usize;
        if opts.verbosity.is_some() {
            writeln!(&mut stderr(),
                     "    {}x{} pixels, PNG format",
                     png.ihdr_data.width,
                     png.ihdr_data.height)
                .ok();
            if let Some(palette) = png.palette.clone() {
                writeln!(&mut stderr(),
                         "    {} bits/pixel, {} colors in palette",
                         png.ihdr_data.bit_depth,
                         palette.len() / 3)
                    .ok();
            } else {
                writeln!(&mut stderr(),
                         "    {}x{} bits/pixel, {:?}",
                         png.channels_per_pixel(),
                         png.ihdr_data.bit_depth,
                         png.ihdr_data.color_type)
                    .ok();
            }
            writeln!(&mut stderr(),
                     "    IDAT size = {} bytes",
                     idat_original_size)
                .ok();
            writeln!(&mut stderr(),
                     "    File size = {} bytes",
                     file_original_size)
                .ok();
        }

        let mut filter = opts.filter.clone();
        let compression = opts.compression.clone();
        let memory = opts.memory.clone();
        let mut strategies = opts.strategies.clone();

        if opts.use_heuristics {
            // Heuristically determine which set of options to use
            if png.ihdr_data.bit_depth.as_u8() >= 8 &&
               png.ihdr_data.color_type != png::ColorType::Indexed {
                if filter.is_empty() {
                    filter.insert(5);
                }
                if strategies.is_empty() {
                    strategies.insert(1);
                }
            } else {
                if filter.is_empty() {
                    filter.insert(0);
                }
                if strategies.is_empty() {
                    strategies.insert(0);
                }
            }
        }

        let mut something_changed = false;

        if opts.bit_depth_reduction {
            if png.reduce_bit_depth() {
                something_changed = true;
                if opts.verbosity == Some(1) {
                    report_reduction(&png);
                }
            };
        }

        if opts.color_type_reduction {
            if png.reduce_color_type() {
                something_changed = true;
                if opts.verbosity == Some(1) {
                    report_reduction(&png);
                }
            };
        }

        if opts.palette_reduction {
            if png.reduce_palette() {
                something_changed = true;
                if opts.verbosity == Some(1) {
                    report_reduction(&png);
                }
            };
        }

        if something_changed && opts.verbosity.is_some() {
            report_reduction(&png);
        }

        if let Some(interlacing) = opts.interlace {
            if png.change_interlacing(interlacing) {
                something_changed = true;
                if opts.verbosity == Some(1) {
                    report_reduction(&png);
                }
            }
        }

        if opts.idat_recoding || something_changed {
            // Go through selected permutations and determine the best
            let mut best: Option<(u8, u8, u8, u8, Vec<u8>)> = None;
            let combinations = filter.len() * compression.len() * memory.len() * strategies.len();
            let mut results = Vec::with_capacity(combinations);
            if opts.verbosity.is_some() {
                writeln!(&mut stderr(), "Trying: {} combinations", combinations).ok();
            }
            crossbeam::scope(|scope| {
                for f in &filter {
                    let filtered = png.filter_image(*f);
                    for zc in &compression {
                        for zm in &memory {
                            for zs in &strategies {
                                let moved_filtered = filtered.clone();
                                results.push(scope.spawn(move || {
                                    let new_idat = match deflate::deflate::deflate(&moved_filtered,
                                                                                   *zc,
                                                                                   *zm,
                                                                                   *zs,
                                                                                   opts.window) {
                                        Ok(x) => x,
                                        Err(x) => return Err(x),
                                    };

                                    if opts.verbosity == Some(1) {
                                        writeln!(&mut stderr(), "    zc = {}  zm = {}  zs = {}  f = {}        {} bytes",
                                                 *zc,
                                                 *zm,
                                                 *zs,
                                                 *f,
                                                 new_idat.len()).ok();
                                    }

                                    Ok((*f, *zc, *zm, *zs, new_idat.clone()))
                                }));
                            }
                        }
                    }
                }
            });

            for result in results {
                if let Ok(ok_result) = result.join() {
                    if (best.is_some() &&
                        ok_result.4.len() < best.as_ref().map(|x| x.4.len()).unwrap()) ||
                       (best.is_none() &&
                        (ok_result.4.len() < png.idat_data.len() ||
                         (opts.interlace.is_some() &&
                          opts.interlace != Some(png.ihdr_data.interlaced)) ||
                         opts.force)) {
                        best = Some(ok_result);
                    }
                }
            }

            if let Some(better) = best {
                png.idat_data = better.4.clone();
                if opts.verbosity.is_some() {
                    writeln!(&mut stderr(), "Found better combination:").ok();
                    writeln!(&mut stderr(),
                             "    zc = {}  zm = {}  zs = {}  f = {}        {} bytes",
                             better.1,
                             better.2,
                             better.3,
                             better.0,
                             png.idat_data.len())
                        .ok();
                }
            }
        }

        match opts.strip.clone() {
            // Strip headers
            png::Headers::None => (),
            png::Headers::Some(hdrs) => {
                for hdr in &hdrs {
                    png.aux_headers.remove(hdr);
                }
            }
            png::Headers::Safe => {
                const PRESERVED_HEADERS: [&'static str; 9] = ["cHRM", "gAMA", "iCCP", "sBIT", "sRGB",
                                                              "bKGD", "hIST", "pHYs", "sPLT"];
                let mut preserved = HashMap::new();
                for (hdr, contents) in &png.aux_headers {
                    if PRESERVED_HEADERS.contains(&hdr.as_ref()) {
                        preserved.insert(hdr.clone(), contents.clone());
                    }
                }
                png.aux_headers = preserved;
            }
            png::Headers::All => {
                png.aux_headers = HashMap::new();
            }
        }

        let output_data = png.output();
        if file_original_size <= output_data.len() && !opts.force && opts.interlace.is_none() {
            writeln!(&mut stderr(), "File already optimized").ok();
            return Ok(());
        }

        if opts.pretend {
            writeln!(&mut stderr(), "Running in pretend mode, no output").ok();
        } else {
            if opts.backup {
                match copy(in_file,
                           in_file.with_extension(format!("bak.{}",
                                                          in_file.extension()
                                                                 .unwrap()
                                                                 .to_str()
                                                                 .unwrap()))) {
                    Ok(x) => x,
                    Err(_) => {
                        return Err(format!("Unable to write to backup file at {}",
                                           opts.out_file.display()))
                    }
                };
            }

            if opts.stdout {
                let mut buffer = BufWriter::new(stdout());
                match buffer.write_all(&output_data) {
                    Ok(_) => (),
                    Err(_) => return Err("Unable to write to stdout".to_owned()),
                }
            } else {
                let out_file = match File::create(&opts.out_file) {
                    Ok(x) => x,
                    Err(_) => {
                        return Err(format!("Unable to write to file {}", opts.out_file.display()))
                    }
                };
                let mut buffer = BufWriter::new(out_file);
                match buffer.write_all(&output_data) {
                    Ok(_) => {
                        if opts.verbosity.is_some() {
                            writeln!(&mut stderr(), "Output: {}", opts.out_file.display()).ok();
                        }
                    }
                    Err(_) => {
                        return Err(format!("Unable to write to file {}", opts.out_file.display()))
                    }
                }
            }
        }
        if opts.verbosity.is_some() {
            if idat_original_size >= png.idat_data.len() {
                writeln!(&mut stderr(),
                         "    IDAT size = {} bytes ({} bytes decrease)",
                         png.idat_data.len(),
                         idat_original_size - png.idat_data.len())
                    .ok();
            } else {
                writeln!(&mut stderr(),
                         "    IDAT size = {} bytes ({} bytes increase)",
                         png.idat_data.len(),
                         png.idat_data.len() - idat_original_size)
                    .ok();
            }
            if file_original_size >= output_data.len() {
                writeln!(&mut stderr(),
                         "    file size = {} bytes ({} bytes = {:.2}% decrease)",
                         output_data.len(),
                         file_original_size - output_data.len(),
                         (file_original_size - output_data.len()) as f64 / file_original_size as f64 *
                         100f64)
                    .ok();
            } else {
                writeln!(&mut stderr(),
                         "    file size = {} bytes ({} bytes = {:.2}% increase)",
                         output_data.len(),
                         output_data.len() - file_original_size,
                         (output_data.len() - file_original_size) as f64 / file_original_size as f64 *
                         100f64)
                    .ok();
            }
        }
        Ok(())
    }

    fn report_reduction(png: &png::PngData) {
        if let Some(palette) = png.palette.clone() {
            writeln!(&mut stderr(),
                     "Reducing image to {} bits/pixel, {} colors in palette",
                     png.ihdr_data.bit_depth,
                     palette.len() / 3)
                .ok();
        } else {
            writeln!(&mut stderr(),
                     "Reducing image to {}x{} bits/pixel, {}",
                     png.channels_per_pixel(),
                     png.ihdr_data.bit_depth,
                     png.ihdr_data.color_type)
                .ok();
        }
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)