aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 0a248b022857e728ae8dbe342370bdc300a19a30 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# Media Player with Effects

This is a simple and minimal media player, written in Java, with additional basic editing features such as adding a hue to a video, grey scaling the video, and splitting the video into its frames and storing them into a frame-dump folder.

## Features

- Play videos
- Add a hue to the video
- Grey scale the video
- Split the video into its frames and store them into a frame-dump folder

## Dependencies

- Java Development Kit (JDK)
- IDE (Integrated Development Environment) or a text editor
- A video file to play

## Usage

1. Compile and run the program using your IDE or the command line

`javac src/Main.java`
`java Main`

2. The program will open up a GUI for the media player, where you can open a video file and play it.
3. You can also use the additional features by clicking on the corresponding buttons on the GUI.
4.  The program will also create a folder in the current directory where the code is running, named 'frame-dump' where the frames will be saved.

## Note

- The program uses the JavaFX library for GUI, it might be necessary to add the JavaFX library to the classpath while compiling the code.
- The program uses the JavaFX MediaPlayer class to play the video, it only supports a specific set of video formats, like MP4, AVI, MKV, etc.
- The program saves the frames in the 'frame-dump' folder in the current directory where the code is running. Do not run long videos if you do not have much hard drive space available.

## License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.