MpStreamFeeder.h

Go to the documentation of this file.

//  
// Copyright (C) 2006 SIPez LLC. 
// Licensed to SIPfoundry under a Contributor Agreement. 
//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$

#ifndef DISABLE_STREAM_PLAYER // [

#ifndef _MpStreamFeeder_h_
#define _MpStreamFeeder_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include "os/OsDefs.h"
#include "os/OsTask.h"
#include "os/OsCSem.h"
#include "os/OsMsgQ.h"
#include "os/OsMutex.h"
#include "net/Url.h"
#include "mp/StreamDefs.h"
#include "mp/StreamDataSourceListener.h"
#include "mp/StreamDecoderListener.h"

// DEFINES
#define INCL_RAW_DECODER         // Include the RAW decoder
#define INCL_WAV_DECODER         // Include the WAV decoder
// #define INCL_MP3_DECODER         // Include the MP3 decoder


// MACROS
// EXTERNAL FUNCTIONS
// CONSTANTS
// STRUCTS
// TYPEDEFS

//: Feeder states (match player states for the most part, but add a 
//: realizing and rendering states)
typedef enum
{
   UnrealizedState,
   RealizedState,
   PrefetchingState,
   PrefetchedState,
   RendereringState,
   StoppedState,
   FailedState

} FeederState ;

// FORWARD DECLARATIONS
class StreamFormatDecoder ;
class StreamDataSource ;
class OsNotification ;


class MpStreamFeeder : public StreamDataSourceListener, public StreamDecoderListener
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

/* ============================ CREATORS ================================== */

   MpStreamFeeder(Url resource, int flags);

   MpStreamFeeder(UtlString* pBuffer, int flags);

   virtual ~MpStreamFeeder();
/* ============================ MANIPULATORS ============================== */
   
   OsStatus realize() ;

   OsStatus render() ;
   OsStatus rewind() ;
     //  This may result in re-prefetching data in cases.

   OsStatus stop();

   OsStatus setEventHandler(OsNotification* pEventHandler) ;
   void markPaused(UtlBoolean bPaused) ;


/* ============================ ACCESSORS ================================= */


   OsStatus getFrame(unsigned short *samples) ;

   UtlBoolean isMarkedPaused() ;

   OsStatus getFlags(int &flags) ;

   FeederState getState() ;

   void fromStreamUpdate(FeederEvent event) ;


/* ============================ INQUIRY =================================== */


   UtlBoolean isValidStateChange(FeederState source, FeederState target) ;

/* ============================ TESTING =================================== */

#ifdef MP_STREAM_DEBUG /* [ */
static const char* getEventString(FeederEvent event);
#endif /* MP_STREAM_DEBUG ] */


/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
   void fireEvent(FeederEvent eventType) ;

   void setState(FeederState state);

   virtual void decoderUpdate(StreamFormatDecoder* pDecoder, StreamDecoderEvent event) ;

   virtual void dataSourceUpdate(StreamDataSource* pDataSource, StreamDataSourceEvent event) ;   

#ifdef MP_STREAM_DEBUG /* [ */
   const char* getDataSourceEventString(StreamDataSourceEvent);
   const char* getDecoderEventString(StreamDecoderEvent);
   const char* getFeederEventString(FeederEvent event);
#endif /* MP_STREAM_DEBUG ] */


/* //////////////////////////// PRIVATE /////////////////////////////////// */
private: 
   static int s_iInstanceCount ;

   FeederState m_state;                      
   StreamFormatDecoder* m_pFormatDecoder;    
   StreamDataSource* m_pDataSource ;         
   int mFlags ;                              

   UtlBoolean m_bMarkedPaused;               
   OsNotification* m_pEventHandler;          
   int m_iInstanceId ;
   OsMutex m_eventGuard;                     


   void initDecodingSource() ;

};

/* ============================ INLINE METHODS ============================ */

#endif  // _MpStreamFeeder_h_

#endif // DISABLE_STREAM_PLAYER ]