libavcodec/libgsm.c
bb4c2140
 /*
  * Interface to libgsm for gsm encoding/decoding
  * Copyright (c) 2005 Alban Bedel <albeu@free.fr>
346a655d
  * Copyright (c) 2006, 2007 Michel Bardiaux <mbardiaux@mediaxim.be>
bb4c2140
  *
b78e7197
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
bb4c2140
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
b78e7197
  * version 2.1 of the License, or (at your option) any later version.
bb4c2140
  *
b78e7197
  * FFmpeg is distributed in the hope that it will be useful,
bb4c2140
  * 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
b78e7197
  * License along with FFmpeg; if not, write to the Free Software
5509bffa
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
bb4c2140
  */
115329f1
 
bb4c2140
 /**
ba87f080
  * @file
bb4c2140
  * Interface to libgsm for gsm encoding/decoding
  */
 
346a655d
 // The idiosyncrasies of GSM-in-WAV are explained at http://kbs.cs.tu-berlin.de/~jutta/toast.html
 
3beb81e7
 #include <gsm/gsm.h>
bb4c2140
 
82390f57
 #include "avcodec.h"
 #include "gsm.h"
bb4c2140
 
8febd6af
 static av_cold int libgsm_encode_init(AVCodecContext *avctx) {
96ddaff5
     if (avctx->channels > 1) {
         av_log(avctx, AV_LOG_ERROR, "Mono required for GSM, got %d channels\n",
                avctx->channels);
bb4c2140
         return -1;
96ddaff5
     }
ef79ef3c
 
88f908fb
     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;
ef79ef3c
     }
bb4c2140
 
     avctx->priv_data = gsm_create();
115329f1
 
346a655d
     switch(avctx->codec_id) {
     case CODEC_ID_GSM:
         avctx->frame_size = GSM_FRAME_SIZE;
         avctx->block_align = GSM_BLOCK_SIZE;
         break;
     case CODEC_ID_GSM_MS: {
         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;
         }
     }
 
bb4c2140
     avctx->coded_frame= avcodec_alloc_frame();
     avctx->coded_frame->key_frame= 1;
115329f1
 
bb4c2140
     return 0;
 }
 
8febd6af
 static av_cold int libgsm_encode_close(AVCodecContext *avctx) {
916ff022
     av_freep(&avctx->coded_frame);
bb4c2140
     gsm_destroy(avctx->priv_data);
     avctx->priv_data = NULL;
     return 0;
 }
 
 static int libgsm_encode_frame(AVCodecContext *avctx,
                                unsigned char *frame, int buf_size, void *data) {
     // we need a full block
346a655d
     if(buf_size < avctx->block_align) return 0;
 
     switch(avctx->codec_id) {
     case CODEC_ID_GSM:
         gsm_encode(avctx->priv_data,data,frame);
         break;
     case CODEC_ID_GSM_MS:
         gsm_encode(avctx->priv_data,data,frame);
         gsm_encode(avctx->priv_data,((short*)data)+GSM_FRAME_SIZE,frame+32);
     }
     return avctx->block_align;
bb4c2140
 }
 
 
e7e2df27
 AVCodec ff_libgsm_encoder = {
ec6402b7
     .name           = "libgsm",
     .type           = AVMEDIA_TYPE_AUDIO,
     .id             = CODEC_ID_GSM,
8febd6af
     .init           = libgsm_encode_init,
ec6402b7
     .encode         = libgsm_encode_frame,
8febd6af
     .close          = libgsm_encode_close,
5d6e4c16
     .sample_fmts = (const enum AVSampleFormat[]){AV_SAMPLE_FMT_S16,AV_SAMPLE_FMT_NONE},
fe4bf374
     .long_name = NULL_IF_CONFIG_SMALL("libgsm GSM"),
bb4c2140
 };
 
e7e2df27
 AVCodec ff_libgsm_ms_encoder = {
ec6402b7
     .name           = "libgsm_ms",
     .type           = AVMEDIA_TYPE_AUDIO,
     .id             = CODEC_ID_GSM_MS,
8febd6af
     .init           = libgsm_encode_init,
ec6402b7
     .encode         = libgsm_encode_frame,
8febd6af
     .close          = libgsm_encode_close,
5d6e4c16
     .sample_fmts = (const enum AVSampleFormat[]){AV_SAMPLE_FMT_S16,AV_SAMPLE_FMT_NONE},
fe4bf374
     .long_name = NULL_IF_CONFIG_SMALL("libgsm GSM Microsoft variant"),
346a655d
 };
 
0eea2129
 typedef struct LibGSMDecodeContext {
     AVFrame frame;
     struct gsm_state *state;
 } LibGSMDecodeContext;
 
8febd6af
 static av_cold int libgsm_decode_init(AVCodecContext *avctx) {
0eea2129
     LibGSMDecodeContext *s = avctx->priv_data;
 
8febd6af
     if (avctx->channels > 1) {
         av_log(avctx, AV_LOG_ERROR, "Mono required for GSM, got %d channels\n",
                avctx->channels);
         return -1;
     }
 
     if (!avctx->channels)
         avctx->channels = 1;
 
     if (!avctx->sample_rate)
         avctx->sample_rate = 8000;
 
     avctx->sample_fmt = AV_SAMPLE_FMT_S16;
 
0eea2129
     s->state = gsm_create();
8febd6af
 
     switch(avctx->codec_id) {
     case CODEC_ID_GSM:
         avctx->frame_size  = GSM_FRAME_SIZE;
         avctx->block_align = GSM_BLOCK_SIZE;
         break;
     case CODEC_ID_GSM_MS: {
         int one = 1;
8637af8d
         gsm_option(s->state, GSM_OPT_WAV49, &one);
8febd6af
         avctx->frame_size  = 2 * GSM_FRAME_SIZE;
         avctx->block_align = GSM_MS_BLOCK_SIZE;
         }
     }
 
0eea2129
     avcodec_get_frame_defaults(&s->frame);
     avctx->coded_frame = &s->frame;
 
8febd6af
     return 0;
 }
 
 static av_cold int libgsm_decode_close(AVCodecContext *avctx) {
0eea2129
     LibGSMDecodeContext *s = avctx->priv_data;
 
     gsm_destroy(s->state);
     s->state = NULL;
8febd6af
     return 0;
 }
 
0eea2129
 static int libgsm_decode_frame(AVCodecContext *avctx, void *data,
                                int *got_frame_ptr, AVPacket *avpkt)
 {
480324e7
     int i, ret;
0eea2129
     LibGSMDecodeContext *s = avctx->priv_data;
357d0d8f
     uint8_t *buf = avpkt->data;
7a00bbad
     int buf_size = avpkt->size;
0eea2129
     int16_t *samples;
b03761b1
 
9d52f0a7
     if (buf_size < avctx->block_align) {
         av_log(avctx, AV_LOG_ERROR, "Packet is too small\n");
         return AVERROR_INVALIDDATA;
346a655d
     }
9d52f0a7
 
0eea2129
     /* get output buffer */
     s->frame.nb_samples = avctx->frame_size;
     if ((ret = avctx->get_buffer(avctx, &s->frame)) < 0) {
         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
         return ret;
     }
     samples = (int16_t *)s->frame.data[0];
 
480324e7
     for (i = 0; i < avctx->frame_size / GSM_FRAME_SIZE; i++) {
0eea2129
         if ((ret = gsm_decode(s->state, buf, samples)) < 0)
480324e7
             return -1;
         buf     += GSM_BLOCK_SIZE;
         samples += GSM_FRAME_SIZE;
346a655d
     }
b03761b1
 
0eea2129
     *got_frame_ptr   = 1;
     *(AVFrame *)data = s->frame;
 
346a655d
     return avctx->block_align;
bb4c2140
 }
 
20e081dd
 static void libgsm_flush(AVCodecContext *avctx) {
0eea2129
     LibGSMDecodeContext *s = avctx->priv_data;
1b35af32
     int one = 1;
0eea2129
 
     gsm_destroy(s->state);
     s->state = gsm_create();
1b35af32
     if (avctx->codec_id == CODEC_ID_GSM_MS)
         gsm_option(s->state, GSM_OPT_WAV49, &one);
20e081dd
 }
 
e7e2df27
 AVCodec ff_libgsm_decoder = {
ec6402b7
     .name           = "libgsm",
     .type           = AVMEDIA_TYPE_AUDIO,
     .id             = CODEC_ID_GSM,
0eea2129
     .priv_data_size = sizeof(LibGSMDecodeContext),
8febd6af
     .init           = libgsm_decode_init,
     .close          = libgsm_decode_close,
ec6402b7
     .decode         = libgsm_decode_frame,
20e081dd
     .flush          = libgsm_flush,
0eea2129
     .capabilities   = CODEC_CAP_DR1,
fe4bf374
     .long_name = NULL_IF_CONFIG_SMALL("libgsm GSM"),
bb4c2140
 };
346a655d
 
e7e2df27
 AVCodec ff_libgsm_ms_decoder = {
ec6402b7
     .name           = "libgsm_ms",
     .type           = AVMEDIA_TYPE_AUDIO,
     .id             = CODEC_ID_GSM_MS,
0eea2129
     .priv_data_size = sizeof(LibGSMDecodeContext),
8febd6af
     .init           = libgsm_decode_init,
     .close          = libgsm_decode_close,
ec6402b7
     .decode         = libgsm_decode_frame,
20e081dd
     .flush          = libgsm_flush,
0eea2129
     .capabilities   = CODEC_CAP_DR1,
fe4bf374
     .long_name = NULL_IF_CONFIG_SMALL("libgsm GSM Microsoft variant"),
346a655d
 };