Merge pull request #77 from kaksmet/mjpeg

Add support for decoding MJPEG frames

Author: kaksmet

.travis.yml

@@ -1,6 +1,6 @@
 language: rust
 rust:
-  - 1.12.0
+  - 1.13.0
   - stable
   - beta
   - nightly

src/decoder.rs

@@ -1,6 +1,6 @@
 use byteorder::ReadBytesExt;
 use error::{Error, Result, UnsupportedFeature};
-use huffman::{HuffmanDecoder, HuffmanTable};
+use huffman::{fill_default_mjpeg_tables, HuffmanDecoder, HuffmanTable};
 use marker::Marker;
 use parser::{AdobeColorTransform, AppData, CodingProcess, Component, Dimensions, EntropyCoding, FrameInfo,
              parse_app, parse_com, parse_dht, parse_dqt, parse_dri, parse_sof, parse_sos, ScanInfo};
@@ -60,6 +60,7 @@ pub struct Decoder<R> {
     restart_interval: u16,
     color_transform: Option<AdobeColorTransform>,
     is_jfif: bool,
+    is_mjpeg: bool,
 
     // Used for progressive JPEGs.
     coefficients: Vec<Vec<i16>>,
@@ -79,6 +80,7 @@ impl<R: Read> Decoder<R> {
             restart_interval: 0,
             color_transform: None,
             is_jfif: false,
+            is_mjpeg: false,
             coefficients: Vec::new(),
             coefficients_finished: [0; MAX_COMPONENTS],
         }
@@ -287,6 +289,7 @@ impl<R: Read> Decoder<R> {
 
                                 self.is_jfif = true;
                             },
+                            AppData::Avi1 => self.is_mjpeg = true,
                         }
                     }
                 },
@@ -368,6 +371,10 @@ impl<R: Read> Decoder<R> {
             return Err(Error::Format("use of unset quantization table".to_owned()));
         }
 
+        if self.is_mjpeg {
+            fill_default_mjpeg_tables(scan, &mut self.dc_huffman_tables, &mut self.ac_huffman_tables);
+        }
+
         // Verify that all required huffman tables has been set.
         if scan.spectral_selection.start == 0 &&
                 scan.dc_table_indices.iter().any(|&i| self.dc_huffman_tables[i].is_none()) {

src/huffman.rs

@@ -1,6 +1,7 @@
 use byteorder::ReadBytesExt;
 use error::{Error, Result};
 use marker::Marker;
+use parser::ScanInfo;
 use std::io::Read;
 use std::iter::repeat;
 
@@ -279,3 +280,64 @@ fn derive_huffman_codes(bits: &[u8; 16]) -> Result<(Vec<u16>, Vec<u8>)> {
 
     Ok((huffcode, huffsize))
 }
+
+// https://www.loc.gov/preservation/digital/formats/fdd/fdd000063.shtml
+// "Avery Lee, writing in the rec.video.desktop newsgroup in 2001, commented that "MJPEG, or at
+//  least the MJPEG in AVIs having the MJPG fourcc, is restricted JPEG with a fixed -- and
+//  *omitted* -- Huffman table. The JPEG must be YCbCr colorspace, it must be 4:2:2, and it must
+//  use basic Huffman encoding, not arithmetic or progressive.... You can indeed extract the
+//  MJPEG frames and decode them with a regular JPEG decoder, but you have to prepend the DHT
+//  segment to them, or else the decoder won't have any idea how to decompress the data.
+//  The exact table necessary is given in the OpenDML spec.""
+pub fn fill_default_mjpeg_tables(scan: &ScanInfo,
+                                 dc_huffman_tables: &mut[Option<HuffmanTable>],
+                                 ac_huffman_tables: &mut[Option<HuffmanTable>]) {
+    // Section K.3.3
+
+    if dc_huffman_tables[0].is_none() && scan.dc_table_indices.iter().any(|&i| i == 0) {
+        // Table K.3
+        dc_huffman_tables[0] = Some(HuffmanTable::new(
+            &[0x00, 0x01, 0x05, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00],
+            &[0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B], HuffmanTableClass::DC).unwrap());
+    }
+    if dc_huffman_tables[1].is_none() && scan.dc_table_indices.iter().any(|&i| i == 1) {
+        // Table K.4
+        dc_huffman_tables[1] = Some(HuffmanTable::new(
+            &[0x00, 0x03, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00],
+            &[0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B], HuffmanTableClass::DC).unwrap());
+    }
+    if ac_huffman_tables[0].is_none() && scan.ac_table_indices.iter().any(|&i| i == 0) {
+        // Table K.5
+        ac_huffman_tables[0] = Some(HuffmanTable::new(
+            &[0x00, 0x02, 0x01, 0x03, 0x03, 0x02, 0x04, 0x03, 0x05, 0x05, 0x04, 0x04, 0x00, 0x00, 0x01, 0x7D],
+            &[0x01, 0x02, 0x03, 0x00, 0x04, 0x11, 0x05, 0x12, 0x21, 0x31, 0x41, 0x06, 0x13, 0x51, 0x61, 0x07,
+              0x22, 0x71, 0x14, 0x32, 0x81, 0x91, 0xA1, 0x08, 0x23, 0x42, 0xB1, 0xC1, 0x15, 0x52, 0xD1, 0xF0,
+              0x24, 0x33, 0x62, 0x72, 0x82, 0x09, 0x0A, 0x16, 0x17, 0x18, 0x19, 0x1A, 0x25, 0x26, 0x27, 0x28,
+              0x29, 0x2A, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3A, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x49,
+              0x4A, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5A, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69,
+              0x6A, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78, 0x79, 0x7A, 0x83, 0x84, 0x85, 0x86, 0x87, 0x88, 0x89,
+              0x8A, 0x92, 0x93, 0x94, 0x95, 0x96, 0x97, 0x98, 0x99, 0x9A, 0xA2, 0xA3, 0xA4, 0xA5, 0xA6, 0xA7,
+              0xA8, 0xA9, 0xAA, 0xB2, 0xB3, 0xB4, 0xB5, 0xB6, 0xB7, 0xB8, 0xB9, 0xBA, 0xC2, 0xC3, 0xC4, 0xC5,
+              0xC6, 0xC7, 0xC8, 0xC9, 0xCA, 0xD2, 0xD3, 0xD4, 0xD5, 0xD6, 0xD7, 0xD8, 0xD9, 0xDA, 0xE1, 0xE2,
+              0xE3, 0xE4, 0xE5, 0xE6, 0xE7, 0xE8, 0xE9, 0xEA, 0xF1, 0xF2, 0xF3, 0xF4, 0xF5, 0xF6, 0xF7, 0xF8,
+              0xF9, 0xFA
+            ], HuffmanTableClass::AC).unwrap());
+    }
+    if ac_huffman_tables[1].is_none() && scan.ac_table_indices.iter().any(|&i| i == 1) {
+        // Table K.6
+        ac_huffman_tables[1] = Some(HuffmanTable::new(
+            &[0x00, 0x02, 0x01, 0x02, 0x04, 0x04, 0x03, 0x04, 0x07, 0x05, 0x04, 0x04, 0x00, 0x01, 0x02, 0x77],
+            &[0x00, 0x01, 0x02, 0x03, 0x11, 0x04, 0x05, 0x21, 0x31, 0x06, 0x12, 0x41, 0x51, 0x07, 0x61, 0x71,
+              0x13, 0x22, 0x32, 0x81, 0x08, 0x14, 0x42, 0x91, 0xA1, 0xB1, 0xC1, 0x09, 0x23, 0x33, 0x52, 0xF0,
+              0x15, 0x62, 0x72, 0xD1, 0x0A, 0x16, 0x24, 0x34, 0xE1, 0x25, 0xF1, 0x17, 0x18, 0x19, 0x1A, 0x26,
+              0x27, 0x28, 0x29, 0x2A, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3A, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48,
+              0x49, 0x4A, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5A, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68,
+              0x69, 0x6A, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78, 0x79, 0x7A, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87,
+              0x88, 0x89, 0x8A, 0x92, 0x93, 0x94, 0x95, 0x96, 0x97, 0x98, 0x99, 0x9A, 0xA2, 0xA3, 0xA4, 0xA5,
+              0xA6, 0xA7, 0xA8, 0xA9, 0xAA, 0xB2, 0xB3, 0xB4, 0xB5, 0xB6, 0xB7, 0xB8, 0xB9, 0xBA, 0xC2, 0xC3,
+              0xC4, 0xC5, 0xC6, 0xC7, 0xC8, 0xC9, 0xCA, 0xD2, 0xD3, 0xD4, 0xD5, 0xD6, 0xD7, 0xD8, 0xD9, 0xDA,
+              0xE2, 0xE3, 0xE4, 0xE5, 0xE6, 0xE7, 0xE8, 0xE9, 0xEA, 0xF2, 0xF3, 0xF4, 0xF5, 0xF6, 0xF7, 0xF8,
+              0xF9, 0xFA
+            ], HuffmanTableClass::AC).unwrap());
+    }
+}

src/parser.rs

@@ -66,6 +66,7 @@ pub struct Component {
 pub enum AppData {
     Adobe(AdobeColorTransform),
     Jfif,
+    Avi1,
 }
 
 // http://www.sno.phy.queensu.ca/~phil/exiftool/TagNames/JPEG.html#Adobe
@@ -479,6 +480,9 @@ pub fn parse_app<R: Read>(reader: &mut R, marker: Marker) -> Result<Option<AppDa
                 // http://www.w3.org/Graphics/JPEG/jfif3.pdf
                 if &buffer[0 .. 5] == &[b'J', b'F', b'I', b'F', b'\0'] {
                     result = Some(AppData::Jfif);
+                // https://sno.phy.queensu.ca/~phil/exiftool/TagNames/JPEG.html#AVI1
+                } else if &buffer[0 .. 5] == &[b'A', b'V', b'I', b'1', b'\0'] {
+                    result = Some(AppData::Avi1);
                 }
             }
         },

tests/reftest/images/README.md

@@ -6,6 +6,7 @@ File              | Source
 ------------------| ------
 16bit-qtables.jpg | Created using <code>convert mozilla/jpg-size-1x1.png tga:- &#124; cjpeg -quality 10 -outfile 16bit-qtables.jpg</code>
 extraneous-data.jpg | `mozilla/jpg-size-16x16.jpg` with 6 random bytes inserted before the EOI marker
+mjpeg.jpg         | https://bugzilla.mozilla.org/show_bug.cgi?id=963907
 restarts.jpg      | `mozilla/jpg-size-33x33.jpg` with added restart markers.
 rgb.jpg           | Created from `ycck.jpg` using <code>convert ycck.jpg tga:- &#124; cjpeg -rgb -outfile rgb.jpg</code>
 ycck.jpg          | https://en.wikipedia.org/wiki/File:Channel_digital_image_CMYK_color.jpg