windowscodecs: Add a bunch of tests for Graphic Control Extension metadata reader.
[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 = 0x00000000,
25     WICPersistOptionsBigEndian = 0x00000001,
26     WICPersistOptionsStrictFormat = 0x00000002,
27     WICPersistOptionsNoCacheStream = 0x00000004,
28     WICPersistOptionPreferUTF8 = 0x00000008,
29     WICPersistOptionsMask = 0x0000FFFF
30 } WICPersistOptions;
31
32 typedef enum WICMetadataCreationOptions {
33     WICMetadataCreationDefault = 0x00000000,
34     WICMetadataCreationAllowUnknown = WICMetadataCreationDefault,
35     WICMetadataCreationFailUnknown = 0x00010000,
36     WICMetadataCreationMask = 0xFFFF0000
37 } WICMetadataCreationOptions;
38
39 cpp_quote("DEFINE_GUID(GUID_MetadataFormatUnknown, 0xa45e592f,0x9078,0x4a7c,0xad,0xb5,0x4e,0xdc,0x4f,0xd6,0x1b,0x1f);")
40 cpp_quote("DEFINE_GUID(GUID_MetadataFormatChunktEXt, 0x568d8936,0xc0a9,0x4923,0x90,0x5d,0xdf,0x2b,0x38,0x23,0x8f,0xbc);")
41 cpp_quote("DEFINE_GUID(GUID_MetadataFormatChunktIME, 0x6b00ae2d,0xe24b,0x460a,0x98,0xb6,0x87,0x8b,0xd0,0x30,0x72,0xfd);")
42 cpp_quote("DEFINE_GUID(GUID_MetadataFormatIfd, 0x537396c6,0x2d8a,0x4bb6,0x9b,0xf8,0x2f,0x0a,0x8e,0x2a,0x3a,0xdf);")
43 cpp_quote("DEFINE_GUID(GUID_MetadataFormatExif, 0x1c3c4f9d,0xb84a,0x467d,0x94,0x93,0x36,0xcf,0xbd,0x59,0xea,0x57);")
44 cpp_quote("DEFINE_GUID(GUID_MetadataFormatXMP, 0xbb5acc38,0xf216,0x4cec,0xa6,0xc5,0x5f,0x6e,0x73,0x97,0x63,0xa9);")
45 cpp_quote("DEFINE_GUID(GUID_MetadataFormatXMPStruct, 0x22383cf1,0xed17,0x4e2e,0xaf,0x17,0xd8,0x5b,0x8f,0x6b,0x30,0xd0);")
46 cpp_quote("DEFINE_GUID(GUID_MetadataFormatIMD, 0xbd2bb086,0x4d52,0x48dd,0x96,0x77,0xdb,0x48,0x3e,0x85,0xae,0x8f);")
47 cpp_quote("DEFINE_GUID(GUID_MetadataFormatLSD, 0xe256031e,0x6299,0x4929,0xb9,0x8d,0x5a,0xc8,0x84,0xaf,0xba,0x92);")
48 cpp_quote("DEFINE_GUID(GUID_MetadataFormatGCE, 0x2a25cad8,0xdeeb,0x4c69,0xa7,0x88,0x0e,0xc2,0x26,0x6d,0xca,0xfd);")
49
50 cpp_quote("DEFINE_GUID(CLSID_WICUnknownMetadataReader, 0x699745c2,0x5066,0x4b82,0xa8,0xe3,0xd4,0x04,0x78,0xdb,0xec,0x8c);")
51 cpp_quote("DEFINE_GUID(CLSID_WICUnknownMetadataWriter, 0xa09cca86,0x27ba,0x4f39,0x90,0x53,0x12,0x1f,0xa4,0xdc,0x08,0xfc);")
52 cpp_quote("DEFINE_GUID(CLSID_WICPngTextMetadataReader, 0x4b59afcc,0xb8c3,0x408a,0xb6,0x70,0x89,0xe5,0xfa,0xb6,0xfd,0xa7);")
53 cpp_quote("DEFINE_GUID(CLSID_WICPngTextMetadataWriter, 0xb5ebafb9,0x253e,0x4a72,0xa7,0x44,0x07,0x62,0xd2,0x68,0x56,0x83);")
54 cpp_quote("DEFINE_GUID(CLSID_WICIfdMetadataReader, 0x8f914656,0x9d0a,0x4eb2,0x90,0x19,0x0b,0xf9,0x6d,0x8a,0x9e,0xe6);")
55 cpp_quote("DEFINE_GUID(CLSID_WICIfdMetadataWriter, 0xb1ebfc28,0xc9bd,0x47a2,0x8d,0x33,0xb9,0x48,0x76,0x97,0x77,0xa7);")
56 cpp_quote("DEFINE_GUID(CLSID_WICExifMetadataReader, 0xd9403860,0x297f,0x4a49,0xbf,0x9b,0x77,0x89,0x81,0x50,0xa4,0x42);")
57 cpp_quote("DEFINE_GUID(CLSID_WICExifMetadataWriter, 0xc9a14cda,0xc339,0x460b,0x90,0x78,0xd4,0xde,0xbc,0xfa,0xbe,0x91);")
58 cpp_quote("DEFINE_GUID(CLSID_WICXMPStructMetadataReader, 0x01b90d9a,0x8209,0x47f7,0x9c,0x52,0xe1,0x24,0x4b,0xf5,0x0c,0xed);")
59 cpp_quote("DEFINE_GUID(CLSID_WICXMPStructMetadataWriter, 0x22c21f93,0x7ddb,0x411c,0x9b,0x17,0xc5,0xb7,0xbd,0x06,0x4a,0xbc);")
60 cpp_quote("DEFINE_GUID(CLSID_WICLSDMetadataReader, 0x41070793,0x59e4,0x479a,0xa1,0xf7,0x95,0x4a,0xdc,0x2e,0xf5,0xfc);")
61 cpp_quote("DEFINE_GUID(CLSID_WICLSDMetadataWriter, 0x73c037e7,0xe5d9,0x4954,0x87,0x6a,0x6d,0xa8,0x1d,0x6e,0x57,0x68);")
62 cpp_quote("DEFINE_GUID(CLSID_WICIMDMetadataReader, 0x7447a267,0x0015,0x42c8,0xa8,0xf1,0xfb,0x3b,0x94,0xc6,0x83,0x61);")
63 cpp_quote("DEFINE_GUID(CLSID_WICIMDMetadataWriter, 0x8c89071f,0x452e,0x4e95,0x96,0x82,0x9d,0x10,0x24,0x62,0x71,0x72);")
64 cpp_quote("DEFINE_GUID(CLSID_WICGCEMetadataReader, 0xb92e345d,0xf52d,0x41f3,0xb5,0x62,0x08,0x1b,0xc7,0x72,0xe3,0xb9);")
65 cpp_quote("DEFINE_GUID(CLSID_WICGCEMetadataWriter, 0xaf95dc76,0x16b2,0x47f4,0xb3,0xea,0x3c,0x31,0x79,0x66,0x93,0xe7);")
66
67 typedef struct WICMetadataPattern {
68     ULARGE_INTEGER Position;
69     ULONG Length;
70     BYTE *Pattern;
71     BYTE *Mask;
72     ULARGE_INTEGER DataOffset;
73 } WICMetadataPattern;
74
75 typedef struct WICMetadataHeader {
76     ULARGE_INTEGER Position;
77     ULONG Length;
78     BYTE *Header;
79     ULARGE_INTEGER DataOffset;
80 } WICMetadataHeader;
81
82 [
83     object,
84     uuid(aba958bf-c672-44d1-8d61-ce6df2e682c2)
85 ]
86 interface IWICMetadataHandlerInfo : IWICComponentInfo
87 {
88     HRESULT GetMetadataFormat(
89         [out] GUID *pguidMetadataFormat);
90
91     HRESULT GetContainerFormats(
92         [in] UINT cContainerFormats,
93         [in, out, unique, size_is(cContainerFormats)] GUID *pguidContainerFormats,
94         [out] UINT *pcchActual);
95
96     HRESULT GetDeviceManufacturer(
97         [in] UINT cchDeviceManufacturer,
98         [in, out, unique, size_is(cchDeviceManufacturer)] WCHAR *wzDeviceManufacturer,
99         [out] UINT *pcchActual);
100
101     HRESULT GetDeviceModels(
102         [in] UINT cchDeviceModels,
103         [in, out, unique, size_is(cchDeviceModels)] WCHAR *wzDeviceModels,
104         [out] UINT *pcchActual);
105
106     HRESULT DoesRequireFullStream(
107         [out] BOOL *pfRequiresFullStream);
108
109     HRESULT DoesSupportPadding(
110         [out] BOOL *pfSupportsPadding);
111
112     HRESULT DoesRequireFixedSize(
113         [out] BOOL *pfFixedSize);
114 }
115
116 [
117     object,
118     uuid(9204fe99-d8fc-4fd5-a001-9536b067a899)
119 ]
120 interface IWICMetadataReader : IUnknown
121 {
122     HRESULT GetMetadataFormat(
123         [out] GUID *pguidMetadataFormat);
124
125     HRESULT GetMetadataHandlerInfo(
126         [out] IWICMetadataHandlerInfo **ppIHandler);
127
128     HRESULT GetCount(
129         [out] UINT *pcCount);
130
131     HRESULT GetValueByIndex(
132         [in] UINT nIndex,
133         [in, out, unique] PROPVARIANT *pvarSchema,
134         [in, out, unique] PROPVARIANT *pvarId,
135         [in, out, unique] PROPVARIANT *pvarValue);
136
137     HRESULT GetValue(
138         [in] const PROPVARIANT *pvarSchema,
139         [in] const PROPVARIANT *pvarId,
140         [in, out, unique] PROPVARIANT *pvarValue);
141
142     HRESULT GetEnumerator(
143         [out] IWICEnumMetadataItem **ppIEnumMetadata);
144 }
145
146 [
147     object,
148     uuid(eebf1f5b-07c1-4447-a3ab-22acaf78a804)
149 ]
150 interface IWICMetadataReaderInfo : IWICMetadataHandlerInfo
151 {
152     [local]
153     HRESULT GetPatterns(
154         [in] REFGUID guidContainerFormat,
155         [in] UINT cbSize,
156         [out, unique] WICMetadataPattern *pPattern,
157         [out, unique] UINT *pcCount,
158         [out, unique] UINT *pcbActual);
159
160     HRESULT MatchesPattern(
161         [in] REFGUID guidContainerFormat,
162         [in] IStream *pIStream,
163         [out] BOOL *pfMatches);
164
165     HRESULT CreateInstance(
166         [out] IWICMetadataReader **ppIReader);
167 }
168
169 [
170     object,
171     uuid(f7836e16-3be0-470b-86bb-160d0aecd7de)
172 ]
173 interface IWICMetadataWriter : IWICMetadataReader
174 {
175     HRESULT SetValue(
176         [in, unique] const PROPVARIANT *pvarSchema,
177         [in] const PROPVARIANT *pvarId,
178         [in] const PROPVARIANT *pvarValue);
179
180     HRESULT SetValueByIndex(
181         [in] UINT nIndex,
182         [in, unique] const PROPVARIANT *pvarSchema,
183         [in] const PROPVARIANT *pvarId,
184         [in] const PROPVARIANT *pvarValue);
185
186     HRESULT RemoveValue(
187         [in, unique] const PROPVARIANT *pvarSchema,
188         [in] const PROPVARIANT *pvarId);
189
190     HRESULT RemoveValueByIndex(
191         [in] UINT nIndex);
192 }
193
194 [
195     object,
196     uuid(b22e3fba-3925-4323-b5c1-9ebfc430f236)
197 ]
198 interface IWICMetadataWriterInfo : IWICMetadataHandlerInfo
199 {
200     [local]
201     HRESULT GetHeader(
202         [in] REFGUID guidContainerFormat,
203         [in] UINT cbSize,
204         [out, unique] WICMetadataHeader *pHeader,
205         [out, unique] UINT *pcbActual);
206
207     HRESULT CreateInstance(
208         [out] IWICMetadataWriter **ppIWriter);
209 }
210
211 [
212     object,
213     uuid(feaa2a8d-b3f3-43e4-b25c-d1de990a1ae1)
214 ]
215 interface IWICMetadataBlockReader : IUnknown
216 {
217     HRESULT GetContainerFormat(
218         [out] GUID *pguidContainerFormat);
219
220     HRESULT GetCount(
221         [out] UINT *pcCount);
222
223     HRESULT GetReaderByIndex(
224         [in] UINT nIndex,
225         [out] IWICMetadataReader **ppIMetadataReader);
226
227     HRESULT GetEnumerator(
228         [out] IEnumUnknown **ppIEnumMetadata);
229 }
230
231 [
232     object,
233     uuid(08fb9676-b444-41e8-8dbe-6a53a542bff1)
234 ]
235 interface IWICMetadataBlockWriter : IWICMetadataBlockReader
236 {
237     HRESULT InitializeFromBlockReader(
238         [in] IWICMetadataBlockReader *pIMDBlockReader);
239
240     HRESULT GetWriterByIndex(
241         [in] UINT nIndex,
242         [out] IWICMetadataWriter **ppIMetadataWriter);
243
244     HRESULT AddWriter(
245         [in] IWICMetadataWriter *pIMetadataWriter);
246
247     HRESULT SetWriterByIndex(
248         [in] UINT nIndex,
249         [in] IWICMetadataWriter *pIMetadataWriter);
250
251     HRESULT RemoveWriterByIndex(
252         [in] UINT nIndex);
253 }
254
255 [
256     object,
257     uuid(00675040-6908-45f8-86a3-49c7dfd6d9ad)
258 ]
259 interface IWICPersistStream : IPersistStream
260 {
261     HRESULT LoadEx(
262         [in, unique] IStream *pIStream,
263         [in, unique] const GUID *pguidPreferredVendor,
264         [in] DWORD dwPersistOptions);
265
266     HRESULT SaveEx(
267         [in] IStream *pIStream,
268         [in] DWORD dwPersistOptions,
269         [in] BOOL fClearDirty);
270 }
271
272 [
273     object,
274     uuid(412d0c3a-9650-44fa-af5b-dd2a06c8e8fb)
275 ]
276 interface IWICComponentFactory : IWICImagingFactory
277 {
278     HRESULT CreateMetadataReader(
279         [in] REFGUID guidMetadataFormat,
280         [in, unique] const GUID *pguidVendor,
281         [in] DWORD dwOptions,
282         [in] IStream *pIStream,
283         [out] IWICMetadataReader **ppIReader);
284
285     HRESULT CreateMetadataReaderFromContainer(
286         [in] REFGUID guidMetadataFormat,
287         [in, unique] const GUID *pguidVendor,
288         [in] DWORD dwOptions,
289         [in] IStream *pIStream,
290         [out] IWICMetadataReader **ppIReader);
291
292     HRESULT CreateMetadataWriter(
293         [in] REFGUID guidMetadataFormat,
294         [in, unique] const GUID *pguidVendor,
295         [in] DWORD dwMetadataOptions,
296         [out] IWICMetadataWriter **ppIWriter);
297
298     HRESULT CreateMetadataWriterFromReader(
299         [in] IWICMetadataReader *pIReader,
300         [in, unique] const GUID *pguidVendor,
301         [out] IWICMetadataWriter **ppIWriter);
302
303     HRESULT CreateQueryReaderFromBlockReader(
304         [in] IWICMetadataBlockReader *pIBlockReader,
305         [out] IWICMetadataQueryReader **ppIQueryReader);
306
307     HRESULT CreateQueryWriterFromBlockWriter(
308         [in] IWICMetadataBlockWriter *pIBlockWriter,
309         [out] IWICMetadataQueryWriter **ppIQueryWriter);
310
311     HRESULT CreateEncoderPropertyBag(
312         [in, unique, size_is(cCount)] PROPBAG2 *ppropOptions,
313         [in] UINT cCount,
314         [out] IPropertyBag2 **ppIPropertyBag);
315 }