remove an unused function.
[asterisk/asterisk.git] / formats / format_pcm_alaw.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Flat, binary, alaw PCM file format.
22  * \arg File name extensions: alaw, al
23  * \ingroup formats
24  */
25  
26 #include <unistd.h>
27 #include <netinet/in.h>
28 #include <arpa/inet.h>
29 #include <stdlib.h>
30 #include <sys/time.h>
31 #include <sys/times.h>
32 #include <sys/types.h>
33 #include <stdio.h>
34 #include <errno.h>
35 #include <string.h>
36
37 #include "asterisk.h"
38
39 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
40
41 #include "asterisk/lock.h"
42 #include "asterisk/channel.h"
43 #include "asterisk/file.h"
44 #include "asterisk/logger.h"
45 #include "asterisk/sched.h"
46 #include "asterisk/module.h"
47 #include "asterisk/endian.h"
48 #include "asterisk/alaw.h"
49
50 #define BUF_SIZE 160            /* 160 bytes, and same number of samples */
51
52 /* #define REALTIME_WRITE */    /* XXX does it work at all ? */
53
54 struct pcma_desc {
55 #ifdef REALTIME_WRITE
56         unsigned long start_time;
57 #endif
58 };
59
60 static char alaw_silence[BUF_SIZE];
61
62 #if 0
63 /* Returns time in msec since system boot. */
64 static unsigned long get_time(struct ast_filestream *s)
65 {
66         struct tms buf;
67         clock_t cur;
68         unsigned long *res;
69
70         cur = times( &buf );
71         if( cur < 0 )
72         {
73                 ast_log( LOG_WARNING, "Cannot get current time\n" );
74                 return 0;
75         }
76         res = cur * 1000 / sysconf( _SC_CLK_TCK );
77         if (s) {
78                 struct pcma_desc *d = (struct pcma_filestream *)s->private;
79                 d->start_time = res;
80         }
81         return res;
82 }
83 #endif
84
85 static int pcm_open(struct ast_filestream *s)
86 {
87 #ifdef REALTIME_WRITE
88         get_time(s);
89 #endif
90         return 0;
91 }
92
93 static int pcm_rewrite(struct ast_filestream *s, const char *comment)
94 {
95         return pcm_open(s);
96 }
97
98 static struct ast_frame *pcm_read(struct ast_filestream *s, int *whennext)
99 {
100         int res;
101         /* Send a frame from the file to the appropriate channel */
102
103         s->fr.frametype = AST_FRAME_VOICE;
104         s->fr.subclass = AST_FORMAT_ALAW;
105         s->fr.mallocd = 0;
106         FR_SET_BUF(&s->fr, s->buf, AST_FRIENDLY_OFFSET, BUF_SIZE);
107         if ((res = fread(s->fr.data, 1, s->fr.datalen, s->f)) < 1) {
108                 if (res)
109                         ast_log(LOG_WARNING, "Short read (%d) (%s)!\n", res, strerror(errno));
110                 return NULL;
111         }
112         s->fr.datalen = res;
113         *whennext = s->fr.samples = res;
114         return &s->fr;
115 }
116
117 static int pcm_write(struct ast_filestream *fs, struct ast_frame *f)
118 {
119         int res;
120 #ifdef REALTIME_WRITE
121         unsigned long cur_time;
122         unsigned long fpos;
123         struct stat stat_buf;
124         struct pcma_filestream *s = (struct pcma_filestream *)fs->private;
125 #endif
126
127         if (f->frametype != AST_FRAME_VOICE) {
128                 ast_log(LOG_WARNING, "Asked to write non-voice frame!\n");
129                 return -1;
130         }
131         if (f->subclass != AST_FORMAT_ALAW) {
132                 ast_log(LOG_WARNING, "Asked to write non-alaw frame (%d)!\n", f->subclass);
133                 return -1;
134         }
135
136 #ifdef REALTIME_WRITE
137         cur_time = get_time();
138         fpos = ( cur_time - s->start_time ) * 8;        /* 8 bytes per msec */
139         /* Check if we have written to this position yet. If we have, then increment pos by one frame
140         *  for some degree of protection against receiving packets in the same clock tick.
141         */
142         
143         fstat(fileno(fs->f), &stat_buf );
144         if (stat_buf.st_size > fpos ) {
145                 fpos += f->datalen;     /* Incrementing with the size of this current frame */
146         }
147
148         if (stat_buf.st_size < fpos) {
149                 /* fill the gap with 0x55 rather than 0. */
150                 char buf[ 512 ];
151                 unsigned long cur, to_write;
152
153                 cur = stat_buf.st_size;
154                 if (fseeko(fs->f, cur, SEEK_SET) < 0) {
155                         ast_log( LOG_WARNING, "Cannot seek in file: %s\n", strerror(errno) );
156                         return -1;
157                 }
158                 memset(buf, 0x55, 512);
159                 while (cur < fpos) {
160                         to_write = fpos - cur;
161                         if (to_write > 512) {
162                                 to_write = 512;
163                         }
164                         fwrite(buf, 1, to_write, fs->f);
165                         cur += to_write;
166                 }
167         }
168
169
170         if (fseeko(s->f, fpos, SEEK_SET) < 0) {
171                 ast_log( LOG_WARNING, "Cannot seek in file: %s\n", strerror(errno) );
172                 return -1;
173         }
174 #endif  /* REALTIME_WRITE */
175         
176         if ((res = fwrite(f->data, 1, f->datalen, fs->f)) != f->datalen) {
177                         ast_log(LOG_WARNING, "Bad write (%d/%d): %s\n", res, f->datalen, strerror(errno));
178                         return -1;
179         }
180         return 0;
181 }
182
183 static int pcm_seek(struct ast_filestream *fs, off_t sample_offset, int whence)
184 {
185         off_t cur, max, offset = 0;
186         int ret = -1; /* assume error */
187
188         cur = ftello(fs->f);
189         fseeko(fs->f, 0, SEEK_END);
190         max = ftello(fs->f);
191
192         switch (whence) {
193         case SEEK_SET:
194                 offset = sample_offset;
195                 break;
196         case SEEK_END:
197                 offset = max - sample_offset;
198                 break;
199         case SEEK_CUR:
200         case SEEK_FORCECUR:
201                 offset = cur + sample_offset;
202                 break;
203         default:
204                 ast_log(LOG_WARNING, "invalid whence %d, assuming SEEK_SET\n", whence);
205                 offset = sample_offset;
206         }
207
208         if (offset < 0) {
209                 offset = 0;
210                 ast_log(LOG_WARNING, "negative offset %ld, resetting to 0\n", (long) offset);
211         }
212         if (whence == SEEK_FORCECUR && offset > max) {
213                 size_t left = offset - max;
214
215                 while (left) {
216                         size_t written = fwrite(alaw_silence, sizeof(alaw_silence[0]),
217                                      (left > BUF_SIZE) ? BUF_SIZE : left, fs->f);
218                         if (written == -1)
219                                 break; /* error */
220                         left -= written * sizeof(alaw_silence[0]);
221                 }
222                 ret = 0; /* success */
223         } else {
224                 if (offset > max) {
225                         ast_log(LOG_WARNING, "offset too large %ld, truncating to %ld\n", (long) offset, (long) max);
226                         offset = max;
227                 }
228                 ret = fseeko(fs->f, offset, SEEK_SET);
229         }
230         return ret;
231 }
232
233 static int pcm_trunc(struct ast_filestream *fs)
234 {
235         return ftruncate(fileno(fs->f), ftello(fs->f));
236 }
237
238 static off_t pcm_tell(struct ast_filestream *fs)
239 {
240         return ftello(fs->f);
241 }
242
243 static struct ast_format_lock me = { .usecnt = -1 };
244
245 static const struct ast_format alaw_f = {
246         .name = "alaw",
247         .exts = "alaw|al",
248         .format = AST_FORMAT_ALAW,
249         .open = pcm_open,
250         .rewrite = pcm_rewrite,
251         .write = pcm_write,
252         .seek = pcm_seek,
253         .trunc = pcm_trunc,
254         .tell = pcm_tell,
255         .read = pcm_read,
256         .buf_size = BUF_SIZE + AST_FRIENDLY_OFFSET,
257         .lockp = &me,
258 #ifdef  REALTIME_WRITE
259         .desc_size = sizeof(struct pcma_desc),
260 #endif
261 };
262
263 int load_module()
264 {
265         int index;
266
267         for (index = 0; index < (sizeof(alaw_silence) / sizeof(alaw_silence[0])); index++)
268                 alaw_silence[index] = AST_LIN2A(0);
269
270         return ast_format_register(&alaw_f);
271 }
272
273 int unload_module()
274 {
275         return ast_format_unregister(alaw_f.name);
276 }       
277
278 int usecount()
279 {
280         return me.usecnt;
281 }
282
283 char *description()
284 {
285         return "Raw aLaw 8khz PCM Audio support";
286 }
287
288 char *key()
289 {
290         return ASTERISK_GPL_KEY;
291 }