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