gstreamer/gst-libs/gst/pbutils/encoding-profile.h

/* GStreamer encoding profiles library
 * Copyright (C) 2009-2010 Edward Hervey <edward.hervey@collabora.co.uk>
 *           (C) 2009-2010 Nokia Corporation
 *
 * 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.
 */

#ifndef __GST_PROFILE_H__
#define __GST_PROFILE_H__

#include <gst/gst.h>

G_BEGIN_DECLS

#include <gst/pbutils/pbutils-enumtypes.h>

/**
 * GstEncodingProfile:
 *
 * The opaque base class object for all encoding profiles. This contains generic
 * information like name, description, format and preset.
 *
 * Since: 0.10.32
 */

#define GST_TYPE_ENCODING_PROFILE			\
  (gst_encoding_profile_get_type ())
#define GST_ENCODING_PROFILE(obj)			\
  (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ENCODING_PROFILE, GstEncodingProfile))
#define GST_IS_ENCODING_PROFILE(obj)			\
  (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ENCODING_PROFILE))
typedef struct _GstEncodingProfile GstEncodingProfile;
typedef GstMiniObjectClass GstEncodingProfileClass;
GType gst_encoding_profile_get_type (void);



/**
 * GstEncodingContainerProfile:
 *
 * Encoding profiles for containers. Keeps track of a list of #GstEncodingProfile
 *
 * Since: 0.10.32
 */
#define GST_TYPE_ENCODING_CONTAINER_PROFILE			\
  (gst_encoding_container_profile_get_type ())
#define GST_ENCODING_CONTAINER_PROFILE(obj)			\
  (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ENCODING_CONTAINER_PROFILE, GstEncodingContainerProfile))
#define GST_IS_ENCODING_CONTAINER_PROFILE(obj)			\
  (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ENCODING_CONTAINER_PROFILE))
typedef struct _GstEncodingContainerProfile GstEncodingContainerProfile;
typedef GstEncodingProfileClass GstEncodingContainerProfileClass;
GType gst_encoding_container_profile_get_type (void);



/**
 * GstEncodingVideoProfile:
 *
 * Variant of #GstEncodingProfile for video streams, allows specifying the @pass.
 *
 * Since: 0.10.32
 */
#define GST_TYPE_ENCODING_VIDEO_PROFILE			\
  (gst_encoding_video_profile_get_type ())
#define GST_ENCODING_VIDEO_PROFILE(obj)			\
  (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ENCODING_VIDEO_PROFILE, GstEncodingVideoProfile))
#define GST_IS_ENCODING_VIDEO_PROFILE(obj)			\
  (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ENCODING_VIDEO_PROFILE))
typedef struct _GstEncodingVideoProfile GstEncodingVideoProfile;
typedef GstEncodingProfileClass GstEncodingVideoProfileClass;
GType gst_encoding_video_profile_get_type (void);



/**
 * GstEncodingAudioProfile:
 *
 * Variant of #GstEncodingProfile for audio streams.
 *
 * Since: 0.10.32
 */
#define GST_TYPE_ENCODING_AUDIO_PROFILE			\
  (gst_encoding_audio_profile_get_type ())
#define GST_ENCODING_AUDIO_PROFILE(obj)			\
  (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ENCODING_AUDIO_PROFILE, GstEncodingAudioProfile))
#define GST_IS_ENCODING_AUDIO_PROFILE(obj)			\
  (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ENCODING_AUDIO_PROFILE))
typedef struct _GstEncodingAudioProfile GstEncodingAudioProfile;
typedef GstEncodingProfileClass GstEncodingAudioProfileClass;
GType gst_encoding_audio_profile_get_type (void);



/* GstEncodingProfile API */

/**
 * gst_encoding_profile_unref:
 * @profile: a #GstEncodingProfile
 *
 * Decreases the reference count of the @profile, possibly freeing the @profile.
 *
 * Since: 0.10.32
 */
#define gst_encoding_profile_unref(profile) (gst_mini_object_unref ((GstMiniObject*) profile))

/**
 * gst_encoding_profile_ref:
 * @profile: a #GstEncodingProfile
 *
 * Increases the reference count of the @profile.
 *
 * Since: 0.10.32
 */
#define gst_encoding_profile_ref(profile) (gst_mini_object_ref ((GstMiniObject*) profile))

const gchar *	gst_encoding_profile_get_name(GstEncodingProfile *profile);
const gchar *	gst_encoding_profile_get_description(GstEncodingProfile *profile);
const GstCaps *	gst_encoding_profile_get_format(GstEncodingProfile *profile);
const gchar *	gst_encoding_profile_get_preset(GstEncodingProfile *profile);
guint	gst_encoding_profile_get_presence(GstEncodingProfile *profile);
const GstCaps *	gst_encoding_profile_get_restriction(GstEncodingProfile *profile);

void	gst_encoding_profile_set_name(GstEncodingProfile *profile, const gchar *name);
void	gst_encoding_profile_set_description(GstEncodingProfile *profile, const gchar *description);
void	gst_encoding_profile_set_format(GstEncodingProfile *profile, GstCaps *format);
void	gst_encoding_profile_set_preset(GstEncodingProfile *profile, const gchar *preset);
void	gst_encoding_profile_set_restriction(GstEncodingProfile *profile, GstCaps *restriction);
void	gst_encoding_profile_set_presence(GstEncodingProfile *profile, guint presence);

gboolean gst_encoding_profile_is_equal (GstEncodingProfile *a,
					GstEncodingProfile *b);
GstCaps * gst_encoding_profile_get_output_caps (GstEncodingProfile *profile);

const gchar *gst_encoding_profile_get_type_nick (GstEncodingProfile *profile);

/* GstEncodingContainerProfile API */
gboolean  gst_encoding_container_profile_add_profile       (GstEncodingContainerProfile *container,
							    GstEncodingProfile *profile);
gboolean  gst_encoding_container_profile_contains_profile  (GstEncodingContainerProfile * container,
							    GstEncodingProfile *profile);
const GList *gst_encoding_container_profile_get_profiles   (GstEncodingContainerProfile *profile);


GstEncodingContainerProfile *  gst_encoding_container_profile_new (const gchar *name,
								   const gchar *description,
								   GstCaps *format,
								   const gchar *preset);


/* Invidual stream encodingprofile API */
GstEncodingVideoProfile * gst_encoding_video_profile_new (GstCaps *format,
							  const gchar *preset,
							  GstCaps *restriction,
							  guint presence);
GstEncodingAudioProfile * gst_encoding_audio_profile_new (GstCaps *format,
							  const gchar *preset,
							  GstCaps *restriction,
							  guint presence);

guint    gst_encoding_video_profile_get_pass              (GstEncodingVideoProfile *prof);
gboolean gst_encoding_video_profile_get_variableframerate (GstEncodingVideoProfile *prof);

void     gst_encoding_video_profile_set_pass              (GstEncodingVideoProfile *prof,
							   guint pass);
void     gst_encoding_video_profile_set_variableframerate (GstEncodingVideoProfile *prof,
							   gboolean variableframerate);

G_END_DECLS

#endif /* __GST_PROFILE_H__ */