MpStreamPlaylistPlayer.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 _MpStreamPlaylistPlayer_h_
#define _MpStreamPlaylistPlayer_h_

#ifndef DISABLE_STREAM_PLAYER // [

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "mp/MpPlayer.h"
#include "mp/StreamDefs.h"
#include "net/Url.h"
#include "os/OsBSem.h"
#include "os/OsEvent.h"
#include "os/OsDefs.h"
#include "os/OsServerTask.h"
#include "os/OsStatus.h"
#include "os/OsQueuedEvent.h"

// DEFINES
#define MAX_PLAYLIST_LENGTH      40    
#define REALIZE_TIMEOUT          15    
#define PREFETCH_TIMEOUT         30    
#define PLAY_TIMEOUT            180    
#define REWIND_TIMEOUT           15    
#define STOP_TIMEOUT             15    
#define DESTROY_TIMEOUT          30    

// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class UtlString;

class MpStreamPlaylistPlayer : public OsServerTask, public MpPlayer
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

   typedef enum
   {
      SourceUrl,
      SourceBuffer
   } SourceType;

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


   MpStreamPlaylistPlayer(OsMsgQ* pMsgQ, const char* pTarget = NULL);


   virtual
   ~MpStreamPlaylistPlayer();


/* ============================ MANIPULATORS ============================== */


   virtual OsStatus add( Url& url  
                       , int flags 
                       );


   virtual OsStatus add(UtlString* pBuffer, int flags);
   virtual OsStatus realize(UtlBoolean bBlock = TRUE); 
   virtual OsStatus prefetch(UtlBoolean bBlock = TRUE); 
   virtual OsStatus play(UtlBoolean bBlock = TRUE);
   virtual OsStatus wait(const OsTime& rTimeout = OsTime::OS_INFINITY);
   virtual OsStatus rewind(UtlBoolean bBlock = TRUE);
   virtual OsStatus reset() ;

   virtual OsStatus stop() ;

   virtual OsStatus destroy() ;

   virtual OsStatus pause() ;



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


   virtual OsStatus getCount(int& count) const ;

   virtual OsStatus getSourceType(int index, int& type) const ;

   virtual OsStatus getSourceUrl(int index, Url url) const ;

   virtual OsStatus getSourceBuffer(int index, UtlString*& netBuffer) const ;

   virtual OsStatus getSourceState(int index, PlayerState& state) const ;

   virtual OsStatus getCurrentIndex(int& iIndex) const ;

   virtual OsStatus getState(PlayerState& state)  ;


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



/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:

   MpStreamPlaylistPlayer(const MpStreamPlaylistPlayer& rMpStreamPlaylistPlayer);

   MpStreamPlaylistPlayer& operator=(const MpStreamPlaylistPlayer& rhs);

   virtual OsStatus first() ;
   virtual OsStatus last() ;   
   virtual OsStatus playNext(UtlBoolean bBlock = TRUE) ;

   virtual OsStatus playPrevious(UtlBoolean bBlock = TRUE) ;

   void setEntryState(int index, PlayerState iState) ;

   OsStatus playEntry(int iEntry, UtlBoolean bBlock = TRUE);

   OsStatus rewindEntry(int iEntry, UtlBoolean bBlock = TRUE);

   OsStatus stopEntry(int index, UtlBoolean bBlock = TRUE);

   OsStatus pauseEntry(int index);

   OsStatus destroyEntry(int index, UtlBoolean bBlockAndClean = TRUE);

   virtual UtlBoolean handleMessage(OsMsg& rMsg) ;

   void handleRealizedState(int index, PlayerState oldState, PlayerState newState);

   void handlePrefetchedState(int index, PlayerState oldState, PlayerState newState);

   void handlePlayingState(int index, PlayerState oldState, PlayerState newState);

   void handlePausedState(int index, PlayerState oldState, PlayerState newState);

   void handleStoppedState(int index, PlayerState oldState, PlayerState newState);

   void handleFailedState(int index, PlayerState oldState, PlayerState newState);

   const char* getFeederEventString(int iEvent);

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:

   struct PlaylistDb
   {
      int            sourceType ;   
      Url            url ;          
      UtlString*     pBuffer ;      
      StreamHandle   handle ;       
      PlayerState    state ;        
      int            flags ;        
      OsQueuedEvent* pQueuedEvent ; 
   }  ;


   int mNumPlayListElements;        
   int mCurrentElement ;            
   int mPlayingElement ;            

   OsQueuedEvent* mpQueueEvent;     
   OsBSem mSemStateChange;          
   OsMsgQ* mpMsgQ;                  
   UtlString mTarget;               
   OsEvent mWaitEvent;              
   OsTime mRealizeTimeout;          
   OsTime mPrefetchTimeout;         
   OsTime mPlayTimeout;             
   OsTime mRewindTimeout;           
   OsTime mStopTimeout;             
   OsTime mDestroyTimeout;          

   UtlBoolean mbAutoAdvance;        

   struct PlaylistDb mPlayListDb[MAX_PLAYLIST_LENGTH];   
   PlayerState mAggregateState ;    
};

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

#endif // DISABLE_STREAM_PLAYER ]

#endif  // _MpStreamPlaylistPlayer_h_