diff --git a/JuicyPixels.cabal b/JuicyPixels.cabal --- a/JuicyPixels.cabal +++ b/JuicyPixels.cabal @@ -1,5 +1,5 @@ Name: JuicyPixels -Version: 3.3.4 +Version: 3.3.5 Synopsis: Picture loading/serialization (in png, jpeg, bitmap, gif, tga, tiff and radiance) Description: <> @@ -28,7 +28,7 @@ Source-Repository this Type: git Location: git://github.com/Twinside/Juicy.Pixels.git - Tag: v3.3.3.1 + Tag: v3.3.5 Flag Mmap Description: Enable the file loading via mmap (memory map) diff --git a/changelog b/changelog --- a/changelog +++ b/changelog @@ -1,6 +1,16 @@ Change log ========== +v3.3.5 January 2020 +------------------- + +Maintenance release to push various pull requests onto +hackage + + * Exporting Pixel32 (will) + * Palettization of transparent frames in Gif (flutterlice) + * Documentation fixes (lehins) + v3.3.4 September 2019 --------------------- diff --git a/docimages/pixelgraph.svg b/docimages/pixelgraph.svg --- a/docimages/pixelgraph.svg +++ b/docimages/pixelgraph.svg @@ -1,264 +1,264 @@ - - - - - - -pixelGraphic - - -PixelRGB8 - -PixelRGB8 - - -PixelRGBA8 - -PixelRGBA8 - - -PixelRGB8->PixelRGBA8 - - -promotePixel - - -PixelRGBF - -PixelRGBF - - -PixelRGB8->PixelRGBF - - -promotePixel - - -Pixel8 - -Pixel8 - - -PixelRGB8->Pixel8 - - -computeLuma - - -PixelCMYK8 - -PixelCMYK8 - - -PixelRGB8->PixelCMYK8 - - -convertPixel - - -PixelYCbCr8 - -PixelYCbCr8 - - -PixelRGB8->PixelYCbCr8 - - -convertPixel - - -PixelRGB16 - -PixelRGB16 - - -PixelRGBA16 - -PixelRGBA16 - - -PixelRGB16->PixelRGBA16 - - -promotePixel - - -Pixel16 - -Pixel16 - - -PixelRGB16->Pixel16 - - -computeLuma - - -PixelCMYK16 - -PixelCMYK16 - - -PixelRGB16->PixelCMYK16 - - -convertPixel - - -PixelRGBA16->PixelRGB16 - - -dropTransparency - - -PixelRGBA8->PixelRGB8 - - -dropTransparency - - -PixelRGBA8->Pixel8 - - -computeLuma - - -PixelF - -PixelF - - -PixelRGBF->PixelF - - -computeLuma - - -PixelYA16 - -PixelYA16 - - -PixelYA16->PixelRGBA16 - - -promotePixel - - -PixelYA16->Pixel16 - - -dropTransparency - - -PixelYA8 - -PixelYA8 - - -PixelYA8->PixelRGB8 - - -promotePixel - - -PixelYA8->PixelRGBA8 - - -promotePixel - - -PixelYA8->Pixel8 - - -dropTransparency - - -PixelYA8->Pixel8 - - -computeLuma - - -PixelF->PixelRGBF - - -promotePixel - - -Pixel16->PixelRGB16 - - -promotePixel - - -Pixel16->PixelRGBA16 - - -promotePixel - - -Pixel16->PixelYA16 - - -promotePixel - - -Pixel8->PixelRGB8 - - -promotePixel - - -Pixel8->PixelRGBA8 - - -promotePixel - - -Pixel8->PixelYA8 - - -promotePixel - - -Pixel8->PixelF - - -promotePixel - - -Pixel8->Pixel16 - - -promotePixel - - -PixelCMYK16->PixelRGB16 - - -convertPixel - - -PixelCMYK8->PixelRGB8 - - -convertPixel - - -PixelYCbCr8->PixelRGB8 - - -convertPixel - - -PixelYCbCr8->Pixel8 - - -computeLuma - - - + + + + + + +pixelGraphic + + +PixelRGB8 + +PixelRGB8 + + +PixelRGBA8 + +PixelRGBA8 + + +PixelRGB8->PixelRGBA8 + + +promotePixel + + +PixelRGBF + +PixelRGBF + + +PixelRGB8->PixelRGBF + + +promotePixel + + +Pixel8 + +Pixel8 + + +PixelRGB8->Pixel8 + + +computeLuma + + +PixelCMYK8 + +PixelCMYK8 + + +PixelRGB8->PixelCMYK8 + + +convertPixel + + +PixelYCbCr8 + +PixelYCbCr8 + + +PixelRGB8->PixelYCbCr8 + + +convertPixel + + +PixelRGB16 + +PixelRGB16 + + +PixelRGBA16 + +PixelRGBA16 + + +PixelRGB16->PixelRGBA16 + + +promotePixel + + +Pixel16 + +Pixel16 + + +PixelRGB16->Pixel16 + + +computeLuma + + +PixelCMYK16 + +PixelCMYK16 + + +PixelRGB16->PixelCMYK16 + + +convertPixel + + +PixelRGBA16->PixelRGB16 + + +dropTransparency + + +PixelRGBA8->PixelRGB8 + + +dropTransparency + + +PixelRGBA8->Pixel8 + + +computeLuma + + +PixelF + +PixelF + + +PixelRGBF->PixelF + + +computeLuma + + +PixelYA16 + +PixelYA16 + + +PixelYA16->PixelRGBA16 + + +promotePixel + + +PixelYA16->Pixel16 + + +dropTransparency + + +PixelYA8 + +PixelYA8 + + +PixelYA8->PixelRGB8 + + +promotePixel + + +PixelYA8->PixelRGBA8 + + +promotePixel + + +PixelYA8->Pixel8 + + +dropTransparency + + +PixelYA8->Pixel8 + + +computeLuma + + +PixelF->PixelRGBF + + +promotePixel + + +Pixel16->PixelRGB16 + + +promotePixel + + +Pixel16->PixelRGBA16 + + +promotePixel + + +Pixel16->PixelYA16 + + +promotePixel + + +Pixel8->PixelRGB8 + + +promotePixel + + +Pixel8->PixelRGBA8 + + +promotePixel + + +Pixel8->PixelYA8 + + +promotePixel + + +Pixel8->PixelF + + +promotePixel + + +Pixel8->Pixel16 + + +promotePixel + + +PixelCMYK16->PixelRGB16 + + +convertPixel + + +PixelCMYK8->PixelRGB8 + + +convertPixel + + +PixelYCbCr8->PixelRGB8 + + +convertPixel + + +PixelYCbCr8->Pixel8 + + +computeLuma + + + diff --git a/src/Codec/Picture.hs b/src/Codec/Picture.hs --- a/src/Codec/Picture.hs +++ b/src/Codec/Picture.hs @@ -129,6 +129,7 @@ -- $graph , Pixel8 , Pixel16 + , Pixel32 , PixelF , PixelYA8( .. ) diff --git a/src/Codec/Picture/ColorQuant.hs b/src/Codec/Picture/ColorQuant.hs --- a/src/Codec/Picture/ColorQuant.hs +++ b/src/Codec/Picture/ColorQuant.hs @@ -10,6 +10,7 @@ -- with its palette. module Codec.Picture.ColorQuant ( palettize + , palettizeWithAlpha , defaultPaletteOptions , PaletteCreationMethod(..) , PaletteOptions( .. ) @@ -32,6 +33,7 @@ import qualified Data.Vector.Storable as VS import Codec.Picture.Types +import Codec.Picture.Gif (GifFrame(..), GifDisposalMethod, GifDelay) ------------------------------------------------------------------------------- ---- Palette Creation and Dithering @@ -71,7 +73,54 @@ , paletteColorCount = 256 } --- | Reduces an image to a color palette according to `PaletteOpts` and +-- | Changes all pixels with alpha = 0 to black +-- converting image to RGB (from RGBA) in meantime +alphaToBlack :: Image PixelRGBA8 -> Image PixelRGB8 +alphaToBlack = pixelMap f + where f (PixelRGBA8 r g b a) = + if a == 0 then PixelRGB8 0 0 0 + else PixelRGB8 r g b + +-- | Using second image as a stencil, changes palette index to the transparent +alphaTo255 :: Image Pixel8 -> Image PixelRGBA8 -> Pixel8 -> Image Pixel8 +alphaTo255 img1 img2 transparentIndex = generateImage f (imageWidth img1) (imageHeight img2) + where f x y = + if a == 0 then transparentIndex + else v + where v = pixelAt img1 x y + PixelRGBA8 _ _ _ a = pixelAt img2 x y + +-- | Converts RGBA image to the array of GifFame's to use in encodeComplexGifImage +palettizeWithAlpha :: [(GifDelay, Image PixelRGBA8)] -> GifDisposalMethod -> [GifFrame] +palettizeWithAlpha [] _ = [] +palettizeWithAlpha (x:xs) dispose = + GifFrame + 0 -- Offset X + 0 -- Offset Y + (Just $ palet) + (Just $ transparentIndex) + delay + dispose + (alphaTo255 pixels i (fromIntegral transparentIndex)) + : palettizeWithAlpha xs dispose + where (delay, i) = x + img = alphaToBlack i + (palet, pixels) = + if isBelow + then (vecToPalette (belowPaletteVec `V.snoc` PixelRGB8 0 0 0), pixelMap belowPaletteIndex img) + else (vecToPalette (genPaletteVec `V.snoc` PixelRGB8 0 0 0), pixelMap genPaletteIndex img) + + (belowPalette, isBelow) = isColorCountBelow 255 img + belowPaletteVec = V.fromList $ Set.toList belowPalette + belowPaletteIndex p = nearestColorIdx p belowPaletteVec + + cs = Set.toList . clusters 255 $ img + genPaletteVec = mkPaletteVec cs + genPaletteIndex p = nearestColorIdx p genPaletteVec + + transparentIndex = length $ if isBelow then belowPaletteVec else genPaletteVec + +-- | Reduces an image to a color palette according to `PaletteOptions` and -- returns the /indices image/ along with its `Palette`. palettize :: PaletteOptions -> Image PixelRGB8 -> (Image Pixel8, Palette) palettize opts@PaletteOptions { paletteCreationMethod = method } = @@ -100,7 +149,7 @@ cs = Set.toList . clusters maxColorCount $ img dImg = pixelMapXY dither img --- | A naive one pass Color Quantiation algorithm - Uniform Quantization. +-- | A naive one pass Color Quantization algorithm - Uniform Quantization. -- Simply take the most significant bits. The maxCols parameter is rounded -- down to the nearest power of 2, and the bits are divided among the three -- color channels with priority order green, red, blue. Returns an diff --git a/src/Codec/Picture/ConvGraph.hs b/src/Codec/Picture/ConvGraph.hs --- a/src/Codec/Picture/ConvGraph.hs +++ b/src/Codec/Picture/ConvGraph.hs @@ -1,10 +1,10 @@ --- $graph --- --- The following graph describe the differents way to convert between pixel types, --- --- * Nodes describe pixel type --- --- * Arrows describe functions --- --- <> --- +-- $graph +-- +-- The following graph describe the differents way to convert between pixel types, +-- +-- * Nodes describe pixel type +-- +-- * Arrows describe functions +-- +-- <> +-- diff --git a/src/Codec/Picture/InternalHelper.hs b/src/Codec/Picture/InternalHelper.hs --- a/src/Codec/Picture/InternalHelper.hs +++ b/src/Codec/Picture/InternalHelper.hs @@ -1,51 +1,51 @@ -{-# LANGUAGE CPP #-} -module Codec.Picture.InternalHelper ( runGet - , runGetStrict - , decode - , getRemainingBytes - , getRemainingLazyBytes ) where - -import qualified Data.ByteString as B -import qualified Data.ByteString.Lazy as L -import Data.Binary( Binary( get ) ) -import Data.Binary.Get( Get - , getRemainingLazyByteString - ) -import qualified Data.Binary.Get as G - -#if MIN_VERSION_binary(0,6,4) -#else -import Control.Applicative( (<$>) ) -import qualified Control.Exception as E --- I feel so dirty. :( -import System.IO.Unsafe( unsafePerformIO ) -#endif - -decode :: (Binary a) => B.ByteString -> Either String a -decode = runGetStrict get - -runGet :: Get a -> L.ByteString -> Either String a -#if MIN_VERSION_binary(0,6,4) -runGet act = unpack . G.runGetOrFail act - where unpack (Left (_, _, str)) = Left str - unpack (Right (_, _, element)) = Right element -#else -runGet act str = unsafePerformIO $ E.catch - (Right <$> E.evaluate (G.runGet act str)) - (\msg -> return . Left $ show (msg :: E.SomeException)) -#endif - -runGetStrict :: Get a -> B.ByteString -> Either String a -runGetStrict act buffer = runGet act $ L.fromChunks [buffer] - -getRemainingBytes :: Get B.ByteString -getRemainingBytes = do - rest <- getRemainingLazyByteString - return $ case L.toChunks rest of - [] -> B.empty - [a] -> a - lst -> B.concat lst - -getRemainingLazyBytes :: Get L.ByteString -getRemainingLazyBytes = getRemainingLazyByteString - +{-# LANGUAGE CPP #-} +module Codec.Picture.InternalHelper ( runGet + , runGetStrict + , decode + , getRemainingBytes + , getRemainingLazyBytes ) where + +import qualified Data.ByteString as B +import qualified Data.ByteString.Lazy as L +import Data.Binary( Binary( get ) ) +import Data.Binary.Get( Get + , getRemainingLazyByteString + ) +import qualified Data.Binary.Get as G + +#if MIN_VERSION_binary(0,6,4) +#else +import Control.Applicative( (<$>) ) +import qualified Control.Exception as E +-- I feel so dirty. :( +import System.IO.Unsafe( unsafePerformIO ) +#endif + +decode :: (Binary a) => B.ByteString -> Either String a +decode = runGetStrict get + +runGet :: Get a -> L.ByteString -> Either String a +#if MIN_VERSION_binary(0,6,4) +runGet act = unpack . G.runGetOrFail act + where unpack (Left (_, _, str)) = Left str + unpack (Right (_, _, element)) = Right element +#else +runGet act str = unsafePerformIO $ E.catch + (Right <$> E.evaluate (G.runGet act str)) + (\msg -> return . Left $ show (msg :: E.SomeException)) +#endif + +runGetStrict :: Get a -> B.ByteString -> Either String a +runGetStrict act buffer = runGet act $ L.fromChunks [buffer] + +getRemainingBytes :: Get B.ByteString +getRemainingBytes = do + rest <- getRemainingLazyByteString + return $ case L.toChunks rest of + [] -> B.empty + [a] -> a + lst -> B.concat lst + +getRemainingLazyBytes :: Get L.ByteString +getRemainingLazyBytes = getRemainingLazyByteString + diff --git a/src/Codec/Picture/Types.hs b/src/Codec/Picture/Types.hs --- a/src/Codec/Picture/Types.hs +++ b/src/Codec/Picture/Types.hs @@ -405,7 +405,7 @@ deriving (Eq, Typeable) -- | Type used to expose a palette extracted during reading. --- Use palettedAsImage to convert it to a palette usable for +-- Use `palettedAsImage` to convert it to a palette usable for -- writing. data Palette' px = Palette' { -- | Number of element in pixels. diff --git a/src/Codec/Picture/VectorByteConversion.hs b/src/Codec/Picture/VectorByteConversion.hs --- a/src/Codec/Picture/VectorByteConversion.hs +++ b/src/Codec/Picture/VectorByteConversion.hs @@ -1,45 +1,45 @@ -{-# LANGUAGE ScopedTypeVariables #-} -{-# LANGUAGE TypeFamilies #-} -{-# LANGUAGE CPP #-} -module Codec.Picture.VectorByteConversion( blitVector - , toByteString - , imageFromUnsafePtr ) where - -import Data.Word( Word8 ) -import Data.Vector.Storable( Vector, unsafeToForeignPtr, unsafeFromForeignPtr0 ) -import Foreign.Storable( Storable, sizeOf ) - -#if !MIN_VERSION_base(4,8,0) -import Foreign.ForeignPtr.Safe( ForeignPtr, castForeignPtr ) -#else -import Foreign.ForeignPtr( ForeignPtr, castForeignPtr ) -#endif - - -import qualified Data.ByteString as B -import qualified Data.ByteString.Internal as S - -import Codec.Picture.Types - -blitVector :: Vector Word8 -> Int -> Int -> B.ByteString -blitVector vec atIndex = S.PS ptr (offset + atIndex) - where (ptr, offset, _length) = unsafeToForeignPtr vec - -toByteString :: forall a. (Storable a) => Vector a -> B.ByteString -toByteString vec = S.PS (castForeignPtr ptr) offset (len * size) - where (ptr, offset, len) = unsafeToForeignPtr vec - size = sizeOf (undefined :: a) - --- | Import a image from an unsafe pointer --- The pointer must have a size of width * height * componentCount px -imageFromUnsafePtr :: forall px - . (Pixel px, (PixelBaseComponent px) ~ Word8) - => Int -- ^ Width in pixels - -> Int -- ^ Height in pixels - -> ForeignPtr Word8 -- ^ Pointer to the raw data - -> Image px -imageFromUnsafePtr width height ptr = - Image width height $ unsafeFromForeignPtr0 ptr size - where compCount = componentCount (undefined :: px) - size = width * height * compCount - +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE CPP #-} +module Codec.Picture.VectorByteConversion( blitVector + , toByteString + , imageFromUnsafePtr ) where + +import Data.Word( Word8 ) +import Data.Vector.Storable( Vector, unsafeToForeignPtr, unsafeFromForeignPtr0 ) +import Foreign.Storable( Storable, sizeOf ) + +#if !MIN_VERSION_base(4,8,0) +import Foreign.ForeignPtr.Safe( ForeignPtr, castForeignPtr ) +#else +import Foreign.ForeignPtr( ForeignPtr, castForeignPtr ) +#endif + + +import qualified Data.ByteString as B +import qualified Data.ByteString.Internal as S + +import Codec.Picture.Types + +blitVector :: Vector Word8 -> Int -> Int -> B.ByteString +blitVector vec atIndex = S.PS ptr (offset + atIndex) + where (ptr, offset, _length) = unsafeToForeignPtr vec + +toByteString :: forall a. (Storable a) => Vector a -> B.ByteString +toByteString vec = S.PS (castForeignPtr ptr) offset (len * size) + where (ptr, offset, len) = unsafeToForeignPtr vec + size = sizeOf (undefined :: a) + +-- | Import a image from an unsafe pointer +-- The pointer must have a size of width * height * componentCount px +imageFromUnsafePtr :: forall px + . (Pixel px, (PixelBaseComponent px) ~ Word8) + => Int -- ^ Width in pixels + -> Int -- ^ Height in pixels + -> ForeignPtr Word8 -- ^ Pointer to the raw data + -> Image px +imageFromUnsafePtr width height ptr = + Image width height $ unsafeFromForeignPtr0 ptr size + where compCount = componentCount (undefined :: px) + size = width * height * compCount +