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