skia2/modules/canvaskit
Mike Klein 9d4b788807 Revert "Split building encoding from decoding"
This reverts commit 94aaf7cdf5.

Reason for revert: you know what I already typed the reason stop making rules that people have to follow, robots.

Original change's description:
> Split building encoding from decoding
> 
> Bug: skia:9756
> 
> In CanvasKit, a large part of the binary is for encoding. Clients
> would be happier with a smaller binary and no webp/jpeg encoding. Make
> this an option by splitting up the GN arguments.
> 
> Split SK_HAS_WEBP_LIBRARY into SK_CODEC_DECODES_WEBP (to match the
> existing SK_CODEC_DECODES_RAW) and SK_ENCODE_WEBP. Same for JPEG and
> PNG.
> 
> Update CanvasKit compile script to disable webp and jpeg encoding.
> Update debugger compile script to disable all encoding.
> 
> Change IsPng signature to match other SkCodecs.
> 
> Change-Id: Iec8466ee1b76bc3d1e377c24201068b776cd7718
> Reviewed-on: https://skia-review.googlesource.com/c/skia/+/273768
> Commit-Queue: Leon Scroggins <scroggo@google.com>
> Reviewed-by: Derek Sollenberger <djsollen@google.com>
> Reviewed-by: Kevin Lubick <kjlubick@google.com>
> Reviewed-by: Nathaniel Nifong <nifong@google.com>

TBR=djsollen@google.com,scroggo@google.com,kjlubick@google.com,nifong@google.com

Change-Id: I4fc2ea916743fda7e7d0d668b59e52052e880104
No-Presubmit: true
No-Tree-Checks: true
No-Try: true
Bug: skia:9756
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/275710
Reviewed-by: Mike Klein <mtklein@google.com>
Commit-Queue: Mike Klein <mtklein@google.com>
2020-03-06 21:39:21 +00:00
..
canvaskit Replace red line skp with a prettier example 2020-03-06 16:15:08 +00:00
fonts [canvaskit] Clean up embedded fonts 2019-10-09 14:51:39 +00:00
htmlcanvas [canvaskit] Fix shadow bugs 2020-03-06 16:14:20 +00:00
perf [canvaskit] Roll chrome version for testing 2019-10-18 17:37:52 +00:00
tests [canvaskit] Fix shadow bugs 2020-03-06 16:14:20 +00:00
.gitignore [canvaskit] Move from experimental to modules 2019-03-11 21:09:52 +00:00
canvaskit_bindings.cpp Remove experimental from name of skm44 canvas methods 2020-03-04 21:36:18 +00:00
CHANGELOG.md Revert "Split building encoding from decoding" 2020-03-06 21:39:21 +00:00
compile.sh Revert "Split building encoding from decoding" 2020-03-06 21:39:21 +00:00
cpu.js rm CanvasKit.HEAPU8.buffer caching (fix UAF bug). 2020-01-15 14:48:36 +00:00
debug.js Expose 4x4 matrices on canvas in a way similar to SimpleMatrix, add example. 2020-02-22 00:12:13 +00:00
externs.js Remove all uses of bones 2020-03-05 18:47:38 +00:00
font.js rm CanvasKit.HEAPU8.buffer caching (fix UAF bug). 2020-01-15 14:48:36 +00:00
gpu.js [canvaskit] Request an 8 bit stencil buffer from the WebGL 1/2 context 2019-11-15 17:21:48 +00:00
helper.js [canvaskit] Expose parseColorString 2020-02-21 12:43:15 +00:00
interface.js Name name changes suggested in API review 2020-03-05 15:13:41 +00:00
karma.bench.conf.js [canvaskit] Try some things to reduce GPU test flakiness 2019-11-21 20:56:42 +00:00
karma.conf.js [canvaskit] Try some things to reduce GPU test flakiness 2019-11-21 20:56:42 +00:00
Makefile [canvaskit] Update build script to support latest Emscripten 2020-01-28 15:41:58 +00:00
package.json [canvaskit] Move from experimental to modules 2019-03-11 21:09:52 +00:00
paragraph_bindings.cpp [canvaskit] Include direction from getRects 2019-11-20 13:27:22 +00:00
paragraph.js [canvaskit] Include direction from getRects 2019-11-20 13:27:22 +00:00
particles_bindings.cpp [canvaskit] Expose bindings to particles uniforms. 2020-02-21 14:43:01 +00:00
particles.js [canvaskit] Expose bindings to particles uniforms. 2020-02-21 14:43:01 +00:00
pathops.js [canvaskit] Add build flag for pathops 2020-01-06 13:10:43 +00:00
postamble.js [canvaskit] Move from experimental to modules 2019-03-11 21:09:52 +00:00
preamble.js [canvaskit] Move from experimental to modules 2019-03-11 21:09:52 +00:00
README.md [canvaskit] Update build script to support latest Emscripten 2020-01-28 15:41:58 +00:00
ready.js [canvaskit] Move from experimental to modules 2019-03-11 21:09:52 +00:00
release.js Expose 4x4 matrices on canvas in a way similar to SimpleMatrix, add example. 2020-02-22 00:12:13 +00:00
rt_shader.js [canvaskit] Support children shaders into runtime shaders 2020-02-22 12:38:52 +00:00
serve.py [canvaskit] Move from experimental to modules 2019-03-11 21:09:52 +00:00
skottie_bindings.cpp use std::make_unique 2019-12-12 22:32:45 +00:00
skottie.js Use ResourceProvider in particles 2019-11-27 16:45:23 +00:00
skp.js Add support for reading .skp files in CanvasKit. 2020-01-15 14:46:37 +00:00
WasmAliases.h [canvaskit] Initial addition of SkParagraph 2019-10-03 18:04:55 +00:00

Prerequisites

To compile CanvasKit, you will first need to install emscripten. This will set the environment EMSDK (among others) which is required for compilation.

Compile and Test Locally

make release  # make debug is much faster and has better error messages
make local-example

This will print a local endpoint for viewing the example. You can experiment with the CanvasKit API by modifying ./canvaskit/example.html and refreshing the page. For some more experimental APIs, there's also ./canvaskit/extra.html.

For other available build targets, see Makefile and compile.sh. For example, building a stripped-down version of CanvasKit with no text support or any of the "extras", one might run:

./compile.sh no_skottie no_particles no_font

Such a stripped-down version is about half the size of the default release build.

Infrastructure Playbook

When dealing with CanvasKit (or PathKit) on our bots, we use Docker. Check out $SKIA_ROOT/infra/wasm-common/docker/README.md for more on building/editing the images used for building and testing.

Updating the version of Emscripten we build/test with

This presumes you have updated emscripten locally to a newer version of the sdk and verified/fixed any build issues that have arisen.

  1. Edit $SKIA_ROOT/infra/wasm-common/docker/emsdk-base/Dockerfile to install and activate the desired version of Emscripten.
  2. Edit $SKIA_ROOT/infra/wasm-common/docker/Makefile to have EMSDK_VERSION be set to that desired version. If there is a suffix that is not _v1, reset it to be _v1. If testing the image later does not work and edits are made to the emsdk-base Dockerfile to correct that, increment to _v2,_v3, etc to force the bots to pick up the new image.
  3. In $SKIA_ROOT/infra/wasm-common/docker/, run make publish_emsdk_base
  4. Edit $SKIA_ROOT/infra/canvaskit/docker/canvaskit-emsdk/Dockerfile to be based off the new version from step 2. CanvasKit has its own docker image because it needs a few extra dependencies to build with font support.
  5. Edit $SKIA_ROOT/infra/canvaskit/docker/Makefile to have the same version from step 2. It's easiest to keep the emsdk-base and canvaskit-emsdk versions be in lock-step.
  6. In $SKIA_ROOT/infra/canvaskit/docker/, make publish_canvaskit_emsdk.
  7. In $SKIA_ROOT/infra/bots/recipe_modules/build/, update canvaskit.py and pathkit.py to have DOCKER_IMAAGE point to the desired tagged Docker containers from steps 2 and 5 (which should be the same).
  8. In $SKIA_ROOT/infra/bots/, run make train to re-train the recipes.
  9. Optional: Run something like git grep 1\\.38\\. in $SKIA_ROOT to see if there are any other references that need updating.
  10. Upload a CL with all the changes. Run all Test.+CanvasKit, Perf.+CanvasKit, Test.+PathKit, Perf.+PathKit jobs to make sure the new builds pass all tests and don't crash the perf harnesses.
  11. Send out CL for review. Feel free to point the reviewer at these steps.