Home | History | Annotate | Download | only in include 
      1 /* ------------------------------------------------------------------
      2  * Copyright (C) 1998-2009 PacketVideo
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  *      http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
     13  * express or implied.
     14  * See the License for the specific language governing permissions
     15  * and limitations under the License.
     16  * -------------------------------------------------------------------
     17  */
     18 #ifndef PVMF_OMX_AUDIODEC_FACTORY_H_INCLUDED
     19 #define PVMF_OMX_AUDIODEC_FACTORY_H_INCLUDED
     20 
     21 #ifndef OSCL_BASE_H_INCLUDED
     22 #include "oscl_base.h"
     23 #endif
     24 
     25 #ifndef OSCL_SCHEDULER_AO_H_INCLUDED
     26 #include "oscl_scheduler_ao.h"
     27 #endif
     28 
     29 // Forward declaration
     30 class PVMFNodeInterface;
     31 
     32 /* Audio decoder node factory related definitions*/
     33 
     34 #define KPVMFOMXAudioDecNodeUuid PVUuid(0x9fe9e9e1,0x2222,0x4394,0xad,0x85,0x43,0xd3,0x29,0x11,0x9a,0x4a)
     35 /**
     36  * PVMFOMXAudioDecNodeFactory Class
     37  *
     38  * a singleton class which instantiates and provides
     39  * access to OMX audio decoder node. It returns a PVMFNodeInterface
     40  * reference, the interface class of the PVMFAudioDecNode.
     41  *
     42  * The client is expected to contain and maintain a pointer to the instance created
     43  * while the node is active.
     44  */
     45 class PVMFOMXAudioDecNodeFactory
     46 {
     47     public:
     48         /**
     49          * Creates an instance of a PVMFOMXAudioDecNode. If the creation fails, this function will leave.
     50          *
     51          * @param aPriority The active object priority for the node. Default is standard priority if not specified
     52          * @returns A pointer to an instance of PVMFOMXAudioDecNode as PVMFNodeInterface reference or leaves if instantiation fails
     53          **/
     54         OSCL_IMPORT_REF static PVMFNodeInterface* CreatePVMFOMXAudioDecNode(int32 aPriority = OsclActiveObject::EPriorityNominal);
     55 
     56         /**
     57          * Deletes an instance of PVMFOMXAudioDecNode
     58          * and reclaims all allocated resources.  An instance can be deleted only in
     59          * the idle state. An attempt to delete in any other state will fail and return false.
     60          *
     61          * @param aNode The PVMFAVCDecNode instance to be deleted
     62          * @returns A status code indicating success or failure of deletion
     63          **/
     64         OSCL_IMPORT_REF static bool DeletePVMFOMXAudioDecNode(PVMFNodeInterface* aNode);
     65 };
     66 
     67 #endif // PVMF_OMX_AUDIODEC_FACTORY_H_INCLUDED
     68 
     69