From 244144029189398862cb02f14162dbca95b27c8e Mon Sep 17 00:00:00 2001 From: Yulong Li Date: Wed, 28 Jun 2023 10:59:00 +0800 Subject: [PATCH] update docs commented by Gordon (#53) * update docs commented by Gordon * Add platform info and upper 'SVT_VP' --- Flex/ubuntu-20.04/media/ffmpeg/README.md | 2 +- Flex/ubuntu-22.04/media/ffmpeg/README.md | 2 +- README.md | 18 +++++++++--------- SG1/centos-7/media/ffmpeg/README.md | 2 +- SG1/ubuntu-20.04/media/ffmpeg/README.md | 2 +- SG1/ubuntu-22.04/media/ffmpeg/README.md | 2 +- Xeon/ubuntu-20.04/media/ffmpeg/README.md | 2 +- Xeon/ubuntu-22.04/media/ffmpeg/README.md | 2 +- doc/ffmpeg.md | 2 +- script/generate_readme.py | 4 ++-- 10 files changed, 19 insertions(+), 19 deletions(-) diff --git a/Flex/ubuntu-20.04/media/ffmpeg/README.md b/Flex/ubuntu-20.04/media/ffmpeg/README.md index f4a68c7e0..4a3db9ce0 100644 --- a/Flex/ubuntu-20.04/media/ffmpeg/README.md +++ b/Flex/ubuntu-20.04/media/ffmpeg/README.md @@ -1,4 +1,4 @@ -This docker image is part of Open Visual Cloud software stacks. Optimized for the media creation and delivery use case. Included FFmpeg and codecs such as opus, ogg, vorbis, x264, x265, vp8/9, av1 and SVT-HEVC. Also included Intel hardware accelaration software stack such as media SDK, media driver, gmmlib and libva. The docker image can be used in the FROM field of a downstream Dockerfile. +This docker image is part of Open Visual Cloud software stacks. Optimized for the media creation and delivery use case. Included FFmpeg and codecs such as opus, ogg, vorbis, x264, x265, VP8/9, SVT-AV1 and SVT-HEVC. Also included Intel hardware accelaration software stack such as media SDK, media driver, gmmlib and libva. The docker image can be used in the FROM field of a downstream Dockerfile. ## Supported tags and respective Dockerfile links - [flex-ubuntu-2004-media-ffmpeg](https://github.com/OpenVisualCloud/Dockerfiles/blob/v23.06/Flex/ubuntu-20.04/media/ffmpeg/Dockerfile) diff --git a/Flex/ubuntu-22.04/media/ffmpeg/README.md b/Flex/ubuntu-22.04/media/ffmpeg/README.md index 6ce6f8e72..c0d3397eb 100644 --- a/Flex/ubuntu-22.04/media/ffmpeg/README.md +++ b/Flex/ubuntu-22.04/media/ffmpeg/README.md @@ -1,4 +1,4 @@ -This docker image is part of Open Visual Cloud software stacks. Optimized for the media creation and delivery use case. Included FFmpeg and codecs such as opus, ogg, vorbis, x264, x265, vp8/9, av1 and SVT-HEVC. Also included Intel hardware accelaration software stack such as media SDK, media driver, gmmlib and libva. The docker image can be used in the FROM field of a downstream Dockerfile. +This docker image is part of Open Visual Cloud software stacks. Optimized for the media creation and delivery use case. Included FFmpeg and codecs such as opus, ogg, vorbis, x264, x265, VP8/9, SVT-AV1 and SVT-HEVC. Also included Intel hardware accelaration software stack such as media SDK, media driver, gmmlib and libva. The docker image can be used in the FROM field of a downstream Dockerfile. ## Supported tags and respective Dockerfile links - [flex-ubuntu-2204-media-ffmpeg](https://github.com/OpenVisualCloud/Dockerfiles/blob/v23.06/Flex/ubuntu-22.04/media/ffmpeg/Dockerfile) diff --git a/README.md b/README.md index fed468ce0..634838bfc 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,10 @@ [logo]: https://avatars3.githubusercontent.com/u/46843401?s=90&v=4 -This repository hosts docker build files of software stacks and services, designed to enable Open Visual Cloud prioritized use cases such as media delivery, media analytics, cloud gaming and cloud graphics, and immersive media. +This repository hosts Docker build files of software stacks and services, designed to enable Open Visual Cloud prioritized use cases such as media delivery, media analytics, cloud gaming and cloud graphics, and immersive media. -Validated docker images are available on [**Docker Hub**](https://hub.docker.com/u/openvisualcloud). +Validated Docker images are available on [**Docker Hub**](https://hub.docker.com/u/openvisualcloud). Explore more container solutions on the [Intel® oneContainer Portal](https://software.intel.com/content/www/us/en/develop/tools/containers.html). @@ -22,11 +22,11 @@ The software stack images provide ready to use software stacks for application d | Image | Description | | :-----: | ----- | -| [ffmpeg](doc/ffmpeg.md) |

Docker images optimized for media creation and delivery based on the FFmpeg framework. Included the AAC, MP3, OPUS, OGG, Vorbis, X264, X265, VP8/9, AV1 and SVT-HEVC codecs. The GPU images are accelerated with VAAPI and QSV. See [`doc/ffmpeg.md`](doc/ffmpeg.md) for additional details.

docker pull [openvisualcloud/xeon-ubuntu2204-media-ffmpeg](https://hub.docker.com/r/openvisualcloud/xeon-ubuntu2204-media-ffmpeg)
docker pull [openvisualcloud/xeon-ubuntu2004-media-ffmpeg](https://hub.docker.com/r/openvisualcloud/xeon-ubuntu2004-media-ffmpeg)| +| [ffmpeg](doc/ffmpeg.md) |

Docker images optimized for media creation and delivery based on the FFmpeg framework. Included the AAC, MP3, OPUS, OGG, Vorbis, X264, X265, VP8/9, SVT-AV1 and SVT-HEVC codecs. The GPU images are accelerated with FFmpeg VAAPI and QSV plugins. See [`doc/ffmpeg.md`](doc/ffmpeg.md) for additional details.

docker pull [openvisualcloud/xeon-ubuntu2204-media-ffmpeg](https://hub.docker.com/r/openvisualcloud/xeon-ubuntu2204-media-ffmpeg)
docker pull [openvisualcloud/xeon-ubuntu2004-media-ffmpeg](https://hub.docker.com/r/openvisualcloud/xeon-ubuntu2004-media-ffmpeg)| | [gst](doc/gst.md) |

Docker images optimized for media creation and delivery based on the GStreamer framework. Included the base, good, bad, ugly and libav set of plugins. The GPU images are accelerated with VAAPI. See [`doc/gst.md`](doc/gst.md) for additional details.

docker pull [openvisualcloud/xeon-ubuntu2204-media-gst](https://hub.docker.com/r/openvisualcloud/xeon-ubuntu2204-media-gst)
docker pull [openvisualcloud/xeon-ubuntu2004-media-gst](https://hub.docker.com/r/openvisualcloud/xeon-ubuntu2004-media-gst)| | [nginx](doc/nginx.md) |

Docker images optimized for web hosting and caching. Included FFmpeg, NGINX the web server, and FLV the RTMP and DASH/HLS streaming module. See [`doc/nginx.md`](doc/nginx.md) for additional details.

docker pull [openvisualcloud/xeon-ubuntu2204-media-nginx](https://hub.docker.com/r/openvisualcloud/xeon-ubuntu2204-media-nginx)
docker pull [openvisualcloud/xeon-ubuntu2004-media-nginx](https://hub.docker.com/r/openvisualcloud/xeon-ubuntu2004-media-nginx)| -| [svt](doc/svt.md) |

Docker images for the SVT (Scalable Video Technology) encoders and decoders. Easiest way to try SVT AV1, HEVC, and VP9 apps. See [`doc/svt.md`](doc/svt.md) for additional details.

docker pull [openvisualcloud/xeon-ubuntu2204-media-svt](https://hub.docker.com/r/openvisualcloud/xeon-ubuntu2204-media-svt)
docker pull [openvisualcloud/xeon-ubuntu2004-media-svt](https://hub.docker.com/r/openvisualcloud/xeon-ubuntu2004-media-svt)| -| [imtl](https://github.com/OpenVisualCloud/Media-Transport-Library/blob/main/README.md) |

Docker images for the IMTL (Intel Media Transport Library), based on DPDK prepared for transmitting and receiving media data with high throughput and low latency. See [`imtl.md`](https://github.com/OpenVisualCloud/Media-Transport-Library/blob/main/README.md) for additional details.

docker pull [openvisualcloud/xeon-ubuntu2204-media-imtl](https://hub.docker.com/r/openvisualcloud/xeon-ubuntu2204-media-imtl)
docker pull [openvisualcloud/xeon-ubuntu2004-media-imtl](https://hub.docker.com/r/openvisualcloud/xeon-ubuntu2004-media-imtl)| +| [SVT](doc/svt.md) |

Docker images for the SVT (Scalable Video Technology) encoders and decoders. Easiest way to try SVT-AV1, HEVC, and VP9 apps. See [`doc/svt.md`](doc/svt.md) for additional details.

docker pull [openvisualcloud/xeon-ubuntu2204-media-svt](https://hub.docker.com/r/openvisualcloud/xeon-ubuntu2204-media-svt)
docker pull [openvisualcloud/xeon-ubuntu2004-media-svt](https://hub.docker.com/r/openvisualcloud/xeon-ubuntu2004-media-svt)| +| [IMTL](https://github.com/OpenVisualCloud/Media-Transport-Library/blob/main/README.md) |

Docker images for the IMTL (Intel Media Transport Library), based on DPDK prepared for transmitting and receiving media data with high throughput and low latency. See [`imtl.md`](https://github.com/OpenVisualCloud/Media-Transport-Library/blob/main/README.md) for additional details.

docker pull [openvisualcloud/xeon-ubuntu2204-media-imtl](https://hub.docker.com/r/openvisualcloud/xeon-ubuntu2204-media-imtl)
docker pull [openvisualcloud/xeon-ubuntu2004-media-imtl](https://hub.docker.com/r/openvisualcloud/xeon-ubuntu2004-media-imtl)| - **Media Analytics** | Image | Description | @@ -63,10 +63,10 @@ The project supports the following platforms and OS'es: | Supported Platforms | Supported OS'es | | :---: | :--- | -| [Xeon](Xeon) | Ubuntu 20.04 LTS, Ubuntu 22.04 LTS | -| [QAT](QAT) | Ubuntu 20.04 LTS, Ubuntu 22.04 LTS | +| [Xeon](https://www.intel.com/content/www/us/en/products/details/processors/xeon.html) | Ubuntu 20.04 LTS, Ubuntu 22.04 LTS | +| [QAT](https://www.intel.com/content/www/us/en/architecture-and-technology/intel-quick-assist-technology-overview.html) | Ubuntu 20.04 LTS, Ubuntu 22.04 LTS | | [SG1](SG1) | Ubuntu 20.04 LTS, Ubuntu 22.04 LTS, CentOS 7 | -| [Flex](Flex) | Ubuntu 20.04 LTS, Ubuntu 22.04 LTS | +| [Flex](https://www.intel.com/content/www/us/en/products/docs/discrete-gpus/data-center-gpu/flex-series/overview.html) | Ubuntu 20.04 LTS, Ubuntu 22.04 LTS | Please see [Development and Test Report](doc/test.md) for the latest development statuses. @@ -88,7 +88,7 @@ sudo systemctl restart docker ### Evaluate Image: -The docker images are published on [Docker Hub](https://hub.docker.com/u/openvisualcloud) with name pattern ```openvisualcloud/<_platform_>-<_OS_>-<_usage_>-<_image_>```. Find and use the images as follows: +The Docker images are published on [Docker Hub](https://hub.docker.com/u/openvisualcloud) with name pattern ```openvisualcloud/<_platform_>-<_OS_>-<_usage_>-<_image_>```. Find and use the images as follows: ```bash docker search openvisualcloud --limit=100 | grep analytics-ffmpeg #list media analytics ffmpeg images diff --git a/SG1/centos-7/media/ffmpeg/README.md b/SG1/centos-7/media/ffmpeg/README.md index 3faae04b0..e8c6b8b1f 100644 --- a/SG1/centos-7/media/ffmpeg/README.md +++ b/SG1/centos-7/media/ffmpeg/README.md @@ -1,4 +1,4 @@ -This docker image is part of Open Visual Cloud software stacks. Optimized for the media creation and delivery use case. Included FFmpeg and codecs such as opus, ogg, vorbis, x264, x265, vp8/9, av1 and SVT-HEVC. Also included Intel hardware accelaration software stack such as media SDK, media driver, gmmlib and libva. The docker image can be used in the FROM field of a downstream Dockerfile. +This docker image is part of Open Visual Cloud software stacks. Optimized for the media creation and delivery use case. Included FFmpeg and codecs such as opus, ogg, vorbis, x264, x265, VP8/9, SVT-AV1 and SVT-HEVC. Also included Intel hardware accelaration software stack such as media SDK, media driver, gmmlib and libva. The docker image can be used in the FROM field of a downstream Dockerfile. ## Supported tags and respective Dockerfile links - [sg1-centos-7-media-ffmpeg](https://github.com/OpenVisualCloud/Dockerfiles/blob/v23.06/SG1/centos-7/media/ffmpeg/Dockerfile) diff --git a/SG1/ubuntu-20.04/media/ffmpeg/README.md b/SG1/ubuntu-20.04/media/ffmpeg/README.md index 7dc0816e8..4a9d2ccda 100644 --- a/SG1/ubuntu-20.04/media/ffmpeg/README.md +++ b/SG1/ubuntu-20.04/media/ffmpeg/README.md @@ -1,4 +1,4 @@ -This docker image is part of Open Visual Cloud software stacks. Optimized for the media creation and delivery use case. Included FFmpeg and codecs such as opus, ogg, vorbis, x264, x265, vp8/9, av1 and SVT-HEVC. Also included Intel hardware accelaration software stack such as media SDK, media driver, gmmlib and libva. The docker image can be used in the FROM field of a downstream Dockerfile. +This docker image is part of Open Visual Cloud software stacks. Optimized for the media creation and delivery use case. Included FFmpeg and codecs such as opus, ogg, vorbis, x264, x265, VP8/9, SVT-AV1 and SVT-HEVC. Also included Intel hardware accelaration software stack such as media SDK, media driver, gmmlib and libva. The docker image can be used in the FROM field of a downstream Dockerfile. ## Supported tags and respective Dockerfile links - [sg1-ubuntu-2004-media-ffmpeg](https://github.com/OpenVisualCloud/Dockerfiles/blob/v23.06/SG1/ubuntu-20.04/media/ffmpeg/Dockerfile) diff --git a/SG1/ubuntu-22.04/media/ffmpeg/README.md b/SG1/ubuntu-22.04/media/ffmpeg/README.md index 2914500f8..573b43f00 100644 --- a/SG1/ubuntu-22.04/media/ffmpeg/README.md +++ b/SG1/ubuntu-22.04/media/ffmpeg/README.md @@ -1,4 +1,4 @@ -This docker image is part of Open Visual Cloud software stacks. Optimized for the media creation and delivery use case. Included FFmpeg and codecs such as opus, ogg, vorbis, x264, x265, vp8/9, av1 and SVT-HEVC. Also included Intel hardware accelaration software stack such as media SDK, media driver, gmmlib and libva. The docker image can be used in the FROM field of a downstream Dockerfile. +This docker image is part of Open Visual Cloud software stacks. Optimized for the media creation and delivery use case. Included FFmpeg and codecs such as opus, ogg, vorbis, x264, x265, VP8/9, SVT-AV1 and SVT-HEVC. Also included Intel hardware accelaration software stack such as media SDK, media driver, gmmlib and libva. The docker image can be used in the FROM field of a downstream Dockerfile. ## Supported tags and respective Dockerfile links - [sg1-ubuntu-2204-media-ffmpeg](https://github.com/OpenVisualCloud/Dockerfiles/blob/v23.06/SG1/ubuntu-22.04/media/ffmpeg/Dockerfile) diff --git a/Xeon/ubuntu-20.04/media/ffmpeg/README.md b/Xeon/ubuntu-20.04/media/ffmpeg/README.md index e57f55957..929c8a87c 100644 --- a/Xeon/ubuntu-20.04/media/ffmpeg/README.md +++ b/Xeon/ubuntu-20.04/media/ffmpeg/README.md @@ -1,4 +1,4 @@ -This docker image is part of Open Visual Cloud software stacks. Optimized for the media creation and delivery use case. Included FFmpeg and codecs such as opus, ogg, vorbis, x264, x265, vp8/9, av1 and SVT-HEVC. The docker image can be used in the FROM field of a downstream Dockerfile. +This docker image is part of Open Visual Cloud software stacks. Optimized for the media creation and delivery use case. Included FFmpeg and codecs such as opus, ogg, vorbis, x264, x265, VP8/9, SVT-AV1 and SVT-HEVC. The docker image can be used in the FROM field of a downstream Dockerfile. ## Supported tags and respective Dockerfile links - [xeon-ubuntu-2004-media-ffmpeg](https://github.com/OpenVisualCloud/Dockerfiles/blob/v23.06/Xeon/ubuntu-20.04/media/ffmpeg/Dockerfile) diff --git a/Xeon/ubuntu-22.04/media/ffmpeg/README.md b/Xeon/ubuntu-22.04/media/ffmpeg/README.md index 393812a80..353d04f4e 100644 --- a/Xeon/ubuntu-22.04/media/ffmpeg/README.md +++ b/Xeon/ubuntu-22.04/media/ffmpeg/README.md @@ -1,4 +1,4 @@ -This docker image is part of Open Visual Cloud software stacks. Optimized for the media creation and delivery use case. Included FFmpeg and codecs such as opus, ogg, vorbis, x264, x265, vp8/9, av1 and SVT-HEVC. The docker image can be used in the FROM field of a downstream Dockerfile. +This docker image is part of Open Visual Cloud software stacks. Optimized for the media creation and delivery use case. Included FFmpeg and codecs such as opus, ogg, vorbis, x264, x265, VP8/9, SVT-AV1 and SVT-HEVC. The docker image can be used in the FROM field of a downstream Dockerfile. ## Supported tags and respective Dockerfile links - [xeon-ubuntu-2204-media-ffmpeg](https://github.com/OpenVisualCloud/Dockerfiles/blob/v23.06/Xeon/ubuntu-22.04/media/ffmpeg/Dockerfile) diff --git a/doc/ffmpeg.md b/doc/ffmpeg.md index 245ad1aff..ce5fbb151 100755 --- a/doc/ffmpeg.md +++ b/doc/ffmpeg.md @@ -27,7 +27,7 @@ The FFmpeg builds included the following patches for feature enhancement, better ### GPU Acceleration: -In GPU images, the FFmpeg docker images are accelerated through `VAAPI` and/or `qsv` (Intel® Media SDK). Note that `VAAPI` or `qsv` requires special setup for X11 authentication. Please see each platform README for setup details. +In GPU images, the FFmpeg docker images are accelerated through `VAAPI` and/or `qsv` (Intel® Media SDK). For Flex Series GPUs, [oneVPL](https://github.com/oneapi-src/oneVPL-intel-gpu) is used for acceleration. Note that `VAAPI` or `qsv` requires special setup for X11 authentication. Please see each platform README for setup details. ### Examples: diff --git a/script/generate_readme.py b/script/generate_readme.py index f2a6bcbcf..2f79561ab 100755 --- a/script/generate_readme.py +++ b/script/generate_readme.py @@ -280,9 +280,9 @@ def create_readme(path, path_components): if image_name=="gst": my_file.write("Included gstreamer and audio and video plugins that can be connected to process audio and video content, such as creating, converting, transcoding. ") if image_name=="ffmpeg": - my_file.write("Included FFmpeg and codecs such as opus, ogg, vorbis, x264, x265, vp8/9, av1 and SVT-HEVC. ") + my_file.write("Included FFmpeg and codecs such as opus, ogg, vorbis, x264, x265, VP8/9, SVT-AV1 and SVT-HEVC. ") if image_name=="ffmpeg-vmaf": - my_file.write("Included FFmpeg and codecs such as opus, ogg, vorbis, x264, x265, vp8/9, av1 and SVT-HEVC. It also includes libvmaf for video quality assessment.") + my_file.write("Included FFmpeg and codecs such as opus, ogg, vorbis, x264, x265, VP8/9, SVT-AV1 and SVT-HEVC. It also includes libvmaf for video quality assessment.") if image_name=="nginx": my_file.write("Optimized for NGINX web server that can be used for serving web content, load balancing, HTTP caching, or a reverse proxy. ") if image_name=="svt":