recv.h

   1 /*
   2  * Copyright (C) 2005-2006 Andre Noll <maan@systemlinux.org>
   3  *
   4  *     This program is free software; you can redistribute it and/or modify
   5  *     it under the terms of the GNU General Public License as published by
   6  *     the Free Software Foundation; either version 2 of the License, or
   7  *     (at your option) any later version.
   8  *
   9  *     This program is distributed in the hope that it will be useful,
  10  *     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *     GNU General Public License for more details.
  13  *
  14  *     You should have received a copy of the GNU General Public License
  15  *     along with this program; if not, write to the Free Software
  16  *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  17  */
  18
  19 /** \file recv.h receiver-relates structures and exported symbols of recv_common.c */
  20
  21 /**
  22  * describes one instance of a receiver
  23  */
  24 struct receiver_node {
  25         /** points to the corresponding receiver */
  26         struct receiver *receiver;
  27         /** the output buffer */
  28         char *buf;
  29         /** the amount of bytes in \a buf */
  30         size_t loaded;
  31         /** receiver-specific data */
  32         void *private_data;
  33         /** set to 1 if end of file is reached */
  34         int eof;
  35         /** pointer to the configuration data for this instance */
  36         void *conf;
  37         /** the task associated with this instance */
  38         struct task task;
  39 };
  40
  41 /**
  42  * describes one supported paraslash receiver
  43  *
  44  * \sa http_recv.c, ortp_recv.c
  45  */
  46 struct receiver {
  47 /**
  48  *
  49  *
  50  * the name of the receiver
  51  */
  52         const char *name;
  53 /**
  54  *
  55  *
  56  * the receiver init function
  57  *
  58  * It must fill in all other function pointers and is assumed to succeed.
  59  *
  60  * \sa http_recv_init ortp_recv_init
  61  */
  62         void (*init)(struct receiver *r);
  63 /**
  64  *
  65  *
  66  * the command line parser of the receiver
  67  *
  68  * It should check whether the command line options given by \a argc and \a
  69  * argv are valid.  On success, it should return a pointer to the
  70  * receiver-specific configuration data determined by \a argc and \a argv.
  71  * Note that this might be called more than once with different values of
  72  * \a argc and \a argv.
  73  *
  74  */
  75         void * (*parse_config)(int argc, char **argv);
  76 /**
  77  *
  78  *
  79  * open one instance of the receiver
  80  *
  81  * This should allocate the output buffer of \a rn. and may also perform any
  82  * other work necessary for retrieving the stream according to the
  83  * configuration stored in the \a conf member of \a rn which is guaranteed to
  84  * point to valid configuration data (as previously obtained from the config
  85  * parser).
  86  *
  87  * \sa receiver_node::conf, receiver_node::buf
  88  */
  89         int (*open)(struct receiver_node *rn);
  90 /**
  91  *
  92  *
  93  * close one instance of the receiver
  94  *
  95  * It should free all resources associated with given receiver node that were
  96  * allocated during the corresponding open call.
  97  *
  98  * \sa receiver_node
  99  */
 100         void (*close)(struct receiver_node *rn);
 101 /**
 102  *
 103  *
 104  * deactivate the receiver
 105  *
 106  * Clean up what init has allocated.
 107  */
 108         void (*shutdown)(void);
 109 /**
 110  *
 111  *
 112  * add file descriptors to fd_sets and compute timeout for select(2)
 113  *
 114  * The pre_select function gets called from the driving application before
 115  * entering its select loop. The receiver may use this hook to add any file
 116  * descriptors to the sets of file descriptors given by \a s.
 117  *
 118  *
 119  * \sa select(2), time.c struct task, struct sched
 120  */
 121         void (*pre_select)(struct sched *s, struct task *t);
 122 /**
 123  *
 124  *
 125  * evaluate the result from select()
 126  *
 127  * This hook gets called after the call to select(). It should check all file
 128  * descriptors which were added to any of the the fd sets during the previous
 129  * call to pre_select. According to the result, it may then use any
 130  * non-blocking I/O to establish a connection or to receive the audio data.
 131  *
 132  *
 133  * \sa select(2), struct receiver
 134  */
 135         void (*post_select)(struct sched *s, struct task *t);
 136 };
 137
 138
 139 /** \cond */
 140 extern void http_recv_init(struct receiver *r);
 141 #define HTTP_RECEIVER {.name = "http", .init = http_recv_init},
 142 extern void dccp_recv_init(struct receiver *r);
 143 #define DCCP_RECEIVER {.name = "dccp", .init = dccp_recv_init},
 144
 145 #ifdef HAVE_ORTP
 146 extern void ortp_recv_init(struct receiver *r);
 147 #define ORTP_RECEIVER {.name = "ortp", .init = ortp_recv_init},
 148 #else
 149 #define ORTP_RECEIVER
 150 #endif
 151
 152 void *check_receiver_arg(char *ra, int *receiver_num);
 153
 154
 155 extern struct receiver receivers[];
 156 extern void (*crypt_function_recv)(unsigned long len, const unsigned char *indata, unsigned char *outdata);
 157 extern void (*crypt_function_send)(unsigned long len, const unsigned char *indata, unsigned char *outdata);
 158
 159 #define DEFINE_RECEIVER_ARRAY struct receiver receivers[] = { \
 160         HTTP_RECEIVER \
 161         DCCP_RECEIVER \
 162         ORTP_RECEIVER \
 163         {.name = NULL}};
 164
 165 /** \endcond */