dlls/quartz/pin.h

   1 /*
   2  * IPin function declarations to allow inheritance
   3  *
   4  * Copyright 2003 Robert Shearman
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  */
  20
  21 /* This function will process incoming samples to the pin.
  22  * Any return value valid in IMemInputPin::Receive is allowed here
  23  *
  24  * Cookie is the cookie that was set when requesting the buffer, if you don't
  25  * implement custom requesting, you can safely ignore this
  26  */
  27 typedef HRESULT (* SAMPLEPROC_PULL)(LPVOID userdata, IMediaSample * pSample, DWORD_PTR cookie);
  28
  29 /* This function will determine whether a type is supported or not.
  30  * It is allowed to return any error value (within reason), as opposed
  31  * to IPin::QueryAccept which is only allowed to return S_OK or S_FALSE.
  32  */
  33 typedef HRESULT (* QUERYACCEPTPROC)(LPVOID userdata, const AM_MEDIA_TYPE * pmt);
  34
  35 /* This function is called prior to finalizing a connection with
  36  * another pin and can be used to get things from the other pin
  37  * like IMemInput interfaces.
  38  *
  39  * props contains some defaults, but you can safely override them to your liking
  40  */
  41 typedef HRESULT (* PRECONNECTPROC)(IPin * iface, IPin * pConnectPin, ALLOCATOR_PROPERTIES *props);
  42
  43 /* This function is called whenever a cleanup operation has to occur,
  44  * this is usually after a flush, seek, or end of stream notification.
  45  * This code may even be repeated multiple times, so build your code to
  46  * tolerate this behavior. Return value is ignored and should be S_OK.
  47  */
  48 typedef HRESULT (* CLEANUPPROC) (LPVOID userdata);
  49
  50 /* This function is called whenever a request for a new sample is made,
  51  * If you implement it (it can be NULL for default behavior), you have to
  52  * call IMemAllocator_GetBuffer and IMemAllocator_RequestBuffer
  53  * This is useful if you want to request more than 1 buffer at simultaneously
  54  *
  55  * This will also cause the Sample Proc to be called with empty buffers to indicate
  56  * failure in retrieving the sample.
  57  */
  58 typedef HRESULT (* REQUESTPROC) (LPVOID userdata);
  59
  60 /* This function is called after processing is done (for whatever reason that is caused)
  61  * This is useful if you create processing threads that need to die
  62  */
  63 typedef HRESULT (* STOPPROCESSPROC) (LPVOID userdata);
  64
  65 #define ALIGNDOWN(value,boundary) ((value)/(boundary)*(boundary))
  66 #define ALIGNUP(value,boundary) (ALIGNDOWN((value)+(boundary)-1, (boundary)))
  67
  68 typedef struct PullPin
  69 {
  70         /* inheritance C style! */
  71         BasePin pin;
  72         LPVOID pUserData;
  73
  74         REFERENCE_TIME rtStart, rtCurrent, rtNext, rtStop;
  75         IAsyncReader * pReader;
  76         IMemAllocator * prefAlloc;
  77         IMemAllocator * pAlloc;
  78         QUERYACCEPTPROC fnQueryAccept;
  79         SAMPLEPROC_PULL fnSampleProc;
  80         PRECONNECTPROC fnPreConnect;
  81         REQUESTPROC fnCustomRequest;
  82         CLEANUPPROC fnCleanProc;
  83         STOPPROCESSPROC fnDone;
  84         double dRate;
  85         BOOL stop_playback;
  86         DWORD cbAlign;
  87
  88         /* Any code that touches the thread must hold the thread lock,
  89          * lock order: thread_lock and then the filter critical section
  90          * also signal thread_sleepy so the thread knows to wake up
  91          */
  92         CRITICAL_SECTION thread_lock;
  93         HANDLE hThread;
  94         DWORD requested_state;
  95         HANDLE hEventStateChanged, thread_sleepy;
  96         DWORD state;
  97 } PullPin;
  98
  99 #define Req_Sleepy 0
 100 #define Req_Die    1
 101 #define Req_Run    2
 102 #define Req_Pause  3
 103
 104 /*** Constructors ***/
 105 HRESULT PullPin_Construct(const IPinVtbl *PullPin_Vtbl, const PIN_INFO * pPinInfo,
 106                           SAMPLEPROC_PULL pSampleProc, LPVOID pUserData, QUERYACCEPTPROC pQueryAccept,
 107                           CLEANUPPROC pCleanUp, REQUESTPROC pCustomRequest, STOPPROCESSPROC pDone,
 108                           LPCRITICAL_SECTION pCritSec, IPin ** ppPin);
 109
 110 /**************************/
 111 /*** Pin Implementation ***/
 112
 113 /* Pull Pin */
 114 HRESULT WINAPI PullPin_ReceiveConnection(IPin * iface, IPin * pReceivePin, const AM_MEDIA_TYPE * pmt);
 115 HRESULT WINAPI PullPin_Disconnect(IPin * iface);
 116 HRESULT WINAPI PullPin_QueryInterface(IPin * iface, REFIID riid, LPVOID * ppv);
 117 ULONG   WINAPI PullPin_Release(IPin * iface);
 118 HRESULT WINAPI PullPin_EndOfStream(IPin * iface);
 119 HRESULT WINAPI PullPin_QueryAccept(IPin * iface, const AM_MEDIA_TYPE * pmt);
 120 HRESULT WINAPI PullPin_BeginFlush(IPin * iface);
 121 HRESULT WINAPI PullPin_EndFlush(IPin * iface);
 122 HRESULT WINAPI PullPin_NewSegment(IPin * iface, REFERENCE_TIME tStart, REFERENCE_TIME tStop, double dRate);
 123
 124 /* Thread interaction functions: Hold the thread_lock before calling them */
 125 HRESULT PullPin_StartProcessing(PullPin * This);
 126 HRESULT PullPin_PauseProcessing(PullPin * This);
 127 HRESULT PullPin_WaitForStateChange(PullPin * This, DWORD dwMilliseconds);
 128
 129 /* COM helpers */
 130 static inline PullPin *impl_PullPin_from_IPin( IPin *iface )
 131 {
 132     return CONTAINING_RECORD(iface, PullPin, pin.IPin_iface);
 133 }