/image/public/imgITools.idl

http://github.com/zpao/v8monkey · IDL · 104 lines · 18 code · 5 blank · 81 comment · 0 complexity · 598903b9d1e2cbef0104b8060a69aeb3 MD5 · raw file

  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 Foundation.
  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. #include "nsISupports.idl"
  39. interface nsIInputStream;
  40. interface imgIContainer;
  41. [scriptable, uuid(1f19a2ce-cf5c-4a6b-8ba7-63785b45053f)]
  42. interface imgITools : nsISupports
  43. {
  44. /**
  45. * decodeImageData
  46. * Caller provides an input stream and mimetype. We read from the stream
  47. * and decompress it (according to the specified mime type) and return
  48. * the resulting imgIContainer. (If the caller already has a container,
  49. * it can be provided as input to be reused).
  50. *
  51. * @param aStream
  52. * An input stream for an encoded image file.
  53. * @param aMimeType
  54. * Type of image in the stream.
  55. * @param aContainer
  56. * An imgIContainer holding the decoded image. Specify |null| when
  57. * calling to have one created, otherwise specify a container to
  58. * be used. It is an error to pass an already-initialized container
  59. * as aContainer.
  60. */
  61. void decodeImageData(in nsIInputStream aStream,
  62. in ACString aMimeType,
  63. inout imgIContainer aContainer);
  64. /**
  65. * encodeImage
  66. * Caller provides an image container, and the mime type it should be
  67. * encoded to. We return an input stream for the encoded image data.
  68. *
  69. * @param aContainer
  70. * An image container.
  71. * @param aMimeType
  72. * Type of encoded image desired (eg "image/png").
  73. * @param outputOptions
  74. * Encoder-specific output options.
  75. */
  76. nsIInputStream encodeImage(in imgIContainer aContainer,
  77. in ACString aMimeType,
  78. [optional] in AString outputOptions);
  79. /**
  80. * encodeScaledImage
  81. * Caller provides an image container, and the mime type it should be
  82. * encoded to. We return an input stream for the encoded image data.
  83. * The encoded image is scaled to the specified dimensions.
  84. *
  85. * @param aContainer
  86. * An image container.
  87. * @param aMimeType
  88. * Type of encoded image desired (eg "image/png").
  89. * @param aWidth, aHeight
  90. * The size (in pixels) desired for the resulting image.
  91. * @param outputOptions
  92. * Encoder-specific output options.
  93. */
  94. nsIInputStream encodeScaledImage(in imgIContainer aContainer,
  95. in ACString aMimeType,
  96. in long aWidth,
  97. in long aHeight,
  98. [optional] in AString outputOptions);
  99. };