SkAnimatedImage.cpp 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348
  1. /*
  2. * Copyright 2018 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. #include "include/android/SkAnimatedImage.h"
  8. #include "include/codec/SkAndroidCodec.h"
  9. #include "include/codec/SkCodec.h"
  10. #include "include/core/SkCanvas.h"
  11. #include "include/core/SkPicture.h"
  12. #include "include/core/SkPictureRecorder.h"
  13. #include "include/core/SkPixelRef.h"
  14. #include "src/codec/SkCodecPriv.h"
  15. #include "src/core/SkImagePriv.h"
  16. #include <limits.h>
  17. #include <utility>
  18. sk_sp<SkAnimatedImage> SkAnimatedImage::Make(std::unique_ptr<SkAndroidCodec> codec,
  19. SkISize scaledSize, SkIRect cropRect, sk_sp<SkPicture> postProcess) {
  20. if (!codec) {
  21. return nullptr;
  22. }
  23. auto info = codec->getInfo().makeWH(scaledSize.width(), scaledSize.height());
  24. return Make(std::move(codec), info, cropRect, std::move(postProcess));
  25. }
  26. sk_sp<SkAnimatedImage> SkAnimatedImage::Make(std::unique_ptr<SkAndroidCodec> codec,
  27. const SkImageInfo& requestedInfo, SkIRect cropRect, sk_sp<SkPicture> postProcess) {
  28. if (!codec) {
  29. return nullptr;
  30. }
  31. auto scaledSize = requestedInfo.dimensions();
  32. auto decodeInfo = requestedInfo;
  33. if (codec->getEncodedFormat() != SkEncodedImageFormat::kWEBP
  34. || scaledSize.width() >= decodeInfo.width()
  35. || scaledSize.height() >= decodeInfo.height()) {
  36. // Only libwebp can decode to arbitrary smaller sizes.
  37. auto dims = codec->getInfo().dimensions();
  38. decodeInfo = decodeInfo.makeWH(dims.width(), dims.height());
  39. }
  40. auto image = sk_sp<SkAnimatedImage>(new SkAnimatedImage(std::move(codec), scaledSize,
  41. decodeInfo, cropRect, std::move(postProcess)));
  42. if (!image->fDisplayFrame.fBitmap.getPixels()) {
  43. // tryAllocPixels failed.
  44. return nullptr;
  45. }
  46. return image;
  47. }
  48. sk_sp<SkAnimatedImage> SkAnimatedImage::Make(std::unique_ptr<SkAndroidCodec> codec) {
  49. if (!codec) {
  50. return nullptr;
  51. }
  52. const auto decodeInfo = codec->getInfo();
  53. const auto scaledSize = decodeInfo.dimensions();
  54. const auto cropRect = SkIRect::MakeSize(scaledSize);
  55. auto image = sk_sp<SkAnimatedImage>(new SkAnimatedImage(std::move(codec), scaledSize,
  56. decodeInfo, cropRect, nullptr));
  57. if (!image->fDisplayFrame.fBitmap.getPixels()) {
  58. // tryAllocPixels failed.
  59. return nullptr;
  60. }
  61. SkASSERT(image->fSimple);
  62. return image;
  63. }
  64. SkAnimatedImage::SkAnimatedImage(std::unique_ptr<SkAndroidCodec> codec, SkISize scaledSize,
  65. SkImageInfo decodeInfo, SkIRect cropRect, sk_sp<SkPicture> postProcess)
  66. : fCodec(std::move(codec))
  67. , fScaledSize(scaledSize)
  68. , fDecodeInfo(decodeInfo)
  69. , fCropRect(cropRect)
  70. , fPostProcess(std::move(postProcess))
  71. , fFrameCount(fCodec->codec()->getFrameCount())
  72. , fSimple(fScaledSize == fDecodeInfo.dimensions() && !fPostProcess
  73. && fCropRect == fDecodeInfo.bounds())
  74. , fFinished(false)
  75. , fRepetitionCount(fCodec->codec()->getRepetitionCount())
  76. , fRepetitionsCompleted(0)
  77. {
  78. if (!fDecodingFrame.fBitmap.tryAllocPixels(fDecodeInfo)) {
  79. return;
  80. }
  81. if (!fSimple) {
  82. fMatrix = SkMatrix::MakeTrans(-fCropRect.fLeft, -fCropRect.fTop);
  83. float scaleX = (float) fScaledSize.width() / fDecodeInfo.width();
  84. float scaleY = (float) fScaledSize.height() / fDecodeInfo.height();
  85. fMatrix.preConcat(SkMatrix::MakeScale(scaleX, scaleY));
  86. }
  87. this->decodeNextFrame();
  88. }
  89. SkAnimatedImage::~SkAnimatedImage() { }
  90. SkRect SkAnimatedImage::onGetBounds() {
  91. return SkRect::MakeIWH(fCropRect.width(), fCropRect.height());
  92. }
  93. SkAnimatedImage::Frame::Frame()
  94. : fIndex(SkCodec::kNoFrame)
  95. {}
  96. bool SkAnimatedImage::Frame::init(const SkImageInfo& info, OnInit onInit) {
  97. if (fBitmap.getPixels()) {
  98. if (fBitmap.pixelRef()->unique()) {
  99. SkAssertResult(fBitmap.setAlphaType(info.alphaType()));
  100. return true;
  101. }
  102. // An SkCanvas provided to onDraw is still holding a reference.
  103. // Copy before we decode to ensure that we don't overwrite the
  104. // expected contents of the image.
  105. if (OnInit::kRestoreIfNecessary == onInit) {
  106. SkBitmap tmp;
  107. if (!tmp.tryAllocPixels(info)) {
  108. return false;
  109. }
  110. memcpy(tmp.getPixels(), fBitmap.getPixels(), fBitmap.computeByteSize());
  111. using std::swap;
  112. swap(tmp, fBitmap);
  113. return true;
  114. }
  115. }
  116. return fBitmap.tryAllocPixels(info);
  117. }
  118. bool SkAnimatedImage::Frame::copyTo(Frame* dst) const {
  119. if (!dst->init(fBitmap.info(), OnInit::kNoRestore)) {
  120. return false;
  121. }
  122. memcpy(dst->fBitmap.getPixels(), fBitmap.getPixels(), fBitmap.computeByteSize());
  123. dst->fIndex = fIndex;
  124. dst->fDisposalMethod = fDisposalMethod;
  125. return true;
  126. }
  127. void SkAnimatedImage::reset() {
  128. fFinished = false;
  129. fRepetitionsCompleted = 0;
  130. if (fDisplayFrame.fIndex != 0) {
  131. fDisplayFrame.fIndex = SkCodec::kNoFrame;
  132. this->decodeNextFrame();
  133. }
  134. }
  135. static bool is_restore_previous(SkCodecAnimation::DisposalMethod dispose) {
  136. return SkCodecAnimation::DisposalMethod::kRestorePrevious == dispose;
  137. }
  138. int SkAnimatedImage::computeNextFrame(int current, bool* animationEnded) {
  139. SkASSERT(animationEnded != nullptr);
  140. *animationEnded = false;
  141. const int frameToDecode = current + 1;
  142. if (frameToDecode == fFrameCount - 1) {
  143. // Final frame. Check to determine whether to stop.
  144. fRepetitionsCompleted++;
  145. if (fRepetitionCount != SkCodec::kRepetitionCountInfinite
  146. && fRepetitionsCompleted > fRepetitionCount) {
  147. *animationEnded = true;
  148. }
  149. } else if (frameToDecode == fFrameCount) {
  150. return 0;
  151. }
  152. return frameToDecode;
  153. }
  154. double SkAnimatedImage::finish() {
  155. fFinished = true;
  156. fCurrentFrameDuration = kFinished;
  157. return kFinished;
  158. }
  159. int SkAnimatedImage::decodeNextFrame() {
  160. if (fFinished) {
  161. return kFinished;
  162. }
  163. bool animationEnded = false;
  164. int frameToDecode = this->computeNextFrame(fDisplayFrame.fIndex, &animationEnded);
  165. SkCodec::FrameInfo frameInfo;
  166. if (fCodec->codec()->getFrameInfo(frameToDecode, &frameInfo)) {
  167. if (!frameInfo.fFullyReceived) {
  168. SkCodecPrintf("Frame %i not fully received\n", frameToDecode);
  169. return this->finish();
  170. }
  171. fCurrentFrameDuration = frameInfo.fDuration;
  172. } else {
  173. animationEnded = true;
  174. if (0 == frameToDecode) {
  175. // Static image. This is okay.
  176. frameInfo.fRequiredFrame = SkCodec::kNoFrame;
  177. frameInfo.fAlphaType = fCodec->getInfo().alphaType();
  178. frameInfo.fDisposalMethod = SkCodecAnimation::DisposalMethod::kKeep;
  179. // These fields won't be read.
  180. frameInfo.fDuration = INT_MAX;
  181. frameInfo.fFullyReceived = true;
  182. fCurrentFrameDuration = kFinished;
  183. } else {
  184. SkCodecPrintf("Error getting frameInfo for frame %i\n",
  185. frameToDecode);
  186. return this->finish();
  187. }
  188. }
  189. if (frameToDecode == fDisplayFrame.fIndex) {
  190. if (animationEnded) {
  191. return this->finish();
  192. }
  193. return fCurrentFrameDuration;
  194. }
  195. for (Frame* frame : { &fRestoreFrame, &fDecodingFrame }) {
  196. if (frameToDecode == frame->fIndex) {
  197. using std::swap;
  198. swap(fDisplayFrame, *frame);
  199. if (animationEnded) {
  200. return this->finish();
  201. }
  202. return fCurrentFrameDuration;
  203. }
  204. }
  205. // The following code makes an effort to avoid overwriting a frame that will
  206. // be used again. If frame |i| is_restore_previous, frame |i+1| will not
  207. // depend on frame |i|, so do not overwrite frame |i-1|, which may be needed
  208. // for frame |i+1|.
  209. // We could be even smarter about which frames to save by looking at the
  210. // entire dependency chain.
  211. SkCodec::Options options;
  212. options.fFrameIndex = frameToDecode;
  213. if (frameInfo.fRequiredFrame == SkCodec::kNoFrame) {
  214. if (is_restore_previous(frameInfo.fDisposalMethod)) {
  215. // frameToDecode will be discarded immediately after drawing, so
  216. // do not overwrite a frame which could possibly be used in the
  217. // future.
  218. if (fDecodingFrame.fIndex != SkCodec::kNoFrame &&
  219. !is_restore_previous(fDecodingFrame.fDisposalMethod)) {
  220. using std::swap;
  221. swap(fDecodingFrame, fRestoreFrame);
  222. }
  223. }
  224. } else {
  225. auto validPriorFrame = [&frameInfo, &frameToDecode](const Frame& frame) {
  226. if (SkCodec::kNoFrame == frame.fIndex ||
  227. is_restore_previous(frame.fDisposalMethod)) {
  228. return false;
  229. }
  230. return frame.fIndex >= frameInfo.fRequiredFrame && frame.fIndex < frameToDecode;
  231. };
  232. if (validPriorFrame(fDecodingFrame)) {
  233. if (is_restore_previous(frameInfo.fDisposalMethod)) {
  234. // fDecodingFrame is a good frame to use for this one, but we
  235. // don't want to overwrite it.
  236. fDecodingFrame.copyTo(&fRestoreFrame);
  237. }
  238. options.fPriorFrame = fDecodingFrame.fIndex;
  239. } else if (validPriorFrame(fDisplayFrame)) {
  240. if (!fDisplayFrame.copyTo(&fDecodingFrame)) {
  241. SkCodecPrintf("Failed to allocate pixels for frame\n");
  242. return this->finish();
  243. }
  244. options.fPriorFrame = fDecodingFrame.fIndex;
  245. } else if (validPriorFrame(fRestoreFrame)) {
  246. if (!is_restore_previous(frameInfo.fDisposalMethod)) {
  247. using std::swap;
  248. swap(fDecodingFrame, fRestoreFrame);
  249. } else if (!fRestoreFrame.copyTo(&fDecodingFrame)) {
  250. SkCodecPrintf("Failed to restore frame\n");
  251. return this->finish();
  252. }
  253. options.fPriorFrame = fDecodingFrame.fIndex;
  254. }
  255. }
  256. auto alphaType = kOpaque_SkAlphaType == frameInfo.fAlphaType ?
  257. kOpaque_SkAlphaType : kPremul_SkAlphaType;
  258. auto info = fDecodeInfo.makeAlphaType(alphaType);
  259. SkBitmap* dst = &fDecodingFrame.fBitmap;
  260. if (!fDecodingFrame.init(info, Frame::OnInit::kRestoreIfNecessary)) {
  261. return this->finish();
  262. }
  263. auto result = fCodec->codec()->getPixels(dst->info(), dst->getPixels(), dst->rowBytes(),
  264. &options);
  265. if (result != SkCodec::kSuccess) {
  266. SkCodecPrintf("error %i, frame %i of %i\n", result, frameToDecode, fFrameCount);
  267. return this->finish();
  268. }
  269. fDecodingFrame.fIndex = frameToDecode;
  270. fDecodingFrame.fDisposalMethod = frameInfo.fDisposalMethod;
  271. using std::swap;
  272. swap(fDecodingFrame, fDisplayFrame);
  273. fDisplayFrame.fBitmap.notifyPixelsChanged();
  274. if (animationEnded) {
  275. return this->finish();
  276. }
  277. return fCurrentFrameDuration;
  278. }
  279. void SkAnimatedImage::onDraw(SkCanvas* canvas) {
  280. auto image = SkMakeImageFromRasterBitmap(fDisplayFrame.fBitmap,
  281. kNever_SkCopyPixelsMode);
  282. if (fSimple) {
  283. canvas->drawImage(image, 0, 0);
  284. return;
  285. }
  286. SkRect bounds = this->getBounds();
  287. if (fPostProcess) {
  288. canvas->saveLayer(&bounds, nullptr);
  289. }
  290. {
  291. SkAutoCanvasRestore acr(canvas, fPostProcess != nullptr);
  292. canvas->concat(fMatrix);
  293. SkPaint paint;
  294. paint.setFilterQuality(kLow_SkFilterQuality);
  295. canvas->drawImage(image, 0, 0, &paint);
  296. }
  297. if (fPostProcess) {
  298. canvas->drawPicture(fPostProcess);
  299. canvas->restore();
  300. }
  301. }
  302. void SkAnimatedImage::setRepetitionCount(int newCount) {
  303. fRepetitionCount = newCount;
  304. }