Burn Subtitles into a video

Description

Burn Subtitles into a video

Usage

ari_burn_subtitles(video, srt, verbose = FALSE)

Arguments

Value

Name of output video

Note

This needs ffmpeg that was compiled with --enable-libass as per https://trac.ffmpeg.org/wiki/HowToBurnSubtitlesIntoVideo

Get the path to an ari example file

Description

This function allows you to quickly access files that are used in the ari documentation.

Usage

ari_example(path = NULL)

Arguments

Value

A character string

Examples

ari_example("ari_intro.Rmd")

Create a video from slides and a script

Description

ari_narrate creates a video from a script written in markdown and HTML slides created with rmarkdown or a similar package. This function uses Amazon Polly via ari_spin.

Usage

ari_narrate(
  script,
  slides,
  output = tempfile(fileext = ".mp4"),
  voice = text2speech::tts_default_voice(service = service),
  service = "amazon",
  capture_method = c("vectorized", "iterative"),
  subtitles = FALSE,
  ...,
  verbose = FALSE,
  audio_codec = get_audio_codec(),
  video_codec = get_video_codec(),
  cleanup = TRUE
)

Arguments

Value

The output from ari_spin

Examples

## Not run: 

# 
ari_narrate(system.file("test", "ari_intro_script.md", package = "ari"),
            system.file("test", "ari_intro.html", package = "ari"),
            voice = "Joey")


## End(Not run)

Create a video from images and text

Description

Given equal length vectors of paths to images (preferably .jpgs or .pngs) and strings which will be synthesized by Amazon Polly or any other synthesizer available in tts, this function creates an .mp4 video file where each image is shown with its corresponding narration. This function uses ari_stitch to create the video.

Usage

ari_spin(
  images,
  paragraphs,
  output = tempfile(fileext = ".mp4"),
  voice = text2speech::tts_default_voice(service = service),
  service = "amazon",
  subtitles = FALSE,
  ...
)

Arguments

Details

This function needs to connect to Amazon Web Services in order to create the narration. You can find a guide for accessing AWS from R here. For more information about how R connects to Amazon Polly see the aws.polly] documentation here.

Value

The output from ari_stitch

Examples

## Not run: 

slides <- system.file("test", c("mab2.png", "mab1.png"),
package = "ari")
sentences <- c("Welome to my very interesting lecture.",
               "Here are some fantastic equations I came up with.")
ari_spin(slides, sentences, voice = "Joey")


## End(Not run)

Create a video from images and audio

Description

Given a vector of paths to images (preferably .jpgs or .pngs) and a flat list of Waves of equal length this function will create an .mp4 video file where each image is shown with its corresponding audio. Take a look at the readWave function if you want to import your audio files into R. Please be sure that all images have the same dimensions.

Usage

ari_stitch(
  images,
  audio,
  output = tempfile(fileext = ".mp4"),
  verbose = FALSE,
  cleanup = TRUE,
  ffmpeg_opts = "",
  divisible_height = TRUE,
  audio_codec = get_audio_codec(),
  video_codec = get_video_codec(),
  video_sync_method = "2",
  audio_bitrate = NULL,
  video_bitrate = NULL,
  pixel_format = "yuv420p",
  fast_start = TRUE,
  deinterlace = TRUE,
  stereo_audio = TRUE
)

Arguments

Details

This function uses FFmpeg which you should be sure is installed before using this function. If running Sys.which("ffmpeg") in your R console returns an empty string after installing FFmpeg then you should set the path to FFmpeg on you computer to an environmental variable using Sys.setenv(ffmpeg = "path/to/ffmpeg"). The environmental variable will always override the result of Sys.which("ffmpeg").

Value

A logical value, with the attribute outfile for the output file.

Examples

## Not run: 
if (ffmpeg_version_sufficient()) {
result = ari_stitch(
ari_example(c("mab1.png", "mab2.png")),
list(tuneR::noise(), tuneR::noise()))
} 

## End(Not run)

Create spoken audio files

Description

A simple function for demoing how spoken text will sound.

Usage

ari_talk(
  paragraphs,
  output = tempfile(fileext = ".wav"),
  voice = text2speech::tts_default_voice(service = service),
  service = "amazon"
)

Arguments

Value

A Wave output object, with the attribute outfile of the output file name.

Get Codecs for ffmpeg

Description

Get Codecs for ffmpeg

Usage

ffmpeg_codecs()

ffmpeg_video_codecs()

ffmpeg_audio_codecs()

ffmpeg_muxers()

ffmpeg_version()

ffmpeg_version_sufficient()

check_ffmpeg_version()

Value

A 'data.frame' of codec names and capabilities

Examples

## Not run: 
if (ffmpeg_version_sufficient()) {
ffmpeg_codecs()
ffmpeg_video_codecs()
ffmpeg_audio_codecs()
}

## End(Not run)

Get Path to ffmpeg Executable

Description

Get Path to ffmpeg Executable

Usage

ffmpeg_exec(quote = FALSE)

have_ffmpeg_exec()

Arguments

Value

The path to the ffmpeg executable, or an error.

Note

This looks using 'Sys.getenv("ffmpeg")' and 'Sys.which("ffmpeg")' to find 'ffmpeg'. If 'ffmpeg' is not in your PATH, then please set the path to 'ffmpeg' using 'Sys.setenv(ffmpeg = "/path/to/ffmpeg")'

Examples

## Not run: 
if (have_ffmpeg_exec()) { 
ffmpeg_exec()
}

## End(Not run)

Set Default Audio and Video Codecs

Description

Set Default Audio and Video Codecs

Usage

set_audio_codec(codec)

set_video_codec(codec = "libx264")

get_audio_codec()

get_video_codec()

audio_codec_encode(codec)

video_codec_encode(codec)

Arguments

Value

A 'NULL' output

See Also

[ffmpeg_codecs()] for options

Examples

## Not run: 
if (have_ffmpeg_exec()) {
print(ffmpeg_version())
get_audio_codec()
set_audio_codec(codec = "libfdk_aac")
get_audio_codec()
set_audio_codec(codec = "aac")
get_audio_codec()
}
if (have_ffmpeg_exec()) {
get_video_codec()
set_video_codec(codec = "libx265") 
get_video_codec()
set_video_codec(codec = "libx264")
get_video_codec()
}
## empty thing
if (have_ffmpeg_exec()) {
video_codec_encode("libx264")

audio_codec_encode("aac")
}

## End(Not run)