README for the VLC media player
===============================
VLC is a popular libre and open source media player and multimedia engine,
used by a large number of individuals, professionals, companies and
institutions. Using open source technologies and libraries, VLC has been
ported to most computing platforms, including GNU/Linux, Windows, Mac OS X,
BSD, iOS and Android.
VLC can play most multimedia files, discs, streams, allows playback from
devices, and is able to convert to or stream in various formats.
The VideoLAN project was started at the university École Centrale Paris who
relicensed VLC under the GPLv2 license in February 2001. Since then, VLC has
been downloaded close to one billion times.
Links:
======
The VLC web site . . . . . http://www.videolan.org/
Support . . . . . . . . . . http://www.videolan.org/support/
Forums . . . . . . . . . . http://forum.videolan.org/
Wiki . . . . . . . . . . . http://wiki.videolan.org/
The Developers site . . . . http://wiki.videolan.org/Developers_Corner
VLC hacking guide . . . . . http://wiki.videolan.org/Hacker_Guide
Bugtracker . . . . . . . . http://trac.videolan.org/vlc/
The VideoLAN web site . . . http://www.videolan.org/
Source Code Content:
===================
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.
README - This file.
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.
extras/buildsystem - different buildsystems specific files.
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.
share/ - Common Resources files.
src/ - libvlccore source code.
test/ - testing system.
Alexandre Janniaux
authored
iosvlc.m provides a binary usable as an iOS application, forwarding the VLC arguments just like VLC on desktop. It allows easier iteration on vlccore development for iOS, without the need to test in a VLCKit application like VLC for iOS or new external application. It is currently designed for usage with dynamic plugins. To develop with it, you must generate a .ipa archive containing both the resulting binary as executable, a PkgInfo file, an Info.plist file describing the package and the libs (libvlc.dylib, libvlccore.dylib, and every plugin .dylib or additional convenience libraries that are not linked statically in the Frameworks/ directory. It must then be signed with a developer certificate allowed by Apple and provisionned with a mobileprovision file allowing installation on the given device for the same developer certificate. Then, tools like libimobiledevice can be used to start the application with additional arguments or environment variables. They can also be added in XCode through the "Edit Scheme" menu. A big part of the iOS-specific code has been originally written by Marvin Scholz in a more complete libVLC ios sample. Co-authored-by:Marvin Scholz <epirat07@gmail.com> Cherry-picked and adapted from commits: e16f4d9b 0bfe8803 96bee418 904998af 54c392d7