mpeghUIManager.h

Go to the documentation of this file.

/*-----------------------------------------------------------------------------
Software License for The Fraunhofer FDK MPEG-H Software

Copyright (c) 2018 - 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten
Forschung e.V. and Contributors
All rights reserved.

1. INTRODUCTION

The "Fraunhofer FDK MPEG-H Software" is software that implements the ISO/MPEG
MPEG-H 3D Audio standard for digital audio or related system features. Patent
licenses for necessary patent claims for the Fraunhofer FDK MPEG-H Software
(including those of Fraunhofer), for the use in commercial products and
services, may be obtained from the respective patent owners individually and/or
from Via LA (www.via-la.com).

Fraunhofer supports the development of MPEG-H products and services by offering
additional software, documentation, and technical advice. In addition, it
operates the MPEG-H Trademark Program to ease interoperability testing of end-
products. Please visit www.mpegh.com for more information.

2. COPYRIGHT LICENSE

Redistribution and use in source and binary forms, with or without modification,
are permitted without payment of copyright license fees provided that you
satisfy the following conditions:

* You must retain the complete text of this software license in redistributions
of the Fraunhofer FDK MPEG-H Software or your modifications thereto in source
code form.

* You must retain the complete text of this software license in the
documentation and/or other materials provided with redistributions of
the Fraunhofer FDK MPEG-H Software or your modifications thereto in binary form.
You must make available free of charge copies of the complete source code of
the Fraunhofer FDK MPEG-H Software and your modifications thereto to recipients
of copies in binary form.

* The name of Fraunhofer may not be used to endorse or promote products derived
from the Fraunhofer FDK MPEG-H Software without prior written permission.

* You may not charge copyright license fees for anyone to use, copy or
distribute the Fraunhofer FDK MPEG-H Software or your modifications thereto.

* Your modified versions of the Fraunhofer FDK MPEG-H Software must carry
prominent notices stating that you changed the software and the date of any
change. For modified versions of the Fraunhofer FDK MPEG-H Software, the term
"Fraunhofer FDK MPEG-H Software" must be replaced by the term "Third-Party
Modified Version of the Fraunhofer FDK MPEG-H Software".

3. No PATENT LICENSE

NO EXPRESS OR IMPLIED LICENSES TO ANY PATENT CLAIMS, including without
limitation the patents of Fraunhofer, ARE GRANTED BY THIS SOFTWARE LICENSE.
Fraunhofer provides no warranty of patent non-infringement with respect to this
software. You may use this Fraunhofer FDK MPEG-H Software or modifications
thereto only for purposes that are authorized by appropriate patent licenses.

4. DISCLAIMER

This Fraunhofer FDK MPEG-H Software is provided by Fraunhofer on behalf of the
copyright holders and contributors "AS IS" and WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, including but not limited to the implied warranties of
merchantability and fitness for a particular purpose. IN NO EVENT SHALL THE
COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE for any direct, indirect,
incidental, special, exemplary, or consequential damages, including but not
limited to procurement of substitute goods or services; loss of use, data, or
profits, or business interruption, however caused and on any theory of
liability, whether in contract, strict liability, or tort (including
negligence), arising in any way out of the use of this software, even if
advised of the possibility of such damage.

5. CONTACT INFORMATION

Fraunhofer Institute for Integrated Circuits IIS
Attention: Division Audio and Media Technologies - MPEG-H FDK
Am Wolfsmantel 33
91058 Erlangen, Germany
www.iis.fraunhofer.de/amm
amm-info@iis.fraunhofer.de
-----------------------------------------------------------------------------*/

/**************************************  ***************************************
   Author(s): Matthias Neusinger
   Description: MPEG-H UI Manager

   This software and/or program is protected by copyright law and international
   treaties. Any reproduction or distribution of this software and/or program,
   or any portion of it, may result in severe civil and criminal penalties, and
   will be prosecuted to the maximum extent possible under law.

*******************************************************************************/

#ifndef MPEGHUIMANAGER_H
#define MPEGHUIMANAGER_H

#include "mpeghexport.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct MPEGH_UI_MANAGER* HANDLE_MPEGH_UI_MANAGER;

#define MAX_NUMBER_SECONDARY_STREAMS 16

typedef enum {
  MPEGH_UI_OK = 0,
  MPEGH_UI_OUT_OF_MEMORY,
  MPEGH_UI_BUFFER_TOO_SMALL, /* This error is not recoverable until a new RAP frame is processed,
                                   i.e. UI events will be delayed. */
  MPEGH_UI_INVALID_PARAM,
  MPEGH_UI_NOT_ALLOWED,
  MPEGH_UI_INVALID_STATE,
  MPEGH_UI_PARSE_ERROR,
  MPEGH_UI_OK_BUT_NO_VALID_DATA
} MPEGH_UI_ERROR;

#define MPEGH_UI_FORCE_UPDATE 1

#define MPEGH_UI_FORCE_RESTART_XML 4

#define MPEGH_UI_NO_CHANGE 1

#define MPEGH_UI_CONTINUES_XML 2

#define MPEGH_UI_INCOMPLETE_XML 4

#define MPEGH_UI_SHORT_OUTPUT 8

MPEGHDEC_EXPORT HANDLE_MPEGH_UI_MANAGER mpegh_UI_Manager_Open(void);

MPEGHDEC_EXPORT void mpegh_UI_Manager_Close(HANDLE_MPEGH_UI_MANAGER self);

MPEGHDEC_EXPORT MPEGH_UI_ERROR mpegh_UI_GetXmlSceneState(HANDLE_MPEGH_UI_MANAGER self, char* xmlOut,
                                                         unsigned int xmlOutSize,
                                                         unsigned int flagsIn,
                                                         unsigned int* flagsOut);

MPEGHDEC_EXPORT MPEGH_UI_ERROR mpegh_UI_ApplyXmlAction(HANDLE_MPEGH_UI_MANAGER self,
                                                       const char* xmlIn, unsigned int xmlInSize,
                                                       unsigned int* flagsOut);

MPEGHDEC_EXPORT MPEGH_UI_ERROR mpegh_UI_FeedMHAS(HANDLE_MPEGH_UI_MANAGER self,
                                                 unsigned char* mhasBuffer,
                                                 unsigned int mhasLength);

MPEGHDEC_EXPORT MPEGH_UI_ERROR mpegh_UI_UpdateMHAS(HANDLE_MPEGH_UI_MANAGER self,
                                                   unsigned char* mhasBuffer,
                                                   unsigned int mhasBufferLength,
                                                   unsigned int* mhasLength);

MPEGHDEC_EXPORT MPEGH_UI_ERROR mpegh_UI_SetPersistenceMemory(HANDLE_MPEGH_UI_MANAGER self,
                                                             void* persistenceMemoryBlock,
                                                             unsigned short persistenceMemorySize);

MPEGHDEC_EXPORT MPEGH_UI_ERROR mpegh_UI_GetPersistenceMemory(HANDLE_MPEGH_UI_MANAGER self,
                                                             void** persistenceMemoryBlock,
                                                             unsigned short* persistenceMemorySize);

#ifdef __cplusplus
}
#endif

#endif