Skip to content

Latest commit

 

History

History
131 lines (82 loc) · 6.27 KB

README.md

File metadata and controls

131 lines (82 loc) · 6.27 KB
Raw



Scalable Video Technology for AV1 Encoder (SVT-AV1 Encoder)

The Scalable Video Technology for AV1 Encoder (SVT-AV1 Encoder) is an AV1-compliant encoder library core. The SVT-AV1 development is a work-in-progress targeting performance levels applicable to both VOD and Live encoding / transcoding video applications.

License

SVT-AV1 Encoder is licensed under the OSI-approved BSD+Patent license. See LICENSE for details.

Documentation

More details about the SVT-AV1 Encoder usage can be found under:

System Requirements

Operating System

SVT-AV1 Encoder may run on any Windows* or Linux* 64 bit operating systems. The list below represents the operating systems that the encoder application and library were tested and validated on:

  • Windows* Operating Systems (64-bit):

    • Windows* Server 2016

  • Linux* Operating Systems (64-bit):

    • Ubuntu* 16.04 Server LTS

    • Ubuntu* 18.04 Server LTS

  • Unix* Operating Systems (64-bit):

    • Mac OS*X

Hardware

The SVT-AV1 Encoder library supports the x86 architecture

  • CPU Requirements

In order to achieve the performance targeted by the SVT-AV1 Encoder, the specific CPU model listed above would need to be used when running the encoder. Otherwise, the encoder runs on any 5th Generation Intel® Core™ processor, (Intel® Xeon® CPUs, E5-v4 or newer).

  • RAM Requirements

In order to run the highest resolution supported by the SVT-AV1 Encoder, at least 48GB of RAM is required to run a 4k 10bit stream multi-threading on a 112 logical core system. The SVT-AV1 Encoder application will display an error if the system does not have enough RAM to support this. The following table shows the minimum amount of RAM required for some standard resolutions of 10bit video per stream:

Resolution Minimum Footprint (GB)
4k 48
1080p 16
720p 8
480p 4

Build and Install

Windows* Operating Systems (64-bit):

  • Build Requirements

    • Visual Studio* 2017 (can be downloaded here)
    • CMake 3.5 or later (can be downloaded here)
    • YASM Assembler version 1.2.0 or later
    • Download the yasm exe from the following link
    • Rename yasm-1.3.0-win64.exe to yasm.exe
    • Copy yasm.exe into a location that is in the PATH environment variable

  • Build Instructions

    • Generate the Visual Studio* 2017 project files by following the steps below cd Build\windows
      • run generate_vs17.bat [such would generate the visual studio project files]
    • Open the "svt-av1.sln" using Visual Studio* 2017 and click on Build -- > Build Solution

  • Binaries Location

    • Binaries can be found under \Bin/Release or \Bin/Debug, depending on whether Debug or Release were selected in the build mode

  • Installation

  • For the binaries to operate properly on your system, the following conditions have to be met:
    • On any of the Windows* Operating Systems listed in the OS requirements section, install Visual Studio* 2017
    • Once the installation is complete, copy the binaries to a location making sure that both the sample application "SvtAv1EncApp.exe” and library "SvtAv1Enc.dll” are in the same folder.
    • Open the command prompt window at the chosen location and run the sample application to encode. SvtAV1EncApp.exe -i [in.yuv] -w [width] -h [height] -b [out.265].
    • Sample application supports reading from pipe. E.g. ffmpeg -i [input.mp4] -nostdin -f rawvideo -pix_fmt yuv420p - | SvtAv1EncApp.exe -i stdin -n [number_of_frames_to_encode] -w [width] -h [height].

Linux* Operating Systems (64-bit):

  • Build Requirements

    • GCC 5.4.0 or later
    • CMake 3.5.1 or later
    • YASM Assembler version 1.2.0 or later

  • Build Instructions

    • cd Build/linux
    • ./build.sh <release | debug> (if none specified, both release and debug will be built)

  • Sample Binaries location

    • Binaries can be found under Bin/Release and / or Bin/Debug

  • Installation For the binaries to operate properly on your system, the following conditions have to be met:

    • On any of the Linux* Operating Systems listed above, copy the binaries under a location of your choice.
    • Change the permissions on the sample application “SvtAV1EncApp” executable by running the command: chmod +x SvtAv1EncApp
    • cd into your chosen location
    • Run the sample application to encode. ./SvtAv1EncApp -i [in.yuv] -w [width] -h [height] -b [out.265].
    • Sample application supports reading from pipe. E.g. ffmpeg -i [input.mp4] -nostdin -f rawvideo -pix_fmt yuv420p - | ./SvtAv1EncApp -i stdin -n [number_of_frames_to_encode] -w [width] -h [height].

Demo features and limitations

  • Multi-instance support: The multi-instance functionality is a demo feature implemented in the SVT-AV1 Encoder sample application as an example of one sample application using multiple encoding libraries. Encoding using the multi-instance support is limited to only 6 simultaneous streams. For example two channels encoding on Windows: SvtAV1EncApp.exe -nch 2 -c firstchannel.cfg secondchannel.cfg
  • Features enabled: The library will display an error message any feature combination that is not currently supported.

How to Contribute

We welcome community contributions to the SVT-AV1 Encoder. Thank you for your time! By contributing to the project, you agree to the license and copyright terms in the OSI-approved BSD+Patent license and to the release of your contribution under these terms. See LICENSE for details.

Contribution process

  • Follow the coding guidelines

  • Validate that your changes do not break a build

  • Perform smoke tests and ensure they pass

  • Submit a pull request for review to the maintainer

How to Report Bugs and Provide Feedback

Use the "Issues" tab on Github. To avoid duplicate issues, please make sure you go through the existing issues before logging a new one.

Notices and Disclaimers

The notices and disclaimers can be found here