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_MetadataFormatIfd, 0x537396c6,0x2d8a,0x4bb6,0x9b,0xf8,0x2f,0x0a,0x8e,0x2a,0x3a,0xdf);")
  41
  42 cpp_quote("DEFINE_GUID(CLSID_WICUnknownMetadataReader, 0x699745c2,0x5066,0x4b82,0xa8,0xe3,0xd4,0x04,0x78,0xdb,0xec,0x8c);")
  43 cpp_quote("DEFINE_GUID(CLSID_WICUnknownMetadataWriter, 0xa09cca86,0x27ba,0x4f39,0x90,0x53,0x12,0x1f,0xa4,0xdc,0x08,0xfc);")
  44 cpp_quote("DEFINE_GUID(CLSID_WICPngTextMetadataReader, 0x4b59afcc,0xb8c3,0x408a,0xb6,0x70,0x89,0xe5,0xfa,0xb6,0xfd,0xa7);")
  45 cpp_quote("DEFINE_GUID(CLSID_WICPngTextMetadataWriter, 0xb5ebafb9,0x253e,0x4a72,0xa7,0x44,0x07,0x62,0xd2,0x68,0x56,0x83);")
  46 cpp_quote("DEFINE_GUID(CLSID_WICIfdMetadataReader, 0x8f914656,0x9d0a,0x4eb2,0x90,0x19,0x0b,0xf9,0x6d,0x8a,0x9e,0xe6);")
  47
  48 [
  49     object,
  50     uuid(aba958bf-c672-44d1-8d61-ce6df2e682c2)
  51 ]
  52 interface IWICMetadataHandlerInfo : IWICComponentInfo
  53 {
  54     HRESULT GetMetadataFormat(
  55         [out] GUID *pguidMetadataFormat);
  56
  57     HRESULT GetContainerFormats(
  58         [in] UINT cContainerFormats,
  59         [in, out, unique, size_is(cContainerFormats)] GUID *pguidContainerFormats,
  60         [out] UINT *pcchActual);
  61
  62     HRESULT GetDeviceManufacturer(
  63         [in] UINT cchDeviceManufacturer,
  64         [in, out, unique, size_is(cchDeviceManufacturer)] WCHAR *wzDeviceManufacturer,
  65         [out] UINT *pcchActual);
  66
  67     HRESULT GetDeviceModels(
  68         [in] UINT cchDeviceModels,
  69         [in, out, unique, size_is(cchDeviceModels)] WCHAR *wzDeviceModels,
  70         [out] UINT *pcchActual);
  71
  72     HRESULT DoesRequireFullStream(
  73         [out] BOOL *pfRequiresFullStream);
  74
  75     HRESULT DoesSupportPadding(
  76         [out] BOOL *pfSupportsPadding);
  77
  78     HRESULT DoesRequireFixedSize(
  79         [out] BOOL *pfFixedSize);
  80 }
  81
  82 [
  83     object,
  84     uuid(9204fe99-d8fc-4fd5-a001-9536b067a899)
  85 ]
  86 interface IWICMetadataReader : IUnknown
  87 {
  88     HRESULT GetMetadataFormat(
  89         [out] GUID *pguidMetadataFormat);
  90
  91     HRESULT GetMetadataHandlerInfo(
  92         [out] IWICMetadataHandlerInfo **ppIHandler);
  93
  94     HRESULT GetCount(
  95         [out] UINT *pcCount);
  96
  97     HRESULT GetValueByIndex(
  98         [in] UINT nIndex,
  99         [in, out, unique] PROPVARIANT *pvarSchema,
 100         [in, out, unique] PROPVARIANT *pvarId,
 101         [in, out, unique] PROPVARIANT *pvarValue);
 102
 103     HRESULT GetValue(
 104         [in] const PROPVARIANT *pvarSchema,
 105         [in] const PROPVARIANT *pvarId,
 106         [in, out, unique] PROPVARIANT *pvarValue);
 107
 108     HRESULT GetEnumerator(
 109         [out] IWICEnumMetadataItem **ppIEnumMetadata);
 110 }
 111
 112 [
 113     object,
 114     uuid(f7836e16-3be0-470b-86bb-160d0aecd7de)
 115 ]
 116 interface IWICMetadataWriter : IWICMetadataReader
 117 {
 118     HRESULT SetValue(
 119         [in, unique] const PROPVARIANT *pvarSchema,
 120         [in] const PROPVARIANT *pvarId,
 121         [in] const PROPVARIANT *pvarValue);
 122
 123     HRESULT SetValueByIndex(
 124         [in] UINT nIndex,
 125         [in, unique] const PROPVARIANT *pvarSchema,
 126         [in] const PROPVARIANT *pvarId,
 127         [in] const PROPVARIANT *pvarValue);
 128
 129     HRESULT RemoveValue(
 130         [in, unique] const PROPVARIANT *pvarSchema,
 131         [in] const PROPVARIANT *pvarId);
 132
 133     HRESULT RemoveValueByIndex(
 134         [in] UINT nIndex);
 135 }
 136
 137 [
 138     object,
 139     uuid(feaa2a8d-b3f3-43e4-b25c-d1de990a1ae1)
 140 ]
 141 interface IWICMetadataBlockReader : IUnknown
 142 {
 143     HRESULT GetContainerFormat(
 144         [out] GUID *pguidContainerFormat);
 145
 146     HRESULT GetCount(
 147         [out] UINT *pcCount);
 148
 149     HRESULT GetReaderByIndex(
 150         [in] UINT nIndex,
 151         [out] IWICMetadataReader **ppIMetadataReader);
 152
 153     HRESULT GetEnumerator(
 154         [out] IEnumUnknown **ppIEnumMetadata);
 155 }
 156
 157 [
 158     object,
 159     uuid(08fb9676-b444-41e8-8dbe-6a53a542bff1)
 160 ]
 161 interface IWICMetadataBlockWriter : IWICMetadataBlockReader
 162 {
 163     HRESULT InitializeFromBlockReader(
 164         [in] IWICMetadataBlockReader *pIMDBlockReader);
 165
 166     HRESULT GetWriterByIndex(
 167         [in] UINT nIndex,
 168         [out] IWICMetadataWriter **ppIMetadataWriter);
 169
 170     HRESULT AddWriter(
 171         [in] IWICMetadataWriter *pIMetadataWriter);
 172
 173     HRESULT SetWriterByIndex(
 174         [in] UINT nIndex,
 175         [in] IWICMetadataWriter *pIMetadataWriter);
 176
 177     HRESULT RemoveWriterByIndex(
 178         [in] UINT nIndex);
 179 }
 180
 181 [
 182     object,
 183     uuid(00675040-6908-45f8-86a3-49c7dfd6d9ad)
 184 ]
 185 interface IWICPersistStream : IPersistStream
 186 {
 187     HRESULT LoadEx(
 188         [in, unique] IStream *pIStream,
 189         [in, unique] const GUID *pguidPreferredVendor,
 190         [in] DWORD dwPersistOptions);
 191
 192     HRESULT SaveEx(
 193         [in] IStream *pIStream,
 194         [in] DWORD dwPersistOptions,
 195         [in] BOOL fClearDirty);
 196 }
 197
 198 [
 199     object,
 200     uuid(412d0c3a-9650-44fa-af5b-dd2a06c8e8fb)
 201 ]
 202 interface IWICComponentFactory : IWICImagingFactory
 203 {
 204     HRESULT CreateMetadataReader(
 205         [in] REFGUID guidMetadataFormat,
 206         [in, unique] const GUID *pguidVendor,
 207         [in] DWORD dwOptions,
 208         [in] IStream *pIStream,
 209         [out] IWICMetadataReader **ppIReader);
 210
 211     HRESULT CreateMetadataReaderFromContainer(
 212         [in] REFGUID guidMetadataFormat,
 213         [in, unique] const GUID *pguidVendor,
 214         [in] DWORD dwOptions,
 215         [in] IStream *pIStream,
 216         [out] IWICMetadataReader **ppIReader);
 217
 218     HRESULT CreateMetadataWriter(
 219         [in] REFGUID guidMetadataFormat,
 220         [in, unique] const GUID *pguidVendor,
 221         [in] DWORD dwMetadataOptions,
 222         [out] IWICMetadataWriter **ppIWriter);
 223
 224     HRESULT CreateMetadataWriterFromReader(
 225         [in] IWICMetadataReader *pIReader,
 226         [in, unique] const GUID *pguidVendor,
 227         [out] IWICMetadataWriter **ppIWriter);
 228
 229     HRESULT CreateQueryReaderFromBlockReader(
 230         [in] IWICMetadataBlockReader *pIBlockReader,
 231         [out] IWICMetadataQueryReader **ppIQueryReader);
 232
 233     HRESULT CreateQueryWriterFromBlockWriter(
 234         [in] IWICMetadataBlockWriter *pIBlockWriter,
 235         [out] IWICMetadataQueryWriter **ppIQueryWriter);
 236
 237     HRESULT CreateEncoderPropertyBag(
 238         [in, unique, size_is(cCount)] PROPBAG2 *ppropOptions,
 239         [in] UINT cCount,
 240         [out] IPropertyBag2 **ppIPropertyBag);
 241 }