danvics/oxipng
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add --keep display equivalent to --strip safe (#584)

Browse source 
This PR reverts #580 and introduces `--keep display` instead.

See discussion in #581.
This commit is contained in:
andrews05 2023-12-13 22:47:29 +13:00 committed by GitHub
parent f6c24409f1
commit 63efc76f3e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 34 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/headers.rs
View file

@ -76,7 +76,7 @@ pub enum StripChunks {
None,
/// Remove specific chunks
Strip(IndexSet<[u8; 4]>),
/// Remove all chunks that won't affect rendering
/// Remove all chunks that won't affect image display
Safe,
/// Remove all non-critical chunks except these
Keep(IndexSet<[u8; 4]>),
@ -85,8 +85,8 @@ pub enum StripChunks {
}
impl StripChunks {
/// List of chunks that will be kept when using the `Safe` option
pub const KEEP_SAFE: [[u8; 4]; 7] = [
/// List of chunks that affect image display and will be kept when using the `Safe` option
pub const DISPLAY: [[u8; 4]; 7] = [
*b"cICP", *b"iCCP", *b"sRGB", *b"pHYs", *b"acTL", *b"fcTL", *b"fdAT",
];
@ -95,7 +95,7 @@ impl StripChunks {
StripChunks::None => true,
StripChunks::Keep(names) => names.contains(name),
StripChunks::Strip(names) => !names.contains(name),
StripChunks::Safe => Self::KEEP_SAFE.contains(name),
StripChunks::Safe => Self::DISPLAY.contains(name),
StripChunks::All => false,
}
}

47
src/main.rs
View file

@ -163,7 +163,7 @@ CAUTION: 'all' will convert APNGs to standard PNGs.
Note that 'bKGD', 'sBIT' and 'hIST' will be forcibly stripped if the color type or bit \
depth is changed, regardless of any options set.",
StripChunks::KEEP_SAFE
StripChunks::DISPLAY
.iter()
.map(|c| String::from_utf8_lossy(c))
.collect::<Vec<_>>()
@ -175,8 +175,16 @@ depth is changed, regardless of any options set.",
.arg(
Arg::new("keep")
.help("Strip all metadata except in the comma-separated list")
.long_help("\
Strip all metadata chunks except those in the comma-separated list. The special value \
'display' includes chunks that affect the image appearance, equivalent to '--strip safe'.
E.g. '--keep eXIf,display' will strip chunks, keeping only eXIf and those that affect the \
image appearance.")
.long("keep")
.value_name("list"),
.value_name("list")
.conflicts_with("strip")
.conflicts_with("strip-safe"),
)
.arg(
Arg::new("alpha")
@ -611,6 +619,24 @@ fn parse_opts_into_struct(
};
}
if let Some(keep) = matches.get_one::<String>("keep") {
let mut keep_display = false;
let mut names = keep
.split(',')
.filter_map(|name| {
if name == "display" {
keep_display = true;
return None;
}
Some(parse_chunk_name(name))
})
.collect::<Result<IndexSet<_>, _>>()?;
if keep_display {
names.extend(StripChunks::DISPLAY.iter().cloned());
}
opts.strip = StripChunks::Keep(names)
}
if let Some(strip) = matches.get_one::<String>("strip") {
if strip == "safe" {
opts.strip = StripChunks::Safe;
@ -637,23 +663,10 @@ fn parse_opts_into_struct(
.collect::<Result<_, _>>()?;
opts.strip = StripChunks::Strip(names);
}
} else if matches.get_flag("strip-safe") {
opts.strip = StripChunks::Safe;
}
if let Some(keep) = matches.get_one::<String>("keep") {
if matches!(opts.strip, StripChunks::Strip(_)) {
return Err("--strip <list> and --keep cannot be used together".to_owned());
}
let mut names: IndexSet<_> = keep
.split(',')
.map(parse_chunk_name)
.collect::<Result<_, _>>()?;
if opts.strip == StripChunks::Safe {
// Add the keep safe chunks to the list
names.extend(StripChunks::KEEP_SAFE.iter().cloned());
}
opts.strip = StripChunks::Keep(names);
if matches.get_flag("strip-safe") {
opts.strip = StripChunks::Safe;
}
if matches.get_flag("zopfli") {