/* GStreamer

 * Copyright (C) 2001 RidgeRun (http://www.ridgerun.com/)

 * Written by Erik Walthinsen <omega@ridgerun.com>

 *

 * gstindex.c: Index for mappings and other data

 *

 * This library is free software; you can redistribute it and/or

 * modify it under the terms of the GNU Library General Public

 * License as published by the Free Software Foundation; either

 * version 2 of the License, or (at your option) any later version.

 *

 * This library is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

 * Library General Public License for more details.

 *

 * You should have received a copy of the GNU Library General Public

 * License along with this library; if not, write to the

 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,

 * Boston, MA 02111-1307, USA.

 */

/**

 * SECTION:gstindex

 * @short_description: Generate indexes on objects

 * @see_also: #GstIndexFactory

 *

 * GstIndex is used to generate a stream index of one or more elements

 * in a pipeline.

 */

#include "gst_private.h"

#include "gstinfo.h"

#include "gstindex.h"

#include "gstindexfactory.h"

#include "gstmarshal.h"

#include "gstregistry.h"

/* for constructing an entry name */

#include "gstelement.h"

#include "gstpad.h"

#include "gstinfo.h"

/* Index signals and args */

enum

{

  ENTRY_ADDED,

  LAST_SIGNAL

};

enum

{

  ARG_0,

  ARG_RESOLVER

      /* FILL ME */

};

GST_DEBUG_CATEGORY_STATIC (index_debug);

#define GST_CAT_DEFAULT index_debug

static void gst_index_class_init (GstIndexClass * klass);

static void gst_index_init (GstIndex * index);

static void gst_index_finalize (GObject * object);

static void gst_index_set_property (GObject * object, guint prop_id,

    const GValue * value, GParamSpec * pspec);

static void gst_index_get_property (GObject * object, guint prop_id,

    GValue * value, GParamSpec * pspec);

static GstIndexGroup *gst_index_group_new (guint groupnum);

static gboolean gst_index_path_resolver (GstIndex * index, GstObject * writer,

    gchar ** writer_string, gpointer data);

static gboolean gst_index_gtype_resolver (GstIndex * index, GstObject * writer,

    gchar ** writer_string, gpointer data);

static void gst_index_add_entry (GstIndex * index, GstIndexEntry * entry);

static GstObject *parent_class = NULL;

static guint gst_index_signals[LAST_SIGNAL] = { 0 };

typedef struct

{

  GstIndexResolverMethod method;

  GstIndexResolver resolver;

  gpointer user_data;

}

ResolverEntry;

static const ResolverEntry resolvers[] = {

  {GST_INDEX_RESOLVER_CUSTOM, NULL, NULL},

  {GST_INDEX_RESOLVER_GTYPE, gst_index_gtype_resolver, NULL},

  {GST_INDEX_RESOLVER_PATH, gst_index_path_resolver, NULL},

};

#define GST_TYPE_INDEX_RESOLVER (gst_index_resolver_get_type())

static GType

gst_index_resolver_get_type (void)

{

  static GType index_resolver_type = 0;

  static const GEnumValue index_resolver[] = {

    {GST_INDEX_RESOLVER_CUSTOM, "GST_INDEX_RESOLVER_CUSTOM", "custom"},

    {GST_INDEX_RESOLVER_GTYPE, "GST_INDEX_RESOLVER_GTYPE", "gtype"},

    {GST_INDEX_RESOLVER_PATH, "GST_INDEX_RESOLVER_PATH", "path"},

    {0, NULL, NULL},

  };

  if (!index_resolver_type) {

    index_resolver_type =

        g_enum_register_static ("GstIndexResolver", index_resolver);

  }

  return index_resolver_type;

}

#ifdef __SYMBIAN32__

EXPORT_C

#endif

GType

gst_index_entry_get_type (void)

{

  static GType index_entry_type = 0;

  if (!index_entry_type) {

    index_entry_type = g_boxed_type_register_static ("GstIndexEntry",

        (GBoxedCopyFunc) gst_index_entry_copy,

        (GBoxedFreeFunc) gst_index_entry_free);

  }

  return index_entry_type;

}

#define _do_init \

{ \

  GST_DEBUG_CATEGORY_INIT (index_debug, "GST_INDEX", GST_DEBUG_BOLD, \

      "Generic indexing support"); \

}

G_DEFINE_TYPE_WITH_CODE (GstIndex, gst_index, GST_TYPE_OBJECT, _do_init);

static void

gst_index_class_init (GstIndexClass * klass)

{

  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);

  parent_class = g_type_class_peek_parent (klass);

  /**

   * GstIndex::entry-added

   * @gstindex: the object which received the signal.

   * @arg1: The entry added to the index.

   *

   * Is emitted when a new entry is added to the index.

   */

  gst_index_signals[ENTRY_ADDED] =

      g_signal_new ("entry-added", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,

      G_STRUCT_OFFSET (GstIndexClass, entry_added), NULL, NULL,

      gst_marshal_VOID__BOXED, G_TYPE_NONE, 1, GST_TYPE_INDEX_ENTRY);

  gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_index_set_property);

  gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_index_get_property);

  gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_index_finalize);

  g_object_class_install_property (gobject_class, ARG_RESOLVER,

      g_param_spec_enum ("resolver", "Resolver",

          "Select a predefined object to string mapper",

          GST_TYPE_INDEX_RESOLVER, GST_INDEX_RESOLVER_PATH,

          G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));

}

static void

gst_index_init (GstIndex * index)

{

  index->curgroup = gst_index_group_new (0);

  index->maxgroup = 0;

  index->groups = g_list_prepend (NULL, index->curgroup);

  index->writers = g_hash_table_new (NULL, NULL);

  index->last_id = 0;

  index->method = GST_INDEX_RESOLVER_PATH;

  index->resolver = resolvers[index->method].resolver;

  index->resolver_user_data = resolvers[index->method].user_data;

  GST_OBJECT_FLAG_SET (index, GST_INDEX_WRITABLE);

  GST_OBJECT_FLAG_SET (index, GST_INDEX_READABLE);

  GST_DEBUG ("created new index");

}

static void

gst_index_free_writer (gpointer key, gpointer value, gpointer user_data)

{

  GstIndexEntry *entry = (GstIndexEntry *) value;

  if (entry) {

    gst_index_entry_free (entry);

  }

}

static void

gst_index_finalize (GObject * object)

{

  GstIndex *index = GST_INDEX (object);

  if (index->groups) {

    g_list_foreach (index->groups, (GFunc) g_free, NULL);

    g_list_free (index->groups);

    index->groups = NULL;

  }

  if (index->writers) {

    g_hash_table_foreach (index->writers, gst_index_free_writer, NULL);

    g_hash_table_destroy (index->writers);

    index->writers = NULL;

  }

  if (index->filter_user_data && index->filter_user_data_destroy)

    index->filter_user_data_destroy (index->filter_user_data);

  if (index->resolver_user_data && index->resolver_user_data_destroy)

    index->resolver_user_data_destroy (index->resolver_user_data);

  G_OBJECT_CLASS (parent_class)->finalize (object);

}

static void

gst_index_set_property (GObject * object, guint prop_id,

    const GValue * value, GParamSpec * pspec)

{

  GstIndex *index;

  index = GST_INDEX (object);

  switch (prop_id) {

    case ARG_RESOLVER:

      index->method = g_value_get_enum (value);

      index->resolver = resolvers[index->method].resolver;

      index->resolver_user_data = resolvers[index->method].user_data;

      break;

    default:

      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);

      break;

  }

}

static void

gst_index_get_property (GObject * object, guint prop_id,

    GValue * value, GParamSpec * pspec)

{

  GstIndex *index;

  index = GST_INDEX (object);

  switch (prop_id) {

    case ARG_RESOLVER:

      g_value_set_enum (value, index->method);

      break;

    default:

      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);

      break;

  }

}

static GstIndexGroup *

gst_index_group_new (guint groupnum)

{

  GstIndexGroup *indexgroup = g_new (GstIndexGroup, 1);

  indexgroup->groupnum = groupnum;

  indexgroup->entries = NULL;

  indexgroup->certainty = GST_INDEX_UNKNOWN;

  indexgroup->peergroup = -1;

  GST_DEBUG ("created new index group %d", groupnum);

  return indexgroup;

}

/**

 * gst_index_new:

 *

 * Create a new tileindex object

 *

 * Returns: a new index object

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

GstIndex *

gst_index_new (void)

{

  GstIndex *index;

  index = g_object_new (gst_index_get_type (), NULL);

  return index;

}

/**

 * gst_index_commit:

 * @index: the index to commit

 * @id: the writer that commited the index

 *

 * Tell the index that the writer with the given id is done

 * with this index and is not going to write any more entries

 * to it.

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

void

gst_index_commit (GstIndex * index, gint id)

{

  GstIndexClass *iclass;

  iclass = GST_INDEX_GET_CLASS (index);

  if (iclass->commit)

    iclass->commit (index, id);

}

/**

 * gst_index_get_group:

 * @index: the index to get the current group from

 *

 * Get the id of the current group.

 *

 * Returns: the id of the current group.

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

gint

gst_index_get_group (GstIndex * index)

{

  return index->curgroup->groupnum;

}

/**

 * gst_index_new_group:

 * @index: the index to create the new group in

 *

 * Create a new group for the given index. It will be

 * set as the current group.

 *

 * Returns: the id of the newly created group.

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

gint

gst_index_new_group (GstIndex * index)

{

  index->curgroup = gst_index_group_new (++index->maxgroup);

  index->groups = g_list_append (index->groups, index->curgroup);

  GST_DEBUG ("created new group %d in index", index->maxgroup);

  return index->maxgroup;

}

/**

 * gst_index_set_group:

 * @index: the index to set the new group in

 * @groupnum: the groupnumber to set

 *

 * Set the current groupnumber to the given argument.

 *

 * Returns: TRUE if the operation succeeded, FALSE if the group

 * did not exist.

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

gboolean

gst_index_set_group (GstIndex * index, gint groupnum)

{

  GList *list;

  GstIndexGroup *indexgroup;

  /* first check for null change */

  if (groupnum == index->curgroup->groupnum)

    return TRUE;

  /* else search for the proper group */

  list = index->groups;

  while (list) {

    indexgroup = (GstIndexGroup *) (list->data);

    list = g_list_next (list);

    if (indexgroup->groupnum == groupnum) {

      index->curgroup = indexgroup;

      GST_DEBUG ("switched to index group %d", indexgroup->groupnum);

      return TRUE;

    }

  }

  /* couldn't find the group in question */

  GST_DEBUG ("couldn't find index group %d", groupnum);

  return FALSE;

}

/**

 * gst_index_set_certainty:

 * @index: the index to set the certainty on

 * @certainty: the certainty to set

 *

 * Set the certainty of the given index.

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

void

gst_index_set_certainty (GstIndex * index, GstIndexCertainty certainty)

{

  index->curgroup->certainty = certainty;

}

/**

 * gst_index_get_certainty:

 * @index: the index to get the certainty of

 *

 * Get the certainty of the given index.

 *

 * Returns: the certainty of the index.

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

GstIndexCertainty

gst_index_get_certainty (GstIndex * index)

{

  return index->curgroup->certainty;

}

/**

 * gst_index_set_filter:

 * @index: the index to register the filter on

 * @filter: the filter to register

 * @user_data: data passed to the filter function

 *

 * Lets the app register a custom filter function so that

 * it can select what entries should be stored in the index.

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

void

gst_index_set_filter (GstIndex * index,

    GstIndexFilter filter, gpointer user_data)

{

  g_return_if_fail (GST_IS_INDEX (index));

  gst_index_set_filter_full (index, filter, user_data, NULL);

}

/**

 * gst_index_set_filter_full:

 * @index: the index to register the filter on

 * @filter: the filter to register

 * @user_data: data passed to the filter function

 * @user_data_destroy: function to call when @user_data is unset

 *

 * Lets the app register a custom filter function so that

 * it can select what entries should be stored in the index.

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

void

gst_index_set_filter_full (GstIndex * index,

    GstIndexFilter filter, gpointer user_data, GDestroyNotify user_data_destroy)

{

  g_return_if_fail (GST_IS_INDEX (index));

  if (index->filter_user_data && index->filter_user_data_destroy)

    index->filter_user_data_destroy (index->filter_user_data);

  index->filter = filter;

  index->filter_user_data = user_data;

  index->filter_user_data_destroy = user_data_destroy;

}

/**

 * gst_index_set_resolver:

 * @index: the index to register the resolver on

 * @resolver: the resolver to register

 * @user_data: data passed to the resolver function

 *

 * Lets the app register a custom function to map index

 * ids to writer descriptions.

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

void

gst_index_set_resolver (GstIndex * index,

    GstIndexResolver resolver, gpointer user_data)

{

  gst_index_set_resolver_full (index, resolver, user_data, NULL);

}

/**

 * gst_index_set_resolver_full:

 * @index: the index to register the resolver on

 * @resolver: the resolver to register

 * @user_data: data passed to the resolver function

 * @user_data_destroy: destroy function for @user_data

 *

 * Lets the app register a custom function to map index

 * ids to writer descriptions.

 *

 * Since: 0.10.18

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

void