gst/isomp4/gstqtmoovrecover.c

   1 /* Quicktime muxer plugin for GStreamer
   2  * Copyright (C) 2010 Thiago Santos <thiago.sousa.santos@collabora.co.uk>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  17  * Boston, MA 02110-1301, USA.
  18  */
  19 /*
  20  * Unless otherwise indicated, Source Code is licensed under MIT license.
  21  * See further explanation attached in License Statement (distributed in the file
  22  * LICENSE).
  23  *
  24  * Permission is hereby granted, free of charge, to any person obtaining a copy of
  25  * this software and associated documentation files (the "Software"), to deal in
  26  * the Software without restriction, including without limitation the rights to
  27  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
  28  * of the Software, and to permit persons to whom the Software is furnished to do
  29  * so, subject to the following conditions:
  30  *
  31  * The above copyright notice and this permission notice shall be included in all
  32  * copies or substantial portions of the Software.
  33  *
  34  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  35  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  36  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  37  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  38  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  39  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  40  * SOFTWARE.
  41  */
  42
  43
  44 /**
  45  * SECTION:element-qtmoovrecover
  46  * @short_description: Utility element for recovering unfinished quicktime files
  47  *
  48  * <refsect2>
  49  * <para>
  50  * This element recovers quicktime files created with qtmux using the moov
  51  * recovery feature.
  52  * </para>
  53  * <title>Example pipelines</title>
  54  * <para>
  55  * <programlisting>
  56  * TODO
  57  * </programlisting>
  58  * </para>
  59  * </refsect2>
  60  */
  61
  62 #ifdef HAVE_CONFIG_H
  63 #include "config.h"
  64 #endif
  65
  66 #include <glib/gstdio.h>
  67 #include <gst/gst.h>
  68
  69 #include "gstqtmoovrecover.h"
  70
  71 GST_DEBUG_CATEGORY_STATIC (gst_qt_moov_recover_debug);
  72 #define GST_CAT_DEFAULT gst_qt_moov_recover_debug
  73
  74 /* QTMoovRecover signals and args */
  75 enum
  76 {
  77   /* FILL ME */
  78   LAST_SIGNAL
  79 };
  80
  81 enum
  82 {
  83   PROP_0,
  84   PROP_RECOVERY_INPUT,
  85   PROP_BROKEN_INPUT,
  86   PROP_FIXED_OUTPUT,
  87   PROP_FAST_START_MODE
  88 };
  89
  90 #define gst_qt_moov_recover_parent_class parent_class
  91 G_DEFINE_TYPE (GstQTMoovRecover, gst_qt_moov_recover, GST_TYPE_PIPELINE);
  92
  93 /* property functions */
  94 static void gst_qt_moov_recover_set_property (GObject * object,
  95     guint prop_id, const GValue * value, GParamSpec * pspec);
  96 static void gst_qt_moov_recover_get_property (GObject * object,
  97     guint prop_id, GValue * value, GParamSpec * pspec);
  98
  99 static GstStateChangeReturn gst_qt_moov_recover_change_state (GstElement *
 100     element, GstStateChange transition);
 101
 102 static void gst_qt_moov_recover_finalize (GObject * object);
 103
 104 static void
 105 gst_qt_moov_recover_class_init (GstQTMoovRecoverClass * klass)
 106 {
 107   GObjectClass *gobject_class;
 108   GstElementClass *gstelement_class;
 109
 110   gobject_class = (GObjectClass *) klass;
 111   gstelement_class = (GstElementClass *) klass;
 112
 113   parent_class = g_type_class_peek_parent (klass);
 114
 115   gobject_class->finalize = gst_qt_moov_recover_finalize;
 116   gobject_class->get_property = gst_qt_moov_recover_get_property;
 117   gobject_class->set_property = gst_qt_moov_recover_set_property;
 118
 119   gstelement_class->change_state = gst_qt_moov_recover_change_state;
 120
 121   g_object_class_install_property (gobject_class, PROP_FIXED_OUTPUT,
 122       g_param_spec_string ("fixed-output",
 123           "Path to write the fixed file",
 124           "Path to write the fixed file to (used as output)",
 125           NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 126   g_object_class_install_property (gobject_class, PROP_BROKEN_INPUT,
 127       g_param_spec_string ("broken-input",
 128           "Path to broken input file",
 129           "Path to broken input file. (If qtmux was on faststart mode, this "
 130           "file is the faststart file)", NULL,
 131           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 132   g_object_class_install_property (gobject_class, PROP_RECOVERY_INPUT,
 133       g_param_spec_string ("recovery-input",
 134           "Path to recovery file",
 135           "Path to recovery file (used as input)", NULL,
 136           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 137   g_object_class_install_property (gobject_class, PROP_FAST_START_MODE,
 138       g_param_spec_boolean ("faststart-mode",
 139           "If the broken input is from faststart mode",
 140           "If the broken input is from faststart mode",
 141           FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 142
 143   GST_DEBUG_CATEGORY_INIT (gst_qt_moov_recover_debug, "qtmoovrecover", 0,
 144       "QT Moovie Recover");
 145
 146   gst_element_class_set_static_metadata (gstelement_class, "QT Moov Recover",
 147       "Util", "Recovers unfinished qtmux files",
 148       "Thiago Santos <thiago.sousa.santos@collabora.co.uk>");
 149 }
 150
 151 static void
 152 gst_qt_moov_recover_init (GstQTMoovRecover * qtmr)
 153 {
 154 }
 155
 156 static void
 157 gst_qt_moov_recover_finalize (GObject * object)
 158 {
 159   G_OBJECT_CLASS (parent_class)->finalize (object);
 160 }
 161
 162 static void
 163 gst_qt_moov_recover_run (void *data)
 164 {
 165   FILE *moovrec = NULL;
 166   FILE *mdatinput = NULL;
 167   FILE *output = NULL;
 168   MdatRecovFile *mdat_recov = NULL;
 169   MoovRecovFile *moov_recov = NULL;
 170   GstQTMoovRecover *qtmr = GST_QT_MOOV_RECOVER_CAST (data);
 171   GError *err = NULL;
 172
 173   GST_LOG_OBJECT (qtmr, "Starting task");
 174
 175   GST_DEBUG_OBJECT (qtmr, "Validating properties");
 176   GST_OBJECT_LOCK (qtmr);
 177   /* validate properties */
 178   if (qtmr->broken_input == NULL) {
 179     GST_OBJECT_UNLOCK (qtmr);
 180     GST_ELEMENT_ERROR (qtmr, RESOURCE, SETTINGS,
 181         ("Please set broken-input property"), (NULL));
 182     goto end;
 183   }
 184   if (qtmr->recovery_input == NULL) {
 185     GST_OBJECT_UNLOCK (qtmr);
 186     GST_ELEMENT_ERROR (qtmr, RESOURCE, SETTINGS,
 187         ("Please set recovery-input property"), (NULL));
 188     goto end;
 189   }
 190   if (qtmr->fixed_output == NULL) {
 191     GST_OBJECT_UNLOCK (qtmr);
 192     GST_ELEMENT_ERROR (qtmr, RESOURCE, SETTINGS,
 193         ("Please set fixed-output property"), (NULL));
 194     goto end;
 195   }
 196
 197   GST_DEBUG_OBJECT (qtmr, "Opening input/output files");
 198   /* open files */
 199   moovrec = g_fopen (qtmr->recovery_input, "rb");
 200   if (moovrec == NULL) {
 201     GST_OBJECT_UNLOCK (qtmr);
 202     GST_ELEMENT_ERROR (qtmr, RESOURCE, OPEN_READ,
 203         ("Failed to open recovery-input file"), (NULL));
 204     goto end;
 205   }
 206
 207   mdatinput = g_fopen (qtmr->broken_input, "rb");
 208   if (mdatinput == NULL) {
 209     GST_OBJECT_UNLOCK (qtmr);
 210     GST_ELEMENT_ERROR (qtmr, RESOURCE, OPEN_READ,
 211         ("Failed to open broken-input file"), (NULL));
 212     goto end;
 213   }
 214   output = g_fopen (qtmr->fixed_output, "wb+");
 215   if (output == NULL) {
 216     GST_OBJECT_UNLOCK (qtmr);
 217     GST_ELEMENT_ERROR (qtmr, RESOURCE, OPEN_READ_WRITE,
 218         ("Failed to open fixed-output file"), (NULL));
 219     goto end;
 220   }
 221   GST_OBJECT_UNLOCK (qtmr);
 222
 223   GST_DEBUG_OBJECT (qtmr, "Parsing input files");
 224   /* now create our structures */
 225   mdat_recov = mdat_recov_file_create (mdatinput, qtmr->faststart_mode, &err);
 226   mdatinput = NULL;
 227   if (mdat_recov == NULL) {
 228     GST_ELEMENT_ERROR (qtmr, RESOURCE, FAILED,
 229         ("Broken file could not be parsed correctly"), (NULL));
 230     goto end;
 231   }
 232   moov_recov = moov_recov_file_create (moovrec, &err);
 233   moovrec = NULL;
 234   if (moov_recov == NULL) {
 235     GST_ELEMENT_ERROR (qtmr, RESOURCE, FAILED,
 236         ("Recovery file could not be parsed correctly"), (NULL));
 237     goto end;
 238   }
 239
 240   /* now parse the buffers data from moovrec */
 241   if (!moov_recov_parse_buffers (moov_recov, mdat_recov, &err)) {
 242     goto end;
 243   }
 244
 245   GST_DEBUG_OBJECT (qtmr, "Writing fixed file to output");
 246   if (!moov_recov_write_file (moov_recov, mdat_recov, output, &err)) {
 247     goto end;
 248   }
 249
 250   /* here means success */
 251   GST_DEBUG_OBJECT (qtmr, "Finished successfully, posting EOS");
 252   gst_element_post_message (GST_ELEMENT_CAST (qtmr),
 253       gst_message_new_eos (GST_OBJECT_CAST (qtmr)));
 254
 255 end:
 256   GST_LOG_OBJECT (qtmr, "Finalizing task");
 257   if (err) {
 258     GST_ELEMENT_ERROR (qtmr, RESOURCE, FAILED, ("%s", err->message), (NULL));
 259     g_error_free (err);
 260   }
 261
 262   if (moov_recov)
 263     moov_recov_file_free (moov_recov);
 264   if (moovrec)
 265     fclose (moovrec);
 266
 267   if (mdat_recov)
 268     mdat_recov_file_free (mdat_recov);
 269   if (mdatinput)
 270     fclose (mdatinput);
 271
 272   if (output)
 273     fclose (output);
 274   GST_LOG_OBJECT (qtmr, "Leaving task");
 275   gst_task_stop (qtmr->task);
 276 }
 277
 278 static void
 279 gst_qt_moov_recover_get_property (GObject * object,
 280     guint prop_id, GValue * value, GParamSpec * pspec)
 281 {
 282   GstQTMoovRecover *qtmr = GST_QT_MOOV_RECOVER_CAST (object);
 283
 284   GST_OBJECT_LOCK (qtmr);
 285   switch (prop_id) {
 286     case PROP_FAST_START_MODE:
 287       g_value_set_boolean (value, qtmr->faststart_mode);
 288       break;
 289     case PROP_BROKEN_INPUT:
 290       g_value_set_string (value, qtmr->broken_input);
 291       break;
 292     case PROP_RECOVERY_INPUT:
 293       g_value_set_string (value, qtmr->recovery_input);
 294       break;
 295     case PROP_FIXED_OUTPUT:
 296       g_value_set_string (value, qtmr->fixed_output);
 297       break;
 298     default:
 299       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 300       break;
 301   }
 302   GST_OBJECT_UNLOCK (qtmr);
 303 }
 304
 305 static void
 306 gst_qt_moov_recover_set_property (GObject * object,
 307     guint prop_id, const GValue * value, GParamSpec * pspec)
 308 {
 309   GstQTMoovRecover *qtmr = GST_QT_MOOV_RECOVER_CAST (object);
 310
 311   GST_OBJECT_LOCK (qtmr);
 312   switch (prop_id) {
 313     case PROP_FAST_START_MODE:
 314       qtmr->faststart_mode = g_value_get_boolean (value);
 315       break;
 316     case PROP_BROKEN_INPUT:
 317       g_free (qtmr->broken_input);
 318       qtmr->broken_input = g_value_dup_string (value);
 319       break;
 320     case PROP_RECOVERY_INPUT:
 321       g_free (qtmr->recovery_input);
 322       qtmr->recovery_input = g_value_dup_string (value);
 323       break;
 324     case PROP_FIXED_OUTPUT:
 325       g_free (qtmr->fixed_output);
 326       qtmr->fixed_output = g_value_dup_string (value);
 327       break;
 328     default:
 329       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 330       break;
 331   }
 332   GST_OBJECT_UNLOCK (qtmr);
 333 }
 334
 335 static GstStateChangeReturn
 336 gst_qt_moov_recover_change_state (GstElement * element,
 337     GstStateChange transition)
 338 {
 339   GstStateChangeReturn ret;
 340   GstQTMoovRecover *qtmr = GST_QT_MOOV_RECOVER_CAST (element);
 341
 342   switch (transition) {
 343     case GST_STATE_CHANGE_NULL_TO_READY:
 344       qtmr->task = gst_task_new (gst_qt_moov_recover_run, qtmr, NULL);
 345       g_rec_mutex_init (&qtmr->task_mutex);
 346       gst_task_set_lock (qtmr->task, &qtmr->task_mutex);
 347       break;
 348     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
 349       gst_task_start (qtmr->task);
 350       break;
 351     default:
 352       break;
 353   }
 354
 355   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 356
 357   switch (transition) {
 358     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
 359       gst_task_stop (qtmr->task);
 360       gst_task_join (qtmr->task);
 361       break;
 362     case GST_STATE_CHANGE_READY_TO_NULL:
 363       if (gst_task_get_state (qtmr->task) != GST_TASK_STOPPED)
 364         GST_ERROR ("task %p should be stopped by now", qtmr->task);
 365       gst_object_unref (qtmr->task);
 366       qtmr->task = NULL;
 367       g_rec_mutex_clear (&qtmr->task_mutex);
 368       break;
 369     default:
 370       break;
 371   }
 372   return ret;
 373 }
 374
 375
 376 gboolean
 377 gst_qt_moov_recover_register (GstPlugin * plugin)
 378 {
 379   return gst_element_register (plugin, "qtmoovrecover", GST_RANK_NONE,
 380       GST_TYPE_QT_MOOV_RECOVER);
 381 }