Safe Haskell	None
Language	Haskell2010

Codec.Picture.Metadata

Contents

Types
Functions
Folding
Helper functions
Conversion functions

Description

This module expose a common "metadata" storage for various image type. Different format can generate different metadatas, and write only a part of them.

Since version 3.2.5

Synopsis

data Metadatas
data Keys a where
- Gamma :: Keys Double
- Format :: Keys SourceFormat
- DpiX :: Keys Word
- DpiY :: Keys Word
- Width :: Keys Word
- Height :: Keys Word
- Title :: Keys String
- Description :: Keys String
- Author :: Keys String
- Copyright :: Keys String
- Software :: Keys String
- Comment :: Keys String
- Disclaimer :: Keys String
- Source :: Keys String
- Warning :: Keys String
- Exif :: !ExifTag -> Keys ExifData
- Unknown :: !String -> Keys Value
data Value
- = Int !Int
- | Double !Double
- | String !String
data Elem k = (Show a, NFData a) => !(k a) :=> a
data SourceFormat
- = SourceJpeg
- | SourceGif
- | SourceBitmap
- | SourceTiff
- | SourcePng
- | SourceHDR
- | SourceTGA
lookup :: Keys a -> Metadatas -> Maybe a
empty :: Metadatas
insert :: (Show a, NFData a) => Keys a -> a -> Metadatas -> Metadatas
delete :: Keys a -> Metadatas -> Metadatas
singleton :: (Show a, NFData a) => Keys a -> a -> Metadatas
foldl' :: (acc -> Elem Keys -> acc) -> acc -> Metadatas -> acc
foldMap :: Monoid m => (Elem Keys -> m) -> Metadatas -> m
mkDpiMetadata :: Word -> Metadatas
mkSizeMetadata :: Integral n => n -> n -> Metadatas
basicMetadata :: Integral nSize => SourceFormat -> nSize -> nSize -> Metadatas
simpleMetadata :: (Integral nSize, Integral nDpi) => SourceFormat -> nSize -> nSize -> nDpi -> nDpi -> Metadatas
extractExifMetas :: Metadatas -> [(ExifTag, ExifData)]
dotsPerMeterToDotPerInch :: Word -> Word
dotPerInchToDotsPerMeter :: Word -> Word
dotsPerCentiMeterToDotPerInch :: Word -> Word

Types

data Metadatas Source #

Dependent storage used for metadatas. All metadatas of a given kind are unique within this container.

The current data structure is based on list, so bad performances can be expected.

Instances

Show Metadatas Source #
Instance details Defined in Codec.Picture.Metadata Methods showsPrec :: Int -> Metadatas -> ShowS # show :: Metadatas -> String # showList :: [Metadatas] -> ShowS #
Semigroup Metadatas Source #
Instance details Defined in Codec.Picture.Metadata Methods (<>) :: Metadatas -> Metadatas -> Metadatas # sconcat :: NonEmpty Metadatas -> Metadatas # stimes :: Integral b => b -> Metadatas -> Metadatas #
Monoid Metadatas Source #
Instance details Defined in Codec.Picture.Metadata Methods mempty :: Metadatas # mappend :: Metadatas -> Metadatas -> Metadatas # mconcat :: [Metadatas] -> Metadatas #
NFData Metadatas Source #
Instance details Defined in Codec.Picture.Metadata Methods rnf :: Metadatas -> () #

data Keys a where Source #

Store various additional information about an image. If something is not recognized, it can be stored in an unknown tag.

DpiX Dot per inch on this x axis.
DpiY Dot per inch on this y axis.
Width Image width in pixel. Relying on the metadata for this information can avoid the full decompression of the image. Ignored for image writing.
Height Image height in pixels. Relyiung on the metadata for this information can void the full decomrpession of the image. Ignored for image writing.
Unknown unlikely to be decoded, but usefull for metadata writing
Exif Exif tag and associated data.

Constructors

Gamma :: Keys Double
Format :: Keys SourceFormat
DpiX :: Keys Word
DpiY :: Keys Word
Width :: Keys Word
Height :: Keys Word
Title :: Keys String
Description :: Keys String
Author :: Keys String
Copyright :: Keys String
Software :: Keys String
Comment :: Keys String
Disclaimer :: Keys String
Source :: Keys String
Warning :: Keys String
Exif :: !ExifTag -> Keys ExifData
Unknown :: !String -> Keys Value

Instances

Eq (Keys a) Source #
Instance details Defined in Codec.Picture.Metadata Methods (==) :: Keys a -> Keys a -> Bool # (/=) :: Keys a -> Keys a -> Bool #
Show (Elem Keys) Source #
Instance details Defined in Codec.Picture.Metadata Methods showsPrec :: Int -> Elem Keys -> ShowS # show :: Elem Keys -> String # showList :: [Elem Keys] -> ShowS #
Show (Keys a) Source #
Instance details Defined in Codec.Picture.Metadata Methods showsPrec :: Int -> Keys a -> ShowS # show :: Keys a -> String # showList :: [Keys a] -> ShowS #
NFData (Elem Keys) Source #
Instance details Defined in Codec.Picture.Metadata Methods rnf :: Elem Keys -> () #

data Value Source #

Encode values for unknown information

Constructors

Int !Int
Double !Double
String !String

Instances

Eq Value Source #
Instance details Defined in Codec.Picture.Metadata Methods (==) :: Value -> Value -> Bool # (/=) :: Value -> Value -> Bool #
Show Value Source #
Instance details Defined in Codec.Picture.Metadata Methods showsPrec :: Int -> Value -> ShowS # show :: Value -> String # showList :: [Value] -> ShowS #
NFData Value Source #
Instance details Defined in Codec.Picture.Metadata Methods rnf :: Value -> () #

data Elem k Source #

Element describing a metadata and it's (typed) associated value.

Constructors

(Show a, NFData a) => !(k a) :=> a

Instances

Show (Elem Keys) Source #
Instance details Defined in Codec.Picture.Metadata Methods showsPrec :: Int -> Elem Keys -> ShowS # show :: Elem Keys -> String # showList :: [Elem Keys] -> ShowS #
NFData (Elem Keys) Source #
Instance details Defined in Codec.Picture.Metadata Methods rnf :: Elem Keys -> () #

data SourceFormat Source #

Type describing the original file format of the ilfe.

Constructors

SourceJpeg
SourceGif
SourceBitmap
SourceTiff
SourcePng
SourceHDR
SourceTGA

Instances

Eq SourceFormat Source #
Instance details Defined in Codec.Picture.Metadata Methods (==) :: SourceFormat -> SourceFormat -> Bool # (/=) :: SourceFormat -> SourceFormat -> Bool #
Show SourceFormat Source #
Instance details Defined in Codec.Picture.Metadata Methods showsPrec :: Int -> SourceFormat -> ShowS # show :: SourceFormat -> String # showList :: [SourceFormat] -> ShowS #
NFData SourceFormat Source #
Instance details Defined in Codec.Picture.Metadata Methods rnf :: SourceFormat -> () #