mmlibs/mmfw/codecs/Inc/Gsm610CodecCommon/gsm610common.h
author hgs
Wed, 13 Oct 2010 12:45:32 +0100
changeset 2 5c1df44f2eed
parent 0 b8ed18f6c07b
permissions -rw-r--r--
2010wk42_01
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     1
// Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     2
// All rights reserved.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     3
// This component and the accompanying materials are made available
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     5
// which accompanies this distribution, and is available
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     7
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     8
// Initial Contributors:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    10
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    11
// Contributors:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    12
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    13
// Description:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    14
//      Interfaces and factories for the GSM 06.10 encoder and decoder.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    15
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    16
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    17
#ifndef GSM610COMMON_H
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    18
#define GSM610COMMON_H
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    19
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    20
#include <e32std.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    21
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    22
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    23
/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    24
 * Provides an interface to the GSM 6.10 full rate (FR) speech encoder.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    25
 * 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    26
 * Class is intantiated via GSM610FR_EncoderFactory::CreateEncoderL().
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    27
 * 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    28
 * @see GSM610FR_EncoderFactory
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    29
 * */
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    30
class MGSM610FR_Encoder
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    31
    {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    32
public:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    33
    virtual void StartL() = 0;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    34
    virtual void ExecuteL(TUint8* aInBuf, TUint8* OutBuf) = 0;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    35
    virtual void StopL() = 0;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    36
    virtual void Release() = 0;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    37
    };
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    38
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    39
/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    40
 * Provides an interface to the GSM 6.10 full rate (FR) speech decoder.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    41
 * 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    42
 * Class is intantiated via GSM610FR_DecoderFactory::CreateDecoderL().
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    43
 * 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    44
 * @see GSM610FR_DecoderFactory
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    45
 * */
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    46
class MGSM610FR_Decoder
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    47
    {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    48
public:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    49
    virtual void StartL() = 0;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    50
    virtual void ExecuteL(TUint8* aSrc, TUint8* aDst) = 0;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    51
    virtual void StopL() = 0;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    52
    virtual void Release() = 0;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    53
    };
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    54
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    55
/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    56
 * Factory class for GSM 6.10 full rate (FR) speech encoder.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    57
 * 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    58
 * Client code can use the factory method to create an encoder object and obtain a handle to it.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    59
 * All operations on the encoder are done through the MGSM610FR_Encoder interface. The client code
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    60
 * is responsible for destroying the encoder by calling MGSM610FR_Encoder::Release().
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    61
 * 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    62
 * @see MGSM610FR_Encoder
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    63
 * */
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    64
class GSM610FR_EncoderFactory
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    65
    {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    66
public:    
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    67
    IMPORT_C static MGSM610FR_Encoder* CreateEncoderL();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    68
    };
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    69
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    70
/**
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    71
 * Factory class for GSM 6.10 full rate (FR) speech decoder.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    72
 * 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    73
 * Client code can use the factory method to create an decoder object and obtain a handle to it.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    74
 * All operations on the decoder are done through the MGSM610FR_Decoder interface. The client code
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    75
 * is responsible for destroying the decoder by calling MGSM610FR_Decoder::Release().
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    76
 * 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    77
 * @see MGSM610FR_Decoder
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    78
 * */
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    79
class GSM610FR_DecoderFactory
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    80
    {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    81
public:    
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    82
    IMPORT_C static MGSM610FR_Decoder* CreateDecoderL();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    83
    };
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    84
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    85
#endif