rmpfs.h

Sample code for use on smp 863x processor.

/*****************************************
 Copyright 2001-2007
 Sigma Designs, Inc. All Rights Reserved
 Proprietary and Confidential
 *****************************************/
/**
  @file   rmpfs.h
  @brief  

  The pfs (Play For Sure) functions are used to start the
  bufferisation of files before the user asks for the playback.  This
  way when the user asks for a given url to be played, the first
  kilobytes of the files are already stored in memory and they can be
  demuxed and play without delay. The caller of these functions has to
  know which urls are likely to be played next so that they are
  already buffered when the user requests to play them.

  @author Julien Soulier
  @date   2007-01-10
*/

#ifndef __RMPFS_H__
#define __RMPFS_H__

#include "../rmdef/rmdef.h"
#include "../rmlibcw/include/rmlibcw.h"
#include "../rmcore/include/rmcore.h"

struct pfs_profile {
	void *prefetch_area;
	RMuint32 prefetch_area_size;
	RMuint32 prefetch_slots;
};


RM_EXTERN_C_BLOCKSTART

#define MAX_NUMBER_OF_CACHEABLE_URL 32

/**
   enables the pre-bufferisation of url before the playback. Gives as
   argument the buffer in OS memory where to prebuffer the URL. The
   maximum number of URL that can be stored simultaneously in the
   buffering_area equals: 
     url_buffering_size = buffering_area_size/prebuffering_slots;

   @param profile       
   @return 
*/
RMstatus rmpfs_open(struct pfs_profile *profile);

     
/**
   Notify the play for sure code to not use the buffering area anymore.
   
   @return 
*/
RMstatus rmpfs_close(void);

/**
   allocates a prefetch slot for a given url.
   
   @param url
   @param slot
   @return 
*/
RMstatus rmpfs_allocate_slot_to_url(RMascii *url, RMuint32 slot);


/**
   begin prefetch for the given slot.
   
   @param slot
   @return
*/
RMstatus rmpfs_prefetch_slot(RMuint32 slot);


/**
   removes the bufferized bytes from the given url. The buffering area
   can now be used for another url.

   @param slot
   @return
*/
RMstatus rmpfs_close_slot(RMuint32 slot);


RM_EXTERN_C_BLOCKEND


#endif // __RMPFS_H__