Vamp# Instructions

User Manual:

Open the PDF directly: View PDF .
Page Count: 66

Download
Open PDF In Browser	View PDF

Petteri Kautonen, VPKSoft
14.10.2018

vamp# instructions
Table of Contents
vamp# instructions................................................................................................................................3
What is the vamp#................................................................................................................................3
The used libraries and the programming technique..............................................................................3
Play an arbitrary file.............................................................................................................................4
Play an arbitrary file via the menu item...............................................................................................4
Play a file from the list.........................................................................................................................5
Movie collection...................................................................................................................................6
Watching movies..................................................................................................................................8
TV show season collection...................................................................................................................9
Watching TV shows............................................................................................................................11
DVD / optical disc playback...............................................................................................................12
Music..................................................................................................................................................13
Configuring the amp#.........................................................................................................................14
The music playback............................................................................................................................15
Playback controls explained...............................................................................................................15
Keyboard controls for the music playback.........................................................................................22
Music playback errors........................................................................................................................23
Watching YouTube.............................................................................................................................24
The Internet........................................................................................................................................26
Photo albums......................................................................................................................................28
The exit menu item.............................................................................................................................30
Controls in the web browser windows...............................................................................................31
Photo album viewer controls..............................................................................................................33
PDF viewer controls...........................................................................................................................35
Other GUI controls.............................................................................................................................35
The photo album editor......................................................................................................................37
The parts of a photo album with the editor.........................................................................................38
Creating a photo album......................................................................................................................38
The description and tags for a single photo in the album...................................................................40
The photo album’s properties.............................................................................................................42
Deleting photos from album and deleting tags...................................................................................42
Saving changes to the photo album....................................................................................................43
Exporting photo album(s)...................................................................................................................45
The exported XML format..................................................................................................................45
The exported SQL format...................................................................................................................46
Importing a photo album from XML..................................................................................................47
Deleting photo album(s).....................................................................................................................47
Video player window’s playback controls..........................................................................................48
The settings.........................................................................................................................................52
Copyright © VPKSoft 2018 http://www.vpksoft.net vpksoft@vpksoft.net
1/66

Petteri Kautonen, VPKSoft
14.10.2018

The amp# remote contro API (Music Player).....................................................................................52
The base directory for movie files......................................................................................................53
The base directory for TV show series files.......................................................................................53
Base directory for image/photo files..................................................................................................53
Cache database in the memory...........................................................................................................54
Cache the TMDb poster/still images into the memory.......................................................................54
TMDb (The Movie Database) enabled...............................................................................................54
TMDb poster/still image file system cache path................................................................................55
Use file name for TV show episode naming......................................................................................55
Language (a restart is required)..........................................................................................................55
Hardware requirements......................................................................................................................56
My low end HTPC..............................................................................................................................56
The license..........................................................................................................................................57
Other information...............................................................................................................................57
Compiling the software from source..................................................................................................58
Getting the source code......................................................................................................................58
Getting the source path ready.............................................................................................................59
Restore the NuGet packages...............................................................................................................60
Compiling the installer package.........................................................................................................61
The installer is ready..........................................................................................................................63
Credits / Thanks to..............................................................................................................................64
”Third party” licenses.........................................................................................................................66
Final words.........................................................................................................................................66

vpksoft@vpksoft.net

2/66

Petteri Kautonen, VPKSoft
14.10.2018

vamp# instructions
This is a small document of how to use the vamp# software and how to compile it from source.

What is the vamp#
The vamp# is a A lightweight open source HTPC software for video, audio and photo playback for
Microsoft® Windows® platform.
The software was wrote because some other similar HTPC software’s were either requiring too
much resources or are otherwise over-bloated with ”useless” features.

The used libraries and the programming technique
The software is written purely in C# programming language and is currently relying on .NET
Framework v.4.6.1. The software uses Windows Forms as the GUI which is somewhat outdated
according to some people, but much easier to approach.
The software’s video playback is base on the famous an efficient VLC media player and the movie
and TV show data is gathered from the TMDb (The Movie Database).
Another libraries will be listed after the actual instructions.

vpksoft@vpksoft.net

3/66

Petteri Kautonen, VPKSoft
14.10.2018

Play an arbitrary file
To play an arbitrary file you need to either select the menu from the main menu or select an already
watched directory from the right side list.

Play an arbitrary file via the menu item
The arbitrary video playback starts from the menu item which gives you a file browser dialog. The
browser playback dialog’s starts from the previously browsed path which is saved in the settings.

The “tick” ( ) icon on the right side of the file indicates that the file has been watched, and the
half-moon icon indicates that the file has been watched to some point and then the playback was
stopped ( ). To play a file just simply click the file to start the playback.

vpksoft@vpksoft.net

4/66

Petteri Kautonen, VPKSoft
14.10.2018

Play a file from the list
When the mouse hovers over the menu item the right side of the screen gets filled with previously
browsed directories. Any directory can be selected from the list and the file browser dialog executes
on that directory.

There is also this deletion button (

) which can be used to delete an item from the list.

vpksoft@vpksoft.net

5/66

Petteri Kautonen, VPKSoft
14.10.2018

Movie collection
Movies are added to the movie collection via the add ( ) button on the bottom of the movie
collection list which opens a directory browser dialog. The actual menu item in this case does
nothing else than displays the movie collection list when the mouse hovers over the menu item. The
refresh button ( ) updates the TMDb (The Movie Database) data for the movies in the
collection(s).

The TMDb (The Movie Database) update/load dialog:

vpksoft@vpksoft.net

6/66

Petteri Kautonen, VPKSoft
14.10.2018

There is also a delete (

) button which can be used to delete a movie collection from the list.

vpksoft@vpksoft.net

7/66

Petteri Kautonen, VPKSoft
14.10.2018

Watching movies
To launch a selection window to watch a movie simply select the collection from which you may
want to watch a movie from. The selection dialog includes the movie posters, the descriptions of the
movies and their running times. Also the same indicators are used to display the watching state of a
movie.
The “tick” ( ) icon on the left of a selected movie indicates that the movie has been watched, and
the half-moon icon indicates that the movie has been watched to some point and then the playback
was stopped ( ). To watch a movie just simply click the movie to start the playback.

vpksoft@vpksoft.net

8/66

Petteri Kautonen, VPKSoft
14.10.2018

TV show season collection
TV show seasons are added to the TV show season collection via the add ( ) button on the bottom
of the TV show collection list which opens a directory browser dialog. The actual menu item in this
case does nothing else than displays the TV show season collection list when the mouse hovers over
the menu item. The refresh button ( ) updates the TMDb (The Movie Database) data for the TV
show season(s) in the collection(s).

The TMDb (The Movie Database) update/load dialog:

vpksoft@vpksoft.net

9/66

Petteri Kautonen, VPKSoft
14.10.2018

There is also a delete (

) button which can be used to delete a TV show season from the list.

vpksoft@vpksoft.net

10/66

Petteri Kautonen, VPKSoft
14.10.2018

Watching TV shows
To launch a selection window to watch a TV show season episode simply select the collection from
which you may want to watch a TV show season episode. The selection dialog includes the TV
show season episode stills, the descriptions of the TV show season episodes and their running times.
Also the same indicators are used to display the watching state of a TV show season episode.
The “tick” ( ) icon on the left of a selected TV show season episode indicates that the TV show
season episode has been watched, and the half-moon icon indicates that the TV show season
episode has been watched to some point and then the playback was stopped ( ). To watch a TV
show season episode just simply click the episode to start the playback.

vpksoft@vpksoft.net

11/66

Petteri Kautonen, VPKSoft
14.10.2018

DVD / optical disc playback
The DVD / other optical disc playback doesn’t currently work – so this entry is in a todo stage.

However a dialog to start the playback is shown if the menu item is clicked

vpksoft@vpksoft.net

12/66

Petteri Kautonen, VPKSoft
14.10.2018

Music
The music playback relies on the amp# program’s remote control WCF (Windows Communication
Foundation) API. The reason to use the amp# software is simply that there was no reason program a
new music player and some of the music playback libraries are incompatible with the GPLv3
license.

vpksoft@vpksoft.net

13/66

Petteri Kautonen, VPKSoft
14.10.2018

Configuring the amp#
Configuring the amp# software is quite simple – however the remote control API to get enabled an
elevated user rights are required.
Select File → Settings:

Enable the remote control API from the settings:

vpksoft@vpksoft.net

14/66

Petteri Kautonen, VPKSoft
14.10.2018

The music playback
The amp# software must be running in order for the audio playback to work – however the remote
control interface doesn’t.

The playback interface is quite simple – it has a search text box, the list of the songs in the album
and common music player controls.

Playback controls explained
The playback position is displayed in minutes and seconds of how much of the playback time is left
and the playback position can be adjusted with a slider.

The volume is adjusted as per-song basis so there is no master volume at all.

vpksoft@vpksoft.net

15/66

Petteri Kautonen, VPKSoft
14.10.2018

The rating of the song can be set with the slider with the stars in it.

Items can be deleted from the album by selecting the delete button on the right side of the song or
by pressing delete button from the keyboard.

NOTE: These previously mentioned controls do affect the amp#’s database and are saved by
the amp# software.

Playlist shuffling / randomizing is set with the button described below.
The playlist shuffling / randomizing is enabled

The playlist shuffling / randomizing is disabled

Playlist repeat is set with the button described below.
The playlist repeat is enabled

vpksoft@vpksoft.net

16/66

Petteri Kautonen, VPKSoft
14.10.2018

The playlist repeat is disabled

The previous song is played if any songs have been played; otherwise the button is disabled

The disabled button

Play / pause button either resumes the paused playback or pauses the current playback
Start / resume the playback

Pause the playback

vpksoft@vpksoft.net

17/66

Petteri Kautonen, VPKSoft
14.10.2018

The next song button either selects the next song from a queue or plays the next song depending on
the randomization / shuffle and repeat settings.
The next song button

The display queue button displays the queue if any songs are queued; otherwise the button is
disabled.
The display queue button is enabled

The display queue button is disabled

The context button allows to load saved queues, append to the current queue and select another
album from the amp#’s database
The context button

vpksoft@vpksoft.net

18/66

Petteri Kautonen, VPKSoft
14.10.2018

The items in the context menu

The first menu item called “Select Album” allows the user to change the album from the amp#’s
database.
Select album item was clicked..

So a dialog to select an album is displayed – the user can either cancel or select another album

vpksoft@vpksoft.net

19/66

Petteri Kautonen, VPKSoft
14.10.2018

The second menu items allows a user to load a saved queue for playback from the amp# software’s
database.
A load a saved queue item was clicked..

So a dialog is is displayed to allow user to either select a saved queue or cancel the operation

An append a saved queue item was clicked..

vpksoft@vpksoft.net

20/66

Petteri Kautonen, VPKSoft
14.10.2018

So a dialog is displayed to either append to the end of the current queue or cancel the operation

The exit button closes the amp# remote control window but the amp# software it self is left to the
state it was running when the window was still open.
The close button

The queue counter displays how many songs there are in the queue currently
The queue counter

There is also this tool-tip text which gives a short description when the mouse hovers over a control
The tool-tip text

vpksoft@vpksoft.net

21/66

Petteri Kautonen, VPKSoft
14.10.2018

Keyboard controls for the music playback
Searching for songs is just as simple as to just start writing text event though the search box doesn’t
have a focus.

Control keys
•

The Delete key deletes selected items from the album (play list)

•

The Return key starts a playback of a selected item from the list

•

The Add key (NP +) adds a song to the queue, if the Control key is also down the song is
inserted into the queue after the currently playing song in the queue.

•

The Up and Down arrow keys and the Page Up or Page Down keys allows the user to
navigate in the song list.

vpksoft@vpksoft.net

22/66

Petteri Kautonen, VPKSoft
14.10.2018

Music playback errors
The only actual error there might occur with the music player window is that the amp# software is
not running or the remove control API is not configured correctly.

The error message in the music player window

The error message text:
There was no endpoint listening at http://localhost:11316/ampRemote/ that could accept the
message. This is often caused by an incorrect address or SOAP action. See InnerException, if
present, for more details.

vpksoft@vpksoft.net

23/66

Petteri Kautonen, VPKSoft
14.10.2018

Watching YouTube
YouTube TV interface can be simply launched from the main menu bu selecting the YouTube
button from the menu.
The YouTube menu item

This opens a window based on the Chromium Embedded Framework with the YouTube’s TV
interface.

The YouTube’s TV interface loading

vpksoft@vpksoft.net

24/66

Petteri Kautonen, VPKSoft
14.10.2018

The interface in ready state (weird recommendations though

)

vpksoft@vpksoft.net

25/66

Petteri Kautonen, VPKSoft
14.10.2018

The Internet
The Internet menu allows you to store web sites mostly for watching videos. The browser is based
on the GeckoFX-45.0 framework because as compared to Chromium this has an embedded support
for decryption of DRM content in HTML5 videos. Do note that the Flash is not supported and will
not ever be supported.
The menu item is as follows and has no other functionality than to display the website list on the
right side of the screen when the mouse hovers over the menu item.
The Internet menu item

It the right side list box the user can select, add and delete a website from the list. The delete ( )
button simply displays a dialog whether a selected website should be deleted from the list.
The delete item dialog

The add button (

) displays a dialog which allows the user to add a website to the list.

The dialog also allows you to give a name for the website to be added to the list so too long or too
complex WWW addresses aren’t displayed.

vpksoft@vpksoft.net

26/66

Petteri Kautonen, VPKSoft
14.10.2018

The add website (location) dialog

The right side menu for managing websites

Once an item is clicked from the list the web browser window automatically navigates to the
selected location.

vpksoft@vpksoft.net

27/66

Petteri Kautonen, VPKSoft
14.10.2018

The web browser window showing the selected location

Photo albums
Photo albums can be viewed and deleted through the main interface but there is no editing
possibility. The software has a separate photo album editor for that. The menu item it self does
nothing else than shows a list of photo albums on the right side of the screen when the mouse
hovers over the menu item.

The photo album menu item

vpksoft@vpksoft.net

28/66

Petteri Kautonen, VPKSoft
14.10.2018

A photo album can be either watched or deleted using the delete (
box.

) button in the photo album list

The deletion dialog

An item is is selected from the photo album list

After selecting an item a photo album browser window opens. It has simple movement buttons to
backward and forward.

vpksoft@vpksoft.net

29/66

Petteri Kautonen, VPKSoft
14.10.2018

The photo album window with the navigation menu showing

TIP: To zoom an image use the right mouse button and drag the mouse over the image.

The exit menu item
The exit menu item currently does nothing else than quits the program.

The exit menu item

vpksoft@vpksoft.net

30/66

Petteri Kautonen, VPKSoft
14.10.2018

Controls in the web browser windows
The web browser windows were build to be simple – you can only browse backwards and forwards
and exit the web browser window. An additional freature is the ability to refresh the current web
page.

The navigation tool bar pops up when the mouse is at the bottom side of the screen

There are five buttons to use with the navigation in addition to what the web browsers control has to
offer.

The back button takes the user to the previous page the browser was on. There are also keyboard
controls such as Alt+Left Arrow and Backspace keys for keyboard use.
The back button

The forward button tajes the user to the next page the browser was on. There are also keyboard
controls such as Alt+Right Arrow and Shift+Backspace keys for keyboard use.
The previous button

vpksoft@vpksoft.net

31/66

Petteri Kautonen, VPKSoft
14.10.2018

The refresh buttons refreshes the web page. There are also keyboard controls such as F5 to refresh
the page and Ctrl+F5 to refresh the page entirely without using the previously cached data.
The refresh button

The home button sets the page to the page the browser window was started on. The keyboard
shortcut key is Alt+Home.
The home button

The close button simply closes the web browser window. The keyboard shortcut is the Escape key.
The close button

The controls works both on the Chromium and the Gecko based web browser windows.

vpksoft@vpksoft.net

32/66

Petteri Kautonen, VPKSoft
14.10.2018

Photo album viewer controls
In the photo album viewer a user can select previous or next photo and rotate the photos in 90
degree steps.

The photo album viewer control bar

The previous button displays the previous image or the last image in the album if first photo in the
album is currently visible. The shortcut key is Left.
The previous photo button

The rotate counter-clockwise button rotates the image 90 degrees counter-clockwise. The shortcut
key is Page Up.
The rotate counter-clockwise button

vpksoft@vpksoft.net

33/66

Petteri Kautonen, VPKSoft
14.10.2018

The rotate clockwise button rotates the image 90 degrees clockwise. The shortcut key is Page
Down.
The rotate clockwise button

The next button displays the next image or the first image in the album if last photo in the album is
currently visible. The shortcut key is Right.
The next photo button

The exit button simply exits the photo album viewer. The shortcut key is Escape.
The exit button

Use the right mouse button to zoom the image to 100 percent and drag the mouse pan the image
while zoomed.

vpksoft@vpksoft.net

34/66

Petteri Kautonen, VPKSoft
14.10.2018

PDF viewer controls
The PDF viewer has no other controls than the bottom browser bar’s exit button and the Escape key
closes the PDF viewer window. Other controls are based on the viewer control it self – it can be
zoomed, dragged and scrolled as any PDF viewer.

The PDF viewer window with the control bar visible showing the Thanks to (credits) document

Other GUI controls
Thera are few other controls in the GUI. The one shows simply the Thanks to PDF document on the
right upper corner of the main window.

vpksoft@vpksoft.net

35/66

Petteri Kautonen, VPKSoft
14.10.2018

The other is just a link to my website to the vamp# software’s web page which opens the website in
the Gecko web browser window.

On the center of the upper center of the main window is the settings button. The settings can also be
found in the Windows start menu under the vamp# item if the software is installed via the installer.

The last one is the loading indicator which just indicates that the software is loading something and
hasn’t crashed – so please do wait. The other parts of the GUI also go disabled while this indicator
is spinning.

vpksoft@vpksoft.net

36/66

Petteri Kautonen, VPKSoft
14.10.2018

The photo album editor
The photo album editor is in a way a ”normal” Windows application and you shouldn’t try to use it
on a HTPC – instead export and import the photo album made with a normal PC.
The photo album editor can be launched from the Windows start menu or by giving the vamp#
software a command line argument ”--photos”.

The photo album editor at glance

vpksoft@vpksoft.net

37/66

Petteri Kautonen, VPKSoft
14.10.2018

The parts of a photo album with the editor
A single photo album in the vap# software consists of the following things
•

The name of the photo album

•

The photo files in the file system

•

The start date and time of the photo album

•

The description for a single image in the photo album

•

The tags assigned to a single image in the photo album

•

The date and time of a single file in the photo album

Creating a photo album
The creation of a photo album is simple. Just select New from the main menu. First a name for the
new albums is asked from the user.

Once the name is given a folder browser dialog opens where the user can select the folder
containing the photo album.

vpksoft@vpksoft.net

38/66

Petteri Kautonen, VPKSoft
14.10.2018

A folder browser dialog opens with the from the directory selected in the settings.

Just select the folder containing the photo album and a new photo album is created.
The new photo album just created

vpksoft@vpksoft.net

39/66

Petteri Kautonen, VPKSoft
14.10.2018

The description and tags for a single photo in the album
The photo in the photo album can be given a description and tags to describe the photo in the
album. One of the two must be given or both. If the describtion is empy the tags assigned to the
photo will be used as describtion delimited by commas (,); otherwise the given describtion will be
used while displaying the photo.
Tags can be assigned to the photo with two different ways.
The first one is simply to drag an existing tag over the photo view box or over the list box
displaying the selected photo’s tags.
The other way is to write the tag to the text box and select the ”Add tag ←” button.

An image to show how a tag can be added to a single photo in a photo album

vpksoft@vpksoft.net

40/66

Petteri Kautonen, VPKSoft
14.10.2018

The describtion for a photo file can be set from below the photo album’s photo list box. The is also
the time the photo was taken.

If I was to erase the describtion the describtion in the list would change to the list of tags instead.

The time the photo was taken is gotten from the photo’s Exif tag howevet if it’s not valid the date
and time can be changed. Also a free description of the photo’s taking time can be given like
”Summer of 69”, etc.
The actual files in the file system remain unchanged when setting their properties in the photo
album editor. All the properties are saved into the vamp#’s database.

vpksoft@vpksoft.net

41/66

Petteri Kautonen, VPKSoft
14.10.2018

The photo album’s properties
The photo album has two properties one being the name and the other the date and time of the photo
album.

The name is given in a different dialog box as a check must be made that there are no same named
photo albums in the photo album collection. The date usually is the date the first photo was taken,
but it can also be set to any value a user wishes to.

Deleting photos from album and deleting tags
To delete a photo from a photo album just drag and drop a photo from the photo album’s contents
list box to the trash bin. The deletion is confirmed with a dialog.

vpksoft@vpksoft.net

42/66

Petteri Kautonen, VPKSoft
14.10.2018

To delete a tag from a selected photo the previous procedure applies – just drag the tag into the trash
bin. A deletion of a tag is not confirmed with a dialog.

Saving changes to the photo album
If the photo album is edited the changes can be saved with the large save button in the lower left
corner of the photo album editor or by selecting the Save changes menu item from the File menu.
The save button

The Save changes menu item

vpksoft@vpksoft.net

43/66

Petteri Kautonen, VPKSoft
14.10.2018

To undo changes you can select the large undo changes button in the lower left corner of the photo
album editor or by selecting the Undo changes menu item from the File menu.
The undo changes button

The Undo changes menu item

All other changes can be undone except a deletion of a photo album or deletion of a photo in a
photo album. Do note that the GUI reacts to photo album’s edition by disabling items that are not
needed to for editing a selected photo album.

vpksoft@vpksoft.net

44/66

Petteri Kautonen, VPKSoft
14.10.2018

Exporting photo album(s)
Photo albums can either be exported in XML or in SQL format. The export files don’t include the
actual photos in the file system – only their locations. Select the albums you wish to export from the
list.

After the selection export the selected album(s) in either XML or SQL format. Do note that the
software doesn’t allow SQL to be imported to prevent direct SQL injection.

The exported XML format
The exported XML contains the following structure:

Basically the contents are the same as in the database.

vpksoft@vpksoft.net

45/66

Petteri Kautonen, VPKSoft
14.10.2018

The exported SQL format
The exported SQL contains ”well” formated SQL sentences to run against the database – however a
direct import is made impossible due to the possibility of SQL injection (malicious SQL).

vpksoft@vpksoft.net

46/66

Petteri Kautonen, VPKSoft
14.10.2018

Importing a photo album from XML
To import a photo album from a XML file select the Import (XML) menu item from the File menu.

An open file dialog opens to select a XML file to import into the database. If the files in the XML
file are not found in the source computer’s file system the album’s file locations are asked to make
the import successfull.

Deleting photo album(s)
To delete selected photo album(s) select the Delete selected albums menu item from the File menu.
Each deletion is confirmed separately.

vpksoft@vpksoft.net

47/66

Petteri Kautonen, VPKSoft
14.10.2018

Video player window’s playback controls
The video player window consist of mostly common playback control and some related to the VLC
media player.

The time shows how many hours, minutes and seconds the playback position is compared to the
total length of the video.
The playback position

The playback position can be adjusted via the slider next to the text describing the position.

The subtitle selection can be used to select the subtitles the VLC has detected or to disable the
subtitles at all.

The select subtitle dialog

vpksoft@vpksoft.net

48/66

Petteri Kautonen, VPKSoft
14.10.2018

The audio control doesn’t control the master audio of the system, it controls the audio of the current
video which is playing. This is saved to the vamp#’s database and set while the video is re-played.
The audio slider and the volume mute button

The jump to the start of the playback starts the playback from the beginning.
The jump to start button

The rewind button rewinds the playback faster than the normal playback speed.
The rewind button

The play / pause button pauses the playback when the video is playing or resumes the playback
when the video is paused. Also a mouse click on the screen toggles the play / pause state.
The play and the

pause button

vpksoft@vpksoft.net

49/66

Petteri Kautonen, VPKSoft
14.10.2018

The stop button also acts as an exit button. The playback position is saved to the database.
The stop button

The wind forward button winds the playback faster than the normal playback speed.
The wind forward button

The jump to end button marks the video as watched and closes the playback window. It can be used
if you have already watched the video or don’t want to wach the video.
The jump to the end button

Tooltips in the player window mostly show the function of the button / control except for with the
audio slider with which the percentage of the original playback volume is also displayed.
The volume tooltip

If the volume is set to zero the the volume button goes to a muted state and can be restored with the
same button.
The volume muted

vpksoft@vpksoft.net

50/66

Petteri Kautonen, VPKSoft
14.10.2018

If the playback of a file has been stopped somewhere in the middle a dialog is shown if the
playback should be started from the beginning or to continue the playback from the previously
stopped location.

vpksoft@vpksoft.net

51/66

Petteri Kautonen, VPKSoft
14.10.2018

The settings
The settings are either launched from the main screen or from the Windows start menu under the
vamp# folder. It is recommended that the software is restarted after the settings have been changed.
The settings window at glance

The amp# remote contro API (Music Player)
This setting tells the vamp# software the endpoint where the amp# remote control API is listening
to requests. The setting allows the user to play music via the music player window. The default
setting is http://localhost:11316/ampRemote.

The amp# remote contro API (Music Player) setting

vpksoft@vpksoft.net

52/66

Petteri Kautonen, VPKSoft
14.10.2018

The base directory for movie files
This setting tells the vamp# software the default location for movie files. This setting only affects
the directory browser dialog when adding new movie folders to the collection. The default value is
%USERPROFILE%\Videos.

The base directory for movie files setting

The base directory for TV show series files
This tells the vamp# software’s the default location for TV show series files. This setting only
affects the directory browser dialog when adding new TV show folders to the collection. The
default value is %USERPROFILE%\Videos.

The base directory for TV show series files setting

Base directory for image/photo files
This tells the vamp# software the default location for image / photo files. This setting only affects
the directory browser dialog when browsing for a photo album folder to add or to update the
collection. The default value is %USERPROFILE%\Pictures.

Base directory for image/photo files setting

vpksoft@vpksoft.net

53/66

Petteri Kautonen, VPKSoft
14.10.2018

Cache database in the memory
This setting affects the method of how the database is being handled by the software. The default
setting is false and should be kept that way as the in-memory database might cause excess memory
usage.

Cache database in the memory setting

Cache the TMDb poster/still images into the memory
This setting affects the method of how the caching of poster/still images from the TMDb is handled.
The default value is false and should always be kept false as numerous amount of poster/still images
in the memory will cause excess memory usage.

Cache the TMDb poster/still images into the memory setting

TMDb (The Movie Database) enabled
This value indicates if the software should fetch data for the movie and TV show series files from
the TMDb (The Movie Database). The default value is true and there is no reason to disable the
setting.

TMDb (The Movie Database) enabled setting

vpksoft@vpksoft.net

54/66

Petteri Kautonen, VPKSoft
14.10.2018

TMDb poster/still image file system cache path
A path in the file system where the TMDb poster / still images should be cached if the caching is
enabled. The default value is %USERPROFILE%\AppData\Local\vamp#\TBDbImageCache.

TMDb poster/still image file system cache path setting

Use file name for TV show episode naming
This indicates if the file name should be used for TV show season episode naming instead of the
longer string version. The default value is false.

Use file name for TV show episode naming setting

Language (a restart is required)
This is the language used in the software. The default is English (United States). Currently two
languages are supported: en-US and fi-FI. Do remember to restart the software if the GUI language
has been changed.

Language setting

vpksoft@vpksoft.net

55/66

Petteri Kautonen, VPKSoft
14.10.2018

Hardware requirements
The hardware requirements are the same as mentioned in the vamp# software’s website.
•

Microsoft® Windows® supporting .NET Framework v.4.6.1.

•

Runs both on 32 and 64 bit operating systems.

•

Internet connection for the TMDb database, this is however optional.

•

4 GB RAM, a hard drive and some Intel Celeron or similar CPU with 2+ cores and running
@2 GHz and a display chip

My low end HTPC
The specifications on my low-end HTPC (which doesn’t run Kodi) according to the CPU-Z
software.

vpksoft@vpksoft.net

56/66

Petteri Kautonen, VPKSoft
14.10.2018

The GPU

The license
The software (vamp#) is licensed under the terms of the terms of the GNU GENERAL PUBLIC
LICENSE Version 3, 29 June 2007.

Other information
This software doesn’t affect the file system of the operating system; this includes
•

Video files

•

Photo files

•

Optical media discs

•

Audio files

•

Any other

The only thing that is affected is the software’s own directory which includes the database, browser
caches, error logs and some cached data from the TMDb (The Movie Database). The software’s
own data directory is located at %USERPROFILE%\AppData\Local\vamp#.

vpksoft@vpksoft.net

57/66

Petteri Kautonen, VPKSoft
14.10.2018

Compiling the software from source
To compile the software from source you will need
•

An internet connection

•

A Microsoft® Visual Studio® 2017 community edition or better

Getting the source code
The source code is located at GitHub, https://github.com/VPKSoft/vamp.
Use the Git (Command Prompt): git clone https://github.com/VPKSoft/vamp.git

vpksoft@vpksoft.net

58/66

Petteri Kautonen, VPKSoft
14.10.2018

Getting the source path ready
First open the solution in the Visual Studio 2017 by selecting the vamp.sln file.

vpksoft@vpksoft.net

59/66

Petteri Kautonen, VPKSoft
14.10.2018

Restore the NuGet packages
Now thath the solution is opened the nuget packages it is using must be restored. To do this you
need to click the solution with right mouse button and select Restore NuGet Packages

After that just start coding.

NOTE: Do not update the System.Data.SQLite.Core NuGet package as many other NuGet
packages and the software it self uses the NuGet. Updating the package will lead to an
exception: System.BadImageFormatException: Could not load file or assembly
'System.Data.SQLite..

vpksoft@vpksoft.net

60/66

Petteri Kautonen, VPKSoft
14.10.2018

Compiling the installer package
First select the Release with Any CPU from the Visual Studio

From the solution explorer select the solution with the right mouse button and then select Rebuild
Solution

vpksoft@vpksoft.net

61/66

Petteri Kautonen, VPKSoft
14.10.2018

After the software has been compiled open the solution folder, navigate to the installer folder and
execute the make_installer.bat batch file. The NSIS (Nullsoft Scriptable Install System) must be
installed before this procedure.

After the make_installer.bat has been launched you should propably take a coffee break or
something..

The installer being compiled

vpksoft@vpksoft.net

62/66

Petteri Kautonen, VPKSoft
14.10.2018

The installer is ready
After the coffee break or something the installer should be ready and appear to the installer
directory.

The NSIS finished

The installer in the file system

vpksoft@vpksoft.net

63/66

Petteri Kautonen, VPKSoft
14.10.2018

Credits / Thanks to
libVLC,
libVLC is the core engine and the interface to the multimedia framework on which VLC media
player is based.
Vlc.DotNet,
Vlc.DotNet is a .net library that hosts the audio/video capabilities of the VLC libraries. In other
words, it's a .net wrapper around libvlc.
Chromium Embedded Framework,
The Chromium Embedded Framework (CEF) is a simple framework for embedding Chromiumbased browsers in other applications.
CefSharp,
.NET (WPF and Windows Forms) bindings for the Chromium Embedded Framework
GeckoFX-45.0,
library that allows embeding Gecko in C# applications.
Loading.io,
Loading.io provides the world's best ajax loaders, loading gifs, preloaders and ajax spinners.
NSIS,
NSIS (Nullsoft Scriptable Install System) is a professional open source system to create Windows
installers. It is designed to be as small and flexible as possible and is therefore very suitable for
internet distribution.
NsisDotNetChecker,
NSIS plugin that allows one to detect if particular .Net framework is installed on the computer and
download/install one if it is not found.
PdfiumViewer,
PDF viewer based on Google's PDFium.
libdvdcss-dll,
Compiled libdvdcss libraries for Windows. Ready for use with Handbrake.
THE MOVIE DB,
This product uses the TMDb API but is not endorsed or certified by TMDb.
TmdbEasy,
TMdbEasy is a wrapper, written in C# , for the TMDB Api v3. By using TMdbEasy you can easily
gain access to a large amount of movie data.

vpksoft@vpksoft.net

64/66

Petteri Kautonen, VPKSoft
14.10.2018

Globalmousekeyhook,
This library allows you to tap keyboard and mouse, detect and record their activity even when an
application is inactive and runs in background.
MediaInfo,
MediaInfo is a convenient unified display of the most relevant technical and tag data for video and
audio files.
MediaInfoDotNet,
Wrapper Library for MediaInfo Library. Automatically chooses 32 and 64 bit library.
VPKSoft (me),
Various libraries both GNU Lesser General Public License Version 3 and GNU GENERAL
PUBLIC LICENSE Version 3.
openclipart,
Greate clipart which is all licensed as public domain.
Aha-Soft 16x16 Free Application Icons,
A small icon set of 16x16 icons in various image formats.
MetadataExtractor,
MetadataExtractor is a straightforward .NET library for reading metadata from image and movie
files.
Owner-drawn trackbar(slider) - Implementing a Windows Forms owner-drawn trackbar (slider)
control in C#.
© Michal Brylka

vpksoft@vpksoft.net

65/66

Petteri Kautonen, VPKSoft
14.10.2018

”Third party” licenses
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•

libVLC: GNU General Public License
Vlc.DotNet: MIT
cef: Modified BSD (3-clause BSD license)
CefSharp: Modified BSD (3-clause BSD license)
openclipart: CC0
Loading.io: CC0 and commercial versions
NsisDotNetChecker: MIT
System.Data.SQLite: Public Domain
globalmousekeyhook: MIT
NSIS (Nullsoft Scriptable Install System): The zlib/libpng License (Zlib)
GeckoFX-45.0: Mozilla Public Licence
PdfiumViewer: Apache 2.0 License
libdvdcss-dll: GNU General Public License, version 2
THE MOVIE DB: Terms of Use, API Terms of Use
TmdbEasy: GNU GENERAL PUBLIC LICENSE Version 3
MediaInfo: BSD-2-Clause license
MediaInfoDotNet: BSD-2-Clause license (Assumed from the MediaInfo library's license,
which this library is using)
openclipart: Public Domain
Aha-Soft: Attribution 3.0 United States (CC BY 3.0 US)
MetadataExtractor, Apache License Version 2.0
Owner-drawn trackbar(slider), The GNU Lesser General Public License (LGPLv3)

If your library or contribution is not listed here do contact me at https://www.vpksoft.net or send
email to vpksoft@vpksoft.net.

Final words
I'll be back.
If you enjoyed the show please contact me at my website or via the GitHub or via email:
vpksoft@vpksoft.net.

vpksoft@vpksoft.net

66/66

Source Exif Data:

File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.5
Linearized                      : No
Page Count                      : 66
Language                        : fi-FI
Creator                         : Writer
Producer                        : LibreOffice 6.1
Create Date                     : 2018:10:14 11:21:58+03:00

EXIF Metadata provided by EXIF.tools

Vamp# Instructions

Navigation menu

Versions of this User Manual:

Views

Navigation