1 /* GStreamer encoding profiles library
2 * Copyright (C) 2009-2010 Edward Hervey <edward.hervey@collabora.co.uk>
3 * (C) 2009-2010 Nokia Corporation
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
18 * Boston, MA 02110-1301, USA.
21 #ifndef __GST_PROFILE_H__
22 #define __GST_PROFILE_H__
28 #include <gst/pbutils/pbutils-enumtypes.h>
29 #include <gst/pbutils/gstdiscoverer.h>
34 * The opaque base class object for all encoding profiles. This contains generic
35 * information like name, description, format and preset.
38 #define GST_TYPE_ENCODING_PROFILE \
39 (gst_encoding_profile_get_type ())
40 #define GST_ENCODING_PROFILE(obj) \
41 (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ENCODING_PROFILE, GstEncodingProfile))
42 #define GST_IS_ENCODING_PROFILE(obj) \
43 (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ENCODING_PROFILE))
44 typedef struct _GstEncodingProfile GstEncodingProfile;
45 typedef struct _GstEncodingProfileClass GstEncodingProfileClass;
46 GType gst_encoding_profile_get_type (void);
51 * GstEncodingContainerProfile:
53 * Encoding profiles for containers. Keeps track of a list of #GstEncodingProfile
55 #define GST_TYPE_ENCODING_CONTAINER_PROFILE \
56 (gst_encoding_container_profile_get_type ())
57 #define GST_ENCODING_CONTAINER_PROFILE(obj) \
58 (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ENCODING_CONTAINER_PROFILE, GstEncodingContainerProfile))
59 #define GST_IS_ENCODING_CONTAINER_PROFILE(obj) \
60 (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ENCODING_CONTAINER_PROFILE))
61 typedef struct _GstEncodingContainerProfile GstEncodingContainerProfile;
62 typedef struct _GstEncodingContainerProfileClass GstEncodingContainerProfileClass;
63 GType gst_encoding_container_profile_get_type (void);
68 * GstEncodingVideoProfile:
70 * Variant of #GstEncodingProfile for video streams, allows specifying the @pass.
72 #define GST_TYPE_ENCODING_VIDEO_PROFILE \
73 (gst_encoding_video_profile_get_type ())
74 #define GST_ENCODING_VIDEO_PROFILE(obj) \
75 (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ENCODING_VIDEO_PROFILE, GstEncodingVideoProfile))
76 #define GST_IS_ENCODING_VIDEO_PROFILE(obj) \
77 (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ENCODING_VIDEO_PROFILE))
78 typedef struct _GstEncodingVideoProfile GstEncodingVideoProfile;
79 typedef struct _GstEncodingVideoProfileClass GstEncodingVideoProfileClass;
80 GType gst_encoding_video_profile_get_type (void);
85 * GstEncodingAudioProfile:
87 * Variant of #GstEncodingProfile for audio streams.
89 #define GST_TYPE_ENCODING_AUDIO_PROFILE \
90 (gst_encoding_audio_profile_get_type ())
91 #define GST_ENCODING_AUDIO_PROFILE(obj) \
92 (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ENCODING_AUDIO_PROFILE, GstEncodingAudioProfile))
93 #define GST_IS_ENCODING_AUDIO_PROFILE(obj) \
94 (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ENCODING_AUDIO_PROFILE))
95 typedef struct _GstEncodingAudioProfile GstEncodingAudioProfile;
96 typedef struct _GstEncodingAudioProfileClass GstEncodingAudioProfileClass;
97 GType gst_encoding_audio_profile_get_type (void);
101 /* GstEncodingProfile API */
104 * gst_encoding_profile_unref:
105 * @profile: a #GstEncodingProfile
107 * Decreases the reference count of the @profile, possibly freeing the @profile.
109 #define gst_encoding_profile_unref(profile) (g_object_unref ((GObject*) profile))
112 * gst_encoding_profile_ref:
113 * @profile: a #GstEncodingProfile
115 * Increases the reference count of the @profile.
117 #define gst_encoding_profile_ref(profile) (g_object_ref ((GObject*) profile))
119 const gchar * gst_encoding_profile_get_name (GstEncodingProfile *profile);
120 void gst_encoding_profile_set_name (GstEncodingProfile *profile,
122 const gchar * gst_encoding_profile_get_description (GstEncodingProfile *profile);
123 void gst_encoding_profile_set_description (GstEncodingProfile *profile,
124 const gchar *description);
125 GstCaps * gst_encoding_profile_get_format (GstEncodingProfile *profile);
126 void gst_encoding_profile_set_format (GstEncodingProfile *profile,
128 const gchar * gst_encoding_profile_get_preset (GstEncodingProfile *profile);
129 const gchar * gst_encoding_profile_get_preset_name (GstEncodingProfile *profile);
130 void gst_encoding_profile_set_preset (GstEncodingProfile *profile,
131 const gchar *preset);
132 guint gst_encoding_profile_get_presence (GstEncodingProfile *profile);
133 void gst_encoding_profile_set_presence (GstEncodingProfile *profile,
135 void gst_encoding_profile_set_preset_name (GstEncodingProfile * profile,
136 const gchar * preset_name);
137 GstCaps * gst_encoding_profile_get_restriction (GstEncodingProfile *profile);
138 void gst_encoding_profile_set_restriction (GstEncodingProfile *profile,
139 GstCaps *restriction);
141 gboolean gst_encoding_profile_is_equal (GstEncodingProfile *a,
142 GstEncodingProfile *b);
143 GstCaps * gst_encoding_profile_get_input_caps (GstEncodingProfile *profile);
144 const gchar * gst_encoding_profile_get_type_nick (GstEncodingProfile *profile);
146 const gchar * gst_encoding_profile_get_file_extension (GstEncodingProfile * profile);
148 GstEncodingProfile * gst_encoding_profile_find (const gchar *targetname,
149 const gchar *profilename,
150 const gchar *category);
152 /* GstEncodingContainerProfile API */
153 gboolean gst_encoding_container_profile_add_profile (GstEncodingContainerProfile *container,
154 GstEncodingProfile *profile);
155 gboolean gst_encoding_container_profile_contains_profile (GstEncodingContainerProfile * container,
156 GstEncodingProfile *profile);
157 const GList * gst_encoding_container_profile_get_profiles (GstEncodingContainerProfile *profile);
160 GstEncodingContainerProfile * gst_encoding_container_profile_new (const gchar *name,
161 const gchar *description,
163 const gchar *preset);
166 /* Invidual stream encodingprofile API */
167 GstEncodingVideoProfile * gst_encoding_video_profile_new (GstCaps *format,
169 GstCaps *restriction,
171 GstEncodingAudioProfile * gst_encoding_audio_profile_new (GstCaps *format,
173 GstCaps *restriction,
176 guint gst_encoding_video_profile_get_pass (GstEncodingVideoProfile *prof);
177 gboolean gst_encoding_video_profile_get_variableframerate (GstEncodingVideoProfile *prof);
179 void gst_encoding_video_profile_set_pass (GstEncodingVideoProfile *prof,
181 void gst_encoding_video_profile_set_variableframerate (GstEncodingVideoProfile *prof,
182 gboolean variableframerate);
184 GstEncodingProfile * gst_encoding_profile_from_discoverer (GstDiscovererInfo *info);
188 #endif /* __GST_PROFILE_H__ */