vlcsync 0.2.1__tar.gz → 0.3.1__tar.gz

{vlcsync-0.2.1 → vlcsync-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vlcsync
-Version: 0.2.1
+Version: 0.3.1
 Summary: Utility for synchronize multiple instances of VLC. Supports seek, play and pause. 
 Home-page: https://github.com/mrkeuz/vlcsync/
 License: MIT
@@ -29,7 +29,7 @@ Description-Content-Type: text/markdown
 VLC Sync
 ========
 
-Utility for synchronize multiple instances of VLC. Supports seek, play and pause. 
+Utility for synchronize multiple instances of VLC. Supports seek, play and pause/stop, playlist and volume sync. 
   
 
 #### Motivation
@@ -71,6 +71,10 @@ $ vlcsync --rc-host 192.168.1.100:12345 --rc-host 192.168.1.50:54321
 # For disable local discovery (only remote instances)
 $ vlcsync --no-local-discovery --rc-host 192.168.1.100:12345
 
+# Started from version 0.3.0 (playlists sync)
+# Support volume sync for exotic cases
+$ vlcsync --volume-sync
+
 # For help and see all options
 $ vlcsync --help
 ```
@@ -89,7 +93,7 @@ Awesome [use-case](./docs/awesome.md) ideas
   Difference between videos can be **up to ~0.5 seconds** in worst case. Especially when playing from network share, 
   due buffering time and network latency.
 
-- Currently, tested only on:
+- Currently, tested on:
   - Linux (Ubuntu 20.04)
   - Windows 7 (32-bit)
   - Windows 10 (64-bit)
@@ -102,7 +106,7 @@ Awesome [use-case](./docs/awesome.md) ideas
 - [Syncplay](https://github.com/Syncplay/syncplay) - very promised, but little [complicated](https://github.com/Syncplay/syncplay/discussions/463) for sync different videos
 - [bino](https://bino3d.org/) - working, very strange controls, file dialog not working and only fullscreen
 - [gridplayer](https://github.com/vzhd1701/gridplayer) - low fps by some reason
-- [mpv](https://github.com/mpv-player/mpv) - with [mixing multiple videos](https://superuser.com/a/1325668/1272472) in one window. Unfortunally does not support multiple screens
+- [mpv](https://github.com/mpv-player/mpv) - with [mixing multiple videos](https://superuser.com/a/1325668/1272472) in one window. Unfortunately does not support multiple screens
 - [AVPlayer](http://www.awesomevideoplayer.com/) - only Win, macOS, up to 4 videos in free version
 
 ## Contributing

{vlcsync-0.2.1 → vlcsync-0.3.1}/README.md

@@ -1,7 +1,7 @@
 VLC Sync
 ========
 
-Utility for synchronize multiple instances of VLC. Supports seek, play and pause. 
+Utility for synchronize multiple instances of VLC. Supports seek, play and pause/stop, playlist and volume sync. 
   
 
 #### Motivation
@@ -43,6 +43,10 @@ $ vlcsync --rc-host 192.168.1.100:12345 --rc-host 192.168.1.50:54321
 # For disable local discovery (only remote instances)
 $ vlcsync --no-local-discovery --rc-host 192.168.1.100:12345
 
+# Started from version 0.3.0 (playlists sync)
+# Support volume sync for exotic cases
+$ vlcsync --volume-sync
+
 # For help and see all options
 $ vlcsync --help
 ```
@@ -61,7 +65,7 @@ Awesome [use-case](./docs/awesome.md) ideas
   Difference between videos can be **up to ~0.5 seconds** in worst case. Especially when playing from network share, 
   due buffering time and network latency.
 
-- Currently, tested only on:
+- Currently, tested on:
   - Linux (Ubuntu 20.04)
   - Windows 7 (32-bit)
   - Windows 10 (64-bit)
@@ -74,7 +78,7 @@ Awesome [use-case](./docs/awesome.md) ideas
 - [Syncplay](https://github.com/Syncplay/syncplay) - very promised, but little [complicated](https://github.com/Syncplay/syncplay/discussions/463) for sync different videos
 - [bino](https://bino3d.org/) - working, very strange controls, file dialog not working and only fullscreen
 - [gridplayer](https://github.com/vzhd1701/gridplayer) - low fps by some reason
-- [mpv](https://github.com/mpv-player/mpv) - with [mixing multiple videos](https://superuser.com/a/1325668/1272472) in one window. Unfortunally does not support multiple screens
+- [mpv](https://github.com/mpv-player/mpv) - with [mixing multiple videos](https://superuser.com/a/1325668/1272472) in one window. Unfortunately does not support multiple screens
 - [AVPlayer](http://www.awesomevideoplayer.com/) - only Win, macOS, up to 4 videos in free version
 
 ## Contributing

{vlcsync-0.2.1 → vlcsync-0.3.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "vlcsync"
-version = "0.2.1"
+version = "0.3.1"
 description = "Utility for synchronize multiple instances of VLC. Supports seek, play and pause. "
 authors = ["mrkeuz <mrkeuz@users.noreply.github.com>"]
 license = "MIT"

vlcsync-0.3.1/setup.py

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+from setuptools import setup
+
+packages = \
+['vlcsync']
+
+package_data = \
+{'': ['*']}
+
+install_requires = \
+['cached-property', 'click>=8.1.3,<9.0.0', 'loguru', 'psutil']
+
+entry_points = \
+{'console_scripts': ['vlcsync = vlcsync.main:main']}
+
+setup_kwargs = {
+    'name': 'vlcsync',
+    'version': '0.3.1',
+    'description': 'Utility for synchronize multiple instances of VLC. Supports seek, play and pause. ',
+    'long_description': 'VLC Sync\n========\n\nUtility for synchronize multiple instances of VLC. Supports seek, play and pause/stop, playlist and volume sync. \n  \n\n#### Motivation\n\nStrongly inspired by F1 streams with extra driver tracking data streams. Did [not find](#alternatives) reasonable alternative for Linux for playing several videos synchronously. So decided to write my own solution.\n\n## Install\n\n```shell\npip3 install -U vlcsync\n```\n\nor \n\n- Download [binary release](https://github.com/mrkeuz/vlcsync/releases) for Windows 7/10  \n  NOTE: On some systems there are false positive Antivirus warnings [issues](https://github.com/mrkeuz/vlcsync/issues/1).\n  In this case use [alternative way](./docs/install.md#windows-detailed-instructions) to install.   \n\n## Run\n\n`Vlc` players should open with `--rc-host 127.0.0.42` option OR configured properly from gui (see [how configure vlc](./docs/vlc_setup.md)) \n\n```shell\n\n# Run vlc players \n$ vlc --rc-host 127.0.0.42 SomeMedia1.mkv &\n$ vlc --rc-host 127.0.0.42 SomeMedia2.mkv &\n$ vlc --rc-host 127.0.0.42 SomeMedia3.mkv &\n\n# vlcsync will monitor and syncing all players\n$ vlcsync\n\n# Started from version 0.2.0\n\n# For control remote vlc instances, \n# remote port should be open and rc interface listen on 0.0.0.0\n$ vlcsync --rc-host 192.168.1.100:12345 --rc-host 192.168.1.50:54321\n\n# For disable local discovery (only remote instances)\n$ vlcsync --no-local-discovery --rc-host 192.168.1.100:12345\n\n# Started from version 0.3.0 (playlists sync)\n# Support volume sync for exotic cases\n$ vlcsync --volume-sync\n\n# For help and see all options\n$ vlcsync --help\n```\n\n## Awesome \n\nAwesome [use-case](./docs/awesome.md) ideas\n\n## Demo\n\n![vlcsync](./docs/vlcsync.gif)\n\n## Limitations \n\n- Frame-to-frame sync NOT provided. `vlc` does not have precise controlling via `rc` interface out of box. \n  Difference between videos can be **up to ~0.5 seconds** in worst case. Especially when playing from network share, \n  due buffering time and network latency.\n\n- Currently, tested on:\n  - Linux (Ubuntu 20.04)\n  - Windows 7 (32-bit)\n  - Windows 10 (64-bit)\n\n## Alternatives\n\n- [vlc](https://www.videolan.org/vlc/index.ru.html) \n    - There is a [netsync](https://wiki.videolan.org/Documentation:Modules/netsync/) but seem only master-slave (tried, but not working by some reason)\n    - Open additional media. Seems feature broken in vlc 3 (also afaik limited only 2 streams)  \n- [Syncplay](https://github.com/Syncplay/syncplay) - very promised, but little [complicated](https://github.com/Syncplay/syncplay/discussions/463) for sync different videos\n- [bino](https://bino3d.org/) - working, very strange controls, file dialog not working and only fullscreen\n- [gridplayer](https://github.com/vzhd1701/gridplayer) - low fps by some reason\n- [mpv](https://github.com/mpv-player/mpv) - with [mixing multiple videos](https://superuser.com/a/1325668/1272472) in one window. Unfortunately does not support multiple screens\n- [AVPlayer](http://www.awesomevideoplayer.com/) - only Win, macOS, up to 4 videos in free version\n\n## Contributing\n\nAny thoughts, ideas and contributions welcome!\n\nA special thanks to **KorDen32** for inspiration! <img src="./docs/F1.svg" alt="F1" width="45"/>\n\nEnjoy!\n',
+    'author': 'mrkeuz',
+    'author_email': 'mrkeuz@users.noreply.github.com',
+    'maintainer': None,
+    'maintainer_email': None,
+    'url': 'https://github.com/mrkeuz/vlcsync/',
+    'packages': packages,
+    'package_data': package_data,
+    'install_requires': install_requires,
+    'entry_points': entry_points,
+    'python_requires': '>=3.8,<4.0',
+}
+
+
+setup(**setup_kwargs)

{vlcsync-0.2.1 → vlcsync-0.3.1}/vlcsync/cli.py

@@ -11,7 +11,8 @@ from vlcsync.syncer import AppConfig, Syncer
 from vlcsync.vlc_finder import print_exc
 from vlcsync.vlc_state import VlcId
 
-__version__ = "0.2.1"
+# Also ref in project.toml
+__version__ = "0.3.1"
 
 
 @click.command
@@ -28,20 +29,32 @@ __version__ = "0.2.1"
               required=False,
               is_flag=True,
               help="Disable discovery local vlc instances.")
-def main(rc_host_list: Set[VlcId], no_local_discover):
+@click.option("--volume-sync",
+              "volume_sync",
+              default=False,
+              required=False,
+              is_flag=True,
+              help=
+              """
+              Enable volume sync between players. Useful for play video with external audio file.\n
+              I.e. first play video with disabled audio track ('vlc --no-audio video.mkv' option) and then play audio stream (`vlc audio.mka`).
+              \n  
+              And you can control volume from main video player.
+              """)
+def main(rc_host_list: Set[VlcId], no_local_discover, volume_sync):
     """Utility for synchronize multiple instances of VLC. Supports seek, play and pause."""
-    print("Vlcsync started...")
+    print("Vlcsync started...", flush=True)
 
-    app_config = AppConfig(rc_host_list, no_local_discover)
+    app_config = AppConfig(rc_host_list, no_local_discover, volume_sync)
     time.sleep(2)  # Wait instances
     while True:
         try:
             with Syncer(app_config) as s:
                 while True:
-                    s.do_sync()
+                    s.do_check_synchronized()
                     time.sleep(0.05)
         except KeyboardInterrupt:
             sys.exit(0)
         except Exception:
             print_exc()
-            print("Exception detected. Restart sync...")
+            print("Exception detected. Restart sync...", flush=True)

vlcsync-0.3.1/vlcsync/syncer.py

@@ -0,0 +1,114 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+import sys
+import time
+from typing import Set, List
+
+from loguru import logger
+
+from vlcsync.vlc import VLC_IFACE_IP, VlcProcs, Vlc
+from vlcsync.vlc_finder import LocalProcessFinderProvider, ExtraHostFinder
+from vlcsync.vlc_socket import VlcConnectionError
+
+from vlcsync.vlc_state import VlcId
+
+
+@dataclass
+class AppConfig:
+    extra_rc_hosts: Set[VlcId]
+    no_local_discovery: bool
+    volume_sync: bool
+
+
+class Syncer:
+    def __init__(self, app_config: AppConfig):
+        self.env = None
+        self.app_config = app_config
+        self.supress_log_until = 0
+
+        vlc_finders = set()
+        if not self.app_config.no_local_discovery:
+            vlc_finders.add(LocalProcessFinderProvider(VLC_IFACE_IP))
+            print(f"  Discover instances on {VLC_IFACE_IP} iface...", flush=True)
+        else:
+            print("  Local discovery vlc instances DISABLED...", flush=True)
+
+        if app_config.extra_rc_hosts:
+            vlc_finders.add(ExtraHostFinder(app_config.extra_rc_hosts))
+            for rc_host in app_config.extra_rc_hosts:
+                rc_host: VlcId
+                print(f"  Manual host defined {rc_host.addr}:{rc_host.port}", flush=True)
+        else:
+            print("""  Manual vlc addresses ("--rc-host" args) NOT provided...""", flush=True)
+
+        if not vlc_finders:
+            print("\nTarget vlc instances not selected (nor autodiscover, nor manually). \n"
+                  """See: "vlcsync --help" for more info""", flush=True)
+            sys.exit(1)
+
+        self.env = VlcProcs(vlc_finders)
+
+    def __enter__(self):
+        self.do_check_synchronized()
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self.close()
+
+    def do_check_synchronized(self):
+        self.log_with_debounce("do_check_synchronized()...")
+        try:
+            if self.app_config.volume_sync:
+                self.sync_volume()
+
+            self.sync_playstate()
+
+        except VlcConnectionError as e:
+            self.env.dereg(e.vlc_id)
+
+    def sync_playstate(self):
+        for vlc_id, vlc in self.env.all_vlc.items():
+            is_changed, state, playlist_changed = vlc.is_state_change()
+
+            if is_changed:
+                # Workaround Save volumes.
+                # When playlist items changed ALSO happen volumes sync by some reason. But SHOULD NOT!
+                volumes: List[tuple[Vlc, int]] = []
+                if not self.app_config.volume_sync and playlist_changed:
+                    volumes = [(vlc1, vlc1.volume()) for _, vlc1 in self.env.all_vlc.items()]
+                #
+
+                print(f"\nVlc state change detected from ({vlc_id})", flush=True)
+                self.env.sync_all(state, vlc)
+
+                # Restore volumes if needed
+                if volumes:
+                    for vlc_next, volume in volumes:
+                        vlc_next.set_volume(volume)
+                # Trying to fix endless resyncing hang
+                # Cannot find reproduce steps for that
+                time.sleep(0.5)
+                break
+
+    def sync_volume(self):
+        for vlc_id, vlc in self.env.all_vlc.items():
+            cur_volume = vlc.volume()
+            if vlc.prev_volume != cur_volume:
+                for vlc_id_for_sync, vlc_for_sync in self.env.all_vlc.items():
+                    vlc_for_sync.prev_volume = cur_volume
+                    if vlc_for_sync != vlc:
+                        vlc_for_sync.set_volume(cur_volume)
+                break
+
+    def log_with_debounce(self, msg: str, _debounce=5):
+        if time.time() > self.supress_log_until:
+            logger.debug(msg)
+            self.supress_log_until = time.time() + _debounce
+
+    def __del__(self):
+        self.close()
+
+    def close(self):
+        if self.env:
+            self.env.close()

vlcsync-0.3.1/vlcsync/vlc.py

@@ -0,0 +1,246 @@
+from __future__ import annotations
+
+from functools import lru_cache
+import re
+import socket
+import threading
+import time
+from typing import Set, List, Optional
+
+from loguru import logger
+
+from vlcsync.vlc_finder import IVlcListFinder
+from vlcsync.vlc_socket import VlcSocket
+from vlcsync.vlc_state import PlayState, State, VlcId, PlayList, PlayListItem
+
+VLC_IFACE_IP = "127.0.0.42"
+RE_PLAYSTATE_COMPILED = re.compile(r"\( state (playing|stopped|paused) \)")
+RE_PLAYLIST_ITEM = re.compile(r'\| {2}([ *])(\d+) - ')
+
+socket.setdefaulttimeout(0.5)
+
+
+class Vlc:
+    def __init__(self, vlc_id: VlcId):
+        self.vlc_id = vlc_id
+        self.vlc_conn = VlcSocket(vlc_id)
+        self.prev_state: State = self.cur_state()
+        self.prev_volume = self.volume()
+
+    def play_state(self) -> PlayState:
+        status = self.vlc_conn.cmd("status")
+        return self._extract_state(status)
+
+    def get_seek(self) -> int | None:
+        seek = self.vlc_conn.cmd("get_time")
+        if seek != '':
+            return int(seek)
+
+    def playlist_goto(self, vlc_internal_index: int):
+        self.vlc_conn.cmd(f"goto {vlc_internal_index}")
+
+    def playlist(self) -> PlayList:
+        cmd_resp = self.vlc_conn.cmd("playlist")
+        return self._extract_playlist(cmd_resp)
+
+    def volume(self) -> Optional[int]:
+        vol = self.vlc_conn.cmd("volume")
+        if vol.strip() != '':
+            return int(float(vol.replace(",",'.')))
+        else:
+            return None
+
+    def set_volume(self, volume: int):
+        self.vlc_conn.cmd(f"volume {volume}")
+        self.prev_volume = volume
+
+    def seek(self, seek: int):
+        self.vlc_conn.cmd(f"seek {seek}")
+
+    def stop(self):
+        self.vlc_conn.cmd("stop")
+
+    def pause(self):
+        self.vlc_conn.cmd("pause")
+
+    def play(self):
+        self.vlc_conn.cmd("play")
+
+    def cur_state(self) -> State:
+        cur_seek = self.get_seek()
+
+        return State(self.play_state(),
+                     cur_seek,
+                     self.playlist().active_order_index(),
+                     # Abs time of video start
+                     time.time() - (cur_seek or 0)
+                     )
+
+    def is_state_change(self) -> (bool, State):
+        cur_state: State = self.cur_state()
+        prev_state: State = self.prev_state
+        full_same, playlist_same = cur_state.same(prev_state)
+
+        # Return cur_state for reduce further socket communications
+        return not full_same, cur_state, not playlist_same
+
+    def sync_to(self, new_state: State, source: Vlc):
+
+        self._sync_playlist(new_state)
+        self._sync_playstate(new_state)
+        self._sync_timeline(new_state, source)
+
+        self.prev_state = self.cur_state()
+
+    def _sync_timeline(self, new_state: State, source: Vlc):
+        cur_play_state = self.play_state()
+
+        if cur_play_state == PlayState.PAUSED and source == self:
+            """
+            Skip sync seek with himself on pause (avoid flickering)
+            As half-seconds not supported and cannot to set.
+            """
+            pass
+        else:
+            # In all other cases
+            self.seek(new_state.seek)
+
+    def _sync_playstate(self, new_state: State):
+        cur_play_state: PlayState = self.play_state()
+        if cur_play_state != new_state.play_state:
+            if new_state.play_state == PlayState.STOPPED:
+                self.stop()
+            elif new_state.play_state == PlayState.PLAYING:
+                if cur_play_state in [PlayState.PAUSED, PlayState.STOPPED]:
+                    self.play()
+            elif new_state.play_state == PlayState.PAUSED:
+                if cur_play_state == PlayState.PLAYING:
+                    self.pause()
+            else:
+                logger.warning(f"Unknown new play state {new_state.play_state} for player")
+
+    def _sync_playlist(self, new_state: State):
+        cur_playlist = self.playlist()
+        if new_state.is_play_or_pause() and cur_playlist.active_order_index() != new_state.playlist_order_idx:
+            if new_state.playlist_order_idx is not None and len(cur_playlist.items) > new_state.playlist_order_idx:
+                self.playlist_goto(cur_playlist.items[new_state.playlist_order_idx].vlc_internal_index)
+            else:
+                self.stop()
+
+    @staticmethod
+    @lru_cache(maxsize=128)
+    def _extract_state(status: str):
+        match = RE_PLAYSTATE_COMPILED.search(status)
+        return PlayState(match.group(1)) if match else PlayState.UNKNOWN
+
+    @staticmethod
+    @lru_cache(maxsize=128)
+    def _extract_playlist(resp: str) -> PlayList:
+        """ Playlist answer Format:
+        +----[ Playlist - playlist ]
+        | 1 - Плейлист
+        |   6 - Video 1.mkv (00:23:37) [played 1 time]
+        |  *4 - Video 2.mkv (00:23:44) [played 2 times]
+        |   3 - Video 3.mkv (00:23:43) [played 1 time]
+        |   5 - Video 4.mkv (00:23:44) [played 1 time]
+        | 2 - Медиатека
+        |   12 - Video 6.mkv (00:23:44)
+        +----[ End of playlist ]
+        """
+
+        items: List[PlayListItem] = []
+        active: Optional[PlayListItem] = None
+
+        for idx, match in enumerate(re.finditer(RE_PLAYLIST_ITEM, resp)):
+            item = PlayListItem(idx, match.group(2))
+            items.append(item)
+            if match.group(1) == "*":
+                active = item
+
+        return PlayList(items, active)
+
+    def __repr__(self):
+        return f"Vlc({self.vlc_id}, {self.prev_state=})"
+
+    def close(self):
+        self.vlc_conn.close()
+
+
+class VlcProcs:
+    def __init__(self, vlc_list_providers: Set[IVlcListFinder]):
+        self.closed = False
+        self._vlc_instances: dict[VlcId, Vlc] = {}
+        self.vlc_list_providers = vlc_list_providers
+        self.vlc_finder_thread = threading.Thread(target=self.refresh_vlc_list_periodically, daemon=True)
+        self.vlc_finder_thread.start()
+
+    def refresh_vlc_list_periodically(self):
+        while not self.closed:
+            start = time.time()
+
+            vlc_candidates = []
+
+            for vlc_list_provider in self.vlc_list_providers:
+                vlc_list_provider: IVlcListFinder
+                next_vlc_ids_list: Set[VlcId] = vlc_list_provider.get_vlc_list()
+
+                vlc_candidates.extend(next_vlc_ids_list)
+                logger.debug(next_vlc_ids_list)
+
+            # Remove missed
+            for orphaned_vlc in (self._vlc_instances.keys() - vlc_candidates):
+                self.dereg(orphaned_vlc)
+
+            # Populate if not exists
+            for vlc_id in vlc_candidates:
+                if vlc_id not in self._vlc_instances.keys():
+                    if vlc := self.try_connect(vlc_id):
+                        print(f"Found active instance {vlc_id}, with state {vlc.cur_state()}", flush=True)
+                        self._vlc_instances[vlc_id] = vlc
+
+            logger.debug(f"Compute all_vlc (took {time.time() - start:.3f})...")
+            time.sleep(5)
+
+    @staticmethod
+    def try_connect(vlc_id):
+        try:
+            return Vlc(vlc_id)
+        except Exception as e:
+            logger.opt(exception=True).debug("Cannot connect to {0}, cause: {1}", vlc_id, e)
+            print(f"Cannot connect to {vlc_id} socket, cause: {e}. Skipping. Enable debug for more info. See --help. ", flush=True)
+            return None
+
+    @property
+    def all_vlc(self) -> dict[VlcId, Vlc]:
+        return self._vlc_instances.copy()  # copy: for thread safe
+
+    def sync_all(self, state: State, source_vlc: Vlc):
+        logger.debug(">" * 60)
+        logger.debug(f"Detect change to {state} from {source_vlc.vlc_id}")
+        logger.debug(f" old --> {source_vlc.prev_state} ")
+        logger.debug(f" new --> {state} ")
+        logger.debug(f" Time diff abs(old - new) {abs(source_vlc.prev_state.vid_start_at - state.vid_start_at)}")
+        logger.debug("<" * 60)
+        logger.debug("")
+        print(">>> Sync players...", flush=True)
+
+        for next_pid, next_vlc in self.all_vlc.items():
+            next_vlc: Vlc
+            print(f"    Sync {next_pid} to {state}", flush=True)
+            next_vlc.sync_to(state, source_vlc)
+        print()
+
+    def dereg(self, vlc_id: VlcId):
+        print(f"Detect vlc instance closed {vlc_id}", flush=True)
+        if vlc_to_close := self._vlc_instances.pop(vlc_id, None):
+            vlc_to_close.close()
+
+    def close(self):
+        for vlc in self._vlc_instances.values():
+            vlc.close()
+
+        self.closed = True
+        self._vlc_instances.clear()
+
+    def __del__(self):
+        self.close()

{vlcsync-0.2.1 → vlcsync-0.3.1}/vlcsync/vlc_finder.py

@@ -28,16 +28,16 @@ class IVlcListFinder:
 
 
 class LocalProcessFinderProvider(IVlcListFinder):
-    def __init__(self, iface):
-        self.iface = iface
+    def __init__(self, iface: str):
+        self._iface = iface
 
     def get_vlc_list(self) -> Set[VlcId]:
         vlc_ports = set()
 
         for proc in self._find_vlc_procs():
-            port = self._has_listen_port(proc, self.iface)
+            port = self._has_listen_port(proc, self._iface)
             if port:
-                vlc_ports.add(VlcId(self.iface, port, proc.pid))
+                vlc_ports.add(VlcId(self._iface, port, proc.pid))
 
         return vlc_ports
 
@@ -90,11 +90,12 @@ class LocalProcessFinderProvider(IVlcListFinder):
 
 def print_exc():
     print("-" * 60)
-    print("Exception in user code: ")
+    print("Exception in user code: ", flush=True)
     print("-" * 60)
     traceback.print_exc(file=sys.stdout)
     print("-" * 60)
     print()
+    sys.stdout.flush()
 
 
 class ExtraHostFinder(IVlcListFinder):

{vlcsync-0.2.1 → vlcsync-0.3.1}/vlcsync/vlc_state.py

@@ -38,16 +38,23 @@ class PlayState(Enum):
 class State:
     play_state: PlayState
     seek: int
-    time_diff: float = field(repr=False)
+    playlist_order_idx: int
+    """
+    vid_start_at - is abs time of video start in given vlc
+    
+    If this time changed it indicates time seek 
+    
+    See for details:
+       - play_in_same_pos()
+       - Vlc.cur_state() 
+    """
+    vid_start_at: float = field(repr=False)
 
     def same(self, other: State):
-        return (self.same_play_state(other) and
-                (
-                        self.play_in_same_pos(other) or
-                        self.pause_is_same_pos(other) or
-                        self.both_stopped(other)
-                )
-                )
+        playlist_same = self.same_playlist_item(other)
+        full_same = (self.same_play_state(other) and playlist_same and (
+                    self.play_in_same_pos(other) or self.pause_is_same_pos(other) or self.both_stopped(other)))
+        return full_same, playlist_same
 
     def same_play_state(self, other: State):
         return self.play_state == other.play_state
@@ -57,23 +64,41 @@ class State:
 
     def play_in_same_pos(self: State, other: State):
         """ Check time_diff only when play """
-        desync_secs = abs(self.time_diff - other.time_diff)
+        desync_secs = abs(self.vid_start_at - other.vid_start_at)
 
         if 2 < desync_secs < MAX_DESYNC_SECONDS:
             logger.debug(f"Asynchronous anomaly between probes: {desync_secs} secs")
 
         return (
                 self.play_state == other.play_state == PlayState.PLAYING and
-                self.time_diff and other.time_diff and
+                self.vid_start_at and other.vid_start_at and
                 desync_secs < MAX_DESYNC_SECONDS
         )
 
     def both_stopped(self, other: State):
         return self.play_state == other.play_state == PlayState.STOPPED
 
-    def is_active(self):
+    def is_play_or_pause(self):
         return self.play_state in [PlayState.PLAYING, PlayState.PAUSED]
 
+    def same_playlist_item(self, other):
+        return self.playlist_order_idx == other.playlist_order_idx
+
+
+@dataclass
+class PlayListItem:
+    order_index: int
+    vlc_internal_index: int
+
+
+@dataclass
+class PlayList:
+    items: List[PlayListItem]
+    active_item: Optional[PlayListItem]
+
+    def active_order_index(self) -> Optional[int]:
+        return self.active_item.order_index if self.active_item else None
+
 
 @dataclass(frozen=True)
 class VlcId:

vlcsync-0.2.1/setup.py

@@ -1,34 +0,0 @@
-# -*- coding: utf-8 -*-
-from setuptools import setup
-
-packages = \
-['vlcsync']
-
-package_data = \
-{'': ['*']}
-
-install_requires = \
-['cached-property', 'click>=8.1.3,<9.0.0', 'loguru', 'psutil']
-
-entry_points = \
-{'console_scripts': ['vlcsync = vlcsync.main:main']}
-
-setup_kwargs = {
-    'name': 'vlcsync',
-    'version': '0.2.1',
-    'description': 'Utility for synchronize multiple instances of VLC. Supports seek, play and pause. ',
-    'long_description': 'VLC Sync\n========\n\nUtility for synchronize multiple instances of VLC. Supports seek, play and pause. \n  \n\n#### Motivation\n\nStrongly inspired by F1 streams with extra driver tracking data streams. Did [not find](#alternatives) reasonable alternative for Linux for playing several videos synchronously. So decided to write my own solution.\n\n## Install\n\n```shell\npip3 install -U vlcsync\n```\n\nor \n\n- Download [binary release](https://github.com/mrkeuz/vlcsync/releases) for Windows 7/10  \n  NOTE: On some systems there are false positive Antivirus warnings [issues](https://github.com/mrkeuz/vlcsync/issues/1).\n  In this case use [alternative way](./docs/install.md#windows-detailed-instructions) to install.   \n\n## Run\n\n`Vlc` players should open with `--rc-host 127.0.0.42` option OR configured properly from gui (see [how configure vlc](./docs/vlc_setup.md)) \n\n```shell\n\n# Run vlc players \n$ vlc --rc-host 127.0.0.42 SomeMedia1.mkv &\n$ vlc --rc-host 127.0.0.42 SomeMedia2.mkv &\n$ vlc --rc-host 127.0.0.42 SomeMedia3.mkv &\n\n# vlcsync will monitor and syncing all players\n$ vlcsync\n\n# Started from version 0.2.0\n\n# For control remote vlc instances, \n# remote port should be open and rc interface listen on 0.0.0.0\n$ vlcsync --rc-host 192.168.1.100:12345 --rc-host 192.168.1.50:54321\n\n# For disable local discovery (only remote instances)\n$ vlcsync --no-local-discovery --rc-host 192.168.1.100:12345\n\n# For help and see all options\n$ vlcsync --help\n```\n\n## Awesome \n\nAwesome [use-case](./docs/awesome.md) ideas\n\n## Demo\n\n![vlcsync](./docs/vlcsync.gif)\n\n## Limitations \n\n- Frame-to-frame sync NOT provided. `vlc` does not have precise controlling via `rc` interface out of box. \n  Difference between videos can be **up to ~0.5 seconds** in worst case. Especially when playing from network share, \n  due buffering time and network latency.\n\n- Currently, tested only on:\n  - Linux (Ubuntu 20.04)\n  - Windows 7 (32-bit)\n  - Windows 10 (64-bit)\n\n## Alternatives\n\n- [vlc](https://www.videolan.org/vlc/index.ru.html) \n    - There is a [netsync](https://wiki.videolan.org/Documentation:Modules/netsync/) but seem only master-slave (tried, but not working by some reason)\n    - Open additional media. Seems feature broken in vlc 3 (also afaik limited only 2 streams)  \n- [Syncplay](https://github.com/Syncplay/syncplay) - very promised, but little [complicated](https://github.com/Syncplay/syncplay/discussions/463) for sync different videos\n- [bino](https://bino3d.org/) - working, very strange controls, file dialog not working and only fullscreen\n- [gridplayer](https://github.com/vzhd1701/gridplayer) - low fps by some reason\n- [mpv](https://github.com/mpv-player/mpv) - with [mixing multiple videos](https://superuser.com/a/1325668/1272472) in one window. Unfortunally does not support multiple screens\n- [AVPlayer](http://www.awesomevideoplayer.com/) - only Win, macOS, up to 4 videos in free version\n\n## Contributing\n\nAny thoughts, ideas and contributions welcome!\n\nA special thanks to **KorDen32** for inspiration! <img src="./docs/F1.svg" alt="F1" width="45"/>\n\nEnjoy!\n',
-    'author': 'mrkeuz',
-    'author_email': 'mrkeuz@users.noreply.github.com',
-    'maintainer': None,
-    'maintainer_email': None,
-    'url': 'https://github.com/mrkeuz/vlcsync/',
-    'packages': packages,
-    'package_data': package_data,
-    'install_requires': install_requires,
-    'entry_points': entry_points,
-    'python_requires': '>=3.8,<4.0',
-}
-
-
-setup(**setup_kwargs)

vlcsync-0.2.1/vlcsync/syncer.py

@@ -1,84 +0,0 @@
-from __future__ import annotations
-
-from dataclasses import dataclass
-import sys
-import time
-from typing import Set
-
-from loguru import logger
-
-from vlcsync.vlc import VLC_IFACE_IP, VlcProcs
-from vlcsync.vlc_finder import LocalProcessFinderProvider, ExtraHostFinder
-from vlcsync.vlc_socket import VlcConnectionError
-
-from vlcsync.vlc_state import VlcId
-
-
-@dataclass
-class AppConfig:
-    extra_rc_hosts: Set[VlcId]
-    no_local_discovery: bool
-
-
-class Syncer:
-    def __init__(self, app_config: AppConfig):
-        self.env = None
-        self.app_config = app_config
-        self.supress_log_until = 0
-
-        vlc_finders = set()
-        if not self.app_config.no_local_discovery:
-            vlc_finders.add(LocalProcessFinderProvider(VLC_IFACE_IP))
-            print(f"  Discover instances on {VLC_IFACE_IP} iface...")
-        else:
-            print("  Local discovery vlc instances DISABLED...")
-
-        if app_config.extra_rc_hosts:
-            vlc_finders.add(ExtraHostFinder(app_config.extra_rc_hosts))
-            for rc_host in app_config.extra_rc_hosts:
-                rc_host: VlcId
-                print(f"  Manual host defined {rc_host.addr}:{rc_host.port}")
-        else:
-            print("""  Manual vlc addresses ("--rc-host" args) NOT provided...""")
-
-        if not vlc_finders:
-            print("\nTarget vlc instances not selected (nor autodiscover, nor manually). \n"
-                  """See: "vlcsync --help" for more info""")
-            sys.exit(1)
-
-        self.env = VlcProcs(vlc_finders)
-
-    def __enter__(self):
-        self.do_sync()
-        return self
-
-    def __exit__(self, exc_type, exc_val, exc_tb):
-        self.close()
-
-    def do_sync(self):
-        self.log_with_debounce("Sync...")
-        try:
-            for vlc_id, vlc in self.env.all_vlc.items():
-                is_changed, state = vlc.is_state_change()
-                if not state.is_active():
-                    continue
-
-                if is_changed:
-                    print(f"\nVlc state change detected from ({vlc_id})")
-                    self.env.sync_all(state, vlc)
-                    return
-
-        except VlcConnectionError as e:
-            self.env.dereg(e.vlc_id)
-
-    def log_with_debounce(self, msg: str, _debounce=5):
-        if time.time() > self.supress_log_until:
-            logger.debug(msg)
-            self.supress_log_until = time.time() + _debounce
-
-    def __del__(self):
-        self.close()
-
-    def close(self):
-        if self.env:
-            self.env.close()

vlcsync-0.2.1/vlcsync/vlc.py

@@ -1,176 +0,0 @@
-from __future__ import annotations
-
-import socket
-import threading
-import time
-from typing import Set
-
-from loguru import logger
-
-from vlcsync.vlc_finder import IVlcListFinder
-from vlcsync.vlc_socket import VlcSocket
-from vlcsync.vlc_state import PlayState, State, VlcId
-
-VLC_IFACE_IP = "127.0.0.42"
-
-socket.setdefaulttimeout(0.5)
-
-
-class Vlc:
-    def __init__(self, vlc_id: VlcId):
-        self.vlc_id = vlc_id
-        self.vlc_conn = VlcSocket(vlc_id)
-        self.prev_state: State = self.cur_state()
-
-    def play_state(self) -> PlayState:
-        status = self.vlc_conn.cmd("status")
-        return self._extract_state(status)
-
-    def get_time(self) -> int | None:
-        seek = self.vlc_conn.cmd("get_time")
-        if seek != '':
-            return int(seek)
-
-    def seek(self, seek: int):
-        self.vlc_conn.cmd(f"seek {seek}")
-
-    def cur_state(self) -> State:
-        get_time = self.get_time()
-
-        return State(self.play_state(),
-                     get_time,
-                     time.time() - (get_time or 0))
-
-    def is_state_change(self) -> (bool, State):
-        cur_state: State = self.cur_state()
-        prev_state: State = self.prev_state
-        is_change = not cur_state.same(prev_state)
-
-        # Return cur_state for reduce further socket communications
-        return is_change, cur_state
-
-    def sync_to(self, new_state: State, source: Vlc):
-        if not new_state.is_active():
-            return
-
-        cur_play_state = self.play_state()
-
-        if cur_play_state != new_state.play_state:
-            self.play_if_pause(new_state, cur_play_state)
-            self.pause_if_play(new_state, cur_play_state)
-
-        # Sync all secondary, but main only when playing
-        if source != self or cur_play_state == PlayState.PLAYING:
-            self.seek(new_state.seek)
-
-        self.prev_state = self.cur_state()
-
-    def pause_if_play(self, new_state, cur_play_state):
-        if cur_play_state == PlayState.PLAYING and new_state.play_state == PlayState.PAUSED:
-            self.vlc_conn.cmd("pause")
-
-    def play_if_pause(self, new_state, cur_play_state):
-        if cur_play_state == PlayState.PAUSED and new_state.play_state == PlayState.PLAYING:
-            self.vlc_conn.cmd("play")
-
-    @staticmethod
-    def _extract_state(status, _valid_states=(PlayState.PLAYING.value,
-                                              PlayState.PAUSED.value,
-                                              PlayState.STOPPED.value)):
-        for pb_state in _valid_states:
-            if pb_state in status:
-                return PlayState(pb_state)
-
-        return PlayState.UNKNOWN
-
-    def __repr__(self):
-        return f"Vlc({self.vlc_id}, {self.prev_state=})"
-
-    def close(self):
-        self.vlc_conn.close()
-
-
-class VlcProcs:
-    def __init__(self, vlc_list_providers: Set[IVlcListFinder]):
-        self.closed = False
-        self._vlc_instances: dict[VlcId, Vlc] = {}
-        self.vlc_list_providers = vlc_list_providers
-        self.vlc_finder_thread = threading.Thread(target=self.refresh_vlc_list_periodically, daemon=True)
-        self.vlc_finder_thread.start()
-
-    def refresh_vlc_list_periodically(self):
-        while not self.closed:
-            start = time.time()
-
-            vlc_candidates = []
-
-            for vlc_list_provider in self.vlc_list_providers:
-                vlc_list_provider: IVlcListFinder
-                next_vlc_ids_list: Set[VlcId] = vlc_list_provider.get_vlc_list()
-
-                vlc_candidates.extend(next_vlc_ids_list)
-                logger.debug(next_vlc_ids_list)
-
-            # Remove missed
-            for orphaned_vlc in (self._vlc_instances.keys() - vlc_candidates):
-                self.dereg(orphaned_vlc)
-
-            # Populate if not exists
-            for vlc_id in vlc_candidates:
-                if vlc_id not in self._vlc_instances.keys():
-                    if vlc := self.try_connect(vlc_id):
-                        print(f"Found active instance {vlc_id}, with state {vlc.cur_state()}")
-                        self._vlc_instances[vlc_id] = vlc
-
-            logger.debug(f"Compute all_vlc (took {time.time() - start:.3f})...")
-            time.sleep(5)
-
-    @staticmethod
-    def try_connect(vlc_id):
-        try:
-            return Vlc(vlc_id)
-        except Exception as e:
-            logger.opt(exception=True).debug("Cannot connect to {0}, cause: {1}", vlc_id, e)
-            print(f"Cannot connect to {vlc_id} socket, cause: {e}. Skipping. Enable debug for more info. See --help. ")
-            return None
-
-    @property
-    def all_vlc(self) -> dict[VlcId, Vlc]:
-        return self._vlc_instances.copy()  # copy: for thread safe
-
-    def sync_all(self, state: State, source: Vlc):
-        logger.debug(">" * 60)
-        logger.debug(f"Detect change to {state} from {source.vlc_id}")
-        logger.debug(f" old --> {source.prev_state} ")
-        logger.debug(f" new --> {state} ")
-        logger.debug(f" Time diff abs(old - new) {abs(state.time_diff - source.prev_state.time_diff)}")
-        logger.debug("<" * 60)
-        logger.debug("")
-        print(">>> Sync windows...")
-        if not state.is_active():
-            print("   Source window stopped. Skip sync")
-            return
-
-        for next_pid, next_vlc in self.all_vlc.items():
-            next_vlc: Vlc
-            if next_vlc.cur_state().is_active():
-                print(f"    Sync {next_pid} to {state}")
-                next_vlc.sync_to(state, source)
-        print()
-
-    def dereg(self, vlc_id: VlcId):
-        print(f"Detect vlc instance closed {vlc_id}")
-        if vlc_to_close := self._vlc_instances.pop(vlc_id, None):
-            vlc_to_close.close()
-
-    def close(self):
-        for vlc in self._vlc_instances.values():
-            vlc.close()
-
-        self.closed = True
-        self._vlc_instances.clear()
-
-    def __del__(self):
-        self.close()
-
-