Adding auto-generated video to your slides
How can we add auto-generated video?
How does it work?
What do I need to do to make it optimal for viewers?
Adding a video to a set of slidesTime estimation: 20 minutesSupporting Materials:Published: Oct 20, 2020Last modification: Nov 9, 2023License: Tutorial Content is licensed under Creative Commons Attribution 4.0 International License. The GTN Framework is licensed under MITpurl PURL: https://gxy.io/GTN:T00071version Revision: 19
Based on the work by Delphine Larivière and James Taylor with their COVID-19 Lectures we have implemented a similar feature in the Galaxy Training Network.
In this tutorial, we will:
How it Works
We wrote a short script which does the following:
Locally and in production:
- Extracts a ‘script’ from the slides. We extract every presenter comment in the slidedeck, and turn this into a text file.
- Every line of this text file is then narrated by Amazon Polly (if you have money) or MozillaTTS (free).
- The slide deck is converted to a PDF, and then each slide is extracted as a PNG.
- Captions are extracted from the audio components.
- The narration is stitched together into an mp3
- The images are stitched together into an mp4 file
- The video, audio, and captions are muxed together into a final mp4 file
- We use Amazon Polly, paid for by the Galaxyproject
- The result is uploaded to an S3 bucket
We have attempted to simplify this process as much as possible, but making good slides which work well is up to you.
Writing Good Captions
Every slide must have some narration in the presenter notes. It does not make sense for students to see a slide without commentary. For each slide, you’ll need to write presenter notes in full, but short sentences.
Use simple and uncomplex sentences whenever possible. Break up ideas into easy to digest bits. Students will be listening to this spoken and possibly reading the captions.
2021-05-01 There used to be a limit of ~120 characters per sentence, but this is no longer an issue. We now break up sentences which are too long in the captions and show them over multiple timepoints. So if you need to write a really long sentence, you can, but we still advise to simplify sentences where possible.
Captions per Slide
Every slide must have some speaker notes in this system, NO exceptions.
Sentences should end with punctuation like
? or even
! if you’re feeling excited.
These are generally fine as-is. (e.g.
i.e. is fine as-is,
RNA is fine, etc.) Make sure abbreviations are all caps though.
Good This role deploys CVMFS.
In the captions you will want to teach the GTN how to pronounce these words by editing
bin/ari-map.yml to provide your definition.
|/ E T C
The same applies to the many terms we read differently from how they are written, e.g. ‘src’ vs ‘source’. Most of us would pronounce it like the latter, even though it isn’t spelt that way. Our speaking robot doesn’t know what we mean, so we need to spell it out properly.
So we write the definition in the
(Written 2020-12-16, things may have changed since.)
Be sure to check the pronunciation of the slides. There are known issues with heteronyms, words spelt the same but having different pronunciation and meaning. Consider “read” for a classic example, or “analyses” for one that comes up often in the GTN. “She analyses data” and “Multiple analyses” are pronounced quite differently based on their usage in sentences. See the wiktionary page for more information, or the list of English heteronyms you might want to be aware of.
This becomes an issue for AWS Polly and Mozilla’s TTS which both don’t have sufficient context sometimes to choose between the two pronunciations. You’ll find that “many analyses” is pronounced correctly while “multiple analyses” isn’t.
Oftentimes the services don’t understand part of speech, so by adding adjectives to analyses, you confuse the engine in to thinking it should be the third person singular pronunciation. This is probably because it only has one or two words of context ahead of the word to be pronounced.
Enable the Video
Lastly, we need to tell the GTN framework we would like videos to be generated.
Hands-on: Enable video
- Edit the
slides.htmlfor your tutorial
video: trueto the top
That’s it! With this, videos can be automatically generated.
There are multiple voices available, see the following list:
By default a random voice is chosen every time the video is rebuilt (only whenever a change is made to that slide deck.) We do this to ensure a good diversity of genders and nationalities in the audio samples.
However, if you have a preferred voice, you can set that permanently for that video, add the following metadata to the top of your slide deck:
The above voice example is specific to Spanish language content, hence not being represented in the first list.
How it works: In Detail
- We take our markdown slides, e.g.
- In order for them to be processed, slides must have an annotation saying
video: truein the header metadata, and then ‘speaker notes’ (everything after the ??? before the —)
- This is turned into our ‘plain text slides’ which just renders the markdown a bit more nicely (example)
Then we run ari.sh which does the following:
make videois run which runs
- This builds PDFs for any slides which have changed
- And runs
./bin/ari.shwith the PDF, the original Slides, and where the mp4 should be saved.
- It extracts metadata from the tutorial (title, authors, etc.)
- It builds a ‘script’, a json document with blocks for every line of the speaker notes that were in the slides.
- Those get converted into mp3 files by AWS Polly (or MozillaTTS), one per slide.
- The PDFs get turned into a series of PNG images
- We take the timings of the mp3 files together with the json ‘script’ to write out webvtt / srt subtitles which get embedded into the video, and supplied next to it.
- editly is used to knit together the PNGs + mp3s with appropriate delay
All of this is run on cron by
.github/workflows/video.yml which handles building all of these videos and then later uploading them to s3.
Many of the scripts internally are prefixed with
ari, we named our internal version after github.com/jhudsl/ari/ which inspired it, but we wanted a version that would be more closely tied to the GTN and integrate with our infrastructure nicely, so we ended up writing our own.