Skip to content

Commit

Permalink
Added generic build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
nurupo committed Aug 27, 2015
1 parent ebe4f9c commit 148187a
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 1 deletion.
35 changes: 35 additions & 0 deletions common/building.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## Building (all platforms)

If instead of using the precompiled plugin binaries you want to build Windows or OS X plugin binary yourself or for some reason Debian instructions don't work for you, you can follow these instructions on building the plugin.

What these instructions sum up to is building VLC itself with the plugin integrated into its source tree / build system, so that the plugin would be built together with VLC.

Git clone VLC:

```sh
git clone git://git.videolan.org/vlc.git
```

Checkout the git tag that matches VLC version that you want to build the plugin for. You can use `git tag` to get a list of all tags available. As of writing this there is no tag for 3.0 version yet, so `master` branch should be used. For example, for 2.2.0 you would do:

```sh
cd vlc
git checkout 2.2.0-git
```

Add the plugin into the VLC build system by copying the appropriate version of `pause_click.c` (there are [vlc-2.1.x](/vlc-2.1.x) and [vlc-2.2.x+](/vlc-2.2.x+) versions) into `modules/video_filter/`.

Add

```
libpause_click_plugin_la_SOURCES = pause_click.c
libpause_click_plugin_la_CFLAGS = $(AM_CFLAGS)
libpause_click_plugin_la_LIBADD = $(AM_LIBADD)
video_filter_LTLIBRARIES += libpause_click_plugin.la
```

to the `Modules.am` or `Makefile.am` file, whichever is present in `modules/video_filter/`.

Build VLC the way you would usually do so. There should be some instruction on VLC wiki, you should be able to google that. Note that you don't care for VLC itself, you just care for the plugin to be built, so if something fails your build and there is an option to disable that thing that is failing from being built -- there is no harm in doing so.

After the build is done, you should have `libpause_click_plugin.dll` or `libpause_click_plugin.so` or `libpause_click_plugin.dylib` (the extension depends on the target platform) somewhere in `modules/video_filter/` of the build tree. That's the plugin binary that you want.
9 changes: 9 additions & 0 deletions vlc-2.1.x/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ VLC version | 32 bit | 64 bit

Extract the archive at `{VLC}/plugins/video_filter/`

If you want to build the plugin binary yourself, take a look at the [build instructions](/common/building.md).

### OS X
There are currently no precompiled OS X plugin binaries.

[You are welcome to contribute them though](/common/building.md).

### Debian
Get required libraries and tools:
```bash
Expand All @@ -27,6 +34,8 @@ make
sudo make install
```

If those instructions don't work for you (perhaps you are using a non-Debian-derived Linux distribuion or don't have `libvlccore` available), [there is another way to build the plugin binary](/common/building.md).

## Usage
1. Restart VLC to load the newly added plugin
2. Go into advanced preferences: Tools -> Preferences -> Show settings -> All
Expand Down
11 changes: 10 additions & 1 deletion vlc-2.2.x+/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,18 @@ Download an appropriate archive:

VLC version | 32 bit | 64 bit
----------- | ------- | -------
2.2.x | [Tested on 2.2.0](https://github.com/nurupo/vlc-pause-click-plugin/releases/download/0.2.0/vlc-2.2.x-32bit-win.zip) | [Not tested](https://github.com/nurupo/vlc-pause-click-plugin/releases/download/0.2.0/vlc-2.2.x-64bit-win.zip)
2.2.x | [Tested on 2.2.0](https://github.com/nurupo/vlc-pause-click-plugin/releases/download/0.2.0/vlc-2.2.x-32bit-win.zip) | [Tested on 2.2.0](https://github.com/nurupo/vlc-pause-click-plugin/releases/download/0.2.0/vlc-2.2.x-64bit-win.zip)
3.0.x | [Tested on 3.0.0](https://github.com/nurupo/vlc-pause-click-plugin/releases/download/0.2.0/vlc-3.0.x-32bit-win.zip) | [Tested on 3.0.0](https://github.com/nurupo/vlc-pause-click-plugin/releases/download/0.2.0/vlc-3.0.x-64bit-win.zip)

Extract the archive at `{VLC}/plugins/video_filter/`

If you want to build the plugin binary yourself, take a look at the [build instructions](/common/building.md).

### OS X
There are currently no precompiled OS X plugin binaries.

[You are welcome to contribute them though](/common/building.md).

### Debian
Get required libraries and tools:
```bash
Expand All @@ -30,6 +37,8 @@ sudo make install

Note: because of API change in VLC 2.2.0 this build requires `vlc_interface.h`, which is not present in libvlccore-dev package since it's not considered to be a public header by VLC build system. `vlc_interface.h` that is present here is from the current master branch of VLC (3.0.0). It's highly unlikely, but if the plugin doesn't work, you might need to get `vlc_interface.h` appropriate for your VLC version out of the VLC source tree.

If those instructions don't work for you (perhaps you are using a non-Debian-derived Linux distribuion or don't have `libvlccore` available), [there is another way to build the plugin binary](/common/building.md).

## Usage
1. Restart VLC to load the newly added plugin
2. Go into advanced preferences: Tools -> Preferences -> Show settings -> All
Expand Down

0 comments on commit 148187a

Please sign in to comment.