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 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
);
137 if (pin_info
.pFilter
)
138 IBaseFilter_Release( pin_info
.pFilter
);
143 static void Copy_PinInfo(PIN_INFO
* pDest
, const PIN_INFO
* pSrc
)
145 /* Tempting to just do a memcpy, but the name field is
146 128 characters long! We will probably never exceed 10
147 most of the time, so we are better off copying
148 each field manually */
149 strcpyW(pDest
->achName
, pSrc
->achName
);
150 pDest
->dir
= pSrc
->dir
;
151 pDest
->pFilter
= pSrc
->pFilter
;
154 static HRESULT
deliver_endofstream(IPin
* pin
, LPVOID unused
)
156 return IPin_EndOfStream( pin
);
159 static HRESULT
deliver_beginflush(IPin
* pin
, LPVOID unused
)
161 return IPin_BeginFlush( pin
);
164 static HRESULT
deliver_endflush(IPin
* pin
, LPVOID unused
)
166 return IPin_EndFlush( pin
);
169 typedef struct newsegmentargs
171 REFERENCE_TIME tStart
, tStop
;
175 static HRESULT
deliver_newsegment(IPin
*pin
, LPVOID data
)
177 newsegmentargs
*args
= data
;
178 return IPin_NewSegment(pin
, args
->tStart
, args
->tStop
, args
->rate
);
181 /*** PullPin implementation ***/
183 static HRESULT
PullPin_Init(const IPinVtbl
*PullPin_Vtbl
, const PIN_INFO
* pPinInfo
, SAMPLEPROC_PULL pSampleProc
, LPVOID pUserData
,
184 QUERYACCEPTPROC pQueryAccept
, CLEANUPPROC pCleanUp
, REQUESTPROC pCustomRequest
, STOPPROCESSPROC pDone
, LPCRITICAL_SECTION pCritSec
, PullPin
* pPinImpl
)
186 /* Common attributes */
187 pPinImpl
->pin
.lpVtbl
= PullPin_Vtbl
;
188 pPinImpl
->pin
.refCount
= 1;
189 pPinImpl
->pin
.pConnectedTo
= NULL
;
190 pPinImpl
->pin
.pCritSec
= pCritSec
;
191 Copy_PinInfo(&pPinImpl
->pin
.pinInfo
, pPinInfo
);
192 ZeroMemory(&pPinImpl
->pin
.mtCurrent
, sizeof(AM_MEDIA_TYPE
));
194 /* Input pin attributes */
195 pPinImpl
->pUserData
= pUserData
;
196 pPinImpl
->fnQueryAccept
= pQueryAccept
;
197 pPinImpl
->fnSampleProc
= pSampleProc
;
198 pPinImpl
->fnCleanProc
= pCleanUp
;
199 pPinImpl
->fnDone
= pDone
;
200 pPinImpl
->fnPreConnect
= NULL
;
201 pPinImpl
->pAlloc
= NULL
;
202 pPinImpl
->pReader
= NULL
;
203 pPinImpl
->hThread
= NULL
;
204 pPinImpl
->hEventStateChanged
= CreateEventW(NULL
, TRUE
, TRUE
, NULL
);
205 pPinImpl
->thread_sleepy
= CreateEventW(NULL
, FALSE
, FALSE
, NULL
);
207 pPinImpl
->rtStart
= 0;
208 pPinImpl
->rtCurrent
= 0;
209 pPinImpl
->rtStop
= ((LONGLONG
)0x7fffffff << 32) | 0xffffffff;
210 pPinImpl
->dRate
= 1.0;
211 pPinImpl
->state
= Req_Die
;
212 pPinImpl
->fnCustomRequest
= pCustomRequest
;
213 pPinImpl
->stop_playback
= 1;
215 InitializeCriticalSection(&pPinImpl
->thread_lock
);
216 pPinImpl
->thread_lock
.DebugInfo
->Spare
[0] = (DWORD_PTR
)( __FILE__
": PullPin.thread_lock");
221 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
)
227 if (pPinInfo
->dir
!= PINDIR_INPUT
)
229 ERR("Pin direction(%x) != PINDIR_INPUT\n", pPinInfo
->dir
);
233 pPinImpl
= CoTaskMemAlloc(sizeof(*pPinImpl
));
236 return E_OUTOFMEMORY
;
238 if (SUCCEEDED(PullPin_Init(PullPin_Vtbl
, pPinInfo
, pSampleProc
, pUserData
, pQueryAccept
, pCleanUp
, pCustomRequest
, pDone
, pCritSec
, pPinImpl
)))
240 *ppPin
= (IPin
*)(&pPinImpl
->pin
.lpVtbl
);
244 CoTaskMemFree(pPinImpl
);
248 static HRESULT
PullPin_InitProcessing(PullPin
* This
);
250 HRESULT WINAPI
PullPin_ReceiveConnection(IPin
* iface
, IPin
* pReceivePin
, const AM_MEDIA_TYPE
* pmt
)
252 PIN_DIRECTION pindirReceive
;
254 PullPin
*This
= (PullPin
*)iface
;
256 TRACE("(%p/%p)->(%p, %p)\n", This
, iface
, pReceivePin
, pmt
);
257 dump_AM_MEDIA_TYPE(pmt
);
259 EnterCriticalSection(This
->pin
.pCritSec
);
260 if (!This
->pin
.pConnectedTo
)
262 ALLOCATOR_PROPERTIES props
;
265 props
.cbBuffer
= 64 * 1024; /* 64k bytes */
269 if (SUCCEEDED(hr
) && (This
->fnQueryAccept(This
->pUserData
, pmt
) != S_OK
))
270 hr
= VFW_E_TYPE_NOT_ACCEPTED
; /* FIXME: shouldn't we just map common errors onto
271 * VFW_E_TYPE_NOT_ACCEPTED and pass the value on otherwise? */
275 IPin_QueryDirection(pReceivePin
, &pindirReceive
);
277 if (pindirReceive
!= PINDIR_OUTPUT
)
279 ERR("Can't connect from non-output pin\n");
280 hr
= VFW_E_INVALID_DIRECTION
;
284 This
->pReader
= NULL
;
288 hr
= IPin_QueryInterface(pReceivePin
, &IID_IAsyncReader
, (LPVOID
*)&This
->pReader
);
291 if (SUCCEEDED(hr
) && This
->fnPreConnect
)
293 hr
= This
->fnPreConnect(iface
, pReceivePin
, &props
);
298 hr
= IAsyncReader_RequestAllocator(This
->pReader
, NULL
, &props
, &This
->pAlloc
);
303 CopyMediaType(&This
->pin
.mtCurrent
, pmt
);
304 This
->pin
.pConnectedTo
= pReceivePin
;
305 IPin_AddRef(pReceivePin
);
306 hr
= IMemAllocator_Commit(This
->pAlloc
);
310 hr
= PullPin_InitProcessing(This
);
315 IAsyncReader_Release(This
->pReader
);
316 This
->pReader
= NULL
;
318 IMemAllocator_Release(This
->pAlloc
);
323 hr
= VFW_E_ALREADY_CONNECTED
;
324 LeaveCriticalSection(This
->pin
.pCritSec
);
328 HRESULT WINAPI
PullPin_QueryInterface(IPin
* iface
, REFIID riid
, LPVOID
* ppv
)
330 PullPin
*This
= (PullPin
*)iface
;
332 TRACE("(%p/%p)->(%s, %p)\n", This
, iface
, qzdebugstr_guid(riid
), ppv
);
336 if (IsEqualIID(riid
, &IID_IUnknown
))
338 else if (IsEqualIID(riid
, &IID_IPin
))
340 else if (IsEqualIID(riid
, &IID_IMediaSeeking
) ||
341 IsEqualIID(riid
, &IID_IQualityControl
))
343 return IBaseFilter_QueryInterface(This
->pin
.pinInfo
.pFilter
, riid
, ppv
);
348 IUnknown_AddRef((IUnknown
*)(*ppv
));
352 FIXME("No interface for %s!\n", qzdebugstr_guid(riid
));
354 return E_NOINTERFACE
;
357 ULONG WINAPI
PullPin_Release(IPin
*iface
)
359 PullPin
*This
= (PullPin
*)iface
;
360 ULONG refCount
= InterlockedDecrement(&This
->pin
.refCount
);
362 TRACE("(%p)->() Release from %d\n", This
, refCount
+ 1);
366 WaitForSingleObject(This
->hEventStateChanged
, INFINITE
);
367 assert(!This
->hThread
);
370 IMemAllocator_Release(This
->pAlloc
);
372 IAsyncReader_Release(This
->pReader
);
373 CloseHandle(This
->thread_sleepy
);
374 CloseHandle(This
->hEventStateChanged
);
375 This
->thread_lock
.DebugInfo
->Spare
[0] = 0;
376 DeleteCriticalSection(&This
->thread_lock
);
383 static void PullPin_Flush(PullPin
*This
)
385 IMediaSample
*pSample
;
386 TRACE("Flushing!\n");
390 /* Flush outstanding samples */
391 IAsyncReader_BeginFlush(This
->pReader
);
397 IAsyncReader_WaitForNext(This
->pReader
, 0, &pSample
, &dwUser
);
402 assert(!IMediaSample_GetActualDataLength(pSample
));
404 IMediaSample_Release(pSample
);
407 IAsyncReader_EndFlush(This
->pReader
);
411 static void PullPin_Thread_Process(PullPin
*This
)
414 IMediaSample
* pSample
= NULL
;
415 ALLOCATOR_PROPERTIES allocProps
;
417 hr
= IMemAllocator_GetProperties(This
->pAlloc
, &allocProps
);
419 This
->cbAlign
= allocProps
.cbAlign
;
421 if (This
->rtCurrent
< This
->rtStart
)
422 This
->rtCurrent
= MEDIATIME_FROM_BYTES(ALIGNDOWN(BYTES_FROM_MEDIATIME(This
->rtStart
), This
->cbAlign
));
426 if (This
->rtCurrent
>= This
->rtStop
)
428 IPin_EndOfStream((IPin
*)This
);
432 /* There is no sample in our buffer */
433 hr
= This
->fnCustomRequest(This
->pUserData
);
436 ERR("Request error: %x\n", hr
);
438 EnterCriticalSection(This
->pin
.pCritSec
);
439 SetEvent(This
->hEventStateChanged
);
440 LeaveCriticalSection(This
->pin
.pCritSec
);
447 TRACE("Process sample\n");
450 hr
= IAsyncReader_WaitForNext(This
->pReader
, 10000, &pSample
, &dwUser
);
452 /* Return an empty sample on error to the implementation in case it does custom parsing, so it knows it's gone */
455 hr
= This
->fnSampleProc(This
->pUserData
, pSample
, dwUser
);
459 /* FIXME: This is not well handled yet! */
460 ERR("Processing error: %x\n", hr
);
461 if (hr
== VFW_E_TIMEOUT
)
471 IMediaSample_Release(pSample
);
474 } while (This
->rtCurrent
< This
->rtStop
&& hr
== S_OK
&& !This
->stop_playback
);
476 /* Sample was rejected, and we are asked to terminate */
479 IMediaSample_Release(pSample
);
482 /* Can't reset state to Sleepy here because that might race, instead PauseProcessing will do that for us
483 * Flush remaining samples
486 This
->fnDone(This
->pUserData
);
488 TRACE("End: %08x, %d\n", hr
, This
->stop_playback
);
491 static void PullPin_Thread_Pause(PullPin
*This
)
495 EnterCriticalSection(This
->pin
.pCritSec
);
496 This
->state
= Req_Sleepy
;
497 SetEvent(This
->hEventStateChanged
);
498 LeaveCriticalSection(This
->pin
.pCritSec
);
501 static void PullPin_Thread_Stop(PullPin
*This
)
503 TRACE("(%p)->()\n", This
);
505 EnterCriticalSection(This
->pin
.pCritSec
);
507 CloseHandle(This
->hThread
);
508 This
->hThread
= NULL
;
509 SetEvent(This
->hEventStateChanged
);
511 LeaveCriticalSection(This
->pin
.pCritSec
);
513 IBaseFilter_Release(This
->pin
.pinInfo
.pFilter
);
519 static DWORD WINAPI
PullPin_Thread_Main(LPVOID pv
)
522 CoInitializeEx(NULL
, COINIT_MULTITHREADED
);
528 WaitForSingleObject(This
->thread_sleepy
, INFINITE
);
530 TRACE("State: %d\n", This
->state
);
534 case Req_Die
: PullPin_Thread_Stop(This
); break;
535 case Req_Run
: PullPin_Thread_Process(This
); break;
536 case Req_Pause
: PullPin_Thread_Pause(This
); break;
537 case Req_Sleepy
: ERR("Should not be signalled with SLEEPY!\n"); break;
538 default: ERR("Unknown state request: %d\n", This
->state
); break;
544 static HRESULT
PullPin_InitProcessing(PullPin
* This
)
548 TRACE("(%p)->()\n", This
);
550 /* if we are connected */
555 WaitForSingleObject(This
->hEventStateChanged
, INFINITE
);
556 EnterCriticalSection(This
->pin
.pCritSec
);
558 assert(!This
->hThread
);
559 assert(This
->state
== Req_Die
);
560 assert(This
->stop_playback
);
561 assert(WaitForSingleObject(This
->thread_sleepy
, 0) == WAIT_TIMEOUT
);
562 This
->state
= Req_Sleepy
;
564 /* AddRef the filter to make sure it and it's pins will be around
565 * as long as the thread */
566 IBaseFilter_AddRef(This
->pin
.pinInfo
.pFilter
);
569 This
->hThread
= CreateThread(NULL
, 0, PullPin_Thread_Main
, This
, 0, &dwThreadId
);
572 hr
= HRESULT_FROM_WIN32(GetLastError());
573 IBaseFilter_Release(This
->pin
.pinInfo
.pFilter
);
578 SetEvent(This
->hEventStateChanged
);
579 /* If assert fails, that means a command was not processed before the thread previously terminated */
581 LeaveCriticalSection(This
->pin
.pCritSec
);
584 TRACE(" -- %x\n", hr
);
589 HRESULT
PullPin_StartProcessing(PullPin
* This
)
591 /* if we are connected */
592 TRACE("(%p)->()\n", This
);
595 assert(This
->hThread
);
597 PullPin_WaitForStateChange(This
, INFINITE
);
599 assert(This
->state
== Req_Sleepy
);
602 assert(WaitForSingleObject(This
->thread_sleepy
, 0) == WAIT_TIMEOUT
);
603 This
->state
= Req_Run
;
604 This
->stop_playback
= 0;
605 ResetEvent(This
->hEventStateChanged
);
606 SetEvent(This
->thread_sleepy
);
612 HRESULT
PullPin_PauseProcessing(PullPin
* This
)
614 /* if we are connected */
615 TRACE("(%p)->()\n", This
);
618 assert(This
->hThread
);
620 PullPin_WaitForStateChange(This
, INFINITE
);
622 EnterCriticalSection(This
->pin
.pCritSec
);
624 assert(!This
->stop_playback
);
625 assert(This
->state
== Req_Run
|| This
->state
== Req_Sleepy
);
627 assert(WaitForSingleObject(This
->thread_sleepy
, 0) == WAIT_TIMEOUT
);
628 This
->state
= Req_Pause
;
629 This
->stop_playback
= 1;
630 ResetEvent(This
->hEventStateChanged
);
631 SetEvent(This
->thread_sleepy
);
633 LeaveCriticalSection(This
->pin
.pCritSec
);
639 static HRESULT
PullPin_StopProcessing(PullPin
* This
)
641 TRACE("(%p)->()\n", This
);
643 /* if we are alive */
644 assert(This
->hThread
);
646 PullPin_WaitForStateChange(This
, INFINITE
);
648 assert(This
->state
== Req_Pause
|| This
->state
== Req_Sleepy
);
650 This
->stop_playback
= 1;
651 This
->state
= Req_Die
;
652 assert(WaitForSingleObject(This
->thread_sleepy
, 0) == WAIT_TIMEOUT
);
653 ResetEvent(This
->hEventStateChanged
);
654 SetEvent(This
->thread_sleepy
);
658 HRESULT
PullPin_WaitForStateChange(PullPin
* This
, DWORD dwMilliseconds
)
660 if (WaitForSingleObject(This
->hEventStateChanged
, dwMilliseconds
) == WAIT_TIMEOUT
)
665 HRESULT WINAPI
PullPin_QueryAccept(IPin
* iface
, const AM_MEDIA_TYPE
* pmt
)
667 PullPin
*This
= (PullPin
*)iface
;
669 TRACE("(%p/%p)->(%p)\n", This
, iface
, pmt
);
671 return (This
->fnQueryAccept(This
->pUserData
, pmt
) == S_OK
? S_OK
: S_FALSE
);
674 HRESULT WINAPI
PullPin_EndOfStream(IPin
* iface
)
676 FIXME("(%p)->() stub\n", iface
);
678 return SendFurther( iface
, deliver_endofstream
, NULL
, NULL
);
681 HRESULT WINAPI
PullPin_BeginFlush(IPin
* iface
)
683 PullPin
*This
= (PullPin
*)iface
;
684 TRACE("(%p)->()\n", This
);
686 EnterCriticalSection(This
->pin
.pCritSec
);
688 SendFurther( iface
, deliver_beginflush
, NULL
, NULL
);
690 LeaveCriticalSection(This
->pin
.pCritSec
);
692 EnterCriticalSection(&This
->thread_lock
);
695 IAsyncReader_BeginFlush(This
->pReader
);
696 PullPin_WaitForStateChange(This
, INFINITE
);
698 if (This
->hThread
&& This
->state
== Req_Run
)
700 PullPin_PauseProcessing(This
);
701 PullPin_WaitForStateChange(This
, INFINITE
);
704 LeaveCriticalSection(&This
->thread_lock
);
706 EnterCriticalSection(This
->pin
.pCritSec
);
708 This
->fnCleanProc(This
->pUserData
);
710 LeaveCriticalSection(This
->pin
.pCritSec
);
715 HRESULT WINAPI
PullPin_EndFlush(IPin
* iface
)
717 PullPin
*This
= (PullPin
*)iface
;
719 TRACE("(%p)->()\n", iface
);
721 /* Send further first: Else a race condition might terminate processing early */
722 EnterCriticalSection(This
->pin
.pCritSec
);
723 SendFurther( iface
, deliver_endflush
, NULL
, NULL
);
724 LeaveCriticalSection(This
->pin
.pCritSec
);
726 EnterCriticalSection(&This
->thread_lock
);
731 IAsyncReader_EndFlush(This
->pReader
);
733 IBaseFilter_GetState(This
->pin
.pinInfo
.pFilter
, INFINITE
, &state
);
735 if (state
!= State_Stopped
)
736 PullPin_StartProcessing(This
);
738 PullPin_WaitForStateChange(This
, INFINITE
);
740 LeaveCriticalSection(&This
->thread_lock
);
745 HRESULT WINAPI
PullPin_Disconnect(IPin
*iface
)
748 PullPin
*This
= (PullPin
*)iface
;
752 EnterCriticalSection(This
->pin
.pCritSec
);
754 if (FAILED(hr
= IMemAllocator_Decommit(This
->pAlloc
)))
755 ERR("Allocator decommit failed with error %x. Possible memory leak\n", hr
);
757 if (This
->pin
.pConnectedTo
)
759 IPin_Release(This
->pin
.pConnectedTo
);
760 This
->pin
.pConnectedTo
= NULL
;
761 PullPin_StopProcessing(This
);
763 FreeMediaType(&This
->pin
.mtCurrent
);
764 ZeroMemory(&This
->pin
.mtCurrent
, sizeof(This
->pin
.mtCurrent
));
770 LeaveCriticalSection(This
->pin
.pCritSec
);
775 HRESULT WINAPI
PullPin_NewSegment(IPin
* iface
, REFERENCE_TIME tStart
, REFERENCE_TIME tStop
, double dRate
)
778 FIXME("(%p)->(%s, %s, %g) stub\n", iface
, wine_dbgstr_longlong(tStart
), wine_dbgstr_longlong(tStop
), dRate
);
780 args
.tStart
= tStart
;
784 return SendFurther( iface
, deliver_newsegment
, &args
, NULL
);
787 static const IPinVtbl PullPin_Vtbl
=
789 PullPin_QueryInterface
,
792 BaseInputPinImpl_Connect
,
793 PullPin_ReceiveConnection
,
795 BasePinImpl_ConnectedTo
,
796 BasePinImpl_ConnectionMediaType
,
797 BasePinImpl_QueryPinInfo
,
798 BasePinImpl_QueryDirection
,
801 BasePinImpl_EnumMediaTypes
,
802 BasePinImpl_QueryInternalConnections
,