REF_DEBUG: Install refcounter.py to $(ASTDATADIR)/scripts
[asterisk/asterisk.git] / formats / format_gsm.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, 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 Save to raw, headerless GSM data.
22  * \arg File name extension: gsm
23  * \ingroup formats
24  */
25
26 /*** MODULEINFO
27         <support_level>core</support_level>
28  ***/
29  
30 #include "asterisk.h"
31
32 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
33
34 #include "asterisk/mod_format.h"
35 #include "asterisk/module.h"
36 #include "asterisk/endian.h"
37 #include "asterisk/format_cache.h"
38
39 #include "msgsm.h"
40
41 /* Some Ideas for this code came from makegsme.c by Jeffrey Chilton */
42
43 /* Portions of the conversion code are by guido@sienanet.it */
44
45 #define GSM_FRAME_SIZE  33
46 #define GSM_SAMPLES     160
47
48 /* silent gsm frame */
49 /* begin binary data: */
50 static const char gsm_silence[] = /* 33 */
51 {0xD8,0x20,0xA2,0xE1,0x5A,0x50,0x00,0x49,0x24,0x92,0x49,0x24,0x50,0x00,0x49
52 ,0x24,0x92,0x49,0x24,0x50,0x00,0x49,0x24,0x92,0x49,0x24,0x50,0x00,0x49,0x24
53 ,0x92,0x49,0x24};
54 /* end binary data. size = 33 bytes */
55
56 static struct ast_frame *gsm_read(struct ast_filestream *s, int *whennext)
57 {
58         int res;
59
60         AST_FRAME_SET_BUFFER(&(s->fr), s->buf, AST_FRIENDLY_OFFSET, GSM_FRAME_SIZE)
61         if ((res = fread(s->fr.data.ptr, 1, GSM_FRAME_SIZE, s->f)) != GSM_FRAME_SIZE) {
62                 if (res)
63                         ast_log(LOG_WARNING, "Short read (%d) (%s)!\n", res, strerror(errno));
64                 return NULL;
65         }
66         *whennext = s->fr.samples = GSM_SAMPLES;
67         return &s->fr;
68 }
69
70 static int gsm_write(struct ast_filestream *fs, struct ast_frame *f)
71 {
72         int res;
73         unsigned char gsm[2*GSM_FRAME_SIZE];
74
75         if (!(f->datalen % 65)) {
76                 /* This is in MSGSM format, need to be converted */
77                 int len=0;
78                 while(len < f->datalen) {
79                         conv65(f->data.ptr + len, gsm);
80                         if ((res = fwrite(gsm, 1, 2*GSM_FRAME_SIZE, fs->f)) != 2*GSM_FRAME_SIZE) {
81                                 ast_log(LOG_WARNING, "Bad write (%d/66): %s\n", res, strerror(errno));
82                                 return -1;
83                         }
84                         len += 65;
85                 }
86         } else {
87                 if (f->datalen % GSM_FRAME_SIZE) {
88                         ast_log(LOG_WARNING, "Invalid data length, %d, should be multiple of 33\n", f->datalen);
89                         return -1;
90                 }
91                 if ((res = fwrite(f->data.ptr, 1, f->datalen, fs->f)) != f->datalen) {
92                                 ast_log(LOG_WARNING, "Bad write (%d/33): %s\n", res, strerror(errno));
93                                 return -1;
94                 }
95         }
96         return 0;
97 }
98
99 static int gsm_seek(struct ast_filestream *fs, off_t sample_offset, int whence)
100 {
101         off_t offset = 0, min = 0, cur, max, distance;
102
103         if ((cur = ftello(fs->f)) < 0) {
104                 ast_log(AST_LOG_WARNING, "Unable to determine current position in g719 filestream %p: %s\n", fs, strerror(errno));
105                 return -1;
106         }
107
108         if (fseeko(fs->f, 0, SEEK_END) < 0) {
109                 ast_log(AST_LOG_WARNING, "Unable to seek to end of g719 filestream %p: %s\n", fs, strerror(errno));
110                 return -1;
111         }
112
113         if ((max = ftello(fs->f)) < 0) {
114                 ast_log(AST_LOG_WARNING, "Unable to determine max position in g719 filestream %p: %s\n", fs, strerror(errno));
115                 return -1;
116         }
117
118         /* have to fudge to frame here, so not fully to sample */
119         distance = (sample_offset / GSM_SAMPLES) * GSM_FRAME_SIZE;
120         if (whence == SEEK_SET) {
121                 offset = distance;
122         } else if (whence == SEEK_CUR || whence == SEEK_FORCECUR) {
123                 offset = distance + cur;
124         } else if (whence == SEEK_END) {
125                 offset = max - distance;
126         }
127
128         /* Always protect against seeking past the begining. */
129         offset = (offset < min)?min:offset;
130         if (whence != SEEK_FORCECUR) {
131                 offset = (offset > max)?max:offset;
132         } else if (offset > max) {
133                 int i;
134                 fseeko(fs->f, 0, SEEK_END);
135                 for (i=0; i< (offset - max) / GSM_FRAME_SIZE; i++) {
136                         if (!fwrite(gsm_silence, 1, GSM_FRAME_SIZE, fs->f)) {
137                                 ast_log(LOG_WARNING, "fwrite() failed: %s\n", strerror(errno));
138                         }
139                 }
140         }
141         return fseeko(fs->f, offset, SEEK_SET);
142 }
143
144 static int gsm_trunc(struct ast_filestream *fs)
145 {
146         int fd;
147         off_t cur;
148
149         if ((fd = fileno(fs->f)) < 0) {
150                 ast_log(AST_LOG_WARNING, "Unable to determine file descriptor for gsm filestream %p: %s\n", fs, strerror(errno));
151                 return -1;
152         }
153         if ((cur = ftello(fs->f)) < 0) {
154                 ast_log(AST_LOG_WARNING, "Unable to determine current position in gsm filestream %p: %s\n", fs, strerror(errno));
155                 return -1;
156         }
157         /* Truncate file to current length */
158         return ftruncate(fd, cur);
159 }
160
161 static off_t gsm_tell(struct ast_filestream *fs)
162 {
163         off_t offset = ftello(fs->f);
164
165         if (offset < 0) {
166                 ast_log(AST_LOG_WARNING, "Unable to determine offset for gsm filestream %p: %s\n", fs, strerror(errno));
167                 return 0;
168         }
169
170         return (offset / GSM_FRAME_SIZE) * GSM_SAMPLES;
171 }
172
173 static struct ast_format_def gsm_f = {
174         .name = "gsm",
175         .exts = "gsm",
176         .write = gsm_write,
177         .seek = gsm_seek,
178         .trunc = gsm_trunc,
179         .tell = gsm_tell,
180         .read = gsm_read,
181         .buf_size = 2*GSM_FRAME_SIZE + AST_FRIENDLY_OFFSET,     /* 2 gsm frames */
182 };
183
184 static int load_module(void)
185 {
186         gsm_f.format = ast_format_gsm;
187         if (ast_format_def_register(&gsm_f))
188                 return AST_MODULE_LOAD_FAILURE;
189         return AST_MODULE_LOAD_SUCCESS;
190 }
191
192 static int unload_module(void)
193 {
194         return ast_format_def_unregister(gsm_f.name);
195 }
196
197 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "Raw GSM data",
198         .support_level = AST_MODULE_SUPPORT_CORE,
199         .load = load_module,
200         .unload = unload_module,
201         .load_pri = AST_MODPRI_APP_DEPEND
202 );