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