Package org.apache.tika.parser.image

Class RawTiffParser

java.lang.Object

org.apache.tika.parser.image.AbstractImageParser

org.apache.tika.parser.image.TiffParser

org.apache.tika.parser.image.RawTiffParser

All Implemented Interfaces:

Serializable, SelfConfiguring, EnrichingParser, Parser

public class RawTiffParser
extends TiffParser

Parser for TIFF-based camera raw images: Nikon NEF/NRW, Sony ARW/SRF/SR2, Pentax PEF/PTX, Samsung SRW, Epson ERF, Kodak KDC, Leaf MOS, Adobe DNG, Canon CR2, Olympus ORF and Panasonic RW2.

These formats are TIFF containers: metadata extraction is inherited from TiffParser. In addition, this parser extracts the camera-generated JPEG preview images embedded in the raw file and hands them to the EmbeddedDocumentExtractor. Previews are referenced from the IFD chain or from SubIFDs, either via the JPEGInterchangeFormat/ JPEGInterchangeFormatLength tags or as a single JPEG-compressed strip (DNG, CR2). Four formats keep theirs elsewhere. A Panasonic RW2 uses the private JpgFromRaw tag. An Olympus ORF uses its MakerNote, whose own IFD holds the camera thumbnail and the CameraSettings sub-IFD that points at the preview. An Epson ERF uses its MakerNote too, under a tag of its own, at an offset counted from the start of the file and behind a byte the camera writes over the JPEG's first one, which is put back on the way out. A Leaf MOS uses a vendor block of named sections, one of which holds the JPEG. ORF and RW2 carry a magic number of their own; ERF, KDC and MOS are plain TIFFs, and a KDC names its preview the way a TIFF does.

Strips holding raw sensor data are also JPEG-encoded in some formats (lossless JPEG in CR2 and DNG), so strip candidates are only accepted for displayable images: PhotometricInterpretation RGB or YCbCr, or 8 bits per sample when PhotometricInterpretation is absent (CR2). Both classic TIFF and BigTIFF containers (allowed for DNG since spec version 1.7) are supported.

Of the previews that are extracted (see the length limits in RawTiffParser.RawTiffParserConfig), the largest by JPEG byte length is marked TikaCoreProperties.EmbeddedResourceType.THUMBNAIL, any smaller ones are TikaCoreProperties.EmbeddedResourceType.INLINE images (TIKA-4851).

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RawTiffParser.RawTiffParserConfig	Configuration class for RawTiffParser.

Constructor Summary

Constructors

Constructor	Description
RawTiffParser()
RawTiffParser(JsonConfig jsonConfig)
RawTiffParser(RawTiffParser.RawTiffParserConfig config)

Method Summary

Modifier and Type	Method	Description
protected ImageMetadataConfig	getImageMetadataConfig(ParseContext context)
Set<MediaType>	getSupportedTypes(ParseContext context)	Returns the set of media types supported by this parser when used with the given parse context.
void	parse(TikaInputStream tis, ContentHandler handler, Metadata metadata, ParseContext context)	Parses a document stream into a sequence of XHTML SAX events.

Methods inherited from class org.apache.tika.parser.image.AbstractImageParser

setContentEnrichers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RawTiffParser

public RawTiffParser()

RawTiffParser

public RawTiffParser(RawTiffParser.RawTiffParserConfig config)

RawTiffParser

public RawTiffParser(JsonConfig jsonConfig)

Method Details

getSupportedTypes

public Set<MediaType> getSupportedTypes(ParseContext context)

Description copied from interface: Parser

Returns the set of media types supported by this parser when used with the given parse context.

Specified by:

getSupportedTypes in interface Parser

Overrides:

getSupportedTypes in class TiffParser

Parameters:

context - parse context

Returns:

immutable set of media types

parse

public void parse(TikaInputStream tis,
 ContentHandler handler,
 Metadata metadata,
 ParseContext context)
           throws IOException,
SAXException,
TikaException

Description copied from interface: Parser

Parses a document stream into a sequence of XHTML SAX events. Fills in related document metadata in the given metadata object.

The given document stream is consumed but not closed by this method. The responsibility to close the stream remains on the caller.

Information about the parsing context can be passed in the context parameter. See the parser implementations for the kinds of context information they expect.

Specified by:

parse in interface Parser

Overrides:

parse in class AbstractImageParser

Parameters:

handler - handler for the XHTML SAX events (output)

metadata - document metadata (input and output)

context - parse context

Throws:

IOException - if the document stream could not be read

SAXException - if the SAX events could not be processed

TikaException - if the document could not be parsed

getImageMetadataConfig

protected ImageMetadataConfig getImageMetadataConfig(ParseContext context)
                                              throws TikaException,
IOException

Overrides:

getImageMetadataConfig in class TiffParser

Throws:

TikaException

IOException