include/mherrors.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2014 Ocean Blue Software Ltd
 *
 * 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 _MHEG5_ERRORS_H
#define _MHEG5_ERRORS_H

typedef enum
{
   // 0. Requested operation completed successfully
   MHERR_OK = 0,

   // 1. Indicate result is pending
   MHERR_PENDING,
   MHERR_RESULT_PENDING = MHERR_PENDING,

   // 2. Function call had no effect
   MHERR_REQUEST_IGNORED,

   // 3. Pending request was aborted
   MHERR_REQUEST_ABORTED,

   // 4. One or more of the parameters passed was invalid
   MHERR_BAD_PARAMETER,

   // 5. When specified object (e.g. file) was not found
   MHERR_OBJECT_NOT_FOUND,

   // 6. Memory allocation failure or mutex/semaphore failure
   MHERR_ALLOCATING_MEMORY,

   // 7. The MHEG5 engine has not been opened
   MHERR_COMP_NOT_OPEN,

   // 8. The MHEG5 engine has already been opened
   MHERR_COMP_ALREADY_OPEN,

   // 9. The MHEG5 engine has not been started
   MHERR_COMP_NOT_STARTED,

   //10. The MHEG5 engine has already been started
   MHERR_COMP_ALREADY_STARTED,

   //11. The internal Queue is full
   MHERR_QUEUE_FULL,

   //12. An error internal to the MHEG5 engine has occurred.
   MHERR_INTERNAL,

   //13. A session with a CI module has not established.
   MHERR_CI_SESSION_NOT_ESTABLISHED,

   //14. specific to MHEG5 PVR, to indicate a booking conflict
   MHERR_CONFLICT,

   //15. specific to MHEG5 PVR, to indicate an alternative booking
   MHERR_ALTERNATIVE_FOUND,

   //16. specific to MHEG5 PVR, to indicate out of space*/
   MHERR_INSUFFICIENT_SPACE,

   //17. specific to MHEG5 PVR, to indicate too many bookings
   MHERR_OVERBOOKED,

   //18+. An error due to failure to create system resource (e.g task, queue, semaphore or mutex)
   MHERR_SYSTEM_RESOURCE_TASK,
   MHERR_SYSTEM_RESOURCE_QUEUE,
   MHERR_SYSTEM_RESOURCE_SEMAPHORE,
   MHERR_SYSTEM_RESOURCE_MUTEX,

   //22+. An error occured while creating, resetting or destroying dsmcc instance
   MHERR_DSMCC_INSTANCE_CREATE,
   MHERR_DSMCC_INSTANCE_RESET,
   MHERR_DSMCC_INSTANCE_DESTROY,

   //25+. An error occured while loading or unloading dsmcc carousel
   MHERR_DSMCC_CAROUSEL_LOAD,
   MHERR_DSMCC_CAROUSEL_UNLOAD,

   //27+. Errors specific to the MHEG5 engine Open function
   MHERR_VERSION_MISMATCH,
   MHERR_BAD_TASK_PRIORITY,
   MHERR_ALLOCATING_MEMORY_REGION,
   MHERR_BAD_SECTION_BUFFER_SIZE,
   MHERR_BAD_NVM_SIZE,
   MHERR_BAD_ICS_BUFFER,
   MHERR_BAD_ICS_BUFFER_SIZE,
   MHERR_UNSUPPORTED_EXTENSION,
   MHERR_UNSUPPORTED_PROFILE,

   //36. An error that does not fit any other error code occurred
   MHERR_OTHER,
} E_MhegErr, E_MHEG5_ERR;


#endif // _MHEG5_ERRORS_H