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