MediaMigrate 1.2.2

There is a newer version of this package available.
See the version list below for details.
dotnet tool install --global MediaMigrate --version 1.2.2                
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest # if you are setting up this repo
dotnet tool install --local MediaMigrate --version 1.2.2                
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=MediaMigrate&version=1.2.2                
nuke :add-package MediaMigrate --version 1.2.2                

Azure Media Services Migration Tool

.net License: MIT NuGet version (MediaMigrate)

Overview

A command line tool to migrate your media data. Primarily deisgned to migrate from Azure Media Services.

Azure Media Services is being retired.

If you have been using the service for your streaming needs and want to move on you have reached the right place.

Presenting a rich and flexible command line tool to migrate your data from Azure Media Services. This tool helps you to migrate your media data from Azure Media Services (AMS). It can be used to just copy the data to other cloud storage like AWS S3 or GCS. Or can be packaged to be streamed directly from Azure storage or any web server.

It has extensible support to migrate AMS assets to Azure storage or AWS S3 or GCS. Fairly easy to plugin another service (e.g mux.com or encoding.com) or another cloud storage if needed.

The tool supports both shaka-packager and ffmpeg to conver the videos to directly streamable format. The content is converted to CMAF format with both a DASH and HLS manifest to support a wide range of devices. The default is shaka packager because it can use pipes to reduce the temporary storage required but can changed via the command line.

Features

  • Cross-Platform. Works on all platforms where .NET core is available.
  • Simple command line interface. Intuitive and easy to use.
  • Docker container to run anywhere or can be installed as a .NET tool.
  • Support for packaging both VOD and live archive assets.
  • Marks migrated assets and provides summary.

Content Migration

The tool supports various forms of content migration depending on the asset format and the command line options.

  • It can simply copy and upload the files to the new storage account.
  • For direct streaming, it can convert the assets to CMAF files with a DASH and HLS manifest.
  • It can convert files to MP4 format and then upload for progressive download.

Supported Asset Formats.

The below table summarizes the supported asset formats.

Format Copy Packaging (DASH/HLS)
Single MP4 Yes No
Multiple MP4 without .ism Yes No
Multiple MP4 with .ism Yes Yes
Smooth streaming asset No Yes
Statically packaged HLS No Yes
Asset with text tracks Yes Yes
Storage encrypted assets Yes No
Live archive No Yes
Low-latency Live archive No Yes
Encrypted Live archive No No
Live archive with captions No Yes
Live archive with discontinuities No No (discontinuities not handled)

Open Issues

  • Support to migrate AMS transforms to AWS Elemental Media Convert Job Specification.
  • Support to convert AMS transforms to GCS Transcode API Job templates.
  • Support to migrate AMS Keys to AWS KMS or GCP Secret Manager.

How to Run

Local

  • Install .NET SDK for the platform you are running. Click here on how to download.
  • Run the following command to install the tool
dotnet tool install -g mediamigrate
  • Run the tool with -? to get more help. You may have to add the install location to PATH in some instances
mediamigrate -?

Typical command is of the form

mediamigrate command -s subscriptionid -g resourcegroup -n amsaccount [options...]

Running the tool in the Cloud.

The tool is packaged as a docker container and is available to run in the cloud.

docker pull ghcr.io/duggaraju/mediamigrate:main

Azure

See the deployment file for more details.

Credentials and Privileges

The tools uses Azure Identity library for authentication. See here for various ways to authenticate and the settings needed. The identity used to migrate must have the following permissions:

  • 'Media Services Media Operator' role on the Azure Media Services account being migrated.
  • 'Contributor' role on the Azure Media Services account if you have storage encrypted assets and need acces to key to decrypt them.
  • 'Storage Blob Data Contributor' role on the Storage accounts used (source/destination)
  • 'Key Vault Secrets Officer' role on the key vault used to store the keys. If the key vault is not using Azure RBAC then you will have to create an Access policy giving secrets management permission to the identity used.

You can run the following az command line to give the privileges. Update the subscription id, resource group and account names as necessary.

az role assignment create --assignee sp_name_or_managed_identity --role "Reader" --scope /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup
az role assignment create --assignee sp_name_or_managed_identity --role "Media Services Media Operator" --scope /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Media/mediaServices/mediaAccount
az role assignment create --assignee sp_name_or_managed_identity --role "Storage Blob Data Contributor" --scope /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Storage/storageAccounts/storageAccount
az role assignment create --assignee sp_name_or_managed_identity --role "Key Vault Secrets Officer" --scope /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/Microsoft.KeyVault/vaults/keyVaultAccount

Temporary storage needed.

The tool uses temporary storage space for format conversion and uses pipes where possible to minimize storage usage. Smooth Streaming assets or assets from live events don't need to be downloaded locally.

Linux

  • The only storage needed is for manifests when using shaka packager.
  • When using ffmpeg, if the asset files are MP4, it downloads the files locally before converting so storage is proportional to asset size.

Windows

  • Shaka packager writes the packaged files to local disk first before uploading due to a windows specific bug.
  • Using ffmpeg needs double the local disk space when packaging MP4 files.
  • Smooth Streaming assets or assets from live events don't need to be downloaded locally.

Destination Cloud for migration.

You can migrate your data to various cloud services like AWS or GCP or keep within Azure by moving to a storage account.

Migrate to an Azure Storage Account.

Ensure that the Identity you are using to migrate has the following permissions

  • 'Storage Blob Data Contributor' role on the storage account to which you are migrating.

Migrate to an AWS S3 account.

  • If Running locally
    • Create a bucket (or use an existing bucket) in your S3 account.
    • Create an API access key and secret.
    • Create a profile with those settings.
    • Set the environment variable AWS_PROFILE to the profile name used in step above.
    • Run the tool.
  • Running in the cloud.
    • TBD

Migrate to a GCS account.

To migrate to a Google cloud storage bucket

  • If running locally
      gcloud auth application-default login
    
    • Run the command by specifying the bucket name as part of the path template. e.g -t bucket_name/{AssetId}
  • If running a container in the cloud
    • Ensure the bucket to use is already created.
    • Create API keys and pass them as environment variables to the container

Migrate to a custom cloud/service.

If your want to migrate to a service or cloud other than the ones supported out of box, you can write your own custom migrator if needed

  • Clone the source code locally.
  • Implement your custom migration. Look in to aws/gcp folder for examples.
  • Build and Run the code locally.

FFmpeg dependency

The tool optionally uses ffmpeg for media format conversion. It primarily uses shaka-packager but can be changed to use ffmpeg. It doesn't ship a copy of FFmpeg itself but uses the one in the PATH.

  • On Windows you can use winget or chocolatey to install ffmpeg.
winget install ffmpeg
  • On Ubuntu/Debian Linux use apt to install ffmpeg
sudo apt install -y ffmpeg
  • On RedHat Linux use dnf to install ffmpeg.
sudo dnf install ffmpeg
  • On MacOs use brew to install ffmpeg
brew install ffmpeg
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
1.2.4 303 9/26/2023
1.2.3 297 8/29/2023
1.2.2 293 8/10/2023
1.2.1 362 8/10/2023
1.2.0 300 8/9/2023
1.1.2 269 8/7/2023
1.1.1 344 8/3/2023
1.0.8 174 7/29/2023
1.0.7 202 7/28/2023
1.0.6 187 7/27/2023
1.0.5 200 7/26/2023
1.0.4 214 7/25/2023
1.0.3 254 7/25/2023
1.0.2 196 7/25/2023
1.0.0 173 7/18/2023