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., 51 Franklin St, Fifth Floor,
  20  * Boston, MA 02110-1301, 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-1.0 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 #include <gst/pbutils/pbutils.h>
  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 GstFlowReturn gst_amr_parse_handle_frame (GstBaseParse * parse,
  83     GstBaseParseFrame * frame, gint * skipsize);
  84 static GstFlowReturn gst_amr_parse_pre_push_frame (GstBaseParse * parse,
  85     GstBaseParseFrame * frame);
  86
  87 G_DEFINE_TYPE (GstAmrParse, gst_amr_parse, GST_TYPE_BASE_PARSE);
  88
  89 /**
  90  * gst_amr_parse_class_init:
  91  * @klass: GstAmrParseClass.
  92  *
  93  */
  94 static void
  95 gst_amr_parse_class_init (GstAmrParseClass * klass)
  96 {
  97   GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
  98   GstBaseParseClass *parse_class = GST_BASE_PARSE_CLASS (klass);
  99
 100   GST_DEBUG_CATEGORY_INIT (amrparse_debug, "amrparse", 0,
 101       "AMR-NB audio stream parser");
 102
 103   gst_element_class_add_pad_template (element_class,
 104       gst_static_pad_template_get (&sink_template));
 105   gst_element_class_add_pad_template (element_class,
 106       gst_static_pad_template_get (&src_template));
 107
 108   gst_element_class_set_static_metadata (element_class,
 109       "AMR audio stream parser", "Codec/Parser/Audio",
 110       "Adaptive Multi-Rate audio parser",
 111       "Ronald Bultje <rbultje@ronald.bitfreak.net>");
 112
 113   parse_class->start = GST_DEBUG_FUNCPTR (gst_amr_parse_start);
 114   parse_class->stop = GST_DEBUG_FUNCPTR (gst_amr_parse_stop);
 115   parse_class->set_sink_caps = GST_DEBUG_FUNCPTR (gst_amr_parse_sink_setcaps);
 116   parse_class->get_sink_caps = GST_DEBUG_FUNCPTR (gst_amr_parse_sink_getcaps);
 117   parse_class->handle_frame = GST_DEBUG_FUNCPTR (gst_amr_parse_handle_frame);
 118   parse_class->pre_push_frame =
 119       GST_DEBUG_FUNCPTR (gst_amr_parse_pre_push_frame);
 120 }
 121
 122
 123 /**
 124  * gst_amr_parse_init:
 125  * @amrparse: #GstAmrParse
 126  * @klass: #GstAmrParseClass.
 127  *
 128  */
 129 static void
 130 gst_amr_parse_init (GstAmrParse * amrparse)
 131 {
 132   /* init rest */
 133   gst_base_parse_set_min_frame_size (GST_BASE_PARSE (amrparse), 62);
 134   GST_DEBUG ("initialized");
 135   GST_PAD_SET_ACCEPT_INTERSECT (GST_BASE_PARSE_SINK_PAD (amrparse));
 136   GST_PAD_SET_ACCEPT_TEMPLATE (GST_BASE_PARSE_SINK_PAD (amrparse));
 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 GstFlowReturn
 258 gst_amr_parse_handle_frame (GstBaseParse * parse,
 259     GstBaseParseFrame * frame, gint * skipsize)
 260 {
 261   GstBuffer *buffer;
 262   GstMapInfo map;
 263   gint fsize = 0, mode, dsize;
 264   GstAmrParse *amrparse;
 265   GstFlowReturn ret = GST_FLOW_OK;
 266   gboolean found = FALSE;
 267
 268   amrparse = GST_AMR_PARSE (parse);
 269   buffer = frame->buffer;
 270
 271   gst_buffer_map (buffer, &map, GST_MAP_READ);
 272   dsize = map.size;
 273
 274   GST_LOG ("buffer: %d bytes", dsize);
 275
 276   if (amrparse->need_header) {
 277     if (dsize >= AMR_MIME_HEADER_SIZE &&
 278         gst_amr_parse_parse_header (amrparse, map.data, skipsize)) {
 279       amrparse->need_header = FALSE;
 280       gst_base_parse_set_frame_rate (GST_BASE_PARSE (amrparse), 50, 1, 2, 2);
 281     } else {
 282       GST_WARNING ("media doesn't look like a AMR format");
 283     }
 284     /* We return FALSE, so this frame won't get pushed forward. Instead,
 285        the "skip" value is set, so next time we will receive a valid frame. */
 286     goto done;
 287   }
 288
 289   *skipsize = 1;
 290   /* Does this look like a possible frame header candidate? */
 291   if ((map.data[0] & 0x83) == 0) {
 292     /* Yep. Retrieve the frame size */
 293     mode = (map.data[0] >> 3) & 0x0F;
 294     fsize = amrparse->block_size[mode] + 1;     /* +1 for the header byte */
 295
 296     /* We recognize this data as a valid frame when:
 297      *     - We are in sync. There is no need for extra checks then
 298      *     - We are in EOS. There might not be enough data to check next frame
 299      *     - Sync is lost, but the following data after this frame seem
 300      *       to contain a valid header as well (and there is enough data to
 301      *       perform this check)
 302      */
 303     if (fsize) {
 304       *skipsize = 0;
 305       /* in sync, no further check */
 306       if (!GST_BASE_PARSE_LOST_SYNC (parse)) {
 307         found = TRUE;
 308       } else if (dsize > fsize) {
 309         /* enough data, check for next sync */
 310         if ((map.data[fsize] & 0x83) == 0)
 311           found = TRUE;
 312       } else if (GST_BASE_PARSE_DRAINING (parse)) {
 313         /* not enough, but draining, so ok */
 314         found = TRUE;
 315       }
 316     }
 317   }
 318
 319 done:
 320   gst_buffer_unmap (buffer, &map);
 321
 322   if (found && fsize <= map.size) {
 323     ret = gst_base_parse_finish_frame (parse, frame, fsize);
 324   }
 325
 326   return ret;
 327 }
 328
 329 /**
 330  * gst_amr_parse_start:
 331  * @parse: #GstBaseParse.
 332  *
 333  * Implementation of "start" vmethod in #GstBaseParse class.
 334  *
 335  * Returns: TRUE on success.
 336  */
 337 static gboolean
 338 gst_amr_parse_start (GstBaseParse * parse)
 339 {
 340   GstAmrParse *amrparse;
 341
 342   amrparse = GST_AMR_PARSE (parse);
 343   GST_DEBUG ("start");
 344   amrparse->need_header = TRUE;
 345   amrparse->header = 0;
 346   amrparse->sent_codec_tag = FALSE;
 347   return TRUE;
 348 }
 349
 350
 351 /**
 352  * gst_amr_parse_stop:
 353  * @parse: #GstBaseParse.
 354  *
 355  * Implementation of "stop" vmethod in #GstBaseParse class.
 356  *
 357  * Returns: TRUE on success.
 358  */
 359 static gboolean
 360 gst_amr_parse_stop (GstBaseParse * parse)
 361 {
 362   GstAmrParse *amrparse;
 363
 364   amrparse = GST_AMR_PARSE (parse);
 365   GST_DEBUG ("stop");
 366   amrparse->need_header = TRUE;
 367   amrparse->header = 0;
 368   return TRUE;
 369 }
 370
 371 static GstCaps *
 372 gst_amr_parse_sink_getcaps (GstBaseParse * parse, GstCaps * filter)
 373 {
 374   GstCaps *peercaps, *templ;
 375   GstCaps *res;
 376
 377
 378   templ = gst_pad_get_pad_template_caps (GST_BASE_PARSE_SINK_PAD (parse));
 379   peercaps = gst_pad_peer_query_caps (GST_BASE_PARSE_SRC_PAD (parse), filter);
 380
 381   if (peercaps) {
 382     guint i, n;
 383
 384     /* Rename structure names */
 385     peercaps = gst_caps_make_writable (peercaps);
 386     n = gst_caps_get_size (peercaps);
 387     for (i = 0; i < n; i++) {
 388       GstStructure *s = gst_caps_get_structure (peercaps, i);
 389
 390       if (gst_structure_has_name (s, "audio/AMR"))
 391         gst_structure_set_name (s, "audio/x-amr-nb-sh");
 392       else
 393         gst_structure_set_name (s, "audio/x-amr-wb-sh");
 394     }
 395
 396     res = gst_caps_intersect_full (peercaps, templ, GST_CAPS_INTERSECT_FIRST);
 397     gst_caps_unref (peercaps);
 398     res = gst_caps_make_writable (res);
 399     /* Append the template caps because we still want to accept
 400      * caps without any fields in the case upstream does not
 401      * know anything.
 402      */
 403     gst_caps_append (res, templ);
 404   } else {
 405     res = templ;
 406   }
 407
 408   if (filter) {
 409     GstCaps *intersection;
 410
 411     intersection =
 412         gst_caps_intersect_full (filter, res, GST_CAPS_INTERSECT_FIRST);
 413     gst_caps_unref (res);
 414     res = intersection;
 415   }
 416
 417   return res;
 418 }
 419
 420 static GstFlowReturn
 421 gst_amr_parse_pre_push_frame (GstBaseParse * parse, GstBaseParseFrame * frame)
 422 {
 423   GstAmrParse *amrparse = GST_AMR_PARSE (parse);
 424
 425   if (!amrparse->sent_codec_tag) {
 426     GstTagList *taglist;
 427     GstCaps *caps;
 428
 429     taglist = gst_tag_list_new_empty ();
 430
 431     /* codec tag */
 432     caps = gst_pad_get_current_caps (GST_BASE_PARSE_SRC_PAD (parse));
 433     gst_pb_utils_add_codec_description_to_tag_list (taglist,
 434         GST_TAG_AUDIO_CODEC, caps);
 435     gst_caps_unref (caps);
 436
 437     gst_base_parse_merge_tags (parse, taglist, GST_TAG_MERGE_REPLACE);
 438     gst_tag_list_unref (taglist);
 439
 440     /* also signals the end of first-frame processing */
 441     amrparse->sent_codec_tag = TRUE;
 442   }
 443
 444   return GST_FLOW_OK;
 445 }