libgsm.c 7.68 KB
Newer Older
1 2 3
/*
 * Interface to libgsm for gsm encoding/decoding
 * Copyright (c) 2005 Alban Bedel <albeu@free.fr>
4
 * Copyright (c) 2006, 2007 Michel Bardiaux <mbardiaux@mediaxim.be>
5
 *
6 7 8
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
9 10
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
11
 * version 2.1 of the License, or (at your option) any later version.
12
 *
13
 * FFmpeg is distributed in the hope that it will be useful,
14 15 16 17 18
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
19
 * License along with FFmpeg; if not, write to the Free Software
20
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21
 */
22

23
/**
24
 * @file
25 26 27
 * Interface to libgsm for gsm encoding/decoding
 */

28 29
// The idiosyncrasies of GSM-in-WAV are explained at http://kbs.cs.tu-berlin.de/~jutta/toast.html

30 31 32 33
#include "config.h"
#if HAVE_GSM_H
#include <gsm.h>
#else
34
#include <gsm/gsm.h>
35
#endif
36

37 38
#include "libavutil/channel_layout.h"
#include "libavutil/common.h"
Justin Ruggles's avatar
Justin Ruggles committed
39
#include "avcodec.h"
40
#include "internal.h"
Justin Ruggles's avatar
Justin Ruggles committed
41
#include "gsm.h"
42

43 44 45 46 47 48
static av_cold int libgsm_encode_close(AVCodecContext *avctx) {
    gsm_destroy(avctx->priv_data);
    avctx->priv_data = NULL;
    return 0;
}

49
static av_cold int libgsm_encode_init(AVCodecContext *avctx) {
50 51 52
    if (avctx->channels > 1) {
        av_log(avctx, AV_LOG_ERROR, "Mono required for GSM, got %d channels\n",
               avctx->channels);
53
        return -1;
54
    }
Michael Niedermayer's avatar
Michael Niedermayer committed
55

56 57 58 59 60 61 62 63 64 65 66 67 68
    if (avctx->sample_rate != 8000) {
        av_log(avctx, AV_LOG_ERROR, "Sample rate 8000Hz required for GSM, got %dHz\n",
               avctx->sample_rate);
        if (avctx->strict_std_compliance > FF_COMPLIANCE_UNOFFICIAL)
            return -1;
    }
    if (avctx->bit_rate != 13000 /* Official */ &&
        avctx->bit_rate != 13200 /* Very common */ &&
        avctx->bit_rate != 0 /* Unknown; a.o. mov does not set bitrate when decoding */ ) {
        av_log(avctx, AV_LOG_ERROR, "Bitrate 13000bps required for GSM, got %dbps\n",
               avctx->bit_rate);
        if (avctx->strict_std_compliance > FF_COMPLIANCE_UNOFFICIAL)
            return -1;
Michael Niedermayer's avatar
Michael Niedermayer committed
69
    }
70 71

    avctx->priv_data = gsm_create();
72 73
    if (!avctx->priv_data)
        goto error;
74

75
    switch(avctx->codec_id) {
76
    case AV_CODEC_ID_GSM:
77 78 79
        avctx->frame_size = GSM_FRAME_SIZE;
        avctx->block_align = GSM_BLOCK_SIZE;
        break;
80
    case AV_CODEC_ID_GSM_MS: {
81 82 83 84 85 86 87
        int one = 1;
        gsm_option(avctx->priv_data, GSM_OPT_WAV49, &one);
        avctx->frame_size = 2*GSM_FRAME_SIZE;
        avctx->block_align = GSM_MS_BLOCK_SIZE;
        }
    }

88
    return 0;
89
error:
90
    libgsm_encode_close(avctx);
91
    return -1;
92 93
}

94 95 96 97 98 99 100
static int libgsm_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
                               const AVFrame *frame, int *got_packet_ptr)
{
    int ret;
    gsm_signal *samples = (gsm_signal *)frame->data[0];
    struct gsm_state *state = avctx->priv_data;

101
    if ((ret = ff_alloc_packet2(avctx, avpkt, avctx->block_align)) < 0)
102
        return ret;
103 104

    switch(avctx->codec_id) {
105
    case AV_CODEC_ID_GSM:
106
        gsm_encode(state, samples, avpkt->data);
107
        break;
108
    case AV_CODEC_ID_GSM_MS:
109 110
        gsm_encode(state, samples,                  avpkt->data);
        gsm_encode(state, samples + GSM_FRAME_SIZE, avpkt->data + 32);
111
    }
112 113 114

    *got_packet_ptr = 1;
    return 0;
115 116 117
}


118
#if CONFIG_LIBGSM_ENCODER
119
AVCodec ff_libgsm_encoder = {
120 121
    .name           = "libgsm",
    .type           = AVMEDIA_TYPE_AUDIO,
122
    .id             = AV_CODEC_ID_GSM,
123
    .init           = libgsm_encode_init,
124
    .encode2        = libgsm_encode_frame,
125
    .close          = libgsm_encode_close,
126 127 128
    .sample_fmts    = (const enum AVSampleFormat[]){ AV_SAMPLE_FMT_S16,
                                                     AV_SAMPLE_FMT_NONE },
    .long_name      = NULL_IF_CONFIG_SMALL("libgsm GSM"),
129
};
130 131
#endif
#if CONFIG_LIBGSM_MS_ENCODER
132
AVCodec ff_libgsm_ms_encoder = {
133 134
    .name           = "libgsm_ms",
    .type           = AVMEDIA_TYPE_AUDIO,
135
    .id             = AV_CODEC_ID_GSM_MS,
136
    .init           = libgsm_encode_init,
137
    .encode2        = libgsm_encode_frame,
138
    .close          = libgsm_encode_close,
139 140 141
    .sample_fmts    = (const enum AVSampleFormat[]){ AV_SAMPLE_FMT_S16,
                                                     AV_SAMPLE_FMT_NONE },
    .long_name      = NULL_IF_CONFIG_SMALL("libgsm GSM Microsoft variant"),
142
};
143
#endif
144

145 146 147 148
typedef struct LibGSMDecodeContext {
    struct gsm_state *state;
} LibGSMDecodeContext;

149
static av_cold int libgsm_decode_init(AVCodecContext *avctx) {
150 151
    LibGSMDecodeContext *s = avctx->priv_data;

152 153
    avctx->channels       = 1;
    avctx->channel_layout = AV_CH_LAYOUT_MONO;
154 155
    if (!avctx->sample_rate)
        avctx->sample_rate = 8000;
156
    avctx->sample_fmt     = AV_SAMPLE_FMT_S16;
157

158
    s->state = gsm_create();
159 160

    switch(avctx->codec_id) {
161
    case AV_CODEC_ID_GSM:
162 163 164
        avctx->frame_size  = GSM_FRAME_SIZE;
        avctx->block_align = GSM_BLOCK_SIZE;
        break;
165
    case AV_CODEC_ID_GSM_MS: {
166
        int one = 1;
167
        gsm_option(s->state, GSM_OPT_WAV49, &one);
168 169 170 171 172 173 174 175 176
        avctx->frame_size  = 2 * GSM_FRAME_SIZE;
        avctx->block_align = GSM_MS_BLOCK_SIZE;
        }
    }

    return 0;
}

static av_cold int libgsm_decode_close(AVCodecContext *avctx) {
177 178 179 180
    LibGSMDecodeContext *s = avctx->priv_data;

    gsm_destroy(s->state);
    s->state = NULL;
181 182 183
    return 0;
}

184 185 186
static int libgsm_decode_frame(AVCodecContext *avctx, void *data,
                               int *got_frame_ptr, AVPacket *avpkt)
{
187
    int i, ret;
188
    LibGSMDecodeContext *s = avctx->priv_data;
189
    AVFrame *frame         = data;
190
    uint8_t *buf = avpkt->data;
191
    int buf_size = avpkt->size;
192
    int16_t *samples;
193

194 195 196
    if (buf_size < avctx->block_align) {
        av_log(avctx, AV_LOG_ERROR, "Packet is too small\n");
        return AVERROR_INVALIDDATA;
197
    }
198

199
    /* get output buffer */
200
    frame->nb_samples = avctx->frame_size;
201
    if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
202
        return ret;
203
    samples = (int16_t *)frame->data[0];
204

205
    for (i = 0; i < avctx->frame_size / GSM_FRAME_SIZE; i++) {
206
        if ((ret = gsm_decode(s->state, buf, samples)) < 0)
207 208 209
            return -1;
        buf     += GSM_BLOCK_SIZE;
        samples += GSM_FRAME_SIZE;
210
    }
211

212
    *got_frame_ptr = 1;
213

214
    return avctx->block_align;
215 216
}

217
static void libgsm_flush(AVCodecContext *avctx) {
218
    LibGSMDecodeContext *s = avctx->priv_data;
219
    int one = 1;
220 221 222

    gsm_destroy(s->state);
    s->state = gsm_create();
223
    if (avctx->codec_id == AV_CODEC_ID_GSM_MS)
224
        gsm_option(s->state, GSM_OPT_WAV49, &one);
225 226
}

227
#if CONFIG_LIBGSM_DECODER
228
AVCodec ff_libgsm_decoder = {
229 230
    .name           = "libgsm",
    .type           = AVMEDIA_TYPE_AUDIO,
231
    .id             = AV_CODEC_ID_GSM,
232
    .priv_data_size = sizeof(LibGSMDecodeContext),
233 234
    .init           = libgsm_decode_init,
    .close          = libgsm_decode_close,
235
    .decode         = libgsm_decode_frame,
236
    .flush          = libgsm_flush,
237
    .capabilities   = CODEC_CAP_DR1,
238
    .long_name      = NULL_IF_CONFIG_SMALL("libgsm GSM"),
239
};
240 241
#endif
#if CONFIG_LIBGSM_MS_DECODER
242
AVCodec ff_libgsm_ms_decoder = {
243 244
    .name           = "libgsm_ms",
    .type           = AVMEDIA_TYPE_AUDIO,
245
    .id             = AV_CODEC_ID_GSM_MS,
246
    .priv_data_size = sizeof(LibGSMDecodeContext),
247 248
    .init           = libgsm_decode_init,
    .close          = libgsm_decode_close,
249
    .decode         = libgsm_decode_frame,
250
    .flush          = libgsm_flush,
251
    .capabilities   = CODEC_CAP_DR1,
252
    .long_name      = NULL_IF_CONFIG_SMALL("libgsm GSM Microsoft variant"),
253
};
254
#endif