mtklein | 281b33f | 2016-07-12 15:01:26 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016 Google Inc. |
| 3 | * |
| 4 | * Use of this source code is governed by a BSD-style license that can be |
| 5 | * found in the LICENSE file. |
| 6 | */ |
| 7 | |
| 8 | #ifndef SkRasterPipeline_DEFINED |
| 9 | #define SkRasterPipeline_DEFINED |
| 10 | |
Mike Klein | 0a76b41 | 2017-05-22 12:01:59 -0400 | [diff] [blame] | 11 | #include "SkArenaAlloc.h" |
Mike Klein | d37d5d9 | 2016-12-14 13:38:24 +0000 | [diff] [blame] | 12 | #include "SkImageInfo.h" |
mtklein | 281b33f | 2016-07-12 15:01:26 -0700 | [diff] [blame] | 13 | #include "SkNx.h" |
Mike Klein | 16776df | 2017-08-03 10:22:42 -0400 | [diff] [blame] | 14 | #include "SkPM4f.h" |
mtklein | 281b33f | 2016-07-12 15:01:26 -0700 | [diff] [blame] | 15 | #include "SkTArray.h" |
| 16 | #include "SkTypes.h" |
Mike Klein | 0a76b41 | 2017-05-22 12:01:59 -0400 | [diff] [blame] | 17 | #include <functional> |
Mike Klein | cc63173 | 2016-12-06 09:17:55 -0500 | [diff] [blame] | 18 | #include <vector> |
mtklein | 281b33f | 2016-07-12 15:01:26 -0700 | [diff] [blame] | 19 | |
Mike Klein | 3b92b69 | 2017-07-18 11:30:25 -0400 | [diff] [blame] | 20 | struct SkJumper_Engine; |
Mike Klein | b24704d | 2017-05-24 07:53:00 -0400 | [diff] [blame] | 21 | |
mtklein | 281b33f | 2016-07-12 15:01:26 -0700 | [diff] [blame] | 22 | /** |
| 23 | * SkRasterPipeline provides a cheap way to chain together a pixel processing pipeline. |
| 24 | * |
| 25 | * It's particularly designed for situations where the potential pipeline is extremely |
| 26 | * combinatoric: {N dst formats} x {M source formats} x {K mask formats} x {C transfer modes} ... |
| 27 | * No one wants to write specialized routines for all those combinations, and if we did, we'd |
| 28 | * end up bloating our code size dramatically. SkRasterPipeline stages can be chained together |
| 29 | * at runtime, so we can scale this problem linearly rather than combinatorically. |
| 30 | * |
Mike Klein | b8d88d7 | 2017-06-29 12:21:22 -0400 | [diff] [blame] | 31 | * Each stage is represented by a function conforming to a common interface and by an |
| 32 | * arbitrary context pointer. The stage funciton arguments and calling convention are |
| 33 | * designed to maximize the amount of data we can pass along the pipeline cheaply, and |
| 34 | * vary depending on CPU feature detection. |
mtklein | 281b33f | 2016-07-12 15:01:26 -0700 | [diff] [blame] | 35 | * |
Mike Klein | b8d88d7 | 2017-06-29 12:21:22 -0400 | [diff] [blame] | 36 | * If you'd like to see how this works internally, you want to start digging around src/jumper. |
mtklein | 281b33f | 2016-07-12 15:01:26 -0700 | [diff] [blame] | 37 | */ |
| 38 | |
Mike Klein | 1f49f26 | 2016-10-31 19:49:27 -0400 | [diff] [blame] | 39 | #define SK_RASTER_PIPELINE_STAGES(M) \ |
Mike Klein | 7fee90c | 2017-04-07 16:55:09 -0400 | [diff] [blame] | 40 | M(callback) \ |
Mike Klein | 9f2b3d1 | 2017-06-27 17:26:50 -0400 | [diff] [blame] | 41 | M(move_src_dst) M(move_dst_src) \ |
Mike Reed | 279091e | 2017-06-27 16:58:00 -0400 | [diff] [blame] | 42 | M(clamp_0) M(clamp_1) M(clamp_a) M(clamp_a_dst) \ |
Mike Reed | 883c9bc | 2017-07-19 10:57:53 -0400 | [diff] [blame] | 43 | M(unpremul) M(premul) M(premul_dst) \ |
Mike Klein | 50d0d05 | 2017-08-08 11:29:01 -0400 | [diff] [blame] | 44 | M(set_rgb) M(swap_rb) M(invert) \ |
Mike Reed | 279091e | 2017-06-27 16:58:00 -0400 | [diff] [blame] | 45 | M(from_srgb) M(from_srgb_dst) M(to_srgb) \ |
Mike Reed | c91e387 | 2017-07-05 14:12:37 -0400 | [diff] [blame] | 46 | M(black_color) M(white_color) M(uniform_color) \ |
| 47 | M(seed_shader) M(dither) \ |
Mike Klein | 111f8a9 | 2017-06-27 15:56:32 -0400 | [diff] [blame] | 48 | M(load_a8) M(load_a8_dst) M(store_a8) M(gather_a8) \ |
| 49 | M(load_g8) M(load_g8_dst) M(gather_g8) \ |
| 50 | M(load_565) M(load_565_dst) M(store_565) M(gather_565) \ |
| 51 | M(load_4444) M(load_4444_dst) M(store_4444) M(gather_4444) \ |
| 52 | M(load_f16) M(load_f16_dst) M(store_f16) M(gather_f16) \ |
Mike Reed | 279091e | 2017-06-27 16:58:00 -0400 | [diff] [blame] | 53 | M(load_f32) M(load_f32_dst) M(store_f32) \ |
Mike Klein | 111f8a9 | 2017-06-27 15:56:32 -0400 | [diff] [blame] | 54 | M(load_8888) M(load_8888_dst) M(store_8888) M(gather_8888) \ |
| 55 | M(load_bgra) M(load_bgra_dst) M(store_bgra) M(gather_bgra) \ |
Matt Sarett | 1da27ef | 2017-01-19 17:14:07 -0500 | [diff] [blame] | 56 | M(load_u16_be) M(load_rgb_u16_be) M(store_u16_be) \ |
Matt Sarett | 5bee0b6 | 2017-01-19 12:04:32 -0500 | [diff] [blame] | 57 | M(load_tables_u16_be) M(load_tables_rgb_u16_be) \ |
Mike Reed | 9959f72 | 2017-05-15 09:34:22 -0400 | [diff] [blame] | 58 | M(load_tables) M(load_rgba) M(store_rgba) \ |
Mike Klein | fb126fa | 2017-08-24 13:06:23 -0400 | [diff] [blame] | 59 | M(scale_u8) M(scale_565) M(scale_1_float) \ |
| 60 | M( lerp_u8) M( lerp_565) M( lerp_1_float) \ |
Mike Klein | 1f49f26 | 2016-10-31 19:49:27 -0400 | [diff] [blame] | 61 | M(dstatop) M(dstin) M(dstout) M(dstover) \ |
| 62 | M(srcatop) M(srcin) M(srcout) M(srcover) \ |
| 63 | M(clear) M(modulate) M(multiply) M(plus_) M(screen) M(xor_) \ |
| 64 | M(colorburn) M(colordodge) M(darken) M(difference) \ |
| 65 | M(exclusion) M(hardlight) M(lighten) M(overlay) M(softlight) \ |
Mike Klein | bb33833 | 2017-05-04 12:42:52 -0400 | [diff] [blame] | 66 | M(hue) M(saturation) M(color) M(luminosity) \ |
Mike Klein | 5062626 | 2017-05-25 13:06:57 -0400 | [diff] [blame] | 67 | M(srcover_rgba_8888) \ |
Mike Klein | 06a65e2 | 2016-11-17 12:39:09 -0500 | [diff] [blame] | 68 | M(luminance_to_alpha) \ |
Mike Reed | 7aad8cc | 2017-07-05 12:33:06 -0400 | [diff] [blame] | 69 | M(matrix_translate) M(matrix_scale_translate) \ |
Mike Reed | 0264095 | 2017-05-19 15:32:13 -0400 | [diff] [blame] | 70 | M(matrix_2x3) M(matrix_3x4) M(matrix_4x5) M(matrix_4x3) \ |
Mike Klein | c01e7df | 2016-11-17 16:27:10 -0500 | [diff] [blame] | 71 | M(matrix_perspective) \ |
Mike Klein | cfcf624 | 2016-11-16 09:01:30 -0500 | [diff] [blame] | 72 | M(parametric_r) M(parametric_g) M(parametric_b) \ |
Mike Klein | a07e430 | 2017-08-09 13:51:35 -0400 | [diff] [blame] | 73 | M(parametric_a) M(gamma) \ |
raftias | 5476128 | 2016-12-01 13:44:07 -0500 | [diff] [blame] | 74 | M(table_r) M(table_g) M(table_b) M(table_a) \ |
Mike Klein | c17dc24 | 2017-04-20 16:21:57 -0400 | [diff] [blame] | 75 | M(lab_to_xyz) \ |
Mike Klein | f3b4e16 | 2017-09-22 15:32:59 -0400 | [diff] [blame] | 76 | M(mirror_x) M(repeat_x) \ |
| 77 | M(mirror_y) M(repeat_y) \ |
Mike Klein | 9f85d68 | 2017-05-23 07:52:01 -0400 | [diff] [blame] | 78 | M(clamp_x_1) M(mirror_x_1) M(repeat_x_1) \ |
Mike Klein | b0b17d1 | 2016-12-09 16:25:44 -0500 | [diff] [blame] | 79 | M(bilinear_nx) M(bilinear_px) M(bilinear_ny) M(bilinear_py) \ |
| 80 | M(bicubic_n3x) M(bicubic_n1x) M(bicubic_p1x) M(bicubic_p3x) \ |
| 81 | M(bicubic_n3y) M(bicubic_n1y) M(bicubic_p1y) M(bicubic_p3y) \ |
Florin Malita | c86e470 | 2017-01-20 08:41:34 -0500 | [diff] [blame] | 82 | M(save_xy) M(accumulate) \ |
Herb Derby | 4de1304 | 2017-05-15 10:49:39 -0400 | [diff] [blame] | 83 | M(evenly_spaced_gradient) \ |
Mike Reed | 6533159 | 2017-05-24 16:45:34 -0400 | [diff] [blame] | 84 | M(gauss_a_to_rgba) M(gradient) \ |
Mike Klein | 5c7960b | 2017-05-11 10:59:22 -0400 | [diff] [blame] | 85 | M(evenly_spaced_2_stop_gradient) \ |
| 86 | M(xy_to_unit_angle) \ |
Herb Derby | 090fbf8 | 2017-05-08 15:10:36 -0400 | [diff] [blame] | 87 | M(xy_to_radius) \ |
Florin Malita | 9026fe1 | 2017-06-29 11:03:45 -0400 | [diff] [blame] | 88 | M(xy_to_2pt_conical_quadratic_min) \ |
| 89 | M(xy_to_2pt_conical_quadratic_max) \ |
| 90 | M(xy_to_2pt_conical_linear) \ |
| 91 | M(mask_2pt_conical_degenerates) M(apply_vector_mask) \ |
Matt Sarett | e522f4c | 2017-02-22 13:02:31 -0500 | [diff] [blame] | 92 | M(byte_tables) M(byte_tables_rgb) \ |
Mike Klein | c2f876b | 2017-08-09 18:23:25 -0400 | [diff] [blame] | 93 | M(rgb_to_hsl) M(hsl_to_rgb) \ |
| 94 | M(clut_3D) M(clut_4D) |
Mike Klein | aebfb45 | 2016-10-25 10:27:33 -0400 | [diff] [blame] | 95 | |
mtklein | 281b33f | 2016-07-12 15:01:26 -0700 | [diff] [blame] | 96 | class SkRasterPipeline { |
| 97 | public: |
Mike Klein | b24704d | 2017-05-24 07:53:00 -0400 | [diff] [blame] | 98 | explicit SkRasterPipeline(SkArenaAlloc*); |
| 99 | |
| 100 | SkRasterPipeline(const SkRasterPipeline&) = delete; |
| 101 | SkRasterPipeline(SkRasterPipeline&&) = default; |
| 102 | |
| 103 | SkRasterPipeline& operator=(const SkRasterPipeline&) = delete; |
| 104 | SkRasterPipeline& operator=(SkRasterPipeline&&) = default; |
| 105 | |
| 106 | void reset(); |
mtklein | 281b33f | 2016-07-12 15:01:26 -0700 | [diff] [blame] | 107 | |
Mike Klein | fa9f241 | 2016-09-29 13:40:01 -0400 | [diff] [blame] | 108 | enum StockStage { |
Mike Klein | aebfb45 | 2016-10-25 10:27:33 -0400 | [diff] [blame] | 109 | #define M(stage) stage, |
| 110 | SK_RASTER_PIPELINE_STAGES(M) |
| 111 | #undef M |
Mike Klein | fa9f241 | 2016-09-29 13:40:01 -0400 | [diff] [blame] | 112 | }; |
Mike Klein | 26bea5d | 2016-10-05 10:36:38 -0400 | [diff] [blame] | 113 | void append(StockStage, void* = nullptr); |
| 114 | void append(StockStage stage, const void* ctx) { this->append(stage, const_cast<void*>(ctx)); } |
Mike Klein | fa9f241 | 2016-09-29 13:40:01 -0400 | [diff] [blame] | 115 | |
mtklein | 9a5c47f | 2016-07-22 11:05:04 -0700 | [diff] [blame] | 116 | // Append all stages to this pipeline. |
| 117 | void extend(const SkRasterPipeline&); |
| 118 | |
Mike Klein | 3b92b69 | 2017-07-18 11:30:25 -0400 | [diff] [blame] | 119 | // Runs the pipeline in 2d from (x,y) inclusive to (x+w,y+h) exclusive. |
Mike Klein | 45c16fa | 2017-07-18 18:15:13 -0400 | [diff] [blame] | 120 | void run(size_t x, size_t y, size_t w, size_t h) const; |
Mike Klein | 3b92b69 | 2017-07-18 11:30:25 -0400 | [diff] [blame] | 121 | |
Mike Klein | 0a76b41 | 2017-05-22 12:01:59 -0400 | [diff] [blame] | 122 | // Allocates a thunk which amortizes run() setup cost in alloc. |
Mike Klein | 45c16fa | 2017-07-18 18:15:13 -0400 | [diff] [blame] | 123 | std::function<void(size_t, size_t, size_t, size_t)> compile() const; |
Mike Klein | 0a76b41 | 2017-05-22 12:01:59 -0400 | [diff] [blame] | 124 | |
Mike Klein | 3928c6b | 2016-11-15 16:18:38 -0500 | [diff] [blame] | 125 | void dump() const; |
| 126 | |
Mike Klein | d37d5d9 | 2016-12-14 13:38:24 +0000 | [diff] [blame] | 127 | // Conversion from sRGB can be subtly tricky when premultiplication is involved. |
| 128 | // Use these helpers to keep things sane. |
Mike Klein | 8c8cb5b | 2017-01-06 10:21:56 -0500 | [diff] [blame] | 129 | void append_from_srgb(SkAlphaType); |
Mike Reed | 279091e | 2017-06-27 16:58:00 -0400 | [diff] [blame] | 130 | void append_from_srgb_dst(SkAlphaType); |
Mike Klein | d37d5d9 | 2016-12-14 13:38:24 +0000 | [diff] [blame] | 131 | |
Mike Klein | 073073e | 2017-08-03 09:42:53 -0400 | [diff] [blame] | 132 | // Appends a stage for the specified matrix. |
| 133 | // Tries to optimize the stage by analyzing the type of matrix. |
Mike Reed | 6b59bf4 | 2017-07-03 21:26:44 -0400 | [diff] [blame] | 134 | void append_matrix(SkArenaAlloc*, const SkMatrix&); |
| 135 | |
Mike Klein | 073073e | 2017-08-03 09:42:53 -0400 | [diff] [blame] | 136 | // Appends a stage for a constant uniform color. |
| 137 | // Tries to optimize the stage based on the color. |
Mike Klein | 16776df | 2017-08-03 10:22:42 -0400 | [diff] [blame] | 138 | void append_constant_color(SkArenaAlloc*, const float rgba[4]); |
| 139 | |
| 140 | void append_constant_color(SkArenaAlloc* alloc, const SkPM4f& color) { |
| 141 | this->append_constant_color(alloc, color.fVec); |
| 142 | } |
| 143 | void append_constant_color(SkArenaAlloc* alloc, const SkColor4f& color) { |
| 144 | this->append_constant_color(alloc, color.vec()); |
| 145 | } |
Mike Reed | c91e387 | 2017-07-05 14:12:37 -0400 | [diff] [blame] | 146 | |
Mike Klein | b24704d | 2017-05-24 07:53:00 -0400 | [diff] [blame] | 147 | bool empty() const { return fStages == nullptr; } |
Mike Klein | 1859f69 | 2017-05-22 08:28:45 -0400 | [diff] [blame] | 148 | |
Mike Klein | 159db0a | 2017-07-25 12:02:13 -0400 | [diff] [blame] | 149 | // Used to track if we're handling values outside [0.0f, 1.0f], |
| 150 | // and to clamp back to [0.0f, 1.0f] if so. |
| 151 | void set_clamped(bool clamped) { fClamped = clamped; } |
| 152 | void clamp_if_unclamped(SkAlphaType); |
| 153 | |
mtklein | 281b33f | 2016-07-12 15:01:26 -0700 | [diff] [blame] | 154 | private: |
Mike Klein | b24704d | 2017-05-24 07:53:00 -0400 | [diff] [blame] | 155 | struct StageList { |
| 156 | StageList* prev; |
| 157 | StockStage stage; |
| 158 | void* ctx; |
| 159 | }; |
| 160 | |
Mike Klein | 3b92b69 | 2017-07-18 11:30:25 -0400 | [diff] [blame] | 161 | const SkJumper_Engine& build_pipeline(void**) const; |
Mike Klein | b24704d | 2017-05-24 07:53:00 -0400 | [diff] [blame] | 162 | void unchecked_append(StockStage, void*); |
Mike Klein | b24704d | 2017-05-24 07:53:00 -0400 | [diff] [blame] | 163 | |
| 164 | SkArenaAlloc* fAlloc; |
| 165 | StageList* fStages; |
Mike Klein | 9fff111 | 2017-05-24 11:37:52 -0400 | [diff] [blame] | 166 | int fNumStages; |
Mike Klein | b24704d | 2017-05-24 07:53:00 -0400 | [diff] [blame] | 167 | int fSlotsNeeded; |
Mike Klein | 159db0a | 2017-07-25 12:02:13 -0400 | [diff] [blame] | 168 | bool fClamped; |
mtklein | 281b33f | 2016-07-12 15:01:26 -0700 | [diff] [blame] | 169 | }; |
| 170 | |
Mike Klein | b24704d | 2017-05-24 07:53:00 -0400 | [diff] [blame] | 171 | template <size_t bytes> |
| 172 | class SkRasterPipeline_ : public SkRasterPipeline { |
| 173 | public: |
| 174 | SkRasterPipeline_() |
Florin Malita | 14a6430 | 2017-05-24 14:53:44 -0400 | [diff] [blame] | 175 | : SkRasterPipeline(&fBuiltinAlloc) {} |
Mike Klein | b24704d | 2017-05-24 07:53:00 -0400 | [diff] [blame] | 176 | |
| 177 | private: |
Florin Malita | 14a6430 | 2017-05-24 14:53:44 -0400 | [diff] [blame] | 178 | SkSTArenaAlloc<bytes> fBuiltinAlloc; |
Mike Klein | b24704d | 2017-05-24 07:53:00 -0400 | [diff] [blame] | 179 | }; |
| 180 | |
| 181 | |
mtklein | 281b33f | 2016-07-12 15:01:26 -0700 | [diff] [blame] | 182 | #endif//SkRasterPipeline_DEFINED |