| /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- |
| * |
| * ***** BEGIN LICENSE BLOCK ***** |
| * Version: MPL 1.1/GPL 2.0/LGPL 2.1 |
| * |
| * The contents of this file are subject to the Mozilla Public License Version |
| * 1.1 (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * http://www.mozilla.org/MPL/ |
| * |
| * Software distributed under the License is distributed on an "AS IS" basis, |
| * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License |
| * for the specific language governing rights and limitations under the |
| * License. |
| * |
| * The Original Code is mozilla.org code. |
| * |
| * The Initial Developer of the Original Code is Mozilla Corporation. |
| * Portions created by the Initial Developer are Copyright (C) 2007 |
| * the Initial Developer. All Rights Reserved. |
| * |
| * Contributor(s): |
| * Justin Dolske <dolske@mozilla.com> (original author) |
| * |
| * Alternatively, the contents of this file may be used under the terms of |
| * either the GNU General Public License Version 2 or later (the "GPL"), or |
| * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), |
| * in which case the provisions of the GPL or the LGPL are applicable instead |
| * of those above. If you wish to allow use of your version of this file only |
| * under the terms of either the GPL or the LGPL, and not to allow others to |
| * use your version of this file under the terms of the MPL, indicate your |
| * decision by deleting the provisions above and replace them with the notice |
| * and other provisions required by the GPL or the LGPL. If you do not delete |
| * the provisions above, a recipient may use your version of this file under |
| * the terms of any one of the MPL, the GPL or the LGPL. |
| * |
| * ***** END LICENSE BLOCK ***** */ |
| |
| #include "nsISupports.idl" |
| |
| interface nsIInputStream; |
| interface imgIContainer; |
| |
| [scriptable, uuid(c395d8f1-c616-4a1b-adfd-747b4b1b2cbe)] |
| interface imgITools : nsISupports |
| { |
| /** |
| * decodeImageData |
| * Caller provides an input stream and mimetype. We read from the stream |
| * and decompress it (according to the specified mime type) and return |
| * the resulting imgIContainer. (If the caller already has a container, |
| * it can be provided as input to be reused). |
| * |
| * @param aStream |
| * An input stream for an encoded image file. |
| * @param aMimeType |
| * Type of image in the stream. |
| * @param aContainer |
| * An imgIContainer holding the decoded image. Specify |null| when |
| * calling to have one created, otherwise specify a container to |
| * be reused. |
| */ |
| void decodeImageData(in nsIInputStream aStream, |
| in ACString aMimeType, |
| inout imgIContainer aContainer); |
| |
| /** |
| * encodeImage |
| * Caller provides an image container, and the mime type it should be |
| * encoded to. We return an input stream for the encoded image data. |
| * |
| * @param aContainer |
| * An image container. |
| * @param aMimeType |
| * Type of encoded image desired (eg "image/png"). |
| */ |
| nsIInputStream encodeImage(in imgIContainer aContainer, |
| in ACString aMimeType); |
| |
| /** |
| * encodeScaledImage |
| * Caller provides an image container, and the mime type it should be |
| * encoded to. We return an input stream for the encoded image data. |
| * The encoded image is scaled to the specified dimensions. |
| * |
| * @param aContainer |
| * An image container. |
| * @param aMimeType |
| * Type of encoded image desired (eg "image/png"). |
| * @param aWidth, aHeight |
| * The size (in pixels) desired for the resulting image. |
| */ |
| nsIInputStream encodeScaledImage(in imgIContainer aContainer, |
| in ACString aMimeType, |
| in long aWidth, |
| in long aHeight); |
| }; |