Gifcurry

Produces GIFs using FFmpeg and ImageMagick. The main function is gif.

Documentation

gif :: GifParams -> IO (Either IOError String)

Inputs GifParams and outputs either an IO IOError or IO String.

   import qualified Gifcurry (gif, GifParams(..), defaultGifParams, gifParamsValid)
   main :: IO ()
   main = do
     let params = Gifcurry.defaultGifParams { Gifcurry.inputFile = "./in.mov", Gifcurry.outputFile = "./out.gif" }
     valid <- Gifcurry.gifParamsValid params
     if valid
       then do
         result <- Gifcurry.gif params
         print result
       else return ()

data GifParams

The data type record required by gif.

Constructors

GifParams

Fields

• inputFile :: String
• outputFile :: String
• saveAsVideo :: Bool
• startTime :: Float
• durationTime :: Float
• widthSize :: Int
• qualityPercent :: Float
• fontChoice :: String
• topText :: String
• bottomText :: String
• leftCrop :: Float
• rightCrop :: Float
• topCrop :: Float
• bottomCrop :: Float

Instances

Read GifParams

Methods

readsPrec :: Int -> ReadS GifParams

readList :: ReadS [GifParams]

readPrec :: ReadPrec GifParams

readListPrec :: ReadPrec [GifParams]

Show GifParams

Methods

showsPrec :: Int -> GifParams -> ShowS

show :: GifParams -> String

showList :: [GifParams] -> ShowS

defaultGifParams :: GifParams

Specifies default parameters for startTime, durationTime, widthSize, qualityPercent, and fontChoice.

defaultFontChoice :: String

Returns the default font choice used if no font choice is specified.

gifParamsValid :: GifParams -> IO Bool

Outputs True or False if the parameters in the GifParams record are valid.

versionNumber :: String

The version number.

getVideoDurationInSeconds :: GifParams -> IO (Maybe Float)

Returns the duration of the video in seconds if successful.

   import qualified Gifcurry (getVideoDurationInSeconds)
   -- ...
   let params = Gifcurry.defaultGifParams { Gifcurry.inputFile = "./in.mov" }
   maybeDuration <- Gifcurry.getVideoDurationInSeconds params
   let duration = case maybeDuration of
                     Nothing    -> 0.0
                     Just float -> float

getOutputFileWithExtension :: GifParams -> String

Adds the proper file extension to the outputFile depending on saveAsVideo.

getVideoWidthAndHeight :: GifParams -> IO (Maybe (Float, Float))

Returns the width and height of the video if successful. If the width and/or height of the video is <= 0, it will return nothing.

findOrCreateTemporaryDirectory :: IO FilePath

Finds or creates the temporary directory for Gifcurry. This directory is used for storing temporary frames.