include/wincodec.idl

   1 /*
   2  * Copyright 2009 Vincent Povirk for CodeWeavers
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  17  */
  18
  19 import "wtypes.idl";
  20 import "propidl.idl";
  21 import "objidl.idl";
  22 import "ocidl.idl";
  23
  24 #define CODEC_FORCE_DWORD 0x7fffffff
  25
  26 typedef enum WICDecodeOptions {
  27     WICDecodeMetadataCacheOnDemand = 0x00000000,
  28     WICDecodeMetadataCacheOnLoad = 0x00000001,
  29     WICMETADATACACHEOPTION_FORCE_DWORD = CODEC_FORCE_DWORD
  30 } WICDecodeOptions;
  31
  32 typedef enum WICBitmapCreateCacheOption {
  33     WICBitmapNoCache = 0x00000000,
  34     WICBitmapCacheOnDemand = 0x00000001,
  35     WICBitmapCacheOnLoad = 0x00000002,
  36     WICBITMAPCREATECACHEOPTION_FORCE_DWORD = CODEC_FORCE_DWORD
  37 } WICBitmapCreateCacheOption;
  38
  39 typedef enum WICBitmapAlphaChannelOption {
  40     WICBitmapUseAlpha = 0x00000000,
  41     WICBitmapUsePremultipliedAlpha = 0x00000001,
  42     WICBitmapIgnoreAlpha = 0x00000002,
  43     WICBITMAPALPHACHANNELOPTIONS_FORCE_DWORD = CODEC_FORCE_DWORD
  44 } WICBitmapAlphaChannelOption;
  45
  46 typedef enum WICBitmapDecoderCapabilities {
  47     WICBitmapDecoderCapabilitySameEncoder = 0x00000001,
  48     WICBitmapDecoderCapabilityCanDecodeAllImages = 0x00000002,
  49     WICBitmapDecoderCapabilityCanDecodeSomeImages = 0x00000004,
  50     WICBitmapDecoderCapabilityCanEnumerateMetadata = 0x00000008,
  51     WICBitmapDecoderCapabilityCanDecodeThumbnail = 0x00000010,
  52 } WICBitmapDecoderCapabilities;
  53
  54 typedef GUID WICPixelFormatGUID;
  55 typedef REFGUID REFWICPixelFormatGUID;
  56
  57 cpp_quote("DEFINE_GUID(GUID_WICPixelFormatDontCare, 0x6fddc324,0x4e03,0x4bfe,0xb1,0x85,0x3d,0x77,0x76,0x8d,0xc9,0x00);")
  58 cpp_quote("#define GUID_WICPixelFormatUndefined GUID_WICPixelFormatDontCare")
  59
  60 cpp_quote("DEFINE_GUID(GUID_WICPixelFormat1bppIndexed, 0x6fddc324,0x4e03,0x4bfe,0xb1,0x85,0x3d,0x77,0x76,0x8d,0xc9,0x01);")
  61 cpp_quote("DEFINE_GUID(GUID_WICPixelFormat2bppIndexed, 0x6fddc324,0x4e03,0x4bfe,0xb1,0x85,0x3d,0x77,0x76,0x8d,0xc9,0x02);")
  62 cpp_quote("DEFINE_GUID(GUID_WICPixelFormat4bppIndexed, 0x6fddc324,0x4e03,0x4bfe,0xb1,0x85,0x3d,0x77,0x76,0x8d,0xc9,0x03);")
  63 cpp_quote("DEFINE_GUID(GUID_WICPixelFormat8bppIndexed, 0x6fddc324,0x4e03,0x4bfe,0xb1,0x85,0x3d,0x77,0x76,0x8d,0xc9,0x04);")
  64
  65 cpp_quote("DEFINE_GUID(GUID_WICPixelFormat16bppBGR555, 0x6fddc324,0x4e03,0x4bfe,0xb1,0x85,0x3d,0x77,0x76,0x8d,0xc9,0x09);")
  66 cpp_quote("DEFINE_GUID(GUID_WICPixelFormat24bppBGR, 0x6fddc324,0x4e03,0x4bfe,0xb1,0x85,0x3d,0x77,0x76,0x8d,0xc9,0x0c);")
  67 cpp_quote("DEFINE_GUID(GUID_WICPixelFormat32bppBGR, 0x6fddc324,0x4e03,0x4bfe,0xb1,0x85,0x3d,0x77,0x76,0x8d,0xc9,0x0e);")
  68
  69 typedef struct WICRect {
  70     INT X;
  71     INT Y;
  72     INT Width;
  73     INT Height;
  74 } WICRect;
  75
  76 cpp_quote("#define WINCODEC_ERR_WRONGSTATE 0x88982f04")
  77 cpp_quote("#define WINCODEC_ERR_CODECNOTHUMBNAIL 0x88982f44")
  78
  79 interface IWICBitmap;
  80 interface IWICComponentInfo;
  81 interface IWICBitmapEncoder;
  82 interface IWICPalette;
  83 interface IWICFormatConverter;
  84 interface IWICBitmapScaler;
  85 interface IWICBitmapClipper;
  86 interface IWICBitmapFlipRotator;
  87 interface IWICStream;
  88 interface IWICColorContext;
  89 interface IWICColorTransform;
  90 interface IWICFastMetadataEncoder;
  91 interface IWICMetadataQueryReader;
  92 interface IWICMetadataQueryWriter;
  93 interface IWICBitmapDecoderInfo;
  94
  95 [
  96     object,
  97     uuid(00000120-a8f2-4877-ba0a-fd2b6645fb94)
  98 ]
  99 interface IWICBitmapSource : IUnknown
 100 {
 101     HRESULT GetSize(
 102         [out] UINT *puiWidth,
 103         [out] UINT *puiHeight);
 104
 105     HRESULT GetPixelFormat(
 106         [out] WICPixelFormatGUID *pPixelFormat);
 107
 108     HRESULT GetResolution(
 109         [out] double *pDpiX,
 110         [out] double *pDpiY);
 111
 112     HRESULT CopyPalette(
 113         [in] IWICPalette *pIPalette);
 114
 115     HRESULT CopyPixels(
 116         [in] const WICRect *prc,
 117         [in] UINT cbStride,
 118         [in] UINT cbBufferSize,
 119         [out, size_is(cbBufferSize)] BYTE *pbBuffer);
 120 }
 121
 122 [
 123     object,
 124     uuid(3b16811b-6a43-4ec9-a813-3d930c13b940)
 125 ]
 126 interface IWICBitmapFrameDecode : IWICBitmapSource
 127 {
 128     HRESULT GetMetadataQueryReader(
 129         [out] IWICMetadataQueryReader **ppIMetadataQueryReader);
 130
 131     HRESULT GetColorContexts(
 132         [in] UINT cCount,
 133         [in, out, unique, size_is(cCount)] IWICColorContext **ppIColorContexts,
 134         [out] UINT *pcActualCount);
 135
 136     HRESULT GetThumbnail(
 137         [out] IWICBitmapSource **ppIThumbnail);
 138 }
 139
 140 [
 141     object,
 142     uuid(9edde9e7-8dee-47ea-99df-e6faf2ed44bf)
 143 ]
 144 interface IWICBitmapDecoder : IUnknown
 145 {
 146     HRESULT QueryCapability(
 147         [in] IStream *pIStream,
 148         [out] DWORD *pdwCapability);
 149
 150     HRESULT Initialize(
 151         [in] IStream *pIStream,
 152         [in] WICDecodeOptions cacheOptions);
 153
 154     HRESULT GetContainerFormat(
 155         [out] GUID *pguidContainerFormat);
 156
 157     HRESULT GetDecoderInfo(
 158         [out] IWICBitmapDecoderInfo **ppIDecoderInfo);
 159
 160     HRESULT CopyPalette(
 161         [in] IWICPalette *pIPalette);
 162
 163     HRESULT GetMetadataQueryReader(
 164         [out] IWICMetadataQueryReader **ppIMetadataQueryReader);
 165
 166     HRESULT GetPreview(
 167         [out] IWICBitmapSource **ppIBitmapSource);
 168
 169     HRESULT GetColorContexts(
 170         [in] UINT cCount,
 171         [in, out, unique, size_is(cCount)] IWICColorContext **ppIColorContexts,
 172         [out] UINT *pcActualCount);
 173
 174     HRESULT GetThumbnail(
 175         [out] IWICBitmapSource **ppIThumbnail);
 176
 177     HRESULT GetFrameCount(
 178         [out] UINT *pCount);
 179
 180     HRESULT GetFrame(
 181         [in] UINT index,
 182         [out] IWICBitmapFrameDecode **ppIBitmapFrame);
 183 }
 184
 185 cpp_quote("DEFINE_GUID(CLSID_WICImagingFactory, 0xcacaf262,0x9370,0x4615,0xa1,0x3b,0x9f,0x55,0x39,0xda,0x4c,0x0a);")
 186
 187 [
 188     object,
 189     uuid(ec5ec8a9-c395-4314-9c77-54d7a935ff70)
 190 ]
 191 interface IWICImagingFactory : IUnknown
 192 {
 193     HRESULT CreateDecoderFromFilename(
 194         [in] LPCWSTR wzFilename,
 195         [in, unique] const GUID *pguidVendor,
 196         [in] DWORD dwDesiredAccess,
 197         [in] WICDecodeOptions metadataOptions,
 198         [out, retval] IWICBitmapDecoder **ppIDecoder);
 199
 200     HRESULT CreateDecoderFromStream(
 201         [in] IStream *pIStream,
 202         [in, unique] const GUID *pguidVendor,
 203         [in] WICDecodeOptions metadataOptions,
 204         [out, retval] IWICBitmapDecoder **ppIDecoder);
 205
 206     HRESULT CreateDecoderFromFileHandle(
 207         [in] ULONG_PTR hFile,
 208         [in, unique] const GUID *pguidVendor,
 209         [in] WICDecodeOptions metadataOptions,
 210         [out, retval] IWICBitmapDecoder **ppIDecoder);
 211
 212     HRESULT CreateComponentInfo(
 213         [in] REFCLSID clsidComponent,
 214         [out] IWICComponentInfo **ppIInfo);
 215
 216     HRESULT CreateDecoder(
 217         [in] REFGUID guidContainerFormat,
 218         [in, unique] const GUID *pguidVendor,
 219         [out, retval] IWICBitmapDecoder **ppIDecoder);
 220
 221     HRESULT CreateEncoder(
 222         [in] REFGUID guidContainerFormat,
 223         [in, unique] const GUID *pguidVendor,
 224         [out, retval] IWICBitmapEncoder **ppIEncoder);
 225
 226     HRESULT CreatePalette(
 227         [out] IWICPalette **ppIPalette);
 228
 229     HRESULT CreateFormatConverter(
 230         [out] IWICFormatConverter **ppIFormatConverter);
 231
 232     HRESULT CreateBitmapScaler(
 233         [out] IWICBitmapScaler **ppIBitmapScaler);
 234
 235     HRESULT CreateBitmapClipper(
 236         [out] IWICBitmapClipper **ppIBitmapClipper);
 237
 238     HRESULT CreateBitmapFlipRotator(
 239         [out] IWICBitmapFlipRotator **ppIBitmapFlipRotator);
 240
 241     HRESULT CreateStream(
 242         [out] IWICStream **ppIWICStream);
 243
 244     HRESULT CreateColorContext(
 245         [out] IWICColorContext **ppIWICColorContext);
 246
 247     HRESULT CreateColorTransformer(
 248         [out] IWICColorTransform **ppIWICColorTransform);
 249
 250     HRESULT CreateBitmap(
 251         [in] UINT uiWidth,
 252         [in] UINT uiHeight,
 253         [in] REFWICPixelFormatGUID pixelFormat,
 254         [in] WICBitmapCreateCacheOption option,
 255         [out] IWICBitmap **ppIBitmap);
 256
 257     HRESULT CreateBitmapFromSource(
 258         [in] IWICBitmapSource *piBitmapSource,
 259         [in] WICBitmapCreateCacheOption option,
 260         [out] IWICBitmap **ppIBitmap);
 261
 262     HRESULT CreateBitmapFromSourceRect(
 263         [in] IWICBitmapSource *piBitmapSource,
 264         [in] UINT x,
 265         [in] UINT y,
 266         [in] UINT width,
 267         [in] UINT height,
 268         [out] IWICBitmap **ppIBitmap);
 269
 270     HRESULT CreateBitmapFromMemory(
 271         [in] UINT uiWidth,
 272         [in] UINT uiHeight,
 273         [in] REFWICPixelFormatGUID pixelFormat,
 274         [in] UINT cbStride,
 275         [in] UINT cbBufferSize,
 276         [in, size_is(cbBufferSize)] BYTE *pbBuffer,
 277         [out] IWICBitmap **ppIBitmap);
 278
 279     HRESULT CreateBitmapFromHBITMAP(
 280         [in] HBITMAP hBitmap,
 281         [in, unique] HPALETTE hPalette,
 282         [in] WICBitmapAlphaChannelOption options,
 283         [out] IWICBitmap **ppIBitmap);
 284
 285     HRESULT CreateBitmapFromHICON(
 286         [in] HICON hIcon,
 287         [out] IWICBitmap **ppIBitmap);
 288
 289     HRESULT CreateComponentEnumerator(
 290         [in] DWORD componentTypes,
 291         [in] DWORD options,
 292         [out] IEnumUnknown **ppIEnumUnknown);
 293
 294     HRESULT CreateFastMetadataEncoderFromDecoder(
 295         [in] IWICBitmapDecoder *pIDecoder,
 296         [out] IWICFastMetadataEncoder **ppIFastEncoder);
 297
 298     HRESULT CreateFastMetadataEncoderFromFrameDecode(
 299         [in] IWICBitmapFrameDecode *pIFrameDecoder,
 300         [out] IWICFastMetadataEncoder **ppIFastEncoder);
 301
 302     HRESULT CreateQueryWriter(
 303         [in] REFGUID guidMetadataFormat,
 304         [in, unique] const GUID *pguidVendor,
 305         [out] IWICMetadataQueryWriter **ppIQueryWriter);
 306
 307     HRESULT CreateQueryWriterFromReader(
 308         [in] IWICMetadataQueryReader *pIQueryReader,
 309         [in, unique] const GUID *pguidVendor,
 310         [out] IWICMetadataQueryWriter **ppIQueryWriter);
 311 }
 312
 313 cpp_quote("DEFINE_GUID(CLSID_WICBmpDecoder, 0x6b462062,0x7cbf,0x400d,0x9f,0xdb,0x81,0x3d,0xd1,0x0f,0x27,0x78);")
 314 cpp_quote("DEFINE_GUID(CLSID_WICPngDecoder, 0x389ea17b,0x5078,0x4cde,0xb6,0xef,0x25,0xc1,0x51,0x75,0xc7,0x51);")
 315 cpp_quote("DEFINE_GUID(CLSID_WICIcoDecoder, 0xc61bfcdf,0x2e0f,0x4aad,0xa8,0xd7,0xe0,0x6b,0xaf,0xeb,0xcd,0xfe);")
 316 cpp_quote("DEFINE_GUID(CLSID_WICJpegDecoder, 0x9456a480,0xe88b,0x43ea,0x9e,0x73,0x0b,0x2d,0x9b,0x71,0xb1,0xca);")
 317 cpp_quote("DEFINE_GUID(CLSID_WICGifDecoder, 0x381dda3c,0x9ce9,0x4834,0xa2,0x3e,0x1f,0x98,0xf8,0xfc,0x52,0xbe);")
 318 cpp_quote("DEFINE_GUID(CLSID_WICTiffDecoder, 0xb54e85d9,0xfe23,0x499f,0x8b,0x88,0x6a,0xce,0xa7,0x13,0x75,0x2b);")
 319 cpp_quote("DEFINE_GUID(CLSID_WICWmpDecoder, 0xa26cec36,0x234c,0x4950,0xae,0x16,0xe3,0x4a,0xac,0xe7,0x1d,0x0d);")
 320
 321 cpp_quote("DEFINE_GUID(GUID_ContainerFormatBmp, 0x0af1d87e,0xfcfe,0x4188,0xbd,0xeb,0xa7,0x90,0x64,0x71,0xcb,0xe3);")
 322 cpp_quote("DEFINE_GUID(GUID_ContainerFormatPng, 0x1b7cfaf4,0x713f,0x473c,0xbb,0xcd,0x61,0x37,0x42,0x5f,0xae,0xaf);")
 323 cpp_quote("DEFINE_GUID(GUID_ContainerFormatIco, 0xa3a860c4,0x338f,0x4c17,0x91,0x9a,0xfb,0xa4,0xb5,0x62,0x8f,0x21);")
 324 cpp_quote("DEFINE_GUID(GUID_ContainerFormatJpeg, 0x19e4a5aa,0x5662,0x4fc5,0xa0,0xc0,0x17,0x58,0x02,0x8e,0x10,0x57);")
 325 cpp_quote("DEFINE_GUID(GUID_ContainerFormatTiff, 0x163bcc30,0xe2e9,0x4f0b,0x96,0x1d,0xa3,0xe9,0xfd,0xb7,0x88,0xa3);")
 326 cpp_quote("DEFINE_GUID(GUID_ContainerFormatGif, 0x1f8a5601,0x7d4d,0x4cbd,0x9c,0x82,0x1b,0xc8,0xd4,0xee,0xb9,0xa5);")
 327 cpp_quote("DEFINE_GUID(GUID_ContainerFormatWmp, 0x57a37caa,0x367a,0x4540,0x91,0x6b,0xf1,0x83,0xc5,0x09,0x3a,0x4b);")