Skip to content

Commit a2f1dfd

Browse files
authored
Update README.md
1 parent db245f2 commit a2f1dfd

File tree

1 file changed

+34
-23
lines changed

1 file changed

+34
-23
lines changed

README.md

Lines changed: 34 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -17,36 +17,47 @@ Currently you can use it to create a h264 file and a wave file so you can watch
1717
I am finishing up and RTP implementation so you can live watch and hear your device.
1818
If you want to contribute to code or documentation, please go ahead :-D
1919

20-
## 2. Technical Docs
21-
I have written some documentation here [doc/technical_documentation.md](https://github.com/danielpaulus/quicktime_video_hack/blob/master/doc/technical_documentation.md)
22-
So if you are just interested in the protocol or if you want to implement this in a different programming language than golang, read the docs.
23-
## 3. Usage& Current State of the Tool
24-
- run `qvh --help` to see how it works
25-
- The `record` command lets you save iOS video and Audio into separate h264 and wave files.
26-
- The `gstreamer` command will render the video in a nice window on your screen. For this to work you need to install gstreamer on you machine.
20+
## 2. Installation
21+
22+
### MAC OS X LIBUSB -- IMPORTANT
23+
1. Make sure to use either this fork `https://github.com/GroundControl-Solutions/libusb`
24+
or a LibUsb version BELOW 1.0.20 or iOS devices won't be found on Mac OS X.
25+
[See Github Issue](https://github.com/libusb/libusb/issues/290)
2726

28-
Progress:
2927

30-
0. ~Fix it for MacOS X~
28+
## 3. Usage
29+
```
30+
Q.uickTime V.ideo H.ack (qvh) v0.2-beta
3131
32-
0a. Release 0.1-beta
32+
Usage:
33+
qvh devices [-v]
34+
qvh activate [--udid=<udid>] [-v]
35+
qvh record <h264file> <wavfile> [-v] [--udid=<udid>]
36+
qvh gstreamer [-v]
37+
qvh --version | version
3338
34-
1. Use Gstreamer to create a nice Window with Video and Audio
35-
2. Release 0.2-beta
36-
3. Allow Creating MPEG files
37-
4. Release 0.3-beta
38-
5. BUG- Linux Only: After running the tool to grab AV data, you have to unplug the device to make it work again
39-
6. BUG- MacOSX Only: After running the tool, you have to wait a while until it works again (or keep restarting the tool)
4039
41-
Extra Goals:
40+
Options:
41+
-h --help Show this screen.
42+
-v Enable verbose mode (debug logging).
43+
--version Show version.
44+
--udid=<udid> UDID of the device. If not specified, the first found device will be used automatically.
4245
43-
1. ~~[Port to Windows](https://github.com/danielpaulus/quicktime_video_hack/tree/windows/windows) (I don't know why, but still people use Windows nowadays)~~ Did not find a way to do it
46+
The commands work as following:
47+
devices lists iOS devices attached to this host and tells you if video streaming was activated for them
48+
activate enables the video streaming config for the device specified by --udid
49+
record will start video&audio recording. Video will be saved in a raw h264 file playable by VLC.
50+
Audio will be saved in a uncompressed wav file.
51+
Run like: "qvh record /home/yourname/out.h264 /home/yourname/out.wav"
52+
gstreamer qvh will open a new window and push AV data to gstreamer.
53+
```
4454

55+
## 3. Technical Docs
56+
I have written some documentation here [doc/technical_documentation.md](https://github.com/danielpaulus/quicktime_video_hack/blob/master/doc/technical_documentation.md)
57+
So if you are just interested in the protocol or if you want to implement this in a different programming language than golang, read the docs.
58+
59+
I have given up on windows support :-)
60+
~~[Port to Windows](https://github.com/danielpaulus/quicktime_video_hack/tree/windows/windows) (I don't know why, but still people use Windows nowadays)~~ Did not find a way to do it
4561

4662

47-
## 4. Additional Notes
48-
### MAC OS X LIBUSB -- IMPORTANT
49-
1. Make sure to use either this fork `https://github.com/GroundControl-Solutions/libusb`
50-
or a LibUsb version BELOW 1.0.20 or iOS devices won't be found on Mac OS X.
51-
[See Github Issue](https://github.com/libusb/libusb/issues/290)
5263

0 commit comments

Comments
 (0)