stmr_dl.h File Reference

IC Streamer download manager. More...

#include "techtype.h"
#include "dvb_ics.h"
#include "stmr_util.h"
#include "mh5profile.h"
#include "stmr_header.h"

Go to the source code of this file.

Data Structures
struct	sMHEG5HttpStreamRequest

Typedefs
typedef struct sMHEG5HttpStreamRequest	MHEG5HttpStreamRequest

Functions
U32BIT	MHEG5CreateDownloadRequest (U32BIT requestId, char *url, U64BIT rangeFrom, U64BIT rangeTo, BOOLEAN lastRequest)
	Create HTTP download request. More...
void	MHEG5StartDownloadRequest (U32BIT downloadId)
	Start HTTP download request. More...
BOOLEAN	MHEG5DownloadPositionPartial (U32BIT downloadId, U64BIT *position)
	Return what is current position of download request. More...
U8BIT *	MHEG5GetDownloadRedirect (U32BIT downloadId)
	Return the redirection URL for a request that was redirected (HTTP status 3xx). More...
U64BIT	MHEG5GetDownloadContentLength (U32BIT downloadId, U64BIT contentLength)
	Return content length (in bytes) for download request. The content length may be: More...
void	MHEG5CopyDownloadBitrate (U32BIT downloadId, U32BIT *bytesPerSecond)
	Copy download bitrate that was obtained from the headers. If the X-BytesPerSecond header were not received, the bitrate is not updated. More...
void	MHEG5CopyDownloadStreamKeyInfo (U32BIT downloadId, S_ICSKeys *keys, MHEG5String *keyLocation)
	Copy any keys or key location that were obtained from the headers. If such keys or location exist, they are also cleared from the download request (i.e. ownership is transferred to the caller). In addition, the caller keys and key location are also cleared. If such keys or key location does not exist, the function does not overwrite the caller's keys or key location. More...
BOOLEAN	MHEG5GetDownloadPmt (U32BIT downloadId, U8BIT *pmt)
	Return program map table (PMT) for download (if available). The table is provided as a complete section, including table_id and CRC_32. More...
void	MHEG5ResumeDownload (void)
	Resume download of the active request. Download may or may not have been paused due to the buffer being full. More...
void	MHEG5ClearDownloadThrottling (void)
	Clear information about throttling, causing the download to proceed at full speed (until throttling kicks in again). More...
void	MHEG5StopDownloadRequest (U32BIT downloadId)
	Stop HTTP download request. More...
void	MHEG5StopDownloadRequestAsync (U32BIT downloadId)
	Stop HTTP download request asynchronously. This function should be used when the caller wants to stop the download from one of the callbacks. In that case the download will be paused and notified as complete. The caller can then handle the event and stop/destroy the request. More...
void	MHEG5DestroyDownloadRequest (U32BIT downloadId)
	Destroy HTTP download request. More...
void	MHEG5ClearDownloadRequest (U32BIT downloadId)
	Clear HTTP download request. More...
void	MHEG5RenewDownloadRequest (U32BIT downloadId, char *url)
	Renew HTTP download request. More...

Detailed Description

IC Streamer download manager.

Date

20/12/2012

Author

Adam Sturtridge

Function Documentation

void MHEG5ClearDownloadRequest

(

U32BIT

downloadId

)

Clear HTTP download request.

Parameters

downloadId

Download request ID

Returns

Nothing

void MHEG5ClearDownloadThrottling

(

void

)

Clear information about throttling, causing the download to proceed at full speed (until throttling kicks in again).

Returns

Nothing

void MHEG5CopyDownloadBitrate	(	U32BIT	downloadId,
		U32BIT *	bytesPerSecond
	)

Copy download bitrate that was obtained from the headers. If the X-BytesPerSecond header were not received, the bitrate is not updated.

Parameters

downloadId	Download request ID
bytesPerSecond	Stream bitrate (bytes per second)

Returns

Nothing

void MHEG5CopyDownloadStreamKeyInfo	(	U32BIT	downloadId,
		S_ICSKeys *	keys,
		MHEG5String *	keyLocation
	)

Copy any keys or key location that were obtained from the headers. If such keys or location exist, they are also cleared from the download request (i.e. ownership is transferred to the caller). In addition, the caller keys and key location are also cleared. If such keys or key location does not exist, the function does not overwrite the caller's keys or key location.

Parameters

downloadId	Download request ID
keyLocation	Key location (if any)

Returns

Nothing

Parameters

downloadId	Download request ID
keys	Keys (if any)
keyLocation	Key location (if any)

Returns

Nothing

U32BIT MHEG5CreateDownloadRequest	(	U32BIT	requestId,
		char *	url,
		U64BIT	rangeFrom,
		U64BIT	rangeTo,
		BOOLEAN	lastRequest
	)

Create HTTP download request.

Parameters

requestId	Request ID to be stored with downloaded items
url	URL for request
rangeFrom	Range from in bytes (0 for "start")
rangeTo	Range to in bytes (invalid for "end")
lastRequest	Whether this is the last request for this URL

Returns

Donwload ID (non-zero) if request was created, 0 (zero) otherwise

void MHEG5DestroyDownloadRequest

(

U32BIT

downloadId

)

Destroy HTTP download request.

Parameters

downloadId

Download request ID

Returns

Nothing

BOOLEAN MHEG5DownloadPositionPartial	(	U32BIT	downloadId,
		U64BIT *	position
	)

Return what is current position of download request.

Parameters

downloadId	Download request ID
position	current position (downloaded bytes)

Returns

TRUE if position is only partial download

U64BIT MHEG5GetDownloadContentLength	(	U32BIT	downloadId,
		U64BIT	contentLength
	)

Return content length (in bytes) for download request. The content length may be:

1. The length value from Content-Range
2. The value of Content-Length
3. Invalid value (if not available)

   Parameters

   downloadId	Download request ID
   contentLength	Content length in bytes

   Returns

   Content length in bytes

BOOLEAN MHEG5GetDownloadPmt	(	U32BIT	downloadId,
		U8BIT *	pmt
	)

Return program map table (PMT) for download (if available). The table is provided as a complete section, including table_id and CRC_32.

Parameters

downloadId	Download request ID
pmt	Storage area for PMT (1024 bytes)

Returns

TRUE if PMT is available, FALSE otherwise

U8BIT* MHEG5GetDownloadRedirect

(

U32BIT

downloadId

)

Return the redirection URL for a request that was redirected (HTTP status 3xx).

Parameters

downloadId

Download request ID

Returns

Redirection URL or NULL

void MHEG5RenewDownloadRequest	(	U32BIT	downloadId,
		char *	url
	)

Renew HTTP download request.

Parameters

downloadId

Download request ID

Returns

Nothing

void MHEG5ResumeDownload

(

void

)

Resume download of the active request. Download may or may not have been paused due to the buffer being full.

Returns

Nothing

void MHEG5StartDownloadRequest

(

U32BIT

downloadId

)

Start HTTP download request.

Parameters

downloadId

Download request ID

Returns

Nothing

void MHEG5StopDownloadRequest

(

U32BIT

downloadId

)

Stop HTTP download request.

Parameters

downloadId

Download request ID

Returns

Nothing

void MHEG5StopDownloadRequestAsync

(

U32BIT

downloadId

)

Stop HTTP download request asynchronously. This function should be used when the caller wants to stop the download from one of the callbacks. In that case the download will be paused and notified as complete. The caller can then handle the event and stop/destroy the request.

Parameters

downloadId

Download request ID

Returns

Nothing