epoger@google.com | ec3ed6a | 2011-07-28 14:26:00 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2011 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 | */ |
reed | 53b9e2e | 2014-12-19 12:26:07 -0800 | [diff] [blame] | 7 | |
reed@android.com | b08eb2b | 2009-01-06 20:16:26 +0000 | [diff] [blame] | 8 | #ifndef SkImageEncoder_DEFINED |
| 9 | #define SkImageEncoder_DEFINED |
| 10 | |
reed | 53b9e2e | 2014-12-19 12:26:07 -0800 | [diff] [blame] | 11 | #include "SkImageInfo.h" |
mtklein@google.com | bd6343b | 2013-09-04 17:20:18 +0000 | [diff] [blame] | 12 | #include "SkTRegistry.h" |
reed@android.com | b08eb2b | 2009-01-06 20:16:26 +0000 | [diff] [blame] | 13 | |
| 14 | class SkBitmap; |
reed@google.com | 4b0757b | 2013-05-20 16:33:41 +0000 | [diff] [blame] | 15 | class SkData; |
reed@android.com | b08eb2b | 2009-01-06 20:16:26 +0000 | [diff] [blame] | 16 | class SkWStream; |
| 17 | |
| 18 | class SkImageEncoder { |
| 19 | public: |
scroggo | 1dd3ea9 | 2015-03-20 11:55:55 -0700 | [diff] [blame] | 20 | // TODO (scroggo): Merge with SkEncodedFormat. |
reed@android.com | b08eb2b | 2009-01-06 20:16:26 +0000 | [diff] [blame] | 21 | enum Type { |
scroggo@google.com | 39edf4c | 2013-04-25 17:33:51 +0000 | [diff] [blame] | 22 | kUnknown_Type, |
scroggo@google.com | 4c6adf9 | 2013-04-17 21:07:55 +0000 | [diff] [blame] | 23 | kBMP_Type, |
| 24 | kGIF_Type, |
| 25 | kICO_Type, |
reed@android.com | b08eb2b | 2009-01-06 20:16:26 +0000 | [diff] [blame] | 26 | kJPEG_Type, |
commit-bot@chromium.org | a936e37 | 2013-03-14 14:42:18 +0000 | [diff] [blame] | 27 | kPNG_Type, |
scroggo@google.com | 4c6adf9 | 2013-04-17 21:07:55 +0000 | [diff] [blame] | 28 | kWBMP_Type, |
| 29 | kWEBP_Type, |
krajcevski | c250d2e | 2014-06-06 06:16:28 -0700 | [diff] [blame] | 30 | kKTX_Type, |
reed@android.com | b08eb2b | 2009-01-06 20:16:26 +0000 | [diff] [blame] | 31 | }; |
| 32 | static SkImageEncoder* Create(Type); |
| 33 | |
| 34 | virtual ~SkImageEncoder(); |
rmistry@google.com | fbfcd56 | 2012-08-23 18:09:54 +0000 | [diff] [blame] | 35 | |
reed@android.com | b08eb2b | 2009-01-06 20:16:26 +0000 | [diff] [blame] | 36 | /* Quality ranges from 0..100 */ |
| 37 | enum { |
| 38 | kDefaultQuality = 80 |
| 39 | }; |
| 40 | |
epoger@google.com | 4ce738b | 2012-11-16 18:44:18 +0000 | [diff] [blame] | 41 | /** |
reed@google.com | 4b0757b | 2013-05-20 16:33:41 +0000 | [diff] [blame] | 42 | * Encode bitmap 'bm', returning the results in an SkData, at quality level |
| 43 | * 'quality' (which can be in range 0-100). If the bitmap cannot be |
| 44 | * encoded, return null. On success, the caller is responsible for |
| 45 | * calling unref() on the data when they are finished. |
| 46 | */ |
| 47 | SkData* encodeData(const SkBitmap&, int quality); |
| 48 | |
| 49 | /** |
epoger@google.com | 4ce738b | 2012-11-16 18:44:18 +0000 | [diff] [blame] | 50 | * Encode bitmap 'bm' in the desired format, writing results to |
| 51 | * file 'file', at quality level 'quality' (which can be in range |
reed@google.com | 4b0757b | 2013-05-20 16:33:41 +0000 | [diff] [blame] | 52 | * 0-100). Returns false on failure. |
epoger@google.com | 4ce738b | 2012-11-16 18:44:18 +0000 | [diff] [blame] | 53 | */ |
| 54 | bool encodeFile(const char file[], const SkBitmap& bm, int quality); |
| 55 | |
| 56 | /** |
| 57 | * Encode bitmap 'bm' in the desired format, writing results to |
| 58 | * stream 'stream', at quality level 'quality' (which can be in |
reed@google.com | 4b0757b | 2013-05-20 16:33:41 +0000 | [diff] [blame] | 59 | * range 0-100). Returns false on failure. |
epoger@google.com | 4ce738b | 2012-11-16 18:44:18 +0000 | [diff] [blame] | 60 | */ |
| 61 | bool encodeStream(SkWStream* stream, const SkBitmap& bm, int quality); |
reed@android.com | b08eb2b | 2009-01-06 20:16:26 +0000 | [diff] [blame] | 62 | |
reed | 53b9e2e | 2014-12-19 12:26:07 -0800 | [diff] [blame] | 63 | static SkData* EncodeData(const SkImageInfo&, const void* pixels, size_t rowBytes, |
| 64 | Type, int quality); |
reed@google.com | 4b0757b | 2013-05-20 16:33:41 +0000 | [diff] [blame] | 65 | static SkData* EncodeData(const SkBitmap&, Type, int quality); |
reed | 53b9e2e | 2014-12-19 12:26:07 -0800 | [diff] [blame] | 66 | |
reed@android.com | b08eb2b | 2009-01-06 20:16:26 +0000 | [diff] [blame] | 67 | static bool EncodeFile(const char file[], const SkBitmap&, Type, |
| 68 | int quality); |
| 69 | static bool EncodeStream(SkWStream*, const SkBitmap&, Type, |
| 70 | int quality); |
| 71 | |
| 72 | protected: |
epoger@google.com | 4ce738b | 2012-11-16 18:44:18 +0000 | [diff] [blame] | 73 | /** |
| 74 | * Encode bitmap 'bm' in the desired format, writing results to |
| 75 | * stream 'stream', at quality level 'quality' (which can be in |
| 76 | * range 0-100). |
| 77 | * |
| 78 | * This must be overridden by each SkImageEncoder implementation. |
| 79 | */ |
| 80 | virtual bool onEncode(SkWStream* stream, const SkBitmap& bm, int quality) = 0; |
reed@android.com | b08eb2b | 2009-01-06 20:16:26 +0000 | [diff] [blame] | 81 | }; |
| 82 | |
robertphillips@google.com | ec51cb8 | 2012-03-23 18:13:47 +0000 | [diff] [blame] | 83 | // This macro declares a global (i.e., non-class owned) creation entry point |
| 84 | // for each encoder (e.g., CreateJPEGImageEncoder) |
| 85 | #define DECLARE_ENCODER_CREATOR(codec) \ |
| 86 | SkImageEncoder *Create ## codec (); |
| 87 | |
| 88 | // This macro defines the global creation entry point for each encoder. Each |
| 89 | // encoder implementation that registers with the encoder factory must call it. |
| 90 | #define DEFINE_ENCODER_CREATOR(codec) \ |
| 91 | SkImageEncoder *Create ## codec () { \ |
| 92 | return SkNEW( Sk ## codec ); \ |
| 93 | } |
| 94 | |
| 95 | // All the encoders known by Skia. Note that, depending on the compiler settings, |
| 96 | // not all of these will be available |
bungeman@google.com | 8c6a4f2 | 2013-04-23 18:06:23 +0000 | [diff] [blame] | 97 | /** An ARGBImageEncoder will always write out |
| 98 | * bitmap.width() * bitmap.height() * 4 |
| 99 | * bytes. |
| 100 | */ |
| 101 | DECLARE_ENCODER_CREATOR(ARGBImageEncoder); |
robertphillips@google.com | ec51cb8 | 2012-03-23 18:13:47 +0000 | [diff] [blame] | 102 | DECLARE_ENCODER_CREATOR(JPEGImageEncoder); |
| 103 | DECLARE_ENCODER_CREATOR(PNGImageEncoder); |
krajcevski | c250d2e | 2014-06-06 06:16:28 -0700 | [diff] [blame] | 104 | DECLARE_ENCODER_CREATOR(KTXImageEncoder); |
commit-bot@chromium.org | a936e37 | 2013-03-14 14:42:18 +0000 | [diff] [blame] | 105 | DECLARE_ENCODER_CREATOR(WEBPImageEncoder); |
robertphillips@google.com | ec51cb8 | 2012-03-23 18:13:47 +0000 | [diff] [blame] | 106 | |
caryclark | 936b734 | 2014-07-11 12:14:51 -0700 | [diff] [blame] | 107 | #ifdef SK_BUILD_FOR_IOS |
| 108 | DECLARE_ENCODER_CREATOR(PNGImageEncoder_IOS); |
| 109 | #endif |
| 110 | |
mtklein@google.com | bd6343b | 2013-09-04 17:20:18 +0000 | [diff] [blame] | 111 | // Typedef to make registering encoder callback easier |
| 112 | // This has to be defined outside SkImageEncoder. :( |
| 113 | typedef SkTRegistry<SkImageEncoder*(*)(SkImageEncoder::Type)> SkImageEncoder_EncodeReg; |
reed@android.com | b08eb2b | 2009-01-06 20:16:26 +0000 | [diff] [blame] | 114 | #endif |