include/wincodecsdk.idl

   1 /*
   2  * Copyright 2011 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 "wincodec.idl";
  21
  22 typedef enum WICPersistOptions {
  23     WICPersistOptionsDefault = 0x00000000,
  24     WICPersistOptionsLittleEndian = 0x00000000,
  25     WICPersistOptionsBigEndian = 0x00000001,
  26     WICPersistOptionsStrictFormat = 0x00000002,
  27     WICPersistOptionsNoCacheStream = 0x00000004,
  28     WICPersistOptionPreferUTF8 = 0x00000008,
  29     WICPersistOptionsMask = 0x0000FFFF
  30 } WICPersistOptions;
  31
  32 typedef enum WICMetadataCreationOptions {
  33     WICMetadataCreationDefault = 0x00000000,
  34     WICMetadataCreationAllowUnknown = WICMetadataCreationDefault,
  35     WICMetadataCreationFailUnknown = 0x00010000,
  36     WICMetadataCreationMask = 0xFFFF0000
  37 } WICMetadataCreationOptions;
  38
  39 cpp_quote("DEFINE_GUID(GUID_MetadataFormatUnknown, 0xa45e592f,0x9078,0x4a7c,0xad,0xb5,0x4e,0xdc,0x4f,0xd6,0x1b,0x1f);")
  40 cpp_quote("DEFINE_GUID(GUID_MetadataFormatChunkcHRM, 0x9db3655b,0x2842,0x44b3,0x80,0x67,0x12,0xe9,0xb3,0x75,0x55,0x6a);")
  41 cpp_quote("DEFINE_GUID(GUID_MetadataFormatChunkgAMA, 0xf00935a5,0x1d5d,0x4cd1,0x81,0xb2,0x93,0x24,0xd7,0xec,0xa7,0x81);")
  42 cpp_quote("DEFINE_GUID(GUID_MetadataFormatChunktEXt, 0x568d8936,0xc0a9,0x4923,0x90,0x5d,0xdf,0x2b,0x38,0x23,0x8f,0xbc);")
  43 cpp_quote("DEFINE_GUID(GUID_MetadataFormatChunktIME, 0x6b00ae2d,0xe24b,0x460a,0x98,0xb6,0x87,0x8b,0xd0,0x30,0x72,0xfd);")
  44 cpp_quote("DEFINE_GUID(GUID_MetadataFormatIfd, 0x537396c6,0x2d8a,0x4bb6,0x9b,0xf8,0x2f,0x0a,0x8e,0x2a,0x3a,0xdf);")
  45 cpp_quote("DEFINE_GUID(GUID_MetadataFormatExif, 0x1c3c4f9d,0xb84a,0x467d,0x94,0x93,0x36,0xcf,0xbd,0x59,0xea,0x57);")
  46 cpp_quote("DEFINE_GUID(GUID_MetadataFormatXMP, 0xbb5acc38,0xf216,0x4cec,0xa6,0xc5,0x5f,0x6e,0x73,0x97,0x63,0xa9);")
  47 cpp_quote("DEFINE_GUID(GUID_MetadataFormatXMPStruct, 0x22383cf1,0xed17,0x4e2e,0xaf,0x17,0xd8,0x5b,0x8f,0x6b,0x30,0xd0);")
  48 cpp_quote("DEFINE_GUID(GUID_MetadataFormatIMD, 0xbd2bb086,0x4d52,0x48dd,0x96,0x77,0xdb,0x48,0x3e,0x85,0xae,0x8f);")
  49 cpp_quote("DEFINE_GUID(GUID_MetadataFormatLSD, 0xe256031e,0x6299,0x4929,0xb9,0x8d,0x5a,0xc8,0x84,0xaf,0xba,0x92);")
  50 cpp_quote("DEFINE_GUID(GUID_MetadataFormatGCE, 0x2a25cad8,0xdeeb,0x4c69,0xa7,0x88,0x0e,0xc2,0x26,0x6d,0xca,0xfd);")
  51 cpp_quote("DEFINE_GUID(GUID_MetadataFormatAPE, 0x2e043dc2,0xc967,0x4e05,0x87,0x5e,0x61,0x8b,0xf6,0x7e,0x85,0xc3);")
  52 cpp_quote("DEFINE_GUID(GUID_MetadataFormatGifComment, 0xc4b6e0e0,0xcfb4,0x4ad3,0xab,0x33,0x9a,0xad,0x23,0x55,0xa3,0x4a);")
  53
  54 cpp_quote("DEFINE_GUID(CLSID_WICUnknownMetadataReader, 0x699745c2,0x5066,0x4b82,0xa8,0xe3,0xd4,0x04,0x78,0xdb,0xec,0x8c);")
  55 cpp_quote("DEFINE_GUID(CLSID_WICUnknownMetadataWriter, 0xa09cca86,0x27ba,0x4f39,0x90,0x53,0x12,0x1f,0xa4,0xdc,0x08,0xfc);")
  56 cpp_quote("DEFINE_GUID(CLSID_WICPngChrmMetadataReader, 0xf90b5f36,0x367b,0x402a,0x9d,0xd1,0xbc,0x0f,0xd5,0x9d,0x8f,0x62);")
  57 cpp_quote("DEFINE_GUID(CLSID_WICPngGamaMetadataReader, 0x3692ca39,0xe082,0x4350,0x9e,0x1f,0x37,0x04,0xcb,0x08,0x3c,0xd5);")
  58 cpp_quote("DEFINE_GUID(CLSID_WICPngTextMetadataReader, 0x4b59afcc,0xb8c3,0x408a,0xb6,0x70,0x89,0xe5,0xfa,0xb6,0xfd,0xa7);")
  59 cpp_quote("DEFINE_GUID(CLSID_WICPngTextMetadataWriter, 0xb5ebafb9,0x253e,0x4a72,0xa7,0x44,0x07,0x62,0xd2,0x68,0x56,0x83);")
  60 cpp_quote("DEFINE_GUID(CLSID_WICIfdMetadataReader, 0x8f914656,0x9d0a,0x4eb2,0x90,0x19,0x0b,0xf9,0x6d,0x8a,0x9e,0xe6);")
  61 cpp_quote("DEFINE_GUID(CLSID_WICIfdMetadataWriter, 0xb1ebfc28,0xc9bd,0x47a2,0x8d,0x33,0xb9,0x48,0x76,0x97,0x77,0xa7);")
  62 cpp_quote("DEFINE_GUID(CLSID_WICExifMetadataReader, 0xd9403860,0x297f,0x4a49,0xbf,0x9b,0x77,0x89,0x81,0x50,0xa4,0x42);")
  63 cpp_quote("DEFINE_GUID(CLSID_WICExifMetadataWriter, 0xc9a14cda,0xc339,0x460b,0x90,0x78,0xd4,0xde,0xbc,0xfa,0xbe,0x91);")
  64 cpp_quote("DEFINE_GUID(CLSID_WICXMPStructMetadataReader, 0x01b90d9a,0x8209,0x47f7,0x9c,0x52,0xe1,0x24,0x4b,0xf5,0x0c,0xed);")
  65 cpp_quote("DEFINE_GUID(CLSID_WICXMPStructMetadataWriter, 0x22c21f93,0x7ddb,0x411c,0x9b,0x17,0xc5,0xb7,0xbd,0x06,0x4a,0xbc);")
  66 cpp_quote("DEFINE_GUID(CLSID_WICLSDMetadataReader, 0x41070793,0x59e4,0x479a,0xa1,0xf7,0x95,0x4a,0xdc,0x2e,0xf5,0xfc);")
  67 cpp_quote("DEFINE_GUID(CLSID_WICLSDMetadataWriter, 0x73c037e7,0xe5d9,0x4954,0x87,0x6a,0x6d,0xa8,0x1d,0x6e,0x57,0x68);")
  68 cpp_quote("DEFINE_GUID(CLSID_WICIMDMetadataReader, 0x7447a267,0x0015,0x42c8,0xa8,0xf1,0xfb,0x3b,0x94,0xc6,0x83,0x61);")
  69 cpp_quote("DEFINE_GUID(CLSID_WICIMDMetadataWriter, 0x8c89071f,0x452e,0x4e95,0x96,0x82,0x9d,0x10,0x24,0x62,0x71,0x72);")
  70 cpp_quote("DEFINE_GUID(CLSID_WICGCEMetadataReader, 0xb92e345d,0xf52d,0x41f3,0xb5,0x62,0x08,0x1b,0xc7,0x72,0xe3,0xb9);")
  71 cpp_quote("DEFINE_GUID(CLSID_WICGCEMetadataWriter, 0xaf95dc76,0x16b2,0x47f4,0xb3,0xea,0x3c,0x31,0x79,0x66,0x93,0xe7);")
  72 cpp_quote("DEFINE_GUID(CLSID_WICAPEMetadataReader, 0x1767b93a,0xb021,0x44ea,0x92,0x0f,0x86,0x3c,0x11,0xf4,0xf7,0x68);")
  73 cpp_quote("DEFINE_GUID(CLSID_WICAPEMetadataWriter, 0xbd6edfca,0x2890,0x482f,0xb2,0x33,0x8d,0x73,0x39,0xa1,0xcf,0x8d);")
  74 cpp_quote("DEFINE_GUID(CLSID_WICGifCommentMetadataReader, 0x32557d3b,0x69dc,0x4f95,0x83,0x6e,0xf5,0x97,0x2b,0x2f,0x61,0x59);")
  75 cpp_quote("DEFINE_GUID(CLSID_WICGifCommentMetadataWriter, 0xa02797fc,0xc4ae,0x418c,0xaf,0x95,0xe6,0x37,0xc7,0xea,0xd2,0xa1);")
  76
  77 typedef struct WICMetadataPattern {
  78     ULARGE_INTEGER Position;
  79     ULONG Length;
  80     BYTE *Pattern;
  81     BYTE *Mask;
  82     ULARGE_INTEGER DataOffset;
  83 } WICMetadataPattern;
  84
  85 typedef struct WICMetadataHeader {
  86     ULARGE_INTEGER Position;
  87     ULONG Length;
  88     BYTE *Header;
  89     ULARGE_INTEGER DataOffset;
  90 } WICMetadataHeader;
  91
  92 [
  93     object,
  94     uuid(aba958bf-c672-44d1-8d61-ce6df2e682c2)
  95 ]
  96 interface IWICMetadataHandlerInfo : IWICComponentInfo
  97 {
  98     HRESULT GetMetadataFormat(
  99         [out] GUID *pguidMetadataFormat);
 100
 101     HRESULT GetContainerFormats(
 102         [in] UINT cContainerFormats,
 103         [in, out, unique, size_is(cContainerFormats)] GUID *pguidContainerFormats,
 104         [out] UINT *pcchActual);
 105
 106     HRESULT GetDeviceManufacturer(
 107         [in] UINT cchDeviceManufacturer,
 108         [in, out, unique, size_is(cchDeviceManufacturer)] WCHAR *wzDeviceManufacturer,
 109         [out] UINT *pcchActual);
 110
 111     HRESULT GetDeviceModels(
 112         [in] UINT cchDeviceModels,
 113         [in, out, unique, size_is(cchDeviceModels)] WCHAR *wzDeviceModels,
 114         [out] UINT *pcchActual);
 115
 116     HRESULT DoesRequireFullStream(
 117         [out] BOOL *pfRequiresFullStream);
 118
 119     HRESULT DoesSupportPadding(
 120         [out] BOOL *pfSupportsPadding);
 121
 122     HRESULT DoesRequireFixedSize(
 123         [out] BOOL *pfFixedSize);
 124 }
 125
 126 [
 127     object,
 128     uuid(9204fe99-d8fc-4fd5-a001-9536b067a899)
 129 ]
 130 interface IWICMetadataReader : IUnknown
 131 {
 132     HRESULT GetMetadataFormat(
 133         [out] GUID *pguidMetadataFormat);
 134
 135     HRESULT GetMetadataHandlerInfo(
 136         [out] IWICMetadataHandlerInfo **ppIHandler);
 137
 138     HRESULT GetCount(
 139         [out] UINT *pcCount);
 140
 141     HRESULT GetValueByIndex(
 142         [in] UINT nIndex,
 143         [in, out, unique] PROPVARIANT *pvarSchema,
 144         [in, out, unique] PROPVARIANT *pvarId,
 145         [in, out, unique] PROPVARIANT *pvarValue);
 146
 147     HRESULT GetValue(
 148         [in] const PROPVARIANT *pvarSchema,
 149         [in] const PROPVARIANT *pvarId,
 150         [in, out, unique] PROPVARIANT *pvarValue);
 151
 152     HRESULT GetEnumerator(
 153         [out] IWICEnumMetadataItem **ppIEnumMetadata);
 154 }
 155
 156 [
 157     object,
 158     uuid(eebf1f5b-07c1-4447-a3ab-22acaf78a804)
 159 ]
 160 interface IWICMetadataReaderInfo : IWICMetadataHandlerInfo
 161 {
 162     [local]
 163     HRESULT GetPatterns(
 164         [in] REFGUID guidContainerFormat,
 165         [in] UINT cbSize,
 166         [out, unique] WICMetadataPattern *pPattern,
 167         [out, unique] UINT *pcCount,
 168         [out, unique] UINT *pcbActual);
 169
 170     HRESULT MatchesPattern(
 171         [in] REFGUID guidContainerFormat,
 172         [in] IStream *pIStream,
 173         [out] BOOL *pfMatches);
 174
 175     HRESULT CreateInstance(
 176         [out] IWICMetadataReader **ppIReader);
 177 }
 178
 179 [
 180     object,
 181     uuid(f7836e16-3be0-470b-86bb-160d0aecd7de)
 182 ]
 183 interface IWICMetadataWriter : IWICMetadataReader
 184 {
 185     HRESULT SetValue(
 186         [in, unique] const PROPVARIANT *pvarSchema,
 187         [in] const PROPVARIANT *pvarId,
 188         [in] const PROPVARIANT *pvarValue);
 189
 190     HRESULT SetValueByIndex(
 191         [in] UINT nIndex,
 192         [in, unique] const PROPVARIANT *pvarSchema,
 193         [in] const PROPVARIANT *pvarId,
 194         [in] const PROPVARIANT *pvarValue);
 195
 196     HRESULT RemoveValue(
 197         [in, unique] const PROPVARIANT *pvarSchema,
 198         [in] const PROPVARIANT *pvarId);
 199
 200     HRESULT RemoveValueByIndex(
 201         [in] UINT nIndex);
 202 }
 203
 204 [
 205     object,
 206     uuid(b22e3fba-3925-4323-b5c1-9ebfc430f236)
 207 ]
 208 interface IWICMetadataWriterInfo : IWICMetadataHandlerInfo
 209 {
 210     [local]
 211     HRESULT GetHeader(
 212         [in] REFGUID guidContainerFormat,
 213         [in] UINT cbSize,
 214         [out, unique] WICMetadataHeader *pHeader,
 215         [out, unique] UINT *pcbActual);
 216
 217     HRESULT CreateInstance(
 218         [out] IWICMetadataWriter **ppIWriter);
 219 }
 220
 221 [
 222     object,
 223     uuid(feaa2a8d-b3f3-43e4-b25c-d1de990a1ae1)
 224 ]
 225 interface IWICMetadataBlockReader : IUnknown
 226 {
 227     HRESULT GetContainerFormat(
 228         [out] GUID *pguidContainerFormat);
 229
 230     HRESULT GetCount(
 231         [out] UINT *pcCount);
 232
 233     HRESULT GetReaderByIndex(
 234         [in] UINT nIndex,
 235         [out] IWICMetadataReader **ppIMetadataReader);
 236
 237     HRESULT GetEnumerator(
 238         [out] IEnumUnknown **ppIEnumMetadata);
 239 }
 240
 241 [
 242     object,
 243     uuid(08fb9676-b444-41e8-8dbe-6a53a542bff1)
 244 ]
 245 interface IWICMetadataBlockWriter : IWICMetadataBlockReader
 246 {
 247     HRESULT InitializeFromBlockReader(
 248         [in] IWICMetadataBlockReader *pIMDBlockReader);
 249
 250     HRESULT GetWriterByIndex(
 251         [in] UINT nIndex,
 252         [out] IWICMetadataWriter **ppIMetadataWriter);
 253
 254     HRESULT AddWriter(
 255         [in] IWICMetadataWriter *pIMetadataWriter);
 256
 257     HRESULT SetWriterByIndex(
 258         [in] UINT nIndex,
 259         [in] IWICMetadataWriter *pIMetadataWriter);
 260
 261     HRESULT RemoveWriterByIndex(
 262         [in] UINT nIndex);
 263 }
 264
 265 [
 266     object,
 267     uuid(00675040-6908-45f8-86a3-49c7dfd6d9ad)
 268 ]
 269 interface IWICPersistStream : IPersistStream
 270 {
 271     HRESULT LoadEx(
 272         [in, unique] IStream *pIStream,
 273         [in, unique] const GUID *pguidPreferredVendor,
 274         [in] DWORD dwPersistOptions);
 275
 276     HRESULT SaveEx(
 277         [in] IStream *pIStream,
 278         [in] DWORD dwPersistOptions,
 279         [in] BOOL fClearDirty);
 280 }
 281
 282 [
 283     object,
 284     uuid(412d0c3a-9650-44fa-af5b-dd2a06c8e8fb)
 285 ]
 286 interface IWICComponentFactory : IWICImagingFactory
 287 {
 288     HRESULT CreateMetadataReader(
 289         [in] REFGUID guidMetadataFormat,
 290         [in, unique] const GUID *pguidVendor,
 291         [in] DWORD dwOptions,
 292         [in] IStream *pIStream,
 293         [out] IWICMetadataReader **ppIReader);
 294
 295     HRESULT CreateMetadataReaderFromContainer(
 296         [in] REFGUID guidMetadataFormat,
 297         [in, unique] const GUID *pguidVendor,
 298         [in] DWORD dwOptions,
 299         [in] IStream *pIStream,
 300         [out] IWICMetadataReader **ppIReader);
 301
 302     HRESULT CreateMetadataWriter(
 303         [in] REFGUID guidMetadataFormat,
 304         [in, unique] const GUID *pguidVendor,
 305         [in] DWORD dwMetadataOptions,
 306         [out] IWICMetadataWriter **ppIWriter);
 307
 308     HRESULT CreateMetadataWriterFromReader(
 309         [in] IWICMetadataReader *pIReader,
 310         [in, unique] const GUID *pguidVendor,
 311         [out] IWICMetadataWriter **ppIWriter);
 312
 313     HRESULT CreateQueryReaderFromBlockReader(
 314         [in] IWICMetadataBlockReader *pIBlockReader,
 315         [out] IWICMetadataQueryReader **ppIQueryReader);
 316
 317     HRESULT CreateQueryWriterFromBlockWriter(
 318         [in] IWICMetadataBlockWriter *pIBlockWriter,
 319         [out] IWICMetadataQueryWriter **ppIQueryWriter);
 320
 321     HRESULT CreateEncoderPropertyBag(
 322         [in, unique, size_is(cCount)] PROPBAG2 *ppropOptions,
 323         [in] UINT cCount,
 324         [out] IPropertyBag2 **ppIPropertyBag);
 325 }