]> git.nihav.org Git - nihav.git/blame - nihav-game/src/codecs/bmv.rs
avimux: do not record palette change chunks in OpenDML index
[nihav.git] / nihav-game / src / codecs / bmv.rs
CommitLineData
9067c1f8
KS
1use nihav_core::formats;
2use nihav_core::codecs::*;
3use nihav_core::io::byteio::*;
4use std::str::FromStr;
5
6const FRAME_W: usize = 640;
7const FRAME_H: usize = 429;
8
9const BMV_INTRA: u8 = 0x03;
10const BMV_SCROLL: u8 = 0x04;
11const BMV_PAL: u8 = 0x08;
12const BMV_COMMAND: u8 = 0x10;
13const BMV_PRINT: u8 = 0x80;
14
15struct BMVReader<'a> {
16 src: &'a [u8],
17 pos: usize,
18 fwd: bool,
19 nibble: u8,
20 saved: bool,
21}
22
23impl<'a> BMVReader<'a> {
24 fn new(src: &'a [u8], fwd: bool) -> Self {
25 let pos = if fwd { 0 } else { src.len() - 1 };
26 Self { src, pos, fwd, nibble: 0, saved: false }
27 }
cb56d166 28 #[allow(clippy::collapsible_else_if)]
9067c1f8
KS
29 fn advance(&mut self) {
30 if self.fwd {
31 if self.pos < self.src.len() - 1 { self.pos += 1; }
32 } else {
33 if self.pos > 0 { self.pos -= 1; }
34 }
35 }
36 fn get_byte(&mut self) -> u8 {
37 let ret = self.src[self.pos];
38 self.advance();
39 ret
40 }
41 fn get_nibble(&mut self) -> u8 {
42 if self.saved {
43 self.saved = false;
44 self.nibble
45 } else {
46 let val = self.get_byte();
47 self.saved = true;
48 self.nibble = val >> 4;
49 val & 0xF
50 }
51 }
52}
53
54struct BMVWriter<'a> {
55 data: &'a mut [u8],
56 pos: usize,
57 fwd: bool,
58 off: isize,
59}
60
61impl<'a> BMVWriter<'a> {
62 fn new(data: &'a mut [u8], fwd: bool, off: isize) -> Self {
63 let pos = if fwd { 0 } else { data.len() - 1 };
64 Self { data, pos, fwd, off }
65 }
66 fn is_at_end(&self) -> bool {
67 if self.fwd {
68 self.pos == self.data.len() - 1
69 } else {
70 self.pos == 0
71 }
72 }
cb56d166 73 #[allow(clippy::collapsible_else_if)]
9067c1f8
KS
74 fn advance(&mut self) {
75 if self.fwd {
76 if self.pos < self.data.len() - 1 { self.pos += 1; }
77 } else {
78 if self.pos > 0 { self.pos -= 1; }
79 }
80 }
81 fn put_byte(&mut self, val: u8) {
82 self.data[self.pos] = val;
83 self.advance();
84 }
85 fn copy(&mut self, len: usize) {
86 for _ in 0..len {
87 let saddr = (self.pos as isize) + self.off;
88 if saddr < 0 { continue; }
da736dbd 89 self.data[self.pos] = self.data[saddr as usize];
9067c1f8
KS
90 self.advance();
91 }
92 }
93 fn repeat(&mut self, len: usize) {
94 let last = if self.fwd { self.data[self.pos - 1] } else { self.data[self.pos + 1] };
95 for _ in 0..len {
96 self.put_byte(last);
97 }
98 }
99}
100
101struct BMVVideoDecoder {
2422d969 102 info: NACodecInfoRef,
9067c1f8
KS
103 pal: [u8; 768],
104 frame: [u8; FRAME_W * FRAME_H],
105}
106
107impl BMVVideoDecoder {
108 fn new() -> Self {
9067c1f8 109 Self {
2422d969 110 info: NACodecInfoRef::default(), pal: [0; 768], frame: [0; FRAME_W * FRAME_H],
9067c1f8
KS
111 }
112 }
113 fn decode_frame(&mut self, src: &[u8], bufinfo: &mut NABufferType, line: i16) -> DecoderResult<()> {
114 let bufo = bufinfo.get_vbuf();
115 let mut buf = bufo.unwrap();
116 let paloff = buf.get_offset(1);
117 let stride = buf.get_stride(0);
1a967e6b 118 let data = buf.get_data_mut().unwrap();
9067c1f8
KS
119 let dst = data.as_mut_slice();
120
121 let fwd = (line <= -640) || (line >= 0);
122
123 let mut br = BMVReader::new(src, fwd);
124 let mut bw = BMVWriter::new(&mut self.frame, fwd, line as isize);
125 let mut mode = 0;
126 while !bw.is_at_end() {
127 let mut val = 0;
128 let mut shift = 0;
129 loop {
130 let nib = br.get_nibble() as usize;
131 if (nib & 0xC) != 0 {
132 val |= nib << shift;
133 break;
134 }
135 val |= nib << shift;
136 shift += 2;
137 }
138 if (val & 1) != 0 {
139 mode += 1;
140 }
141 mode += 1;
142 if mode >= 4 {
143 mode -= 3;
144 }
145 validate!(val >= 2);
146 let len = (val >> 1) - 1;
d24468d9 147
9067c1f8
KS
148 match mode {
149 1 => bw.copy(len),
150 2 => for _ in 0..len { bw.put_byte(br.get_byte()); },
151 3 => bw.repeat(len),
152 _ => unreachable!(),
153 };
154 }
155
156 for y in 0..FRAME_H {
157 for x in 0..FRAME_W {
158 dst[y * stride + x] = self.frame[y * FRAME_W + x];
159 }
160 }
161
162 let dpal = &mut dst[paloff..][..768];
163 dpal.copy_from_slice(&self.pal[0..]);
164
165 Ok(())
166 }
167}
168
169impl NADecoder for BMVVideoDecoder {
01613464 170 fn init(&mut self, _supp: &mut NADecoderSupport, info: NACodecInfoRef) -> DecoderResult<()> {
9067c1f8
KS
171 if let NACodecTypeInfo::Video(_vinfo) = info.get_properties() {
172 let fmt = NAPixelFormaton::new(ColorModel::RGB(RGBSubmodel::RGB),
173 Some(NAPixelChromaton::new(0, 0, true, 8, 0, 0, 3)),
174 Some(NAPixelChromaton::new(0, 0, true, 8, 0, 1, 3)),
175 Some(NAPixelChromaton::new(0, 0, true, 8, 0, 2, 3)),
176 None, None,
177 FORMATON_FLAG_PALETTE, 3);
178 let myinfo = NACodecTypeInfo::Video(NAVideoInfo::new(FRAME_W, FRAME_H, false, fmt));
2422d969 179 self.info = NACodecInfo::new_ref(info.get_name(), myinfo, info.get_extradata()).into_ref();
9067c1f8
KS
180
181 Ok(())
182 } else {
183 Err(DecoderError::InvalidData)
184 }
185 }
01613464 186 fn decode(&mut self, _supp: &mut NADecoderSupport, pkt: &NAPacket) -> DecoderResult<NAFrameRef> {
9067c1f8
KS
187 let src = pkt.get_buffer();
188 validate!(src.len() > 1);
189
190 let mut mr = MemoryReader::new_read(&src);
191 let mut br = ByteReader::new(&mut mr);
192 let flags = br.read_byte()?;
193
194 if (flags & BMV_COMMAND) != 0 {
195 let size = if (flags & BMV_PRINT) != 0 { 8 } else { 10 };
196 br.read_skip(size)?;
197 }
198 if (flags & BMV_PAL) != 0 {
199 br.read_buf(&mut self.pal)?;
200 }
201 let line;
202 if (flags & BMV_SCROLL) != 0 {
203 line = br.read_u16le()? as i16;
204 } else if (flags & BMV_INTRA) == BMV_INTRA {
205 line = -640;
206 } else {
207 line = 0;
208 }
209 let pos = br.tell() as usize;
210
e69b1148 211 let mut bufinfo = alloc_video_buffer(self.info.get_properties().get_video_info().unwrap(), 0)?;
9067c1f8
KS
212
213 self.decode_frame(&src[pos..], &mut bufinfo, line)?;
214
215 let is_intra = (flags & BMV_INTRA) == BMV_INTRA;
216 let mut frm = NAFrame::new_from_pkt(pkt, self.info.clone(), bufinfo);
217 frm.set_keyframe(is_intra);
218 frm.set_frame_type(if is_intra { FrameType::I } else { FrameType::P });
171860fc 219 Ok(frm.into_ref())
9067c1f8 220 }
f9be4e75
KS
221 fn flush(&mut self) {
222 }
9067c1f8
KS
223}
224
7d57ae2f
KS
225impl NAOptionHandler for BMVVideoDecoder {
226 fn get_supported_options(&self) -> &[NAOptionDefinition] { &[] }
227 fn set_options(&mut self, _options: &[NAOption]) { }
228 fn query_option_value(&self, _name: &str) -> Option<NAValue> { None }
229}
230
9067c1f8 231
08a1fab7 232pub fn get_decoder_video() -> Box<dyn NADecoder + Send> {
9067c1f8
KS
233 Box::new(BMVVideoDecoder::new())
234}
235
236struct BMVAudioDecoder {
237 ainfo: NAAudioInfo,
238 chmap: NAChannelMap,
239}
240
241const BMV_AUD_SCALES: [i32; 16] = [ 16512, 8256, 4128, 2064, 1032, 516, 258, 192, 129, 88, 64, 56, 48, 40, 36, 32 ];
242
243impl BMVAudioDecoder {
244 fn new() -> Self {
245 Self {
246 ainfo: NAAudioInfo::new(0, 1, formats::SND_S16P_FORMAT, 0),
247 chmap: NAChannelMap::new(),
248 }
249 }
250}
251
252fn scale_sample(samp: u8, scale: i32) -> i16 {
e69b1148 253 let val = (i32::from(samp as i8) * scale) >> 5;
9067c1f8
KS
254 if val < -32768 {
255 -32768
256 } else if val > 32767 {
257 32767
258 } else {
259 val as i16
260 }
261}
262
263impl NADecoder for BMVAudioDecoder {
01613464 264 fn init(&mut self, _supp: &mut NADecoderSupport, info: NACodecInfoRef) -> DecoderResult<()> {
9067c1f8
KS
265 if let NACodecTypeInfo::Audio(ainfo) = info.get_properties() {
266 self.ainfo = NAAudioInfo::new(ainfo.get_sample_rate(), ainfo.get_channels(), formats::SND_S16P_FORMAT, 32);
267 self.chmap = NAChannelMap::from_str("L,R").unwrap();
268 Ok(())
269 } else {
270 Err(DecoderError::InvalidData)
271 }
272 }
01613464 273 fn decode(&mut self, _supp: &mut NADecoderSupport, pkt: &NAPacket) -> DecoderResult<NAFrameRef> {
9067c1f8
KS
274 let info = pkt.get_stream().get_info();
275 if let NACodecTypeInfo::Audio(_) = info.get_properties() {
276 let pktbuf = pkt.get_buffer();
277 validate!(pktbuf.len() > 1);
278 let nblocks = pktbuf[0] as usize;
279 validate!(pktbuf.len() == 1 + 65 * nblocks);
280 let samples = nblocks * 32;
b70cc006 281 let abuf = alloc_audio_buffer(self.ainfo, samples, self.chmap.clone())?;
9067c1f8
KS
282 let mut adata = abuf.get_abuf_i16().unwrap();
283 let off1 = adata.get_offset(1);
1a967e6b 284 let dst = adata.get_data_mut().unwrap();
9067c1f8
KS
285 let psrc = &pktbuf[1..];
286 for (n, src) in psrc.chunks_exact(65).enumerate() {
287 let code = src[0].rotate_right(1);
288 let scale0 = BMV_AUD_SCALES[(code & 0xF) as usize];
289 let scale1 = BMV_AUD_SCALES[(code >> 4) as usize];
290 let aoff0 = n * 32;
291 let aoff1 = aoff0 + off1;
292 let data = &src[1..];
293 for (i, samp) in data.chunks_exact(2).enumerate() {
294 dst[aoff0 + i] = scale_sample(samp[0], scale0);
295 dst[aoff1 + i] = scale_sample(samp[1], scale1);
296 }
297 }
298 let mut frm = NAFrame::new_from_pkt(pkt, info, abuf);
299 frm.set_duration(Some(samples as u64));
300 frm.set_keyframe(false);
171860fc 301 Ok(frm.into_ref())
9067c1f8
KS
302 } else {
303 Err(DecoderError::InvalidData)
304 }
305 }
f9be4e75
KS
306 fn flush(&mut self) {
307 }
9067c1f8
KS
308}
309
7d57ae2f
KS
310impl NAOptionHandler for BMVAudioDecoder {
311 fn get_supported_options(&self) -> &[NAOptionDefinition] { &[] }
312 fn set_options(&mut self, _options: &[NAOption]) { }
313 fn query_option_value(&self, _name: &str) -> Option<NAValue> { None }
314}
315
08a1fab7 316pub fn get_decoder_audio() -> Box<dyn NADecoder + Send> {
9067c1f8
KS
317 Box::new(BMVAudioDecoder::new())
318}
319
320#[cfg(test)]
321mod test {
322 use nihav_core::codecs::RegisteredDecoders;
323 use nihav_core::demuxers::RegisteredDemuxers;
ce742854 324 use nihav_codec_support::test::dec_video::*;
78fb6560 325 use crate::game_register_all_decoders;
e64739f8 326 use crate::game_register_all_demuxers;
886cde48 327 // samples from: https://samples.mplayerhq.hu/game-formats/bmv/
9067c1f8
KS
328 #[test]
329 fn test_bmv_video() {
330 let mut dmx_reg = RegisteredDemuxers::new();
331 game_register_all_demuxers(&mut dmx_reg);
332 let mut dec_reg = RegisteredDecoders::new();
78fb6560 333 game_register_all_decoders(&mut dec_reg);
9067c1f8 334
951d4be7
KS
335 test_decoding("bmv", "bmv-video", "assets/Game/WILDCAT.BMV", Some(40), &dmx_reg, &dec_reg,
336 ExpectedTestResult::MD5([0x9e91bb16, 0xc1edafc9, 0x4ef3171f, 0x0f3f6181]));
9067c1f8
KS
337 }
338 #[test]
339 fn test_bmv_audio() {
340 let mut dmx_reg = RegisteredDemuxers::new();
341 game_register_all_demuxers(&mut dmx_reg);
342 let mut dec_reg = RegisteredDecoders::new();
78fb6560 343 game_register_all_decoders(&mut dec_reg);
9067c1f8 344
951d4be7
KS
345 test_decoding("bmv", "bmv-audio", "assets/Game/PERFECT.BMV", None, &dmx_reg, &dec_reg,
346 ExpectedTestResult::MD5([0x90b9ace4, 0x5fc19938, 0x7f534560, 0x32589cdf]));
9067c1f8
KS
347 }
348}