/* @(#)ecc.h	1.6 12/12/02 Copyright 1998-2002 Heiko Eissfeldt, Joerg Schilling */

/*
 * compact disc reed-solomon routines
 *
 * (c) 1998-2002 by Heiko Eissfeldt, heiko@colossus.escape.de
 * (c) 2002-2012 by Joerg Schilling
 */
/*
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * See the file CDDL.Schily.txt in this distribution for details.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file CDDL.Schily.txt from this distribution.
 */

#define	RS_L12_BITS	8

/* audio sector definitions for CIRC */
#define	FRAMES_PER_SECTOR	98
/* user data bytes per frame */
#define	L1_RAW	24
/* parity bytes with 8 bit */
#define	L1_Q	4
#define	L1_P	4

/* audio sector Cross Interleaved Reed-Solomon Code (CIRC) encoder (layer 1) */
/*
 * adds P- and Q- parity information to audio (f2) frames. Also
 * optionally handles the various delays and permutations. The output with all
 * stages enabled can be fed into the Eight-Fourteen-Modulator.
 * On input: 2352 bytes of audio data is given.
 * On output: 3136 bytes of CIRC enriched audio data are returned.
 */
int do_encode_L1 __PR((unsigned char in[L1_RAW*FRAMES_PER_SECTOR],
		unsigned char out[(L1_RAW+L1_Q+L1_P)*FRAMES_PER_SECTOR],
		int delay1, int delay2, int delay3, int scramble));

/* data sector definitions for RSPC */
/* user data bytes per frame */
#define	L2_RAW	(1024*2)
/* parity bytes for 16 bit units */
#define	L2_Q	(26*2*2)
#define	L2_P	(43*2*2)

/* known sector types */
#define	MODE_0	0
#define	MODE_1	1
#define	MODE_2	2
#define	MODE_2_FORM_1	3
#define	MODE_2_FORM_2	4

/* set one of the MODE_* constants for subsequent data sector formatting */
int set_sector_type	__PR((int st));
/* get the current sector type setting for data sector formatting */
int get_sector_type	__PR((void));

/* data sector layer 2 Reed-Solomon Product Code encoder */
/*
 * encode the given data portion depending on sector type (see
 * get/set_sector_type() functions). Use the given address for the header.
 * The returned data is __unscrambled__ and not in F2-frame format (for that
 * see function scramble_L2()).
 * Supported sector types:
 *   MODE_0: a 12-byte sync field, a header and 2336 zeros are returned.
 *   MODE_1: the user data portion (2048 bytes) has to be given
 *           at offset 16 in the inout array.
 *           Sync-, header-, edc-, spare-, p- and q- fields will be added.
 *   MODE_2: the user data portion (2336 bytes) has to be given
 *           at offset 16 in the inout array.
 *           Sync- and header- fields will be added.
 *   MODE_2_FORM_1: the user data portion (8 bytes subheader followed
 *                  by 2048 bytes data) has to be given at offset 16
 *                  in the inout array.
 *                  Sync-, header-, edc-, p- and q- fields will be added.
 *   MODE_2_FORM_2: the user data portion (8 bytes subheader followed
 *                  by 2324 bytes data) has to be given at offset 16
 *                  in the inout array.
 *                  Sync-, header- and edc- fields will be added.
 */
int do_encode_L2	__PR((unsigned char *inout, int sectortype, unsigned address));
int encode_L2_Q		__PR((unsigned char inout[4 + L2_RAW + 4 + 8 + L2_P + L2_Q]));
int encode_L2_P		__PR((unsigned char inout[4 + L2_RAW + 4 + 8 + L2_P]));

int decode_L2_Q		__PR((unsigned char inout[4 + L2_RAW + 12 + L2_Q]));
int decode_L2_P		__PR((unsigned char inout[4 + L2_RAW + 12 + L2_Q + L2_P]));
unsigned int build_edc	__PR((unsigned char inout[], int from, int upto));

/*
 * generates f2 frames from otherwise fully formatted sectors (generated by
 * do_encode_L2()).
 */
#define	EDC_SCRAMBLE_NOSWAP	1	/* Do not swap bytes while scrambling */
int scramble_L2		__PR((unsigned char *inout));

/* r-w sub channel definitions */
#define	RS_SUB_RW_BITS	6

#define	PACKETS_PER_SUBCHANNELFRAME	4
#define	LSUB_RAW			18
#define	LSUB_QRAW			2
/* 6 bit */
#define	LSUB_Q	2
#define	LSUB_P	4

/* R-W subchannel encoder */
/*
 * On input: 72 bytes packed user data, four frames with each 18 bytes.
 * On output: per frame: 2 bytes user data, 2 bytes Q parity,
 *                       16 bytes user data, 4 bytes P parity.
 * Options:
 *   delay1: use low level delay line
 *   scramble: perform low level permutations
 */
int do_encode_sub __PR((unsigned char in[LSUB_RAW*PACKETS_PER_SUBCHANNELFRAME],
		unsigned char out[(LSUB_RAW+LSUB_Q+LSUB_P)*PACKETS_PER_SUBCHANNELFRAME],
		int delay1, int scramble));
int do_decode_sub __PR((unsigned char in[(LSUB_RAW+LSUB_Q+LSUB_P)*PACKETS_PER_SUBCHANNELFRAME],
		unsigned char out[LSUB_RAW*PACKETS_PER_SUBCHANNELFRAME],
		int delay1, int scramble));

int decode_LSUB_Q	__PR((unsigned char inout[LSUB_QRAW + LSUB_Q]));
int decode_LSUB_P	__PR((unsigned char inout[LSUB_RAW + LSUB_Q + LSUB_P]));