h264_enc/arih264enchwdevice/inc/arih264encconfigdataci.h
changeset 0 bb31fbe78861
equal deleted inserted replaced
-1:000000000000 0:bb31fbe78861
       
     1 /*
       
     2 * Copyright (c) 2009 Aricent and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of the License "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Aricent - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:
       
    15 * User defined encoder init data custom interface for H264 encoder plugin.
       
    16 *
       
    17 */
       
    18 
       
    19 /**
       
    20 * Example of the CI usage:
       
    21 * 1. Create CI.
       
    22 * MH324AnnexKDefinedEncoderConfigDataCI* userConfigCI = NULL;
       
    23 * userConfigCI = (MH324AnnexKDefinedEncoderConfigDataCI*)
       
    24 * 					iDevvrInstance->CustomInterface( hwdevUid,
       
    25 * 					KH324AnnexKDefinedEncoderConfigDataCIUid );
       
    26 *
       
    27 * CDEVVRVideoRecord iDevvrInstance    - The instance of the DeviceVideoRecord;
       
    28 * TUid hwdevUid                       - Encoder HwDevice Uid;
       
    29 * KH324AnnexKDefinedEncoderConfigDataCIUid  - Custom Interface Uid;
       
    30 *
       
    31 *
       
    32 * 2. TInt status = userConfigCI->H324AnnexKDefinedEncoderConfigDataOn();
       
    33 *
       
    34 *    if ( status != KErrNone )
       
    35 *        {
       
    36 *        // handle error
       
    37 *        }
       
    38 *
       
    39 * 3. This CI API H324AnnexKDefinedEncoderConfigDataOn() can only be called
       
    40 * before the initializing phase (Before Initialize() method is called by
       
    41 * DevVideo).
       
    42 *
       
    43 */
       
    44 
       
    45 #ifndef ARIH264ENCCONFIGDATACI_H 
       
    46 #define ARIH264ENCCONFIGDATACI_H
       
    47 
       
    48 
       
    49 // CONSTANTS
       
    50 // Custom Interface UId
       
    51 const TUid KH324AnnexKDefinedEncoderConfigDataCIUid = {0x10204C0B};
       
    52 
       
    53 // CLASS DECLARATION
       
    54 /**
       
    55  *  User defined encoder confguration data custom interface
       
    56  */
       
    57 class MH324AnnexKDefinedEncoderConfigDataCI
       
    58     {
       
    59     public:
       
    60 
       
    61         /**
       
    62         * Enables inserting H324 pre-defind config data (VOL / SPS PPS / etc.)
       
    63         * @param none
       
    64         * @return KErrNone - Success, otherwise KErrGeneral - Error, unable
       
    65         * to process operation
       
    66         */
       
    67         virtual TInt H324AnnexKDefinedEncoderConfigDataOn() = 0;
       
    68 
       
    69     };
       
    70 
       
    71 
       
    72 #endif  // ARIH264ENCCONFIGDATACI_H