net.sourceforge.plantuml.png.PngIO Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-mit Show documentation
Show all versions of plantuml-mit Show documentation
PlantUML is a component that allows to quickly write diagrams from text.
// THIS FILE HAS BEEN GENERATED BY A PREPROCESSOR.
/* +=======================================================================
* |
* | PlantUML : a free UML diagram generator
* |
* +=======================================================================
*
* (C) Copyright 2009-2024, Arnaud Roques
*
* Project Info: https://plantuml.com
*
* If you like this project or if you find it useful, you can support us at:
*
* https://plantuml.com/patreon (only 1$ per month!)
* https://plantuml.com/liberapay (only 1€ per month!)
* https://plantuml.com/paypal
*
*
* PlantUML is free software; you can redistribute it and/or modify it
* under the terms of the MIT License.
*
* See http://opensource.org/licenses/MIT
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
* IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* PlantUML can occasionally display sponsored or advertising messages. Those
* messages are usually generated on welcome or error images and never on
* functional diagrams.
* See https://plantuml.com/professional if you want to remove them
*
* Images (whatever their format : PNG, SVG, EPS...) generated by running PlantUML
* are owned by the author of their corresponding sources code (that is, their
* textual description in PlantUML language). Those images are not covered by
* this MIT license.
*
* The generated images can then be used without any reference to the MIT license.
* It is not even necessary to stipulate that they have been generated with PlantUML,
* although this will be appreciated by the PlantUML team.
*
* There is an exception : if the textual description in PlantUML language is also covered
* by any license, then the generated images are logically covered
* by the very same license.
*
* This is the IGY distribution (Install GraphViz by Yourself).
* You have to install GraphViz and to setup the GRAPHVIZ_DOT environment variable
* (see https://plantuml.com/graphviz-dot )
*
* Icons provided by OpenIconic : https://useiconic.com/open
* Archimate sprites provided by Archi : http://www.archimatetool.com
* Stdlib AWS provided by https://github.com/milo-minderbinder/AWS-PlantUML
* Stdlib Icons provided https://github.com/tupadr3/plantuml-icon-font-sprites
* ASCIIMathML (c) Peter Jipsen http://www.chapman.edu/~jipsen
* ASCIIMathML (c) David Lippman http://www.pierce.ctc.edu/dlippman
* CafeUndZopfli ported by Eugene Klyuchnikov https://github.com/eustas/CafeUndZopfli
* Brotli (c) by the Brotli Authors https://github.com/google/brotli
* Themes (c) by Brett Schwarz https://github.com/bschwarz/puml-themes
* Twemoji (c) by Twitter at https://twemoji.twitter.com/
*
*/
package net.sourceforge.plantuml.png;
import java.awt.image.RenderedImage;
import java.io.IOException;
import java.io.OutputStream;
import net.sourceforge.plantuml.klimt.color.ColorMapper;
import net.sourceforge.plantuml.security.SFile;
import net.sourceforge.plantuml.security.SImageIO;
import net.sourceforge.plantuml.utils.Log;
public class PngIO {
// ::remove folder when __HAXE__
// ::comment when __CORE__
private static final String copyleft = "Generated by https://plantuml.com";
public static void write(RenderedImage image, ColorMapper mapper, SFile file, String metadata, int dpi)
throws IOException {
try (OutputStream os = file.createBufferedOutputStream()) {
write(image, mapper, os, metadata, dpi);
}
Log.debug("File is " + file);
Log.debug("File size " + file.length());
if (file.length() == 0) {
Log.error("File size is zero: " + file);
SImageIO.write(image, "png", file);
}
}
public static void write(RenderedImage image, ColorMapper mapper, OutputStream os, String metadata, int dpi)
throws IOException {
write(image, mapper, os, metadata, dpi, null);
}
private static void write(RenderedImage image, ColorMapper mapper, OutputStream os, String metadata, int dpi,
String debugData) throws IOException {
// ::comment when __CORE__
if (metadata == null)
SImageIO.write(image, "png", os);
// ::comment when __CORE__
else
PngIOMetadata.writeWithMetadata(image, os, metadata, dpi, debugData);
}
// /** writes a BufferedImage of type TYPE_INT_ARGB to PNG using PNGJ */
// public static void writeARGB(BufferedImage bi, OutputStream os, String metadata) {
// // if (bi.getType() != BufferedImage.TYPE_INT_ARGB)
// // throw new PngjException("This method expects BufferedImage.TYPE_INT_ARGB");
// ImageInfo imi = new ImageInfo(bi.getWidth(), bi.getHeight(), 8, false);
// PngChunkTEXT chunkText = new PngChunkTEXT(imi, "copyleft", copyleft);
// // PngChunkTEXT chunkTextDebug = new PngChunkTEXT(imi, "debug", "debugData");
// PngChunkITXT meta = new PngChunkITXT(imi);
// meta.setKeyVal("plantuml", metadata);
// meta.setCompressed(true);
//
// PngWriter pngw = new PngWriter(os, imi);
// pngw.setCompLevel(9);// maximum compression, not critical usually
// // pngw.setFilterType(FilterType.FILTER_ADAPTIVE_FAST); // see what you prefer here
// // pngw.setFilterType(FilterType.FILTER_ADAPTIVE_MEDIUM); // see what you prefer here
// pngw.setFilterType(FilterType.FILTER_ADAPTIVE_FULL); // see what you prefer here
// pngw.queueChunk(chunkText);
// // // pngw.queueChunk(chunkTextDebug);
// pngw.queueChunk(meta);
// DataBufferInt db = ((DataBufferInt) bi.getRaster().getDataBuffer());
// SinglePixelPackedSampleModel samplemodel = (SinglePixelPackedSampleModel) bi.getSampleModel();
// if (db.getNumBanks() != 1)
// throw new PngjException("This method expects one bank");
// ImageLineInt line = new ImageLineInt(imi);
// for (int row = 0; row < imi.rows; row++) {
// int elem = samplemodel.getOffset(0, row);
// for (int col = 0, j = 0; col < imi.cols; col++) {
// int sample = db.getElem(elem++);
// line.scanline[j++] = (sample & 0xFF0000) >> 16; // R
// line.scanline[j++] = (sample & 0xFF00) >> 8; // G
// line.scanline[j++] = (sample & 0xFF); // B
// // line.scanline[j++] = (((sample & 0xFF000000) >> 24) & 0xFF); // A
// }
// pngw.writeRow(line, row);
// }
// pngw.end();
// }
}