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