nodes/pvamrffparsernode/include/pvmf_amrffparser_factory.h

/* ------------------------------------------------------------------
 * Copyright (C) 1998-2009 PacketVideo
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 * -------------------------------------------------------------------
 */
#ifndef PVMF_AMRFFPARSER_FACTORY_H_INCLUDED
#define PVMF_AMRFFPARSER_FACTORY_H_INCLUDED

#ifndef OSCL_SCHEDULER_AO_H_INCLUDED
#include "oscl_scheduler_ao.h"
#endif

// Forward declaration
class PVMFNodeInterface;

#define KPVMFAmrFFParserNodeUuid PVUuid(0x9966e471,0xc1b7,0x4b3c,0x93,0x9e,0x1e,0x00,0xc8,0xed,0xe5,0xf4)


/**
 * PVMFAMRFFParserNodeFactory Class
 *
 * PVMFAMRFFParserNodeFactory class is a singleton class which instantiates and provides
 * access to PVMF GSM-AMR NB audio decoder node. It returns a PVMFNodeInterface
 * reference, the interface class of the PVMFAMRFFParserNode.
 *
 * The client is expected to contain and maintain a pointer to the instance created
 * while the node is active.
 */
class PVMFAMRFFParserNodeFactory
{
    public:
        /**
         * Creates an instance of a PVMFAMRFFParserNode. If the creation fails, this function will leave.
         *
         * @param aPriority The active object priority for the node. Default is standard priority if not specified
         * @returns A pointer to an instance of PVMFAMRFFParserNode as PVMFNodeInterface reference or leaves if instantiation fails
         **/
        OSCL_IMPORT_REF static PVMFNodeInterface* CreatePVMFAMRFFParserNode(int32 aPriority = OsclActiveObject::EPriorityNominal);

        /**
         * Deletes an instance of PVMFAMRFFParserNode
         * and reclaims all allocated resources.  An instance can be deleted only in
         * the idle state. An attempt to delete in any other state will fail and return false.
         *
         * @param aNode The PVMFAMRFFParserNode instance to be deleted
         * @returns A status code indicating success or failure of deletion
         **/
        OSCL_IMPORT_REF static bool DeletePVMFAMRFFParserNode(PVMFNodeInterface* aNode);
};



#endif // PVMF_AMRFFPARSER_FACTORY_H_INCLUDED