Building-Thumbnails-And-GIFs-Generator-Using-Lambda-And-FFmpeg

AWS Lambda FFmpeg Python Tutorial

This AWS Lambda FFmpeg Python example shows how to create a serverless API for generating thumbnails and GIF images from video files uploaded in the S3 bucket. Let’s get started.

The heart of the video processing service is Lambda functions with Lambda Layer attached to it with statically linked FFmpeg. This Lambda function is responsible for core business logic:

  • Retrieve the uploaded video file from the POST request.
  • Generate GIF and Thumbnail from the video file.
  • Upload generated GIF and Thumbnail to S3.
  • Send a user a JSON reply back.

Now, let’s look at how all those services may be integrated.

For those of you, who’re interested in the code only, please, feel free to grab it from our GitHub

Building a prototype

To build a prototype, we’ll take an AWS CDK – a great framework I recently opened for fast prototyping and implementing solutions for the AWS cloud.

Project structure

Here’s our project structure:

tree
.
├── README.md
├── app.py
├── cdk.json
├── functions
│   └── ffmpeg_lambda
│       └── ffmpeg_lambda.py
├── helpers
│   ├── __init__.py
│   └── ffmpeg_lambda_stack.py
├── layers
│   └── ffmpeg_layer
│       ├── Makefile
│       ├── bin
│       │   └── ffmpeg
│       ├── python
│       │   └── lib
│       │       └── python3.7
│       │           └── site-packages
│       │               └── ffmpeg_mgr.py
│       └── requirements.txt
├── requirements.txt
├── small.mp4
└── tests
    └── upload.py
11 directories, 13 files

Short description of the files and folders:

  • app.py – standard AWS CDK application entry point.
  • cdk.json – standard AWS CDK application context.
  • functions – folder containing Lamda functions code for the AWS CDK application.
  • helpers – folder, which I’m using as a python module; I’ll store AWS CDK stacks here.
  • layers – folder, which will contain Lambda Layers.
  • requirements.txt – standard Python project requirements.
  • small.mp4 – a small video file we’ll be using to test our prototype.
  • tests – folder with the tests you’d like to have.

As you can see, we have one Lambda function with a Lambda environment in functions/ffmpeg_lambda folder. And a new layer, one Lambda layer for this function, which located in layers/ffmpeg_layer.

AWS Lambda FFmpeg Python function Layer

Lambda Layer location:

layers
└── ffmpeg_layer
    ├── Makefile
    ├── bin
    │   └── ffmpeg
    ├── python
    │   └── lib
    │       └── python3.7
    │           └── site-packages
    │               └── ffmpeg_mgr.py
    └── requirements.txt
6 directories, 4 files

As you know, there’s no such file as a Lambda function with the FFmpeg library. And if you need to have it, the best way to get FFmpeg binary is to build your Lambda function Layer. AWS gives us excellent documentation about configuring your own Lambda Layers.

Here, the general idea is to create a ZIP archive with a folder structure to be mounted to the Lambda function during its execution. So, we’ll need:

  • Statically build FFmpeg for amd64 architecture (ffmpeg executable placed inside the bin folder).
  • A Python FFmpeg wrapper class (python/lib/python3.7/site-packages/ffmpeg_mgr.py) – it is convenient to import this class from your Lambda function code with the given function name to execute ffmpeg commands; code upgrades are straightforward too, as you may publish new Lambda Layer separately and test your code independently.

Now we’re ready to start coding! Here is the Layer code for making GIFs and thumbnails in the .py file:

import os
import subprocess
def ffmpeg_version():
    p = subprocess.Popen(["ffmpeg", "-version"], stdout=subprocess.PIPE)
    out = p.stdout.read()
    return out
def ffmpeg_thumbnail(video_file_path, tumbnail_path):
    print("Creating thumbnail...")
    cmd = [
        "ffmpeg",
        "-i",
        video_file_path,
        "-ss",
        "00:00:01.000",
        "-vframes",
        "1",
        tumbnail_path
    ]
    print(f"Command: {cmd}")
    p = subprocess.Popen(cmd, stdout=subprocess.PIPE)
    out = p.stdout.read()
    return out
def ffmpeg_gif(video_file_path, gif_path):
    print("Creating gif...")
    cmd = [
        "ffmpeg",
        "-i",
        video_file_path,
        "-ss",
        "1.0",
        "-t",
        "2.0",
        "-f",
        "gif",
        gif_path
    ]
    print(f"Command: {cmd}")
    p = subprocess.Popen(cmd, stdout=subprocess.PIPE)
    out = p.stdout.read()
    return out

Again, the code is not ideal, as it is just a prototype. You need to consider parameterizing ffmpeg arguments for ffmpeg_thumbnail and ffmpeg_gif functions. Other code improvements may be applied, but the current example is easy to read and understand.

We provide sources and destination file paths for every function and make a ffmpeg call to do its job.

Here are a couple of great articles which I used to find the fight ffmpeg command:

Additionally, I added Makefile and requirements.txt to the layers folder if you do not want to use AWS CDK and want to build Lambda Layer manually.

Makefile content:

.PHONY: clean
PYTHON_VER=python3.7
_PKG_NAME=$(PYTHON_VER)_ffmpeg_common
DOT:= .
NOTHING:=
PKG_NAME=$(subst $(DOT),$(NOTHING),$(_PKG_NAME))
PKG_DIR=$(PKG_NAME)/python/lib/$(PYTHON_VER)/site-packages
all: package
package:
	docker run --rm -v `pwd`:/src -w /src python /bin/bash -c "mkdir -p $(PKG_NAME) && \
	mkdir -p $(PKG_DIR) && \
	apt-get update && \
	apt-get -y install zip && \
	pip install -r requirements.txt -t $(PKG_DIR) && \
	mkdir -p $(PKG_NAME)/bin && \
	wget https://johnvansickle.com/ffmpeg/releases/ffmpeg-release-amd64-static.tar.xz && \
	tar -xJf ffmpeg-release-amd64-static.tar.xz && \
	cp ffmpeg-4.3.1-amd64-static/ffmpeg $(PKG_NAME)/bin/ && \
	chmod +x $(PKG_NAME)/bin/* && \
	rm -Rf ffmpeg-* && \
	cd $(PKG_NAME) && \
	zip -9 --symlinks -r ../$(PKG_NAME).zip . && \
	cd .."
deploy:
	aws lambda publish-layer-version --layer-name $(PKG_NAME) --zip-file fileb://$(PKG_NAME).zip
clean:
	rm -Rf $(PKG_NAME)
	rm -Rf $(PKG_NAME).zip

Here I’m using a Python Docker image to build the input file in a Lambda function layer. I’ve covered the process in more detail in Creating and deploying your first Python 3 AWS Lambda Function article.

The layers/ffmpeg_layer/requirements.txt file contains additional Python dependencies you may need. Right now it contains only requests_toolbelt, which is used to process POST requests in the Lambda function.

Lambda function

Lambda function location:

functions
└── ffmpeg_lambda
    └── ffmpeg_lambda.py
1 directory, 1 file

The following code is not very difficult:

import base64
import json
import os
import re
import ffmpeg_mgr as mgr
import boto3
from requests_toolbelt.multipart import decoder
UPLOAD_BUCKET = os.environ.get('BUCKET')
s3_client = boto3.client('s3')
def post_file(event, context):
    print(f'event={event}')
    content_type = event["headers"]["Content-Type"]
    if 'multipart/form-data' in content_type:
        if isinstance(event['body'], str):
            event['body'] = base64.b64decode(bytes(event['body'], 'utf-8'))
    multipart_data = decoder.MultipartDecoder(event['body'], content_type)
    for part in multipart_data.parts:
        content_disposition = part.headers.get(b'Content-Disposition',b'').decode('utf-8')
        media_name = re.findall("filename=\"(.+)\"", content_disposition)[0]
        media_path = os.path.join('/tmp', media_name)
        with open(media_path, "wb") as v_file:
            v_file.write(part.content)
        name = media_name.split('.')[:1][0]
        # Thumbnail
        thumb_name = f'{name}.png'
        thumb_path = os.path.join('/tmp', thumb_name)
        mgr.ffmpeg_thumbnail(media_path, thumb_path)
        # Gif
        gif_name = f'{name}.gif'
        gif_path = os.path.join('/tmp', gif_name)
        mgr.ffmpeg_thumbnail(media_path, gif_path)
        # S3 Upload
        s3_client.upload_file(media_path, UPLOAD_BUCKET, media_name)
        s3_client.upload_file(thumb_path, UPLOAD_BUCKET, thumb_name)
        s3_client.upload_file(gif_path, UPLOAD_BUCKET, gif_name)
        site_name = 'https://hands-on.cloud'
        return {
            'mediaURL': f'{site_name}/{media_name}',
            'gifURL': f'{site_name}/{gif_name}',
            'thumbnURL': f'{site_name}/{thumb_name}'
        }
def handler(event, context):
    _response = {}
    if event['requestContext']['httpMethod'] == 'POST':
        _response = post_file(event, context)
    else:
        _response = {
            'err': 'Method not supported'
        }
    return {
        'statusCode': 200,
        'headers': {
            'Content-Type': 'application/json'
        },
        'body': json.dumps(_response)
    }

Code logic:

  • Process the POST multipart/form-data request only.
  • Decode received vide file from base64 string.
  • Save a video file to the Lambda function /tmp folder.
  • Launch the wrapper module from the Lambda layer several times to create GIF and thumbnail.
  • Use boto3 S3 client to upload results to some S3 bucket (obtained from ENV variable).
  • Return some JSON structure to the client.

AWS CDK part

The first thing we need to cover here is the AWS CDK application entry point source file – app.py:

from aws_cdk import (core)
from helpers.ffmpeg_lambda_stack import FfmpegLambdaStack
app = core.App()
FfmpegLambdaStack(app, "ffmpeg-lambda-stack")
app.synth()

Again, nothing complicated.

Code logic:

  • Import AWS CDK core module.
  • Import our stack declaration from the helper module.
  • Use the stack declaration as a part of the AWS CDK application.

Content of the ffmpeg_lambda_stack.py file:

from aws_cdk import (
    aws_lambda as _lambda,
    core,
    aws_iam,
    aws_apigateway as apigw,
    aws_s3 as s3
)
from aws_cdk.aws_iam import PolicyStatement
from aws_cdk.aws_lambda import LayerVersion, AssetCode

class FfmpegLambdaStack(core.Stack):
    def __init__(self, scope: core.Construct, id: str, **kwargs) -> None:
        super().__init__(scope, id, **kwargs)
        testLambda : _lambda.Function = FfmpegLambdaStack.cdkResourcesCreate(self)
        projectPolicy = FfmpegLambdaStack.createPolicy(self, testLambda)
        apigw.LambdaRestApi(
            self, 'Endpoint',
            handler=testLambda,
            binary_media_types=['multipart/form-data']
        )
    @staticmethod
    def createPolicy(this, testLambda:_lambda.Function) -> None:
        projectPolicy:PolicyStatement = PolicyStatement(
            effect=aws_iam.Effect.ALLOW,
            resources=[testLambda.function_arn],
            actions=[ "s3:*",
                      "logs:CreateLogGroup",
                      "logs:CreateLogStream",
                      "logs:PutLogEvents"
                    ]
        )
        return projectPolicy
    @staticmethod
    def cdkResourcesCreate(self) -> None:
        bucket = s3.Bucket(self, "my-bucket-with-ffmpeg-thumbnails")
        lambdaFunction:_lambda.Function = _lambda.Function(self, 'ffmpeg_lambda',
                                                           function_name='ffmpeg_lambda',
                                                           handler='ffmpeg_lambda.handler',
                                                           runtime=_lambda.Runtime.PYTHON_3_7,
                                                           code=_lambda.Code.asset('functions/ffmpeg_lambda'),
                                                           timeout=core.Duration.seconds(900),
                                                           environment=dict(BUCKET=bucket.bucket_name)
                                                           )
        bucket.grant_read_write(lambdaFunction)
        ac = AssetCode("layers/ffmpeg_layer")
        layer  = LayerVersion(self, "ffmpeg_layer", code=ac, description="ffmpeg_layer", layer_version_name='ffmpeg_4_3_1_layer')
        lambdaFunction.add_layers(layer)
        return lambdaFunction

This code is not mine. I reused and modified the already existing StackOverflow solution:

Code logic:

  • Import all necessary modules we need to use to build a complete infrastructure.
  • Declare FfmpegLambdaStack class, which will be converted to the CloudFormation stack to deploy everything.

The most important parts of this stack:

  • binary_media_types attribute for API Gateway – without this parameter created, API Gateway will pass the file object in the correct base64 format. This problem is covered in How to upload files to lambda function or API Gateway? StackOverflow discussion.
  • cdkResourcesCreate function creates an S3 source bucket, Lambda layer, and Lambda function and ties everything together.

Deployment

The deployment process is straightforward. First, we need to install a Python environment, all required modules and source files, and lastly, bootstrap the CDK:

python3 -m venv .env
source .env/bin/activate
pip install --upgrade pip
pip install -r requirements.txt

As AWS CDK does not control your Python dependencies for the Lambda Layer, so you need to do it yourself:

pip install -r layers/ffmpeg_layer/requirements.txt \
    -t layers/ffmpeg_layer/python/lib/python3.7/site-packages/

Now you can deploy everything:

cdk bootstrap
cdk deploy

Testing

Testing is very important part of any development process. I used a very simple Python app (tests/upload.py) which is the source file:

import os
import requests
import sys
import hashlib
from requests_toolbelt.multipart.encoder import MultipartEncoder
url = sys.argv[1]
os.system('curl -v -F "file=@small.mp4;type=video/mp4" "' + url + '"')
hexdigest = hashlib.md5(open("small.mp4", "rb").read()).hexdigest()
print(f"md5(small.mp4)={hexdigest}")

The FFmpeg output small.mp4 video stream with the following output format is obtained from Sample WebM, Ogg, and MP4 Video Files for HTML5.

Cleaning up

After the output files are released, we need to clean up everything. Execute the following command:

cdk destroy

Architecture improvements

As soon as I heard about this service architecture, I immediately proposed several improvements. So today, I’ll show you how to use FFmpeg in your Lambdas and provide a couple of improvements for the above architecture.

While our prototype shows necessary service integrations, it has several significant constraints, which I recommend you to fix in your solutions:

  • Synchronous request processing – the user must wait until the processing operation finishes to get a response back; I strongly recommend considering asynchronous architecture (I’ll show an example below).
  • Monolithic architecture pattern – the service is based on a single Lambda function, which does all the operations sequentially – by the ask, it has to be only one Lambda function with no asynchronous workflow using the Step Function state machine.
  • Processing file uploads through API Gateway – even if we have Binary Support for API Integrations for API Gateway, this method has some significant constraints. Again, I suggest another architectural pattern for processing uploaded user files.

So, if we try to implement some of my advice, we should come to something like that:

AWS Lambda FFmpeg Python Architecture

The ideas are simple:

  • Offload users uploads to S3 – use pre-signed URLs to upload any content directly to S3 and use a standard pattern to trigger any process based on this event. Please, review the S3 Uploads — Proxies vs. Presigned URLs vs. Presigned POSTs article for more information.
  • Use State Functions to control your business logic execution flow – this gives you many additional features like enhanced ways to handle errors, retry logic, failbacks, etc.
  • Use asynchronous processes wherever possible – it leads to a way better customer experience when launching a long-running process in the background and showing your customer a nice “processing” animation. You may update the web page as soon as the status of the process changes or notify your customer by email.
  • Decouple everything – In the Step Function state machine, we have three different Lambda functions that do the job; each function does its small piece of the whole logic; it’s much easier to avoid errors during updates.

Summary

In this article, we talked about AWS Lambda, FFmpeg & Python. We also integrated AWS API Gateway with AWS Lambda to process POST file uploads. We also built a Lambda function, which uses FFMpeg to create GIFs and thumbnails from uploaded videos. And finally, we improved the initial architecture.

I hope this article will help you to save some time. If you found it useful, please, help us spread it to the world!

Similar Posts