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 [
  38     object,
  39     uuid(aba958bf-c672-44d1-8d61-ce6df2e682c2)
  40 ]
  41 interface IWICMetadataHandlerInfo : IWICComponentInfo
  42 {
  43     HRESULT GetMetadataFormat(
  44         [out] GUID *pguidMetadataFormat);
  45
  46     HRESULT GetContainerFormats(
  47         [in] UINT cContainerFormats,
  48         [in, out, unique, size_is(cContainerFormats)] GUID *pguidContainerFormats,
  49         [out] UINT *pcchActual);
  50
  51     HRESULT GetDeviceManufacturer(
  52         [in] UINT cchDeviceManufacturer,
  53         [in, out, unique, size_is(cchDeviceManufacturer)] WCHAR *wzDeviceManufacturer,
  54         [out] UINT *pcchActual);
  55
  56     HRESULT GetDeviceModels(
  57         [in] UINT cchDeviceModels,
  58         [in, out, unique, size_is(cchDeviceModels)] WCHAR *wzDeviceModels,
  59         [out] UINT *pcchActual);
  60
  61     HRESULT DoesRequireFullStream(
  62         [out] BOOL *pfRequiresFullStream);
  63
  64     HRESULT DoesSupportPadding(
  65         [out] BOOL *pfSupportsPadding);
  66
  67     HRESULT DoesRequireFixedSize(
  68         [out] BOOL *pfFixedSize);
  69 }
  70
  71 [
  72     object,
  73     uuid(9204fe99-d8fc-4fd5-a001-9536b067a899)
  74 ]
  75 interface IWICMetadataReader : IUnknown
  76 {
  77     HRESULT GetMetadataFormat(
  78         [out] GUID *pguidMetadataFormat);
  79
  80     HRESULT GetMetadataHandlerInfo(
  81         [out] IWICMetadataHandlerInfo **ppIHandler);
  82
  83     HRESULT GetCount(
  84         [out] UINT *pcCount);
  85
  86     HRESULT GetValueByIndex(
  87         [in] UINT nIndex,
  88         [in, out, unique] PROPVARIANT *pvarSchema,
  89         [in, out, unique] PROPVARIANT *pvarId,
  90         [in, out, unique] PROPVARIANT *pvarValue);
  91
  92     HRESULT GetValue(
  93         [in] const PROPVARIANT *pvarSchema,
  94         [in] const PROPVARIANT *pvarId,
  95         [in, out, unique] const PROPVARIANT *pvarValue);
  96
  97     HRESULT GetEnumerator(
  98         [out] IWICEnumMetadataItem **ppIEnumMetadata);
  99 }
 100
 101 [
 102     object,
 103     uuid(f7836e16-3be0-470b-86bb-160d0aecd7de)
 104 ]
 105 interface IWICMetadataWriter : IWICMetadataReader
 106 {
 107     HRESULT SetValue(
 108         [in, unique] const PROPVARIANT *pvarSchema,
 109         [in] const PROPVARIANT *pvarId,
 110         [in] const PROPVARIANT *pvarValue);
 111
 112     HRESULT SetValueByIndex(
 113         [in] UINT nIndex,
 114         [in, unique] const PROPVARIANT *pvarSchema,
 115         [in] const PROPVARIANT *pvarId,
 116         [in] const PROPVARIANT *pvarValue);
 117
 118     HRESULT RemoveValue(
 119         [in, unique] const PROPVARIANT *pvarSchema,
 120         [in] const PROPVARIANT *pvarId);
 121
 122     HRESULT RemoveValueByIndex(
 123         [in] UINT nIndex);
 124 }
 125
 126 [
 127     object,
 128     uuid(feaa2a8d-b3f3-43e4-b25c-d1de990a1ae1)
 129 ]
 130 interface IWICMetadataBlockReader : IUnknown
 131 {
 132     HRESULT GetContainerFormat(
 133         [out] GUID *pguidContainerFormat);
 134
 135     HRESULT GetCount(
 136         [out] UINT *pcCount);
 137
 138     HRESULT GetReaderByIndex(
 139         [in] UINT nIndex,
 140         [out] IWICMetadataReader **ppIMetadataReader);
 141
 142     HRESULT GetEnumerator(
 143         [out] IEnumUnknown **ppIEnumMetadata);
 144 }
 145
 146 [
 147     object,
 148     uuid(08fb9676-b444-41e8-8dbe-6a53a542bff1)
 149 ]
 150 interface IWICMetadataBlockWriter : IWICMetadataBlockReader
 151 {
 152     HRESULT InitializeFromBlockReader(
 153         [in] IWICMetadataBlockReader *pIMDBlockReader);
 154
 155     HRESULT GetWriterByIndex(
 156         [in] UINT nIndex,
 157         [out] IWICMetadataWriter **ppIMetadataWriter);
 158
 159     HRESULT AddWriter(
 160         [in] IWICMetadataWriter *pIMetadataWriter);
 161
 162     HRESULT SetWriterByIndex(
 163         [in] UINT nIndex,
 164         [in] IWICMetadataWriter *pIMetadataWriter);
 165
 166     HRESULT RemoveWriterByIndex(
 167         [in] UINT nIndex);
 168 }
 169
 170 [
 171     object,
 172     uuid(412d0c3a-9650-44fa-af5b-dd2a06c8e8fb)
 173 ]
 174 interface IWICComponentFactory : IWICImagingFactory
 175 {
 176     HRESULT CreateMetadataReader(
 177         [in] REFGUID guidMetadataFormat,
 178         [in, unique] const GUID *pguidVendor,
 179         [in] DWORD dwOptions,
 180         [in] IStream *pIStream,
 181         [out] IWICMetadataReader **ppIReader);
 182
 183     HRESULT CreateMetadataReaderFromContainer(
 184         [in] REFGUID guidMetadataFormat,
 185         [in, unique] const GUID *pguidVendor,
 186         [in] DWORD dwOptions,
 187         [in] IStream *pIStream,
 188         [out] IWICMetadataReader **ppIReader);
 189
 190     HRESULT CreateMetadataWriter(
 191         [in] REFGUID guidMetadataFormat,
 192         [in, unique] const GUID *pguidVendor,
 193         [in] DWORD dwMetadataOptions,
 194         [out] IWICMetadataWriter **ppIWriter);
 195
 196     HRESULT CreateMetadataWriterFromReader(
 197         [in] IWICMetadataReader *pIReader,
 198         [in, unique] const GUID *pguidVendor,
 199         [out] IWICMetadataWriter **ppIWriter);
 200
 201     HRESULT CreateQueryReaderFromBlockReader(
 202         [in] IWICMetadataBlockReader *pIBlockReader,
 203         [out] IWICMetadataQueryReader **ppIQueryReader);
 204
 205     HRESULT CreateQueryWriterFromBlockWriter(
 206         [in] IWICMetadataBlockWriter *pIBlockWriter,
 207         [out] IWICMetadataQueryWriter **ppIQueryWriter);
 208
 209     HRESULT CreateEncoderPropertyBag(
 210         [in, unique, size_is(cCount)] PROPBAG2 *ppropOptions,
 211         [in] UINT cCount,
 212         [out] IPropertyBag2 **ppIPropertyBag);
 213 }