A specialization of a DirectShow graph for tuner reception (Windows-specific). More...

#include <tsTunerGraph.h>

Inheritance diagram for ts::TunerGraph:

Collaboration diagram for ts::TunerGraph:

Public Types
enum	PropSearch { psFIRST , psLAST , psLOWEST , psHIGHEST }
	Search criteria for properties. More...

Public Member Functions
	TunerGraph ()=default
	Default constructor.

virtual	~TunerGraph ()
	Destructor.

bool	addFilter (::IBaseFilter filter, const wchar_t name, Report &report)
	Add a filter in the graph.

bool	cleanupDownstream (::IBaseFilter *filter, Report &report)
	In the graph, cleanup everything downstream a specified filter.

virtual void	clear (Report &report) override
	Clear the graph back to uninitialized state.

bool	connectFilters (::IBaseFilter filter1, ::IBaseFilter filter2, Report &report)
	Directly connect two filters using whatever output and input pin.

void	display (std::ostream &output, Report &report, const UString &margin=UString(), bool verbose=true)
	Display the description of the graph.

bool	initialize (const UString &tuner_name, ::IMoniker *tuner_moniker, DeliverySystemSet &delivery_systems, Report &report)
	Initialize the graph.

bool	initialize (Report &report)
	Initialize the graph.

bool	isValid () const
	Check if the graph was correctly initialized.

bool	removeFilter (::IBaseFilter *filter, Report &report)
	Remove a filter from the graph.

bool	run (Report &report)
	Run the graph.

template<typename VALTYPE , typename IVALTYPE , class FILTER , typename std::enable_if< std::is_base_of<::IBDA_SignalStatistics, FILTER >::value >::type * = nullptr>
bool	searchProperty (VALTYPE &retvalue, PropSearch searchtype, ::HRESULT(__stdcall FILTER::getmethod)(IVALTYPE ), const ::GUID &propset, int propid)
	Search a property, until found, in all interfaces of a given class and then in tuner properties.

template<typename VALTYPE >
bool	searchTunerProperty (VALTYPE &retvalue, PropSearch searchtype, const ::GUID &propset, int propid)
	Search all IKsPropertySet in the tuner until the specified data is found.

template<typename VALTYPE , typename ARGTYPE , typename IVALTYPE , class FILTER , typename std::enable_if< std::is_same<::IBDA_DigitalDemodulator, FILTER >::value >::type * = nullptr>
bool	searchVarProperty (VALTYPE unset, std::optional< ARGTYPE > &parameter, PropSearch searchtype, bool reset_unknown, ::HRESULT(__stdcall FILTER::getmethod)(IVALTYPE ), const ::GUID &propset, int propid)
	Search a property, until found, in all interfaces of a given class and then in tuner properties.

bool	sendTuneRequest (DuckContext &duck, const ModulationArgs &params)
	Send a tune request.

void	setReceiverName (const UString &name)
	Specify a receiver filter name.

SinkFilter *	sinkFilter () const
	Get the sink filter of the graph.

ComPtr<::IBaseFilter >	startingFilter (Report &report)
	Get the starting filter of the graph.

bool	stop (Report &report)
	Stop the graph.

Detailed Description

A specialization of a DirectShow graph for tuner reception (Windows-specific).

A DirectShow graph for TS capture is usually made of the following filters:

Network provider (typically "Microsoft DVBx Network Provider")
Tuner (typically provided by tuner hardware vendor as "BDA driver")
Receiver (optional, also provided by tuner hardware vendor)
Tee filter, creating two branches:
Branch A: actual capture of TS packets
- SinkFiler (provided by TSDuck)
Branch B: MPEG-2 demux, actually unused but required by the graph
- MPEG-2 demultiplexer
- TIF (Transport Information Filter)

Member Enumeration Documentation

◆ PropSearch

enum ts::TunerGraph::PropSearch

Search criteria for properties.

Enumerator

psLAST

Keep first value, when found.

psLOWEST

Keep last value.

psHIGHEST

Keep lowest value.

Keep highest value.

Member Function Documentation

◆ setReceiverName()

void ts::TunerGraph::setReceiverName ( const UString & name )

inline

Specify a receiver filter name.

Must be called before initialize(). The graph will use the specified receiver filter instead of the standard algorithm.

Parameters

[in] name Name of the receiver filter to use.

◆ initialize() [1/2]

bool ts::TunerGraph::initialize	(	const UString &	tuner_name,
		::IMoniker *	tuner_moniker,
		DeliverySystemSet &	delivery_systems,
		Report &	report
	)

Initialize the graph.

Parameters

[in]	tuner_name	Tuner filter name (informational only).
[in,out]	tuner_moniker	A moniker to create instances of a tuner filter. This tuner filter is the base of the graph creation (not the starting point of the graph, which is the network provider filter).
[out]	delivery_systems	List of delivery systems which are supported by the tuner.
[in,out]	report	Where to report errors.

Returns: True on success, false on error.

◆ clear()

virtual void ts::TunerGraph::clear ( Report & report )

overridevirtual

Clear the graph back to uninitialized state.

Parameters

[in,out] report Where to report errors.

Reimplemented from ts::DirectShowGraph.

◆ sinkFilter()

SinkFilter * ts::TunerGraph::sinkFilter ( ) const

inline

Get the sink filter of the graph.

This is where the TS packets can be fetched out of the graph.

Returns: The address of the sink filter or a null pointer if the graph is not initialized.

◆ sendTuneRequest()

bool ts::TunerGraph::sendTuneRequest	(	DuckContext &	duck,
		const ModulationArgs &	params
	)

Send a tune request.

Parameters

[in,out]	duck	TSDuck execution context.
[in]	params	Modulation parameters.

Returns: True on success, false on error.

◆ searchTunerProperty()

template<typename VALTYPE >

bool ts::TunerGraph::searchTunerProperty	(	VALTYPE &	retvalue,
		PropSearch	searchtype,
		const ::GUID &	propset,
		int	propid
	)

Search all IKsPropertySet in the tuner until the specified data is found.

Template Parameters

VALTYPE The type of the property to search.

Parameters

[out]	retvalue	Returned property value.
[in]	searchtype	Selection criteria for the final value.
[in]	propset	GUID of the property set.
[in]	propid	Id of the property to search.

Returns: True when the property was found, false otherwise.

◆ searchProperty()

template<typename VALTYPE , typename IVALTYPE , class FILTER , typename std::enable_if< std::is_base_of<::IBDA_SignalStatistics, FILTER >::value >::type * = nullptr>

bool ts::TunerGraph::searchProperty	(	VALTYPE &	retvalue,
		PropSearch	searchtype,
		::HRESULT(__stdcall FILTER::)(IVALTYPE )	getmethod,
		const ::GUID &	propset,
		int	propid
	)

inline

Search a property, until found, in all interfaces of a given class and then in tuner properties.

Template Parameters

VALTYPE	The type of the property to search.
IVALTYPE	The type of the property in the get_XXX() method of the object.
FILTER	The interface class through which the property can be found.

Parameters

[out]	retvalue	Returned property value.
[in]	searchtype	Selection criteria for the final value.
[in]	getmethod	The get_XXX() method of the object to retrieve the property. Used to search in ivector.
[in]	propset	GUID of the property set. Used to search in tuner properties.
[in]	propid	Id of the property to search.

Returns: True when the property was found, false otherwise.

◆ searchVarProperty()

template<typename VALTYPE , typename ARGTYPE , typename IVALTYPE , class FILTER , typename std::enable_if< std::is_same<::IBDA_DigitalDemodulator, FILTER >::value >::type * = nullptr>

bool ts::TunerGraph::searchVarProperty	(	VALTYPE	unset,
		std::optional< ARGTYPE > &	parameter,
		PropSearch	searchtype,
		bool	reset_unknown,
		::HRESULT(__stdcall FILTER::)(IVALTYPE )	getmethod,
		const ::GUID &	propset,
		int	propid
	)

inline

Search a property, until found, in all interfaces of a given class and then in tuner properties.

Same as previous method, with additional handling of unknown return value.

Template Parameters

VALTYPE	The type of the property to search.
ARGTYPE
IVALTYPE	The type of the property in the get_XXX() method of the object.
FILTER	The interface class through which the property can be found.

Parameters

[in]	unset	A value which, when returned by the interface, means "value is unset".
[in,out]	parameter	A variable object containing the result. When the value is considered as "unset", the variable is reset (becomes uninitialized).
[in]	searchtype	Selection criteria for the final value.
[in]	reset_unknown	If true and the property cannot be found, reset the variable in parameter.
[in]	getmethod	The get_XXX() method of the object to retrieve the property. Used to search in ivector.
[in]	propset	GUID of the property set. Used to search in tuner properties.
[in]	propid	Id of the property to search.

Returns: True when the property was found, false otherwise.

◆ initialize() [2/2]

bool ts::DirectShowGraph::initialize ( Report & report )

inherited

Initialize the graph.

Parameters

[in,out] report Where to report errors.

Returns: True on success, false on error.

◆ isValid()

bool ts::DirectShowGraph::isValid ( ) const

inherited

Check if the graph was correctly initialized.

Returns: True if the graph was correctly initialized.

◆ addFilter()

bool ts::DirectShowGraph::addFilter	(	::IBaseFilter *	filter,
		const wchar_t *	name,
		Report &	report
	)

inherited

Add a filter in the graph.

Parameters

[in,out]	filter	The filter to add.
[in]	name	Filter name.
[in,out]	report	Where to report errors.

Returns: True on success, false on error.

◆ removeFilter()

bool ts::DirectShowGraph::removeFilter	(	::IBaseFilter *	filter,
		Report &	report
	)

inherited

Remove a filter from the graph.

Parameters

[in,out]	filter	The filter to remove.
[in,out]	report	Where to report errors.

Returns: True on success, false on error.

◆ connectFilters()

bool ts::DirectShowGraph::connectFilters	(	::IBaseFilter *	filter1,
		::IBaseFilter *	filter2,
		Report &	report
	)

inherited

Directly connect two filters using whatever output and input pin.

Parameters

[in,out]	filter1	DirectShow filter with output pins.
[in,out]	filter2	DirectShow filter with input pins.
[in,out]	report	Where to report errors.

Returns: True on success, false on error.

◆ cleanupDownstream()

bool ts::DirectShowGraph::cleanupDownstream	(	::IBaseFilter *	filter,
		Report &	report
	)

inherited

In the graph, cleanup everything downstream a specified filter.

All downstream filters are disconnected and removed from the graph.

Parameters

[in,out]	filter	DirectShow filter.
[in,out]	report	Where to report errors.

Returns: True on success, false on error.

◆ startingFilter()

ComPtr<::IBaseFilter > ts::DirectShowGraph::startingFilter ( Report & report )

inherited

Get the starting filter of the graph.

Parameters

[in,out] report Where to report errors.

Returns: A pointer to the first filter with no connected input pin or a null pointer if not found.

◆ run()

bool ts::DirectShowGraph::run ( Report & report )

inherited

Run the graph.

Parameters

[in,out] report Where to report errors.

Returns: True on success, false on error.

◆ stop()

bool ts::DirectShowGraph::stop ( Report & report )

inherited

Stop the graph.

Parameters

[in,out] report Where to report errors.

Returns: True on success or already stopped, false on error.

◆ display()

void ts::DirectShowGraph::display	(	std::ostream &	output,
		Report &	report,
		const UString &	margin = `UString()`,
		bool	verbose = `true`
	)

inherited

Display the description of the graph.

Parameters

[in,out]	output	Where to display test results.
[in,out]	report	Where to report errors.
[in]	margin	Left margin to display.
[in]	verbose	True for verbose information.

The documentation for this class was generated from the following file:

tsTunerGraph.h

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ PropSearch

Member Function Documentation

◆ setReceiverName()

◆ initialize() [1/2]

◆ clear()

◆ sinkFilter()

◆ sendTuneRequest()

◆ searchTunerProperty()

◆ searchProperty()

◆ searchVarProperty()

◆ initialize() [2/2]

◆ isValid()

◆ addFilter()

◆ removeFilter()

◆ connectFilters()

◆ cleanupDownstream()

◆ startingFilter()

◆ run()

◆ stop()

◆ display()