Rezzect/syncplay
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Merge branch 'master' of https://github.com/Uriziel/syncplay

Browse Source
This commit is contained in:
Uriziel 2012-09-23 17:17:43 +02:00
commit ce4abe6e9b
1 changed files with 31 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
README.md
View File

@ -1,52 +1,56 @@
# Syncplay
Solution to synchronize video playback across multiple instances of MPlayer and/or Media Player Classic (MPC-HC) over the Internet.
Solution to synchronize video playback across multiple instances of mplayer2 and/or Media Player Classic (MPC-HC) over the Internet.
## What does it do
Syncplay synchronises the position and play state of multiple media players so that the viewers can watch the same thing at the same time.
Syncplay synchronises the position and play state of multiple media players so that the viewers can watch the same thing at the same time without video streaming.
When one person pauses playback, the media player is paused for all users who are connected to the same server and are in the same 'room' (viewing session).
When one person seeks, all players seek to the same position. When a new person joins they will be synchronised with their fellow viewers.
## What does it not do
## What it doesn't do
Syncplay does not provide video streaming, nor does it synchronise player configuration, selected audio or subtitle track, playback rate, volume or filters. Furthermore, the user must manually choose what file to play as Syncplay does not synchronise which file is open. Finally, Syncplay does not provide a voice or text-based chat platform to allow for discussion during playback as Syncplay is intended to be used in conjunction with third-party communication software such as IRC, Mumble or Skype.
Syncplay does not use video streaming or file sharing so each user must have their own copy of the media to be played. Syncplay does not synchronise player configuration, audio or subtitle track choice, playback rate, volume or filters. Furthermore, users must manually choose what file to play as Syncplay does not synchronise which file is open. Finally, Syncplay does not provide a voice or text-based chat platform to allow for discussion during playback as Syncplay is intended to be used in conjunction with third-party communication solutions such as IRC and Mumble.
## Requirements
Frozen Windows executables are available on download page - https://github.com/Uriziel/syncplay/downloads
Frozen Windows executables are available on the download page - https://github.com/Uriziel/syncplay/downloads
On Windows: `Media Player Classic - Home Cinema (MPC-HC)` >= `1.6.3`.
On Linux: `mplayer2`. `MPlayer` >= `1.1` should be compatible, but is not supported.
For running python script you need (not needed if using frozen executable package from download page):
### Python scripts (for those not using the frozen executable package)
If you are not using the frozen executable package then you will need the following to run python scripts:
`pygtk` >= `2.0.0` (unless started with `--no-gui`)
`argparse` >= `1.1`
`pywin32` >= `r217` (mpc-hc, Windows only)
`pywin32` >= `r217` (MPC-HC, Windows only)
`twisted` >= `12.1.0`
## Supported players
### MPlayer on Linux
If you are using the frozen executable package available from the download page then you will not need to be able to run python scripts.
On Linux `syncplayClient.py` acts as a wrapper for MPlayer.
You're expected to pass filename as the first positional argument, if you wish to pass more arguments to mplayer prepend them with -- argument, it's treated as the last argument for wrapper.
## Supported players
### mplayer2 on Linux
On Linux `syncplayClient.py` acts as a wrapper for mplayer.
You're expected to pass filename as the first positional argument. If you wish to pass more arguments to mplayer prepend them with -- argument, it's treated as the last argument for wrapper.
It launches mplayer which behaves just like normal (it reacts to keyboard shortcuts etc).
Default mplayer output is suppressed, but if mplayer quits with errors, those errors will be printed (at most 50 last lines).
### Media Player Classic Home Cinema (MPC-HC) on Windows
### Media Player Classic - Home Cinema (MPC-HC) on Windows
On Windows simply running `syncplayClient.exe` opens a Syncplay command-line window for communication and a new instance of MPC-HC for synchronised video playback. This instance of MPC-HC is controlled by Syncplay through the associated command-line window, but other instances of MPC-HC will be unaffected.
On Windows simply running `syncplayClient.exe` opens a Syncplay command-line window for communication/control and a new instance of MPC-HC for synchronised video playback. This instance of MPC-HC is controlled by Syncplay through the associated command-line window, but other instances of MPC-HC will be unaffected.
## Using Syncplay
### Opening a media file with Syncplay
If you open a file with `syncplayClient` then it will automatically open Syncplay and load the file through MPC-HC on Windows and MPlayer on Linux.
If you open a file with `syncplayClient` then it will automatically open Syncplay and load the file through MPC-HC on Windows and mplayer on Linux.
### Configuration window
The configuration window allows for various settings to be configured prior to Syncplay starting.
@ -69,7 +73,7 @@ The settings to be configured are as follows:
`Server password (optional)` - Password for server. Servers that are not password protected have a blank password.
`Path to mpc-hc.exe [Windows only]` - Location of the MPC-HC executable (mpc-hc.exe or mpc-hc64.exe). If this is in a common location then it will be filled in by default. Users are adviced to check it though, if it's chosen their desired installation.
`Path to mpc-hc.exe [Windows only]` - Location of the MPC-HC executable (mpc-hc.exe or mpc-hc64.exe). If this is in a common location then it will be filled in by default. Users are advised to check that it points to their desired installation.
Pressing "Save" will save the settings and continue Syncplay start-up.
@ -91,19 +95,19 @@ Within the Syncplay command-line you can enter the following commands (and then
### Instructions on how to use Syncplay for the first time
1. Ensure that you have the latest version of MPC-HC on Windows or MPlayer on Linux.
1. Ensure that you have the latest version of MPC-HC on Windows or mplayer2 on Linux.
2. Download Syncplay from https://github.com/Uriziel/syncplay/downloads and extract to a folder of your choosing.
3. If you are running your own server then open `syncplayServer` (see "How to use the server", below)
3. If you are running your own server then open `syncplayServer` (see "How to use the server", below).
4. Open `syncplayClient` (or open the media file you wish to play with `syncplayClient`, e.g. using "Open with")
4. Open `syncplayClient` (or open the media file you wish to play with `syncplayClient`, e.g. using "Open with").
5. Enter configuration settings (see "Configuration window", above).
5. Enter configuration settings (see "Configuration window", above). Ensure that you are on the same server and room as your fellow viewers.
6. If your fellow viewers are not in the same 'room' as you then use the room command (see "Syncplay Commands", above)
6. If you don't have the file you want to play open then open it from within your media player.
7. If you don't have the file you want to play open in your media player then open it from within your media player.
7. Playing, pausing and seeking should now be synchronised with everyone else in the same 'room'.
### Command-line switches
@ -135,19 +139,18 @@ You can run `syncplayClient` with the following command-line switches to alter S
## How to use the server
You need to run `syncplayServer`. If you have a public IP then you can try to launch server on your computer
and give your friends your IP number, so they can connect to it. It will listen at port `8999`, unless stated otherwise, you
might need to allow connections to it in your firewall/router.
Run `syncplayServer` to host a Syncplay server. If you have a public IP then you can try to launch the server on your computer
and give your friends your IP number so that they can connect to it. The server software will listen on port `8999` by default, but you can specify a different port. You might need to specifically allow connections to `syncplayServer` in your firewall/router. If that is the case then please consult your firewall/router instructions or contact your network administrator.
Pass the IP or hostname to people you want to watch with and you're ready to go.
Pass the IP or hostname (and password / port if necessary) to people you want to watch with and you're ready to go. There are various online services that will tell you what your IP address is.
### Server command-line switches
`--port [port]` - use stated port instead of the default one.
`--port [port]` - Use stated port instead of the default one.
`--isolate-room` - if stated you won't be able to see users in rooms different for your.
`--isolate-room` - If specified then 'room isolation' is enabled. This means that viewers will not be able to see information about users who are in rooms other than the one they are in. This feature is reccommended for a public server, but not for a small private server.
`--password` - server password used for private servers.
`--password` - Restrict access to the Syncplay server to only those who use this password when they connect to the server. This feature is recommended for a private server but is not needed for a public server. By default the password is blank (i.e. there is no password restriction).
## How to report bugs