mh5gate.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 _MH5GATE_H
#define _MH5GATE_H

/*---includes for this file--------------------------------------------------*/

#include "mh5base.h"

/*---Constant and macro definitions for public use---------------------------*/

#define ORIGIN_MAX  ORIGIN_ERROR

/*---Enumerations for public use---------------------------------------------*/

/* Enumerated type to tell where the origin of a file is (i.e. the part before
 * "://")
 */
typedef enum
{
   ORIGIN_DSM,     /* DSM-CC file system (DSM://)              */
   ORIGIN_CI,      /* CI file system (CI://)                   */
   ORIGIN_HYBRID,  /* Hybrid file system (hybrid://)           */
   ORIGIN_HTTP,    /* HTTP file system (http://)               */
   ORIGIN_HTTPS,   /* HTTPS file system (https://)             */
   ORIGIN_DVB,     /* DAVIC URL format (dvb://)                */
   ORIGIN_REC,     /* UK-DTT URL inherritance format (rec://)  */
   ORIGIN_ERROR    /* Unknown origin - last in list            */
} E_FS_ORIGIN;

/*---Global type defs for public use-----------------------------------------*/

/*---Global variable declarations for public use-----------------------------*/

/*---Global Function prototypes for public use-------------------------------*/

MHEG5Int MHEG5FullOriginLength(E_FS_ORIGIN origin);

MHEG5Bool MHEG5ResolveOrigin(MHEG5String *ref, E_FS_ORIGIN *pOrigin, MHEG5Int *offset);

MHEG5String MHEG5convertGIDGetOrigin( MHEG5String *inRef, E_FS_ORIGIN *pOrigin );

MHEG5String MHEG5convertGID( MHEG5String *inRef );

MHEG5String MHEG5CreateUrl( E_FS_ORIGIN origin, S_STRING path, S_STRING name );

MHEG5Bool MHEG5sameGroups(MH5GroupRef gref1, MH5GroupRef gref2);


MHEG5Bool MHEG5sameGroup(MH5GroupPtr gptr, MH5GroupRef gref);

void MHEG5setWorkingDir(MHEG5String source);


#endif /*_MH5GATE_H*/