[nihav-player.git] / videoplayer / README.md

# nihav-videoplayer

nihav-player is a simple video player based on of NihAV.

## Getting Started

In order to build the player, put it into directory with other NihAV crates and invoke `cargo build`.

Usage: `nihav-player [options] inputfile1 inputfile2 ...`. Known options are:
- `-an` tells player to ignore audio stream
- `-ae` tells player to play audio stream again
- `-vn` tells player to ignore video stream
- `-ve` tells player to play video stream again
- `-seek` tells player to start playing file from the specified time
- `-vol` tells player to set playback volume (in percents to the normal one)

Recognized commands:
- escape key or `q` - quit player
- left/right arrows - tell player to skip to 10 seconds earlier or later
- up/down arrows - tell player to skip to 1 minute earlier or later
- pageup/pagedown - tell player to skip to 10 minutes earlier or later
- spacebar - pause/unpause playback
- plus/minus - increase/decrease volume by ten percent
- `m` - mute or unmute audio
- `h` - cycle through frame skip modes (none/reference frames only/intra frames only)

## Contributing

You're not supposed to. Even I hardly do that so why should you?

## License

NihAV is licensed under GNU Affero Public License - see [COPYING] for details.

Parts of the project can be relicensed to other free licenses like LGPLv2 on request.
Commit	Line	Data
	1	# nihav-videoplayer
	2
	3	nihav-player is a simple video player based on of NihAV.
	4
	5	## Getting Started
	6
	7	In order to build the player, put it into directory with other NihAV crates and invoke `cargo build`.
	8
	9	Usage: `nihav-player [options] inputfile1 inputfile2 ...`. Known options are:
	10	- `-an` tells player to ignore audio stream
	11	- `-ae` tells player to play audio stream again
	12	- `-vn` tells player to ignore video stream
	13	- `-ve` tells player to play video stream again
	14	- `-seek` tells player to start playing file from the specified time
	15	- `-vol` tells player to set playback volume (in percents to the normal one)
	16
	17	Recognized commands:
	18	- escape key or `q` - quit player
	19	- left/right arrows - tell player to skip to 10 seconds earlier or later
	20	- up/down arrows - tell player to skip to 1 minute earlier or later
	21	- pageup/pagedown - tell player to skip to 10 minutes earlier or later
	22	- spacebar - pause/unpause playback
	23	- plus/minus - increase/decrease volume by ten percent
	24	- `m` - mute or unmute audio
	25	- `h` - cycle through frame skip modes (none/reference frames only/intra frames only)
	26
	27	## Contributing
	28
	29	You're not supposed to. Even I hardly do that so why should you?
	30
	31	## License
	32
	33	NihAV is licensed under GNU Affero Public License - see [COPYING] for details.
	34
	35	Parts of the project can be relicensed to other free licenses like LGPLv2 on request.