Loading...
Searching...
No Matches
ecu.h
Go to the documentation of this file.
#pragma once
#include <stdint.h>
#include <stdbool.h>
#include <osmocom/core/defs.h>
#include <osmocom/codec/codec.h>
/* ECU state for GSM-FR */
struct osmo_ecu_fr_state {
bool subsequent_lost_frame;
uint8_t frame_backup[GSM_FR_BYTES];
};
void osmo_ecu_fr_reset(struct osmo_ecu_fr_state *state, const uint8_t *frame)
OSMO_DEPRECATED_OUTSIDE("Use generic ECU abstraction layer instead");
int osmo_ecu_fr_conceal(struct osmo_ecu_fr_state *state, uint8_t *frame)
OSMO_DEPRECATED_OUTSIDE("Use generic ECU abstraction layer instead");
enum osmo_ecu_codec {
OSMO_ECU_CODEC_HR,
OSMO_ECU_CODEC_FR,
OSMO_ECU_CODEC_EFR,
OSMO_ECU_CODEC_AMR,
_NUM_OSMO_ECU_CODECS
};
/***********************************************************************
* Generic ECU abstraction layer below
***********************************************************************/
/* As the developer and copyright holder of the related code, I hereby
* state that any ECU implementation using 'struct osmo_ecu_ops' and
* registering with the 'osmo_ecu_register()' function shall not be
* considered as a derivative work under any applicable copyright law;
* the copyleft terms of GPLv2 shall hence not apply to any such ECU
* implementation.
*
* The intent of the above exception is to allow anyone to combine third
* party Error Concealment Unit implementations with libosmocodec.
* including but not limited to such published by ETSI.
*
* -- Harald Welte <laforge@gnumonks.org> on August 1, 2019.
*/
/* Codec independent ECU state */
struct osmo_ecu_state {
enum osmo_ecu_codec codec;
uint8_t data[0];
};
/* initialize an ECU instance */
struct osmo_ecu_state *osmo_ecu_init(void *ctx, enum osmo_ecu_codec codec);
/* destroy an ECU instance */
void osmo_ecu_destroy(struct osmo_ecu_state *st);
/* process a received frame a substitute/erroneous frame */
int osmo_ecu_frame_in(struct osmo_ecu_state *st, bool bfi,
const uint8_t *frame, unsigned int frame_bytes);
/* generate output data for a substitute/erroneous frame */
int osmo_ecu_frame_out(struct osmo_ecu_state *st, uint8_t *frame_out);
struct osmo_ecu_ops {
struct osmo_ecu_state * (*init)(void *ctx, enum osmo_ecu_codec codec);
void (*destroy)(struct osmo_ecu_state *);
int (*frame_in)(struct osmo_ecu_state *st, bool bfi,
const uint8_t *frame, unsigned int frame_bytes);
int (*frame_out)(struct osmo_ecu_state *st, uint8_t *frame_out);
};
int osmo_ecu_register(const struct osmo_ecu_ops *ops, enum osmo_ecu_codec codec);
codec.h
GSM_FR_BYTES
#define GSM_FR_BYTES
Definition codec.h:12
defs.h
osmo_ecu_frame_in
int osmo_ecu_frame_in(struct osmo_ecu_state *st, bool bfi, const uint8_t *frame, unsigned int frame_bytes)
process a received frame a substitute/erroneous frame.
Definition ecu.c:76
osmo_ecu_frame_out
int osmo_ecu_frame_out(struct osmo_ecu_state *st, uint8_t *frame_out)
generate output data for a substitute/erroneous frame.
Definition ecu.c:90
osmo_ecu_init
struct osmo_ecu_state * osmo_ecu_init(void *ctx, enum osmo_ecu_codec codec)
initialize an ECU instance for given codec.
Definition ecu.c:48
osmo_ecu_fr_reset
void osmo_ecu_fr_reset(struct osmo_ecu_fr_state *state, const uint8_t *frame) OSMO_DEPRECATED_OUTSIDE("Use generic ECU override ion layer instead")
To be called when a good frame is received.
Definition ecu_fr.c:129
osmo_ecu_codec
osmo_ecu_codec
Definition ecu.h:20
OSMO_ECU_CODEC_FR
@ OSMO_ECU_CODEC_FR
Definition ecu.h:22
OSMO_ECU_CODEC_HR
@ OSMO_ECU_CODEC_HR
Definition ecu.h:21
_NUM_OSMO_ECU_CODECS
@ _NUM_OSMO_ECU_CODECS
Definition ecu.h:25
OSMO_ECU_CODEC_EFR
@ OSMO_ECU_CODEC_EFR
Definition ecu.h:23
OSMO_ECU_CODEC_AMR
@ OSMO_ECU_CODEC_AMR
Definition ecu.h:24
osmo_ecu_fr_conceal
int osmo_ecu_fr_conceal(struct osmo_ecu_fr_state *state, uint8_t *frame) OSMO_DEPRECATED_OUTSIDE("Use generic ECU override ion layer instead")
To be called when a bad frame is received.
Definition ecu_fr.c:143
osmo_ecu_register
int osmo_ecu_register(const struct osmo_ecu_ops *ops, enum osmo_ecu_codec codec)
register an ECU implementation for a given codec
Definition ecu.c:104
osmo_ecu_destroy
void osmo_ecu_destroy(struct osmo_ecu_state *st)
destroy an ECU instance
Definition ecu.c:58
OSMO_DEPRECATED_OUTSIDE
#define OSMO_DEPRECATED_OUTSIDE(text)
osmo_ecu_fr_state
Definition ecu.h:10
osmo_ecu_fr_state::frame_backup
uint8_t frame_backup[GSM_FR_BYTES]
Definition ecu.h:12
osmo_ecu_fr_state::subsequent_lost_frame
bool subsequent_lost_frame
Definition ecu.h:11
osmo_ecu_ops
Definition ecu.h:65
osmo_ecu_ops::frame_out
int(* frame_out)(struct osmo_ecu_state *st, uint8_t *frame_out)
Definition ecu.h:70
osmo_ecu_ops::destroy
void(* destroy)(struct osmo_ecu_state *)
Definition ecu.h:67
osmo_ecu_ops::frame_in
int(* frame_in)(struct osmo_ecu_state *st, bool bfi, const uint8_t *frame, unsigned int frame_bytes)
Definition ecu.h:68
osmo_ecu_state
Definition ecu.h:47
osmo_ecu_state::codec
enum osmo_ecu_codec codec
Definition ecu.h:48
osmo_ecu_state::data
uint8_t data[0]
Definition ecu.h:49