ADTF Filter SDK

Table of Contents

• Introduction
• Dependency
• C++ Classes
  • Namespaces
  • Main Classes and interfaces
• Using the Filter SDK

The ADTF Filter SDK Package defines a internal Filter Architecture.

The main header to include is:

#include <adtffiltersdk/adtf_filtersdk.h>

Introduction

The main focus of this SDK package is to develop customized filters and Streaming Sources.

For an explaination for the different use-cases please see

• Filter
• Streaming Service

Use the base classes provided at Using the Filter SDK.

Dependency

The ADTF Filter SDK depends on the ADTF Streaming SDK and ADTF Media Description SDK.

C++ Classes

Namespaces

adtf

Namespace for entire ADTF SDK.

adtf::filter

Namespace for the ADTF Filter SDK.

adtf::filter::testing

Namespace for all testing functionality of the ADTF Filter SDK.

Main Classes and interfaces

cFilter

Base class for ADTF filters.

cSampleStreamingSource

Base class for ADTF sample streaming sources.

cSampleStreamingSink

Base class for ADTF sample streaming sinks.

cPinWriter

use cSampleWriter as cPinWriter

pin_writer

Specialized Sample Writer to write DATA of type DATA_TYPE.

cPinReader

use cSampleReader as cPinReader

time_limited_pin_reader

The time_limited_sample_reader will create a sample reader which will create a internal sample queue that is time limited by the given TimeRange.

size_limited_pin_reader

The size_limited_sample_reader will create a sample reader which will create a internal sample queue that is sample count item limited by the given TimeRange.

Using the Filter SDK

The Filter SDK provides base classes to facilitate the implementation of Filters and Streaming Services.

• For developing Filters use cFilter
• For developing Sample Streaming Sources use cSampleStreamingSource
• For developing Sample Streaming Sinks use cSampleStreamingSink

They may be part of the Filter Graph and Streaming Graph.

This Filter SDK allows you to develop non-UI Filters.
If you want to develop Filters that display and vizualize data, have a look at ADTF UI SDK.

Legacy and Trigger Functions

Starting from ADTF 3.5 onwards, all functionality provided by the "old" Trigger Functions API can now easily be replaced by the cFilter API which is a lot more flexible and still requires less code. The Trigger Functions API is here to stay, but will no longer be maintained besides bugfixing.

The Trigger Functions API is separated into two parts:

PART 1: Definition of Triggers and Triggerfunctions.

See the Legacy Trigger Function for more information on that

PART 2: Definition of Standard Filter Implementations.

See Legacy Standard Filter