/
BitmapDecodeInterceptor.kt
64 lines (53 loc) · 2.05 KB
/
BitmapDecodeInterceptor.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/*
* Copyright (C) 2022 panpf <panpfpanpf@outlook.com>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.github.panpf.sketch.decode
import android.graphics.Bitmap
import androidx.annotation.WorkerThread
import com.github.panpf.sketch.ComponentRegistry
import com.github.panpf.sketch.Sketch
import com.github.panpf.sketch.decode.internal.EngineBitmapDecodeInterceptor
import com.github.panpf.sketch.fetch.FetchResult
import com.github.panpf.sketch.request.ImageRequest
import com.github.panpf.sketch.request.internal.RequestContext
/**
* Intercept the execution of [Bitmap] decode, you can change the output, register to [ComponentRegistry] to take effect
*/
interface BitmapDecodeInterceptor {
/**
* If the current BitmapDecodeInterceptor will change the BitmapDecodeResult,
* and may only work on part [ImageRequest],
* provide a valid key to build request key and cache key
*/
val key: String?
/**
* For sorting, larger values go lower in the list. It ranges from 0 to 100. It's usually zero.
* Convention 51-100 is the exclusive range for sketch. [EngineBitmapDecodeInterceptor] is 100
*/
val sortWeight: Int
@WorkerThread
suspend fun intercept(chain: Chain): Result<BitmapDecodeResult>
interface Chain {
val sketch: Sketch
val request: ImageRequest
val requestContext: RequestContext
val fetchResult: FetchResult?
/**
* Continue executing the chain.
*/
@WorkerThread
suspend fun proceed(): Result<BitmapDecodeResult>
}
}