flowly_mp4/mp4box/
meta.rs

1use std::collections::HashMap;
2
3use serde::Serialize;
4
5use crate::mp4box::hdlr::HdlrBox;
6use crate::mp4box::ilst::IlstBox;
7use crate::mp4box::*;
8
9#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
10#[serde(tag = "hdlr")]
11#[serde(rename_all = "lowercase")]
12pub enum MetaBox {
13    Mdir {
14        #[serde(skip_serializing_if = "Option::is_none")]
15        ilst: Option<IlstBox>,
16    },
17
18    #[serde(skip)]
19    Unknown {
20        #[serde(skip)]
21        hdlr: HdlrBox,
22
23        #[serde(skip)]
24        data: Vec<(BoxType, Vec<u8>)>,
25    },
26}
27
28const MDIR: FourCC = FourCC { value: *b"mdir" };
29const MDTA: FourCC = FourCC { value: *b"mdta" };
30
31impl MetaBox {
32    pub fn get_type(&self) -> BoxType {
33        BoxType::MetaBox
34    }
35
36    pub fn get_size(&self) -> u64 {
37        let mut size = HEADER_SIZE + HEADER_EXT_SIZE;
38        match self {
39            Self::Mdir { ilst } => {
40                size += HdlrBox::default().box_size();
41                if let Some(ilst) = ilst {
42                    size += ilst.box_size();
43                }
44            }
45            Self::Unknown { hdlr, data } => {
46                size += hdlr.box_size()
47                    + data
48                        .iter()
49                        .map(|(_, data)| data.len() as u64 + HEADER_SIZE)
50                        .sum::<u64>()
51            }
52        }
53        size
54    }
55}
56
57impl Mp4Box for MetaBox {
58    const TYPE: BoxType = BoxType::MetaBox;
59
60    fn box_size(&self) -> u64 {
61        self.get_size()
62    }
63
64    fn to_json(&self) -> Result<String, Error> {
65        Ok(serde_json::to_string(&self).unwrap())
66    }
67
68    fn summary(&self) -> Result<String, Error> {
69        let s = match self {
70            Self::Mdir { .. } => "hdlr=ilst".to_string(),
71            Self::Unknown { hdlr, data } => {
72                format!("hdlr={} data_len={}", hdlr.handler_type, data.len())
73            }
74        };
75        Ok(s)
76    }
77}
78
79impl Default for MetaBox {
80    fn default() -> Self {
81        Self::Unknown {
82            hdlr: Default::default(),
83            data: Default::default(),
84        }
85    }
86}
87
88impl BlockReader for MetaBox {
89    fn read_block<'a>(reader: &mut impl Reader<'a>) -> Result<Self, Error> {
90        let extended_header = reader.peek_u32();
91        if extended_header == 0 {
92            reader.skip(4);
93        }
94
95        let mut boxes = HashMap::new();
96        while let Some(mut bx) = reader.get_box()? {
97            boxes.insert(bx.kind, bx.inner.collect_remaining());
98        }
99
100        // find the hdlr box
101        let hdlr = HdlrBox::read_block(&mut boxes.remove(&BoxType::HdlrBox).unwrap().as_slice())?;
102
103        Ok(match hdlr.handler_type {
104            MDIR => MetaBox::Mdir {
105                ilst: if let Some(inner) = boxes.remove(&BoxType::IlstBox) {
106                    Some(IlstBox::read_block(&mut inner.as_slice())?)
107                } else {
108                    None
109                },
110            },
111            _ => MetaBox::Unknown {
112                hdlr: hdlr.clone(),
113                data: boxes.into_iter().collect::<Vec<(BoxType, Vec<u8>)>>(),
114            },
115        })
116    }
117
118    fn size_hint() -> usize {
119        8
120    }
121}
122
123impl<W: Write> WriteBox<&mut W> for MetaBox {
124    fn write_box(&self, writer: &mut W) -> Result<u64, Error> {
125        let size = self.box_size();
126        BoxHeader::new(Self::TYPE, size).write(writer)?;
127
128        write_box_header_ext(writer, 0, 0)?;
129
130        let hdlr = match self {
131            Self::Mdir { .. } => HdlrBox {
132                handler_type: MDIR,
133                ..Default::default()
134            },
135            Self::Unknown { hdlr, .. } => hdlr.clone(),
136        };
137        hdlr.write_box(writer)?;
138
139        match self {
140            Self::Mdir { ilst } => {
141                if let Some(ilst) = ilst {
142                    ilst.write_box(writer)?;
143                }
144            }
145            Self::Unknown { data, .. } => {
146                for (box_type, data) in data {
147                    BoxHeader::new(*box_type, data.len() as u64 + HEADER_SIZE).write(writer)?;
148                    writer.write_all(data)?;
149                }
150            }
151        }
152        Ok(size)
153    }
154}
155
156#[cfg(test)]
157mod tests {
158    use super::*;
159    use crate::mp4box::BoxHeader;
160
161    #[tokio::test]
162    async fn test_meta_mdir_empty() {
163        let src_box = MetaBox::Mdir { ilst: None };
164
165        let mut buf = Vec::new();
166        src_box.write_box(&mut buf).unwrap();
167        assert_eq!(buf.len(), src_box.box_size() as usize);
168
169        let mut reader = buf.as_slice();
170        let header = BoxHeader::read(&mut reader, &mut 0).await.unwrap().unwrap();
171        assert_eq!(header.kind, BoxType::MetaBox);
172        assert_eq!(header.size, src_box.box_size());
173
174        let dst_box = MetaBox::read_block(&mut reader).unwrap();
175        assert_eq!(dst_box, src_box);
176    }
177
178    #[tokio::test]
179    async fn test_meta_mdir() {
180        let src_box = MetaBox::Mdir {
181            ilst: Some(IlstBox::default()),
182        };
183
184        let mut buf = Vec::new();
185        src_box.write_box(&mut buf).unwrap();
186        assert_eq!(buf.len(), src_box.box_size() as usize);
187
188        let mut reader = buf.as_slice();
189        let header = BoxHeader::read(&mut reader, &mut 0).await.unwrap().unwrap();
190        assert_eq!(header.kind, BoxType::MetaBox);
191        assert_eq!(header.size, src_box.box_size());
192
193        let dst_box = MetaBox::read_block(&mut reader).unwrap();
194        assert_eq!(dst_box, src_box);
195    }
196
197    #[tokio::test]
198    async fn test_meta_hdrl_non_first() {
199        let data = b"\x00\x00\x00\x7fmeta\x00\x00\x00\x00\x00\x00\x00Qilst\x00\x00\x00I\xa9too\x00\x00\x00Adata\x00\x00\x00\x01\x00\x00\x00\x00TMPGEnc Video Mastering Works 7 Version 7.0.15.17\x00\x00\x00\"hdlr\x00\x00\x00\x00\x00\x00\x00\x00mdirappl\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00";
200
201        let mut reader = data.as_slice();
202
203        let header = BoxHeader::read(&mut reader, &mut 0).await.unwrap().unwrap();
204        assert_eq!(header.kind, BoxType::MetaBox);
205
206        let meta_box = MetaBox::read_block(&mut reader).unwrap();
207
208        // this contains \xa9too box in the ilst
209        // it designates the tool that created the file, but is not yet supported by this crate
210        assert_eq!(
211            meta_box,
212            MetaBox::Mdir {
213                ilst: Some(IlstBox::default())
214            }
215        );
216    }
217
218    #[tokio::test]
219    async fn test_meta_unknown() {
220        let src_hdlr = HdlrBox {
221            handler_type: FourCC::from(*b"test"),
222            ..Default::default()
223        };
224        let src_data = (BoxType::UnknownBox(0x42494241), b"123".to_vec());
225        let src_box = MetaBox::Unknown {
226            hdlr: src_hdlr,
227            data: vec![src_data],
228        };
229
230        let mut buf = Vec::new();
231        src_box.write_box(&mut buf).unwrap();
232        assert_eq!(buf.len(), src_box.box_size() as usize);
233
234        let mut reader = buf.as_slice();
235        let header = BoxHeader::read(&mut reader, &mut 0).await.unwrap().unwrap();
236        assert_eq!(header.kind, BoxType::MetaBox);
237        assert_eq!(header.size, src_box.box_size());
238
239        let dst_box = MetaBox::read_block(&mut reader).unwrap();
240        assert_eq!(dst_box, src_box);
241    }
242}