timelapse

README

timelapse

A tool to create timelapses from a series of images using ImageMagick and FFMpeg.

Usage

Downlad the latest release here.

Linux (x64)

./timelapse-linux-amd64 --source-directory=/path/to/image/directory

Embedded Go

View the example or the CLI.

Documentation

Overview

Package timelapse provides the ability to generate a timelapse video from a series of sorted images.

Example Usage:

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/mpawlowski/timelapse"
	"github.com/mpawlowski/timelapse/src/pkg/ffmpeg"
	"github.com/mpawlowski/timelapse/src/pkg/imagemagick"
)

func main() {
	im := imagemagick.NewImageMagick()
	ff := ffmpeg.NewFFMpeg()
	tl := timelapse.NewTimelapseGenerator(im, ff)

	ctx := context.Background()
	sourceDir := "path/to/images"
	outputFile := "output.mp4"

	err := tl.GenerateTimelapse(ctx, sourceDir, outputFile)
	if err != nil {
		fmt.Println(err)
		os.Exit(1)
	}
}

Index

• func FxOptions() []fx.Option
• type Option
  • func WithFFMpegVideoOptions(opts ...ffmpeg.Option) Option
  • func WithImageMagickMorphOptions(opts ...imagemagick.ConvertOption) Option
• type TimelapseGenerator
  • func NewTimelapseGenerator(im imagemagick.ImageMagickConvert, ff ffmpeg.FFMpeg) TimelapseGenerator

Functions

func FxOptions

func FxOptions() []fx.Option

FxOptions returns an array of fx.Options for use of the timelapse package with go.uber.org/fx.

Example Usage:

app := fx.New(
	timelapse.FxOptions()...,
)

Types

type Option

type Option func(*timelapseOptions)

Option is an interface for functional options.

func WithFFMpegVideoOptions

func WithFFMpegVideoOptions(opts ...ffmpeg.Option) Option

WithFFMpegVideoOptions is a functional option for setting ffmpeg options.

func WithImageMagickMorphOptions

func WithImageMagickMorphOptions(opts ...imagemagick.ConvertOption) Option

WithImageMagickMorphOptions is a functional option for setting imagemagick options.

type TimelapseGenerator

type TimelapseGenerator interface {
	// GenerateTimelapse creates a timelapse video from a series of images.
	GenerateTimelapse(ctx context.Context, sourceDir string, outputFile string, options ...Option) error
}

func NewTimelapseGenerator

func NewTimelapseGenerator(
	im imagemagick.ImageMagickConvert,
	ff ffmpeg.FFMpeg,
) TimelapseGenerator

NewTimelapseGenerator creates a new TimelapseGenerator instance.