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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
/*
* Copyright 2015 Google Inc.
*
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
#ifndef SkCodec_DEFINED
#define SkCodec_DEFINED
#include "SkEncodedFormat.h"
#include "SkImageGenerator.h"
#include "SkImageInfo.h"
#include "SkScanlineDecoder.h"
#include "SkSize.h"
#include "SkStream.h"
#include "SkTemplates.h"
#include "SkTypes.h"
class SkData;
/**
* Abstraction layer directly on top of an image codec.
*/
class SkCodec : public SkImageGenerator {
public:
/**
* If this stream represents an encoded image that we know how to decode,
* return an SkCodec that can decode it. Otherwise return NULL.
*
* If NULL is returned, the stream is deleted immediately. Otherwise, the
* SkCodec takes ownership of it, and will delete it when done with it.
*/
static SkCodec* NewFromStream(SkStream*);
/**
* If this data represents an encoded image that we know how to decode,
* return an SkCodec that can decode it. Otherwise return NULL.
*
* Will take a ref if it returns a codec, else will not affect the data.
*/
static SkCodec* NewFromData(SkData*);
/**
* Return a size that approximately supports the desired scale factor.
* The codec may not be able to scale efficiently to the exact scale
* factor requested, so return a size that approximates that scale.
*
* FIXME: Move to SkImageGenerator?
*/
SkISize getScaledDimensions(float desiredScale) const {
return this->onGetScaledDimensions(desiredScale);
}
/**
* Format of the encoded data.
*/
SkEncodedFormat getEncodedFormat() const { return this->onGetEncodedFormat(); }
/**
* Return an object which can be used to decode individual scanlines.
*
* This object is owned by the SkCodec, which will handle its lifetime. The
* returned object is only valid until the SkCodec is deleted or the next
* call to getScanlineDecoder, whichever comes first.
*
* Calling a second time will rewind and replace the existing one with a
* new one. If the stream cannot be rewound, this will delete the existing
* one and return NULL.
*
* @param dstInfo Info of the destination. If the dimensions do not match
* those of getInfo, this implies a scale.
* @param options Contains decoding options, including if memory is zero
* initialized.
* @param ctable A pointer to a color table. When dstInfo.colorType() is
* kIndex8, this should be non-NULL and have enough storage for 256
* colors. The color table will be populated after decoding the palette.
* @param ctableCount A pointer to the size of the color table. When
* dstInfo.colorType() is kIndex8, this should be non-NULL. It will
* be modified to the true size of the color table (<= 256) after
* decoding the palette.
* @return New SkScanlineDecoder, or NULL on failure.
*
* NOTE: If any rows were previously decoded, this requires rewinding the
* SkStream.
*
* NOTE: The scanline decoder is owned by the SkCodec and will delete it
* when the SkCodec is deleted.
*/
SkScanlineDecoder* getScanlineDecoder(const SkImageInfo& dstInfo, const Options* options,
SkPMColor ctable[], int* ctableCount);
/**
* Simplified version of getScanlineDecoder() that asserts that info is NOT
* kIndex8_SkColorType and uses the default Options.
*/
SkScanlineDecoder* getScanlineDecoder(const SkImageInfo& dstInfo);
/**
* Some images may initially report that they have alpha due to the format
* of the encoded data, but then never use any colors which have alpha
* less than 100%. This function can be called *after* decoding to
* determine if such an image truly had alpha. Calling it before decoding
* is undefined.
* FIXME: see skbug.com/3582.
*/
bool reallyHasAlpha() const {
return this->onReallyHasAlpha();
}
protected:
SkCodec(const SkImageInfo&, SkStream*);
/**
* The SkAlphaType is a conservative answer. i.e. it is possible that it
* initially returns a non-opaque answer, but completing the decode
* reveals that the image is actually opaque.
*/
#ifdef SK_SUPPORT_LEGACY_BOOL_ONGETINFO
bool onGetInfo(SkImageInfo* info) override {
*info = fInfo;
return true;
}
#endif
virtual SkISize onGetScaledDimensions(float /* desiredScale */) const {
// By default, scaling is not supported.
#ifdef SK_SUPPORT_LEGACY_BOOL_ONGETINFO
return fInfo.dimensions();
#else
return this->getInfo().dimensions();
#endif
}
virtual SkEncodedFormat onGetEncodedFormat() const = 0;
/**
* Override if your codec supports scanline decoding.
*
* As in onGetPixels(), the implementation must call rewindIfNeeded() and
* handle as appropriate.
*
* @param dstInfo Info of the destination. If the dimensions do not match
* those of getInfo, this implies a scale.
* @param options Contains decoding options, including if memory is zero
* initialized.
* @param ctable A pointer to a color table. When dstInfo.colorType() is
* kIndex8, this should be non-NULL and have enough storage for 256
* colors. The color table will be populated after decoding the palette.
* @param ctableCount A pointer to the size of the color table. When
* dstInfo.colorType() is kIndex8, this should be non-NULL. It will
* be modified to the true size of the color table (<= 256) after
* decoding the palette.
* @return New SkScanlineDecoder on success, NULL otherwise. The SkCodec
* will take ownership of the returned scanline decoder.
*/
virtual SkScanlineDecoder* onGetScanlineDecoder(const SkImageInfo& dstInfo,
const Options& options,
SkPMColor ctable[],
int* ctableCount) {
return NULL;
}
virtual bool onReallyHasAlpha() const { return false; }
enum RewindState {
kRewound_RewindState,
kNoRewindNecessary_RewindState,
kCouldNotRewind_RewindState
};
/**
* If the stream was previously read, attempt to rewind.
* @returns:
* kRewound if the stream needed to be rewound, and the
* rewind succeeded.
* kNoRewindNecessary if the stream did not need to be
* rewound.
* kCouldNotRewind if the stream needed to be rewound, and
* rewind failed.
*
* Subclasses MUST call this function before reading the stream (e.g. in
* onGetPixels). If it returns false, onGetPixels should return
* kCouldNotRewind.
*/
RewindState SK_WARN_UNUSED_RESULT rewindIfNeeded();
/*
*
* Get method for the input stream
*
*/
SkStream* stream() {
return fStream.get();
}
private:
#ifdef SK_SUPPORT_LEGACY_BOOL_ONGETINFO
const SkImageInfo fInfo;
#endif // SK_SUPPORT_LEGACY_BOOL_ONGETINFO
SkAutoTDelete<SkStream> fStream;
bool fNeedsRewind;
SkAutoTDelete<SkScanlineDecoder> fScanlineDecoder;
typedef SkImageGenerator INHERITED;
};
#endif // SkCodec_DEFINED
|
