ext/lame/gstlamemp3enc.c

   1 /* GStreamer
   2  * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
   3  * Copyright (C) <2004> Wim Taymans <wim@fluendo.com>
   4  * Copyright (C) <2005> Thomas Vander Stichele <thomas at apestaart dot org>
   5  * Copyright (C) <2009> Sebastian Dröge <sebastian.droege@collabora.co.uk>
   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-lamemp3enc
  25  * @see_also: lame, mad, vorbisenc
  26  *
  27  * This element encodes raw integer audio into an MPEG-1 layer 3 (MP3) stream.
  28  * Note that <ulink url="http://en.wikipedia.org/wiki/MP3">MP3</ulink> is not
  29  * a free format, there are licensing and patent issues to take into
  30  * consideration. See <ulink url="http://www.vorbis.com/">Ogg/Vorbis</ulink>
  31  * for a royalty free (and often higher quality) alternative.
  32  *
  33  * <refsect2>
  34  * <title>Output sample rate</title>
  35  * If no fixed output sample rate is negotiated on the element's src pad,
  36  * the element will choose an optimal sample rate to resample to internally.
  37  * For example, a 16-bit 44.1 KHz mono audio stream encoded at 48 kbit will
  38  * get resampled to 32 KHz.  Use filter caps on the src pad to force a
  39  * particular sample rate.
  40  * </refsect2>
  41  * <refsect2>
  42  * <title>Example pipelines</title>
  43  * |[
  44  * gst-launch -v audiotestsrc wave=sine num-buffers=100 ! audioconvert ! lamemp3enc ! filesink location=sine.mp3
  45  * ]| Encode a test sine signal to MP3.
  46  * |[
  47  * gst-launch -v alsasrc ! audioconvert ! lamemp3enc target=bitrate bitrate=192 ! filesink location=alsasrc.mp3
  48  * ]| Record from a sound card using ALSA and encode to MP3 with an average bitrate of 192kbps
  49  * |[
  50  * gst-launch -v filesrc location=music.wav ! decodebin ! audioconvert ! audioresample ! lamemp3enc target=quality quality=0 ! id3v2mux ! filesink location=music.mp3
  51  * ]| Transcode from a .wav file to MP3 (the id3v2mux element is optional) with best VBR quality
  52  * |[
  53  * gst-launch -v cdda://5 ! audioconvert ! lamemp3enc target=bitrate cbr=true bitrate=192 ! filesink location=track5.mp3
  54  * ]| Encode Audio CD track 5 to MP3 with a constant bitrate of 192kbps
  55  * |[
  56  * gst-launch -v audiotestsrc num-buffers=10 ! audio/x-raw-int,rate=44100,channels=1 ! lamemp3enc target=bitrate cbr=true bitrate=48 ! filesink location=test.mp3
  57  * ]| Encode to a fixed sample rate
  58  * </refsect2>
  59  *
  60  * Since: 0.10.12
  61  */
  62
  63 #ifdef HAVE_CONFIG_H
  64 #include "config.h"
  65 #endif
  66
  67 #include <string.h>
  68 #include "gstlamemp3enc.h"
  69 #include <gst/gst-i18n-plugin.h>
  70
  71 /* lame < 3.98 */
  72 #ifndef HAVE_LAME_SET_VBR_QUALITY
  73 #define lame_set_VBR_quality(flags,q) lame_set_VBR_q((flags),(int)(q))
  74 #endif
  75
  76 GST_DEBUG_CATEGORY_STATIC (debug);
  77 #define GST_CAT_DEFAULT debug
  78
  79 /* elementfactory information */
  80
  81 /* LAMEMP3ENC can do MPEG-1, MPEG-2, and MPEG-2.5, so it has 9 possible
  82  * sample rates it supports */
  83 static GstStaticPadTemplate gst_lamemp3enc_sink_template =
  84 GST_STATIC_PAD_TEMPLATE ("sink",
  85     GST_PAD_SINK,
  86     GST_PAD_ALWAYS,
  87     GST_STATIC_CAPS ("audio/x-raw-int, "
  88         "endianness = (int) " G_STRINGIFY (G_BYTE_ORDER) ", "
  89         "signed = (boolean) true, "
  90         "width = (int) 16, "
  91         "depth = (int) 16, "
  92         "rate = (int) { 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000 }, "
  93         "channels = (int) [ 1, 2 ]")
  94     );
  95
  96 static GstStaticPadTemplate gst_lamemp3enc_src_template =
  97 GST_STATIC_PAD_TEMPLATE ("src",
  98     GST_PAD_SRC,
  99     GST_PAD_ALWAYS,
 100     GST_STATIC_CAPS ("audio/mpeg, "
 101         "mpegversion = (int) 1, "
 102         "layer = (int) 3, "
 103         "rate = (int) { 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000 }, "
 104         "channels = (int) [ 1, 2 ]")
 105     );
 106
 107 /********** Define useful types for non-programmatic interfaces **********/
 108 enum
 109 {
 110   LAMEMP3ENC_TARGET_QUALITY = 0,
 111   LAMEMP3ENC_TARGET_BITRATE
 112 };
 113
 114 #define GST_TYPE_LAMEMP3ENC_TARGET (gst_lamemp3enc_target_get_type())
 115 static GType
 116 gst_lamemp3enc_target_get_type (void)
 117 {
 118   static GType lame_target_type = 0;
 119   static GEnumValue lame_targets[] = {
 120     {LAMEMP3ENC_TARGET_QUALITY, "Quality", "quality"},
 121     {LAMEMP3ENC_TARGET_BITRATE, "Bitrate", "bitrate"},
 122     {0, NULL, NULL}
 123   };
 124
 125   if (!lame_target_type) {
 126     lame_target_type =
 127         g_enum_register_static ("GstLameMP3EncTarget", lame_targets);
 128   }
 129   return lame_target_type;
 130 }
 131
 132 enum
 133 {
 134   LAMEMP3ENC_ENCODING_ENGINE_QUALITY_FAST = 0,
 135   LAMEMP3ENC_ENCODING_ENGINE_QUALITY_STANDARD,
 136   LAMEMP3ENC_ENCODING_ENGINE_QUALITY_HIGH
 137 };
 138
 139 #define GST_TYPE_LAMEMP3ENC_ENCODING_ENGINE_QUALITY (gst_lamemp3enc_encoding_engine_quality_get_type())
 140 static GType
 141 gst_lamemp3enc_encoding_engine_quality_get_type (void)
 142 {
 143   static GType lame_encoding_engine_quality_type = 0;
 144   static GEnumValue lame_encoding_engine_quality[] = {
 145     {0, "Fast", "fast"},
 146     {1, "Standard", "standard"},
 147     {2, "High", "high"},
 148     {0, NULL, NULL}
 149   };
 150
 151   if (!lame_encoding_engine_quality_type) {
 152     lame_encoding_engine_quality_type =
 153         g_enum_register_static ("GstLameMP3EncEncodingEngineQuality",
 154         lame_encoding_engine_quality);
 155   }
 156   return lame_encoding_engine_quality_type;
 157 }
 158
 159 /********** Standard stuff for signals and arguments **********/
 160
 161 enum
 162 {
 163   ARG_0,
 164   ARG_TARGET,
 165   ARG_BITRATE,
 166   ARG_CBR,
 167   ARG_QUALITY,
 168   ARG_ENCODING_ENGINE_QUALITY,
 169   ARG_MONO
 170 };
 171
 172 #define DEFAULT_TARGET LAMEMP3ENC_TARGET_QUALITY
 173 #define DEFAULT_BITRATE 128
 174 #define DEFAULT_CBR FALSE
 175 #define DEFAULT_QUALITY 4
 176 #define DEFAULT_ENCODING_ENGINE_QUALITY LAMEMP3ENC_ENCODING_ENGINE_QUALITY_STANDARD
 177 #define DEFAULT_MONO FALSE
 178
 179 static void gst_lamemp3enc_base_init (gpointer g_class);
 180 static void gst_lamemp3enc_class_init (GstLameMP3EncClass * klass);
 181 static void gst_lamemp3enc_init (GstLameMP3Enc * gst_lame);
 182
 183 static void gst_lamemp3enc_set_property (GObject * object, guint prop_id,
 184     const GValue * value, GParamSpec * pspec);
 185 static void gst_lamemp3enc_get_property (GObject * object, guint prop_id,
 186     GValue * value, GParamSpec * pspec);
 187 static gboolean gst_lamemp3enc_sink_event (GstPad * pad, GstEvent * event);
 188 static GstFlowReturn gst_lamemp3enc_chain (GstPad * pad, GstBuffer * buf);
 189 static gboolean gst_lamemp3enc_setup (GstLameMP3Enc * lame);
 190 static GstStateChangeReturn gst_lamemp3enc_change_state (GstElement * element,
 191     GstStateChange transition);
 192
 193 static GstElementClass *parent_class = NULL;
 194
 195 GType
 196 gst_lamemp3enc_get_type (void)
 197 {
 198   static GType gst_lamemp3enc_type = 0;
 199
 200   if (!gst_lamemp3enc_type) {
 201     static const GTypeInfo gst_lamemp3enc_info = {
 202       sizeof (GstLameMP3EncClass),
 203       gst_lamemp3enc_base_init,
 204       NULL,
 205       (GClassInitFunc) gst_lamemp3enc_class_init,
 206       NULL,
 207       NULL,
 208       sizeof (GstLameMP3Enc),
 209       0,
 210       (GInstanceInitFunc) gst_lamemp3enc_init,
 211     };
 212     static const GInterfaceInfo preset_info = {
 213       NULL,
 214       NULL,
 215       NULL
 216     };
 217
 218     gst_lamemp3enc_type =
 219         g_type_register_static (GST_TYPE_ELEMENT, "GstLameMP3Enc",
 220         &gst_lamemp3enc_info, 0);
 221     g_type_add_interface_static (gst_lamemp3enc_type, GST_TYPE_PRESET,
 222         &preset_info);
 223   }
 224   return gst_lamemp3enc_type;
 225 }
 226
 227 static void
 228 gst_lamemp3enc_release_memory (GstLameMP3Enc * lame)
 229 {
 230   if (lame->lgf) {
 231     lame_close (lame->lgf);
 232     lame->lgf = NULL;
 233   }
 234 }
 235
 236 static void
 237 gst_lamemp3enc_finalize (GObject * obj)
 238 {
 239   gst_lamemp3enc_release_memory (GST_LAMEMP3ENC (obj));
 240
 241   G_OBJECT_CLASS (parent_class)->finalize (obj);
 242 }
 243
 244 static void
 245 gst_lamemp3enc_base_init (gpointer g_class)
 246 {
 247   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
 248
 249   gst_element_class_add_pad_template (element_class,
 250       gst_static_pad_template_get (&gst_lamemp3enc_src_template));
 251   gst_element_class_add_pad_template (element_class,
 252       gst_static_pad_template_get (&gst_lamemp3enc_sink_template));
 253   gst_element_class_set_details_simple (element_class, "L.A.M.E. mp3 encoder",
 254       "Codec/Encoder/Audio",
 255       "High-quality free MP3 encoder",
 256       "Sebastian Dröge <sebastian.droege@collabora.co.uk>");
 257 }
 258
 259 static void
 260 gst_lamemp3enc_class_init (GstLameMP3EncClass * klass)
 261 {
 262   GObjectClass *gobject_class;
 263   GstElementClass *gstelement_class;
 264
 265   gobject_class = (GObjectClass *) klass;
 266   gstelement_class = (GstElementClass *) klass;
 267
 268   parent_class = g_type_class_peek_parent (klass);
 269
 270   gobject_class->set_property = gst_lamemp3enc_set_property;
 271   gobject_class->get_property = gst_lamemp3enc_get_property;
 272   gobject_class->finalize = gst_lamemp3enc_finalize;
 273
 274   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_TARGET,
 275       g_param_spec_enum ("target", "Target",
 276           "Optimize for quality or bitrate", GST_TYPE_LAMEMP3ENC_TARGET,
 277           DEFAULT_TARGET, G_PARAM_READWRITE));
 278   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_BITRATE,
 279       g_param_spec_int ("bitrate", "Bitrate (kb/s)",
 280           "Bitrate in kbit/sec (Only valid if target is bitrate, for CBR one "
 281           "of 8, 16, 24, 32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, "
 282           "256 or 320)", 8, 320, DEFAULT_BITRATE, G_PARAM_READWRITE));
 283   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_CBR,
 284       g_param_spec_boolean ("cbr", "CBR", "Enforce constant bitrate encoding "
 285           "(Only valid if target is bitrate)", DEFAULT_CBR, G_PARAM_READWRITE));
 286   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_QUALITY,
 287       g_param_spec_float ("quality", "Quality",
 288           "VBR Quality from 0 to 10, 0 being the best "
 289           "(Only valid if target is quality)", 0.0, 9.999,
 290           DEFAULT_QUALITY, G_PARAM_READWRITE));
 291   g_object_class_install_property (G_OBJECT_CLASS (klass),
 292       ARG_ENCODING_ENGINE_QUALITY, g_param_spec_enum ("encoding-engine-quality",
 293           "Encoding Engine Quality", "Quality/speed of the encoding engine, "
 294           "this does not affect the bitrate!",
 295           GST_TYPE_LAMEMP3ENC_ENCODING_ENGINE_QUALITY,
 296           DEFAULT_ENCODING_ENGINE_QUALITY, G_PARAM_READWRITE));
 297   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_MONO,
 298       g_param_spec_boolean ("mono", "Mono", "Enforce mono encoding",
 299           DEFAULT_MONO, G_PARAM_READWRITE));
 300
 301   gstelement_class->change_state =
 302       GST_DEBUG_FUNCPTR (gst_lamemp3enc_change_state);
 303 }
 304
 305 static gboolean
 306 gst_lamemp3enc_src_setcaps (GstPad * pad, GstCaps * caps)
 307 {
 308   GST_DEBUG_OBJECT (pad, "caps: %" GST_PTR_FORMAT, caps);
 309   return TRUE;
 310 }
 311
 312 static gboolean
 313 gst_lamemp3enc_sink_setcaps (GstPad * pad, GstCaps * caps)
 314 {
 315   GstLameMP3Enc *lame;
 316   gint out_samplerate;
 317   gint version;
 318   GstStructure *structure;
 319   GstCaps *othercaps;
 320
 321   lame = GST_LAMEMP3ENC (GST_PAD_PARENT (pad));
 322   structure = gst_caps_get_structure (caps, 0);
 323
 324   if (!gst_structure_get_int (structure, "rate", &lame->samplerate))
 325     goto no_rate;
 326   if (!gst_structure_get_int (structure, "channels", &lame->num_channels))
 327     goto no_channels;
 328
 329   GST_DEBUG_OBJECT (lame, "setting up lame");
 330   if (!gst_lamemp3enc_setup (lame))
 331     goto setup_failed;
 332
 333
 334   out_samplerate = lame_get_out_samplerate (lame->lgf);
 335   if (out_samplerate == 0)
 336     goto zero_output_rate;
 337   if (out_samplerate != lame->samplerate) {
 338     GST_WARNING_OBJECT (lame,
 339         "output samplerate %d is different from incoming samplerate %d",
 340         out_samplerate, lame->samplerate);
 341   }
 342
 343   version = lame_get_version (lame->lgf);
 344   if (version == 0)
 345     version = 2;
 346   else if (version == 1)
 347     version = 1;
 348   else if (version == 2)
 349     version = 3;
 350
 351   othercaps =
 352       gst_caps_new_simple ("audio/mpeg",
 353       "mpegversion", G_TYPE_INT, 1,
 354       "mpegaudioversion", G_TYPE_INT, version,
 355       "layer", G_TYPE_INT, 3,
 356       "channels", G_TYPE_INT, lame->mono ? 1 : lame->num_channels,
 357       "rate", G_TYPE_INT, out_samplerate, NULL);
 358
 359   /* and use these caps */
 360   gst_pad_set_caps (lame->srcpad, othercaps);
 361   gst_caps_unref (othercaps);
 362
 363   return TRUE;
 364
 365 no_rate:
 366   {
 367     GST_ERROR_OBJECT (lame, "input caps have no sample rate field");
 368     return FALSE;
 369   }
 370 no_channels:
 371   {
 372     GST_ERROR_OBJECT (lame, "input caps have no channels field");
 373     return FALSE;
 374   }
 375 zero_output_rate:
 376   {
 377     GST_ELEMENT_ERROR (lame, LIBRARY, SETTINGS, (NULL),
 378         ("LAMEMP3ENC decided on a zero sample rate"));
 379     return FALSE;
 380   }
 381 setup_failed:
 382   {
 383     GST_ELEMENT_ERROR (lame, LIBRARY, SETTINGS,
 384         (_("Failed to configure LAMEMP3ENC encoder. Check your encoding parameters.")), (NULL));
 385     return FALSE;
 386   }
 387 }
 388
 389 static void
 390 gst_lamemp3enc_init (GstLameMP3Enc * lame)
 391 {
 392   GST_DEBUG_OBJECT (lame, "starting initialization");
 393
 394   lame->sinkpad =
 395       gst_pad_new_from_static_template (&gst_lamemp3enc_sink_template, "sink");
 396   gst_pad_set_event_function (lame->sinkpad,
 397       GST_DEBUG_FUNCPTR (gst_lamemp3enc_sink_event));
 398   gst_pad_set_chain_function (lame->sinkpad,
 399       GST_DEBUG_FUNCPTR (gst_lamemp3enc_chain));
 400   gst_pad_set_setcaps_function (lame->sinkpad,
 401       GST_DEBUG_FUNCPTR (gst_lamemp3enc_sink_setcaps));
 402   gst_element_add_pad (GST_ELEMENT (lame), lame->sinkpad);
 403
 404   lame->srcpad =
 405       gst_pad_new_from_static_template (&gst_lamemp3enc_src_template, "src");
 406   gst_pad_set_setcaps_function (lame->srcpad,
 407       GST_DEBUG_FUNCPTR (gst_lamemp3enc_src_setcaps));
 408   gst_element_add_pad (GST_ELEMENT (lame), lame->srcpad);
 409
 410   lame->samplerate = 44100;
 411   lame->num_channels = 2;
 412   lame->setup = FALSE;
 413
 414   /* Set default settings */
 415   lame->target = DEFAULT_TARGET;
 416   lame->bitrate = DEFAULT_BITRATE;
 417   lame->cbr = DEFAULT_CBR;
 418   lame->quality = DEFAULT_QUALITY;
 419   lame->encoding_engine_quality = DEFAULT_ENCODING_ENGINE_QUALITY;
 420   lame->mono = DEFAULT_MONO;
 421
 422   GST_DEBUG_OBJECT (lame, "done initializing");
 423 }
 424
 425 /* <php-emulation-mode>three underscores for ___rate is really really really
 426  * private as opposed to one underscore<php-emulation-mode> */
 427 /* call this MACRO outside of the NULL state so that we have a higher chance
 428  * of actually having a pipeline and bus to get the message through */
 429
 430 #define CHECK_AND_FIXUP_BITRATE(obj,param,rate)                           \
 431 G_STMT_START {                                                            \
 432   gint ___rate = rate;                                                    \
 433   gint maxrate = 320;                                                     \
 434   gint multiplier = 64;                                                   \
 435   if (rate == 0) {                                                        \
 436     ___rate = rate;                                                       \
 437   } else if (rate <= 64) {                                                \
 438     maxrate = 64; multiplier = 8;                                         \
 439     if ((rate % 8) != 0) ___rate = GST_ROUND_UP_8 (rate);                 \
 440   } else if (rate <= 128) {                                               \
 441     maxrate = 128; multiplier = 16;                                       \
 442     if ((rate % 16) != 0) ___rate = GST_ROUND_UP_16 (rate);               \
 443   } else if (rate <= 256) {                                               \
 444     maxrate = 256; multiplier = 32;                                       \
 445     if ((rate % 32) != 0) ___rate = GST_ROUND_UP_32 (rate);               \
 446   } else if (rate <= 320) {                                               \
 447     maxrate = 320; multiplier = 64;                                       \
 448     if ((rate % 64) != 0) ___rate = GST_ROUND_UP_64 (rate);               \
 449   }                                                                       \
 450   if (___rate != rate) {                                                  \
 451     GST_ELEMENT_WARNING (obj, LIBRARY, SETTINGS,                          \
 452       (_("The requested bitrate %d kbit/s for property '%s' "             \
 453        "is not allowed. "                                                 \
 454        "The bitrate was changed to %d kbit/s."), rate,                    \
 455          param,  ___rate),                                                \
 456        ("A bitrate below %d should be a multiple of %d.",                 \
 457           maxrate, multiplier));                                          \
 458     rate = ___rate;                                                       \
 459   }                                                                       \
 460 } G_STMT_END
 461
 462 static void
 463 gst_lamemp3enc_set_property (GObject * object, guint prop_id,
 464     const GValue * value, GParamSpec * pspec)
 465 {
 466   GstLameMP3Enc *lame;
 467
 468   lame = GST_LAMEMP3ENC (object);
 469
 470   switch (prop_id) {
 471     case ARG_TARGET:
 472       lame->target = g_value_get_enum (value);
 473       break;
 474     case ARG_BITRATE:
 475       lame->bitrate = g_value_get_int (value);
 476       break;
 477     case ARG_CBR:
 478       lame->cbr = g_value_get_boolean (value);
 479       break;
 480     case ARG_QUALITY:
 481       lame->quality = g_value_get_float (value);
 482       break;
 483     case ARG_ENCODING_ENGINE_QUALITY:
 484       lame->encoding_engine_quality = g_value_get_enum (value);
 485       break;
 486     case ARG_MONO:
 487       lame->mono = g_value_get_boolean (value);
 488       break;
 489     default:
 490       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 491       break;
 492   }
 493 }
 494
 495 static void
 496 gst_lamemp3enc_get_property (GObject * object, guint prop_id, GValue * value,
 497     GParamSpec * pspec)
 498 {
 499   GstLameMP3Enc *lame;
 500
 501   lame = GST_LAMEMP3ENC (object);
 502
 503   switch (prop_id) {
 504     case ARG_TARGET:
 505       g_value_set_enum (value, lame->target);
 506       break;
 507     case ARG_BITRATE:
 508       g_value_set_int (value, lame->bitrate);
 509       break;
 510     case ARG_CBR:
 511       g_value_set_boolean (value, lame->cbr);
 512       break;
 513     case ARG_QUALITY:
 514       g_value_set_float (value, lame->quality);
 515       break;
 516     case ARG_ENCODING_ENGINE_QUALITY:
 517       g_value_set_enum (value, lame->encoding_engine_quality);
 518       break;
 519     case ARG_MONO:
 520       g_value_set_boolean (value, lame->mono);
 521       break;
 522     default:
 523       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 524       break;
 525   }
 526 }
 527
 528 static gboolean
 529 gst_lamemp3enc_sink_event (GstPad * pad, GstEvent * event)
 530 {
 531   gboolean ret;
 532   GstLameMP3Enc *lame;
 533
 534   lame = GST_LAMEMP3ENC (gst_pad_get_parent (pad));
 535
 536   switch (GST_EVENT_TYPE (event)) {
 537     case GST_EVENT_EOS:{
 538       GST_DEBUG_OBJECT (lame, "handling EOS event");
 539
 540       if (lame->lgf != NULL) {
 541         GstBuffer *buf;
 542         gint size;
 543
 544         buf = gst_buffer_new_and_alloc (7200);
 545         size = lame_encode_flush (lame->lgf, GST_BUFFER_DATA (buf), 7200);
 546
 547         if (size > 0 && lame->last_flow == GST_FLOW_OK) {
 548           gint64 duration;
 549
 550           duration = gst_util_uint64_scale (size, 8 * GST_SECOND,
 551               1000 * lame->bitrate);
 552
 553           if (lame->last_ts == GST_CLOCK_TIME_NONE) {
 554             lame->last_ts = lame->eos_ts;
 555             lame->last_duration = duration;
 556           } else {
 557             lame->last_duration += duration;
 558           }
 559
 560           GST_BUFFER_TIMESTAMP (buf) = lame->last_ts;
 561           GST_BUFFER_DURATION (buf) = lame->last_duration;
 562           lame->last_ts = GST_CLOCK_TIME_NONE;
 563           GST_BUFFER_SIZE (buf) = size;
 564           GST_DEBUG_OBJECT (lame, "pushing final packet of %u bytes", size);
 565           gst_buffer_set_caps (buf, GST_PAD_CAPS (lame->srcpad));
 566           gst_pad_push (lame->srcpad, buf);
 567         } else {
 568           GST_DEBUG_OBJECT (lame, "no final packet (size=%d, last_flow=%s)",
 569               size, gst_flow_get_name (lame->last_flow));
 570           gst_buffer_unref (buf);
 571         }
 572       }
 573
 574       ret = gst_pad_event_default (pad, event);
 575       break;
 576     }
 577     case GST_EVENT_FLUSH_START:
 578       GST_DEBUG_OBJECT (lame, "handling FLUSH start event");
 579       /* forward event */
 580       ret = gst_pad_push_event (lame->srcpad, event);
 581       break;
 582     case GST_EVENT_FLUSH_STOP:
 583     {
 584       guchar *mp3_data = NULL;
 585       gint mp3_buffer_size;
 586
 587       GST_DEBUG_OBJECT (lame, "handling FLUSH stop event");
 588
 589       if (lame->lgf) {
 590         /* clear buffers if we already have lame set up */
 591         mp3_buffer_size = 7200;
 592         mp3_data = g_malloc (mp3_buffer_size);
 593         lame_encode_flush (lame->lgf, mp3_data, mp3_buffer_size);
 594         g_free (mp3_data);
 595       }
 596
 597       ret = gst_pad_push_event (lame->srcpad, event);
 598       break;
 599     }
 600     case GST_EVENT_TAG:
 601       GST_DEBUG_OBJECT (lame, "ignoring TAG event, passing it on");
 602       ret = gst_pad_push_event (lame->srcpad, event);
 603       break;
 604     default:
 605       ret = gst_pad_event_default (pad, event);
 606       break;
 607   }
 608   gst_object_unref (lame);
 609   return ret;
 610 }
 611
 612 static GstFlowReturn
 613 gst_lamemp3enc_chain (GstPad * pad, GstBuffer * buf)
 614 {
 615   GstLameMP3Enc *lame;
 616   guchar *mp3_data;
 617   gint mp3_buffer_size, mp3_size;
 618   gint64 duration;
 619   GstFlowReturn result;
 620   gint num_samples;
 621   guint8 *data;
 622   guint size;
 623
 624   lame = GST_LAMEMP3ENC (GST_PAD_PARENT (pad));
 625
 626   GST_LOG_OBJECT (lame, "entered chain");
 627
 628   if (!lame->setup)
 629     goto not_setup;
 630
 631   data = GST_BUFFER_DATA (buf);
 632   size = GST_BUFFER_SIZE (buf);
 633
 634   num_samples = size / 2;
 635
 636   /* allocate space for output */
 637   mp3_buffer_size = 1.25 * num_samples + 7200;
 638   mp3_data = g_malloc (mp3_buffer_size);
 639
 640   /* lame seems to be too stupid to get mono interleaved going */
 641   if (lame->num_channels == 1) {
 642     mp3_size = lame_encode_buffer (lame->lgf,
 643         (short int *) data,
 644         (short int *) data, num_samples, mp3_data, mp3_buffer_size);
 645   } else {
 646     mp3_size = lame_encode_buffer_interleaved (lame->lgf,
 647         (short int *) data,
 648         num_samples / lame->num_channels, mp3_data, mp3_buffer_size);
 649   }
 650
 651   GST_LOG_OBJECT (lame, "encoded %d bytes of audio to %d bytes of mp3",
 652       size, mp3_size);
 653
 654   duration = gst_util_uint64_scale_int (size, GST_SECOND,
 655       2 * lame->samplerate * lame->num_channels);
 656
 657   if (GST_BUFFER_DURATION (buf) != GST_CLOCK_TIME_NONE &&
 658       GST_BUFFER_DURATION (buf) != duration) {
 659     GST_DEBUG_OBJECT (lame, "incoming buffer had incorrect duration %"
 660         GST_TIME_FORMAT ", outgoing buffer will have correct duration %"
 661         GST_TIME_FORMAT,
 662         GST_TIME_ARGS (GST_BUFFER_DURATION (buf)), GST_TIME_ARGS (duration));
 663   }
 664
 665   if (lame->last_ts == GST_CLOCK_TIME_NONE) {
 666     lame->last_ts = GST_BUFFER_TIMESTAMP (buf);
 667     lame->last_offs = GST_BUFFER_OFFSET (buf);
 668     lame->last_duration = duration;
 669   } else {
 670     lame->last_duration += duration;
 671   }
 672
 673   gst_buffer_unref (buf);
 674
 675   if (mp3_size < 0) {
 676     g_warning ("error %d", mp3_size);
 677   }
 678
 679   if (mp3_size > 0) {
 680     GstBuffer *outbuf;
 681
 682     outbuf = gst_buffer_new ();
 683     GST_BUFFER_DATA (outbuf) = mp3_data;
 684     GST_BUFFER_MALLOCDATA (outbuf) = mp3_data;
 685     GST_BUFFER_SIZE (outbuf) = mp3_size;
 686     GST_BUFFER_TIMESTAMP (outbuf) = lame->last_ts;
 687     GST_BUFFER_OFFSET (outbuf) = lame->last_offs;
 688     GST_BUFFER_DURATION (outbuf) = lame->last_duration;
 689     gst_buffer_set_caps (outbuf, GST_PAD_CAPS (lame->srcpad));
 690
 691     result = gst_pad_push (lame->srcpad, outbuf);
 692     lame->last_flow = result;
 693     if (result != GST_FLOW_OK) {
 694       GST_DEBUG_OBJECT (lame, "flow return: %s", gst_flow_get_name (result));
 695     }
 696
 697     if (GST_CLOCK_TIME_IS_VALID (lame->last_ts))
 698       lame->eos_ts = lame->last_ts + lame->last_duration;
 699     else
 700       lame->eos_ts = GST_CLOCK_TIME_NONE;
 701     lame->last_ts = GST_CLOCK_TIME_NONE;
 702   } else {
 703     g_free (mp3_data);
 704     result = GST_FLOW_OK;
 705   }
 706
 707   return result;
 708
 709   /* ERRORS */
 710 not_setup:
 711   {
 712     gst_buffer_unref (buf);
 713     GST_ELEMENT_ERROR (lame, CORE, NEGOTIATION, (NULL),
 714         ("encoder not initialized (input is not audio?)"));
 715     return GST_FLOW_ERROR;
 716   }
 717 }
 718
 719 /* set up the encoder state */
 720 static gboolean
 721 gst_lamemp3enc_setup (GstLameMP3Enc * lame)
 722 {
 723
 724 #define CHECK_ERROR(command) G_STMT_START {\
 725   if ((command) < 0) { \
 726     GST_ERROR_OBJECT (lame, "setup failed: " G_STRINGIFY (command)); \
 727     return FALSE; \
 728   } \
 729 }G_STMT_END
 730
 731   int retval;
 732   GstCaps *allowed_caps;
 733
 734   GST_DEBUG_OBJECT (lame, "starting setup");
 735
 736   /* check if we're already setup; if we are, we might want to check
 737    * if this initialization is compatible with the previous one */
 738   /* FIXME: do this */
 739   if (lame->setup) {
 740     GST_WARNING_OBJECT (lame, "already setup");
 741     lame->setup = FALSE;
 742   }
 743
 744   lame->lgf = lame_init ();
 745
 746   if (lame->lgf == NULL)
 747     return FALSE;
 748
 749   /* copy the parameters over */
 750   lame_set_in_samplerate (lame->lgf, lame->samplerate);
 751
 752   /* let lame choose default samplerate unless outgoing sample rate is fixed */
 753   allowed_caps = gst_pad_get_allowed_caps (lame->srcpad);
 754
 755   if (allowed_caps != NULL) {
 756     GstStructure *structure;
 757     gint samplerate;
 758
 759     structure = gst_caps_get_structure (allowed_caps, 0);
 760
 761     if (gst_structure_get_int (structure, "rate", &samplerate)) {
 762       GST_DEBUG_OBJECT (lame, "Setting sample rate to %d as fixed in src caps",
 763           samplerate);
 764       lame_set_out_samplerate (lame->lgf, samplerate);
 765     } else {
 766       GST_DEBUG_OBJECT (lame, "Letting lame choose sample rate");
 767       lame_set_out_samplerate (lame->lgf, 0);
 768     }
 769     gst_caps_unref (allowed_caps);
 770     allowed_caps = NULL;
 771   } else {
 772     GST_DEBUG_OBJECT (lame, "No peer yet, letting lame choose sample rate");
 773     lame_set_out_samplerate (lame->lgf, 0);
 774   }
 775
 776   CHECK_ERROR (lame_set_num_channels (lame->lgf, lame->num_channels));
 777   CHECK_ERROR (lame_set_bWriteVbrTag (lame->lgf, 0));
 778
 779   if (lame->target == LAMEMP3ENC_TARGET_QUALITY) {
 780     CHECK_ERROR (lame_set_VBR (lame->lgf, vbr_default));
 781     CHECK_ERROR (lame_set_VBR_quality (lame->lgf, lame->quality));
 782   } else {
 783     if (lame->cbr) {
 784       CHECK_AND_FIXUP_BITRATE (lame, "bitrate", lame->bitrate);
 785       CHECK_ERROR (lame_set_VBR (lame->lgf, vbr_off));
 786       CHECK_ERROR (lame_set_brate (lame->lgf, lame->bitrate));
 787     } else {
 788       CHECK_ERROR (lame_set_VBR (lame->lgf, vbr_abr));
 789       CHECK_ERROR (lame_set_VBR_mean_bitrate_kbps (lame->lgf, lame->bitrate));
 790     }
 791   }
 792
 793   if (lame->encoding_engine_quality == LAMEMP3ENC_ENCODING_ENGINE_QUALITY_FAST)
 794     CHECK_ERROR (lame_set_quality (lame->lgf, 7));
 795   else if (lame->encoding_engine_quality ==
 796       LAMEMP3ENC_ENCODING_ENGINE_QUALITY_HIGH)
 797     CHECK_ERROR (lame_set_quality (lame->lgf, 2));
 798   /* else default */
 799
 800   if (lame->mono)
 801     CHECK_ERROR (lame_set_mode (lame->lgf, MONO));
 802
 803   /* initialize the lame encoder */
 804   if ((retval = lame_init_params (lame->lgf)) >= 0) {
 805     lame->setup = TRUE;
 806     /* FIXME: it would be nice to print out the mode here */
 807     GST_INFO
 808         ("lame encoder setup (target %s, quality %f, bitrate %d, %d Hz, %d channels)",
 809         (lame->target == LAMEMP3ENC_TARGET_QUALITY) ? "quality" : "bitrate",
 810         lame->quality, lame->bitrate, lame->samplerate, lame->num_channels);
 811   } else {
 812     GST_ERROR_OBJECT (lame, "lame_init_params returned %d", retval);
 813   }
 814
 815   GST_DEBUG_OBJECT (lame, "done with setup");
 816
 817   return lame->setup;
 818 #undef CHECK_ERROR
 819 }
 820
 821 static GstStateChangeReturn
 822 gst_lamemp3enc_change_state (GstElement * element, GstStateChange transition)
 823 {
 824   GstLameMP3Enc *lame;
 825   GstStateChangeReturn result;
 826
 827   lame = GST_LAMEMP3ENC (element);
 828
 829   switch (transition) {
 830     case GST_STATE_CHANGE_READY_TO_PAUSED:
 831       lame->last_flow = GST_FLOW_OK;
 832       lame->last_ts = GST_CLOCK_TIME_NONE;
 833       lame->eos_ts = GST_CLOCK_TIME_NONE;
 834       break;
 835     default:
 836       break;
 837   }
 838
 839   result = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 840
 841   switch (transition) {
 842     case GST_STATE_CHANGE_READY_TO_NULL:
 843       gst_lamemp3enc_release_memory (lame);
 844       break;
 845     default:
 846       break;
 847   }
 848
 849   return result;
 850 }
 851
 852 gboolean
 853 gst_lamemp3enc_register (GstPlugin * plugin)
 854 {
 855   GST_DEBUG_CATEGORY_INIT (debug, "lamemp3enc", 0, "lame mp3 encoder");
 856
 857   if (!gst_element_register (plugin, "lamemp3enc", GST_RANK_PRIMARY,
 858           GST_TYPE_LAMEMP3ENC))
 859     return FALSE;
 860
 861   return TRUE;
 862 }