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_DUMMY_FILEINPUT_NODE_FACTORY_H_INCLUDED
     19 #define PVMF_DUMMY_FILEINPUT_NODE_FACTORY_H_INCLUDED
     20 
     21 #ifndef OSCL_BASE_H_INCLUDED
     22 #include "oscl_base.h"
     23 #endif
     24 #ifndef PVMF_FILEINPUT_SETTINGS_H_INCLUDED
     25 #include "pvmf_fileinput_settings.h"
     26 #endif
     27 #ifndef OSCL_SCHEDULER_AO_H_INCLUDED
     28 #include "oscl_scheduler_ao.h"
     29 #endif
     30 
     31 // Forward declarations
     32 class PVMFNodeInterface;
     33 
     34 /**
     35  * Factory class for PVMFDummyFileInputNode
     36  */
     37 class PVMFDummyFileInputNodeFactory
     38 {
     39     public:
     40         /**
     41          * Creates an instance of a file input node. If the creation fails, this function will leave.
     42          *
     43          * @param aPriority The active object priority for the node. Default is standard priority if not specified
     44          * @param aSettings Settings for the file input node
     45          * @returns A pointer to an author or leaves if instantiation fails
     46          **/
     47         OSCL_IMPORT_REF static PVMFNodeInterface* CreateDummyFileInputNode(PVMFFileInputSettings* aSettings,
     48                 int32 aPriority = OsclActiveObject::EPriorityNominal);
     49 
     50         /**
     51          * This function allows the application to delete an instance of file input node
     52          * and reclaim all allocated resources.  An instance can be deleted only in
     53          * the idle state. An attempt to delete in any other state will fail and return false.
     54          *
     55          * @param aNode The file input node to be deleted.
     56          * @returns A status code indicating success or failure.
     57          **/
     58         OSCL_IMPORT_REF static bool DeleteDummyFileInputNode(PVMFNodeInterface*& aNode);
     59 };
     60 
     61 #endif // PVMF_DUMMY_FILEINPUT_NODE_FACTORY_H_INCLUDED
     62