syphon.client

  1from abc import ABC, abstractmethod
  2from typing import Optional, Any
  3
  4import Metal
  5import objc
  6
  7from syphon.server_directory import SyphonServerDescription
  8from syphon.utils import opengl
  9
 10
 11class BaseSyphonClient(ABC):
 12    """
 13    Abstract base class for Syphon clients.
 14
 15    Attributes:
 16    - description (SyphonServerDescription): The description of the Syphon server.
 17    """
 18
 19    def __init__(self, description: SyphonServerDescription):
 20        """
 21        Initialize a BaseSyphonClient.
 22
 23        Parameters:
 24        - description (SyphonServerDescription): The description of the Syphon server.
 25        """
 26        # todo: implement new frame handler callback support
 27        self._description = description
 28
 29    @property
 30    @abstractmethod
 31    def is_valid(self) -> bool:
 32        """
 33        Check if the Syphon client is valid.
 34
 35        Returns:
 36        - bool: True if the client is valid, False otherwise.
 37        """
 38        pass
 39
 40    @property
 41    @abstractmethod
 42    def has_new_frame(self) -> bool:
 43        """
 44        Check if the Syphon client has a new frame.
 45
 46        Returns:
 47        - bool: True if there is a new frame, False otherwise.
 48        """
 49        pass
 50
 51    @abstractmethod
 52    def stop(self):
 53        """
 54        Stop the Syphon client.
 55        """
 56        pass
 57
 58
 59class SyphonMetalClient(BaseSyphonClient):
 60    """
 61    Syphon client for Metal-based rendering.
 62
 63    Attributes:
 64    - description (SyphonServerDescription): The description of the Syphon server.
 65    - device (Any): The Metal device.
 66    - context (Any): The Syphon-Metal context.
 67    """
 68
 69    def __init__(self, description: SyphonServerDescription, device: Optional[Any] = None):
 70        """
 71        Initialize a SyphonMetalClient.
 72
 73        Parameters:
 74        - description (SyphonServerDescription): The description of the Syphon server.
 75        - device (Any, optional): The Metal device. If None, the default system device will be used.
 76        """
 77        super().__init__(description)
 78
 79        self.device = device
 80
 81        # setup device
 82        if self.device is None:
 83            self.device = Metal.MTLCreateSystemDefaultDevice()
 84
 85        # setup syphon-metal context
 86        SyphonMetalClientObjC = objc.lookUpClass("SyphonMetalClient")
 87
 88        self.context = (
 89            SyphonMetalClientObjC
 90            .alloc()
 91            .initWithServerDescription_device_options_newFrameHandler_(
 92                description.raw,
 93                self.device,
 94                None,
 95                None)
 96        )
 97
 98    @property
 99    def is_valid(self) -> bool:
100        """
101        Check if the SyphonMetalClient is valid.
102
103        Returns:
104        - bool: True if the client is valid, False otherwise.
105        """
106        return self.context.isValid()
107
108    @property
109    def has_new_frame(self) -> bool:
110        """
111        Check if the SyphonMetalClient has a new frame.
112
113        Returns:
114        - bool: True if there is a new frame, False otherwise.
115        """
116        return self.context.hasNewFrame()
117
118    @property
119    def new_frame_image(self) -> Any:
120        """
121        Get the new frame image.
122
123        Returns:
124        - Any: The new frame image.
125        """
126        return self.context.newFrameImage()
127
128    def stop(self):
129        """
130        Stop the SyphonMetalClient.
131        """
132        self.context.stop()
133
134
135class SyphonOpenGLClient(BaseSyphonClient):
136    """
137    Syphon client for OpenGL-based rendering.
138
139    Attributes:
140    - description (SyphonServerDescription): The description of the Syphon server.
141    - cgl_context_obj (Any): The CGL context object.
142    - context (Any): The Syphon-OpenGL context.
143    """
144
145    def __init__(self, description: SyphonServerDescription, cgl_context_obj: Optional[Any] = None):
146        """
147        Initialize a SyphonOpenGLClient.
148
149        Parameters:
150        - description (SyphonServerDescription): The description of the Syphon server.
151        - cgl_context_obj (Any, optional): The CGL context object. If None, the current context will be used.
152        """
153        super().__init__(description)
154
155        # store CGL context object
156        self.cgl_context_obj = opengl.get_current_cgl_context_obj() if cgl_context_obj is None else cgl_context_obj
157
158        # create syphon gl client
159        SyphonOpenGLClientObjC = objc.lookUpClass("SyphonOpenGLClient")
160        self.context = (
161            SyphonOpenGLClientObjC
162            .alloc()
163            .initWithServerDescription_context_options_newFrameHandler_(
164                description.raw,
165                self.cgl_context_obj,
166                None,
167                None)
168        )
169
170    @property
171    def is_valid(self) -> bool:
172        """
173        Check if the SyphonOpenGLClient is valid.
174
175        Returns:
176        - bool: True if the client is valid, False otherwise.
177        """
178        return self.context.isValid()
179
180    @property
181    def has_new_frame(self) -> bool:
182        """
183        Check if the SyphonOpenGLClient has a new frame.
184
185        Returns:
186        - bool: True if there is a new frame, False otherwise.
187        """
188        return self.context.hasNewFrame()
189
190    @property
191    def new_frame_image(self) -> Any:
192        """
193        Get the new frame image.
194
195        Returns:
196        - Any: The new frame image.
197        """
198        return self.context.newFrameImage()
199
200    def stop(self):
201        """
202        Stop the SyphonOpenGLClient.
203        """
204        self.context.stop()