Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Replace printing with tracing #9

Merged
merged 3 commits into from
Jul 18, 2024
Merged

Replace printing with tracing #9

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a1db05f
Replace print statements with tracing calls
xandkar Jul 17, 2024
1bc92b4
Enable tracing in tests
xandkar Jul 17, 2024
4b0dcfa
Fix accidentally commented out instrumentation
xandkar Jul 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/rust.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ jobs:
- name: Build
run: cargo build --verbose
- name: Run tests
run: cargo test --verbose
run: cargo test --verbose -- --nocapture
4 changes: 3 additions & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "nom-exif"
version = "1.2.6"
version = "1.3.0"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I chose to bump minor since this is kind of a new feature, but I don't feel super-strongly about that.

edition = "2021"
license-file = "LICENSE"
description = "Exif/metadata parsing library written in pure Rust, both JPEG/HEIF/HEIC images and MOV/MP4 videos are supported."
Expand All @@ -18,6 +18,7 @@ thiserror = "1.0"
serde = { version = "1.0", features = ["derive"], optional = true }
regex = { version = "1.10" }
chrono = "0.4"
tracing = { version = "0.1.40" }

[features]
json_dump = ["serde"]
Expand All @@ -29,6 +30,7 @@ chrono = "0.4"
serde_json = "1.0"
regex = { version = "1.10" }
clap = { version = "4.4", features = ["derive"] }
tracing-subscriber = { version = "0.3.18", features = ["env-filter"] }

[[example]]
name = "rexiftool"
Expand Down
67 changes: 38 additions & 29 deletions src/bbox.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,15 +49,16 @@ pub struct BoxHeader {
}

impl BoxHeader {
#[tracing::instrument(skip_all)]
pub fn parse<'a>(input: &'a [u8]) -> IResult<&'a [u8], BoxHeader> {
let (remain, size) = number::streaming::be_u32(input)?;

let (remain, box_type) = map_res(streaming::take(4_usize), |res: &'a [u8]| {
// String::from_utf8 will fail on "©xyz"
Ok::<String, ()>(res.iter().map(|b| b.as_char()).collect::<String>())
// String::from_utf8(res.to_vec()).map_err(|e| {
// eprintln!("{e:?}");
// e
// String::from_utf8(res.to_vec()).map_err(|error| {
// tracing::error!(?error, ?res, "Failed to construct string");
// error
// })
})(remain)?;

Expand All @@ -77,20 +78,17 @@ impl BoxHeader {
}

if box_size > (MAX_BODY_LEN + header_size) as u64 {
eprintln!(
"box size of box '{}' is too big: {}",
box_type
.chars()
.map(|c| {
if c.is_ascii_graphic() {
c.as_char()
} else {
'*'
}
})
.collect::<String>(),
box_size
);
let box_type = box_type
.chars()
.map(|c| {
if c.is_ascii_graphic() {
c.as_char()
} else {
'*'
}
})
.collect::<String>();
tracing::error!(?box_type, ?box_size, "Box is too big");
return fail(remain);
}

Expand Down Expand Up @@ -156,10 +154,11 @@ pub struct BoxHolder<'a> {
}

impl<'a> BoxHolder<'a> {
#[tracing::instrument(skip_all)]
pub fn parse(input: &'a [u8]) -> IResult<&'a [u8], BoxHolder<'a>> {
let (_, header) = BoxHeader::parse(input)?;
let (remain, data) = streaming::take(header.box_size)(input)?;
// println!("got {} {}", header.box_type, data.len());
tracing::debug!(?header.box_type, data_len = ?data.len(), "Got");

Ok((remain, BoxHolder { header, data }))
}
Expand Down Expand Up @@ -339,11 +338,13 @@ mod tests {

#[test_case("exif.heic")]
fn travel_heic(path: &str) {
let _ = tracing_subscriber::fmt().with_test_writer().try_init();

let buf = read_sample(path).unwrap();
let mut boxes = Vec::new();

let (remain, bbox) = travel_while(&buf, |bbox| {
// println!("got {}", bbox.header.box_type);
tracing::info!(bbox.header.box_type, "Got");
boxes.push((bbox.header.box_type.to_owned(), bbox.to_owned()));
bbox.box_type() != "mdat"
})
Expand All @@ -365,7 +366,7 @@ mod tests {
let (remain, bbox) = travel_while(
&meta.body_data()[4..], // Safe-slice in test_case
|bbox| {
// println!("got {}", bbox.header.box_type);
tracing::info!(bbox.header.box_type, "Got");
boxes.push(bbox.header.box_type.to_owned());
bbox.box_type() != "iloc"
},
Expand All @@ -384,11 +385,13 @@ mod tests {

#[test_case("meta.mov")]
fn travel_mov(path: &str) {
let _ = tracing_subscriber::fmt().with_test_writer().try_init();

let buf = read_sample(path).unwrap();
let mut boxes = Vec::new();

let (remain, bbox) = travel_while(&buf, |bbox| {
// println!("got {}", bbox.header.box_type);
tracing::info!(bbox.header.box_type, "Got");
boxes.push((bbox.header.box_type.to_owned(), bbox.to_owned()));
bbox.box_type() != "moov"
})
Expand All @@ -408,7 +411,7 @@ mod tests {

let mut boxes = Vec::new();
let (remain, bbox) = travel_while(moov.body_data(), |bbox| {
// println!("got {}", bbox.header.box_type);
tracing::info!(bbox.header.box_type, "Got");
boxes.push(bbox.header.box_type.to_owned());
bbox.box_type() != "meta"
})
Expand All @@ -424,7 +427,7 @@ mod tests {
let meta = bbox;
let mut boxes = Vec::new();
let (remain, _) = travel_while(meta.body_data(), |bbox| {
// println!("got {}", bbox.header.box_type);
tracing::info!(bbox.header.box_type, "Got");
boxes.push(bbox.header.box_type.to_owned());
bbox.box_type() != "ilst"
})
Expand All @@ -437,11 +440,13 @@ mod tests {

#[test_case("meta.mp4")]
fn travel_mp4(path: &str) {
let _ = tracing_subscriber::fmt().with_test_writer().try_init();

let buf = read_sample(path).unwrap();
let mut boxes = Vec::new();

let (remain, bbox) = travel_while(&buf, |bbox| {
// println!("got {}", bbox.header.box_type);
tracing::info!(bbox.header.box_type, "Got");
boxes.push((bbox.header.box_type.to_owned(), bbox.to_owned()));
bbox.box_type() != "moov"
})
Expand All @@ -461,7 +466,7 @@ mod tests {

let mut boxes = Vec::new();
let (remain, bbox) = travel_while(moov.body_data(), |bbox| {
// println!("got {}", bbox.header.box_type);
tracing::info!(bbox.header.box_type, "Got");
boxes.push((bbox.header.box_type.to_owned(), bbox.to_owned()));
bbox.box_type() != "udta"
})
Expand All @@ -482,7 +487,7 @@ mod tests {
let meta = bbox;
let mut boxes = Vec::new();
let (remain, _) = travel_while(meta.body_data(), |bbox| {
// println!("got {}", bbox.header.box_type);
tracing::info!(bbox.header.box_type, "Got");
boxes.push(bbox.header.box_type.to_owned());
bbox.box_type() != "©xyz"
})
Expand All @@ -494,7 +499,7 @@ mod tests {

let mut boxes = Vec::new();
let (remain, bbox) = travel_while(trak.body_data(), |bbox| {
// println!("got {}", bbox.header.box_type);
tracing::info!(bbox.header.box_type, "Got");
boxes.push(bbox.header.box_type.to_owned());
bbox.box_type() != "mdia"
})
Expand All @@ -507,7 +512,7 @@ mod tests {
let mdia = bbox.unwrap();
let mut boxes = Vec::new();
let (remain, _) = travel_while(mdia.body_data(), |bbox| {
// println!("got {}", bbox.header.box_type);
tracing::info!(bbox.header.box_type, "Got");
boxes.push(bbox.header.box_type.to_owned());
bbox.box_type() != "minf"
})
Expand All @@ -522,10 +527,12 @@ mod tests {
// atom.
#[test_case("meta.mp4")]
fn find_android_gps_box(path: &str) {
let _ = tracing_subscriber::fmt().with_test_writer().try_init();

let buf = read_sample(path).unwrap();
let (_, bbox) = find_box(&buf, "moov/udta/©xyz").unwrap();
let bbox = bbox.unwrap();
// println!("bbox: {:?}", bbox.header);
tracing::info!(?bbox.header, "bbox");

// gps info
assert_eq!(
Expand All @@ -536,6 +543,8 @@ mod tests {

#[test]
fn box_header() {
let _ = tracing_subscriber::fmt().with_test_writer().try_init();

let data = [
0x00, 0x00, 0x01, 0xdd, 0x6d, 0x65, 0x74, 0x61, 0x02, 0x04, 0x04, 0x00,
];
Expand Down
6 changes: 2 additions & 4 deletions src/bbox/iinf.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ pub(crate) struct InfeBox {
}

impl ParseBody<InfeBox> for InfeBox {
#[tracing::instrument(skip_all)]
fn parse_body<'a>(remain: &'a [u8], header: FullBoxHeader) -> IResult<&'a [u8], InfeBox> {
let version = header.version;

Expand All @@ -79,10 +80,7 @@ impl ParseBody<InfeBox> for InfeBox {
}),
)(remain)?;

// println!(
// "got {} type: {:?} ver: {version}",
// header.box_type, item_type,
// );
tracing::debug!(?header.box_type, ?item_type, ?version, "Got");

let (remain, item_name) = parse_cstr(remain).map_err(|e| {
if e.is_incomplete() {
Expand Down
3 changes: 2 additions & 1 deletion src/bbox/iloc.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ pub struct IlocBox {
const MAX_ILOC_EXTENTS_PER_ITEM: u16 = 32;

impl ParseBody<IlocBox> for IlocBox {
#[tracing::instrument(skip_all)]
fn parse_body(remain: &[u8], header: FullBoxHeader) -> IResult<&[u8], IlocBox> {
let version = header.version;

Expand Down Expand Up @@ -59,7 +60,7 @@ impl ParseBody<IlocBox> for IlocBox {

let (remain, extent_count) = be_u16(remain)?;
if extent_count > MAX_ILOC_EXTENTS_PER_ITEM {
// eprintln!("extent_count: {extent_count}");
tracing::debug!(?extent_count, "extent_count");
context("extent_count > 32", fail::<_, (), _>)(remain)?;
}

Expand Down
35 changes: 24 additions & 11 deletions src/bbox/ilst.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ impl IlstItem {

/// Parse ilst item data to value, see [Well-known
/// types](https://developer.apple.com/documentation/quicktime-file-format/well-known_types)
// #[tracing::instrument(skip(data))]
fn parse_value(type_code: u32, data: &[u8]) -> crate::Result<EntryValue> {
use EntryValue::*;
let v = match type_code {
Expand All @@ -96,9 +97,13 @@ fn parse_value(type_code: u32, data: &[u8]) -> crate::Result<EntryValue> {
3 => be_i24(data)?.1.into(),
4 => be_i32(data)?.1.into(),
8 => be_i64(data)?.1.into(),
x => {
let msg = format!("Invalid ilst item data; data type is BE Signed Integer while data len is : {x}");
// eprintln!("{msg}");
data_len => {
let data_type = "BE Signed Integer";
tracing::error!(data_type, data_len, "Invalid ilst item data.");
let msg = format!(
"Invalid ilst item data; \
data type is {data_type} while data len is : {data_len}",
);
return Err(msg.into());
}
},
Expand All @@ -108,18 +113,22 @@ fn parse_value(type_code: u32, data: &[u8]) -> crate::Result<EntryValue> {
3 => be_u24(data)?.1.into(),
4 => be_u32(data)?.1.into(),
8 => be_u64(data)?.1.into(),
x => {
let msg = format!("Invalid ilst item data; data type is BE Unsigned Integer while data len is : {x}");
// eprintln!("{msg}");
data_len => {
let data_type = "BE Unsigned Integer";
tracing::error!(data_type, data_len, "Invalid ilst item data.");
let msg = format!(
"Invalid ilst item data; \
data type is {data_type} while data len is : {data_len}",
);
return Err(msg.into());
}
},
23 => be_f32(data)?.1.into(),
24 => be_f64(data)?.1.into(),
o => {
let msg = format!("Unsupported ilst item data type: {o}");
// eprintln!("{msg}");
return Err(msg.into());
data_type => {
let msg = format!("Unsupported ilst item data type");
tracing::error!(data_type, "{}.", msg);
return Err(format!("{}: {data_type}", msg).into());
}
};
Ok(v)
Expand All @@ -134,6 +143,8 @@ mod tests {

#[test_case("meta.mov")]
fn ilst_box(path: &str) {
let _ = tracing_subscriber::fmt().with_test_writer().try_init();

let buf = read_sample(path).unwrap();
let (_, bbox) = travel_while(&buf, |b| b.box_type() != "moov").unwrap();
let bbox = bbox.unwrap();
Expand All @@ -143,7 +154,7 @@ mod tests {
let bbox = bbox.unwrap();

let (rem, ilst) = IlstBox::parse_box(bbox.data).unwrap();
println!("ilst: {ilst:?}");
tracing::info!(?ilst, "ilst");
assert_eq!(rem, b"");

assert_eq!(
Expand All @@ -163,6 +174,8 @@ mod tests {

#[test_case("embedded-in-heic.mov")]
fn heic_mov_ilst(path: &str) {
let _ = tracing_subscriber::fmt().with_test_writer().try_init();

let buf = read_sample(path).unwrap();
let (_, moov) = travel_while(&buf, |b| b.box_type() != "moov").unwrap();
let moov = moov.unwrap();
Expand Down
4 changes: 4 additions & 0 deletions src/bbox/keys.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,8 @@ mod tests {

#[test_case("meta.mov", 4133, 0x01b9, 0xc9)]
fn keys_box(path: &str, moov_size: u64, meta_size: u64, keys_size: u64) {
let _ = tracing_subscriber::fmt().with_test_writer().try_init();

let buf = read_sample(path).unwrap();
let (_, moov) = travel_while(&buf, |b| b.box_type() != "moov").unwrap();
let moov = moov.unwrap();
Expand Down Expand Up @@ -127,6 +129,8 @@ mod tests {

#[test_case("embedded-in-heic.mov", 0x1790, 0x0372, 0x1ce)]
fn heic_mov_keys(path: &str, moov_size: u64, meta_size: u64, keys_size: u64) {
let _ = tracing_subscriber::fmt().with_test_writer().try_init();

let buf = read_sample(path).unwrap();
let (_, moov) = travel_while(&buf, |b| b.box_type() != "moov").unwrap();
let moov = moov.unwrap();
Expand Down
9 changes: 6 additions & 3 deletions src/bbox/meta.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ impl ParseBody<MetaBox> for MetaBox {
}

impl MetaBox {
#[tracing::instrument(skip_all)]
pub fn exif_data<'a>(&self, input: &'a [u8]) -> IResult<&'a [u8], Option<&'a [u8]>> {
self.iinf
.as_ref()
Expand All @@ -86,10 +87,10 @@ impl MetaBox {
}
} else if construction_method == 1 {
// idat offset
eprintln!("idat offset construction method is not supported yet");
tracing::debug!("idat offset construction method is not supported yet");
fail(input)
} else {
eprintln!("item offset construction method is not supported yet");
tracing::debug!("item offset construction method is not supported yet");
fail(input)
}
})
Expand Down Expand Up @@ -123,9 +124,11 @@ mod tests {

#[test_case("exif.heic", 2618)]
fn meta(path: &str, meta_size: usize) {
let _ = tracing_subscriber::fmt().with_test_writer().try_init();

let buf = read_sample(path).unwrap();
let (_, bbox) = travel_while(&buf, |bbox| {
// println!("got {}", bbox.header.box_type);
tracing::info!(bbox.header.box_type, "Got");
bbox.box_type() != "meta"
})
.unwrap();
Expand Down
Loading
Loading