COREMOD_memory.h

/**
 * @file    COREMOD_memory.h
 * @brief   Function prototypes for milk memory functions
 *
 * Functions to handle images and streams
 *
 *
 */



#ifndef _COREMODMEMORY_H
#define _COREMODMEMORY_H

/* the number of images in the data structure is kept NB_IMAGES_BUFFER above the number of used images prior to the execution of any function. It means that no function should create more than 100 images. */
#define NB_IMAGES_BUFFER 500
/* when the number of free images in the data structure is below NB_IMAGES_BUFFER, it is increased by  NB_IMAGES_BUFFER */
#define NB_IMAGES_BUFFER_REALLOC 600

/* the number of variables in the data structure is kept NB_VARIABLES_BUFFER above the number of used variables prior to the execution of any function. It means that no function should create more than 100 variables. */
#define NB_VARIABLES_BUFFER 100
/* when the number of free variables in the data structure is below NB_VARIABLES_BUFFER, it is increased by  NB_VARIABLES_BUFFER */
#define NB_VARIABLES_BUFFER_REALLOC 150


/*void print_sys_mem_info();*/


typedef long imageID;

/** data logging of shared memory image stream
 *
 */
typedef struct
{
    char iname[100];
    char fname[200];
    int partial; // 1 if partial cube
    long cubesize; // size of the cube

    int saveascii;
    // 0 : Not saving ascii
    // 1 : Saving ascii: arraycnt0, arraycnt1, arraytime
    // 2 : ???

    char      fnameascii[200];  // name of frame to be saved
    uint64_t *arrayindex;
    uint64_t *arraycnt0;
    uint64_t *arraycnt1;

    double   *arraytime;
} STREAMSAVE_THREAD_MESSAGE;









typedef struct
{
    int       on;                   /**<  1 if logging, 0 otherwise */
    long long cnt;
    long long filecnt;
    long      interval;             /**<  log every x frames (default = 1) */
    int       logexit;              /**<  toggle to 1 when exiting */
    char      fname[200];
} LOGSHIM_CONF;



typedef struct
{
    long cnt0;
    long cnt1;
} TCP_BUFFER_METADATA;



void __attribute__((constructor)) libinit_COREMOD_memory();



//int ImageCreateSem(IMAGE *image, long NBsem);

//int ImageCreate(IMAGE *image, const char *name, long naxis, uint32_t *size, uint8_t datatype, int shared, int NBkw);


errno_t COREMOD_MEMORY_testfunc();


/* =============================================================================================== */
/* =============================================================================================== */
/** @name 1. MANAGE MEMORY AND IDENTIFIERS
 *
 */
///@{
/* =============================================================================================== */
/* =============================================================================================== */


errno_t    memory_monitor(
    const char *termttyname
);

long       compute_nb_image();

long       compute_nb_variable();

long long  compute_image_memory();

long       compute_variable_memory();

imageID    image_ID(
    const char *name
);

imageID    image_ID_noaccessupdate(
    const char *name
);

variableID variable_ID(
    const char *name
);

imageID    next_avail_image_ID();

variableID next_avail_variable_ID();

errno_t    delete_image_ID(
    const char *imname
);

errno_t    delete_image_ID_prefix(
    const char *prefix
);

errno_t    delete_variable_ID(
    const char *varname
);

variableID create_variable_long_ID(
    const char *name,
    long value
);

variableID create_variable_string_ID(
    const char *name,
    const char *value
);

imageID    create_image_ID(
    const char *name,
    long        naxis,
    uint32_t   *size,
    uint8_t     datatype,
    int         shared,
    int         nbkw
);

errno_t    clearall();

void      *save_fits_function(
    void *ptr
);

///@}



/* =============================================================================================== */
/* =============================================================================================== */
/** @name 2. KEYWORDS
 *
 */
///@{
/* =============================================================================================== */
/* =============================================================================================== */

long image_write_keyword_L(
    const char *IDname,
    const char *kname,
    long value, const
    char       *comment
);

long image_write_keyword_D(
    const char *IDname,
    const char *kname,
    double      value,
    const char *comment
);

long image_write_keyword_S(
    const char *IDname,
    const char *kname,
    const char *value,
    const char *comment
);

long image_list_keywords(
    const char *IDname
);

long image_read_keyword_D(
    const char *IDname,
    const char *kname,
    double     *val
);

long image_read_keyword_L(
    const char *IDname,
    const char *kname,
    long       *val
);

///@}



/* =============================================================================================== */
/* =============================================================================================== */
/** @name 3. READ SHARED MEM IMAGE AND SIZE
 *
 */
///@{
/* =============================================================================================== */
/* =============================================================================================== */


imageID    read_sharedmem_image_size(
    const char *name,
    const char *fname
);

imageID    read_sharedmem_image(
    const char *name
);

///@}



/* =============================================================================================== */
/* =============================================================================================== */
/** @name 4. CREATE IMAGE
 *
 */
///@{
/* =============================================================================================== */
/* =============================================================================================== */


imageID create_1Dimage_ID(
    const char *ID_name,
    uint32_t    xsize
);

imageID create_1DCimage_ID(
    const char *ID_name,
    uint32_t    xsize
);

imageID create_2Dimage_ID(
    const char *ID_name,
    uint32_t    xsize,
    uint32_t    ysize
);

imageID create_2Dimage_ID_double(
    const char *ID_name,
    uint32_t    xsize,
    uint32_t    ysize
);

imageID create_2DCimage_ID(
    const char *ID_name,
    uint32_t    xsize,
    uint32_t    ysize
);

imageID create_2DCimage_ID_double(
    const char *ID_name,
    uint32_t    xsize,
    uint32_t    ysize
);

imageID create_3Dimage_ID(
    const char *ID_name,
    uint32_t    xsize,
    uint32_t    ysize,
    uint32_t    zsize
);

imageID create_3Dimage_ID_double(
    const char *ID_name,
    uint32_t    xsize,
    uint32_t    ysize,
    uint32_t    zsize
);

imageID create_3DCimage_ID(
    const char *ID_name,
    uint32_t    xsize,
    uint32_t    ysize,
    uint32_t    zsize
);

///@}



/* =============================================================================================== */
/* =============================================================================================== */
/** @name 5. CREATE VARIABLE
 *
 */
///@{
/* =============================================================================================== */
/* =============================================================================================== */

variableID create_variable_ID(
    const char *name,
    double      value
);

///@}






/* =============================================================================================== */
/* =============================================================================================== */
/** @name 6. COPY IMAGE
 *
 */
///@{
/* =============================================================================================== */
/* =============================================================================================== */

imageID copy_image_ID(
    const char *name,
    const char *newname,
    int         shared
);

imageID chname_image_ID(
    const char *ID_name,
    const char *new_name
);

errno_t COREMOD_MEMORY_cp2shm(
    const char *IDname,
    const char *IDshmname
);

///@}





/* =============================================================================================== */
/* =============================================================================================== */
/** @name 7. DISPLAY / LISTS
 *
 */
///@{
/* =============================================================================================== */
/* =============================================================================================== */

errno_t init_list_image_ID_ncurses(
    const char *termttyname
);

void close_list_image_ID_ncurses();

errno_t list_image_ID_ncurses();

errno_t list_image_ID_ofp(
    FILE *fo
);

errno_t list_image_ID_ofp_simple(
    FILE *fo
);

errno_t list_image_ID();

errno_t list_image_ID_file(
    const char *fname
);

errno_t list_variable_ID();

errno_t list_variable_ID_file(
    const char *fname
);


///@}



/* =============================================================================================== */
/* =============================================================================================== */
/** @name 8. TYPE CONVERSIONS TO AND FROM COMPLEX
 *
 */
///@{
/* =============================================================================================== */
/* =============================================================================================== */

errno_t mk_complex_from_reim(
    const char *re_name,
    const char *im_name,
    const char *out_name,
    int         sharedmem
);

errno_t mk_complex_from_amph(
    const char *am_name,
    const char *ph_name,
    const char *out_name,
    int         sharedmem
);

errno_t mk_reim_from_complex(
    const char *in_name,
    const char *re_name,
    const char *im_name,
    int         sharedmem
);

errno_t mk_amph_from_complex(
    const char *in_name,
    const char *am_name,
    const char *ph_name,
    int         sharedmem
);

errno_t mk_reim_from_amph(
    const char *am_name,
    const char *ph_name,
    const char *re_out_name,
    const char *im_out_name,
    int         sharedmem
);

errno_t mk_amph_from_reim(
    const char *re_name,
    const char *im_name,
    const char *am_out_name,
    const char *ph_out_name,
    int         sharedmem
);

///@}





/* =============================================================================================== */
/* =============================================================================================== */
/** @name 9. VERIFY SIZE
 *
 */
///@{
/* =============================================================================================== */
/* =============================================================================================== */

int check_2Dsize(
    const char *ID_name,
    uint32_t    xsize,
    uint32_t    ysize
);

int check_3Dsize(
    const char *ID_name,
    uint32_t    xsize,
    uint32_t    ysize,
    uint32_t    zsize
);

int COREMOD_MEMORY_check_2Dsize(
    const char *IDname,
    uint32_t    xsize,
    uint32_t    ysize
);

int COREMOD_MEMORY_check_3Dsize(
    const char *IDname,
    uint32_t    xsize,
    uint32_t    ysize,
    uint32_t    zsize
);

///@}




/* =============================================================================================== */
/* =============================================================================================== */
/** @name 10. COORDINATE CHANGE
 *
 */
///@{
/* =============================================================================================== */
/* =============================================================================================== */

errno_t rotate_cube(const char *ID_name, const char *ID_out_name,
                    int orientation);

///@}





/* =============================================================================================== */
/* =============================================================================================== */
/** @name 11. SET IMAGE FLAGS / COUNTERS
 *
 */
///@{
/* =============================================================================================== */
/* =============================================================================================== */

errno_t COREMOD_MEMORY_image_set_status(
    const char *IDname,
    int         status
);

errno_t COREMOD_MEMORY_image_set_cnt0(
    const char *IDname,
    int         cnt0
);

errno_t COREMOD_MEMORY_image_set_cnt1(
    const char *IDname,
    int         cnt1
);

///@}




/* =============================================================================================== */
/* =============================================================================================== */
/** @name 12. MANAGE SEMAPHORES
 *
 */
///@{
/* =============================================================================================== */
/* =============================================================================================== */

imageID COREMOD_MEMORY_image_set_createsem(
    const char *IDname,
    long        NBsem
);


imageID COREMOD_MEMORY_image_seminfo(
    const char *IDname
);

imageID COREMOD_MEMORY_image_set_sempost(
    const char *IDname,
    long        index
);

imageID COREMOD_MEMORY_image_set_sempost_byID(
    imageID ID,
    long    index
);

imageID COREMOD_MEMORY_image_set_sempost_excl_byID(
    imageID ID,
    long    index
);

imageID COREMOD_MEMORY_image_set_sempost_loop(
    const char *IDname,
    long index,
    long dtus
);

imageID COREMOD_MEMORY_image_set_semwait(
    const char *IDname,
    long index
);

void *waitforsemID(
    void *ID
);

errno_t COREMOD_MEMORY_image_set_semwait_OR_IDarray(
    imageID *IDarray,
    long     NB_ID
);

errno_t COREMOD_MEMORY_image_set_semflush_IDarray(
    imageID *IDarray,
    long     NB_ID
);

imageID COREMOD_MEMORY_image_set_semflush(
    const char *IDname,
    long        index
);

///@}



/* =============================================================================================== */
/* =============================================================================================== */
/** @name 13. SIMPLE OPERATIONS ON STREAMS
 *
 */
///@{
/* =============================================================================================== */
/* =============================================================================================== */


/** @brief Poke stream at regular intervals
 */
imageID COREMOD_MEMORY_streamPoke(
    const char *IDstream_name,
    long        usperiod
);


/** @brief Difference between two streams
*/
imageID COREMOD_MEMORY_streamDiff(
    const char *IDstream0_name,
    const char *IDstream1_name,
    const char *IDstreammask_name,
    const char *IDstreamout_name,
    long        semtrig
);


/** @brief Paste two equal size 2D streams into an output 2D stream
*/
imageID COREMOD_MEMORY_streamPaste(
    const char *IDstream0_name,
    const char *IDstream1_name,
    const char *IDstreamout_name,
    long        semtrig0,
    long        semtrig1,
    int         master
);


/** difference between two halves of stream image
*/
imageID COREMOD_MEMORY_stream_halfimDiff(
    const char *IDstream_name,
    const char *IDstreamout_name,
    long        semtrig
);


/** @brief Averages frames in stream
 *
 * @param[in]  IDstream_name        Input stream
 * @param[in]  NBave                Number of consecutive frames to be averaged together
 * @param[in]  mode                 1: Perform average once, exit when completed and write output to local image
 * 									2: Run forever, write output to shared mem stream
 * @param[out] IDout_name           output stream name
 *
 */
imageID COREMOD_MEMORY_streamAve(
    const char *IDstream_name,
    int         NBave,
    int         mode,
    const char *IDout_name
);




/**
 * @brief takes a 3Dimage (circular buffer) and writes slices to a 2D image with time interval specified in us */
imageID COREMOD_MEMORY_image_streamupdateloop(
    const char *IDinname,
    const char *IDoutname,
    long        usperiod,
    long        NBcubes,
    long        period,
    long        offsetus,
    const char *IDsync_name,
    int         semtrig,
    int         timingmode
);


/**
 * @brief takes a 3Dimage (circular buffer) and writes slices to a 2D image synchronized with an image semaphore
 *
 *
 * @param[in]	IDinname  		3D circular buffer of frames to be written
 * @param[out]	IDoutname 		2D output stream
 * @param[in]	period	 		number of semaphore waits required to advance to next slice in the circular buffer
 * @param[in]	offsetus		fixed time offset between trigger stream and output write
 * @param[in]	IDsync_name		trigger stream
 * @param[in]	smmtrig			semaphore index for trigger
 * @param[in]	timingmode
 */
imageID COREMOD_MEMORY_image_streamupdateloop_semtrig(
    const char *IDinname,
    const char *IDoutname,
    long        period,
    long        offsetus,
    const char *IDsync_name,
    int         semtrig,
    int         timingmode
);


errno_t COREMOD_MEMORY_streamDelay_FPCONF(
    char    *fpsname,
    uint32_t CMDmode
);

imageID COREMOD_MEMORY_streamDelay_RUN(
    char *fpsname
);


errno_t COREMOD_MEMORY_streamDelay(
    const char *IDin_name,
    const char *IDout_name,
    long        delayus,
    long        dtus
);



errno_t COREMOD_MEMORY_SaveAll_snapshot(
    const char *dirname
);


errno_t COREMOD_MEMORY_SaveAll_sequ(
    const char *dirname,
    const char *IDtrig_name,
    long        semtrig,
    long        NBframes
);


errno_t COREMOD_MEMORY_testfunction_semaphore(
    const char *IDname,
    int         semtrig,
    int         testmode
);



imageID COREMOD_MEMORY_image_NETWORKtransmit(
    const char *IDname,
    const char *IPaddr,
    int         port,
    int         mode,
    int         RT_priority
);

imageID COREMOD_MEMORY_image_NETWORKreceive(
    int port,
    int mode,
    int RT_priority
);


imageID COREMOD_MEMORY_PixMapDecode_U(
    const char *inputstream_name,
    uint32_t    xsizeim,
    uint32_t    ysizeim,
    const char *NBpix_fname,
    const char *IDmap_name,
    const char *IDout_name,
    const char *IDout_pixslice_fname
);

///@}





/* =============================================================================================== */
/* =============================================================================================== */
/** @name 14. DATA LOGGING
 *
 */
///@{
/* =============================================================================================== */
/* =============================================================================================== */


errno_t COREMOD_MEMORY_logshim_printstatus(
    const char *IDname
);

errno_t COREMOD_MEMORY_logshim_set_on(
    const char *IDname,
    int         setv
);

errno_t COREMOD_MEMORY_logshim_set_logexit(
    const char *IDname,
    int setv
);

errno_t COREMOD_MEMORY_sharedMem_2Dim_log(
    const char  *IDname,
    uint32_t     zsize,
    const char  *logdir,
    const char  *IDlogdata_name
);

///@}


#endif