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