asterisk/formats/format_g726.c
Matt Jordan 4a58261694 git migration: Refactor the ASTERISK_FILE_VERSION macro
Git does not support the ability to replace a token with a version
string during check-in. While it does have support for replacing a
token on clone, this is somewhat sub-optimal: the token is replaced
with the object hash, which is not particularly easy for human
consumption. What's more, in practice, the source file version was often
not terribly useful. Generally, when triaging bugs, the overall version
of Asterisk is far more useful than an individual SVN version of a file. As a
result, this patch removes Asterisk's support for showing source file
versions.

Specifically, it does the following:

* Rename ASTERISK_FILE_VERSION macro to ASTERISK_REGISTER_FILE, and
  remove passing the version in with the macro. Other facilities
  than 'core show file version' make use of the file names, such as
  setting a debug level only on a specific file. As such, the act of
  registering source files with the Asterisk core still has use. The
  macro rename now reflects the new macro purpose.

* main/asterisk:
  - Refactor the file_version structure to reflect that it no longer
    tracks a version field.
  - Remove the "core show file version" CLI command. Without the file
    version, it is no longer useful.
  - Remove the ast_file_version_find function. The file version is no
    longer tracked.
  - Rename ast_register_file_version/ast_unregister_file_version to
    ast_register_file/ast_unregister_file, respectively.

* main/manager: Remove value from the Version key of the ModuleCheck
  Action. The actual key itself has not been removed, as doing so would
  absolutely constitute a backwards incompatible change. However, since
  the file version is no longer tracked, there is no need to attempt to
  include it in the Version key.

* UPGRADE: Add notes for:
  - Modification to the ModuleCheck AMI Action
  - Removal of the "core show file version" CLI command

Change-Id: I6cf0ff280e1668bf4957dc21f32a5ff43444a40e
2015-04-13 03:48:57 -04:00

257 lines
5.8 KiB
C

/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (c) 2004 - 2005, inAccess Networks
*
* Michael Manousos <manousos@inaccessnetworks.com>
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
* any of the maintainers of this project for assistance;
* the project provides a web site, mailing lists and IRC
* channels for your use.
*
* This program is free software, distributed under the terms of
* the GNU General Public License Version 2. See the LICENSE file
* at the top of the source tree.
*/
/*!\file
*
* \brief Headerless G.726 (16/24/32/40kbps) data format for Asterisk.
*
* File name extensions:
* \arg 40 kbps: g726-40
* \arg 32 kbps: g726-32
* \arg 24 kbps: g726-24
* \arg 16 kbps: g726-16
* \ingroup formats
*/
/*** MODULEINFO
<support_level>core</support_level>
***/
#include "asterisk.h"
ASTERISK_REGISTER_FILE()
#include "asterisk/mod_format.h"
#include "asterisk/module.h"
#include "asterisk/endian.h"
#include "asterisk/format_cache.h"
#define RATE_40 0
#define RATE_32 1
#define RATE_24 2
#define RATE_16 3
/* We can only read/write chunks of FRAME_TIME ms G.726 data */
#define FRAME_TIME 10 /* 10 ms size */
#define BUF_SIZE (5*FRAME_TIME) /* max frame size in bytes ? */
/* Frame sizes in bytes */
static int frame_size[4] = {
FRAME_TIME * 5,
FRAME_TIME * 4,
FRAME_TIME * 3,
FRAME_TIME * 2
};
struct g726_desc {
int rate; /* RATE_* defines */
};
/*
* Rate dependant format functions (open, rewrite)
*/
static int g726_open(struct ast_filestream *tmp, int rate)
{
struct g726_desc *s = (struct g726_desc *)tmp->_private;
s->rate = rate;
ast_debug(1, "Created filestream G.726-%dk.\n", 40 - s->rate * 8);
return 0;
}
static int g726_40_open(struct ast_filestream *s)
{
return g726_open(s, RATE_40);
}
static int g726_32_open(struct ast_filestream *s)
{
return g726_open(s, RATE_32);
}
static int g726_24_open(struct ast_filestream *s)
{
return g726_open(s, RATE_24);
}
static int g726_16_open(struct ast_filestream *s)
{
return g726_open(s, RATE_16);
}
static int g726_40_rewrite(struct ast_filestream *s, const char *comment)
{
return g726_open(s, RATE_40);
}
static int g726_32_rewrite(struct ast_filestream *s, const char *comment)
{
return g726_open(s, RATE_32);
}
static int g726_24_rewrite(struct ast_filestream *s, const char *comment)
{
return g726_open(s, RATE_24);
}
static int g726_16_rewrite(struct ast_filestream *s, const char *comment)
{
return g726_open(s, RATE_16);
}
/*
* Rate independent format functions (read, write)
*/
static struct ast_frame *g726_read(struct ast_filestream *s, int *whennext)
{
int res;
struct g726_desc *fs = (struct g726_desc *)s->_private;
/* Send a frame from the file to the appropriate channel */
AST_FRAME_SET_BUFFER(&s->fr, s->buf, AST_FRIENDLY_OFFSET, frame_size[fs->rate]);
s->fr.samples = 8 * FRAME_TIME;
if ((res = fread(s->fr.data.ptr, 1, s->fr.datalen, s->f)) != s->fr.datalen) {
if (res)
ast_log(LOG_WARNING, "Short read (%d) (%s)!\n", res, strerror(errno));
return NULL;
}
*whennext = s->fr.samples;
return &s->fr;
}
static int g726_write(struct ast_filestream *s, struct ast_frame *f)
{
int res;
struct g726_desc *fs = (struct g726_desc *)s->_private;
if (f->datalen % frame_size[fs->rate]) {
ast_log(LOG_WARNING, "Invalid data length %d, should be multiple of %d\n",
f->datalen, frame_size[fs->rate]);
return -1;
}
if ((res = fwrite(f->data.ptr, 1, f->datalen, s->f)) != f->datalen) {
ast_log(LOG_WARNING, "Bad write (%d/%d): %s\n",
res, frame_size[fs->rate], strerror(errno));
return -1;
}
return 0;
}
static int g726_seek(struct ast_filestream *fs, off_t sample_offset, int whence)
{
return -1;
}
static int g726_trunc(struct ast_filestream *fs)
{
return -1;
}
static off_t g726_tell(struct ast_filestream *fs)
{
return -1;
}
static struct ast_format_def f[] = {
{
.name = "g726-40",
.exts = "g726-40",
.open = g726_40_open,
.rewrite = g726_40_rewrite,
.write = g726_write,
.seek = g726_seek,
.trunc = g726_trunc,
.tell = g726_tell,
.read = g726_read,
.buf_size = BUF_SIZE + AST_FRIENDLY_OFFSET,
.desc_size = sizeof(struct g726_desc),
},
{
.name = "g726-32",
.exts = "g726-32",
.open = g726_32_open,
.rewrite = g726_32_rewrite,
.write = g726_write,
.seek = g726_seek,
.trunc = g726_trunc,
.tell = g726_tell,
.read = g726_read,
.buf_size = BUF_SIZE + AST_FRIENDLY_OFFSET,
.desc_size = sizeof(struct g726_desc),
},
{
.name = "g726-24",
.exts = "g726-24",
.open = g726_24_open,
.rewrite = g726_24_rewrite,
.write = g726_write,
.seek = g726_seek,
.trunc = g726_trunc,
.tell = g726_tell,
.read = g726_read,
.buf_size = BUF_SIZE + AST_FRIENDLY_OFFSET,
.desc_size = sizeof(struct g726_desc),
},
{
.name = "g726-16",
.exts = "g726-16",
.open = g726_16_open,
.rewrite = g726_16_rewrite,
.write = g726_write,
.seek = g726_seek,
.trunc = g726_trunc,
.tell = g726_tell,
.read = g726_read,
.buf_size = BUF_SIZE + AST_FRIENDLY_OFFSET,
.desc_size = sizeof(struct g726_desc),
},
{ .desc_size = 0 } /* terminator */
};
static int load_module(void)
{
int i;
for (i = 0; f[i].desc_size ; i++) {
f[i].format = ast_format_g726;
if (ast_format_def_register(&f[i])) { /* errors are fatal */
ast_log(LOG_WARNING, "Failed to register format %s.\n", f[i].name);
return AST_MODULE_LOAD_FAILURE;
}
}
return AST_MODULE_LOAD_SUCCESS;
}
static int unload_module(void)
{
int i;
for (i = 0; f[i].desc_size ; i++) {
if (ast_format_def_unregister(f[i].name))
ast_log(LOG_WARNING, "Failed to unregister format %s.\n", f[i].name);
}
return(0);
}
AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "Raw G.726 (16/24/32/40kbps) data",
.support_level = AST_MODULE_SUPPORT_CORE,
.load = load_module,
.unload = unload_module,
.load_pri = AST_MODPRI_APP_DEPEND
);