include: Assorted spelling fixes.
[wine] / dlls / strmbase / enumpins.c
1 /*
2  * Implementation of IEnumPins Interface
3  *
4  * Copyright 2003 Robert Shearman
5  * Copyright 2010 Aric Stewart, CodeWeavers
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20  */
21
22 #define COBJMACROS
23
24 #include "dshow.h"
25 #include "wine/strmbase.h"
26 #include "wine/debug.h"
27
28 WINE_DEFAULT_DEBUG_CHANNEL(strmbase);
29
30 typedef struct IEnumPinsImpl
31 {
32     IEnumPins IEnumPins_iface;
33     LONG refCount;
34     ULONG uIndex;
35     BaseFilter *base;
36     BaseFilter_GetPin receive_pin;
37     BaseFilter_GetPinCount receive_pincount;
38     BaseFilter_GetPinVersion receive_version;
39     DWORD Version;
40 } IEnumPinsImpl;
41
42 static inline IEnumPinsImpl *impl_from_IEnumPins(IEnumPins *iface)
43 {
44     return CONTAINING_RECORD(iface, IEnumPinsImpl, IEnumPins_iface);
45 }
46
47 static const struct IEnumPinsVtbl IEnumPinsImpl_Vtbl;
48
49 HRESULT WINAPI EnumPins_Construct(BaseFilter *base,  BaseFilter_GetPin receive_pin, BaseFilter_GetPinCount receive_pincount, BaseFilter_GetPinVersion receive_version, IEnumPins ** ppEnum)
50 {
51     IEnumPinsImpl * pEnumPins;
52
53     if (!ppEnum)
54         return E_POINTER;
55
56     pEnumPins = CoTaskMemAlloc(sizeof(IEnumPinsImpl));
57     if (!pEnumPins)
58     {
59         *ppEnum = NULL;
60         return E_OUTOFMEMORY;
61     }
62     pEnumPins->IEnumPins_iface.lpVtbl = &IEnumPinsImpl_Vtbl;
63     pEnumPins->refCount = 1;
64     pEnumPins->uIndex = 0;
65     pEnumPins->receive_pin = receive_pin;
66     pEnumPins->receive_pincount = receive_pincount;
67     pEnumPins->receive_version = receive_version;
68     pEnumPins->base = base;
69     IBaseFilter_AddRef(&base->IBaseFilter_iface);
70     *ppEnum = &pEnumPins->IEnumPins_iface;
71     pEnumPins->Version = receive_version(base);
72
73     TRACE("Created new enumerator (%p)\n", *ppEnum);
74     return S_OK;
75 }
76
77 static HRESULT WINAPI IEnumPinsImpl_QueryInterface(IEnumPins * iface, REFIID riid, LPVOID * ppv)
78 {
79     TRACE("(%s, %p)\n", debugstr_guid(riid), ppv);
80
81     *ppv = NULL;
82
83     if (IsEqualIID(riid, &IID_IUnknown))
84         *ppv = iface;
85     else if (IsEqualIID(riid, &IID_IEnumPins))
86         *ppv = iface;
87
88     if (*ppv)
89     {
90         IUnknown_AddRef((IUnknown *)(*ppv));
91         return S_OK;
92     }
93
94     FIXME("No interface for %s!\n", debugstr_guid(riid));
95
96     return E_NOINTERFACE;
97 }
98
99 static ULONG WINAPI IEnumPinsImpl_AddRef(IEnumPins * iface)
100 {
101     IEnumPinsImpl *This = impl_from_IEnumPins(iface);
102     ULONG refCount = InterlockedIncrement(&This->refCount);
103
104     TRACE("(%p)->() AddRef from %d\n", This, refCount - 1);
105
106     return refCount;
107 }
108
109 static ULONG WINAPI IEnumPinsImpl_Release(IEnumPins * iface)
110 {
111     IEnumPinsImpl *This = impl_from_IEnumPins(iface);
112     ULONG refCount = InterlockedDecrement(&This->refCount);
113
114     TRACE("(%p)->() Release from %d\n", This, refCount + 1);
115
116     if (!refCount)
117     {
118         IBaseFilter_Release(&This->base->IBaseFilter_iface);
119         CoTaskMemFree(This);
120         return 0;
121     }
122     else
123         return refCount;
124 }
125
126 static HRESULT WINAPI IEnumPinsImpl_Next(IEnumPins * iface, ULONG cPins, IPin ** ppPins, ULONG * pcFetched)
127 {
128     IEnumPinsImpl *This = impl_from_IEnumPins(iface);
129     HRESULT hr = S_OK;
130     ULONG i = 0;
131
132     TRACE("(%u, %p, %p)\n", cPins, ppPins, pcFetched);
133
134     if (!ppPins)
135         return E_POINTER;
136
137     if (cPins > 1 && !pcFetched)
138         return E_INVALIDARG;
139
140     if (pcFetched)
141         *pcFetched = 0;
142
143     if (This->Version != This->receive_version(This->base))
144         return VFW_E_ENUM_OUT_OF_SYNC;
145
146     while (i < cPins && hr == S_OK)
147     {
148        IPin *pin;
149        pin = This->receive_pin(This->base, This->uIndex + i);
150
151        if (!pin)
152          break;
153        else
154          ppPins[i] = pin;
155        ++i;
156     }
157
158     if (pcFetched)
159         *pcFetched = i;
160     This->uIndex += i;
161
162     if (i < cPins)
163         return S_FALSE;
164     return S_OK;
165 }
166
167 static HRESULT WINAPI IEnumPinsImpl_Skip(IEnumPins * iface, ULONG cPins)
168 {
169     IEnumPinsImpl *This = impl_from_IEnumPins(iface);
170
171     TRACE("(%u)\n", cPins);
172
173     if (This->Version != This->receive_version(This->base))
174         return VFW_E_ENUM_OUT_OF_SYNC;
175
176     if (This->receive_pincount(This->base) >= This->uIndex + cPins)
177         return S_FALSE;
178
179     This->uIndex += cPins;
180     return S_OK;
181 }
182
183 static HRESULT WINAPI IEnumPinsImpl_Reset(IEnumPins * iface)
184 {
185     IEnumPinsImpl *This = impl_from_IEnumPins(iface);
186
187     TRACE("IEnumPinsImpl::Reset()\n");
188     This->Version = This->receive_version(This->base);
189
190     This->uIndex = 0;
191     return S_OK;
192 }
193
194 static HRESULT WINAPI IEnumPinsImpl_Clone(IEnumPins * iface, IEnumPins ** ppEnum)
195 {
196     HRESULT hr;
197     IEnumPinsImpl *This = impl_from_IEnumPins(iface);
198
199     TRACE("(%p)\n", ppEnum);
200
201     hr = EnumPins_Construct(This->base, This->receive_pin, This->receive_pincount, This->receive_version, ppEnum);
202     if (FAILED(hr))
203         return hr;
204     return IEnumPins_Skip(*ppEnum, This->uIndex);
205 }
206
207 static const IEnumPinsVtbl IEnumPinsImpl_Vtbl =
208 {
209     IEnumPinsImpl_QueryInterface,
210     IEnumPinsImpl_AddRef,
211     IEnumPinsImpl_Release,
212     IEnumPinsImpl_Next,
213     IEnumPinsImpl_Skip,
214     IEnumPinsImpl_Reset,
215     IEnumPinsImpl_Clone
216 };