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_VIDEODEC_FACTORY_H_INCLUDED
     19 #define PVMF_OMX_VIDEODEC_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 #define KPVMFOMXVideoDecNodeUuid PVUuid(0x8f39e9d1,0x1232,0x4394,0xad,0x85,0x43,0xd3,0x29,0x11,0x9a,0x4a)
     33 /**
     34  * PVMFOMXVideoDecNodeFactory Class
     35  *
     36  * a singleton class which instantiates and provides
     37  * access to OMX video decoder node. It returns a PVMFNodeInterface
     38  * reference, the interface class of the PVMFVideoDecNode.
     39  *
     40  * The client is expected to contain and maintain a pointer to the instance created
     41  * while the node is active.
     42  */
     43 class PVMFOMXVideoDecNodeFactory
     44 {
     45     public:
     46         /**
     47          * Creates an instance of a PVMFOMXVideoDecNode. If the creation fails, this function will leave.
     48          *
     49          * @param aPriority The active object priority for the node. Default is standard priority if not specified
     50          * @returns A pointer to an instance of PVMFOMXVideoDecNode as PVMFNodeInterface reference or leaves if instantiation fails
     51          **/
     52         OSCL_IMPORT_REF static PVMFNodeInterface* CreatePVMFOMXVideoDecNode(int32 aPriority = OsclActiveObject::EPriorityNominal, bool aHwAccelerated = true);
     53 
     54         /**
     55          * Deletes an instance of PVMFOMXVideoDecNode
     56          * and reclaims all allocated resources.  An instance can be deleted only in
     57          * the idle state. An attempt to delete in any other state will fail and return false.
     58          *
     59          * @param aNode The PVMFAVCDecNode instance to be deleted
     60          * @returns A status code indicating success or failure of deletion
     61          **/
     62         OSCL_IMPORT_REF static bool DeletePVMFOMXVideoDecNode(PVMFNodeInterface* aNode);
     63 };
     64 
     65 #endif // PVMF_OMX_VIDEODEC_FACTORY_H_INCLUDED
     66 
     67