2 // Copyright 2006 The Android Open Source Project
4 // Build resource files from raw assets.
11 #include <androidfw/ResourceTypes.h>
12 #include <utils/ByteOrder.h>
17 // Change this to true for noisy debug output.
18 static const bool kIsDebug = false;
21 png_write_aapt_file(png_structp png_ptr, png_bytep data, png_size_t length)
23 AaptFile* aaptfile = (AaptFile*) png_get_io_ptr(png_ptr);
24 status_t err = aaptfile->writeData(data, length);
25 if (err != NO_ERROR) {
26 png_error(png_ptr, "Write Error");
32 png_flush_aapt_file(png_structp /* png_ptr */)
36 // This holds an image as 8bpp RGBA.
39 image_info() : rows(NULL), is9Patch(false),
40 xDivs(NULL), yDivs(NULL), colors(NULL), allocRows(NULL) { }
43 if (rows && rows != allocRows) {
47 for (int i=0; i<(int)allocHeight; i++) {
57 void* serialize9patch() {
58 void* serialized = Res_png_9patch::serialize(info9Patch, xDivs, yDivs, colors);
59 reinterpret_cast<Res_png_9patch*>(serialized)->deviceToFile();
69 Res_png_9patch info9Patch;
74 // Layout padding, if relevant
75 bool haveLayoutBounds;
76 int32_t layoutBoundsLeft;
77 int32_t layoutBoundsTop;
78 int32_t layoutBoundsRight;
79 int32_t layoutBoundsBottom;
81 // Round rect outline description
82 int32_t outlineInsetsLeft;
83 int32_t outlineInsetsTop;
84 int32_t outlineInsetsRight;
85 int32_t outlineInsetsBottom;
89 png_uint_32 allocHeight;
93 static void log_warning(png_structp png_ptr, png_const_charp warning_message)
95 const char* imageName = (const char*) png_get_error_ptr(png_ptr);
96 fprintf(stderr, "%s: libpng warning: %s\n", imageName, warning_message);
99 static void read_png(const char* imageName,
100 png_structp read_ptr, png_infop read_info,
101 image_info* outImageInfo)
104 int bit_depth, interlace_type, compression_type;
107 png_set_error_fn(read_ptr, const_cast<char*>(imageName),
108 NULL /* use default errorfn */, log_warning);
109 png_read_info(read_ptr, read_info);
111 png_get_IHDR(read_ptr, read_info, &outImageInfo->width,
112 &outImageInfo->height, &bit_depth, &color_type,
113 &interlace_type, &compression_type, NULL);
115 //printf("Image %s:\n", imageName);
116 //printf("color_type=%d, bit_depth=%d, interlace_type=%d, compression_type=%d\n",
117 // color_type, bit_depth, interlace_type, compression_type);
119 if (color_type == PNG_COLOR_TYPE_PALETTE)
120 png_set_palette_to_rgb(read_ptr);
122 if (color_type == PNG_COLOR_TYPE_GRAY && bit_depth < 8)
123 png_set_expand_gray_1_2_4_to_8(read_ptr);
125 if (png_get_valid(read_ptr, read_info, PNG_INFO_tRNS)) {
126 //printf("Has PNG_INFO_tRNS!\n");
127 png_set_tRNS_to_alpha(read_ptr);
131 png_set_strip_16(read_ptr);
133 if ((color_type&PNG_COLOR_MASK_ALPHA) == 0)
134 png_set_add_alpha(read_ptr, 0xFF, PNG_FILLER_AFTER);
136 if (color_type == PNG_COLOR_TYPE_GRAY || color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
137 png_set_gray_to_rgb(read_ptr);
139 png_set_interlace_handling(read_ptr);
141 png_read_update_info(read_ptr, read_info);
143 outImageInfo->rows = (png_bytepp)malloc(
144 outImageInfo->height * sizeof(png_bytep));
145 outImageInfo->allocHeight = outImageInfo->height;
146 outImageInfo->allocRows = outImageInfo->rows;
148 png_set_rows(read_ptr, read_info, outImageInfo->rows);
150 for (i = 0; i < (int)outImageInfo->height; i++)
152 outImageInfo->rows[i] = (png_bytep)
153 malloc(png_get_rowbytes(read_ptr, read_info));
156 png_read_image(read_ptr, outImageInfo->rows);
158 png_read_end(read_ptr, read_info);
161 printf("Image %s: w=%d, h=%d, d=%d, colors=%d, inter=%d, comp=%d\n",
163 (int)outImageInfo->width, (int)outImageInfo->height,
164 bit_depth, color_type,
165 interlace_type, compression_type);
168 png_get_IHDR(read_ptr, read_info, &outImageInfo->width,
169 &outImageInfo->height, &bit_depth, &color_type,
170 &interlace_type, &compression_type, NULL);
173 #define COLOR_TRANSPARENT 0
174 #define COLOR_WHITE 0xFFFFFFFF
175 #define COLOR_TICK 0xFF000000
176 #define COLOR_LAYOUT_BOUNDS_TICK 0xFF0000FF
181 TICK_TYPE_LAYOUT_BOUNDS,
185 static int tick_type(png_bytep p, bool transparent, const char** outError)
187 png_uint_32 color = p[0] | (p[1] << 8) | (p[2] << 16) | (p[3] << 24);
191 return TICK_TYPE_NONE;
193 if (color == COLOR_LAYOUT_BOUNDS_TICK) {
194 return TICK_TYPE_LAYOUT_BOUNDS;
196 if (color == COLOR_TICK) {
197 return TICK_TYPE_TICK;
202 *outError = "Frame pixels must be either solid or transparent (not intermediate alphas)";
203 return TICK_TYPE_NONE;
205 if (p[0] != 0 || p[1] != 0 || p[2] != 0) {
206 *outError = "Ticks in transparent frame must be black or red";
208 return TICK_TYPE_TICK;
212 *outError = "White frame must be a solid color (no alpha)";
214 if (color == COLOR_WHITE) {
215 return TICK_TYPE_NONE;
217 if (color == COLOR_TICK) {
218 return TICK_TYPE_TICK;
220 if (color == COLOR_LAYOUT_BOUNDS_TICK) {
221 return TICK_TYPE_LAYOUT_BOUNDS;
224 if (p[0] != 0 || p[1] != 0 || p[2] != 0) {
225 *outError = "Ticks in white frame must be black or red";
226 return TICK_TYPE_NONE;
228 return TICK_TYPE_TICK;
237 static status_t get_horizontal_ticks(
238 png_bytep row, int width, bool transparent, bool required,
239 int32_t* outLeft, int32_t* outRight, const char** outError,
240 uint8_t* outDivs, bool multipleAllowed)
243 *outLeft = *outRight = -1;
244 int state = TICK_START;
247 for (i=1; i<width-1; i++) {
248 if (TICK_TYPE_TICK == tick_type(row+i*4, transparent, outError)) {
249 if (state == TICK_START ||
250 (state == TICK_OUTSIDE_1 && multipleAllowed)) {
254 if (outDivs != NULL) {
257 state = TICK_INSIDE_1;
258 } else if (state == TICK_OUTSIDE_1) {
259 *outError = "Can't have more than one marked region along edge";
261 return UNKNOWN_ERROR;
263 } else if (*outError == NULL) {
264 if (state == TICK_INSIDE_1) {
265 // We're done with this div. Move on to the next.
269 state = TICK_OUTSIDE_1;
273 return UNKNOWN_ERROR;
277 if (required && !found) {
278 *outError = "No marked region found along edge";
280 return UNKNOWN_ERROR;
286 static status_t get_vertical_ticks(
287 png_bytepp rows, int offset, int height, bool transparent, bool required,
288 int32_t* outTop, int32_t* outBottom, const char** outError,
289 uint8_t* outDivs, bool multipleAllowed)
292 *outTop = *outBottom = -1;
293 int state = TICK_START;
296 for (i=1; i<height-1; i++) {
297 if (TICK_TYPE_TICK == tick_type(rows[i]+offset, transparent, outError)) {
298 if (state == TICK_START ||
299 (state == TICK_OUTSIDE_1 && multipleAllowed)) {
301 *outBottom = height-2;
303 if (outDivs != NULL) {
306 state = TICK_INSIDE_1;
307 } else if (state == TICK_OUTSIDE_1) {
308 *outError = "Can't have more than one marked region along edge";
310 return UNKNOWN_ERROR;
312 } else if (*outError == NULL) {
313 if (state == TICK_INSIDE_1) {
314 // We're done with this div. Move on to the next.
318 state = TICK_OUTSIDE_1;
322 return UNKNOWN_ERROR;
326 if (required && !found) {
327 *outError = "No marked region found along edge";
329 return UNKNOWN_ERROR;
335 static status_t get_horizontal_layout_bounds_ticks(
336 png_bytep row, int width, bool transparent, bool /* required */,
337 int32_t* outLeft, int32_t* outRight, const char** outError)
340 *outLeft = *outRight = 0;
342 // Look for left tick
343 if (TICK_TYPE_LAYOUT_BOUNDS == tick_type(row + 4, transparent, outError)) {
344 // Starting with a layout padding tick
346 while (i < width - 1) {
349 int tick = tick_type(row + i * 4, transparent, outError);
350 if (tick != TICK_TYPE_LAYOUT_BOUNDS) {
356 // Look for right tick
357 if (TICK_TYPE_LAYOUT_BOUNDS == tick_type(row + (width - 2) * 4, transparent, outError)) {
358 // Ending with a layout padding tick
363 int tick = tick_type(row+i*4, transparent, outError);
364 if (tick != TICK_TYPE_LAYOUT_BOUNDS) {
373 static status_t get_vertical_layout_bounds_ticks(
374 png_bytepp rows, int offset, int height, bool transparent, bool /* required */,
375 int32_t* outTop, int32_t* outBottom, const char** outError)
378 *outTop = *outBottom = 0;
381 if (TICK_TYPE_LAYOUT_BOUNDS == tick_type(rows[1] + offset, transparent, outError)) {
382 // Starting with a layout padding tick
384 while (i < height - 1) {
387 int tick = tick_type(rows[i] + offset, transparent, outError);
388 if (tick != TICK_TYPE_LAYOUT_BOUNDS) {
394 // Look for bottom tick
395 if (TICK_TYPE_LAYOUT_BOUNDS == tick_type(rows[height - 2] + offset, transparent, outError)) {
396 // Ending with a layout padding tick
401 int tick = tick_type(rows[i] + offset, transparent, outError);
402 if (tick != TICK_TYPE_LAYOUT_BOUNDS) {
411 static void find_max_opacity(png_byte** rows,
412 int startX, int startY, int endX, int endY, int dX, int dY,
415 uint8_t max_opacity = 0;
418 for (int x = startX, y = startY; x != endX && y != endY; x += dX, y += dY, inset++) {
419 png_byte* color = rows[y] + x * 4;
420 uint8_t opacity = color[3];
421 if (opacity > max_opacity) {
422 max_opacity = opacity;
425 if (opacity == 0xff) return;
429 static uint8_t max_alpha_over_row(png_byte* row, int startX, int endX)
431 uint8_t max_alpha = 0;
432 for (int x = startX; x < endX; x++) {
433 uint8_t alpha = (row + x * 4)[3];
434 if (alpha > max_alpha) max_alpha = alpha;
439 static uint8_t max_alpha_over_col(png_byte** rows, int offsetX, int startY, int endY)
441 uint8_t max_alpha = 0;
442 for (int y = startY; y < endY; y++) {
443 uint8_t alpha = (rows[y] + offsetX * 4)[3];
444 if (alpha > max_alpha) max_alpha = alpha;
449 static void get_outline(image_info* image)
451 int midX = image->width / 2;
452 int midY = image->height / 2;
453 int endX = image->width - 2;
454 int endY = image->height - 2;
456 // find left and right extent of nine patch content on center row
457 if (image->width > 4) {
458 find_max_opacity(image->rows, 1, midY, midX, -1, 1, 0, &image->outlineInsetsLeft);
459 find_max_opacity(image->rows, endX, midY, midX, -1, -1, 0, &image->outlineInsetsRight);
461 image->outlineInsetsLeft = 0;
462 image->outlineInsetsRight = 0;
465 // find top and bottom extent of nine patch content on center column
466 if (image->height > 4) {
467 find_max_opacity(image->rows, midX, 1, -1, midY, 0, 1, &image->outlineInsetsTop);
468 find_max_opacity(image->rows, midX, endY, -1, midY, 0, -1, &image->outlineInsetsBottom);
470 image->outlineInsetsTop = 0;
471 image->outlineInsetsBottom = 0;
474 int innerStartX = 1 + image->outlineInsetsLeft;
475 int innerStartY = 1 + image->outlineInsetsTop;
476 int innerEndX = endX - image->outlineInsetsRight;
477 int innerEndY = endY - image->outlineInsetsBottom;
478 int innerMidX = (innerEndX + innerStartX) / 2;
479 int innerMidY = (innerEndY + innerStartY) / 2;
481 // assuming the image is a round rect, compute the radius by marching
482 // diagonally from the top left corner towards the center
483 image->outlineAlpha = std::max(
484 max_alpha_over_row(image->rows[innerMidY], innerStartX, innerEndX),
485 max_alpha_over_col(image->rows, innerMidX, innerStartY, innerStartY));
487 int diagonalInset = 0;
488 find_max_opacity(image->rows, innerStartX, innerStartY, innerMidX, innerMidY, 1, 1,
491 /* Determine source radius based upon inset:
492 * sqrt(r^2 + r^2) = sqrt(i^2 + i^2) + r
493 * sqrt(2) * r = sqrt(2) * i + r
494 * (sqrt(2) - 1) * r = sqrt(2) * i
495 * r = sqrt(2) / (sqrt(2) - 1) * i
497 image->outlineRadius = 3.4142f * diagonalInset;
500 printf("outline insets %d %d %d %d, rad %f, alpha %x\n",
501 image->outlineInsetsLeft,
502 image->outlineInsetsTop,
503 image->outlineInsetsRight,
504 image->outlineInsetsBottom,
505 image->outlineRadius,
506 image->outlineAlpha);
511 static uint32_t get_color(
512 png_bytepp rows, int left, int top, int right, int bottom)
514 png_bytep color = rows[top] + left*4;
516 if (left > right || top > bottom) {
517 return Res_png_9patch::TRANSPARENT_COLOR;
520 while (top <= bottom) {
521 for (int i = left; i <= right; i++) {
522 png_bytep p = rows[top]+i*4;
525 return Res_png_9patch::NO_COLOR;
527 } else if (p[0] != color[0] || p[1] != color[1]
528 || p[2] != color[2] || p[3] != color[3]) {
529 return Res_png_9patch::NO_COLOR;
536 return Res_png_9patch::TRANSPARENT_COLOR;
538 return (color[3]<<24) | (color[0]<<16) | (color[1]<<8) | color[2];
541 static status_t do_9patch(const char* imageName, image_info* image)
543 image->is9Patch = true;
545 int W = image->width;
546 int H = image->height;
549 int maxSizeXDivs = W * sizeof(int32_t);
550 int maxSizeYDivs = H * sizeof(int32_t);
551 int32_t* xDivs = image->xDivs = (int32_t*) malloc(maxSizeXDivs);
552 int32_t* yDivs = image->yDivs = (int32_t*) malloc(maxSizeYDivs);
553 uint8_t numXDivs = 0;
554 uint8_t numYDivs = 0;
563 memset(xDivs, -1, maxSizeXDivs);
564 memset(yDivs, -1, maxSizeYDivs);
565 image->info9Patch.paddingLeft = image->info9Patch.paddingRight =
566 image->info9Patch.paddingTop = image->info9Patch.paddingBottom = -1;
568 image->layoutBoundsLeft = image->layoutBoundsRight =
569 image->layoutBoundsTop = image->layoutBoundsBottom = 0;
571 png_bytep p = image->rows[0];
572 bool transparent = p[3] == 0;
573 bool hasColor = false;
575 const char* errorMsg = NULL;
577 const char* errorEdge = NULL;
582 if (W < 3 || H < 3) {
583 errorMsg = "Image must be at least 3x3 (1x1 without frame) pixels";
589 (p[0] != 0xFF || p[1] != 0xFF || p[2] != 0xFF || p[3] != 0xFF)) {
590 errorMsg = "Must have one-pixel frame that is either transparent or white";
594 // Find left and right of sizing areas...
595 if (get_horizontal_ticks(p, W, transparent, true, &xDivs[0],
596 &xDivs[1], &errorMsg, &numXDivs, true) != NO_ERROR) {
597 errorPixel = xDivs[0];
602 // Find top and bottom of sizing areas...
603 if (get_vertical_ticks(image->rows, 0, H, transparent, true, &yDivs[0],
604 &yDivs[1], &errorMsg, &numYDivs, true) != NO_ERROR) {
605 errorPixel = yDivs[0];
610 // Copy patch size data into image...
611 image->info9Patch.numXDivs = numXDivs;
612 image->info9Patch.numYDivs = numYDivs;
614 // Find left and right of padding area...
615 if (get_horizontal_ticks(image->rows[H-1], W, transparent, false, &image->info9Patch.paddingLeft,
616 &image->info9Patch.paddingRight, &errorMsg, NULL, false) != NO_ERROR) {
617 errorPixel = image->info9Patch.paddingLeft;
618 errorEdge = "bottom";
622 // Find top and bottom of padding area...
623 if (get_vertical_ticks(image->rows, (W-1)*4, H, transparent, false, &image->info9Patch.paddingTop,
624 &image->info9Patch.paddingBottom, &errorMsg, NULL, false) != NO_ERROR) {
625 errorPixel = image->info9Patch.paddingTop;
630 // Find left and right of layout padding...
631 get_horizontal_layout_bounds_ticks(image->rows[H-1], W, transparent, false,
632 &image->layoutBoundsLeft,
633 &image->layoutBoundsRight, &errorMsg);
635 get_vertical_layout_bounds_ticks(image->rows, (W-1)*4, H, transparent, false,
636 &image->layoutBoundsTop,
637 &image->layoutBoundsBottom, &errorMsg);
639 image->haveLayoutBounds = image->layoutBoundsLeft != 0
640 || image->layoutBoundsRight != 0
641 || image->layoutBoundsTop != 0
642 || image->layoutBoundsBottom != 0;
644 if (image->haveLayoutBounds) {
646 printf("layoutBounds=%d %d %d %d\n", image->layoutBoundsLeft, image->layoutBoundsTop,
647 image->layoutBoundsRight, image->layoutBoundsBottom);
651 // use opacity of pixels to estimate the round rect outline
654 // If padding is not yet specified, take values from size.
655 if (image->info9Patch.paddingLeft < 0) {
656 image->info9Patch.paddingLeft = xDivs[0];
657 image->info9Patch.paddingRight = W - 2 - xDivs[1];
659 // Adjust value to be correct!
660 image->info9Patch.paddingRight = W - 2 - image->info9Patch.paddingRight;
662 if (image->info9Patch.paddingTop < 0) {
663 image->info9Patch.paddingTop = yDivs[0];
664 image->info9Patch.paddingBottom = H - 2 - yDivs[1];
666 // Adjust value to be correct!
667 image->info9Patch.paddingBottom = H - 2 - image->info9Patch.paddingBottom;
671 printf("Size ticks for %s: x0=%d, x1=%d, y0=%d, y1=%d\n", imageName,
674 printf("padding ticks for %s: l=%d, r=%d, t=%d, b=%d\n", imageName,
675 image->info9Patch.paddingLeft, image->info9Patch.paddingRight,
676 image->info9Patch.paddingTop, image->info9Patch.paddingBottom);
679 // Remove frame from image.
680 image->rows = (png_bytepp)malloc((H-2) * sizeof(png_bytep));
681 for (i=0; i<(H-2); i++) {
682 image->rows[i] = image->allocRows[i+1];
683 memmove(image->rows[i], image->rows[i]+4, (W-2)*4);
690 // Figure out the number of rows and columns in the N-patch
691 numCols = numXDivs + 1;
692 if (xDivs[0] == 0) { // Column 1 is strechable
695 if (xDivs[numXDivs - 1] == W) {
698 numRows = numYDivs + 1;
699 if (yDivs[0] == 0) { // Row 1 is strechable
702 if (yDivs[numYDivs - 1] == H) {
706 // Make sure the amount of rows and columns will fit in the number of
707 // colors we can use in the 9-patch format.
708 if (numRows * numCols > 0x7F) {
709 errorMsg = "Too many rows and columns in 9-patch perimeter";
713 numColors = numRows * numCols;
714 image->info9Patch.numColors = numColors;
715 image->colors = (uint32_t*)malloc(numColors * sizeof(uint32_t));
717 // Fill in color information for each patch.
722 // The first row always starts with the top being at y=0 and the bottom
723 // being either yDivs[1] (if yDivs[0]=0) of yDivs[0]. In the former case
724 // the first row is stretchable along the Y axis, otherwise it is fixed.
725 // The last row always ends with the bottom being bitmap.height and the top
726 // being either yDivs[numYDivs-2] (if yDivs[numYDivs-1]=bitmap.height) or
727 // yDivs[numYDivs-1]. In the former case the last row is stretchable along
728 // the Y axis, otherwise it is fixed.
730 // The first and last columns are similarly treated with respect to the X
733 // The above is to help explain some of the special casing that goes on the
736 // The initial yDiv and whether the first row is considered stretchable or
737 // not depends on whether yDiv[0] was zero or not.
738 for (j = (yDivs[0] == 0 ? 1 : 0);
739 j <= numYDivs && top < H;
747 // The initial xDiv and whether the first column is considered
748 // stretchable or not depends on whether xDiv[0] was zero or not.
749 for (i = xDivs[0] == 0 ? 1 : 0;
750 i <= numXDivs && left < W;
757 c = get_color(image->rows, left, top, right - 1, bottom - 1);
758 image->colors[colorIndex++] = c;
760 if (c != Res_png_9patch::NO_COLOR)
768 assert(colorIndex == numColors);
770 for (i=0; i<numColors; i++) {
772 if (i == 0) printf("Colors in %s:\n ", imageName);
773 printf(" #%08x", image->colors[i]);
774 if (i == numColors - 1) printf("\n");
780 "ERROR: 9-patch image %s malformed.\n"
781 " %s.\n", imageName, errorMsg);
782 if (errorEdge != NULL) {
783 if (errorPixel >= 0) {
785 " Found at pixel #%d along %s edge.\n", errorPixel, errorEdge);
788 " Found along %s edge.\n", errorEdge);
791 return UNKNOWN_ERROR;
796 static void checkNinePatchSerialization(Res_png_9patch* inPatch, void* data)
798 size_t patchSize = inPatch->serializedSize();
799 void* newData = malloc(patchSize);
800 memcpy(newData, data, patchSize);
801 Res_png_9patch* outPatch = inPatch->deserialize(newData);
802 // deserialization is done in place, so outPatch == newData
803 assert(outPatch == newData);
804 assert(outPatch->numXDivs == inPatch->numXDivs);
805 assert(outPatch->numYDivs == inPatch->numYDivs);
806 assert(outPatch->paddingLeft == inPatch->paddingLeft);
807 assert(outPatch->paddingRight == inPatch->paddingRight);
808 assert(outPatch->paddingTop == inPatch->paddingTop);
809 assert(outPatch->paddingBottom == inPatch->paddingBottom);
810 for (int i = 0; i < outPatch->numXDivs; i++) {
811 assert(outPatch->getXDivs()[i] == inPatch->getXDivs()[i]);
813 for (int i = 0; i < outPatch->numYDivs; i++) {
814 assert(outPatch->getYDivs()[i] == inPatch->getYDivs()[i]);
816 for (int i = 0; i < outPatch->numColors; i++) {
817 assert(outPatch->getColors()[i] == inPatch->getColors()[i]);
822 static void dump_image(int w, int h, png_bytepp rows, int color_type)
824 int i, j, rr, gg, bb, aa;
827 if (color_type == PNG_COLOR_TYPE_PALETTE || color_type == PNG_COLOR_TYPE_GRAY) {
829 } else if (color_type == PNG_COLOR_TYPE_GRAY_ALPHA) {
831 } else if (color_type == PNG_COLOR_TYPE_RGB || color_type == PNG_COLOR_TYPE_RGB_ALPHA) {
832 // We use a padding byte even when there is no alpha
835 printf("Unknown color type %d.\n", color_type);
838 for (j = 0; j < h; j++) {
839 png_bytep row = rows[j];
840 for (i = 0; i < w; i++) {
848 printf("Row %d:", j);
855 printf(" (%d %d", rr, gg);
858 printf(" (%d %d %d)", rr, gg, bb);
861 printf(" (%d %d %d %d)", rr, gg, bb, aa);
871 #define MAX(a,b) ((a)>(b)?(a):(b))
872 #define ABS(a) ((a)<0?-(a):(a))
874 static void analyze_image(const char *imageName, image_info &imageInfo, int grayscaleTolerance,
875 png_colorp rgbPalette, png_bytep alphaPalette,
876 int *paletteEntries, int *alphaPaletteEntries, bool *hasTransparency,
877 int *colorType, png_bytepp outRows)
879 int w = imageInfo.width;
880 int h = imageInfo.height;
881 int i, j, rr, gg, bb, aa, idx;;
882 uint32_t opaqueColors[256], alphaColors[256];
884 int numOpaqueColors = 0, numAlphaColors = 0;
885 int maxGrayDeviation = 0;
887 bool isOpaque = true;
888 bool isPalette = true;
889 bool isGrayscale = true;
891 // Scan the entire image and determine if:
892 // 1. Every pixel has R == G == B (grayscale)
893 // 2. Every pixel has A == 255 (opaque)
894 // 3. There are no more than 256 distinct RGBA colors
895 // We will track opaque colors separately from colors with
896 // alpha. This allows us to reencode the color table more
897 // efficiently (color tables entries without a corresponding
898 // alpha value are assumed to be opaque).
901 printf("Initial image data:\n");
902 dump_image(w, h, imageInfo.rows, PNG_COLOR_TYPE_RGB_ALPHA);
905 for (j = 0; j < h; j++) {
906 png_bytep row = imageInfo.rows[j];
907 png_bytep out = outRows[j];
908 for (i = 0; i < w; i++) {
910 // Make sure any zero alpha pixels are fully zeroed. On average,
911 // each of our PNG assets seem to have about four distinct pixels
913 // There are several advantages to setting these to zero:
914 // (1) Images are more likely able to be encodable with a palette.
915 // (2) Image palettes will be smaller.
916 // (3) Premultiplied and unpremultiplied PNG decodes can skip
917 // writing zeros to memory, often saving significant numbers
925 // Also set red, green, and blue to zero in "row". If we later
926 // decide to encode the PNG as RGB or RGBA, we will use the
927 // values stored there.
938 int odev = maxGrayDeviation;
939 maxGrayDeviation = MAX(ABS(rr - gg), maxGrayDeviation);
940 maxGrayDeviation = MAX(ABS(gg - bb), maxGrayDeviation);
941 maxGrayDeviation = MAX(ABS(bb - rr), maxGrayDeviation);
942 if (maxGrayDeviation > odev) {
944 printf("New max dev. = %d at pixel (%d, %d) = (%d %d %d %d)\n",
945 maxGrayDeviation, i, j, rr, gg, bb, aa);
949 // Check if image is really grayscale
951 if (rr != gg || rr != bb) {
953 printf("Found a non-gray pixel at %d, %d = (%d %d %d %d)\n",
954 i, j, rr, gg, bb, aa);
960 // Check if image is really opaque
964 printf("Found a non-opaque pixel at %d, %d = (%d %d %d %d)\n",
965 i, j, rr, gg, bb, aa);
971 // Check if image is really <= 256 colors
973 col = (uint32_t) ((rr << 24) | (gg << 16) | (bb << 8) | aa);
977 for (idx = 0; idx < numOpaqueColors; idx++) {
978 if (opaqueColors[idx] == col) {
985 if (numOpaqueColors < 256) {
986 opaqueColors[numOpaqueColors] = col;
991 // Write the palette index for the pixel to outRows optimistically.
992 // We might overwrite it later if we decide to encode as gray or
993 // gray + alpha. We may also need to overwrite it when we combine
994 // into a single palette.
997 for (idx = 0; idx < numAlphaColors; idx++) {
998 if (alphaColors[idx] == col) {
1005 if (numAlphaColors < 256) {
1006 alphaColors[numAlphaColors] = col;
1011 // Write the palette index for the pixel to outRows optimistically.
1012 // We might overwrite it later if we decide to encode as gray or
1017 if (numOpaqueColors + numAlphaColors > 256) {
1019 printf("Found 257th color at %d, %d\n", i, j);
1027 // If we decide to encode the image using a palette, we will reset these counts
1028 // to the appropriate values later. Initializing them here avoids compiler
1029 // complaints about uses of possibly uninitialized variables.
1030 *paletteEntries = 0;
1031 *alphaPaletteEntries = 0;
1033 *hasTransparency = !isOpaque;
1034 int paletteSize = w * h + 3 * numOpaqueColors + 4 * numAlphaColors;
1036 int bpp = isOpaque ? 3 : 4;
1038 printf("isGrayscale = %s\n", isGrayscale ? "true" : "false");
1039 printf("isOpaque = %s\n", isOpaque ? "true" : "false");
1040 printf("isPalette = %s\n", isPalette ? "true" : "false");
1041 printf("Size w/ palette = %d, gray+alpha = %d, rgb(a) = %d\n",
1042 paletteSize, 2 * w * h, bpp * w * h);
1043 printf("Max gray deviation = %d, tolerance = %d\n", maxGrayDeviation, grayscaleTolerance);
1046 // Choose the best color type for the image.
1047 // 1. Opaque gray - use COLOR_TYPE_GRAY at 1 byte/pixel
1048 // 2. Gray + alpha - use COLOR_TYPE_PALETTE if the number of distinct combinations
1049 // is sufficiently small, otherwise use COLOR_TYPE_GRAY_ALPHA
1050 // 3. RGB(A) - use COLOR_TYPE_PALETTE if the number of distinct colors is sufficiently
1051 // small, otherwise use COLOR_TYPE_RGB{_ALPHA}
1054 *colorType = PNG_COLOR_TYPE_GRAY; // 1 byte/pixel
1056 // Use a simple heuristic to determine whether using a palette will
1057 // save space versus using gray + alpha for each pixel.
1058 // This doesn't take into account chunk overhead, filtering, LZ
1059 // compression, etc.
1060 if (isPalette && (paletteSize < 2 * w * h)) {
1061 *colorType = PNG_COLOR_TYPE_PALETTE; // 1 byte/pixel + 4 bytes/color
1063 *colorType = PNG_COLOR_TYPE_GRAY_ALPHA; // 2 bytes per pixel
1066 } else if (isPalette && (paletteSize < bpp * w * h)) {
1067 *colorType = PNG_COLOR_TYPE_PALETTE;
1069 if (maxGrayDeviation <= grayscaleTolerance) {
1070 printf("%s: forcing image to gray (max deviation = %d)\n", imageName, maxGrayDeviation);
1071 *colorType = isOpaque ? PNG_COLOR_TYPE_GRAY : PNG_COLOR_TYPE_GRAY_ALPHA;
1073 *colorType = isOpaque ? PNG_COLOR_TYPE_RGB : PNG_COLOR_TYPE_RGB_ALPHA;
1077 // Perform postprocessing of the image or palette data based on the final
1078 // color type chosen
1080 if (*colorType == PNG_COLOR_TYPE_PALETTE) {
1081 // Combine the alphaColors and the opaqueColors into a single palette.
1082 // The alphaColors must be at the start of the palette.
1083 uint32_t* colors = alphaColors;
1084 memcpy(colors + numAlphaColors, opaqueColors, 4 * numOpaqueColors);
1086 // Fix the indices of the opaque colors in the image.
1087 for (j = 0; j < h; j++) {
1088 png_bytep row = imageInfo.rows[j];
1089 png_bytep out = outRows[j];
1090 for (i = 0; i < w; i++) {
1091 uint32_t pixel = ((uint32_t*) row)[i];
1092 if (pixel >> 24 == 0xFF) {
1093 out[i] += numAlphaColors;
1098 // Create separate RGB and Alpha palettes and set the number of colors
1099 int numColors = numOpaqueColors + numAlphaColors;
1100 *paletteEntries = numColors;
1101 *alphaPaletteEntries = numAlphaColors;
1103 // Create the RGB and alpha palettes
1104 for (int idx = 0; idx < numColors; idx++) {
1106 rgbPalette[idx].red = (png_byte) ((col >> 24) & 0xff);
1107 rgbPalette[idx].green = (png_byte) ((col >> 16) & 0xff);
1108 rgbPalette[idx].blue = (png_byte) ((col >> 8) & 0xff);
1109 if (idx < numAlphaColors) {
1110 alphaPalette[idx] = (png_byte) (col & 0xff);
1113 } else if (*colorType == PNG_COLOR_TYPE_GRAY || *colorType == PNG_COLOR_TYPE_GRAY_ALPHA) {
1114 // If the image is gray or gray + alpha, compact the pixels into outRows
1115 for (j = 0; j < h; j++) {
1116 png_bytep row = imageInfo.rows[j];
1117 png_bytep out = outRows[j];
1118 for (i = 0; i < w; i++) {
1127 *out++ = (png_byte) (rr * 0.2126f + gg * 0.7152f + bb * 0.0722f);
1137 static void write_png(const char* imageName,
1138 png_structp write_ptr, png_infop write_info,
1139 image_info& imageInfo, const Bundle* bundle)
1141 png_uint_32 width, height;
1143 int bit_depth, interlace_type, compression_type;
1146 png_unknown_chunk unknowns[3];
1147 unknowns[0].data = NULL;
1148 unknowns[1].data = NULL;
1149 unknowns[2].data = NULL;
1151 png_bytepp outRows = (png_bytepp) malloc((int) imageInfo.height * sizeof(png_bytep));
1152 if (outRows == (png_bytepp) 0) {
1153 printf("Can't allocate output buffer!\n");
1156 for (i = 0; i < (int) imageInfo.height; i++) {
1157 outRows[i] = (png_bytep) malloc(2 * (int) imageInfo.width);
1158 if (outRows[i] == (png_bytep) 0) {
1159 printf("Can't allocate output buffer!\n");
1164 png_set_compression_level(write_ptr, Z_BEST_COMPRESSION);
1167 printf("Writing image %s: w = %d, h = %d\n", imageName,
1168 (int) imageInfo.width, (int) imageInfo.height);
1171 png_color rgbPalette[256];
1172 png_byte alphaPalette[256];
1173 bool hasTransparency;
1174 int paletteEntries, alphaPaletteEntries;
1176 int grayscaleTolerance = bundle->getGrayscaleTolerance();
1177 analyze_image(imageName, imageInfo, grayscaleTolerance, rgbPalette, alphaPalette,
1178 &paletteEntries, &alphaPaletteEntries, &hasTransparency, &color_type, outRows);
1180 // Legacy versions of aapt would always encode 9patch PNGs as RGBA. This had the unintended
1181 // benefit of working around a bug decoding paletted images in Android 4.1.
1182 // https://code.google.com/p/android/issues/detail?id=34619
1184 // If SDK_JELLY_BEAN is supported, we need to avoid a paletted encoding in order to not expose
1186 if (!bundle->isMinSdkAtLeast(SDK_JELLY_BEAN_MR1)) {
1187 if (imageInfo.is9Patch && PNG_COLOR_TYPE_PALETTE == color_type) {
1188 if (hasTransparency) {
1189 color_type = PNG_COLOR_TYPE_RGB_ALPHA;
1191 color_type = PNG_COLOR_TYPE_RGB;
1197 switch (color_type) {
1198 case PNG_COLOR_TYPE_PALETTE:
1199 printf("Image %s has %d colors%s, using PNG_COLOR_TYPE_PALETTE\n",
1200 imageName, paletteEntries,
1201 hasTransparency ? " (with alpha)" : "");
1203 case PNG_COLOR_TYPE_GRAY:
1204 printf("Image %s is opaque gray, using PNG_COLOR_TYPE_GRAY\n", imageName);
1206 case PNG_COLOR_TYPE_GRAY_ALPHA:
1207 printf("Image %s is gray + alpha, using PNG_COLOR_TYPE_GRAY_ALPHA\n", imageName);
1209 case PNG_COLOR_TYPE_RGB:
1210 printf("Image %s is opaque RGB, using PNG_COLOR_TYPE_RGB\n", imageName);
1212 case PNG_COLOR_TYPE_RGB_ALPHA:
1213 printf("Image %s is RGB + alpha, using PNG_COLOR_TYPE_RGB_ALPHA\n", imageName);
1218 png_set_IHDR(write_ptr, write_info, imageInfo.width, imageInfo.height,
1219 8, color_type, PNG_INTERLACE_NONE,
1220 PNG_COMPRESSION_TYPE_DEFAULT, PNG_FILTER_TYPE_DEFAULT);
1222 if (color_type == PNG_COLOR_TYPE_PALETTE) {
1223 png_set_PLTE(write_ptr, write_info, rgbPalette, paletteEntries);
1224 if (hasTransparency) {
1225 png_set_tRNS(write_ptr, write_info, alphaPalette, alphaPaletteEntries,
1228 png_set_filter(write_ptr, 0, PNG_NO_FILTERS);
1230 png_set_filter(write_ptr, 0, PNG_ALL_FILTERS);
1233 if (imageInfo.is9Patch) {
1234 int chunk_count = 2 + (imageInfo.haveLayoutBounds ? 1 : 0);
1235 int p_index = imageInfo.haveLayoutBounds ? 2 : 1;
1239 // Chunks ordered thusly because older platforms depend on the base 9 patch data being last
1240 png_byte *chunk_names = imageInfo.haveLayoutBounds
1241 ? (png_byte*)"npOl\0npLb\0npTc\0"
1242 : (png_byte*)"npOl\0npTc";
1244 // base 9 patch data
1246 printf("Adding 9-patch info...\n");
1248 strcpy((char*)unknowns[p_index].name, "npTc");
1249 unknowns[p_index].data = (png_byte*)imageInfo.serialize9patch();
1250 unknowns[p_index].size = imageInfo.info9Patch.serializedSize();
1251 // TODO: remove the check below when everything works
1252 checkNinePatchSerialization(&imageInfo.info9Patch, unknowns[p_index].data);
1254 // automatically generated 9 patch outline data
1255 int chunk_size = sizeof(png_uint_32) * 6;
1256 strcpy((char*)unknowns[o_index].name, "npOl");
1257 unknowns[o_index].data = (png_byte*) calloc(chunk_size, 1);
1258 png_byte outputData[chunk_size];
1259 memcpy(&outputData, &imageInfo.outlineInsetsLeft, 4 * sizeof(png_uint_32));
1260 ((float*) outputData)[4] = imageInfo.outlineRadius;
1261 ((png_uint_32*) outputData)[5] = imageInfo.outlineAlpha;
1262 memcpy(unknowns[o_index].data, &outputData, chunk_size);
1263 unknowns[o_index].size = chunk_size;
1265 // optional optical inset / layout bounds data
1266 if (imageInfo.haveLayoutBounds) {
1267 int chunk_size = sizeof(png_uint_32) * 4;
1268 strcpy((char*)unknowns[b_index].name, "npLb");
1269 unknowns[b_index].data = (png_byte*) calloc(chunk_size, 1);
1270 memcpy(unknowns[b_index].data, &imageInfo.layoutBoundsLeft, chunk_size);
1271 unknowns[b_index].size = chunk_size;
1274 for (int i = 0; i < chunk_count; i++) {
1275 unknowns[i].location = PNG_HAVE_IHDR;
1277 png_set_keep_unknown_chunks(write_ptr, PNG_HANDLE_CHUNK_ALWAYS,
1278 chunk_names, chunk_count);
1279 png_set_unknown_chunks(write_ptr, write_info, unknowns, chunk_count);
1283 png_write_info(write_ptr, write_info);
1286 if (color_type == PNG_COLOR_TYPE_RGB || color_type == PNG_COLOR_TYPE_RGB_ALPHA) {
1287 if (color_type == PNG_COLOR_TYPE_RGB) {
1288 png_set_filler(write_ptr, 0, PNG_FILLER_AFTER);
1290 rows = imageInfo.rows;
1294 png_write_image(write_ptr, rows);
1297 printf("Final image data:\n");
1298 dump_image(imageInfo.width, imageInfo.height, rows, color_type);
1301 png_write_end(write_ptr, write_info);
1303 for (i = 0; i < (int) imageInfo.height; i++) {
1307 free(unknowns[0].data);
1308 free(unknowns[1].data);
1309 free(unknowns[2].data);
1311 png_get_IHDR(write_ptr, write_info, &width, &height,
1312 &bit_depth, &color_type, &interlace_type,
1313 &compression_type, NULL);
1316 printf("Image written: w=%d, h=%d, d=%d, colors=%d, inter=%d, comp=%d\n",
1317 (int)width, (int)height, bit_depth, color_type, interlace_type,
1322 static bool read_png_protected(png_structp read_ptr, String8& printableName, png_infop read_info,
1323 const sp<AaptFile>& file, FILE* fp, image_info* imageInfo) {
1324 if (setjmp(png_jmpbuf(read_ptr))) {
1328 png_init_io(read_ptr, fp);
1330 read_png(printableName.string(), read_ptr, read_info, imageInfo);
1332 const size_t nameLen = file->getPath().length();
1334 const char* name = file->getPath().string();
1335 if (name[nameLen-5] == '9' && name[nameLen-6] == '.') {
1336 if (do_9patch(printableName.string(), imageInfo) != NO_ERROR) {
1345 static bool write_png_protected(png_structp write_ptr, String8& printableName, png_infop write_info,
1346 image_info* imageInfo, const Bundle* bundle) {
1347 if (setjmp(png_jmpbuf(write_ptr))) {
1351 write_png(printableName.string(), write_ptr, write_info, *imageInfo, bundle);
1356 status_t preProcessImage(const Bundle* bundle, const sp<AaptAssets>& /* assets */,
1357 const sp<AaptFile>& file, String8* /* outNewLeafName */)
1359 String8 ext(file->getPath().getPathExtension());
1361 // We currently only process PNG images.
1362 if (strcmp(ext.string(), ".png") != 0) {
1366 // Example of renaming a file:
1367 //*outNewLeafName = file->getPath().getBasePath().getFileName();
1368 //outNewLeafName->append(".nupng");
1370 String8 printableName(file->getPrintableSource());
1372 if (bundle->getVerbose()) {
1373 printf("Processing image: %s\n", printableName.string());
1376 png_structp read_ptr = NULL;
1377 png_infop read_info = NULL;
1380 image_info imageInfo;
1382 png_structp write_ptr = NULL;
1383 png_infop write_info = NULL;
1385 status_t error = UNKNOWN_ERROR;
1387 fp = fopen(file->getSourceFile().string(), "rb");
1389 fprintf(stderr, "%s: ERROR: Unable to open PNG file\n", printableName.string());
1393 read_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING, 0, (png_error_ptr)NULL,
1394 (png_error_ptr)NULL);
1399 read_info = png_create_info_struct(read_ptr);
1404 if (!read_png_protected(read_ptr, printableName, read_info, file, fp, &imageInfo)) {
1408 write_ptr = png_create_write_struct(PNG_LIBPNG_VER_STRING, 0, (png_error_ptr)NULL,
1409 (png_error_ptr)NULL);
1415 write_info = png_create_info_struct(write_ptr);
1421 png_set_write_fn(write_ptr, (void*)file.get(),
1422 png_write_aapt_file, png_flush_aapt_file);
1424 if (!write_png_protected(write_ptr, printableName, write_info, &imageInfo, bundle)) {
1430 if (bundle->getVerbose()) {
1431 fseek(fp, 0, SEEK_END);
1432 size_t oldSize = (size_t)ftell(fp);
1433 size_t newSize = file->getSize();
1434 float factor = ((float)newSize)/oldSize;
1435 int percent = (int)(factor*100);
1436 printf(" (processed image %s: %d%% size of source)\n", printableName.string(), percent);
1441 png_destroy_read_struct(&read_ptr, &read_info, (png_infopp)NULL);
1447 png_destroy_write_struct(&write_ptr, &write_info);
1450 if (error != NO_ERROR) {
1451 fprintf(stderr, "ERROR: Failure processing PNG image %s\n",
1452 file->getPrintableSource().string());
1457 status_t preProcessImageToCache(const Bundle* bundle, const String8& source, const String8& dest)
1459 png_structp read_ptr = NULL;
1460 png_infop read_info = NULL;
1464 image_info imageInfo;
1466 png_structp write_ptr = NULL;
1467 png_infop write_info = NULL;
1469 status_t error = UNKNOWN_ERROR;
1471 if (bundle->getVerbose()) {
1472 printf("Processing image to cache: %s => %s\n", source.string(), dest.string());
1475 // Get a file handler to read from
1476 fp = fopen(source.string(),"rb");
1478 fprintf(stderr, "%s ERROR: Unable to open PNG file\n", source.string());
1482 // Call libpng to get a struct to read image data into
1483 read_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING, NULL, NULL, NULL);
1486 png_destroy_read_struct(&read_ptr, &read_info,NULL);
1490 // Call libpng to get a struct to read image info into
1491 read_info = png_create_info_struct(read_ptr);
1494 png_destroy_read_struct(&read_ptr, &read_info,NULL);
1498 // Set a jump point for libpng to long jump back to on error
1499 if (setjmp(png_jmpbuf(read_ptr))) {
1501 png_destroy_read_struct(&read_ptr, &read_info,NULL);
1505 // Set up libpng to read from our file.
1506 png_init_io(read_ptr,fp);
1508 // Actually read data from the file
1509 read_png(source.string(), read_ptr, read_info, &imageInfo);
1511 // We're done reading so we can clean up
1512 // Find old file size before releasing handle
1513 fseek(fp, 0, SEEK_END);
1514 size_t oldSize = (size_t)ftell(fp);
1516 png_destroy_read_struct(&read_ptr, &read_info,NULL);
1518 // Check to see if we're dealing with a 9-patch
1519 // If we are, process appropriately
1520 if (source.getBasePath().getPathExtension() == ".9") {
1521 if (do_9patch(source.string(), &imageInfo) != NO_ERROR) {
1526 // Call libpng to create a structure to hold the processed image data
1527 // that can be written to disk
1528 write_ptr = png_create_write_struct(PNG_LIBPNG_VER_STRING, NULL, NULL, NULL);
1530 png_destroy_write_struct(&write_ptr, &write_info);
1534 // Call libpng to create a structure to hold processed image info that can
1535 // be written to disk
1536 write_info = png_create_info_struct(write_ptr);
1538 png_destroy_write_struct(&write_ptr, &write_info);
1542 // Open up our destination file for writing
1543 fp = fopen(dest.string(), "wb");
1545 fprintf(stderr, "%s ERROR: Unable to open PNG file\n", dest.string());
1546 png_destroy_write_struct(&write_ptr, &write_info);
1550 // Set up libpng to write to our file
1551 png_init_io(write_ptr, fp);
1553 // Set up a jump for libpng to long jump back on on errors
1554 if (setjmp(png_jmpbuf(write_ptr))) {
1556 png_destroy_write_struct(&write_ptr, &write_info);
1560 // Actually write out to the new png
1561 write_png(dest.string(), write_ptr, write_info, imageInfo, bundle);
1563 if (bundle->getVerbose()) {
1564 // Find the size of our new file
1565 FILE* reader = fopen(dest.string(), "rb");
1566 fseek(reader, 0, SEEK_END);
1567 size_t newSize = (size_t)ftell(reader);
1570 float factor = ((float)newSize)/oldSize;
1571 int percent = (int)(factor*100);
1572 printf(" (processed image to cache entry %s: %d%% size of source)\n",
1573 dest.string(), percent);
1578 png_destroy_write_struct(&write_ptr, &write_info);
1583 status_t postProcessImage(const Bundle* bundle, const sp<AaptAssets>& assets,
1584 ResourceTable* table, const sp<AaptFile>& file)
1586 String8 ext(file->getPath().getPathExtension());
1588 // At this point, now that we have all the resource data, all we need to
1589 // do is compile XML files.
1590 if (strcmp(ext.string(), ".xml") == 0) {
1591 String16 resourceName(parseResourceName(file->getSourceFile().getPathLeaf()));
1592 return compileXmlFile(bundle, assets, resourceName, file, table);