gstreamer/subprojects/gst-plugins-base/gst-libs/gst/pbutils/descriptions.h

114 lines
4.1 KiB
C

/* GStreamer base utils library source/sink/codec description support
* Copyright (C) 2006 Tim-Philipp Müller <tim centricular net>
*
* 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., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef __GST_PB_UTILS_DESCRIPTIONS_H__
#define __GST_PB_UTILS_DESCRIPTIONS_H__
#include <gst/gsttaglist.h>
#include <gst/gstcaps.h>
#include <gst/pbutils/pbutils-prelude.h>
G_BEGIN_DECLS
/**
* GstPbUtilsCapsDescriptionFlags:
* @GST_PBUTILS_CAPS_DESCRIPTION_FLAG_CONTAINER: Caps describe a container format.
* @GST_PBUTILS_CAPS_DESCRIPTION_FLAG_AUDIO: Caps describe an audio format, or a
* container format that can store audio.
* @GST_PBUTILS_CAPS_DESCRIPTION_FLAG_VIDEO: Caps describe an video format, or a
* container format that can store video.
* @GST_PBUTILS_CAPS_DESCRIPTION_FLAG_IMAGE: Caps describe an image format, or a
* container format that can store image.
* @GST_PBUTILS_CAPS_DESCRIPTION_FLAG_SUBTITLE: Caps describe an subtitle format, or a
* container format that can store subtitles.
* @GST_PBUTILS_CAPS_DESCRIPTION_FLAG_TAG: Container format is a tags container.
* @GST_PBUTILS_CAPS_DESCRIPTION_FLAG_GENERIC: Container format can store any kind of
* stream type.
* @GST_PBUTILS_CAPS_DESCRIPTION_FLAG_METADATA: Caps describe a metadata
* format, or a container format that can store metadata.
*
* Flags that are returned by gst_pb_utils_get_caps_description_flags() and
* describe the format of the caps.
*
* Since: 1.20
*/
typedef enum {
GST_PBUTILS_CAPS_DESCRIPTION_FLAG_CONTAINER = 1 << 0,
GST_PBUTILS_CAPS_DESCRIPTION_FLAG_AUDIO = 1 << 1,
GST_PBUTILS_CAPS_DESCRIPTION_FLAG_VIDEO = 1 << 2,
GST_PBUTILS_CAPS_DESCRIPTION_FLAG_IMAGE = 1 << 3,
GST_PBUTILS_CAPS_DESCRIPTION_FLAG_SUBTITLE = 1 << 4,
GST_PBUTILS_CAPS_DESCRIPTION_FLAG_TAG = 1 << 5,
GST_PBUTILS_CAPS_DESCRIPTION_FLAG_GENERIC = 1 << 6,
/**
* GST_PBUTILS_CAPS_DESCRIPTION_FLAG_METADATA:
*
* Caps describe a metadata format, or a container format that can store
* metadata.
*
* Since: 1.22
*/
GST_PBUTILS_CAPS_DESCRIPTION_FLAG_METADATA = 1 << 7,
} GstPbUtilsCapsDescriptionFlags;
/*
* functions for use by demuxers or decoders to add CODEC tags to tag lists
* from caps
*/
GST_PBUTILS_API
gboolean gst_pb_utils_add_codec_description_to_tag_list (GstTagList * taglist,
const gchar * codec_tag,
const GstCaps * caps);
GST_PBUTILS_API
gchar * gst_pb_utils_get_codec_description (const GstCaps * caps);
/*
* functions mainly used by the missing plugins message creation functions to
* find descriptions of what exactly is missing
*/
GST_PBUTILS_API
gchar * gst_pb_utils_get_source_description (const gchar * protocol);
GST_PBUTILS_API
gchar * gst_pb_utils_get_sink_description (const gchar * protocol);
GST_PBUTILS_API
gchar * gst_pb_utils_get_decoder_description (const GstCaps * caps);
GST_PBUTILS_API
gchar * gst_pb_utils_get_encoder_description (const GstCaps * caps);
GST_PBUTILS_API
gchar * gst_pb_utils_get_element_description (const gchar * factory_name);
GST_PBUTILS_API
GstPbUtilsCapsDescriptionFlags gst_pb_utils_get_caps_description_flags (const GstCaps * caps);
GST_PBUTILS_API
gchar * gst_pb_utils_get_file_extension_from_caps (const GstCaps *caps);
G_END_DECLS
#endif /* __GST_PB_UTILS_DESCRIPTIONS_H__ */