struct GstIndex

struct GstIndex;

struct GstIndexEntry

struct GstIndexEntry {

  GstIndexEntryType	 type;
  gint			 id;

  union {
    struct {
      gchar		*description;
    } id;
    struct {
      gint		 nassocs;
      GstIndexAssociation 
	      		*assocs;
      GstAssocFlags	 flags;
    } assoc;
    struct {
      gchar		*key;
      GType		 type;
      gpointer		 object;
    } object;
    struct {
      GstFormat		 format;
      gchar		*key;
    } format;
  } data;
};

The basic element of an index.

struct GstIndexGroup

struct GstIndexGroup {

  /* unique ID of group in index */
  gint groupnum;

  /* list of entries */
  GList *entries;

  /* the certainty level of the group */
  GstIndexCertainty certainty;

  /* peer group that contains more certain entries */
  gint peergroup;
};

A group of related entries in an index.

enum GstIndexCertainty

typedef enum {
  GST_INDEX_UNKNOWN,
  GST_INDEX_CERTAIN,
  GST_INDEX_FUZZY
} GstIndexCertainty;

The certainty of a group in the index.

enum GstIndexEntryType

typedef enum {
  GST_INDEX_ENTRY_ID,
  GST_INDEX_ENTRY_ASSOCIATION,
  GST_INDEX_ENTRY_OBJECT,
  GST_INDEX_ENTRY_FORMAT
} GstIndexEntryType;

The different types of entries in the index.

enum GstIndexLookupMethod

typedef enum {
  GST_INDEX_LOOKUP_EXACT,
  GST_INDEX_LOOKUP_BEFORE,
  GST_INDEX_LOOKUP_AFTER
} GstIndexLookupMethod;

Specify the method to find an index entry in the index.

GST_INDEX_NASSOCS()

#define GST_INDEX_NASSOCS(entry)		((entry)->data.assoc.nassocs)

Get the number of associations in the entry.

GST_INDEX_ASSOC_FLAGS()

#define GST_INDEX_ASSOC_FLAGS(entry)		((entry)->data.assoc.flags)

Get the flags for this entry

GST_INDEX_ASSOC_FORMAT()

#define GST_INDEX_ASSOC_FORMAT(entry,i)		((entry)->data.assoc.assocs[(i)].format)

Get the i-th format of the entry.

GST_INDEX_ASSOC_VALUE()

#define GST_INDEX_ASSOC_VALUE(entry,i)		((entry)->data.assoc.assocs[(i)].value)

Get the i-th value of the entry.

struct GstIndexAssociation

struct GstIndexAssociation {

  GstFormat 	format;
  gint64 	value;
};

An association in an entry.

enum GstAssocFlags

typedef enum {
  GST_ASSOCIATION_FLAG_NONE 	= 0,
  GST_ASSOCIATION_FLAG_KEY_UNIT = (1 << 0),
  GST_ASSOCIATION_FLAG_DELTA_UNIT = (1 << 1),

  /* new flags should start here */
  GST_ASSOCIATION_FLAG_LAST	= (1 << 8)
} GstAssocFlags;

flags for an association entry

GST_INDEX_FORMAT_FORMAT()

#define GST_INDEX_FORMAT_FORMAT(entry)		((entry)->data.format.format)

Get the format of the format entry

GST_INDEX_FORMAT_KEY()

#define GST_INDEX_FORMAT_KEY(entry)		((entry)->data.format.key)

Get the key of the format entry

GST_INDEX_ID_INVALID

#define GST_INDEX_ID_INVALID			(-1)

An invalid index id

GST_INDEX_ID_DESCRIPTION()

#define GST_INDEX_ID_DESCRIPTION(entry)		((entry)->data.id.description)

Get the description of the id entry

GstIndexFilter ()

gboolean    (*GstIndexFilter)               (GstIndex *index,
                                             GstIndexEntry *entry);

Function to filter out entries in the index.

enum GstIndexResolverMethod

typedef enum {
  GST_INDEX_RESOLVER_CUSTOM,
  GST_INDEX_RESOLVER_GTYPE,
  GST_INDEX_RESOLVER_PATH
} GstIndexResolverMethod;

The method used to resolve index writers

GstIndexResolver ()

gboolean    (*GstIndexResolver)             (GstIndex *index,
                                             GstObject *writer,
                                             gchar **writer_string,
                                             gpointer user_data);

Function to resolve ids to writer descriptions.

enum GstIndexFlags

typedef enum {
  GST_INDEX_WRITABLE 		= GST_OBJECT_FLAG_LAST,	
  GST_INDEX_READABLE,	

  GST_INDEX_FLAG_LAST 		= GST_OBJECT_FLAG_LAST + 8
} GstIndexFlags;

Flags for this index

GST_INDEX_IS_READABLE()

#define GST_INDEX_IS_READABLE(obj)    (GST_FLAG_IS_SET (obj, GST_INDEX_READABLE))

Check if the index can be read from

GST_INDEX_IS_WRITABLE()

#define GST_INDEX_IS_WRITABLE(obj)    (GST_FLAG_IS_SET (obj, GST_INDEX_WRITABLE))

Check if the index can be written to

gst_index_new ()

GstIndex*   gst_index_new                   (void);

Create a new tileindex object

gst_index_commit ()

void        gst_index_commit                (GstIndex *index,
                                             gint id);

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.

gst_index_get_group ()

gint        gst_index_get_group             (GstIndex *index);

Get the id of the current group.

gst_index_new_group ()

gint        gst_index_new_group             (GstIndex *index);

Create a new group for the given index. It will be set as the current group.

gst_index_set_group ()

gboolean    gst_index_set_group             (GstIndex *index,
                                             gint groupnum);

Set the current groupnumber to the given argument.

gst_index_set_certainty ()

void        gst_index_set_certainty         (GstIndex *index,
                                             GstIndexCertainty certainty);

Set the certainty of the given index.

gst_index_get_certainty ()

GstIndexCertainty gst_index_get_certainty   (GstIndex *index);

Get the certainty of the given index.

gst_index_set_filter ()

void        gst_index_set_filter            (GstIndex *index,
                                             GstIndexFilter filter,
                                             gpointer user_data);

Lets the app register a custom filter function so that it can select what entries should be stored in the index.

gst_index_set_resolver ()

void        gst_index_set_resolver          (GstIndex *index,
                                             GstIndexResolver resolver,
                                             gpointer user_data);

Lets the app register a custom function to map index ids to writer descriptions.

gst_index_get_writer_id ()

gboolean    gst_index_get_writer_id         (GstIndex *index,
                                             GstObject *writer,
                                             gint *id);

Before entries can be added to the index, a writer should obtain a unique id. The methods to add new entries to the index require this id as an argument.

The application can implement a custom function to map the writer object to a string. That string will be used to register or look up an id in the index.

gst_index_add_format ()

GstIndexEntry* gst_index_add_format         (GstIndex *index,
                                             gint id,
                                             GstFormat format);

Adds a format entry into the index. This function is used to map dynamic GstFormat ids to their original format key.

gst_index_add_association ()

GstIndexEntry* gst_index_add_association    (GstIndex *index,
                                             gint id,
                                             GstAssocFlags flags,
                                             GstFormat format,
                                             gint64 value,
                                             ...);

Associate given format/value pairs with each other. Be sure to pass gint64 values to this functions varargs, you might want to use a gint64 cast to be sure.

gst_index_add_object ()

GstIndexEntry* gst_index_add_object         (GstIndex *index,
                                             gint id,
                                             gchar *key,
                                             GType type,
                                             gpointer object);

Add the given object to the index with the given key.

gst_index_add_id ()

GstIndexEntry* gst_index_add_id             (GstIndex *index,
                                             gint id,
                                             gchar *description);

Add an id entry into the index.

gst_index_get_assoc_entry ()

GstIndexEntry* gst_index_get_assoc_entry    (GstIndex *index,
                                             gint id,
                                             GstIndexLookupMethod method,
                                             GstAssocFlags flags,
                                             GstFormat format,
                                             gint64 value);

Finds the given format/value in the index

gst_index_get_assoc_entry_full ()

GstIndexEntry* gst_index_get_assoc_entry_full
                                            (GstIndex *index,
                                             gint id,
                                             GstIndexLookupMethod method,
                                             GstAssocFlags flags,
                                             GstFormat format,
                                             gint64 value,
                                             GCompareDataFunc func,
                                             gpointer user_data);

Finds the given format/value in the index with the given compare function and user_data.

gst_index_entry_get_type ()

GType       gst_index_entry_get_type        (void);

gst_index_entry_copy ()

GstIndexEntry* gst_index_entry_copy         (GstIndexEntry *entry);

Copies an entry and returns the result.

gst_index_entry_free ()

void        gst_index_entry_free            (GstIndexEntry *entry);

Free the memory used by the given entry.

gst_index_entry_assoc_map ()

gboolean    gst_index_entry_assoc_map       (GstIndexEntry *entry,
                                             GstFormat format,
                                             gint64 *value);

Gets alternative formats associated with the indexentry.

The "entry-added" signal

void        user_function                  (GstIndex *gstindex,
                                            GstIndexEntry *arg1,
                                            gpointer user_data);

Is emited when a new entry is added to the index.