Discworld 2 BMV support
authorKostya Shishkov <kostya.shishkov@gmail.com>
Tue, 22 Jan 2019 15:28:06 +0000 (16:28 +0100)
committerKostya Shishkov <kostya.shishkov@gmail.com>
Tue, 22 Jan 2019 15:28:06 +0000 (16:28 +0100)
nihav-game/Cargo.toml
nihav-game/src/codecs/bmv.rs [new file with mode: 0644]
nihav-game/src/codecs/mod.rs
nihav-game/src/demuxers/bmv.rs [new file with mode: 0644]
nihav-game/src/demuxers/mod.rs

index 789161d8bb1cef24e60ebd93424118ee1324ebcf..2c1e800f5d1ed75a87da60083258fae8ba5bca6a 100644 (file)
@@ -11,13 +11,15 @@ features = []
 [features]
 default = ["all_decoders", "all_demuxers"]
 demuxers = []
-all_demuxers = ["demuxer_gdv"]
+all_demuxers = ["demuxer_bmv", "demuxer_gdv"]
+demuxer_bmv = ["demuxers"]
 demuxer_gdv = ["demuxers"]
 
 all_decoders = ["all_video_decoders", "all_audio_decoders"]
 decoders = []
 
-all_video_decoders = ["decoder_gdvvid"]
+all_video_decoders = ["decoder_bmv", "decoder_gdvvid"]
+decoder_bmv = ["decoders"]
 decoder_gdvvid = ["decoders"]
 
 all_audio_decoders = []
diff --git a/nihav-game/src/codecs/bmv.rs b/nihav-game/src/codecs/bmv.rs
new file mode 100644 (file)
index 0000000..cea10eb
--- /dev/null
@@ -0,0 +1,340 @@
+use nihav_core::formats;
+use nihav_core::codecs::*;
+use nihav_core::io::byteio::*;
+use std::str::FromStr;
+
+const FRAME_W: usize = 640;
+const FRAME_H: usize = 429;
+
+const BMV_INTRA:    u8 = 0x03;
+const BMV_SCROLL:   u8 = 0x04;
+const BMV_PAL:      u8 = 0x08;
+const BMV_COMMAND:  u8 = 0x10;
+const BMV_PRINT:    u8 = 0x80;
+
+struct BMVReader<'a> {
+    src:        &'a [u8],
+    pos:        usize,
+    fwd:        bool,
+    nibble:     u8,
+    saved:      bool,
+}
+
+impl<'a> BMVReader<'a> {
+    fn new(src: &'a [u8], fwd: bool) -> Self {
+        let pos = if fwd { 0 } else { src.len() - 1 };
+        Self { src, pos, fwd, nibble: 0, saved: false }
+    }
+    fn advance(&mut self) {
+        if self.fwd {
+            if self.pos < self.src.len() - 1 { self.pos += 1; }
+        } else {
+            if self.pos > 0 { self.pos -= 1; }
+        }
+    }
+    fn get_byte(&mut self) -> u8 {
+        let ret = self.src[self.pos];
+        self.advance();
+        ret
+    }
+    fn get_nibble(&mut self) -> u8 {
+        if self.saved {
+            self.saved = false;
+            self.nibble
+        } else {
+            let val = self.get_byte();
+            self.saved = true;
+            self.nibble = val >> 4;
+            val & 0xF
+        }
+    }
+}
+
+struct BMVWriter<'a> {
+    data:       &'a mut [u8],
+    pos:        usize,
+    fwd:        bool,
+    off:        isize,
+}
+
+impl<'a> BMVWriter<'a> {
+    fn new(data: &'a mut [u8], fwd: bool, off: isize) -> Self {
+        let pos = if fwd { 0 } else { data.len() - 1 };
+        Self { data, pos, fwd, off }
+    }
+    fn is_at_end(&self) -> bool {
+        if self.fwd {
+            self.pos == self.data.len() - 1
+        } else {
+            self.pos == 0
+        }
+    }
+    fn advance(&mut self) {
+        if self.fwd {
+            if self.pos < self.data.len() - 1 { self.pos += 1; }
+        } else {
+            if self.pos > 0 { self.pos -= 1; }
+        }
+    }
+    fn put_byte(&mut self, val: u8) {
+        self.data[self.pos] = val;
+        self.advance();
+    }
+    fn copy(&mut self, len: usize) {
+        for _ in 0..len {
+            let saddr = (self.pos as isize) + self.off;
+            if saddr < 0 { continue; }
+            if self.fwd {
+                self.data[self.pos] = self.data[saddr as usize];
+            } else {
+                self.data[self.pos] = self.data[saddr as usize];
+            }
+            self.advance();
+        }
+    }
+    fn repeat(&mut self, len: usize) {
+        let last = if self.fwd { self.data[self.pos - 1] } else { self.data[self.pos + 1] };
+        for _ in 0..len {
+            self.put_byte(last);
+        }
+    }
+}
+
+struct BMVVideoDecoder {
+    info:       Rc<NACodecInfo>,
+    pal:        [u8; 768],
+    frame:      [u8; FRAME_W * FRAME_H],
+}
+
+impl BMVVideoDecoder {
+    fn new() -> Self {
+        let dummy_info = Rc::new(DUMMY_CODEC_INFO);
+        Self {
+            info: dummy_info, pal: [0; 768], frame: [0; FRAME_W * FRAME_H],
+        }
+    }
+    fn decode_frame(&mut self, src: &[u8], bufinfo: &mut NABufferType, line: i16) -> DecoderResult<()> {
+        let bufo = bufinfo.get_vbuf();
+        let mut buf = bufo.unwrap();
+        let paloff = buf.get_offset(1);
+        let stride = buf.get_stride(0);
+        let mut data = buf.get_data_mut();
+        let dst = data.as_mut_slice();
+
+        let fwd = (line <= -640) || (line >= 0);
+
+        let mut br = BMVReader::new(src, fwd);
+        let mut bw = BMVWriter::new(&mut self.frame, fwd, line as isize);
+        let mut mode = 0;
+        while !bw.is_at_end() {
+            let mut val = 0;
+            let mut shift = 0;
+            loop {
+                let nib = br.get_nibble() as usize;
+                if (nib & 0xC) != 0 {
+                    val |= nib << shift;
+                    break;
+                }
+                val |= nib << shift;
+                shift += 2;
+            }
+            if (val & 1) != 0 {
+                mode += 1;
+            }
+            mode += 1;
+            if mode >= 4 {
+                mode -= 3;
+            }
+            validate!(val >= 2);
+            let len = (val >> 1) - 1;
+            
+            match mode {
+                1 => bw.copy(len),
+                2 => for _ in 0..len { bw.put_byte(br.get_byte()); },
+                3 => bw.repeat(len),
+                _ => unreachable!(),
+            };
+        }
+
+        for y in 0..FRAME_H {
+            for x in 0..FRAME_W {
+                dst[y * stride + x] = self.frame[y * FRAME_W + x];
+            }
+        }
+
+        let dpal = &mut dst[paloff..][..768];
+        dpal.copy_from_slice(&self.pal[0..]);
+
+        Ok(())
+    }
+}
+
+impl NADecoder for BMVVideoDecoder {
+    fn init(&mut self, info: Rc<NACodecInfo>) -> DecoderResult<()> {
+        if let NACodecTypeInfo::Video(_vinfo) = info.get_properties() {
+            let fmt = NAPixelFormaton::new(ColorModel::RGB(RGBSubmodel::RGB),
+                                           Some(NAPixelChromaton::new(0, 0, true, 8, 0, 0, 3)),
+                                           Some(NAPixelChromaton::new(0, 0, true, 8, 0, 1, 3)),
+                                           Some(NAPixelChromaton::new(0, 0, true, 8, 0, 2, 3)),
+                                           None, None,
+                                           FORMATON_FLAG_PALETTE, 3);
+            let myinfo = NACodecTypeInfo::Video(NAVideoInfo::new(FRAME_W, FRAME_H, false, fmt));
+            self.info = Rc::new(NACodecInfo::new_ref(info.get_name(), myinfo, info.get_extradata()));
+
+            Ok(())
+        } else {
+            Err(DecoderError::InvalidData)
+        }
+    }
+    fn decode(&mut self, pkt: &NAPacket) -> DecoderResult<NAFrameRef> {
+        let src = pkt.get_buffer();
+        validate!(src.len() > 1);
+
+        let mut mr = MemoryReader::new_read(&src);
+        let mut br = ByteReader::new(&mut mr);
+        let flags                               = br.read_byte()?;
+
+        if (flags & BMV_COMMAND) != 0 {
+            let size = if (flags & BMV_PRINT) != 0 { 8 } else { 10 };
+            br.read_skip(size)?;
+        }
+        if (flags & BMV_PAL) != 0 {
+            br.read_buf(&mut self.pal)?;
+        }
+        let line;
+        if (flags & BMV_SCROLL) != 0 {
+            line                                = br.read_u16le()? as i16;
+        } else if (flags & BMV_INTRA) == BMV_INTRA {
+            line = -640;
+        } else {
+            line = 0;
+        }
+        let pos = br.tell() as usize;
+
+        let bufret = alloc_video_buffer(self.info.get_properties().get_video_info().unwrap(), 0);
+        if let Err(_) = bufret { return Err(DecoderError::InvalidData); }
+        let mut bufinfo = bufret.unwrap();
+
+        self.decode_frame(&src[pos..], &mut bufinfo, line)?;
+
+        let is_intra = (flags & BMV_INTRA) == BMV_INTRA;
+        let mut frm = NAFrame::new_from_pkt(pkt, self.info.clone(), bufinfo);
+        frm.set_keyframe(is_intra);
+        frm.set_frame_type(if is_intra { FrameType::I } else { FrameType::P });
+        Ok(Rc::new(RefCell::new(frm)))
+    }
+}
+
+
+pub fn get_decoder_video() -> Box<NADecoder> {
+    Box::new(BMVVideoDecoder::new())
+}
+
+struct BMVAudioDecoder {
+    ainfo:      NAAudioInfo,
+    chmap:      NAChannelMap,
+}
+
+const BMV_AUD_SCALES: [i32; 16] = [ 16512, 8256, 4128, 2064, 1032, 516, 258, 192, 129, 88, 64, 56, 48, 40, 36, 32 ];
+
+impl BMVAudioDecoder {
+    fn new() -> Self {
+        Self {
+            ainfo:  NAAudioInfo::new(0, 1, formats::SND_S16P_FORMAT, 0),
+            chmap:  NAChannelMap::new(),
+        }
+    }
+}
+
+fn scale_sample(samp: u8, scale: i32) -> i16 {
+    let val = (((samp as i8) as i32) * scale) >> 5;
+    if val < -32768 {
+        -32768
+    } else if val > 32767 {
+        32767
+    } else {
+        val as i16
+    }
+}
+
+impl NADecoder for BMVAudioDecoder {
+    fn init(&mut self, info: Rc<NACodecInfo>) -> DecoderResult<()> {
+        if let NACodecTypeInfo::Audio(ainfo) = info.get_properties() {
+            self.ainfo = NAAudioInfo::new(ainfo.get_sample_rate(), ainfo.get_channels(), formats::SND_S16P_FORMAT, 32);
+            self.chmap = NAChannelMap::from_str("L,R").unwrap();
+            Ok(())
+        } else {
+            Err(DecoderError::InvalidData)
+        }
+    }
+    fn decode(&mut self, pkt: &NAPacket) -> DecoderResult<NAFrameRef> {
+        let info = pkt.get_stream().get_info();
+        if let NACodecTypeInfo::Audio(_) = info.get_properties() {
+            let pktbuf = pkt.get_buffer();
+            validate!(pktbuf.len() > 1);
+            let nblocks = pktbuf[0] as usize;
+            validate!(pktbuf.len() == 1 + 65 * nblocks);
+            let samples = nblocks * 32;
+            let mut abuf = alloc_audio_buffer(self.ainfo, samples, self.chmap.clone())?;
+            let mut adata = abuf.get_abuf_i16().unwrap();
+            let off1 = adata.get_offset(1);
+            let mut dst = adata.get_data_mut();
+            let psrc = &pktbuf[1..];
+            for (n, src) in psrc.chunks_exact(65).enumerate() {
+                let code = src[0].rotate_right(1);
+                let scale0 = BMV_AUD_SCALES[(code & 0xF) as usize];
+                let scale1 = BMV_AUD_SCALES[(code >>  4) as usize];
+                let aoff0 = n * 32;
+                let aoff1 = aoff0 + off1;
+                let data = &src[1..];
+                for (i, samp) in data.chunks_exact(2).enumerate() {
+                    dst[aoff0 + i] = scale_sample(samp[0], scale0);
+                    dst[aoff1 + i] = scale_sample(samp[1], scale1);
+                }
+            }
+            let mut frm = NAFrame::new_from_pkt(pkt, info, abuf);
+            frm.set_duration(Some(samples as u64));
+            frm.set_keyframe(false);
+            Ok(Rc::new(RefCell::new(frm)))
+        } else {
+            Err(DecoderError::InvalidData)
+        }
+    }
+}
+
+pub fn get_decoder_audio() -> Box<NADecoder> {
+    Box::new(BMVAudioDecoder::new())
+}
+
+#[cfg(test)]
+mod test {
+    use nihav_core::codecs::RegisteredDecoders;
+    use nihav_core::demuxers::RegisteredDemuxers;
+    use nihav_core::test::dec_video::*;
+    use crate::codecs::game_register_all_codecs;
+    use crate::demuxers::game_register_all_demuxers;
+    #[test]
+    fn test_bmv_video() {
+        let mut dmx_reg = RegisteredDemuxers::new();
+        game_register_all_demuxers(&mut dmx_reg);
+        let mut dec_reg = RegisteredDecoders::new();
+        game_register_all_codecs(&mut dec_reg);
+
+//        let file = "assets/PERFECT.BMV";
+//        let file = "assets/DW2-MOUSE.BMV";
+        let file = "assets/WILDCAT.BMV";
+        test_file_decoding("bmv", file, Some(40), true, false, None, &dmx_reg, &dec_reg);
+    }
+    #[test]
+    fn test_bmv_audio() {
+        let mut dmx_reg = RegisteredDemuxers::new();
+        game_register_all_demuxers(&mut dmx_reg);
+        let mut dec_reg = RegisteredDecoders::new();
+        game_register_all_codecs(&mut dec_reg);
+
+        let file = "assets/PERFECT.BMV";
+//        let file = "assets/DW2-MOUSE.BMV";
+//        let file = "assets/WILDCAT.BMV";
+        test_decode_audio("bmv", file, None, "bmv", &dmx_reg, &dec_reg);
+    }
+}
index 1b6e473db7c081e1421c0f953738da015b800b85..2bf29cca90705e7aa56fc10f481788b5cfdbf7da 100644 (file)
@@ -4,6 +4,8 @@ macro_rules! validate {
     ($a:expr) => { if !$a { println!("check failed at {}:{}", file!(), line!()); return Err(DecoderError::InvalidData); } };
 }
 
+#[cfg(feature="decoder_bmv")]
+pub mod bmv;
 #[cfg(feature="decoder_gdvvid")]
 pub mod gremlinvideo;
 
@@ -12,6 +14,10 @@ const GAME_CODECS: &[DecoderInfo] = &[
     DecoderInfo { name: "gdv-audio", get_decoder: gremlinvideo::get_decoder_audio },
 #[cfg(feature="decoder_gdvvid")]
     DecoderInfo { name: "gdv-video", get_decoder: gremlinvideo::get_decoder_video },
+#[cfg(feature="decoder_bmv")]
+    DecoderInfo { name: "bmv-audio", get_decoder: bmv::get_decoder_audio },
+#[cfg(feature="decoder_bmv")]
+    DecoderInfo { name: "bmv-video", get_decoder: bmv::get_decoder_video },
 ];
 
 pub fn game_register_all_codecs(rd: &mut RegisteredDecoders) {
diff --git a/nihav-game/src/demuxers/bmv.rs b/nihav-game/src/demuxers/bmv.rs
new file mode 100644 (file)
index 0000000..08c59c0
--- /dev/null
@@ -0,0 +1,125 @@
+use nihav_core::frame::*;
+use nihav_core::demuxers::*;
+
+struct BMVDemuxer<'a> {
+    src:        &'a mut ByteReader<'a>,
+    vid_id:     usize,
+    aud_id:     usize,
+    vpos:       u64,
+    apos:       u64,
+    pkt_buf:    Vec<NAPacket>,
+}
+
+impl<'a> DemuxCore<'a> for BMVDemuxer<'a> {
+    #[allow(unused_variables)]
+    fn open(&mut self, strmgr: &mut StreamManager) -> DemuxerResult<()> {
+        let src = &mut self.src;
+
+        let vhdr = NAVideoInfo::new(640, 429, false, PAL8_FORMAT);
+        let vci = NACodecTypeInfo::Video(vhdr);
+        let vinfo = NACodecInfo::new("bmv-video", vci, None);
+        self.vid_id = strmgr.add_stream(NAStream::new(StreamType::Video, 0, vinfo, 1, 12)).unwrap();
+
+        let ahdr = NAAudioInfo::new(22050, 2, SND_S16_FORMAT, 1);
+        let ainfo = NACodecInfo::new("bmv-audio", NACodecTypeInfo::Audio(ahdr), None);
+        self.aud_id = strmgr.add_stream(NAStream::new(StreamType::Audio, 1, ainfo, 1, 22050)).unwrap();
+
+        self.vpos       = 0;
+        self.apos       = 0;
+        Ok(())
+    }
+
+    fn get_frame(&mut self, strmgr: &mut StreamManager) -> DemuxerResult<NAPacket> {
+        if self.pkt_buf.len() > 0 {
+            return Ok(self.pkt_buf.pop().unwrap());
+        }
+
+        loop {
+            let ctype                   = self.src.read_byte()?;
+            if ctype == 0 { // NOP chunk
+                continue;
+            }
+            if ctype == 1 { return Err(DemuxerError::EOF); }
+            let size                    = self.src.read_u24le()? as usize;
+            validate!(size > 0);
+            let asize;
+            if (ctype & 0x20) != 0 {
+                let nblocks             = self.src.peek_byte()?;
+                asize = (nblocks as usize) * 65 + 1;
+                validate!(asize < size);
+                let str = strmgr.get_stream(self.aud_id).unwrap();
+                let (tb_num, tb_den) = str.get_timebase();
+                let ts = NATimeInfo::new(Some(self.apos), None, None, tb_num, tb_den);
+                let apkt = self.src.read_packet(str, ts, false, asize)?;
+                self.apos += (nblocks as u64) * 32;
+                self.pkt_buf.push(apkt);
+            } else {
+                asize = 0;
+            }
+            let mut buf: Vec<u8> = Vec::with_capacity(size - asize + 1);
+            buf.resize(size - asize + 1, 0);
+            buf[0] = ctype;
+            self.src.read_buf(&mut buf[1..])?;
+
+            let str = strmgr.get_stream(self.vid_id).unwrap();
+            let (tb_num, tb_den) = str.get_timebase();
+            let ts = NATimeInfo::new(Some(self.vpos), None, None, tb_num, tb_den);
+            let pkt = NAPacket::new(str, ts, (ctype & 3) == 3, buf);
+
+            self.vpos += 1;
+            return Ok(pkt);
+        }
+    }
+
+    #[allow(unused_variables)]
+    fn seek(&mut self, time: u64) -> DemuxerResult<()> {
+        Err(DemuxerError::NotImplemented)
+    }
+}
+
+impl<'a> BMVDemuxer<'a> {
+    fn new(io: &'a mut ByteReader<'a>) -> Self {
+        Self {
+            src:        io,
+            vid_id:     0,
+            aud_id:     0,
+            vpos:       0,
+            apos:       0,
+            pkt_buf:    Vec::with_capacity(1),
+        }
+    }
+}
+
+pub struct BMVDemuxerCreator { }
+
+impl DemuxerCreator for BMVDemuxerCreator {
+    fn new_demuxer<'a>(&self, br: &'a mut ByteReader<'a>) -> Box<DemuxCore<'a> + 'a> {
+        Box::new(BMVDemuxer::new(br))
+    }
+    fn get_name(&self) -> &'static str { "bmv" }
+}
+
+#[cfg(test)]
+mod test {
+    use super::*;
+    use std::fs::File;
+
+    #[test]
+    fn test_bmv_demux() {
+        let mut file = File::open("assets/DW2-MOUSE.BMV").unwrap();
+        let mut fr = FileReader::new_read(&mut file);
+        let mut br = ByteReader::new(&mut fr);
+        let mut dmx = BMVDemuxer::new(&mut br);
+        let mut sm = StreamManager::new();
+        dmx.open(&mut sm).unwrap();
+        loop {
+            let pktres = dmx.get_frame(&mut sm);
+            if let Err(e) = pktres {
+                if (e as i32) == (DemuxerError::EOF as i32) { break; }
+                panic!("error");
+            }
+            let pkt = pktres.unwrap();
+            println!("Got {}", pkt);
+        }
+    }
+}
index 8f9b384a03254fff4b2498bb63060e50c498e4b0..f361ea36a2e206a79962225061db66c9818fb3a9 100644 (file)
@@ -5,10 +5,14 @@ macro_rules! validate {
     ($a:expr) => { if !$a { println!("check failed at {}:{}", file!(), line!()); return Err(DemuxerError::InvalidData); } };
 }
 
+#[cfg(feature="demuxer_bmv")]
+mod bmv;
 #[cfg(feature="demuxer_gdv")]
 mod gdv;
 
 const GAME_DEMUXERS: &[&'static DemuxerCreator] = &[
+#[cfg(feature="demuxer_bmv")]
+    &bmv::BMVDemuxerCreator {},
 #[cfg(feature="demuxer_gdv")]
     &gdv::GDVDemuxerCreator {},
 ];