gstreamer/ges/ges-uri-clip.c
Christoph Reiter a66e674649 Include class related section documentation in the gir file.
g-ir-scanner includes section docs as class/interface docs if the section name is equal to the lowercase type name.
Since all the documentation is in section blocks, rename them to match the type names.

https://bugzilla.gnome.org/show_bug.cgi?id=727776
2014-04-07 22:13:25 +02:00

495 lines
14 KiB
C

/* GStreamer Editing Services
* Copyright (C) 2009 Edward Hervey <edward.hervey@collabora.co.uk>
* 2009 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., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
/**
* SECTION:gestimelinefilesource
* @short_description: An object for manipulating media files in a GESTimeline
*
* Represents all the output streams from a particular uri. It is assumed that
* the URI points to a file of some type.
*/
#include "ges-internal.h"
#include "ges-uri-clip.h"
#include "ges-source-clip.h"
#include "ges-video-uri-source.h"
#include "ges-audio-uri-source.h"
#include "ges-uri-asset.h"
#include "ges-track-element-asset.h"
#include "ges-extractable.h"
#include "ges-image-source.h"
#include "ges-audio-test-source.h"
#include "ges-multi-file-source.h"
static void ges_extractable_interface_init (GESExtractableInterface * iface);
#define parent_class ges_uri_clip_parent_class
G_DEFINE_TYPE_WITH_CODE (GESUriClip, ges_uri_clip,
GES_TYPE_SOURCE_CLIP,
G_IMPLEMENT_INTERFACE (GES_TYPE_EXTRACTABLE,
ges_extractable_interface_init));
GESExtractableInterface *parent_extractable_iface;
struct _GESUriClipPrivate
{
gchar *uri;
gboolean mute;
gboolean is_image;
};
enum
{
PROP_0,
PROP_URI,
PROP_MUTE,
PROP_IS_IMAGE,
PROP_SUPPORTED_FORMATS,
};
static GList *ges_uri_clip_create_track_elements (GESClip *
clip, GESTrackType type);
static GESTrackElement
* ges_uri_clip_create_track_element (GESClip * clip, GESTrackType type);
void ges_uri_clip_set_uri (GESUriClip * self, gchar * uri);
gboolean
filesource_set_max_duration (GESTimelineElement * element,
GstClockTime maxduration);
static void
ges_uri_clip_get_property (GObject * object, guint property_id,
GValue * value, GParamSpec * pspec)
{
GESUriClipPrivate *priv = GES_URI_CLIP (object)->priv;
switch (property_id) {
case PROP_URI:
g_value_set_string (value, priv->uri);
break;
case PROP_MUTE:
g_value_set_boolean (value, priv->mute);
break;
case PROP_IS_IMAGE:
g_value_set_boolean (value, priv->is_image);
break;
case PROP_SUPPORTED_FORMATS:
g_value_set_flags (value,
ges_clip_get_supported_formats (GES_CLIP (object)));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
}
}
static void
ges_uri_clip_set_property (GObject * object, guint property_id,
const GValue * value, GParamSpec * pspec)
{
GESUriClip *uriclip = GES_URI_CLIP (object);
switch (property_id) {
case PROP_URI:
ges_uri_clip_set_uri (uriclip, g_value_dup_string (value));
break;
case PROP_MUTE:
ges_uri_clip_set_mute (uriclip, g_value_get_boolean (value));
break;
case PROP_IS_IMAGE:
ges_uri_clip_set_is_image (uriclip, g_value_get_boolean (value));
break;
case PROP_SUPPORTED_FORMATS:
ges_clip_set_supported_formats (GES_CLIP (uriclip),
g_value_get_flags (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
}
}
static void
ges_uri_clip_finalize (GObject * object)
{
GESUriClipPrivate *priv = GES_URI_CLIP (object)->priv;
if (priv->uri)
g_free (priv->uri);
G_OBJECT_CLASS (parent_class)->finalize (object);
}
static void
ges_uri_clip_class_init (GESUriClipClass * klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
GESClipClass *timobj_class = GES_CLIP_CLASS (klass);
GESTimelineElementClass *element_class = GES_TIMELINE_ELEMENT_CLASS (klass);
g_type_class_add_private (klass, sizeof (GESUriClipPrivate));
object_class->get_property = ges_uri_clip_get_property;
object_class->set_property = ges_uri_clip_set_property;
object_class->finalize = ges_uri_clip_finalize;
/**
* GESUriClip:uri:
*
* The location of the file/resource to use.
*/
g_object_class_install_property (object_class, PROP_URI,
g_param_spec_string ("uri", "URI", "uri of the resource", NULL,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
/**
* GESUriClip:mute:
*
* Whether the sound will be played or not.
*/
g_object_class_install_property (object_class, PROP_MUTE,
g_param_spec_boolean ("mute", "Mute", "Mute audio track",
FALSE, G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
/**
* GESUriClip:is-image:
*
* Whether this filesource represents a still image or not. This must be set
* before create_track_elements is called.
*/
g_object_class_install_property (object_class, PROP_IS_IMAGE,
g_param_spec_boolean ("is-image", "Is still image",
"Whether the clip represents a still image or not",
FALSE, G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
/* Redefine the supported formats property so the default value is UNKNOWN
* and not AUDIO | VIDEO */
g_object_class_install_property (object_class, PROP_SUPPORTED_FORMATS,
g_param_spec_flags ("supported-formats",
"Supported formats", "Formats supported by the file",
GES_TYPE_TRACK_TYPE, GES_TRACK_TYPE_UNKNOWN,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
element_class->set_max_duration = filesource_set_max_duration;
timobj_class->create_track_elements = ges_uri_clip_create_track_elements;
timobj_class->create_track_element = ges_uri_clip_create_track_element;
}
static gchar *
extractable_check_id (GType type, const gchar * id)
{
const gchar *testing_directory;
testing_directory = g_getenv ("GES_TESTING_ASSETS_DIRECTORY");
/* Testing purposes, user can specify a directory to look up for script */
if (testing_directory != NULL) {
gchar **tokens;
gchar *location = NULL;
guint i;
GST_DEBUG ("Checking if the testing directory contains needed media");
tokens = g_strsplit (id, "media", 2);
for (i = 0; tokens[i]; i++)
if (i == 1)
location = tokens[1];
if (location == NULL)
GST_WARNING ("The provided id doesn't have a media subdirectory");
else {
gchar *actual_id =
g_strconcat ("file://", testing_directory, "/media/", location, NULL);
if (gst_uri_is_valid (actual_id)) {
GST_DEBUG ("Returning new id %s instead of id %s", actual_id, id);
g_strfreev (tokens);
return (actual_id);
} else
GST_WARNING ("The constructed id %s was not valid, trying %s anyway",
actual_id, id);
g_free (actual_id);
}
g_strfreev (tokens);
}
if (gst_uri_is_valid (id))
return g_strdup (id);
return NULL;
}
static GParameter *
extractable_get_parameters_from_id (const gchar * id, guint * n_params)
{
GParameter *params = g_new0 (GParameter, 2);
params[0].name = "uri";
g_value_init (&params[0].value, G_TYPE_STRING);
g_value_set_string (&params[0].value, id);
*n_params = 1;
return params;
}
static gchar *
extractable_get_id (GESExtractable * self)
{
return g_strdup (GES_URI_CLIP (self)->priv->uri);
}
static void
extractable_set_asset (GESExtractable * self, GESAsset * asset)
{
GESUriClip *uriclip = GES_URI_CLIP (self);
GESUriClipAsset *filesource_asset = GES_URI_CLIP_ASSET (asset);
GESClip *clip = GES_CLIP (self);
if (GST_CLOCK_TIME_IS_VALID (GES_TIMELINE_ELEMENT_DURATION (clip)) == FALSE)
_set_duration0 (GES_TIMELINE_ELEMENT (uriclip),
ges_uri_clip_asset_get_duration (filesource_asset));
ges_timeline_element_set_max_duration (GES_TIMELINE_ELEMENT (uriclip),
ges_uri_clip_asset_get_duration (filesource_asset));
ges_uri_clip_set_is_image (uriclip,
ges_uri_clip_asset_is_image (filesource_asset));
if (ges_clip_get_supported_formats (clip) == GES_TRACK_TYPE_UNKNOWN) {
ges_clip_set_supported_formats (clip,
ges_clip_asset_get_supported_formats
(GES_CLIP_ASSET (filesource_asset)));
}
GES_TIMELINE_ELEMENT (uriclip)->asset = asset;
}
static void
ges_extractable_interface_init (GESExtractableInterface * iface)
{
iface->asset_type = GES_TYPE_URI_CLIP_ASSET;
iface->check_id = (GESExtractableCheckId) extractable_check_id;
iface->get_parameters_from_id = extractable_get_parameters_from_id;
iface->get_id = extractable_get_id;
iface->set_asset = extractable_set_asset;
}
static void
ges_uri_clip_init (GESUriClip * self)
{
self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
GES_TYPE_URI_CLIP, GESUriClipPrivate);
/* Setting the duration to -1 by default. */
GES_TIMELINE_ELEMENT (self)->duration = GST_CLOCK_TIME_NONE;
}
/**
* ges_uri_clip_set_mute:
* @self: the #GESUriClip on which to mute or unmute the audio track
* @mute: %TRUE to mute @self audio track, %FALSE to unmute it
*
* Sets whether the audio track of this clip is muted or not.
*
*/
void
ges_uri_clip_set_mute (GESUriClip * self, gboolean mute)
{
GList *tmp;
GST_DEBUG ("self:%p, mute:%d", self, mute);
self->priv->mute = mute;
/* Go over tracked objects, and update 'active' status on all audio objects */
for (tmp = GES_CONTAINER_CHILDREN (self); tmp; tmp = g_list_next (tmp)) {
GESTrackElement *trackelement = (GESTrackElement *) tmp->data;
if (ges_track_element_get_track (trackelement)->type ==
GES_TRACK_TYPE_AUDIO)
ges_track_element_set_active (trackelement, !mute);
}
}
gboolean
filesource_set_max_duration (GESTimelineElement * element,
GstClockTime maxduration)
{
if (_DURATION (element) == GST_CLOCK_TIME_NONE || _DURATION (element) == 0)
/* If we don't have a valid duration, use the max duration */
_set_duration0 (element, maxduration - _INPOINT (element));
return
GES_TIMELINE_ELEMENT_CLASS (parent_class)->set_max_duration (element,
maxduration);
}
/**
* ges_uri_clip_set_is_image:
* @self: the #GESUriClip
* @is_image: %TRUE if @self is a still image, %FALSE otherwise
*
* Sets whether the clip is a still image or not.
*/
void
ges_uri_clip_set_is_image (GESUriClip * self, gboolean is_image)
{
self->priv->is_image = is_image;
}
/**
* ges_uri_clip_is_muted:
* @self: the #GESUriClip
*
* Lets you know if the audio track of @self is muted or not.
*
* Returns: %TRUE if the audio track of @self is muted, %FALSE otherwise.
*/
gboolean
ges_uri_clip_is_muted (GESUriClip * self)
{
return self->priv->mute;
}
/**
* ges_uri_clip_is_image:
* @self: the #GESUriClip
*
* Lets you know if @self is an image or not.
*
* Returns: %TRUE if @self is a still image %FALSE otherwise.
*/
gboolean
ges_uri_clip_is_image (GESUriClip * self)
{
return self->priv->is_image;
}
/**
* ges_uri_clip_get_uri:
* @self: the #GESUriClip
*
* Get the location of the resource.
*
* Returns: The location of the resource.
*/
const gchar *
ges_uri_clip_get_uri (GESUriClip * self)
{
return self->priv->uri;
}
static GList *
ges_uri_clip_create_track_elements (GESClip * clip, GESTrackType type)
{
GList *res = NULL;
const GList *tmp, *stream_assets;
g_return_val_if_fail (GES_TIMELINE_ELEMENT (clip)->asset, NULL);
stream_assets =
ges_uri_clip_asset_get_stream_assets (GES_URI_CLIP_ASSET
(GES_TIMELINE_ELEMENT (clip)->asset));
for (tmp = stream_assets; tmp; tmp = tmp->next) {
GESTrackElementAsset *asset = GES_TRACK_ELEMENT_ASSET (tmp->data);
if (ges_track_element_asset_get_track_type (asset) == type)
res = g_list_prepend (res, ges_asset_extract (GES_ASSET (asset), NULL));
}
return res;
}
static GESTrackElement *
ges_uri_clip_create_track_element (GESClip * clip, GESTrackType type)
{
GESUriClipPrivate *priv = GES_URI_CLIP (clip)->priv;
GESTrackElement *res = NULL;
if (g_str_has_prefix (priv->uri, GES_MULTI_FILE_URI_PREFIX)) {
GST_DEBUG ("Creating a GESMultiFileSource for %s", priv->uri);
res = (GESTrackElement *) ges_multi_file_source_new (priv->uri);
} else if (priv->is_image) {
if (type != GES_TRACK_TYPE_VIDEO) {
GST_DEBUG ("Object is still image, not adding any audio source");
return NULL;
} else {
GST_DEBUG ("Creating a GESImageSource");
res = (GESTrackElement *) ges_image_source_new (priv->uri);
}
} else {
GST_DEBUG ("Creating a GESUriSource");
/* FIXME : Implement properly ! */
if (type == GES_TRACK_TYPE_VIDEO)
res = (GESTrackElement *) ges_video_uri_source_new (priv->uri);
else if (type == GES_TRACK_TYPE_AUDIO)
res = (GESTrackElement *) ges_audio_uri_source_new (priv->uri);
/* If mute and track is audio, deactivate the track element */
if (type == GES_TRACK_TYPE_AUDIO && priv->mute)
ges_track_element_set_active (res, FALSE);
}
if (res)
ges_track_element_set_track_type (res, type);
return res;
}
/**
* ges_uri_clip_new:
* @uri: the URI the source should control
*
* Creates a new #GESUriClip for the provided @uri.
*
* Returns: The newly created #GESUriClip, or NULL if there was an
* error.
*/
GESUriClip *
ges_uri_clip_new (gchar * uri)
{
GESUriClip *res = NULL;
if (gst_uri_is_valid (uri))
res = g_object_new (GES_TYPE_URI_CLIP, "uri", uri, NULL);
return res;
}
void
ges_uri_clip_set_uri (GESUriClip * self, gchar * uri)
{
if (GES_CONTAINER_CHILDREN (self)) {
/* FIXME handle this case properly */
GST_WARNING_OBJECT (self, "Can not change uri when already"
"containing TrackElements");
return;
}
self->priv->uri = uri;
}