third_party/dav1d/README.md

   1 ![dav1d logo](dav1d_logo.png)
   2
   3 # dav1d
   4
   5 **dav1d** is a new **AV1** cross-platform **d**ecoder, open-source, and focused on speed and correctness.
   6
   7 The canonical repository URL for this repo is https://code.videolan.org/videolan/dav1d
   8
   9 This project is partially funded by the *Alliance for Open Media*/**AOM**.
  10
  11 ## Goal and Features
  12
  13 The goal of this project is to provide a decoder for **most platforms**, and achieve the **highest speed** possible to overcome the temporary lack of AV1 hardware decoder.
  14
  15 It supports all features from AV1, including all subsampling and bit-depth parameters.
  16
  17 In the future, this project will host simple tools or simple wrappings *(like, for example, an MFT transform)*.
  18
  19 ## License
  20
  21 **dav1d** is released under a very liberal license, a contrario from the other VideoLAN projects, so that it can be embedded anywhere, including non-open-source software; or even drivers, to allow the creation of hybrid decoders.
  22
  23 The reasoning behind this decision is the same as for libvorbis, see [RMS on vorbis](https://lwn.net/2001/0301/a/rms-ov-license.php3).
  24
  25 # Roadmap
  26
  27 The plan is the folllowing:
  28
  29 ### Reached
  30 1. Complete C implementation of the decoder,
  31 2. Provide a usable API,
  32 3. Port to most platforms,
  33 4. Make it fast on desktop, by writing asm for AVX-2 chips.
  34 5. Make it fast on mobile, by writing asm for ARMv8 chips,
  35 6. Make it fast on older desktop, by writing asm for SSSE3+ chips.
  36
  37 ### On-going
  38 7. Make it fast on older mobiles, by writing asm for ARMv7 chips,
  39 8. Improve C code base with [various tweaks](https://code.videolan.org/videolan/dav1d/wikis/task-list),
  40 9. Accelerate for less common architectures, like PPC, SSE2 or AVX-512.
  41
  42 ### After
  43 10. Use more GPU, when possible.
  44
  45 # Contribute
  46
  47 Currently, we are looking for help from:
  48 - C developers,
  49 - asm developers,
  50 - platform-specific developers,
  51 - GPGPU developers,
  52 - testers.
  53
  54 Our contributions guidelines are quite strict. We want to build a coherent codebase to simplify maintenance and achieve the highest possible speed.
  55
  56 Notably, the codebase is in pure C and asm.
  57
  58 We are on IRC, on the **#dav1d** channel on *Freenode*.
  59
  60 See the [contributions document](CONTRIBUTING.md).
  61
  62 ## CLA
  63
  64 There is no CLA.
  65
  66 People will keep their copyright and their authorship rights, while adhering to the BSD 2-clause license.
  67
  68 VideoLAN will only have the collective work rights.
  69
  70 ## CoC
  71
  72 The [VideoLAN Code of Conduct](https://wiki.videolan.org/CoC) applies to this project.
  73
  74 # Compile
  75
  76 1. Install [Meson](https://mesonbuild.com/) (0.47 or higher), [Ninja](https://ninja-build.org/), and, for x86\* targets, [nasm](https://nasm.us/) (2.14 or higher)
  77 2. Run `mkdir build && cd build` to create a build directory and enter it
  78 3. Run `meson ..` to configure meson, add `--default-library=static` if static linking is desired
  79 4. Run `ninja` to compile
  80
  81 # Run tests
  82
  83 1. In the root directory, run `git clone https://code.videolan.org/videolan/dav1d-test-data.git tests/dav1d-test-data` to fetch the test data repository
  84 2. During meson configuration, specify `-Dtestdata_tests=true`
  85 3. Run `meson test -v` after compiling
  86
  87 # Support
  88
  89 This project is partially funded by the *Alliance for Open Media*/**AOM** and is supported by TwoOrioles and VideoLabs.
  90
  91 These companies can provide support and integration help, should you need it.
  92
  93
  94 # FAQ
  95
  96 ## Why do you not improve libaom rather than starting a new project?
  97
  98 - We believe that libaom is a very good library. It was however developed for research purposes during AV1 design.
  99 We think that an implementation written from scratch can achieve faster decoding, in the same way that *ffvp9* was faster than *libvpx*.
 100
 101 ## Is dav1d a recursive acronym?
 102
 103 - Yes.
 104
 105 ## Can I help?
 106
 107 - Yes. See the [contributions document](CONTRIBUTING.md).
 108
 109 ## I am not a developer. Can I help?
 110
 111 - Yes. We need testers, bug reporters, and documentation writers.
 112
 113 ## What about the AV1 patent license?
 114
 115 - This project is an implementation of a decoder. It gives you no special rights on the AV1 patents.
 116
 117 Please read the [AV1 patent license](doc/PATENTS) that applies to the AV1 specification and codec.
 118
 119 ## Will you care about <my_arch>? <my_os>?
 120
 121 - We do, but we don't have either the time or the knowledge. Therefore, patches and contributions welcome.
 122