1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
2 *
3 * ***** BEGIN LICENSE BLOCK *****
4 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
5 *
6 * The contents of this file are subject to the Mozilla Public License Version
7 * 1.1 (the "License"); you may not use this file except in compliance with
8 * the License. You may obtain a copy of the License at
9 * http://www.mozilla.org/MPL/
10 *
11 * Software distributed under the License is distributed on an "AS IS" basis,
12 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13 * for the specific language governing rights and limitations under the
14 * License.
15 *
16 * The Original Code is mozilla.org code.
17 *
18 * The Initial Developer of the Original Code is Mozilla Corporation.
19 * Portions created by the Initial Developer are Copyright (C) 2007
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 * Justin Dolske <dolske@mozilla.com> (original author)
24 *
25 * Alternatively, the contents of this file may be used under the terms of
26 * either the GNU General Public License Version 2 or later (the "GPL"), or
27 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
28 * in which case the provisions of the GPL or the LGPL are applicable instead
29 * of those above. If you wish to allow use of your version of this file only
30 * under the terms of either the GPL or the LGPL, and not to allow others to
31 * use your version of this file under the terms of the MPL, indicate your
32 * decision by deleting the provisions above and replace them with the notice
33 * and other provisions required by the GPL or the LGPL. If you do not delete
34 * the provisions above, a recipient may use your version of this file under
35 * the terms of any one of the MPL, the GPL or the LGPL.
36 *
37 * ***** END LICENSE BLOCK ***** */
38
39 #include "nsISupports.idl"
40
41 interface nsIInputStream;
42 interface imgIContainer;
43
44 [scriptable, uuid(c395d8f1-c616-4a1b-adfd-747b4b1b2cbe)]
45 interface imgITools : nsISupports
46 {
47 /**
48 * decodeImageData
49 * Caller provides an input stream and mimetype. We read from the stream
50 * and decompress it (according to the specified mime type) and return
51 * the resulting imgIContainer. (If the caller already has a container,
52 * it can be provided as input to be reused).
53 *
54 * @param aStream
55 * An input stream for an encoded image file.
56 * @param aMimeType
57 * Type of image in the stream.
58 * @param aContainer
59 * An imgIContainer holding the decoded image. Specify |null| when
60 * calling to have one created, otherwise specify a container to
61 * be reused.
62 */
63 void decodeImageData(in nsIInputStream aStream,
64 in ACString aMimeType,
65 inout imgIContainer aContainer);
66
67 /**
68 * encodeImage
69 * Caller provides an image container, and the mime type it should be
70 * encoded to. We return an input stream for the encoded image data.
71 *
72 * @param aContainer
73 * An image container.
74 * @param aMimeType
75 * Type of encoded image desired (eg "image/png").
76 */
77 nsIInputStream encodeImage(in imgIContainer aContainer,
78 in ACString aMimeType);
79
80 /**
81 * encodeScaledImage
82 * Caller provides an image container, and the mime type it should be
83 * encoded to. We return an input stream for the encoded image data.
84 * The encoded image is scaled to the specified dimensions.
85 *
86 * @param aContainer
87 * An image container.
88 * @param aMimeType
89 * Type of encoded image desired (eg "image/png").
90 * @param aWidth, aHeight
91 * The size (in pixels) desired for the resulting image.
92 */
93 nsIInputStream encodeScaledImage(in imgIContainer aContainer,
94 in ACString aMimeType,
95 in long aWidth,
96 in long aHeight);
97 };