diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,16 +2,27 @@ ## Changelog -### Version +### 2.3.0.0 -2.2.0.0 +#### Added -#### Downstreams +- Support for GTK 3.10 +- Logo to about dialog +- `findOrCreateTemporaryDirectory` to Gifcurry library API -- [Hackage](https://hackage.haskell.org/package/Gifcurry-2.2.0.0) -- [Docker](https://hub.docker.com/r/lettier/gifcurry/) -- [Arch Linux AUR](https://aur.archlinux.org/packages/gifcurry) +#### Changed +- Switched icon from ICO to PNG +- Use XdgCache location for cross compatible way of storing temporary files + +#### Removed + +- ICO files + +------------------------------------------------------------------------------- + +### 2.2.0.0 + #### Added - Loading a video now populates the start and duration fields @@ -46,13 +57,7 @@ ------------------------------------------------------------------------------- -### Version - -2.1.1.0 - -#### Downstreams - -- [Hackage](https://hackage.haskell.org/package/Gifcurry-2.1.1.0) +### 2.1.1.0 #### Added @@ -71,13 +76,7 @@ ------------------------------------------------------------------------------- -### Version - -2.1.0.0 - -#### Downstreams - -- [Hackage](https://hackage.haskell.org/package/Gifcurry-2.1.0.0) +### 2.1.0.0 #### Added @@ -102,13 +101,7 @@ ------------------------------------------------------------------------------- -### Version - -2.0.0.2 - -#### Downstreams - -- [Hackage](https://hackage.haskell.org/package/Gifcurry-2.0.0.2) +### 2.0.0.2 #### Added @@ -124,13 +117,7 @@ ------------------------------------------------------------------------------- -### Version - -2.0.0.1 - -#### Downstreams - -- [Hackage](https://hackage.haskell.org/package/Gifcurry-2.0.0.1) +### 2.0.0.1 #### Added @@ -147,13 +134,7 @@ ------------------------------------------------------------------------------- -### Version - -2.0.0.0 - -#### Downstreams - -- [Hackage](https://hackage.haskell.org/package/Gifcurry-2.0.0.0) +### 2.0.0.0 #### Added @@ -171,13 +152,7 @@ ------------------------------------------------------------------------------- -### Version - -0.1.1.0 - -#### Downstreams - -- [Hackage](https://hackage.haskell.org/package/Gifcurry-0.1.1.0) +### 0.1.1.0 #### Added @@ -195,13 +170,7 @@ ------------------------------------------------------------------------------- -### Version - -0.1.0.6 - -#### Downstreams - -- +### 0.1.0.6 #### Added @@ -217,13 +186,7 @@ ------------------------------------------------------------------------------- -### Version - -0.1.0.5 - -#### Downstreams - -- [Hackage](https://hackage.haskell.org/package/Gifcurry-0.1.0.5) +### 0.1.0.5 #### Added @@ -239,13 +202,7 @@ ------------------------------------------------------------------------------- -### Version - -0.1.0.4 - -#### Downstreams - -- [Hackage](https://hackage.haskell.org/package/Gifcurry-0.1.0.4) +### 0.1.0.4 #### Added @@ -261,13 +218,7 @@ ------------------------------------------------------------------------------- -### Version - -0.1.0.3 - -#### Downstreams - -- [Hackage](https://hackage.haskell.org/package/Gifcurry-0.1.0.3) +### 0.1.0.3 #### Added @@ -283,13 +234,7 @@ ------------------------------------------------------------------------------- -### Version - -0.1.0.2 - -#### Downstreams - -- [Hackage](https://hackage.haskell.org/package/Gifcurry-0.1.0.2) +### 0.1.0.2 #### Added @@ -305,13 +250,7 @@ ------------------------------------------------------------------------------- -### Version - -0.1.0.1 - -#### Downstreams - -- [Hackage](https://hackage.haskell.org/package/Gifcurry-0.1.0.1) +### 0.1.0.1 #### Added @@ -327,13 +266,7 @@ ------------------------------------------------------------------------------- -### Version - -0.1.0.0 - -#### Downstreams - -- [Hackage](https://hackage.haskell.org/package/Gifcurry-0.1.0.0) +### 0.1.0.0 #### Added @@ -346,14 +279,3 @@ #### Removed - - -------------------------------------------------------------------------------- - -## License - -See [LICENSE](LICENSE). - -## Copyright - -(C) 2017 David Lettier -[lettier.com](http://www.lettier.com/) diff --git a/Gifcurry.cabal b/Gifcurry.cabal --- a/Gifcurry.cabal +++ b/Gifcurry.cabal @@ -1,5 +1,5 @@ name: Gifcurry -version: 2.2.0.0 +version: 2.3.0.0 synopsis: GIF creation utility. description: Create animated GIFs, optionally overlaid with text, from video files. homepage: https://github.com/lettier/gifcurry @@ -18,10 +18,12 @@ , ./lib/GtkMainSyncAsync.hs , ./lib/LICENSE , ./src/dev/Paths_Gifcurry.hs - , ./src/data/icon.ico + , ./src/data/gifcurry-logo.svg + , ./src/data/gifcurry-icon.png , ./makefile data-files: data/gui.glade - , data/icon.ico + , data/gifcurry-logo.svg + , data/gifcurry-icon.png data-dir: ./src/ cabal-version: >=1.10 diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -16,16 +16,24 @@ ## CLI Usage ```bash -gifcurry_cli \ - -i inputFile \ - -o outputFile \ - -s startTime \ - -d durationTime \ - -w widthSize \ - -q qualityPercent \ - -f fontChoice \ - -t topText \ - -b bottomText +gifcurry_cli [OPTIONS] + +Common flags: + -i --inputfile=FILE The input video file path and name. + -o --outputfile=ITEM The output GIF file path and name. + -s --starttime=NUM The start time (in seconds) for the first frame. + -d --durationtime=NUM How long the GIF lasts (in seconds) from the start + time. + -w --widthsize=INT How wide the GIF needs to be. Height will scale to + match. + -q --qualitypercent=NUM Ranges from 0.0 to 100.0. + -f --fontchoice=ITEM Choose your desired font for the top and bottom + text. + -t --toptext=ITEM The text you wish to add to the top of the GIF. + -b --bottomtext=ITEM The text you wish to add to the bottom of the GIF. + -? --help Display help message + -V --version Print version information + --numeric-version Print just the version number ``` ## CLI Example @@ -51,7 +59,7 @@ __/ | |___/ -Gifcurry 2.2.0.0 +Gifcurry 2.3.0.0 (C) 2016 David Lettier lettier.com @@ -75,35 +83,59 @@ ## Dependencies -* [Haskell](https://www.haskell.org/platform/) +### Run + +* [GTK+](http://www.gtk.org/download/index.php) * [FFmpeg](https://www.ffmpeg.org/download.html) * [ImageMagick](http://www.imagemagick.org/script/download.php) -* [GTK+](http://www.gtk.org/download/index.php) +### Build + +* [Haskell](https://www.haskell.org/platform/) + ## Install & Run ### Linux +#### [AppImage (GUI Only)](https://appimage.github.io/gifcurry/) + +```bash +# Install FFmpeg (https://www.ffmpeg.org/download.html) +# Install ImageMagick (https://www.imagemagick.org/script/download.php) +# Install GNU Wget (https://www.gnu.org/software/wget/) or download the AppImage with your browser +# Find the latest release at https://github.com/lettier/gifcurry/releases +# * equals the version number +# Download gifcurry-*-x86_64.AppImage +# Right click on the AppImage and allow the file to be executed as a program +wget https://github.com/lettier/gifcurry/releases/download/*/gifcurry-*-x86_64.AppImage +chmod a+x gifcurry-*-x86_64.AppImage +./gifcurry-*-x86_64.AppImage +# If you would like to install the AppImage, you can run the following +cd +wget "https://raw.githubusercontent.com/lettier/gifcurry/master/packaging/linux/gifcurry-gui-install.sh" -O "gifcurry-gui-install.sh" +chmod +x "gifcurry-gui-install.sh" +./gifcurry-gui-install.sh +``` + #### Ubuntu/Mint ```bash # Install FFmpeg (https://www.ffmpeg.org/download.html) # Install ImageMagick (https://www.imagemagick.org/script/download.php) -sudo add-apt-repository ppa:kirillshkrogalev/ffmpeg-next +sudo add-apt-repository ppa:jonathonf/ffmpeg-3 sudo apt-get update sudo apt-get install ffmpeg imagemagick -# Install Haskell (https://www.haskell.org/platform/) # Install GNU Wget (https://www.gnu.org/software/wget/) # Find the latest release at https://github.com/lettier/gifcurry/releases # * equals the version number wget https://github.com/lettier/gifcurry/releases/download/*/gifcurry-linux-*.tar.gz tar -xvfz gifcurry-linux*.tar.gz cd gifcurry-linux-*/bin -./gifcurry_gui ./gifcurry_cli -? +./gifcurry_gui ``` -#### Arch/Manjaro +#### Arch/Manjaro/Antergos ```bash cd @@ -117,8 +149,8 @@ makepkg -sic cd rm -rf build_gifcurry -gifcurry_gui gifcurry_cli -? +gifcurry_gui ``` ### Mac @@ -126,8 +158,9 @@ #### Binaries ```bash -# If you do not have Homebrew +# Install Homebrew /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" +brew update brew install ffmpeg brew install imagemagick brew install ghostscript @@ -138,43 +171,32 @@ wget https://github.com/lettier/gifcurry/releases/download/*/gifcurry-macosx-*.tar.gz tar xvfz gifcurry-macosx-*.tar.gz cd gifcurry-macosx-*/bin -./gifcurry_gui ./gifcurry_cli -? +./gifcurry_gui ``` #### Compile ```bash -# If you do not have Homebrew +# Install Homebrew /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" brew update brew install xcode brew install git -brew install ghc -sudo chown -R $(whoami):admin /usr/local/bin -brew link ghc -brew install cabal-install -brew install pkg-config -brew install glib -brew install gtk+3 -brew install cairo -brew install pango -brew install ffmpeg -brew install imagemagick -brew install ghostscript -brew install gnome-icon-theme -mkdir gifcurry -cd gifcurry -cabal sandbox init -cabal update -cabal install alex happy -j -cabal install gifcurry -j -cd .cabal-sandbox/bin/ -./gifcurry_gui -./gifcurry_cli -? +git clone git@github.com:lettier/gifcurry.git +cd gifcurry/ +brew cask install haskell-platform +brew install pkg-config gobject-introspection cairo gdk-pixbuf gsettings-desktop-schemas \ + gtk+3 gtk-mac-integration ffmpeg imagemagick ghostscript gnome-icon-theme +stack setup +stack install hsc2hs +stack install +export PATH=$PATH:"$HOME/.local/bin/" +gifcurry_cli -? +gifcurry_gui ``` -### Hackage +### [Hackage](https://hackage.haskell.org/package/Gifcurry) #### Stack @@ -190,8 +212,8 @@ cd Gifcurry-* stack setup stack install -stack exec -- gifcurry_gui stack exec -- gifcurry_cli -? +stack exec -- gifcurry_gui ``` #### Cabal @@ -204,11 +226,11 @@ cabal install alex happy -j cabal install gifcurry -j cd ~/.cabal/bin -./gifcurry_gui ./gifcurry_cli -? +./gifcurry_gui ``` -### Github +### [Github](https://github.com/lettier/gifcurry) ```bash # Install GNU Make (https://www.gnu.org/software/make/) @@ -218,8 +240,8 @@ git clone git@github.com:lettier/gifcurry.git cd gifcurry/ make -make run_gui make run_cli CLI_ARGS='-?' +make run_gui ``` ## License diff --git a/makefile b/makefile --- a/makefile +++ b/makefile @@ -9,14 +9,13 @@ STACK_GHC_BIN=`$(STACK) path --compiler-bin` STACK_PATHS=$(STACK_PATH_LOCAL_BIN):$(STACK_GHC_BIN) CABAL=env PATH=$(PATH):$(STACK_PATHS) $(STACK_PATH_LOCAL_BIN)/cabal -VERSION='2.2.0.0' +VERSION='2.3.0.0' export PATH := $(PATH):$(STACK_PATH_LOCAL_BIN) all: setup update sandbox_clean clean alex happy install_dependencies configure build install setup: - $(STACK) setup && $(STACK) update && $(STACK) install Cabal && $(STACK) install cabal-install alex: setup diff --git a/src/data/gifcurry-icon.png b/src/data/gifcurry-icon.png new file mode 100644 Binary files /dev/null and b/src/data/gifcurry-icon.png differ diff --git a/src/data/gifcurry-logo.svg b/src/data/gifcurry-logo.svg new file mode 100644 --- /dev/null +++ b/src/data/gifcurry-logo.svg @@ -0,0 +1,143 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + (C) DAVID LETTIER + Gifcurry + diff --git a/src/data/gui.glade b/src/data/gui.glade --- a/src/data/gui.glade +++ b/src/data/gui.glade @@ -1,7 +1,41 @@ - + + + + + + True False @@ -39,7 +73,7 @@ False mouse 400 - icon.ico + gifcurry-icon.png center @@ -307,7 +341,7 @@ - + True False vertical @@ -396,7 +430,7 @@ - + True False False @@ -475,7 +509,7 @@ - + @@ -491,7 +525,7 @@ gifcurry-window gifcurry-window Gifcurry - 2.2.0.0 + 2.3.0.0 (C) 2016 David Lettier lettier.com https://github.com/lettier/gifcurry @@ -526,15 +560,15 @@ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. David Lettier - icon.ico + gifcurry-logo.svg custom - + False vertical 2 - + False end @@ -567,12 +601,12 @@ warning Are you sure you want to make a GIF that long? - + False vertical 2 - + False True end diff --git a/src/data/icon.ico b/src/data/icon.ico deleted file mode 100644 Binary files a/src/data/icon.ico and /dev/null differ diff --git a/src/gui/Main.hs b/src/gui/Main.hs --- a/src/gui/Main.hs +++ b/src/gui/Main.hs @@ -31,6 +31,7 @@ , defaultGifParams , gifParamsValid , getVideoDurationInSeconds + , findOrCreateTemporaryDirectory ) import qualified GtkMainSyncAsync (gtkMainSync, gtkMainAsync) @@ -75,6 +76,8 @@ GI.Gtk.dialogAddActionWidget longGifGtkMessageDialog yesGtkButton (enumToInt32 GI.Gtk.ResponseTypeYes) GI.Gtk.dialogAddActionWidget longGifGtkMessageDialog noGtkButton (enumToInt32 GI.Gtk.ResponseTypeNo) + temporaryDirectory <- Gifcurry.findOrCreateTemporaryDirectory + _ <- GI.Gtk.onFileChooserButtonFileSet inputFileButton $ do setStatusEntryReady statusEntry GI.Gtk.imageSetFromIconName firstFrameImage @@ -91,14 +94,31 @@ _ <- GI.Gtk.entrySetText startTimeEntry startText _ <- GI.Gtk.entrySetText durationTimeEntry durationText unless (Data.Text.null startText || Data.Text.null durationText) ( - makeFirstFramePreview inputFileButton startTimeEntry durationTimeEntry firstFrameImage lastFrameImage + makeFirstFramePreview + inputFileButton + startTimeEntry + durationTimeEntry + firstFrameImage + lastFrameImage + temporaryDirectory ) _ <- GI.Gtk.onEditableChanged startTimeEntry $ - makeFirstFramePreview inputFileButton startTimeEntry durationTimeEntry firstFrameImage lastFrameImage + makeFirstFramePreview + inputFileButton + startTimeEntry + durationTimeEntry + firstFrameImage + lastFrameImage + temporaryDirectory _ <- GI.Gtk.onEditableChanged durationTimeEntry $ - makeLastFramePreview inputFileButton startTimeEntry durationTimeEntry lastFrameImage + makeLastFramePreview + inputFileButton + startTimeEntry + durationTimeEntry + lastFrameImage + temporaryDirectory _ <- GI.Gtk.onWidgetButtonReleaseEvent createButton $ \ _ -> do inputFilePathName <- inputFileButtonGetText inputFileButton @@ -238,10 +258,22 @@ framePreviewDirectoryName :: String framePreviewDirectoryName = "gifcurry-frame-previews" -makeLastFramePreview :: GI.Gtk.FileChooserButton -> GI.Gtk.Entry -> GI.Gtk.Entry -> GI.Gtk.Image -> IO () -makeLastFramePreview inputFileButton startTimeEntry durationTimeEntry lastFrameImage = +makeLastFramePreview :: + GI.Gtk.FileChooserButton -> + GI.Gtk.Entry -> + GI.Gtk.Entry -> + GI.Gtk.Image -> + System.FilePath.FilePath -> + IO () +makeLastFramePreview + inputFileButton + startTimeEntry + durationTimeEntry + lastFrameImage + temporaryDirectory + = void $ forkIO $ - withTempDirectory "." framePreviewDirectoryName $ \ tmpdir -> do + withTempDirectory temporaryDirectory framePreviewDirectoryName $ \ tmpdir -> do inputFilePathName <- inputFileButtonGetText inputFileButton startTimeText <- GI.Gtk.entryGetText startTimeEntry durationTimeText <- GI.Gtk.entryGetText durationTimeEntry @@ -258,17 +290,36 @@ _ <- setOrResetFramePrevew doSet inputFilePathName outputFilePathName startTime lastFrameImage " LAST FRAME " return() -makeFirstFramePreview :: GI.Gtk.FileChooserButton -> GI.Gtk.Entry -> GI.Gtk.Entry -> GI.Gtk.Image -> GI.Gtk.Image -> IO () -makeFirstFramePreview inputFileButton startTimeEntry durationTimeEntry firstFrameImage lastFrameImage = +makeFirstFramePreview :: + GI.Gtk.FileChooserButton -> + GI.Gtk.Entry -> + GI.Gtk.Entry -> + GI.Gtk.Image -> + GI.Gtk.Image -> + System.FilePath.FilePath -> + IO () +makeFirstFramePreview + inputFileButton + startTimeEntry + durationTimeEntry + firstFrameImage + lastFrameImage + temporaryDirectory + = void $ forkIO $ do - withTempDirectory "." framePreviewDirectoryName $ \ tmpDir -> do + withTempDirectory temporaryDirectory framePreviewDirectoryName $ \ tmpDir -> do inputFilePathName <- inputFileButtonGetText inputFileButton startTime <- entryGetFloat startTimeEntry (-1.0) let outputFilePathName = tmpDir ++ "/gifcurry-first-frame-preview.gif" let doSet = not (Data.List.null inputFilePathName) && (startTime >= 0.0) _ <- setOrResetFramePrevew doSet inputFilePathName outputFilePathName startTime firstFrameImage " FIRST FRAME " return () - makeLastFramePreview inputFileButton startTimeEntry durationTimeEntry lastFrameImage + makeLastFramePreview + inputFileButton + startTimeEntry + durationTimeEntry + lastFrameImage + temporaryDirectory setOrResetFramePrevew :: Bool -> String -> String -> Float -> GI.Gtk.Image -> String -> IO () setOrResetFramePrevew False _ _ _ image _ = GtkMainSyncAsync.gtkMainAsync $ resetImage image diff --git a/src/lib/Gifcurry.hs b/src/lib/Gifcurry.hs --- a/src/lib/Gifcurry.hs +++ b/src/lib/Gifcurry.hs @@ -15,6 +15,7 @@ , gifParamsValid , versionNumber , getVideoDurationInSeconds + , findOrCreateTemporaryDirectory ) where import System.Process @@ -44,7 +45,7 @@ -- | The version number. versionNumber :: String -versionNumber = "2.2.0.0" +versionNumber = "2.3.0.0" -- | Specifies default parameters for 'startTime', 'durationTime', 'widthSize', 'qualityPercent', and 'fontChoice'. defaultGifParams :: GifParams @@ -75,13 +76,14 @@ -- else return () -- @ gif :: GifParams -> IO (Either IOError String) -gif gifParams = - withTempDirectory "." "gifcurry-frames" $ \tmpdir -> do +gif gifParams = do + temporaryDirectory <- findOrCreateTemporaryDirectory + withTempDirectory temporaryDirectory "gifcurry-frames" $ \tmpdir -> do printGifParams gifParams tmpdir validParams <- gifParamsValid gifParams if validParams then do - fFMpegResult <- tryFfmpeg gifParams tmpdir + fFMpegResult <- tryFfmpeg gifParams tmpdir let fFMpegSuccess = eitherBool fFMpegResult if fFMpegSuccess then do @@ -154,6 +156,14 @@ result :: Either IOError String -> IO (Maybe Float) result (Left _) = return Nothing result (Right durationString) = return (readMaybe durationString :: Maybe Float) + +-- | Finds or creates the temporary directory for Gifcurry. +-- This directory is used for storing temporary frames. +findOrCreateTemporaryDirectory :: IO FilePath +findOrCreateTemporaryDirectory = do + filePath <- System.Directory.getXdgDirectory System.Directory.XdgCache "gifcurry" + System.Directory.createDirectoryIfMissing True filePath + return filePath printGifParams :: GifParams -> String -> IO () printGifParams