mpeghdecoder.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
-----------------------------------------------------------------------------*/

#include <stdint.h>
#include <stdbool.h>

#ifndef MPEGH_DECODER_TIMING_HANDLING_WRAPPER
#define MPEGH_DECODER_TIMING_HANDLING_WRAPPER

#include "mpeghexport.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
  MPEGH_DEC_OK,                
  MPEGH_DEC_FEED_DATA,         
  MPEGH_DEC_NULLPTR_ERROR,     
  MPEGH_DEC_OUT_OF_MEMORY,     
  MPEGH_DEC_BUFFER_ERROR,      
  MPEGH_DEC_PROCESS_ERROR,     
  MPEGH_DEC_UNSUPPORTED_PARAM, 
  MPEGH_DEC_NEEDS_RESTART      
} MPEGH_DECODER_ERROR;

typedef enum {
  MPEGH_DEC_PARAM_TARGET_REFERENCE_LEVEL =
      0x0000, 
  MPEGH_DEC_PARAM_EFFECT_TYPE =
      0x0001, 
  MPEGH_DEC_PARAM_BOOST_FACTOR =
      0x0002, 
  MPEGH_DEC_PARAM_ATTENUATION_FACTOR =
      0x0003, 
  MPEGH_DEC_PARAM_ALBUM_MODE =
      0x0004 
} MPEGH_DECODER_PARAMETER;

typedef struct MPEGH_DECODER_CONTEXT*
    HANDLE_MPEGH_DECODER_CONTEXT; 
typedef struct MPEGH_DECODER_OUTPUT_INFO {
  int numSamplesPerChannel; 
  int numChannels;          
  int sampleRate;           
  uint64_t ticks;           
  uint64_t pts;             
  int loudness;             
  bool isConcealed;         
} MPEGH_DECODER_OUTPUT_INFO;

MPEGHDEC_EXPORT HANDLE_MPEGH_DECODER_CONTEXT mpeghdecoder_init(int32_t cicpSetup);

MPEGHDEC_EXPORT MPEGH_DECODER_ERROR mpeghdecoder_setMhaConfig(HANDLE_MPEGH_DECODER_CONTEXT hCtx,
                                                              const uint8_t* config,
                                                              uint32_t configSize);

MPEGHDEC_EXPORT void mpeghdecoder_destroy(HANDLE_MPEGH_DECODER_CONTEXT hCtx);

MPEGHDEC_EXPORT MPEGH_DECODER_ERROR mpeghdecoder_process(HANDLE_MPEGH_DECODER_CONTEXT hCtx,
                                                         const uint8_t* inData, uint32_t inLength,
                                                         uint64_t timestamp);

MPEGHDEC_EXPORT MPEGH_DECODER_ERROR mpeghdecoder_processTimescale(HANDLE_MPEGH_DECODER_CONTEXT hCtx,
                                                                  const uint8_t* inData,
                                                                  uint32_t inLength,
                                                                  uint64_t timestamp,
                                                                  uint32_t timescale);

MPEGHDEC_EXPORT MPEGH_DECODER_ERROR mpeghdecoder_getSamples(HANDLE_MPEGH_DECODER_CONTEXT hCtx,
                                                            int32_t* outData, uint32_t outLength,
                                                            MPEGH_DECODER_OUTPUT_INFO* outInfo);

MPEGHDEC_EXPORT MPEGH_DECODER_ERROR mpeghdecoder_flushAndGet(HANDLE_MPEGH_DECODER_CONTEXT hCtx);

MPEGHDEC_EXPORT MPEGH_DECODER_ERROR mpeghdecoder_flush(HANDLE_MPEGH_DECODER_CONTEXT hCtx);

MPEGHDEC_EXPORT MPEGH_DECODER_ERROR mpeghdecoder_setParam(HANDLE_MPEGH_DECODER_CONTEXT hCtx,
                                                          MPEGH_DECODER_PARAMETER param, int value);

#ifdef __cplusplus
}
#endif

#endif