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