Google Git
Sign in
aomedia / libavif / f8d9b83c520e044a7ae768532277bb3330afdc89
commitf8d9b83c520e044a7ae768532277bb3330afdc89[log] [tgz]
authorWan-Teh Chang <wtc@google.com>Thu Nov 19 17:33:50 2020 -0800
committerJoe Drago <joedrago@gmail.com>Mon Nov 30 15:45:06 2020 -0800
tree5750f6f03ddcf97f978e4a2f63f45a495fef7d74
parent1db0703895f285a9edc20599188104bac3c82a5c [diff]
Add the avifContainerDump() function

Use the avifContainerDump() function in the info() function in avifdec.c
to dump the container info instead of the first frame's info.

I noticed this issue while trying to debug monochrome images encoded
with libaom before commit 2172ed05169f08b20245221a7e95619a65884fd7.
The container yuvFormat was YUV400 but the first frame's yuvFormat was
YUV420. avifdec -i printed YUV420, so I could not see the container
yuvFormat was wrong. Obviously it would be best to dump both the
container info and every frame's info, but that could be confusing to
average users, or at least too verbose.
3 files changed
tree: 5750f6f03ddcf97f978e4a2f63f45a495fef7d74
  1. .github/
  2. apps/
  3. cmake/
  4. contrib/
  5. examples/
  6. ext/
  7. include/
  8. src/
  9. tests/
  10. .clang-format
  11. .gitattributes
  12. .gitignore
  13. .gitmodules
  14. .travis.yml
  15. appveyor.yml
  16. CHANGELOG.md
  17. CMakeLists.txt
  18. fuzz.sh
  19. libavif.pc.cmake
  20. LICENSE
  21. README.md
README.md

libavif AppVeyor Build Status Travis Build Status

This library aims to be a friendly, portable C implementation of the AV1 Image File Format, as described here:

https://aomediacodec.github.io/av1-avif/

It is a work-in-progress, but can already encode and decode all AOM supported YUV formats and bit depths (with alpha).

For now, it is recommended that you checkout/use tagged releases instead of just using the master branch. I will regularly create new versions as bugfixes and features are added.

Usage

Please see the examples in the examples directory. If you're already building libavif, enable the CMake option AVIF_BUILD_EXAMPLES in order to build and run the examples too.

Build Notes

Building libavif requires CMake.

No AV1 codecs are enabled by default. Enable them by enabling any of the following CMake options:

  • AVIF_CODEC_AOM - requires CMake, NASM
  • AVIF_CODEC_DAV1D - requires Meson, Ninja, NASM
  • AVIF_CODEC_LIBGAV1 - requires CMake, Ninja
  • AVIF_CODEC_RAV1E - requires cargo (Rust), NASM

These libraries (in their C API form) must be externally available (discoverable via CMake‘s FIND_LIBRARY) to use them, or if libavif is a child CMake project, the appropriate CMake target must already exist by the time libavif’s CMake scripts are executed.

Local / Static Builds

The ext/ subdirectory contains a handful of basic scripts which each pull down a known-good copy of an AV1 codec and make a local static library build. If you want to statically link any codec into your local (static) build of libavif, building using one of these scripts and then enabling the associated AVIF_LOCAL_* is a convenient method, but you must make sure to disable BUILD_SHARED_LIBS in CMake to instruct it to make a static libavif library.

If you want to build/install shared libraries for AV1 codecs, you can still peek inside of each script to see where the current known-good SHA is for each codec.

Prebuilt Library (Windows)

If you're building on Windows with Visual Studio 2019 and want to try out libavif without going through the build process, static library builds for both Debug and Release are available on AppVeyor.

License

Released under the BSD License.

Copyright 2019 Joe Drago. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.