summaryrefslogtreecommitdiff
path: root/chromium/third_party/blink/renderer/platform/graphics/image_frame_generator.h
blob: d7449212fb4684f3ac76bf99503c59efe89efd3f (plain)
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
/*
 * Copyright (C) 2012 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef THIRD_PARTY_BLINK_RENDERER_PLATFORM_GRAPHICS_IMAGE_FRAME_GENERATOR_H_
#define THIRD_PARTY_BLINK_RENDERER_PLATFORM_GRAPHICS_IMAGE_FRAME_GENERATOR_H_

#include <memory>
#include "base/memory/scoped_refptr.h"
#include "third_party/blink/renderer/platform/image-decoders/image_decoder.h"
#include "third_party/blink/renderer/platform/image-decoders/segment_reader.h"
#include "third_party/blink/renderer/platform/platform_export.h"
#include "third_party/blink/renderer/platform/wtf/allocator.h"
#include "third_party/blink/renderer/platform/wtf/noncopyable.h"
#include "third_party/blink/renderer/platform/wtf/ref_counted.h"
#include "third_party/blink/renderer/platform/wtf/thread_safe_ref_counted.h"
#include "third_party/blink/renderer/platform/wtf/threading_primitives.h"
#include "third_party/blink/renderer/platform/wtf/vector.h"
#include "third_party/skia/include/core/SkBitmap.h"
#include "third_party/skia/include/core/SkSize.h"
#include "third_party/skia/include/core/SkTypes.h"

struct SkYUVSizeInfo;

namespace blink {

class ImageDecoder;

class PLATFORM_EXPORT ImageDecoderFactory {
  USING_FAST_MALLOC(ImageDecoderFactory);
  WTF_MAKE_NONCOPYABLE(ImageDecoderFactory);

 public:
  ImageDecoderFactory() = default;
  virtual ~ImageDecoderFactory() = default;
  virtual std::unique_ptr<ImageDecoder> Create() = 0;
};

class PLATFORM_EXPORT ImageFrameGenerator final
    : public ThreadSafeRefCounted<ImageFrameGenerator> {
  WTF_MAKE_NONCOPYABLE(ImageFrameGenerator);

 public:
  static scoped_refptr<ImageFrameGenerator> Create(
      const SkISize& full_size,
      bool is_multi_frame,
      const ColorBehavior& color_behavior,
      std::vector<SkISize> supported_sizes) {
    return base::AdoptRef(new ImageFrameGenerator(
        full_size, is_multi_frame, color_behavior, std::move(supported_sizes)));
  }

  ~ImageFrameGenerator();

  // Decodes and scales the specified frame at |index|. The dimensions and
  // output format are given in SkImageInfo. Decoded pixels are written into
  // |pixels| with a stride of |rowBytes|. Returns true if decoding was
  // successful.
  bool DecodeAndScale(SegmentReader*,
                      bool all_data_received,
                      size_t index,
                      const SkImageInfo&,
                      void* pixels,
                      size_t row_bytes,
                      ImageDecoder::AlphaOption);

  // Decodes YUV components directly into the provided memory planes. Must not
  // be called unless getYUVComponentSizes has been called and returned true.
  // YUV decoding does not currently support progressive decoding. In order to
  // support it, ImageDecoder needs something analagous to its ImageFrame cache
  // to hold partial planes, and the GPU code needs to handle them.
  bool DecodeToYUV(SegmentReader*,
                   size_t index,
                   const SkISize component_sizes[3],
                   void* planes[3],
                   const size_t row_bytes[3]);

  const SkISize& GetFullSize() const { return full_size_; }

  SkISize GetSupportedDecodeSize(const SkISize& requested_size) const;

  bool IsMultiFrame() const { return is_multi_frame_; }
  bool DecodeFailed() const { return decode_failed_; }

  bool HasAlpha(size_t index);

  // Must not be called unless the SkROBuffer has all the data. YUV decoding
  // does not currently support progressive decoding. See comment above on
  // decodeToYUV().
  bool GetYUVComponentSizes(SegmentReader*, SkYUVSizeInfo*);

 private:
  ImageFrameGenerator(const SkISize& full_size,
                      bool is_multi_frame,
                      const ColorBehavior&,
                      std::vector<SkISize> supported_sizes);

  friend class ImageFrameGeneratorTest;
  friend class DeferredImageDecoderTest;
  // For testing. |factory| will overwrite the default ImageDecoder creation
  // logic if |factory->create()| returns non-zero.
  void SetImageDecoderFactory(std::unique_ptr<ImageDecoderFactory> factory) {
    image_decoder_factory_ = std::move(factory);
  }

  void SetHasAlpha(size_t index, bool has_alpha);

  SkBitmap TryToResumeDecode(SegmentReader*,
                             bool all_data_received,
                             size_t index,
                             const SkISize& scaled_size,
                             SkBitmap::Allocator&,
                             ImageDecoder::AlphaOption);
  // This method should only be called while decode_mutex_ is locked.
  // Returns a pointer to frame |index|'s ImageFrame, if available.
  // Sets |used_external_allocator| to true if the the image was decoded into
  // |external_allocator|'s memory.
  ImageFrame* Decode(SegmentReader*,
                     bool all_data_received,
                     size_t index,
                     ImageDecoder**,
                     SkBitmap::Allocator& external_allocator,
                     ImageDecoder::AlphaOption,
                     const SkISize& scaled_size,
                     bool& used_external_allocator);

  const SkISize full_size_;

  // Parameters used to create internal ImageDecoder objects.
  const ColorBehavior decoder_color_behavior_;

  const bool is_multi_frame_;
  bool decode_failed_;
  bool yuv_decoding_failed_;
  size_t frame_count_;
  Vector<bool> has_alpha_;
  std::vector<SkISize> supported_sizes_;

  std::unique_ptr<ImageDecoderFactory> image_decoder_factory_;

  // Prevents multiple decode operations on the same data.
  Mutex decode_mutex_;

  // Protect concurrent access to has_alpha_.
  Mutex alpha_mutex_;
};

}  // namespace blink

#endif