source/classes/inc/mh5stream.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2004 Ocean Blue Software Ltd
 * Copyright © 2000 Koninklijke Philips Electronics N.V
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 * 
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 * 
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
#ifndef _MH5STREAM_H_
#define _MH5STREAM_H_

#include "mh5presentable.h"
#include "mh5visible.h"
#include "dvblocator.h"
#include "fs_types.h"

/* Video, Audio, anything else? */
#define MAX_MLTPLX   8

typedef enum
{
   SS_STOPPED,
   SS_STOPPING,
   SS_STARTING,
   SS_PLAYING,
   SS_PLAYING_CLIP,
   SS_NEW_REF,
   SS_FROZEN
} E_StreamState;

typedef struct scounterTrigger
{
   MHEG5Int id;
   MHEG5Int pos;
   struct scounterTrigger *next;
} MHEG5CounterTrigger;


typedef struct
{
   /* Base class */
   MHEG5Ingredient ingredient;

   /* Exchanged attributes */
   MHEG5Ingredient *multiplex[MAX_MLTPLX];
   MHEG5Bool storageMemory;
   MHEG5Bool reloading;
   MHEG5Int looping;

   /* Internal attributes */
   MHEG5Int speed[2];
   MHEG5Int counterPosition;
   MHEG5Int counterEndPosition;
   MHEG5CounterTrigger *counterTriggers;
   MHEG5Int counterMaxPosition;

   /* Engine data */
   E_StreamState streamState;
   S_DVB_LOCATOR dvbLocator;
   F_DESTROY dsmClearFunc;
   FS_HANDLE dsmRef;
} MHEG5Stream;

void MHEG5streamInit(MHEG5Stream *stream);


void MHEG5streamFree(MHEG5Stream *stream);

/*
    Internal behaviours
 */
void MHEG5streamPrepare(MHEG5Stream *stream);
void MHEG5streamActivate(MHEG5Stream *stream);
void MHEG5streamDeactivate(MHEG5Stream *stream);
void MHEG5streamDestruct(MHEG5Stream *stream);

/*
    Actions
 */
MHEG5ErrorCode MHEG5setCounterTrigger(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5setSpeed(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5setCounterPosition(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5setCounterEndPosition(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5getCounterPosition(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5getCounterMaxPosition(MHEG5Root *target, MHEG5GList *params);


void MHEG5streamContentAdapt( MHEG5Stream *stream, S_CONTENT *content );


MHEG5Bool MHEG5streamGetCurrentService(S_DVB_LOCATOR *multiplexRef);


void MHEG5streamFindCurrentService(void);


void MHEG5streamSetCurrentService(MHEG5Ingredient *item,
   S_DvbComponent *service);


void MHEG5streamClearCurrentService(void);


MHEG5Int MHEG5streamGetComponentTag(MHEG5Ingredient *item);


/*
   Debug
 */
#ifdef MH5PRINTOUT
void MHEG5streamPrint(MHEG5Stream *stream, char *out);
#endif

#endif /*_MH5STREAM_H*/