https://github.com/hhsnopek/tomify

Replace faces in image(s) with Tom wiggle or your own Gif!
https://github.com/hhsnopek/tomify

face-recognition gif-creator opencv

Last synced: about 1 month ago
JSON representation

Replace faces in image(s) with Tom wiggle or your own Gif!

• Host: GitHub
• URL: https://github.com/hhsnopek/tomify
• Owner: hhsnopek
• License: mit
• Created: 2017-07-25T20:26:09.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-07-26T15:45:25.000Z (over 7 years ago)
• Last Synced: 2024-08-13T03:05:04.008Z (3 months ago)
• Topics: face-recognition, gif-creator, opencv
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/tomify
• Size: 14.9 MB
• Stars: 11
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license.md

Awesome Lists containing this project

README

        
# Tomify

> Replace faces in an image with Tom wiggle or your own Gif!

![tomified](examples/tomified.gif)

## Requirements

- [Imagemagick](//www.imagemagick.org)

- [OpenCV](//opencv.org/downloads.html) v2.4.x 

## CLI Usage

```

  Replace faces in image(s) with Tom wiggle or your own Gif!

  Usage: $ tomify 

  Options:

    --output, -o Output Path, default: $PWD

    --resize, -r Resize Tom, default: 1 (Number)

    --debug, -d Debug Mode, default: false

    --gif, -g Gif Path, default: tom-wiggle.gif

    --help, -h Display Help

    --version Display Version

  Examples:

    $ tomify image.jpg

        # process single image and save to $PWD/image.gif

    $ tomify person1.jpg person2.jpg --output ./new-folder

        # process multiple images, and saves to ./new-folder

```

## Internal API

### Usage

#### Replace all faces in a gif with your own gif

```

const gif = 'path/to/custom.gif'

const file = 'image/with/faces.jpg'

const dest = 'path/to/output.gif'

const resize = 1

replaceAll({ file, dest, resize, gif })

  .then(() => {

    console.log('Done!')

  })

  .catch(err => {

    console.error('Uh oh!')

    console.error(err)

  })

```

### Reference

#### replaceAll

```

// Find and replace all Faces with gif

async function replaceAll({ file, dest, resize })

  // Params

  Object

    file = Filepath

    dest = Filepath

    resize = Integer

```

#### addGifs

```

// Adds a Gif to all all positions

async function addGifs({ dest, file, positions })

  // Params

  Object

    dest = Filepath

    file = Filepath

    positions = Array of Objects

      Object - {file, x, y, height, width, gif} // see createQuery for details

```

#### createQuery

```

// Creates an imagemagick query, used internally in addGifs

function createQuery({ file, x, y, height, width, gif })

  // Params

  Object

    file = Filepath

    x = Integer

    y = Integer

    height = Integer

    width = Integer

    gif = Filepath

  // Returns Formatted Array

```

#### detect

```

// Async Detect - returns Promise

function detect(file)

  // Params

  file = Filepath

  // Returns

  Object

    faces = Array of Face (See faced)

    image = Matrix

    file = Filepath

```

#### debug

```

// Enables logging if environment variable TOMIFY_DEBUG is 'true'

// note: this is just a small wrapper to console.error

function debug(msg, ...args)

  // Params

  msg = String

  ...args

```

## Known Issues

- Running macOS 10.12 (Sierra)? See: https://github.com/Homebrew/homebrew-science/issues/4303

## License

[MIT](license.md) © [Henry Snopek](//hhsnopek.com)