libedc/ecc.h

   1 /*
   2  * This file has been modified for the cdrkit suite.
   3  *
   4  * The behaviour and appearence of the program code below can differ to a major
   5  * extent from the version distributed by the original author(s).
   6  *
   7  * For details, see Changelog file distributed with the cdrkit package. If you
   8  * received this file from another source then ask the distributing person for
   9  * a log of modifications.
  10  *
  11  */
  12
  13 /* @(#)ecc.h    1.4 02/10/19 Copyright 1998-2002 Heiko Eissfeldt, Joerg Schilling */
  14
  15 /*
  16  * compact disc reed-solomon routines
  17  *
  18  * (c) 1998-2002 by Heiko Eissfeldt, heiko@colossus.escape.de
  19  * (c) 2002 by Joerg Schilling
  20  */
  21 /*
  22  * This program is free software; you can redistribute it and/or modify
  23  * it under the terms of the GNU General Public License version 2
  24  * as published by the Free Software Foundation.
  25  *
  26  * This program is distributed in the hope that it will be useful,
  27  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  29  * GNU General Public License for more details.
  30  *
  31  * You should have received a copy of the GNU General Public License along with
  32  * this program; see the file COPYING.  If not, write to the Free Software
  33  * Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  34  */
  35
  36 #define RS_L12_BITS 8
  37
  38 /* audio sector definitions for CIRC */
  39 #define FRAMES_PER_SECTOR 98
  40 /* user data bytes per frame */
  41 #define L1_RAW 24
  42 /* parity bytes with 8 bit */
  43 #define L1_Q   4
  44 #define L1_P   4
  45
  46 /* audio sector Cross Interleaved Reed-Solomon Code (CIRC) encoder (layer 1) */
  47 /* adds P- and Q- parity information to audio (f2) frames. Also
  48    optionally handles the various delays and permutations. The output with all
  49    stages enabled can be fed into the Eight-Fourteen-Modulator.
  50    On input: 2352 bytes of audio data is given.
  51    On output: 3136 bytes of CIRC enriched audio data are returned.
  52  */
  53 int do_encode_L1(unsigned char in[L1_RAW*FRAMES_PER_SECTOR],
  54                                           unsigned char out[(L1_RAW+L1_Q+L1_P)*FRAMES_PER_SECTOR],
  55                                           int delay1, int delay2, int delay3, int scramble);
  56
  57 /* data sector definitions for RSPC */
  58 /* user data bytes per frame */
  59 #define L2_RAW (1024*2)
  60 /* parity bytes for 16 bit units */
  61 #define L2_Q   (26*2*2)
  62 #define L2_P   (43*2*2)
  63
  64 /* known sector types */
  65 #define MODE_0  0
  66 #define MODE_1  1
  67 #define MODE_2  2
  68 #define MODE_2_FORM_1   3
  69 #define MODE_2_FORM_2   4
  70
  71 /* set one of the MODE_* constants for subsequent data sector formatting */
  72 int set_sector_type(int st);
  73 /* get the current sector type setting for data sector formatting */
  74 int get_sector_type(void);
  75
  76 /* data sector layer 2 Reed-Solomon Product Code encoder */
  77 /* encode the given data portion depending on sector type (see
  78    get/set_sector_type() functions). Use the given address for the header.
  79    The returned data is __unscrambled__ and not in F2-frame format (for that
  80    see function scramble_L2()).
  81    Supported sector types:
  82      MODE_0: a 12-byte sync field, a header and 2336 zeros are returned.
  83      MODE_1: the user data portion (2048 bytes) has to be given
  84              at offset 16 in the inout array.
  85              Sync-, header-, edc-, spare-, p- and q- fields will be added.
  86      MODE_2: the user data portion (2336 bytes) has to be given
  87              at offset 16 in the inout array.
  88              Sync- and header- fields will be added.
  89      MODE_2_FORM_1: the user data portion (8 bytes subheader followed
  90                     by 2048 bytes data) has to be given at offset 16
  91                     in the inout array.
  92                     Sync-, header-, edc-, p- and q- fields will be added.
  93      MODE_2_FORM_2: the user data portion (8 bytes subheader followed
  94                     by 2324 bytes data) has to be given at offset 16
  95                     in the inout array.
  96                     Sync-, header- and edc- fields will be added.
  97 */
  98 int do_encode_L2(unsigned char *inout, int sectortype, unsigned address);
  99 int decode_L2_Q(unsigned char inout[4 + L2_RAW + 12 + L2_Q]);
 100 int decode_L2_P(unsigned char inout[4 + L2_RAW + 12 + L2_Q + L2_P]);
 101 unsigned int build_edc(unsigned char inout[], int from, int upto);
 102
 103 /* generates f2 frames from otherwise fully formatted sectors (generated by
 104    do_encode_L2()). */
 105 #define EDC_SCRAMBLE_NOSWAP     1       /* Do not swap bytes while scrambling */
 106 int scramble_L2(unsigned char *inout);
 107
 108 /* r-w sub channel definitions */
 109 #define RS_SUB_RW_BITS 6
 110
 111 #define PACKETS_PER_SUBCHANNELFRAME 4
 112 #define LSUB_RAW 18
 113 #define LSUB_QRAW 2
 114 /* 6 bit */
 115 #define LSUB_Q 2
 116 #define LSUB_P 4
 117
 118 /* R-W subchannel encoder */
 119 /* On input: 72 bytes packed user data, four frames with each 18 bytes.
 120    On output: per frame: 2 bytes user data, 2 bytes Q parity,
 121                          16 bytes user data, 4 bytes P parity.
 122    Options:
 123      delay1: use low level delay line
 124      scramble: perform low level permutations
 125  */
 126 int do_encode_sub(unsigned char in[LSUB_RAW*PACKETS_PER_SUBCHANNELFRAME],
 127                 unsigned char out[(LSUB_RAW+LSUB_Q+LSUB_P)*PACKETS_PER_SUBCHANNELFRAME],
 128                 int delay1, int scramble);
 129 int do_decode_sub(unsigned char in[(LSUB_RAW+LSUB_Q+LSUB_P)*PACKETS_PER_SUBCHANNELFRAME],
 130                                                 unsigned char out[LSUB_RAW*PACKETS_PER_SUBCHANNELFRAME],
 131                                                 int delay1, int scramble);
 132
 133 int decode_LSUB_Q(unsigned char inout[LSUB_QRAW + LSUB_Q]);
 134 int decode_LSUB_P(unsigned char inout[LSUB_RAW + LSUB_Q + LSUB_P]);