To run this project you need to have python 3.6 or higher installed
-
Cloning the Repository
git clone https://github.com/devclub-iitd/CommonAudioVideoCLI.git cd CommonAudioVideoCLI -
To run locally you will also need to clone the server repo in the same directory in which CommonAudioVideoCLI is.
git clone https://github.com/Harsh14901/CommonAudioVideoServer.git local-
Installing dependencies
pip3 install -r requirements.txt
-
Running the CLI
cd CommonAudioVideoCLI/cli python3 main.py [--flags]
| FLAG NAME | arguments | usage | required | default |
|---|---|---|---|---|
| - - file / -f | path to one or more video files or directories(in which case all video files inside the directory are taken to form a playlist) | indicates which videos are to be converted and queued | yes | |
| -- sub / -s | path to one more subtitle files in order | adds the subtitle track to the playback | no | - |
| -- qr | - | encodes the invite link as a qr code and prints it to the console | no | false |
| --audio-quality | low/medium/good/high | the quality of the audio to be extracted from the video file | no | medium |
| --web | - | use already hosted webserver | no | false |
| --control | - | only the host can control playback | no | false |
| --force-rebuild | - | Use this to rebuild the server (must be used the first time) | no | false |
| EVENT NAME | action |
|---|---|
| connect | emitted at the beginning to establish connection |
| disconnect | emitted when session ends |
| play | has 2 functions -- starts the playback of enqueued song, if no video is loaded, otherwise resumes the playback from where it was paused |
| pause | pauses the playback |
| seek | seeks to the given time in the playback |
Socket events, both sent and received follow the same structure as shown above and additionally, each event has the following information along with the event type :--
- epoch time -- the time in milliseconds when the command is being issued
- position -- the position of the video/audio playback
Note: The server has to create a room when 'connect' message is sent from the CLI, and return in response, the room URL. Any further messages from this socket should be considered as being emitted by the host of that room.
- Python
- ArgParser - create the command line interface
- ffmpeg - extract audio from vidoe file
- subprocess - issue bash commands from python and read VLC logs to catch play/pause events.
- socket-io Client - websocket to connect and send signals to server
- socket - tcp sockets to issue commands to VLC player