README.md 5.59 KB
Newer Older
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
1
2
3
4
5
# VLC media player

**VLC** is a libre and open source **media player** and **multimedia engine**,
focused on **playing everything**, and **running everywhere**.

Ashutosh Verma's avatar
Ashutosh Verma committed
6
**VLC** can play most multimedia files, discs, streams, devices and is also able to
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
7
8
9
10
convert, encode, **stream** and manipulate streams into numerous formats.

VLC is used by many over the world, on numerous platforms, for very different use cases.

Ashutosh Verma's avatar
Ashutosh Verma committed
11
The **engine of VLC** can be embedded into 3rd party applications, and is called *libVLC*.
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
12
13
14
15
16
17

**VLC** is part of the [VideoLAN project](https://videolan.org) and
is developed and supported by a community of volunteers.

The VideoLAN project was started at the university [École Centrale Paris](https://www.centralesupelec.fr/) who
relicensed VLC under the GPLv2 license in February 2001. Since then, VLC has
Ashutosh Verma's avatar
Ashutosh Verma committed
18
been downloaded **billions** of times.
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
19
20
21
22

## License

**VLC** is released under the GPLv2 *(or later)* license.
Ashutosh Verma's avatar
Ashutosh Verma committed
23
*On some platforms, it is de facto GPLv3, because of the licenses of dependencies*.
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
24
25
26
27
28
29

**libVLC**, the engine is released under the LGPLv2 *(or later)* license. \
This allows embedding the engine in 3rd party applications, while letting them to be licensed under other licenses.

# Platforms

Ashutosh Verma's avatar
Ashutosh Verma committed
30
31
32
33
VLC is available for the following platforms:
- [Windows] *(from 7 and later, including UWP platforms and all versions of Windows 10)*
- [macOS] *(10.10 and later)*
- [GNU/Linux] and affiliated
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
34
- \*BSD and affiliated
Ashutosh Verma's avatar
Ashutosh Verma committed
35
36
- [Android] *(4.2 and later)*, including Android TV and Android Auto
- [iOS] *(9 and later)*, including AppleTV and iPadOS
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
37
38
- Haiku, OS/2 and a few others.

Ashutosh Verma's avatar
Ashutosh Verma committed
39
40
41
42
43
44
[Windows]: https://www.videolan.org/vlc/download-windows.html
[macOS]: https://www.videolan.org/vlc/download-macosx.html
[GNU/Linux]: https://www.videolan.org/vlc/#download
[Android]: https://www.videolan.org/vlc/download-android.html
[iOS]: https://www.videolan.org/vlc/download-ios.html

Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
45
46
Not all platforms receive the same amount of care, due to our limited resources.

Ashutosh Verma's avatar
Ashutosh Verma committed
47
48
**Nota Bene**: The [Android app](https://code.videolan.org/videolan/vlc-android/) and
the [iOS app](https://code.videolan.org/videolan/vlc-ios/) are located in different repositories
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
49
50
51
52
53
54
than the main one.

# Contributing & Community

**VLC** is maintained by a community of people, and VideoLAN is not paying any of them.\
The community is composed of developers, helpers, maintainers, designers and writers that want
Ashutosh Verma's avatar
Ashutosh Verma committed
55
this open source project to thrive.
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
56

Ashutosh Verma's avatar
Ashutosh Verma committed
57
58
The main development of VLC is done in the C language, but this repository also contains
plenty of C++, Obj-C, asm and Rust.
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
59

Ashutosh Verma's avatar
Ashutosh Verma committed
60
61
Other repositories linked to vlc are done in languages including Kotlin/Java [(Android)](https://code.videolan.org/videolan/vlc-android/),
Swift [(iOS)](https://code.videolan.org/videolan/vlc-ios/), and C# [(libVLCSharp)](https://code.videolan.org/videolan/libvlcsharp/).
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
62

Ashutosh Verma's avatar
Ashutosh Verma committed
63
We need help with the following tasks:
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
64
65
66
67
68
69
70
- coding
- packaging for Windows, macOS and Linux distributions
- technical writing for the documentation
- design
- support
- community management and communication.

Ashutosh Verma's avatar
Ashutosh Verma committed
71
72
73
Please contribute :)

We are on IRC. You can find us on the **#videolan** channel on *[Libera.chat]*.
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
74

Ashutosh Verma's avatar
Ashutosh Verma committed
75
[Libera.chat]: https://libera.chat
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
76
77
78

## Contributions

Ashutosh Verma's avatar
Ashutosh Verma committed
79
Contributions are now done through Merge Requests on our [GitLab repository](https://code.videolan.org/videolan/vlc/).
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
80

Ashutosh Verma's avatar
Ashutosh Verma committed
81
CI and discussions should be resolved before a Merge Request can be merged.
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
82
83
84
85
86

# libVLC

**libVLC** is an embeddable engine for 3rd party applications and frameworks.

Ashutosh Verma's avatar
Ashutosh Verma committed
87
88
89
It runs on the same platforms as VLC *(and sometimes on more)* and can provide playback,
streaming and converting of multimedia files and streams.

Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
90

Ashutosh Verma's avatar
Ashutosh Verma committed
91
**libVLC** has numerous bindings for other languages, like C++, Python and C#.
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
92
93
94
95
96

# Support

## Links

Ashutosh Verma's avatar
Ashutosh Verma committed
97
Some useful links that might help you:
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
98

Ashutosh Verma's avatar
Ashutosh Verma committed
99
- [VLC web site](http://www.videolan.org/vlc/)
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
100
101
102
- [Support](https://www.videolan.org/support/)
- [Forums](https://forum.videolan.org/)
- [Wiki](https://wiki.videolan.org/)
Ashutosh Verma's avatar
Ashutosh Verma committed
103
- [Developer's Corner](https://wiki.videolan.org/Developers_Corner)
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
104
105
- [VLC hacking guide](https://wiki.videolan.org/Hacker_Guide)
- [Bugtracker](https://code.videolan.org/videolan/vlc/-/issues)
Ashutosh Verma's avatar
Ashutosh Verma committed
106
- [VideoLAN web site](https://www.videolan.org/)
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
107
108
109
110
111
112
113
114
115

## Source Code sitemap
```
ABOUT-NLS          - Notes on the Free Translation Project.
AUTHORS            - VLC authors.
COPYING            - The GPL license.
COPYING.LIB        - The LGPL license.
INSTALL            - Installation and building instructions.
NEWS               - Important modifications between the releases.
Ashutosh Verma's avatar
Ashutosh Verma committed
116
README             - Project summary.
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
117
118
119
120
121
122
123
124
125
126
THANKS             - VLC contributors.

bin/               - VLC binaries.
bindings/          - libVLC bindings to other languages.
compat/            - compatibility library for operating systems missing
                     essential functionalities.
contrib/           - Facilities for retrieving external libraries and building
                     them for systems that don't have the right versions.
doc/               - Miscellaneous documentation.
extras/analyser    - Code analyser and editor specific files.
Ashutosh Verma's avatar
Ashutosh Verma committed
127
extras/buildsystem - Different build system specific files.
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
128
129
130
131
132
133
134
135
extras/misc        - Files that don't fit in the other extras/ categories.
extras/package     - VLC packaging specific files such as spec files.
extras/tools/      - Facilities for retrieving external building tools needed
                     for systems that don't have the right versions.
include/           - Header files.
lib/               - libVLC source code.
modules/           - VLC plugins and modules. Most of the code is here.
po/                - VLC translations.
Ashutosh Verma's avatar
Ashutosh Verma committed
136
share/             - Common resource files.
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
137
src/               - libvlccore source code.
Ashutosh Verma's avatar
Ashutosh Verma committed
138
test/              - Testing system.
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
139
140
```