cannam@127: /*
cannam@127:  * Copyright (c) 2003, 2007-14 Matteo Frigo
cannam@127:  * Copyright (c) 2003, 2007-14 Massachusetts Institute of Technology
cannam@127:  *
cannam@127:  * This program is free software; you can redistribute it and/or modify
cannam@127:  * it under the terms of the GNU General Public License as published by
cannam@127:  * the Free Software Foundation; either version 2 of the License, or
cannam@127:  * (at your option) any later version.
cannam@127:  *
cannam@127:  * This program is distributed in the hope that it will be useful,
cannam@127:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
cannam@127:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
cannam@127:  * GNU General Public License for more details.
cannam@127:  *
cannam@127:  * You should have received a copy of the GNU General Public License
cannam@127:  * along with this program; if not, write to the Free Software
cannam@127:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
cannam@127:  *
cannam@127:  */
cannam@127: 
cannam@127: /*
cannam@127:  * This header file must include every file or define every
cannam@127:  * type or macro which is required to compile a codelet.
cannam@127:  */
cannam@127: 
cannam@127: #ifndef __RDFT_CODELET_H__
cannam@127: #define __RDFT_CODELET_H__
cannam@127: 
cannam@127: #include "ifftw.h"
cannam@127: 
cannam@127: /**************************************************************
cannam@127:  * types of codelets
cannam@127:  **************************************************************/
cannam@127: 
cannam@127: /* FOOab, with a,b in {0,1}, denotes the FOO transform
cannam@127:    where a/b say whether the input/output are shifted by
cannam@127:    half a sample/slot. */
cannam@127: 
cannam@127: typedef enum {
cannam@127:      R2HC00, R2HC01, R2HC10, R2HC11,
cannam@127:      HC2R00, HC2R01, HC2R10, HC2R11,
cannam@127:      DHT, 
cannam@127:      REDFT00, REDFT01, REDFT10, REDFT11, /* real-even == DCT's */
cannam@127:      RODFT00, RODFT01, RODFT10, RODFT11  /*  real-odd == DST's */
cannam@127: } rdft_kind;
cannam@127: 
cannam@127: /* standard R2HC/HC2R transforms are unshifted */
cannam@127: #define R2HC R2HC00
cannam@127: #define HC2R HC2R00
cannam@127: 
cannam@127: #define R2HCII R2HC01
cannam@127: #define HC2RIII HC2R10
cannam@127: 
cannam@127: /* (k) >= R2HC00 produces a warning under gcc because checking x >= 0
cannam@127:    is superfluous for unsigned values...but it is needed because other
cannam@127:    compilers (e.g. icc) may define the enum to be a signed int...grrr. */
cannam@127: #define R2HC_KINDP(k) ((k) >= R2HC00 && (k) <= R2HC11) /* uses kr2hc_genus */
cannam@127: #define HC2R_KINDP(k) ((k) >= HC2R00 && (k) <= HC2R11) /* uses khc2r_genus */
cannam@127: 
cannam@127: #define R2R_KINDP(k) ((k) >= DHT) /* uses kr2r_genus */
cannam@127: 
cannam@127: #define REDFT_KINDP(k) ((k) >= REDFT00 && (k) <= REDFT11)
cannam@127: #define RODFT_KINDP(k) ((k) >= RODFT00 && (k) <= RODFT11)
cannam@127: #define REODFT_KINDP(k) ((k) >= REDFT00 && (k) <= RODFT11)
cannam@127: 
cannam@127: /* codelets with real input (output) and complex output (input) */
cannam@127: typedef struct kr2c_desc_s kr2c_desc;
cannam@127: 
cannam@127: typedef struct {
cannam@127:      rdft_kind kind;
cannam@127:      INT vl;
cannam@127: } kr2c_genus;
cannam@127: 
cannam@127: struct kr2c_desc_s {
cannam@127:      INT n;    /* size of transform computed */
cannam@127:      const char *nam;
cannam@127:      opcnt ops;
cannam@127:      const kr2c_genus *genus;
cannam@127: };
cannam@127: 
cannam@127: typedef void (*kr2c) (R *R0, R *R1, R *Cr, R *Ci,
cannam@127: 		      stride rs, stride csr, stride csi,
cannam@127: 		      INT vl, INT ivs, INT ovs);
cannam@127: void X(kr2c_register)(planner *p, kr2c codelet, const kr2c_desc *desc);
cannam@127: 
cannam@127: /* half-complex to half-complex DIT/DIF codelets: */
cannam@127: typedef struct hc2hc_desc_s hc2hc_desc;
cannam@127: 
cannam@127: typedef struct {
cannam@127:      rdft_kind kind;
cannam@127:      INT vl;
cannam@127: } hc2hc_genus;
cannam@127: 
cannam@127: struct hc2hc_desc_s {
cannam@127:      INT radix;
cannam@127:      const char *nam;
cannam@127:      const tw_instr *tw;
cannam@127:      const hc2hc_genus *genus;
cannam@127:      opcnt ops;
cannam@127: };
cannam@127: 
cannam@127: typedef void (*khc2hc) (R *rioarray, R *iioarray, const R *W,
cannam@127: 			stride rs, INT mb, INT me, INT ms);
cannam@127: void X(khc2hc_register)(planner *p, khc2hc codelet, const hc2hc_desc *desc);
cannam@127: 
cannam@127: /* half-complex to rdft2-complex DIT/DIF codelets: */
cannam@127: typedef struct hc2c_desc_s hc2c_desc;
cannam@127: 
cannam@127: typedef enum {
cannam@127:      HC2C_VIA_RDFT,
cannam@127:      HC2C_VIA_DFT
cannam@127: } hc2c_kind;
cannam@127: 
cannam@127: typedef struct {
cannam@127:      int (*okp)(
cannam@127: 	  const R *Rp, const R *Ip, const R *Rm, const R *Im, 
cannam@127: 	  INT rs, INT mb, INT me, INT ms, 
cannam@127: 	  const planner *plnr);
cannam@127:      rdft_kind kind;
cannam@127:      INT vl;
cannam@127: } hc2c_genus;
cannam@127: 
cannam@127: struct hc2c_desc_s {
cannam@127:      INT radix;
cannam@127:      const char *nam;
cannam@127:      const tw_instr *tw;
cannam@127:      const hc2c_genus *genus;
cannam@127:      opcnt ops;
cannam@127: };
cannam@127: 
cannam@127: typedef void (*khc2c) (R *Rp, R *Ip, R *Rm, R *Im, const R *W,
cannam@127: 		       stride rs, INT mb, INT me, INT ms);
cannam@127: void X(khc2c_register)(planner *p, khc2c codelet, const hc2c_desc *desc,
cannam@127: 		       hc2c_kind hc2ckind);
cannam@127: 
cannam@127: extern const solvtab X(solvtab_rdft_r2cf);
cannam@127: extern const solvtab X(solvtab_rdft_r2cb);
cannam@127: extern const solvtab X(solvtab_rdft_sse2);
cannam@127: extern const solvtab X(solvtab_rdft_avx);
cannam@127: extern const solvtab X(solvtab_rdft_avx_128_fma);
cannam@127: extern const solvtab X(solvtab_rdft_avx2);
cannam@127: extern const solvtab X(solvtab_rdft_avx2_128);
cannam@127: extern const solvtab X(solvtab_rdft_avx512);
cannam@127: extern const solvtab X(solvtab_rdft_kcvi);
cannam@127: extern const solvtab X(solvtab_rdft_altivec);
cannam@127: extern const solvtab X(solvtab_rdft_vsx);
cannam@127: extern const solvtab X(solvtab_rdft_neon);
cannam@127: extern const solvtab X(solvtab_rdft_generic_simd128);
cannam@127: extern const solvtab X(solvtab_rdft_generic_simd256);
cannam@127: 
cannam@127: /* real-input & output DFT-like codelets (DHT, etc.) */
cannam@127: typedef struct kr2r_desc_s kr2r_desc;
cannam@127: 
cannam@127: typedef struct {
cannam@127:      INT vl;
cannam@127: } kr2r_genus;
cannam@127: 
cannam@127: struct kr2r_desc_s {
cannam@127:      INT n;    /* size of transform computed */
cannam@127:      const char *nam;
cannam@127:      opcnt ops;
cannam@127:      const kr2r_genus *genus;
cannam@127:      rdft_kind kind;
cannam@127: };
cannam@127: 
cannam@127: typedef void (*kr2r) (const R *I, R *O, stride is, stride os,
cannam@127: 		      INT vl, INT ivs, INT ovs);
cannam@127: void X(kr2r_register)(planner *p, kr2r codelet, const kr2r_desc *desc);
cannam@127: 
cannam@127: extern const solvtab X(solvtab_rdft_r2r);
cannam@127: 
cannam@127: #endif				/* __RDFT_CODELET_H__ */