2 * Generic Implementation of IPin Interface
4 * Copyright 2003 Robert Shearman
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
21 #include "quartz_private.h"
24 #include "wine/debug.h"
25 #include "wine/unicode.h"
30 WINE_DEFAULT_DEBUG_CHANNEL(quartz);
32 static const IPinVtbl PullPin_Vtbl;
34 #define ALIGNDOWN(value,boundary) ((value)/(boundary)*(boundary))
35 #define ALIGNUP(value,boundary) (ALIGNDOWN((value)+(boundary)-1, (boundary)))
37 typedef HRESULT (*SendPinFunc)( IPin *to, LPVOID arg );
39 /** Helper function, there are a lot of places where the error code is inherited
40 * The following rules apply:
42 * Return the first received error code (E_NOTIMPL is ignored)
43 * If no errors occur: return the first received non-error-code that isn't S_OK
45 static HRESULT updatehres( HRESULT original, HRESULT new )
47 if (FAILED( original ) || new == E_NOTIMPL)
50 if (FAILED( new ) || original == S_OK)
56 /** Sends a message from a pin further to other, similar pins
57 * fnMiddle is called on each pin found further on the stream.
58 * fnEnd (can be NULL) is called when the message can't be sent any further (this is a renderer or source)
60 * If the pin given is an input pin, the message will be sent downstream to other input pins
61 * If the pin given is an output pin, the message will be sent upstream to other output pins
63 static HRESULT SendFurther( IPin *from, SendPinFunc fnMiddle, LPVOID arg, SendPinFunc fnEnd )
68 HRESULT hr_return = S_OK;
69 IEnumPins *enumpins = NULL;
71 PIN_DIRECTION from_dir;
73 IPin_QueryDirection( from, &from_dir );
75 hr = IPin_QueryInternalConnections( from, NULL, &amount );
76 if (hr != E_NOTIMPL && amount)
77 FIXME("Use QueryInternalConnections!\n");
80 pin_info.pFilter = NULL;
81 hr = IPin_QueryPinInfo( from, &pin_info );
85 hr = IBaseFilter_EnumPins( pin_info.pFilter, &enumpins );
89 hr = IEnumPins_Reset( enumpins );
92 hr = IEnumPins_Next( enumpins, 1, &pin, NULL );
93 if (hr == VFW_E_ENUM_OUT_OF_SYNC)
95 hr = IEnumPins_Reset( enumpins );
102 IPin_QueryDirection( pin, &dir );
105 IPin *connected = NULL;
108 IPin_ConnectedTo( pin, &connected );
113 hr_local = fnMiddle( connected, arg );
114 hr_return = updatehres( hr_return, hr_local );
115 IPin_Release(connected);
132 hr_local = fnEnd( from, arg );
133 hr_return = updatehres( hr_return, hr_local );
138 IEnumPins_Release( enumpins );
139 if (pin_info.pFilter)
140 IBaseFilter_Release( pin_info.pFilter );
145 static void Copy_PinInfo(PIN_INFO * pDest, const PIN_INFO * pSrc)
147 /* Tempting to just do a memcpy, but the name field is
148 128 characters long! We will probably never exceed 10
149 most of the time, so we are better off copying
150 each field manually */
151 strcpyW(pDest->achName, pSrc->achName);
152 pDest->dir = pSrc->dir;
153 pDest->pFilter = pSrc->pFilter;
156 static HRESULT deliver_endofstream(IPin* pin, LPVOID unused)
158 return IPin_EndOfStream( pin );
161 static HRESULT deliver_beginflush(IPin* pin, LPVOID unused)
163 return IPin_BeginFlush( pin );
166 static HRESULT deliver_endflush(IPin* pin, LPVOID unused)
168 return IPin_EndFlush( pin );
171 typedef struct newsegmentargs
173 REFERENCE_TIME tStart, tStop;
177 static HRESULT deliver_newsegment(IPin *pin, LPVOID data)
179 newsegmentargs *args = data;
180 return IPin_NewSegment(pin, args->tStart, args->tStop, args->rate);
183 /*** PullPin implementation ***/
185 static HRESULT PullPin_Init(const IPinVtbl *PullPin_Vtbl, const PIN_INFO * pPinInfo, SAMPLEPROC_PULL pSampleProc, LPVOID pUserData,
186 QUERYACCEPTPROC pQueryAccept, CLEANUPPROC pCleanUp, REQUESTPROC pCustomRequest, STOPPROCESSPROC pDone, LPCRITICAL_SECTION pCritSec, PullPin * pPinImpl)
188 /* Common attributes */
189 pPinImpl->pin.lpVtbl = PullPin_Vtbl;
190 pPinImpl->pin.refCount = 1;
191 pPinImpl->pin.pConnectedTo = NULL;
192 pPinImpl->pin.pCritSec = pCritSec;
193 Copy_PinInfo(&pPinImpl->pin.pinInfo, pPinInfo);
194 ZeroMemory(&pPinImpl->pin.mtCurrent, sizeof(AM_MEDIA_TYPE));
196 /* Input pin attributes */
197 pPinImpl->pUserData = pUserData;
198 pPinImpl->fnQueryAccept = pQueryAccept;
199 pPinImpl->fnSampleProc = pSampleProc;
200 pPinImpl->fnCleanProc = pCleanUp;
201 pPinImpl->fnDone = pDone;
202 pPinImpl->fnPreConnect = NULL;
203 pPinImpl->pAlloc = NULL;
204 pPinImpl->prefAlloc = NULL;
205 pPinImpl->pReader = NULL;
206 pPinImpl->hThread = NULL;
207 pPinImpl->hEventStateChanged = CreateEventW(NULL, TRUE, TRUE, NULL);
208 pPinImpl->thread_sleepy = CreateEventW(NULL, FALSE, FALSE, NULL);
210 pPinImpl->rtStart = 0;
211 pPinImpl->rtCurrent = 0;
212 pPinImpl->rtStop = ((LONGLONG)0x7fffffff << 32) | 0xffffffff;
213 pPinImpl->dRate = 1.0;
214 pPinImpl->state = Req_Die;
215 pPinImpl->fnCustomRequest = pCustomRequest;
216 pPinImpl->stop_playback = 1;
218 InitializeCriticalSection(&pPinImpl->thread_lock);
219 pPinImpl->thread_lock.DebugInfo->Spare[0] = (DWORD_PTR)( __FILE__ ": PullPin.thread_lock");
224 HRESULT PullPin_Construct(const IPinVtbl *PullPin_Vtbl, const PIN_INFO * pPinInfo, SAMPLEPROC_PULL pSampleProc, LPVOID pUserData, QUERYACCEPTPROC pQueryAccept, CLEANUPPROC pCleanUp, REQUESTPROC pCustomRequest, STOPPROCESSPROC pDone, LPCRITICAL_SECTION pCritSec, IPin ** ppPin)
230 if (pPinInfo->dir != PINDIR_INPUT)
232 ERR("Pin direction(%x) != PINDIR_INPUT\n", pPinInfo->dir);
236 pPinImpl = CoTaskMemAlloc(sizeof(*pPinImpl));
239 return E_OUTOFMEMORY;
241 if (SUCCEEDED(PullPin_Init(PullPin_Vtbl, pPinInfo, pSampleProc, pUserData, pQueryAccept, pCleanUp, pCustomRequest, pDone, pCritSec, pPinImpl)))
243 *ppPin = (IPin *)(&pPinImpl->pin.lpVtbl);
247 CoTaskMemFree(pPinImpl);
251 static HRESULT PullPin_InitProcessing(PullPin * This);
253 HRESULT WINAPI PullPin_ReceiveConnection(IPin * iface, IPin * pReceivePin, const AM_MEDIA_TYPE * pmt)
255 PIN_DIRECTION pindirReceive;
257 PullPin *This = (PullPin *)iface;
259 TRACE("(%p/%p)->(%p, %p)\n", This, iface, pReceivePin, pmt);
260 dump_AM_MEDIA_TYPE(pmt);
262 EnterCriticalSection(This->pin.pCritSec);
263 if (!This->pin.pConnectedTo)
265 ALLOCATOR_PROPERTIES props;
268 props.cbBuffer = 64 * 1024; /* 64k bytes */
272 if (SUCCEEDED(hr) && (This->fnQueryAccept(This->pUserData, pmt) != S_OK))
273 hr = VFW_E_TYPE_NOT_ACCEPTED; /* FIXME: shouldn't we just map common errors onto
274 * VFW_E_TYPE_NOT_ACCEPTED and pass the value on otherwise? */
278 IPin_QueryDirection(pReceivePin, &pindirReceive);
280 if (pindirReceive != PINDIR_OUTPUT)
282 ERR("Can't connect from non-output pin\n");
283 hr = VFW_E_INVALID_DIRECTION;
287 This->pReader = NULL;
289 This->prefAlloc = NULL;
292 hr = IPin_QueryInterface(pReceivePin, &IID_IAsyncReader, (LPVOID *)&This->pReader);
295 if (SUCCEEDED(hr) && This->fnPreConnect)
297 hr = This->fnPreConnect(iface, pReceivePin, &props);
301 * Some custom filters (such as the one used by Fallout 3
302 * and Fallout: New Vegas) expect to be passed a non-NULL
303 * preferred allocator.
307 hr = StdMemAllocator_create(NULL, (LPVOID *) &This->prefAlloc);
312 hr = IAsyncReader_RequestAllocator(This->pReader, This->prefAlloc, &props, &This->pAlloc);
317 CopyMediaType(&This->pin.mtCurrent, pmt);
318 This->pin.pConnectedTo = pReceivePin;
319 IPin_AddRef(pReceivePin);
320 hr = IMemAllocator_Commit(This->pAlloc);
324 hr = PullPin_InitProcessing(This);
329 IAsyncReader_Release(This->pReader);
330 This->pReader = NULL;
332 IMemAllocator_Release(This->prefAlloc);
333 This->prefAlloc = NULL;
335 IMemAllocator_Release(This->pAlloc);
340 hr = VFW_E_ALREADY_CONNECTED;
341 LeaveCriticalSection(This->pin.pCritSec);
345 HRESULT WINAPI PullPin_QueryInterface(IPin * iface, REFIID riid, LPVOID * ppv)
347 PullPin *This = (PullPin *)iface;
349 TRACE("(%p/%p)->(%s, %p)\n", This, iface, qzdebugstr_guid(riid), ppv);
353 if (IsEqualIID(riid, &IID_IUnknown))
355 else if (IsEqualIID(riid, &IID_IPin))
357 else if (IsEqualIID(riid, &IID_IMediaSeeking) ||
358 IsEqualIID(riid, &IID_IQualityControl))
360 return IBaseFilter_QueryInterface(This->pin.pinInfo.pFilter, riid, ppv);
365 IUnknown_AddRef((IUnknown *)(*ppv));
369 FIXME("No interface for %s!\n", qzdebugstr_guid(riid));
371 return E_NOINTERFACE;
374 ULONG WINAPI PullPin_Release(IPin *iface)
376 PullPin *This = (PullPin *)iface;
377 ULONG refCount = InterlockedDecrement(&This->pin.refCount);
379 TRACE("(%p)->() Release from %d\n", This, refCount + 1);
383 WaitForSingleObject(This->hEventStateChanged, INFINITE);
384 assert(!This->hThread);
387 IMemAllocator_Release(This->prefAlloc);
389 IMemAllocator_Release(This->pAlloc);
391 IAsyncReader_Release(This->pReader);
392 CloseHandle(This->thread_sleepy);
393 CloseHandle(This->hEventStateChanged);
394 This->thread_lock.DebugInfo->Spare[0] = 0;
395 DeleteCriticalSection(&This->thread_lock);
402 static void PullPin_Flush(PullPin *This)
404 IMediaSample *pSample;
405 TRACE("Flushing!\n");
409 /* Do not allow state to change while flushing */
410 EnterCriticalSection(This->pin.pCritSec);
412 /* Flush outstanding samples */
413 IAsyncReader_BeginFlush(This->pReader);
419 IAsyncReader_WaitForNext(This->pReader, 0, &pSample, &dwUser);
424 assert(!IMediaSample_GetActualDataLength(pSample));
426 IMediaSample_Release(pSample);
429 IAsyncReader_EndFlush(This->pReader);
431 LeaveCriticalSection(This->pin.pCritSec);
435 static void PullPin_Thread_Process(PullPin *This)
438 IMediaSample * pSample = NULL;
439 ALLOCATOR_PROPERTIES allocProps;
441 hr = IMemAllocator_GetProperties(This->pAlloc, &allocProps);
443 This->cbAlign = allocProps.cbAlign;
445 if (This->rtCurrent < This->rtStart)
446 This->rtCurrent = MEDIATIME_FROM_BYTES(ALIGNDOWN(BYTES_FROM_MEDIATIME(This->rtStart), This->cbAlign));
450 if (This->rtCurrent >= This->rtStop)
452 IPin_EndOfStream((IPin *)This);
456 /* There is no sample in our buffer */
457 hr = This->fnCustomRequest(This->pUserData);
460 ERR("Request error: %x\n", hr);
462 EnterCriticalSection(This->pin.pCritSec);
463 SetEvent(This->hEventStateChanged);
464 LeaveCriticalSection(This->pin.pCritSec);
471 TRACE("Process sample\n");
474 hr = IAsyncReader_WaitForNext(This->pReader, 10000, &pSample, &dwUser);
476 /* Return an empty sample on error to the implementation in case it does custom parsing, so it knows it's gone */
479 hr = This->fnSampleProc(This->pUserData, pSample, dwUser);
483 if (hr == VFW_E_TIMEOUT)
486 WARN("Non-NULL sample returned with VFW_E_TIMEOUT.\n");
489 /* FIXME: Errors are not well handled yet! */
491 ERR("Processing error: %x\n", hr);
496 IMediaSample_Release(pSample);
499 } while (This->rtCurrent < This->rtStop && hr == S_OK && !This->stop_playback);
502 * Sample was rejected, and we are asked to terminate. When there is more than one buffer
503 * it is possible for a filter to have several queued samples, making it necessary to
504 * release all of these pending samples.
506 if (This->stop_playback || FAILED(hr))
513 IMediaSample_Release(pSample);
515 IAsyncReader_WaitForNext(This->pReader, 0, &pSample, &dwUser);
519 /* Can't reset state to Sleepy here because that might race, instead PauseProcessing will do that for us
520 * Flush remaining samples
523 This->fnDone(This->pUserData);
525 TRACE("End: %08x, %d\n", hr, This->stop_playback);
528 static void PullPin_Thread_Pause(PullPin *This)
532 EnterCriticalSection(This->pin.pCritSec);
533 This->state = Req_Sleepy;
534 SetEvent(This->hEventStateChanged);
535 LeaveCriticalSection(This->pin.pCritSec);
538 static void PullPin_Thread_Stop(PullPin *This)
540 TRACE("(%p)->()\n", This);
542 EnterCriticalSection(This->pin.pCritSec);
544 CloseHandle(This->hThread);
545 This->hThread = NULL;
546 SetEvent(This->hEventStateChanged);
548 LeaveCriticalSection(This->pin.pCritSec);
550 IBaseFilter_Release(This->pin.pinInfo.pFilter);
556 static DWORD WINAPI PullPin_Thread_Main(LPVOID pv)
559 CoInitializeEx(NULL, COINIT_MULTITHREADED);
565 WaitForSingleObject(This->thread_sleepy, INFINITE);
567 TRACE("State: %d\n", This->state);
571 case Req_Die: PullPin_Thread_Stop(This); break;
572 case Req_Run: PullPin_Thread_Process(This); break;
573 case Req_Pause: PullPin_Thread_Pause(This); break;
574 case Req_Sleepy: ERR("Should not be signalled with SLEEPY!\n"); break;
575 default: ERR("Unknown state request: %d\n", This->state); break;
581 static HRESULT PullPin_InitProcessing(PullPin * This)
585 TRACE("(%p)->()\n", This);
587 /* if we are connected */
592 WaitForSingleObject(This->hEventStateChanged, INFINITE);
593 EnterCriticalSection(This->pin.pCritSec);
595 assert(!This->hThread);
596 assert(This->state == Req_Die);
597 assert(This->stop_playback);
598 assert(WaitForSingleObject(This->thread_sleepy, 0) == WAIT_TIMEOUT);
599 This->state = Req_Sleepy;
601 /* AddRef the filter to make sure it and it's pins will be around
602 * as long as the thread */
603 IBaseFilter_AddRef(This->pin.pinInfo.pFilter);
606 This->hThread = CreateThread(NULL, 0, PullPin_Thread_Main, This, 0, &dwThreadId);
609 hr = HRESULT_FROM_WIN32(GetLastError());
610 IBaseFilter_Release(This->pin.pinInfo.pFilter);
615 SetEvent(This->hEventStateChanged);
616 /* If assert fails, that means a command was not processed before the thread previously terminated */
618 LeaveCriticalSection(This->pin.pCritSec);
621 TRACE(" -- %x\n", hr);
626 HRESULT PullPin_StartProcessing(PullPin * This)
628 /* if we are connected */
629 TRACE("(%p)->()\n", This);
632 assert(This->hThread);
634 PullPin_WaitForStateChange(This, INFINITE);
636 assert(This->state == Req_Sleepy);
639 assert(WaitForSingleObject(This->thread_sleepy, 0) == WAIT_TIMEOUT);
640 This->state = Req_Run;
641 This->stop_playback = 0;
642 ResetEvent(This->hEventStateChanged);
643 SetEvent(This->thread_sleepy);
649 HRESULT PullPin_PauseProcessing(PullPin * This)
651 /* if we are connected */
652 TRACE("(%p)->()\n", This);
655 assert(This->hThread);
657 PullPin_WaitForStateChange(This, INFINITE);
659 EnterCriticalSection(This->pin.pCritSec);
661 assert(!This->stop_playback);
662 assert(This->state == Req_Run|| This->state == Req_Sleepy);
664 assert(WaitForSingleObject(This->thread_sleepy, 0) == WAIT_TIMEOUT);
666 This->state = Req_Pause;
667 This->stop_playback = 1;
668 ResetEvent(This->hEventStateChanged);
669 SetEvent(This->thread_sleepy);
671 /* Release any outstanding samples */
674 IMediaSample *pSample;
680 IAsyncReader_WaitForNext(This->pReader, 0, &pSample, &dwUser);
682 IMediaSample_Release(pSample);
686 LeaveCriticalSection(This->pin.pCritSec);
692 static HRESULT PullPin_StopProcessing(PullPin * This)
694 TRACE("(%p)->()\n", This);
696 /* if we are alive */
697 assert(This->hThread);
699 PullPin_WaitForStateChange(This, INFINITE);
701 assert(This->state == Req_Pause || This->state == Req_Sleepy);
703 This->stop_playback = 1;
704 This->state = Req_Die;
705 assert(WaitForSingleObject(This->thread_sleepy, 0) == WAIT_TIMEOUT);
706 ResetEvent(This->hEventStateChanged);
707 SetEvent(This->thread_sleepy);
711 HRESULT PullPin_WaitForStateChange(PullPin * This, DWORD dwMilliseconds)
713 if (WaitForSingleObject(This->hEventStateChanged, dwMilliseconds) == WAIT_TIMEOUT)
718 HRESULT WINAPI PullPin_QueryAccept(IPin * iface, const AM_MEDIA_TYPE * pmt)
720 PullPin *This = (PullPin *)iface;
722 TRACE("(%p/%p)->(%p)\n", This, iface, pmt);
724 return (This->fnQueryAccept(This->pUserData, pmt) == S_OK ? S_OK : S_FALSE);
727 HRESULT WINAPI PullPin_EndOfStream(IPin * iface)
729 PullPin *This = (PullPin *)iface;
730 HRESULT hr = S_FALSE;
732 TRACE("(%p)->()\n", iface);
734 EnterCriticalSection(This->pin.pCritSec);
735 hr = SendFurther( iface, deliver_endofstream, NULL, NULL );
736 SetEvent(This->hEventStateChanged);
737 LeaveCriticalSection(This->pin.pCritSec);
742 HRESULT WINAPI PullPin_BeginFlush(IPin * iface)
744 PullPin *This = (PullPin *)iface;
745 TRACE("(%p)->()\n", This);
747 EnterCriticalSection(This->pin.pCritSec);
749 SendFurther( iface, deliver_beginflush, NULL, NULL );
751 LeaveCriticalSection(This->pin.pCritSec);
753 EnterCriticalSection(&This->thread_lock);
756 IAsyncReader_BeginFlush(This->pReader);
757 PullPin_WaitForStateChange(This, INFINITE);
759 if (This->hThread && This->state == Req_Run)
761 PullPin_PauseProcessing(This);
762 PullPin_WaitForStateChange(This, INFINITE);
765 LeaveCriticalSection(&This->thread_lock);
767 EnterCriticalSection(This->pin.pCritSec);
769 This->fnCleanProc(This->pUserData);
771 LeaveCriticalSection(This->pin.pCritSec);
776 HRESULT WINAPI PullPin_EndFlush(IPin * iface)
778 PullPin *This = (PullPin *)iface;
780 TRACE("(%p)->()\n", iface);
782 /* Send further first: Else a race condition might terminate processing early */
783 EnterCriticalSection(This->pin.pCritSec);
784 SendFurther( iface, deliver_endflush, NULL, NULL );
785 LeaveCriticalSection(This->pin.pCritSec);
787 EnterCriticalSection(&This->thread_lock);
792 IAsyncReader_EndFlush(This->pReader);
794 IBaseFilter_GetState(This->pin.pinInfo.pFilter, INFINITE, &state);
796 if (state != State_Stopped)
797 PullPin_StartProcessing(This);
799 PullPin_WaitForStateChange(This, INFINITE);
801 LeaveCriticalSection(&This->thread_lock);
806 HRESULT WINAPI PullPin_Disconnect(IPin *iface)
809 PullPin *This = (PullPin *)iface;
813 EnterCriticalSection(This->pin.pCritSec);
815 if (FAILED(hr = IMemAllocator_Decommit(This->pAlloc)))
816 ERR("Allocator decommit failed with error %x. Possible memory leak\n", hr);
818 if (This->pin.pConnectedTo)
820 IPin_Release(This->pin.pConnectedTo);
821 This->pin.pConnectedTo = NULL;
822 PullPin_StopProcessing(This);
824 FreeMediaType(&This->pin.mtCurrent);
825 ZeroMemory(&This->pin.mtCurrent, sizeof(This->pin.mtCurrent));
831 LeaveCriticalSection(This->pin.pCritSec);
836 HRESULT WINAPI PullPin_NewSegment(IPin * iface, REFERENCE_TIME tStart, REFERENCE_TIME tStop, double dRate)
839 FIXME("(%p)->(%s, %s, %g) stub\n", iface, wine_dbgstr_longlong(tStart), wine_dbgstr_longlong(tStop), dRate);
841 args.tStart = tStart;
845 return SendFurther( iface, deliver_newsegment, &args, NULL );
848 static const IPinVtbl PullPin_Vtbl =
850 PullPin_QueryInterface,
853 BaseInputPinImpl_Connect,
854 PullPin_ReceiveConnection,
856 BasePinImpl_ConnectedTo,
857 BasePinImpl_ConnectionMediaType,
858 BasePinImpl_QueryPinInfo,
859 BasePinImpl_QueryDirection,
862 BasePinImpl_EnumMediaTypes,
863 BasePinImpl_QueryInternalConnections,