gst/audioparsers/gstamrparse.c

   1 /* GStreamer Adaptive Multi-Rate parser plugin
   2  * Copyright (C) 2006 Edgard Lima <edgard.lima@indt.org.br>
   3  * Copyright (C) 2008 Nokia Corporation. All rights reserved.
   4  *
   5  * Contact: Stefan Kost <stefan.kost@nokia.com>
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 /**
  24  * SECTION:element-amrparse
  25  * @short_description: AMR parser
  26  * @see_also: #GstAmrnbDec, #GstAmrnbEnc
  27  *
  28  * This is an AMR parser capable of handling both narrow-band and wideband
  29  * formats.
  30  *
  31  * <refsect2>
  32  * <title>Example launch line</title>
  33  * |[
  34  * gst-launch filesrc location=abc.amr ! amrparse ! amrdec ! audioresample ! audioconvert ! alsasink
  35  * ]|
  36  * </refsect2>
  37  */
  38
  39 #ifdef HAVE_CONFIG_H
  40 #include "config.h"
  41 #endif
  42
  43 #include <string.h>
  44
  45 #include "gstamrparse.h"
  46
  47
  48 static GstStaticPadTemplate src_template = GST_STATIC_PAD_TEMPLATE ("src",
  49     GST_PAD_SRC,
  50     GST_PAD_ALWAYS,
  51     GST_STATIC_CAPS ("audio/AMR, " "rate = (int) 8000, " "channels = (int) 1;"
  52         "audio/AMR-WB, " "rate = (int) 16000, " "channels = (int) 1;")
  53     );
  54
  55 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
  56     GST_PAD_SINK,
  57     GST_PAD_ALWAYS,
  58     GST_STATIC_CAPS ("audio/x-amr-nb-sh; audio/x-amr-wb-sh"));
  59
  60 GST_DEBUG_CATEGORY_STATIC (amrparse_debug);
  61 #define GST_CAT_DEFAULT amrparse_debug
  62
  63 static const gint block_size_nb[16] =
  64     { 12, 13, 15, 17, 19, 20, 26, 31, 5, 0, 0, 0, 0, 0, 0, 0 };
  65
  66 static const gint block_size_wb[16] =
  67     { 17, 23, 32, 36, 40, 46, 50, 58, 60, 5, -1, -1, -1, -1, 0, 0 };
  68
  69 /* AMR has a "hardcoded" framerate of 50fps */
  70 #define AMR_FRAMES_PER_SECOND 50
  71 #define AMR_FRAME_DURATION (GST_SECOND/AMR_FRAMES_PER_SECOND)
  72 #define AMR_MIME_HEADER_SIZE 9
  73
  74 static gboolean gst_amr_parse_start (GstBaseParse * parse);
  75 static gboolean gst_amr_parse_stop (GstBaseParse * parse);
  76
  77 static gboolean gst_amr_parse_sink_setcaps (GstBaseParse * parse,
  78     GstCaps * caps);
  79 static GstCaps *gst_amr_parse_sink_getcaps (GstBaseParse * parse,
  80     GstCaps * filter);
  81
  82 static gboolean gst_amr_parse_check_valid_frame (GstBaseParse * parse,
  83     GstBaseParseFrame * frame, guint * framesize, gint * skipsize);
  84
  85 static GstFlowReturn gst_amr_parse_parse_frame (GstBaseParse * parse,
  86     GstBaseParseFrame * frame);
  87
  88 G_DEFINE_TYPE (GstAmrParse, gst_amr_parse, GST_TYPE_BASE_PARSE);
  89
  90 /**
  91  * gst_amr_parse_class_init:
  92  * @klass: GstAmrParseClass.
  93  *
  94  */
  95 static void
  96 gst_amr_parse_class_init (GstAmrParseClass * klass)
  97 {
  98   GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
  99   GstBaseParseClass *parse_class = GST_BASE_PARSE_CLASS (klass);
 100
 101   GST_DEBUG_CATEGORY_INIT (amrparse_debug, "amrparse", 0,
 102       "AMR-NB audio stream parser");
 103
 104   gst_element_class_add_pad_template (element_class,
 105       gst_static_pad_template_get (&sink_template));
 106   gst_element_class_add_pad_template (element_class,
 107       gst_static_pad_template_get (&src_template));
 108
 109   gst_element_class_set_details_simple (element_class,
 110       "AMR audio stream parser", "Codec/Parser/Audio",
 111       "Adaptive Multi-Rate audio parser",
 112       "Ronald Bultje <rbultje@ronald.bitfreak.net>");
 113
 114   parse_class->start = GST_DEBUG_FUNCPTR (gst_amr_parse_start);
 115   parse_class->stop = GST_DEBUG_FUNCPTR (gst_amr_parse_stop);
 116   parse_class->set_sink_caps = GST_DEBUG_FUNCPTR (gst_amr_parse_sink_setcaps);
 117   parse_class->get_sink_caps = GST_DEBUG_FUNCPTR (gst_amr_parse_sink_getcaps);
 118   parse_class->parse_frame = GST_DEBUG_FUNCPTR (gst_amr_parse_parse_frame);
 119   parse_class->check_valid_frame =
 120       GST_DEBUG_FUNCPTR (gst_amr_parse_check_valid_frame);
 121 }
 122
 123
 124 /**
 125  * gst_amr_parse_init:
 126  * @amrparse: #GstAmrParse
 127  * @klass: #GstAmrParseClass.
 128  *
 129  */
 130 static void
 131 gst_amr_parse_init (GstAmrParse * amrparse)
 132 {
 133   /* init rest */
 134   gst_base_parse_set_min_frame_size (GST_BASE_PARSE (amrparse), 62);
 135   GST_DEBUG ("initialized");
 136
 137 }
 138
 139
 140 /**
 141  * gst_amr_parse_set_src_caps:
 142  * @amrparse: #GstAmrParse.
 143  *
 144  * Set source pad caps according to current knowledge about the
 145  * audio stream.
 146  *
 147  * Returns: TRUE if caps were successfully set.
 148  */
 149 static gboolean
 150 gst_amr_parse_set_src_caps (GstAmrParse * amrparse)
 151 {
 152   GstCaps *src_caps = NULL;
 153   gboolean res = FALSE;
 154
 155   if (amrparse->wide) {
 156     GST_DEBUG_OBJECT (amrparse, "setting srcpad caps to AMR-WB");
 157     src_caps = gst_caps_new_simple ("audio/AMR-WB",
 158         "channels", G_TYPE_INT, 1, "rate", G_TYPE_INT, 16000, NULL);
 159   } else {
 160     GST_DEBUG_OBJECT (amrparse, "setting srcpad caps to AMR-NB");
 161     /* Max. size of NB frame is 31 bytes, so we can set the min. frame
 162        size to 32 (+1 for next frame header) */
 163     gst_base_parse_set_min_frame_size (GST_BASE_PARSE (amrparse), 32);
 164     src_caps = gst_caps_new_simple ("audio/AMR",
 165         "channels", G_TYPE_INT, 1, "rate", G_TYPE_INT, 8000, NULL);
 166   }
 167   gst_pad_use_fixed_caps (GST_BASE_PARSE (amrparse)->srcpad);
 168   res = gst_pad_set_caps (GST_BASE_PARSE (amrparse)->srcpad, src_caps);
 169   gst_caps_unref (src_caps);
 170   return res;
 171 }
 172
 173
 174 /**
 175  * gst_amr_parse_sink_setcaps:
 176  * @sinkpad: GstPad
 177  * @caps: GstCaps
 178  *
 179  * Returns: TRUE on success.
 180  */
 181 static gboolean
 182 gst_amr_parse_sink_setcaps (GstBaseParse * parse, GstCaps * caps)
 183 {
 184   GstAmrParse *amrparse;
 185   GstStructure *structure;
 186   const gchar *name;
 187
 188   amrparse = GST_AMR_PARSE (parse);
 189   structure = gst_caps_get_structure (caps, 0);
 190   name = gst_structure_get_name (structure);
 191
 192   GST_DEBUG_OBJECT (amrparse, "setcaps: %s", name);
 193
 194   if (!strncmp (name, "audio/x-amr-wb-sh", 17)) {
 195     amrparse->block_size = block_size_wb;
 196     amrparse->wide = 1;
 197   } else if (!strncmp (name, "audio/x-amr-nb-sh", 17)) {
 198     amrparse->block_size = block_size_nb;
 199     amrparse->wide = 0;
 200   } else {
 201     GST_WARNING ("Unknown caps");
 202     return FALSE;
 203   }
 204
 205   amrparse->need_header = FALSE;
 206   gst_base_parse_set_frame_rate (GST_BASE_PARSE (amrparse), 50, 1, 2, 2);
 207   gst_amr_parse_set_src_caps (amrparse);
 208   return TRUE;
 209 }
 210
 211 /**
 212  * gst_amr_parse_parse_header:
 213  * @amrparse: #GstAmrParse
 214  * @data: Header data to be parsed.
 215  * @skipsize: Output argument where the frame size will be stored.
 216  *
 217  * Check if the given data contains an AMR mime header.
 218  *
 219  * Returns: TRUE on success.
 220  */
 221 static gboolean
 222 gst_amr_parse_parse_header (GstAmrParse * amrparse,
 223     const guint8 * data, gint * skipsize)
 224 {
 225   GST_DEBUG_OBJECT (amrparse, "Parsing header data");
 226
 227   if (!memcmp (data, "#!AMR-WB\n", 9)) {
 228     GST_DEBUG_OBJECT (amrparse, "AMR-WB detected");
 229     amrparse->block_size = block_size_wb;
 230     amrparse->wide = TRUE;
 231     *skipsize = amrparse->header = 9;
 232   } else if (!memcmp (data, "#!AMR\n", 6)) {
 233     GST_DEBUG_OBJECT (amrparse, "AMR-NB detected");
 234     amrparse->block_size = block_size_nb;
 235     amrparse->wide = FALSE;
 236     *skipsize = amrparse->header = 6;
 237   } else
 238     return FALSE;
 239
 240   gst_amr_parse_set_src_caps (amrparse);
 241   return TRUE;
 242 }
 243
 244
 245 /**
 246  * gst_amr_parse_check_valid_frame:
 247  * @parse: #GstBaseParse.
 248  * @buffer: #GstBuffer.
 249  * @framesize: Output variable where the found frame size is put.
 250  * @skipsize: Output variable which tells how much data needs to be skipped
 251  *            until a frame header is found.
 252  *
 253  * Implementation of "check_valid_frame" vmethod in #GstBaseParse class.
 254  *
 255  * Returns: TRUE if the given data contains valid frame.
 256  */
 257 static gboolean
 258 gst_amr_parse_check_valid_frame (GstBaseParse * parse,
 259     GstBaseParseFrame * frame, guint * framesize, gint * skipsize)
 260 {
 261   GstBuffer *buffer;
 262   GstMapInfo map;
 263   gint fsize, mode, dsize;
 264   GstAmrParse *amrparse;
 265   gboolean ret = FALSE;
 266
 267   amrparse = GST_AMR_PARSE (parse);
 268   buffer = frame->buffer;
 269
 270   gst_buffer_map (buffer, &map, GST_MAP_READ);
 271   dsize = map.size;
 272
 273   GST_LOG ("buffer: %d bytes", dsize);
 274
 275   if (amrparse->need_header) {
 276     if (dsize >= AMR_MIME_HEADER_SIZE &&
 277         gst_amr_parse_parse_header (amrparse, map.data, skipsize)) {
 278       amrparse->need_header = FALSE;
 279       gst_base_parse_set_frame_rate (GST_BASE_PARSE (amrparse), 50, 1, 2, 2);
 280     } else {
 281       GST_WARNING ("media doesn't look like a AMR format");
 282     }
 283     /* We return FALSE, so this frame won't get pushed forward. Instead,
 284        the "skip" value is set, so next time we will receive a valid frame. */
 285     goto done;
 286   }
 287
 288   /* Does this look like a possible frame header candidate? */
 289   if ((map.data[0] & 0x83) == 0) {
 290     /* Yep. Retrieve the frame size */
 291     mode = (map.data[0] >> 3) & 0x0F;
 292     fsize = amrparse->block_size[mode] + 1;     /* +1 for the header byte */
 293
 294     /* We recognize this data as a valid frame when:
 295      *     - We are in sync. There is no need for extra checks then
 296      *     - We are in EOS. There might not be enough data to check next frame
 297      *     - Sync is lost, but the following data after this frame seem
 298      *       to contain a valid header as well (and there is enough data to
 299      *       perform this check)
 300      */
 301     if (fsize) {
 302       gboolean found = FALSE;
 303
 304       /* in sync, no further check */
 305       if (!GST_BASE_PARSE_LOST_SYNC (parse)) {
 306         found = TRUE;
 307       } else if (dsize > fsize) {
 308         /* enough data, check for next sync */
 309         if ((map.data[fsize] & 0x83) == 0)
 310           found = TRUE;
 311       } else if (GST_BASE_PARSE_DRAINING (parse)) {
 312         /* not enough, but draining, so ok */
 313         found = TRUE;
 314       } else {
 315         /* indicate we need not skip, but need more data */
 316         *skipsize = 0;
 317         *framesize = fsize + 1;
 318       }
 319       if (found) {
 320         *framesize = fsize;
 321         return TRUE;
 322       }
 323     }
 324   }
 325   GST_LOG ("sync lost");
 326
 327 done:
 328   gst_buffer_unmap (buffer, &map);
 329
 330   return ret;
 331 }
 332
 333
 334 /**
 335  * gst_amr_parse_parse_frame:
 336  * @parse: #GstBaseParse.
 337  * @buffer: #GstBuffer.
 338  *
 339  * Implementation of "parse" vmethod in #GstBaseParse class.
 340  *
 341  * Returns: #GstFlowReturn defining the parsing status.
 342  */
 343 static GstFlowReturn
 344 gst_amr_parse_parse_frame (GstBaseParse * parse, GstBaseParseFrame * frame)
 345 {
 346   return GST_FLOW_OK;
 347 }
 348
 349
 350 /**
 351  * gst_amr_parse_start:
 352  * @parse: #GstBaseParse.
 353  *
 354  * Implementation of "start" vmethod in #GstBaseParse class.
 355  *
 356  * Returns: TRUE on success.
 357  */
 358 static gboolean
 359 gst_amr_parse_start (GstBaseParse * parse)
 360 {
 361   GstAmrParse *amrparse;
 362
 363   amrparse = GST_AMR_PARSE (parse);
 364   GST_DEBUG ("start");
 365   amrparse->need_header = TRUE;
 366   amrparse->header = 0;
 367   return TRUE;
 368 }
 369
 370
 371 /**
 372  * gst_amr_parse_stop:
 373  * @parse: #GstBaseParse.
 374  *
 375  * Implementation of "stop" vmethod in #GstBaseParse class.
 376  *
 377  * Returns: TRUE on success.
 378  */
 379 static gboolean
 380 gst_amr_parse_stop (GstBaseParse * parse)
 381 {
 382   GstAmrParse *amrparse;
 383
 384   amrparse = GST_AMR_PARSE (parse);
 385   GST_DEBUG ("stop");
 386   amrparse->need_header = TRUE;
 387   amrparse->header = 0;
 388   return TRUE;
 389 }
 390
 391 static GstCaps *
 392 gst_amr_parse_sink_getcaps (GstBaseParse * parse, GstCaps * filter)
 393 {
 394   GstCaps *peercaps;
 395   GstCaps *res;
 396
 397   /* FIXME: handle filter caps */
 398
 399   peercaps = gst_pad_get_allowed_caps (GST_BASE_PARSE_SRC_PAD (parse));
 400   if (peercaps) {
 401     guint i, n;
 402
 403     /* Rename structure names */
 404     peercaps = gst_caps_make_writable (peercaps);
 405     n = gst_caps_get_size (peercaps);
 406     for (i = 0; i < n; i++) {
 407       GstStructure *s = gst_caps_get_structure (peercaps, i);
 408
 409       if (gst_structure_has_name (s, "audio/AMR"))
 410         gst_structure_set_name (s, "audio/x-amr-nb-sh");
 411       else
 412         gst_structure_set_name (s, "audio/x-amr-wb-sh");
 413     }
 414
 415     res =
 416         gst_caps_intersect_full (peercaps,
 417         gst_pad_get_pad_template_caps (GST_BASE_PARSE_SRC_PAD (parse)),
 418         GST_CAPS_INTERSECT_FIRST);
 419     gst_caps_unref (peercaps);
 420   } else {
 421     res =
 422         gst_caps_copy (gst_pad_get_pad_template_caps (GST_BASE_PARSE_SINK_PAD
 423             (parse)));
 424   }
 425
 426   return res;
 427 }