• file
• revisions
• annotate
• diff
• comparison
• raw

media/libopus/silk/API.h@b8a032363ba2 (annotated)

media/libopus/silk/API.h

Thu, 22 Jan 2015 13:21:57 +0100

author

Michael Schloh von Bennewitz <michael@schloh.com>

date

Thu, 22 Jan 2015 13:21:57 +0100

branch

TOR_BUG_9701

changeset 15

b8a032363ba2

permissions

-rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

michael@0	1	/***********************************************************************
michael@0	2	Copyright (c) 2006-2011, Skype Limited. All rights reserved.
michael@0	3	Redistribution and use in source and binary forms, with or without
michael@0	4	modification, are permitted provided that the following conditions
michael@0	5	are met:
michael@0	6	- Redistributions of source code must retain the above copyright notice,
michael@0	7	this list of conditions and the following disclaimer.
michael@0	8	- Redistributions in binary form must reproduce the above copyright
michael@0	9	notice, this list of conditions and the following disclaimer in the
michael@0	10	documentation and/or other materials provided with the distribution.
michael@0	11	- Neither the name of Internet Society, IETF or IETF Trust, nor the
michael@0	12	names of specific contributors, may be used to endorse or promote
michael@0	13	products derived from this software without specific prior written
michael@0	14	permission.
michael@0	15	THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
michael@0	16	AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
michael@0	17	IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
michael@0	18	ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
michael@0	19	LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
michael@0	20	CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
michael@0	21	SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
michael@0	22	INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
michael@0	23	CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
michael@0	24	ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
michael@0	25	POSSIBILITY OF SUCH DAMAGE.
michael@0	26	***********************************************************************/
michael@0	27
michael@0	28	#ifndef SILK_API_H
michael@0	29	#define SILK_API_H
michael@0	30
michael@0	31	#include "control.h"
michael@0	32	#include "typedef.h"
michael@0	33	#include "errors.h"
michael@0	34	#include "entenc.h"
michael@0	35	#include "entdec.h"
michael@0	36
michael@0	37	#ifdef __cplusplus
michael@0	38	extern "C"
michael@0	39	{
michael@0	40	#endif
michael@0	41
michael@0	42	#define SILK_MAX_FRAMES_PER_PACKET 3
michael@0	43
michael@0	44	/* Struct for TOC (Table of Contents) */
michael@0	45	typedef struct {
michael@0	46	opus_int VADFlag; /* Voice activity for packet */
michael@0	47	opus_int VADFlags[ SILK_MAX_FRAMES_PER_PACKET ]; /* Voice activity for each frame in packet */
michael@0	48	opus_int inbandFECFlag; /* Flag indicating if packet contains in-band FEC */
michael@0	49	} silk_TOC_struct;
michael@0	50
michael@0	51	/****************************************/
michael@0	52	/* Encoder functions */
michael@0	53	/****************************************/
michael@0	54
michael@0	55	/***********************************************/
michael@0	56	/* Get size in bytes of the Silk encoder state */
michael@0	57	/***********************************************/
michael@0	58	opus_int silk_Get_Encoder_Size( /* O Returns error code */
michael@0	59	opus_int *encSizeBytes /* O Number of bytes in SILK encoder state */
michael@0	60	);
michael@0	61
michael@0	62	/*************************/
michael@0	63	/* Init or reset encoder */
michael@0	64	/*************************/
michael@0	65	opus_int silk_InitEncoder( /* O Returns error code */
michael@0	66	void *encState, /* I/O State */
michael@0	67	int arch, /* I Run-time architecture */
michael@0	68	silk_EncControlStruct *encStatus /* O Encoder Status */
michael@0	69	);
michael@0	70
michael@0	71	/**************************/
michael@0	72	/* Encode frame with Silk */
michael@0	73	/**************************/
michael@0	74	/* Note: if prefillFlag is set, the input must contain 10 ms of audio, irrespective of what */
michael@0	75	/* encControl->payloadSize_ms is set to */
michael@0	76	opus_int silk_Encode( /* O Returns error code */
michael@0	77	void *encState, /* I/O State */
michael@0	78	silk_EncControlStruct *encControl, /* I Control status */
michael@0	79	const opus_int16 *samplesIn, /* I Speech sample input vector */
michael@0	80	opus_int nSamplesIn, /* I Number of samples in input vector */
michael@0	81	ec_enc *psRangeEnc, /* I/O Compressor data structure */
michael@0	82	opus_int32 *nBytesOut, /* I/O Number of bytes in payload (input: Max bytes) */
michael@0	83	const opus_int prefillFlag /* I Flag to indicate prefilling buffers no coding */
michael@0	84	);
michael@0	85
michael@0	86	/****************************************/
michael@0	87	/* Decoder functions */
michael@0	88	/****************************************/
michael@0	89
michael@0	90	/***********************************************/
michael@0	91	/* Get size in bytes of the Silk decoder state */
michael@0	92	/***********************************************/
michael@0	93	opus_int silk_Get_Decoder_Size( /* O Returns error code */
michael@0	94	opus_int *decSizeBytes /* O Number of bytes in SILK decoder state */
michael@0	95	);
michael@0	96
michael@0	97	/*************************/
michael@0	98	/* Init or Reset decoder */
michael@0	99	/*************************/
michael@0	100	opus_int silk_InitDecoder( /* O Returns error code */
michael@0	101	void *decState /* I/O State */
michael@0	102	);
michael@0	103
michael@0	104	/******************/
michael@0	105	/* Decode a frame */
michael@0	106	/******************/
michael@0	107	opus_int silk_Decode( /* O Returns error code */
michael@0	108	void* decState, /* I/O State */
michael@0	109	silk_DecControlStruct* decControl, /* I/O Control Structure */
michael@0	110	opus_int lostFlag, /* I 0: no loss, 1 loss, 2 decode fec */
michael@0	111	opus_int newPacketFlag, /* I Indicates first decoder call for this packet */
michael@0	112	ec_dec *psRangeDec, /* I/O Compressor data structure */
michael@0	113	opus_int16 *samplesOut, /* O Decoded output speech vector */
michael@0	114	opus_int32 *nSamplesOut /* O Number of samples decoded */
michael@0	115	);
michael@0	116
michael@0	117	#if 0
michael@0	118	/**************************************/
michael@0	119	/* Get table of contents for a packet */
michael@0	120	/**************************************/
michael@0	121	opus_int silk_get_TOC(
michael@0	122	const opus_uint8 *payload, /* I Payload data */
michael@0	123	const opus_int nBytesIn, /* I Number of input bytes */
michael@0	124	const opus_int nFramesPerPayload, /* I Number of SILK frames per payload */
michael@0	125	silk_TOC_struct *Silk_TOC /* O Type of content */
michael@0	126	);
michael@0	127	#endif
michael@0	128
michael@0	129	#ifdef __cplusplus
michael@0	130	}
michael@0	131	#endif
michael@0	132
michael@0	133	#endif