inc/FMediaIAudioStreamFilter.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.0 (the License);
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //     http://www.apache.org/licenses/LICENSE-2.0
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17
  18 /**
  19  * @file                        FMediaIAudioStreamFilter.h
  20  * @brief                       This is the header file for the %IAudioStreamFilter interface.
  21  *
  22  * This header file contains the declarations of the %IAudioStreamFilter interface.
  23  */
  24
  25 #ifndef _FMEDIA_IAUDIO_STREAM_FILTER_H_
  26 #define _FMEDIA_IAUDIO_STREAM_FILTER_H_
  27
  28 namespace Tizen { namespace Media
  29 {
  30 class AudioFrame;
  31
  32 /**
  33  * @interface   IAudioStreamFilter
  34  * @brief               This interface represents a filter that processes an audio stream data.
  35  *
  36  * @since               2.1
  37  *
  38  * The %IAudioStreamFilter interface represents a filter that processes an audio stream data.
  39 */
  40 class _OSP_EXPORT_ IAudioStreamFilter
  41 {
  42
  43 public:
  44         /**
  45         * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when
  46         * the destructor of this interface is called.
  47         *
  48         * @since                2.1
  49         */
  50         virtual ~IAudioStreamFilter(void) {}
  51
  52         /**
  53         *       Processes an audio stream.
  54         *
  55         * @since                2.1
  56         *
  57         * @param[in,out]        frame   A frame object containing the audio frame data
  58         * @remarks This method should not contain any operations that harm thread safety or performance degradation.
  59         */
  60         virtual void ProcessAudioStream(AudioFrame& frame) = 0;
  61
  62 protected:
  63         //
  64         // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  65         //
  66         // This method is reserved and may change its name at any time without prior notice.
  67         //
  68         // @since               2.1
  69         //
  70         virtual void IAudioStreamFilter_Reserved1(void) {}
  71
  72         //
  73         // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  74         //
  75         // This method is reserved and may change its name at any time without prior notice.
  76         //
  77         // @since               2.1
  78         //
  79         virtual void IAudioStreamFilter_Reserved2(void) {}
  80 };
  81
  82 }}// Tizen::Media
  83
  84 #endif