[xiph-commits] r8748 - trunk/oggdsf/src/lib/core/directshow/dsfOggMux

[illiminable at motherfish-iii.xiph.org]

Author: illiminable
Date: 2005-01-11 22:25:45 -0800 (Tue, 11 Jan 2005)
New Revision: 8748

Modified:
   trunk/oggdsf/src/lib/core/directshow/dsfOggMux/OggMuxFilter.h
   trunk/oggdsf/src/lib/core/directshow/dsfOggMux/OggMuxInputPin.h
Log:
* Little bit of docs on the mux filter.

Modified: trunk/oggdsf/src/lib/core/directshow/dsfOggMux/OggMuxFilter.h
===================================================================
--- trunk/oggdsf/src/lib/core/directshow/dsfOggMux/OggMuxFilter.h	2005-01-12 04:54:14 UTC (rev 8747)
+++ trunk/oggdsf/src/lib/core/directshow/dsfOggMux/OggMuxFilter.h	2005-01-12 06:25:45 UTC (rev 8748)
@@ -69,19 +69,44 @@
 	//IAMFilterMiscFlags Implementation
 	ULONG STDMETHODCALLTYPE GetMiscFlags(void);
 
-	//IOggCallback Implementation
+	// ***************************************
+	// ***** IOggCallback Implementation *****
+	// ***************************************
+
+	/// Takes an incoming page, usually from the interleaver.
 	virtual bool acceptOggPage(OggPage* inOggPage);
-	//IFileSinkFilter Implementation
+	
+	// ******************************************
+	// ***** IFileSinkFilter Implementation *****
+	// ******************************************
+
+	/// Sets the filename to be used to output to
 	STDMETHODIMP SetFileName(LPCOLESTR inFileName, const AM_MEDIA_TYPE* inMediaType);
+
+	/// Gets the output filename this filter is currently using.
 	STDMETHODIMP GetCurFile(LPOLESTR* outFileName, AM_MEDIA_TYPE* outMediaType);
 
-	//IPin Interface (i Think ?? From CBAseFilter)
+	// *************************************
+	// ***** CBaseFilter Pure Virtuals *****
+	// *************************************
+
+	/// Returns the number of pins this filter has
 	virtual int GetPinCount();
+
+	/// Returns the indexed pin or NULL.
 	virtual CBasePin* GetPin(int inPinNo);
 
-	//Streaming MEthods
+	// **********************************
+	// ***** IMediaFilter Overrides *****
+	// **********************************
+
+	/// Called when the graph starts playing
 	STDMETHODIMP Run(REFERENCE_TIME tStart);
+
+	/// Called when the graph pauses
 	STDMETHODIMP Pause(void);
+
+	/// Called when the graph stops
 	STDMETHODIMP Stop(void);
 
 	//Helpers

Modified: trunk/oggdsf/src/lib/core/directshow/dsfOggMux/OggMuxInputPin.h
===================================================================
--- trunk/oggdsf/src/lib/core/directshow/dsfOggMux/OggMuxInputPin.h	2005-01-12 04:54:14 UTC (rev 8747)
+++ trunk/oggdsf/src/lib/core/directshow/dsfOggMux/OggMuxInputPin.h	2005-01-12 06:25:45 UTC (rev 8748)
@@ -54,13 +54,25 @@
 	DECLARE_IUNKNOWN
 	STDMETHODIMP NonDelegatingQueryInterface(REFIID riid, void **ppv);
 
+	/// Gets an indexed media type, that this pin will accept.
 	virtual HRESULT GetMediaType(int inPosition, CMediaType* outMediaType);
+
+	/// Checks whether this pin will accepted the proposed media type.
 	virtual HRESULT CheckMediaType(const CMediaType* inMediaType);
+
+	/// Notification that this media type has been selected for the connection.
 	virtual HRESULT SetMediaType(const CMediaType* inMediaType);
 
+	/// Receives a sample from an upstream filter.
 	STDMETHODIMP Receive(IMediaSample* inSample);
-	virtual STDMETHODIMP EndOfStream(void);
+
+	/// Notification that the stream has ended
+	virtual STDMETHODIMP EndOfStream();
+
+	/// Notification that the output pin of an upstream filter has connected.
 	virtual HRESULT CompleteConnect(IPin* inReceivePin);
+
+	/// Notification the output pin of an upstream filter has been disconnected.
 	virtual HRESULT BreakConnect();
 	
 	//virtual HRESULT DeliverEndFlush(void);