yta-video-opengl 0.0.23__py3-none-any.whl → 0.0.25__py3-none-any.whl

yta_video_opengl/__init__.py

@@ -2,10 +2,9 @@
 Module to include video handling with OpenGL.
 """
 def main():
-    # from yta_video_opengl.tests import video_modified_stored
+    from yta_video_opengl.tests import video_modified_stored
 
-    # video_modified_stored()
-    print('main')
+    video_modified_stored()
 
 
 if __name__ == '__main__':

yta_video_opengl/effects.py

@@ -0,0 +1,382 @@
+from yta_video_opengl.nodes.video.opengl import WavingNode
+from yta_video_opengl.nodes.audio import ChorusNode
+from yta_video_opengl.nodes import TimedNode
+from yta_validation.parameter import ParameterValidator
+from yta_programming.decorators import singleton_old
+from typing import Union
+
+import moderngl
+
+
+class _AudioEffects:
+    """
+    *For internal use only*
+
+    The audio effects that will be available
+    throught our internal _Effects class to
+    wrap and make available all the audio
+    effects we want to be available.
+    """
+
+    def __init__(
+        self,
+        effects: 'Effects'
+    ):
+        self._effects: Effects = effects
+        """
+        The parent instance that includes this
+        class instance as a property.
+        """
+
+    """
+    Here below we expose all the effects
+    we want the users to have available to
+    be used.
+    """
+    def chorus(
+        self,
+        sample_rate: int,
+        depth: int = 0,
+        frequency: float = 0.25,
+        start: Union[int, float, 'Fraction'] = 0,
+        end: Union[int, float, 'Fraction', None] = None
+    ):
+        return _create_node(
+            ChorusNode(
+                sample_rate = sample_rate,
+                depth = depth,
+                frequency = frequency
+            ),
+            start = start,
+            end = end
+        )
+    
+    # TODO: Include definitive and tested audio
+    # effects here below
+
+class _VideoEffects:
+    """
+    *For internal use only*
+
+    The video effects that will be available
+    throught our internal _Effects class to
+    wrap and make available all the video
+    effects we want to be available.
+    """
+
+    def __init__(
+        self,
+        effects: 'Effects'
+    ):
+        self._effects: Effects = effects
+        """
+        The parent instance that includes this
+        class instance as a property.
+        """
+
+    """
+    Here below we expose all the effects
+    we want the users to have available to
+    be used.
+    """
+    def waving_node(
+        self,
+        # TODO: Maybe 'frame_size' (?)
+        size: tuple[int, int],
+        amplitude: float = 0.05,
+        frequency: float = 10.0,
+        speed: float = 2.0,
+        start: Union[int, float, 'Fraction'] = 0.0,
+        end: Union[int, float, 'Fraction', None] = None
+    ) -> 'TimedNode':
+        """
+        TODO: Explain this better.
+
+        The 'start' and 'end' time moments are the
+        limits of the time range in which the effect
+        has to be applied to the frames inside that
+        time range. Providing start=0 and end=None
+        will make the effect to be applied to any
+        frame.
+        """
+        return _create_node(
+            WavingNode(
+                context = self._effects.opengl_context,
+                size = size,
+                amplitude = amplitude,
+                frequency = frequency,
+                speed = speed
+            ),
+            start = start,
+            end = end
+        )
+    
+    # TODO: Include definitive and tested video
+    # effects here below
+
+@singleton_old
+class Effects:
+    """
+    Singleton instance.
+
+    It is a singleton instance to have a
+    unique context for all the instances
+    that need it and instantiate this
+    class to obtain it. Here we group all
+    the nodes we have available for the
+    user.
+
+    This class is to simplify the access to
+    the effect nodes and also to have the
+    single context always available.
+
+    Even though we can have more effects,
+    this class is also the way we expose only
+    the ones we actually want to expose to 
+    the user.
+
+    The GPU will make the calculations in
+    parallel by itself, so we can handle a
+    single context to make the nodes share
+    textures and buffers.
+    """
+
+    def __init__(
+        self
+    ):
+        self.opengl_context = moderngl.create_context(standalone = True)
+        """
+        The opengl context that will be shared
+        by all the opengl nodes.
+        """
+        self.audio: _AudioEffects = _AudioEffects(self)
+        """
+        Shortcut to the audio effects that are
+        available.
+        """
+        self.video: _VideoEffects = _VideoEffects(self)
+        """
+        Shortcut to the video effects that are
+        available.
+        """
+
+def _create_node(
+    node: Union['_AudioNode', '_VideoNode'],
+    start: Union[int, float, 'Fraction'],
+    end: Union[int, float, 'Fraction', None]
+):
+    # We could be other classes in the middle,
+    # because an OpenglNode inherits from
+    # other class
+    ParameterValidator.validate_mandatory_subclass_of('node', node, ['_AudioNode', '_VideoNode', 'OpenglNodeBase'])
+
+    # We have to create a node wrapper with the
+    # time range in which it has to be applied
+    # to all the frames.
+    return TimedNode(
+        node = node,
+        start = start,
+        end = end
+    )
+
+class _EffectStacked:
+    """
+    Class to wrap an effect that will be
+    stacked with an specific priority.
+
+    Priority is higher when lower value,
+    and lower when higher value.
+    """
+
+    @property
+    def is_audio_effect(
+        self
+    ) -> bool:
+        """
+        Flag to indicate if it is an audio effect
+        or not.
+        """
+        return self.effect.is_audio_node
+
+    @property
+    def is_video_effect(
+        self
+    ) -> bool:
+        """
+        Flag to indicate if it is a video effect
+        or not.
+        """
+        return self.effect.is_video_node
+
+    def __init__(
+        self,
+        effect: TimedNode,
+        priority: int
+    ):
+        self.effect: TimedNode = effect
+        """
+        The effect to be applied.
+        """
+        self.priority: int = priority
+        """
+        The priority this stacked frame has versus
+        the other stacked effects.
+        """
+
+# TODO: Move to another py file (?)
+class EffectsStack:
+    """
+    Class to include a collection of effects
+    we want to apply in some entity, that 
+    will make easier to apply them.
+
+    You can use this stack to keep the effects
+    you want to apply on a Media or on the
+    Timeline of your video editor.
+    """
+
+    @property
+    def video_effects(
+        self
+    ) -> list[_EffectStacked]:
+        """
+        The video effects but ordered by 'priority'
+        and 'start' time moment.
+        """
+        return sorted(
+            [
+                effect
+                for effect in self._effects
+                if effect.is_video_effect
+            ],
+            key = lambda effect: (effect.priority, effect.effect.start)
+        )
+    
+    @property
+    def audio_effects(
+        self
+    ) -> list[_EffectStacked]:
+        """
+        The audio effects but ordered by 'priority'
+        and 'start' time moment.
+        """
+        return sorted(
+            [
+                effect
+                for effect in self._effects
+                if effect.is_audio_effect
+            ],
+            key = lambda effect: (effect.priority, effect.effect.start)
+        )
+    
+    @property
+    def lowest_audio_priority(
+        self
+    ) -> int:
+        """
+        The priority of the audio effect with the
+        lowest one, or 0 if no audio effects.
+        """
+        return min(
+            self.audio_effects,
+            key = lambda effect: effect.priority,
+            default = 0
+        )
+
+    @property
+    def lowest_video_priority(
+        self
+    ) -> int:
+        """
+        The priority of the video effect with the
+        lowest one, or 0 if no video effects.
+        """
+        return min(
+            self.video_effects,
+            key = lambda effect: effect.priority,
+            default = 0
+        )
+    
+    def __init__(
+        self
+    ):
+        self._effects: list[_EffectStacked] = []
+        """
+        A list containing all the effects that
+        have been added to this stack, unordered.
+        """
+
+    def get_audio_effects_for_t(
+        self,
+        t: Union[int, float, 'Fraction']
+    ) -> list[TimedNode]:
+        """
+        Get the audio effects, ordered by priority
+        and the 'start' field, that must be applied
+        within the 't' time moment provided because
+        it is within the [start, end) time range.
+        """
+        return [
+            effect.effect
+            for effect in self.audio_effects
+            if effect.effect.is_within_time(t)
+        ]
+
+    def get_video_effects_for_t(
+        self,
+        t: Union[int, float, 'Fraction']
+    ) -> list[TimedNode]:
+        """
+        Get the video effects, ordered by priority
+        and the 'start' field, that must be applied
+        within the 't' time moment provided because
+        it is within the [start, end) time range.
+        """
+        return [
+            effect.effect
+            for effect in self.video_effects
+            if effect.effect.is_within_time(t)
+        ]
+
+    def add_effect(
+        self,
+        effect: TimedNode,
+        priority: Union[int, None] = None
+    ) -> 'EffectsStack':
+        """
+        Add the provided 'effect' to the stack.
+        """
+        ParameterValidator.validate_mandatory_instance_of('effect', effect, TimedNode)
+        ParameterValidator.validate_positive_int('priority', priority, do_include_zero = True)
+
+        # TODO: What about the same effect added
+        # twice during the same time range? Can we
+        # allow it? It will be applied twice for
+        # specific 't' time moments but with 
+        # different attributes. is it ok (?)
+
+        # TODO: What if priority is already taken?
+        # Should we let some effects have the same
+        # priority (?)
+        priority = (
+            self.lowest_audio_priority + 1
+            if (
+                priority is None and
+                effect.is_audio_node
+            ) else
+            self.lowest_video_priority + 1
+            if (
+                priority is None and
+                effect.is_video_node
+            ) else
+            priority
+        )
+
+        self._effects.append(_EffectStacked(
+            effect = effect,
+            priority = priority
+        ))
+
+        return self
+    
+    # TODO: Create 'remove_effect'

yta_video_opengl/nodes/__init__.py

@@ -1,31 +1,12 @@
+from yta_video_opengl.nodes.video import _VideoNode
+from yta_video_opengl.nodes.audio import _AudioNode
 from yta_validation.parameter import ParameterValidator
+from yta_validation import PythonValidator
 from typing import Union
-from abc import ABC, abstractmethod
 
 import moderngl
 
 
-class Node(ABC):
-    """
-    Base class to represent a node, which
-    is an entity that processes frames
-    individually.
-
-    This class must be inherited by any 
-    video or audio node class.
-    """
-
-    # TODO: What about the types?
-    # TODO: Should we expect pyav frames (?)
-    @abstractmethod
-    def process(
-        frame: Union['VideoFrame', 'AudioFrame', moderngl.Texture],
-        t: float
-        # TODO: Maybe we need 'fps' and 'number_of_frames'
-        # to calculate progressions or similar...
-    ) -> Union['VideoFrame', 'AudioFrame', moderngl.Texture]:
-        pass
-
 class TimedNode:
     """
     Class to represent a Node wrapper to
@@ -52,11 +33,35 @@ class TimedNode:
     The 'start' and 'end' values by default
     """
 
+    @property
+    def is_audio_node(
+        self
+    ) -> bool:
+        """
+        Flag to indicate if the node (or effect)
+        is an audio effect or not.
+        """
+        # TODO: Is this checking not only the
+        # first level (?)
+        return PythonValidator.is_subclass_of(self.node, _AudioNode)
+    
+    @property
+    def is_video_node(
+        self
+    ) -> bool:
+        """
+        Flag to indicate if the node (or effect)
+        is a video effect or not.
+        """
+        # TODO: Is this checking not only the
+        # first level (?)
+        return PythonValidator.is_subclass_of(self.node, _VideoNode)
+
     def __init__(
         self,
-        node: Node,
-        start: float = 0.0,
-        end: Union[float, None] = None
+        node: Union[_VideoNode, _AudioNode],
+        start: Union[int, float, 'Fraction'] = 0.0,
+        end: Union[int, float, 'Fraction', None] = None
     ):
         ParameterValidator.validate_mandatory_positive_number('start', start, do_include_zero = True)
         ParameterValidator.validate_positive_number('end', end, do_include_zero = False)
@@ -67,7 +72,7 @@ class TimedNode:
         ):
             raise Exception('The "end" parameter provided must be greater or equal to the "start" parameter.')
 
-        self.node: Node = node
+        self.node: Union[_VideoNode, _AudioNode] = node
         """
         The node we are wrapping and we want to
         apply as a modification of the frame in
@@ -84,6 +89,28 @@ class TimedNode:
         stop being applied (excluding it).
         """
 
+    def _get_t(
+        self,
+        t: Union[int, float, 'Fraction']
+    ) -> float:
+        """
+        Obtain the 't' time moment relative to the
+        effect duration.
+
+        Imagine `start=3` and `end=5`, and we receive 
+        a `t=4`. It is inside the range, so we have
+        to apply the effect, but as the effect
+        lasts from second 3 to second 5 (`duration=2`),
+        the `t=4` is actually a `t=1` for the effect
+        because it is the time elapsed since the
+        effect started being applied, that was on the 
+        second 3.
+
+        The formula:
+        - `t - self.start`
+        """
+        return t - self.start
+
     def is_within_time(
         self,
         t: float
@@ -91,7 +118,9 @@ class TimedNode:
         """
         Flag to indicate if the 't' time moment provided
         is in the range of this TimedNode instance, 
-        which means that it fits this condition:
+        which means between the 'start' and the 'end'.
+
+        The formula:
         - `start <= t < end`
         """
         return (
@@ -113,7 +142,7 @@ class TimedNode:
         instance.
         """
         return (
-            self.node.process(frame, t)
+            self.node.process(frame, self._get_t(t))
             if self.is_within_time(t) else
             frame
         )