peggy

A module for utilizing FFmpeg in Gleam. It requires that you have FFmpeg in your path. This modules contains the tools for building FFmpeg commands in a type-safe manner appropriate for video services written in this wonderful language.

Types

Cfg

</>

pub type Cfg {
  Cfg(overwrite_out: Bool)
}

Constructors

```
Cfg(overwrite_out: Bool)
```

CmdOption

</>

A CLI argument provided to FFmpeg

pub type CmdOption {
  CmdOption(name: String, value: String)
  Flag(flag: String)
}

Constructors

```
CmdOption(name: String, value: String)
```
```
Flag(flag: String)
```

Command

</>

Command provided to FFmpeg

pub type Command {
  Command(
    files: List(File),
    options: List(CmdOption),
    config: Cfg,
  )
}

Constructors

Command(files: List(File), options: List(CmdOption), config: Cfg)

File

</>

A file input provided to FFmpeg

pub type File {
  File(String)
}

Constructors

```
File(String)
```

Constants

default_cfg

</>

pub const default_cfg: Cfg

Functions

add_arg

</>

pub fn add_arg(
  cmd: Command,
  name: String,
  value: String,
) -> Command

Adds argument to command

add_file

</>

pub fn add_file(cmd: Command, file_name: String) -> Command

Adds file to command

add_flag

</>

pub fn add_flag(cmd: Command, flag: String) -> Command

allow_recast

</>

pub fn allow_recast(cmd: Command) -> Command

Allow forcing a decoder of a different media type than the one detected or designated by the demuxer.

CMD: -recast_media

aspect_ratio

</>

pub fn aspect_ratio(cmd: Command, ratio: String) -> Command

Set aspect ratio

CMD: -aspect

audio_bitrate

</>

pub fn audio_bitrate(cmd: Command, rate: String) -> Command

Set audio bitrate

CMD: -b:a

audio_codec

</>

pub fn audio_codec(cmd: Command, codec: String) -> Command

Specify audio codec

use ‘copy’ to copy stream

CMD: -c:a <audio_codec>

audio_filter

</>

pub fn audio_filter(cmd: Command, filter: String) -> Command

Apply filter to audio

CMD: -af

audio_frame_rate

</>

pub fn audio_frame_rate(cmd: Command, rate: String) -> Command

Set audio frame rate

CMD: -s

audio_pad

</>

pub fn audio_pad(cmd: Command) -> Command

Audio pad

CMD: -apad

audio_quality

</>

pub fn audio_quality(cmd: Command, quality: String) -> Command

Set audio quality

This configuration is codec-specific

CMD: -aq

codec

</>

pub fn codec(cmd: Command, codec: String) -> Command

Specify codec

use ‘copy’ to copy stream

CMD: -c

disable_audio

</>

pub fn disable_audio(cmd: Command) -> Command

Disable audio output

CMD: -an

disable_data

</>

pub fn disable_data(cmd: Command) -> Command

Disable data

CMD: -dn

disable_subtitle

</>

pub fn disable_subtitle(cmd: Command) -> Command

Disable subtitles

-cn

disable_video

</>

pub fn disable_video(cmd: Command) -> Command

Disable video output

CMD: -vn

discard

</>

pub fn discard(cmd: Command) -> Command

Set discard

disposition

</>

pub fn disposition(cmd: Command) -> Command

Set discard

duration

</>

pub fn duration(cmd: Command, duration: String) -> Command

Specifies duration to read/write from/to input/output Arg given before input -> duration of input Arg given after input -> duration of output

This argument takes precedent over until (-to)

CMD: -t

err_rate

</>

pub fn err_rate(cmd: Command, rate: Float) -> Command

Set maximum error rate 0.0 -> No errors 1.0 -> All errors

CMD: -max_err_rate

exec_sync

</>

pub fn exec_sync(cmd: Command) -> Result(String, String)

Executes the command provided to ffmpeg

fmt

</>

pub fn fmt(cmd: Command, format: String) -> Command

Specify format of output

frame_rate

</>

pub fn frame_rate(cmd: Command, rate: String) -> Command

Set video frame rate

CMD: -s

frame_rate_max

</>

pub fn frame_rate_max(cmd: Command, rate: String) -> Command

Set frame size

CMD: -s

frame_size

</>

pub fn frame_size(cmd: Command, size: String) -> Command

Set frame size

CMD: -s

input

</>

pub fn input(cmd: Command, url: String) -> Command

Add input to command

limit_size

</>

pub fn limit_size(cmd: Command, size: Int) -> Command

Limit size of output file to a set number of bytes

CMD: -fs

loop

</>

pub fn loop(cmd: Command, loops: Int) -> Command

Specify format of output 0 -> No loop -1 -> Infinite loop

CMD: -stream_loop

metadata

</>

pub fn metadata(cmd: Command, metastring: String) -> Command

Add metadata to output

Usage

CMD: -metadata <key=value>

new_command

</>

pub fn new_command() -> Command

Creates new command for executing an FFmpeg command

no_overwrite

</>

pub fn no_overwrite(cmd: Command) -> Command

Do not overwrite the output file if exists. If the output file already exists, you will get an error

CMD: -n

num_audio_frames

</>

pub fn num_audio_frames(cmd: Command, num: String) -> Command

Set number of audio frames

CMD: -frames

num_frames

</>

pub fn num_frames(cmd: Command, num: String) -> Command

Set number of frames

CMD: -frames

num_video_frames

</>

pub fn num_video_frames(cmd: Command, num: String) -> Command

Set number of video frames

CMD: -frames

output

</>

pub fn output(cmd: Command, output: String) -> Command

Specify output of file

CMD:

overwrite

</>

pub fn overwrite(cmd: Command) -> Command

Overwrite output files if necessary

CMD: -y

seek

</>

pub fn seek(cmd: Command, pos: Int) -> Command

Seek position in input or output Arg given before input -> seek in input Arg given after input -> seek in output

CMD: -ss

seek_eof

</>

pub fn seek_eof(cmd: Command, pos: Int) -> Command

Seek position in input or output relative to EOF Position should be negative in this case (0 is EOF) Arg given before input -> seek in input Arg given after input -> seek in output

CMD: -sseof

set_pass

</>

pub fn set_pass(cmd: Command, pass: Int) -> Command

Set frame size

CMD: -pass <1|2|3>

subtitle_codec

</>

pub fn subtitle_codec(cmd: Command, codec: String) -> Command

Set subtitle codec

‘copy’ to copy stream

CMD: -c:s

target

</>

pub fn target(cmd: Command, tgt: String) -> Command

Set target filetype

until

</>

pub fn until(cmd: Command, stamp: String) -> Command

Specifies location to stop reading/writing at Arg given before input -> duration of input Arg given after input -> duration of output

CMD: -to

video_bitrate

</>

pub fn video_bitrate(cmd: Command, rate: String) -> Command

Set video bitrate

CMD: -b:v

video_codec

</>

pub fn video_codec(cmd: Command, codec: String) -> Command

Specify video codec

use ‘copy’ to copy stream

CMD: -c:v <video_codec>

video_filter

</>

pub fn video_filter(cmd: Command, filter: String) -> Command

Apply filter to video

CMD: -vf

volume

</>

pub fn volume(cmd: Command, volume: String) -> Command

Set volume 256 = normal

CMD: -vol