join.c

This a framework to test new ideas in transmission technology. Actual development is a LDPC-coder in

/***************************************************************************
 *    join.c  -  joins two streams and makes one
 *                           -------------------
 *   begin                :  17 Jul 2003 
 *   authors              :  Selvavinayagam Gunabalan
 *   emails               :  [e-mail]
 ***************************************************************************/

/***************************************************************************
 *                                Changes
 *                                -------
 * 17/06/03 - Selvan - Begin
 * 04/03/05 - ineiti - adjusted description
 *
 **************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/


/**
 * This block joins two complex sub-streams into a single stream:
 *                           figure:
 * in1: 1 3 5 7 ------
 *                    |----- 1 2 3 4 5 6 7 8 : out
 * in2: 2 4 6 8 ------
 */

#include "spc.h"
#include "join.h"

#define DBG_LVL 0


typedef struct {}
config_t;

typedef struct {}
stats_t;

typedef struct {}
private_t;


/*
 * The initialisation function, or constructor, 
 * is called the first time this module is instantiated.
 */

int spc_init( swr_sdb_t *context ) {
  // Begin system-definitions {
  config_t *config;
  stats_t *stats;
  MOD_INC_USE_COUNT;
  if ( sizeof( private_t ) > 0 )
    context->private_data = swr_malloc( sizeof( private_t ) );
  swr_sdb_get_config_struct( context->id, (void**)&config );
  swr_sdb_get_stats_struct( context->id, (void**)&stats );
  // } End of system-definitions

  /**
   * Put your initialisation here. All parameters you define in config_t,
   * stats_t and private_t can be accessed through config->, stats-> and
   * private-> respectively
   * ADD HERE
   */

  // Begin system-definitions
  swr_sdb_free_stats_struct( context->id, (void**)&stats );
  swr_sdb_free_config_struct( context->id, (void**)&config );
  return 0;
  // End system-definitions
}


/*
 * To configure the inputs
 * this is called when the output-sizes change.
 */
int spc_configure_inputs( swr_sdb_t *context ) {
  // Definition of variables - don't touch
  config_t *config;
  swr_sdb_get_config_struct( context->id, (void**)&config );

  port_in(0).size  = port_out(0).size >> 1;
  port_in(1).size  = port_out(0).size >> 1;

  // Definition - don't touch
  swr_sdb_free_config_struct( context->id, (void**)&config );
  return 0;
}


/*
 * To configure the outputs
 * this is called when the input-sizes change
 */
int spc_configure_outputs( swr_sdb_t *context ) {
  // Definition of variables - don't touch
  config_t *config;
  swr_sdb_get_config_struct( context->id, (void**)&config );

  port_out(0).size  = port_in(0).size << 1;

  swr_sdb_free_config_struct( context->id, (void**)&config );
  return 0;
}


/*
 * Every time modules from the outside change the value of a configuration parameter,
 * this function is called.
 */

int spc_reconfig( swr_sdb_t *context ) {
  // Definition of variables - don't touch
  config_t *config;
  swr_sdb_get_config_struct( context->id, (void**)&config );

  // Put you code here
  // ADD HERE

  // Definition - don't touch
  swr_sdb_free_config_struct( context->id, (void**)&config );
  return 0;
}


/*
 * This is the function that implements the `main method' of the class
 * Every class has got just ONE method/working-mode.
 */
int spc_pdata( swr_sdb_t *context ) {
  // Definition of variables - don't touch
  stats_t *stats;
  SYMBOL_COMPLEX *in1, *in2, *out1;
  int i;

  if ( !data_available( 0 ) || !data_available( 1 ) ) {
    // Not all data here yet -> return and wait for all data
    PR_DBG( 4, "Not all data yet\n" );
    return 0;
  }
  PR_DBG( 4, "All data is here\n" );

  in1  = buffer_in( 0 );
  in2  = buffer_in( 1 );
  out1 = buffer_out( 0 );


  for (i = 0; i < port_in( 0 ).size; i++) {

    out1[ 2 * i ].real    = in1[ i ].real;
    out1[ 2 * i ].imag    = in1[ i ].imag;
    out1[ 2 * i + 1].real = in2[ i ].real;
    out1[ 2 * i + 1].imag = in2[ i ].imag;

  }


  swr_sdb_get_stats_struct( context->id, (void**)&stats );
  // Put your code here
  // ADD HERE
  swr_sdb_free_stats_struct( context->id, (void**)&stats );
  return(0);
}

/**
 * User messages
 */
int spc_custom_msg( swr_sdb_t *context, swr_usr_msg_t *data, swr_msgq ret ) {

  return 0;
}

/*
 * This is the `destructor'.
 */
int spc_finalize( swr_sdb_t *context ) {
  if ( sizeof( private_t ) > 0 )
    swr_free( private );
  MOD_DEC_USE_COUNT;
  return 0;
}


/*
 * This function is called upon "insmod" and is used to register the
 * different parts of the module to the SPM.
 */
swr_spc_id_t cdb_id;
int spc_module_init(void) {
  swr_spc_desc_t *desc;

  /**
   * Get a description-part from SPM
   * Give the following parameters:
   * Input-ports, output-ports, config-params, stat-params
   */
  desc = swr_spc_get_new_desc( 2, 1, 0, 0 );
  if ( !desc ) {
    PR_DBG( 0, "Can't initialise the module. This is BAD!\n" );
    return -1;
  }

  /**
   * Define the different parts of config and stats. You have to define
   * them in the same order as they appear in the structures. The names
   * can be freely chosen.
   *
   * UM_CONFIG_{INT,DOUBLE,STRING128,POINTER}( "name" );
   * UM_STATS_{INT,DOUBLE,STRING128,POINTER,BLOCK}( "name" );
   */
  /**
   * The in- and outputs have also to be defined in the right order. First
   * port first. The additional flag is not used yet, but it will...
   *
   * UM_INPUT( SIG_{U8,SYMBOL_{S16,COMPLEX,MMX},SAMPLE_S12,S32}, 0 );
   * UM_OUTPUT( SIG_{U8,SYMBOL_{S16,COMPLEX,MMX},SAMPLE_S12,S32}, 0 );
   */

  // Initialise the callback-functions. Delete the ones you don't use


  UM_INPUT( SIG_SYMBOL_COMPLEX, 0 );
  UM_INPUT( SIG_SYMBOL_COMPLEX, 0 );


  UM_OUTPUT( SIG_SYMBOL_COMPLEX, 0 );


  desc->fn_init              = spc_init;
  desc->fn_reconfigure       = spc_reconfig;
  desc->fn_process_data      = spc_pdata;
  desc->fn_configure_inputs  = spc_configure_inputs;
  desc->fn_configure_outputs = spc_configure_outputs;
  desc->fn_custom_msg        = NULL;
  desc->fn_finalize          = spc_finalize;

  // And register the module in the SPM. Change the name!
  cdb_id = swr_cdb_register_spc( &desc, "join" );
  if ( cdb_id == SWR_SPM_INVALID_ID ) {
    swr_spc_free_desc( desc );
    PR_DBG( 0, "Couldn't register the module!\n" );
    return 1;
  }
  PR_DBG( 4, "Ready\n" );
  return 0;
}


/*
 * This is called upon rmmod
 */
void spc_module_exit( void ) {
  PR_DBG( 4, "Freeing id: %i\n", cdb_id );
  if ( swr_cdb_unregister_spc( cdb_id ) < 0 ) {
    PR_DBG( 0, "Still in use somewhere\n" );
  }
}


module_init( spc_module_init );
module_exit( spc_module_exit );