defs.h

Go to the documentation of this file.

/*********************************************************************** 
 *
 * Copyright (C) 2009  Nils Doormann <ndmn@users.sourceforge.net>
 * 
 * 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 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 ***********************************************************************/

/***************************************************************
 * defs.h
 *
 * $Id: defs.h,v 1.4 2009/09/08 21:54:48 ndmn Exp $
 *
 * Definitions common to all units
 *
 ***************************************************************/

#ifndef __NCHAINS_DEFS_H
#define __NCHAINS_DEFS_H

#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <sys/time.h>
#include <curses.h>
#include <signal.h>
#include <string.h>

/**
 * @desc The ecasound standard server port
 */
#define ECA_SERVER_PORT 2868 /* see man ecasound(1) */

/**
 * @desc Maximum size of server response string
 */
#define MAX_SRESP 1024

/*
 * @desc Server response code
 */
#define SRESP_OK 256
#define SRESP_ERR -1

/*
 * The maximum length of an input or output name
 */
#define INPUT_MAX       256
#define OUTPUT_MAX      256

/** 
 * number of chains 
 */
#define NUM_CHAINS 8

/*
 * View offsets
 */
#define OFFSET_CHAINLIST 2
#define FOOTER_OFFSET (OFFSET_CHAINLIST + app->num_chains )
#define STATUS_Y (FOOTER_OFFSET + 5)
#define STATUS_OFFSET STATUS_Y /* synonym */

/*
 * X-positions
 */
#define CNAME_X 0
#define INPUT_X 20
#define OUTPUT_X 22
#define MUTED_X 24
#define SOLO_X 26
#define CHCOPY_X 28
#define VOLUME_X 30
#define PANNING_X 35


/*
 * Positions
 */
#define CUR_CHAIN_INDEX gchain[y-OFFSET_CHAINLIST].index
#define PCUR_CHAIN_INDEX gchain[y-OFFSET_CHAINLIST]->index
#define CURSOR_OVER_CHAIN (y >= OFFSET_CHAINLIST && y < (app->num_chains+OFFSET_CHAINLIST))

/*
 * Other
 */
#define STR_STATUS "                                                                                    "

/**
 *  Foreground color pairs
 */
enum __color_pairs { 
CP_CYAN = 1,
CP_YELLOW = 2,
CP_GREEN = 3,
CP_RED = 4,
CP_RED_INV = 5,
CP_MAGENTA = 6,
CP_GREEN_INV = 7,
CP_BLUE = 8
};

/** 
 * @desc All the muted states 
 */
enum __muted_states 
{ 
STATE_MUTED_NONE = 0,
STATE_MUTED_MUTED = 1,
STATE_MUTED_SOLO = 2
};

/*
 * @desc Mute actions
 */
enum __mute_actions 
{
MA_MUTE = 0,
MA_SOLO = 1,
MA_SMUTE = 2
};

/**
 * Channel copy modes
 */
enum __chcopy_modes
{
CHCOPY_OFF = 0,
CHCOPY_ON  = 1
};

/*
 * @desc End Of Command
 */
#define EOC "\r\n"

/*************************************************************************
 * Types
 *************************************************************************/
//struct _aio;
//struct _chain;

struct _aio
{
        struct _chain *chains_connected;
        int num_chains_connected;
        int selected;
        char *name;
        char *position;
        char *length;
};

typedef struct _aio AIO_INPUT;
typedef struct _aio* AIO_INPUT_ITERATOR;

typedef struct _aio AIO_OUTPUT;
typedef struct _aio* AIO_OUTPUT_ITERATOR;



struct _chain
{
        /**
         * @desc The row index of the chain from 0..n where 0 is the first and n the last chain in row.
         */
        int index; /* == visual row */
        
        /**
         * @desc The chain identifier string. 
         * According to the active signal selection option <b>-a</b> from ecasound(3), 
         * this field defines the chain name of the chain.
         */
        char a[20];
        
        /**
         * @desc The visual chain name string. 
         */
        char va[20];
        
        /**
         * @desc The chain input name which corresponds to ecasound(3) option <b>-i</b>.
         */
        char i[255];

        /*
         * audio input index, 0 if not attached
         */
        unsigned int input;
        
        /**
         * @desc The chain output which corresponds to ecasound(3) option <b>-o</b>.
         */
        char o[255];

        /*
         * audio output index, 0 if not attached
         */
        unsigned int output;
        
        /**
         * @desc The Amplify parameter of the chain. See ecasound(3) <b>-ea</b>.
         */
        int ea;
        
        /**
         * @desc The Normal pan parameter of the chain. See ecasound(3) <b>-epp</b>.
         */
        int epp;
        
        /**
         * @desc Channel copy mode switch, can be 0(off) or 1(on).
         */
        int chcopy;
        
        /**
         * @desc Muting status switch. Values can be STATE_MUTED_NONE, STATE_MUTED_MUTED or STATE_MUTED_SOLO.
         */
        short state_muted;
        
        /**
         * @desc This file sequencing parameter defines the time position in seconds when the specific chain input should be played.
         * Think of &quot;play input.wav at songposition 330.475 seconds&quot;. See ecasound(3), section <i>Audio file sequencing</i>.
         */
        float ai_playat;
        
        /**
         * @desc The sequence offset. Plays the input from its time position <i>offset</i>. See ecasound(3), section <i>Audio file sequencing</i>.
         */
        float ai_select;
        
        /**
         * @desc The input sequence duration in seconds.
         */
        float ai_duration;
        
        /**
         * @desc The total length of the chain input.
         */
        float ai_length;

        /**
         * Indicates that the chain is temporarily being removed (for ex. a chain with null input device during bounce)
         * can be 0 or 1(removed)
         */
        int removed;

};


typedef struct _chain CHAIN;
typedef struct _chain* CHAIN_ITERATOR;

/*
 * Application state
 */
struct _application
{
        WINDOW *win;
        char debug;
        char is_running;
        char csname[255];

        /*
         * Client socket file descriptors/pointers
         */
        int cl_sfd;
        FILE *cl_sfp;

        /**
         * Number of all chains contained in the project
         */
        unsigned int num_chains;

        /**
         * @desc Container for all chains.
         * @see num_chains for the number of elements contained in the chain list.
         */
        struct _chain *gchain;

        /**
         * Pointer to the fist chain in chain list
         */
        struct _chain *cbegin;

        /**
         * Pointer to the last chain in chain list
         */
        struct _chain *cend;

        /*
         * The total number of inputs and outputs
         * contained in chain setup
         */
        unsigned int num_inputs;
        unsigned int num_outputs;

        /*
         * How many chains are soloized
         */
        int count_solo;

        /*
         * real length is the computed length of all relevant chains
         */
        float real_length;

        /*
         * initial setup flags
         */
        char start_server;
        char server_host[1024]; // hostname
        unsigned int server_port;

};

/************************************************************************
 * Global Solo state counter
 ************************************************************************/
//extern int count_solo;

/************************************************************************
 * global chain container 
 ***********************************************************************/
//extern struct _chain gchain[NUM_CHAINS];

struct _application *gappl;

#endif /* __NCHAINS_DEFS_H */

---