def getEffectConfigurationUI(self, effect):
"""Permit to get a configuration GUI for the effect
@param effect: The effect for which we want the configuration UI
@type effect: C{Gst.Element}
"""
if effect not in self.cache_dict:
# Here we should handle special effects configuration UI
effect_settings_widget = GstElementSettingsWidget()
effect_settings_widget.setElement(effect, ignore=PROPS_TO_IGNORE,
default_btn=True, use_element_props=True)
scrolled_window = Gtk.ScrolledWindow()
scrolled_window.add_with_viewport(effect_settings_widget)
scrolled_window.set_policy(Gtk.PolicyType.AUTOMATIC,
Gtk.PolicyType.AUTOMATIC)
self.cache_dict[effect] = scrolled_window
self._connectAllWidgetCallbacks(effect_settings_widget, effect)
self._postConfiguration(effect, effect_settings_widget)
self._current_effect_setting_ui = self._getUiToSetEffect(effect)
element = self._current_effect_setting_ui.element
for prop in element.list_children_properties():
self._current_element_values[
prop.name] = element.get_child_property(prop.name)
return self.cache_dict[effect]
def getEffectConfigurationUI(self, effect):
"""
Permit to get a configuration GUI for the effect
@param effect: The effect for which we want the configuration UI
@type effect: C{gst.Element}
"""
if effect not in self.cache_dict:
#Here we should handle special effects configuration UI
effect_set_ui = GstElementSettingsWidget()
effect_set_ui.setElement(effect, ignore=PROPS_TO_IGNORE,
default_btn=True, use_element_props=True)
nb_rows = effect_set_ui.get_children()[0].get_property('n-rows')
effect_configuration_ui = gtk.ScrolledWindow()
effect_configuration_ui.add_with_viewport(effect_set_ui)
effect_configuration_ui.set_policy(gtk.POLICY_AUTOMATIC,
gtk.POLICY_AUTOMATIC)
self.cache_dict[effect] = effect_configuration_ui
self._connectAllWidgetCbs(effect_set_ui, effect)
self._postConfiguration(effect, effect_set_ui)
effect_set_ui = self._getUiToSetEffect(effect)
self._current_effect_setting_ui = effect_set_ui
element = self._current_effect_setting_ui.element
for prop in element.list_children_properties():
self._current_element_values[prop.name] = element.get_child_property(prop.name)
return self.cache_dict[effect]
def _register_alpha_widget(self, widgets):
"""Sets up an EffectsPropertiesManager instance to create custom effect UI."""
self.alpha_effect = GES.Effect.new("alpha")
self.prop_name = "black-sensitivity"
_, _, self.prop = self.alpha_effect.lookup_child(self.prop_name)
self.effects_prop_manager = EffectsPropertiesManager(self.app)
self.effects_prop_manager.connect("create-widget", self.create_alpha_widget_cb, widgets)
self.element_settings_widget = GstElementSettingsWidget(self.alpha_effect, PROPS_TO_IGNORE)
self.effects_prop_manager.emit("create-widget", self.element_settings_widget, self.alpha_effect)
self.effects_prop_manager._connect_all_widget_callbacks(self.element_settings_widget, self.alpha_effect)
self.effects_prop_manager._post_configuration(self.alpha_effect, self.element_settings_widget)
def getEffectConfigurationUI(self, effect):
"""Gets a configuration UI element for the effect.
Args:
effect (Gst.Element): The effect for which we want the UI.
Returns:
GstElementSettingsWidget: A container for configuring the effect.
"""
if effect not in self.cache_dict:
effect_widget = GstElementSettingsWidget(effect, PROPS_TO_IGNORE)
widget = self.emit("create_widget", effect_widget, effect)
# The default handler of `create_widget` handles visibility
# itself and returns None
if widget is not None:
effect_widget.show_widget(widget)
self.cache_dict[effect] = effect_widget
self._connectAllWidgetCallbacks(effect_widget, effect)
return self.cache_dict[effect]
def getEffectConfigurationUI(self, effect):
"""Permit to get a configuration GUI for the effect
@param effect: The effect for which we want the configuration UI
@type effect: C{Gst.Element}
"""
if effect not in self.cache_dict:
# Here we should handle special effects configuration UI
effect_widget = GstElementSettingsWidget()
effect_widget.setElement(effect, ignore=PROPS_TO_IGNORE,
with_reset_button=True)
self.cache_dict[effect] = effect_widget
self._connectAllWidgetCallbacks(effect_widget, effect)
self._postConfiguration(effect, effect_widget)
for prop in effect.list_children_properties():
value = effect.get_child_property(prop.name)
self._current_element_values[prop.name] = value
return self.cache_dict[effect]
def _register_alpha_widget(self, widgets):
"""Sets up an EffectsPropertiesManager instance to create custom effect UI."""
self.alpha_effect = GES.Effect.new("alpha")
self.prop_name = "black-sensitivity"
_, _, self.prop = self.alpha_effect.lookup_child(self.prop_name)
self.effects_prop_manager = EffectsPropertiesManager(self.app)
self.effects_prop_manager.connect("create-widget", self.create_alpha_widget_cb, widgets)
self.element_settings_widget = GstElementSettingsWidget(self.alpha_effect, PROPS_TO_IGNORE)
self.effects_prop_manager.emit("create-widget", self.element_settings_widget, self.alpha_effect)
self.effects_prop_manager._connectAllWidgetCallbacks(self.element_settings_widget, self.alpha_effect)
self.effects_prop_manager._postConfiguration(self.alpha_effect, self.element_settings_widget)
def getEffectConfigurationUI(self, effect):
"""Gets a configuration UI element for the effect.
Args:
effect (Gst.Element): The effect for which we want the UI.
Returns:
GstElementSettingsWidget: A container for configuring the effect.
"""
if effect not in self.cache_dict:
# Here we should handle special effects configuration UI
effect_widget = GstElementSettingsWidget()
effect_widget.setElement(effect, ignore=PROPS_TO_IGNORE,
with_reset_button=True)
self.cache_dict[effect] = effect_widget
self._connectAllWidgetCallbacks(effect_widget, effect)
self._postConfiguration(effect, effect_widget)
for prop in effect.list_children_properties():
value = effect.get_child_property(prop.name)
self._current_element_values[prop.name] = value
return self.cache_dict[effect]
class EffectsPropertiesManagerTest(common.TestCase):
"""Tests for the EffectsPropertiesManager class."""
def create_alpha_widget_cb(self, unused_manager, unused_container, unused_effect, widgets):
"""Handles the request to create an effect widget."""
self.builder = Gtk.Builder()
path = os.path.join(os.path.dirname(__file__), "plugins", "test_alpha.ui")
self.builder.add_objects_from_file(path, widgets)
self.element_settings_widget.mapBuilder(self.builder)
return self.builder.get_object("GstAlpha::black-sensitivity")
def _register_alpha_widget(self, widgets):
"""Sets up an EffectsPropertiesManager instance to create custom effect UI."""
self.alpha_effect = GES.Effect.new("alpha")
self.prop_name = "black-sensitivity"
_, _, self.prop = self.alpha_effect.lookup_child(self.prop_name)
self.effects_prop_manager = EffectsPropertiesManager(self.app)
self.effects_prop_manager.connect("create-widget", self.create_alpha_widget_cb, widgets)
self.element_settings_widget = GstElementSettingsWidget(self.alpha_effect, PROPS_TO_IGNORE)
self.effects_prop_manager.emit("create-widget", self.element_settings_widget, self.alpha_effect)
self.effects_prop_manager._connectAllWidgetCallbacks(self.element_settings_widget, self.alpha_effect)
self.effects_prop_manager._postConfiguration(self.alpha_effect, self.element_settings_widget)
def test_wrapping(self):
"""Checks UI updating results in updating the effect."""
self.app = common.create_pitivi_mock()
self._register_alpha_widget(("black_sens_adjustment", "GstAlpha::black-sensitivity"))
# Check if the widget is wrapped correctly
wrapped_spin_button = self.element_settings_widget.properties[self.prop]
self.assertTrue(isinstance(wrapped_spin_button, DynamicWidget))
self.assertTrue(isinstance(wrapped_spin_button, NumericWidget))
# Check if the wrapper has the correct default value
self.assertEqual(self.prop.default_value, wrapped_spin_button.getWidgetDefault())
# Check if the callbacks are functioning
value = (1 + self.prop.default_value) % self.prop.maximum
wrapped_spin_button.setWidgetValue(value)
self.assertEqual(wrapped_spin_button.getWidgetValue(), value)
_, prop_value = self.alpha_effect.get_child_property(self.prop_name)
self.assertEqual(prop_value, value)
def test_prop_keyframe(self):
"""Checks the keyframe button effect."""
uri = common.get_sample_uri("tears_of_steel.webm")
asset = GES.UriClipAsset.request_sync(uri)
ges_clip = asset.extract()
# Add the clip to a timeline so it gets tracks.
timeline = common.create_timeline_container()
self.app = timeline.app
ges_timeline = timeline.ges_timeline
ges_timeline.append_layer()
ges_layer, = ges_timeline.get_layers()
ges_layer.add_clip(ges_clip)
self._register_alpha_widget(
("black_sens_adjustment", "GstAlpha::black-sensitivity", "GstAlpha::black-sensitivity::keyframe"))
ges_clip.add(self.alpha_effect)
track_element = self.element_settings_widget._GstElementSettingsWidget__get_track_element_of_same_type(
self.alpha_effect)
prop_keyframe_button = \
list(self.element_settings_widget._GstElementSettingsWidget__widgets_by_keyframe_button.keys())[0]
# Control the self.prop property on the timeline
prop_keyframe_button.set_active(True)
self.assertEqual(track_element.ui_element._TimelineElement__controlledProperty, self.prop)
# Revert to controlling the default property
prop_keyframe_button.set_active(False)
self.assertNotEqual(track_element.ui_element._TimelineElement__controlledProperty, self.prop)
def test_prop_reset(self):
"""Checks the reset button resets the property."""
self.app = common.create_pitivi_mock()
self._register_alpha_widget(
("black_sens_adjustment", "GstAlpha::black-sensitivity", "GstAlpha::black-sensitivity::reset", "image1"))
wrapped_spin_button = self.element_settings_widget.properties[self.prop]
_, prop_value = self.alpha_effect.get_child_property(self.prop_name)
self.assertEqual(self.prop.default_value, prop_value)
self.assertEqual(self.prop.default_value, wrapped_spin_button.getWidgetValue())
# Set the property value to a different value than the default
wrapped_spin_button.setWidgetValue((1 + self.prop.default_value) % self.prop.maximum)
_, prop_value = self.alpha_effect.get_child_property(self.prop_name)
self.assertEqual(prop_value, (1 + self.prop.default_value) % self.prop.maximum)
# Reset the value of the property to default
prop_reset_button = \
list(self.element_settings_widget._GstElementSettingsWidget__widgets_by_reset_button.keys())[0]
prop_reset_button.clicked()
_, prop_value = self.alpha_effect.get_child_property(self.prop_name)
self.assertEqual(self.prop.default_value, prop_value)
self.assertEqual(self.prop.default_value, wrapped_spin_button.getWidgetValue())
def test_dependent_properties(self):
"""Checks dependent properties updating is handled correctly."""
mainloop = common.create_main_loop()
app = common.create_pitivi()
app.project_manager.new_blank_project()
manager = EffectsPropertiesManager(app)
called = False
def set_child_property(prop_name, value):
nonlocal called
called = True
self.assertEqual(prop_name, "aspect-ratio")
GES.Effect.set_child_property(effect, prop_name, value)
# When setting the aspect-ratio property, and the stars align,
# the effect also changes the left/right properties.
# Here we simulate the updating of the dependent properties.
GES.Effect.set_child_property(effect, "left", 100)
GES.Effect.set_child_property(effect, "right", 100)
effect = GES.Effect.new("aspectratiocrop")
effect.set_child_property = set_child_property
effect_widget = manager.getEffectConfigurationUI(effect)
widgets = {prop.name: widget
for prop, widget in effect_widget.properties.items()}
# Simulate the user choosing an aspect-ratio.
widgets["aspect-ratio"].setWidgetValue(Gst.Fraction(4, 3))
mainloop.run(until_empty=True)
self.assertTrue(called)
class EffectsPropertiesManagerTest(common.TestCase):
"""Tests for the EffectsPropertiesManager class."""
def create_alpha_widget_cb(self, unused_manager, unused_container,
unused_effect, widgets):
"""Handles the request to create an effect widget."""
self.builder = Gtk.Builder()
path = os.path.join(os.path.dirname(__file__), "plugins",
"test_alpha.ui")
self.builder.add_objects_from_file(path, widgets)
self.element_settings_widget.mapBuilder(self.builder)
return self.builder.get_object("GstAlpha::black-sensitivity")
def _register_alpha_widget(self, widgets):
"""Sets up an EffectsPropertiesManager instance to create custom effect UI."""
self.alpha_effect = GES.Effect.new("alpha")
self.prop_name = "black-sensitivity"
_, _, self.prop = self.alpha_effect.lookup_child(self.prop_name)
self.effects_prop_manager = EffectsPropertiesManager(self.app)
self.effects_prop_manager.connect("create-widget",
self.create_alpha_widget_cb, widgets)
self.element_settings_widget = GstElementSettingsWidget(
self.alpha_effect, PROPS_TO_IGNORE)
self.effects_prop_manager.emit("create-widget",
self.element_settings_widget,
self.alpha_effect)
self.effects_prop_manager._connectAllWidgetCallbacks(
self.element_settings_widget, self.alpha_effect)
self.effects_prop_manager._postConfiguration(
self.alpha_effect, self.element_settings_widget)
def test_wrapping(self):
"""Checks UI updating results in updating the effect."""
self.app = common.create_pitivi_mock()
self._register_alpha_widget(
("black_sens_adjustment", "GstAlpha::black-sensitivity"))
# Check if the widget is wrapped correctly
wrapped_spin_button = self.element_settings_widget.properties[
self.prop]
self.assertTrue(isinstance(wrapped_spin_button, DynamicWidget))
self.assertTrue(isinstance(wrapped_spin_button, NumericWidget))
# Check if the wrapper has the correct default value
self.assertEqual(self.prop.default_value,
wrapped_spin_button.getWidgetDefault())
# Check if the callbacks are functioning
value = (1 + self.prop.default_value) % self.prop.maximum
wrapped_spin_button.setWidgetValue(value)
self.assertEqual(wrapped_spin_button.getWidgetValue(), value)
_, prop_value = self.alpha_effect.get_child_property(self.prop_name)
self.assertEqual(prop_value, value)
def test_prop_keyframe(self):
"""Checks the keyframe button effect."""
uri = common.get_sample_uri("tears_of_steel.webm")
asset = GES.UriClipAsset.request_sync(uri)
ges_clip = asset.extract()
# Add the clip to a timeline so it gets tracks.
timeline = common.create_timeline_container()
self.app = timeline.app
ges_timeline = timeline.ges_timeline
ges_timeline.append_layer()
ges_layer, = ges_timeline.get_layers()
ges_layer.add_clip(ges_clip)
self._register_alpha_widget(
("black_sens_adjustment", "GstAlpha::black-sensitivity",
"GstAlpha::black-sensitivity::keyframe"))
ges_clip.add(self.alpha_effect)
track_element = self.element_settings_widget._GstElementSettingsWidget__get_track_element_of_same_type(
self.alpha_effect)
prop_keyframe_button = \
list(self.element_settings_widget._GstElementSettingsWidget__widgets_by_keyframe_button.keys())[0]
# Control the self.prop property on the timeline
prop_keyframe_button.set_active(True)
self.assertEqual(
track_element.ui_element._TimelineElement__controlledProperty,
self.prop)
# Revert to controlling the default property
prop_keyframe_button.set_active(False)
self.assertNotEqual(
track_element.ui_element._TimelineElement__controlledProperty,
self.prop)
def test_prop_reset(self):
"""Checks the reset button resets the property."""
self.app = common.create_pitivi_mock()
self._register_alpha_widget(
("black_sens_adjustment", "GstAlpha::black-sensitivity",
"GstAlpha::black-sensitivity::reset", "image1"))
wrapped_spin_button = self.element_settings_widget.properties[
self.prop]
_, prop_value = self.alpha_effect.get_child_property(self.prop_name)
self.assertEqual(self.prop.default_value, prop_value)
self.assertEqual(self.prop.default_value,
wrapped_spin_button.getWidgetValue())
# Set the property value to a different value than the default
wrapped_spin_button.setWidgetValue(
(1 + self.prop.default_value) % self.prop.maximum)
_, prop_value = self.alpha_effect.get_child_property(self.prop_name)
self.assertEqual(prop_value,
(1 + self.prop.default_value) % self.prop.maximum)
# Reset the value of the property to default
prop_reset_button = \
list(self.element_settings_widget._GstElementSettingsWidget__widgets_by_reset_button.keys())[0]
prop_reset_button.clicked()
_, prop_value = self.alpha_effect.get_child_property(self.prop_name)
self.assertEqual(self.prop.default_value, prop_value)
self.assertEqual(self.prop.default_value,
wrapped_spin_button.getWidgetValue())
def test_dependent_properties(self):
"""Checks dependent properties updating is handled correctly."""
mainloop = common.create_main_loop()
app = common.create_pitivi()
app.project_manager.new_blank_project()
manager = EffectsPropertiesManager(app)
called = False
def set_child_property(prop_name, value):
nonlocal called
called = True
self.assertEqual(prop_name, "aspect-ratio")
GES.Effect.set_child_property(effect, prop_name, value)
# When setting the aspect-ratio property, and the stars align,
# the effect also changes the left/right properties.
# Here we simulate the updating of the dependent properties.
GES.Effect.set_child_property(effect, "left", 100)
GES.Effect.set_child_property(effect, "right", 100)
effect = GES.Effect.new("aspectratiocrop")
effect.set_child_property = set_child_property
effect_widget = manager.getEffectConfigurationUI(effect)
widgets = {
prop.name: widget
for prop, widget in effect_widget.properties.items()
}
# Simulate the user choosing an aspect-ratio.
widgets["aspect-ratio"].setWidgetValue(Gst.Fraction(4, 3))
mainloop.run(until_empty=True)
self.assertTrue(called)
class TestCustomEffectUI(common.TestCase):
"""Tests for the custom effect UI create mechanism."""
def create_alpha_widget_cb(self, unused_manager, unused_container,
unused_effect, widgets):
"""Handles the request to create an effect widget."""
self.builder = Gtk.Builder()
path = os.path.join(os.path.dirname(__file__), "plugins",
"test_alpha.ui")
self.builder.add_objects_from_file(path, widgets)
self.element_settings_widget.mapBuilder(self.builder)
return self.builder.get_object("GstAlpha::black-sensitivity")
def _register_alpha_widget(self, widgets):
"""Sets up an EffectsPropertiesManager instance to create custom effect UI."""
self.alpha_effect = GES.Effect.new("alpha")
self.prop_name = "black-sensitivity"
_, _, self.prop = self.alpha_effect.lookup_child(self.prop_name)
self.effects_prop_manager = EffectsPropertiesManager(self.app)
self.effects_prop_manager.connect("create-widget",
self.create_alpha_widget_cb, widgets)
self.element_settings_widget = GstElementSettingsWidget()
self.element_settings_widget.setElement(self.alpha_effect,
PROPS_TO_IGNORE)
self.effects_prop_manager.emit("create-widget",
self.element_settings_widget,
self.alpha_effect)
self.effects_prop_manager._connectAllWidgetCallbacks(
self.element_settings_widget, self.alpha_effect)
self.effects_prop_manager._postConfiguration(
self.alpha_effect, self.element_settings_widget)
def test_wrapping(self):
"""Checks UI updating results in updating the effect."""
self.app = common.create_pitivi_mock()
self._register_alpha_widget(
("black_sens_adjustment", "GstAlpha::black-sensitivity"))
# Check if the widget is wrapped correctly
wrapped_spin_button = self.element_settings_widget.properties[
self.prop]
self.assertTrue(isinstance(wrapped_spin_button, DynamicWidget))
self.assertTrue(isinstance(wrapped_spin_button, NumericWidget))
# Check if the wrapper has the correct default value
self.assertEqual(self.prop.default_value,
wrapped_spin_button.getWidgetDefault())
# Check if the callbacks are functioning
value = (1 + self.prop.default_value) % self.prop.maximum
wrapped_spin_button.setWidgetValue(value)
self.assertEqual(wrapped_spin_button.getWidgetValue(), value)
_, prop_value = self.alpha_effect.get_child_property(self.prop_name)
self.assertEqual(prop_value, value)
def test_prop_keyframe(self):
"""Checks the keyframe button effect."""
uri = common.get_sample_uri("tears_of_steel.webm")
asset = GES.UriClipAsset.request_sync(uri)
ges_clip = asset.extract()
# Add the clip to a timeline so it gets tracks.
timeline = common.create_timeline_container()
self.app = timeline.app
ges_timeline = timeline.ges_timeline
ges_timeline.append_layer()
ges_layer, = ges_timeline.get_layers()
ges_layer.add_clip(ges_clip)
self._register_alpha_widget(
("black_sens_adjustment", "GstAlpha::black-sensitivity",
"GstAlpha::black-sensitivity::keyframe"))
ges_clip.add(self.alpha_effect)
track_element = self.element_settings_widget._GstElementSettingsWidget__get_track_element_of_same_type(
self.alpha_effect)
prop_keyframe_button = \
list(self.element_settings_widget._GstElementSettingsWidget__widgets_by_keyframe_button.keys())[0]
# Control the self.prop property on the timeline
prop_keyframe_button.set_active(True)
self.assertEqual(
track_element.ui_element._TimelineElement__controlledProperty,
self.prop)
# Revert to controlling the default property
prop_keyframe_button.set_active(False)
self.assertNotEqual(
track_element.ui_element._TimelineElement__controlledProperty,
self.prop)
def test_prop_reset(self):
"""Checks the reset button resets the property."""
self.app = common.create_pitivi_mock()
self._register_alpha_widget(
("black_sens_adjustment", "GstAlpha::black-sensitivity",
"GstAlpha::black-sensitivity::reset", "image1"))
wrapped_spin_button = self.element_settings_widget.properties[
self.prop]
_, prop_value = self.alpha_effect.get_child_property(self.prop_name)
self.assertEqual(self.prop.default_value, prop_value)
self.assertEqual(self.prop.default_value,
wrapped_spin_button.getWidgetValue())
# Set the property value to a different value than the default
wrapped_spin_button.setWidgetValue(
(1 + self.prop.default_value) % self.prop.maximum)
_, prop_value = self.alpha_effect.get_child_property(self.prop_name)
self.assertEqual(prop_value,
(1 + self.prop.default_value) % self.prop.maximum)
# Reset the value of the property to default
prop_reset_button = \
list(self.element_settings_widget._GstElementSettingsWidget__widgets_by_reset_button.keys())[0]
prop_reset_button.clicked()
_, prop_value = self.alpha_effect.get_child_property(self.prop_name)
self.assertEqual(self.prop.default_value, prop_value)
self.assertEqual(self.prop.default_value,
wrapped_spin_button.getWidgetValue())
