README.md 3.05 KB
Newer Older
Chris Talbot's avatar
Chris Talbot committed
1
2
# Visual Voicemail Player (VVM Player)

3
Copyright (C) 2021, Chris Talbot
Chris Talbot's avatar
Chris Talbot committed
4

Chris Talbot's avatar
Chris Talbot committed
5
## About
Chris Talbot's avatar
Chris Talbot committed
6
7
8
9
10
VVM Player is a front end GUI to display, play, and delete visual voicemails (VVMs).

VVM Player depends on vvmd for VVM functionality
( https://gitlab.com/kop316/vvmd )

11
12
13
14
15
<div align="center">
  <img src="https://gitlab.com/kop316/vvmplayer/-/raw/main/data/metainfo/screenshot.png?inline=false" width="300" >
  <img src="https://gitlab.com/kop316/vvmplayer/-/raw/main/data/metainfo/screenshot2.png?inline=false" width="300" >
</div>

Chris Talbot's avatar
Chris Talbot committed
16
17
18
19
20
21
22
23
## License
Unless otherwise specified, all code is licensed under the GPL Version 3 or later
 https://www.gnu.org/licenses/gpl-3.0.en.html

All other images/data is licensed under  Creative Commons
Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)
https://creativecommons.org/licenses/by-sa/4.0/

Chris Talbot's avatar
Chris Talbot committed
24
## Notes
Chris Talbot's avatar
Chris Talbot committed
25
26
27
VVM Player is configured in the "Settings" page. VVM Player has the same
limitations as vvmd (e.g. carrier limitations, backend limitations)

Chris Talbot's avatar
Chris Talbot committed
28
## Settings Notes
Chris Talbot's avatar
Chris Talbot committed
29
30
31
32
33
34
35
36
37
VVM player will give you feedback on whether vvmd is functional. Both
"VVMD Running" and "Mailbox Active" must be checked for VVM to work!

Please look here for a databse of known good settings:
https://gitlab.com/kop316/vvmd/-/wikis/Carrier-Database

Note: Default Modem Number can be left blank (whereas in vvmd, it must be
      set to NULL) if a default modem number is not needed

Chris Talbot's avatar
Chris Talbot committed
38
## Compiling VVM Player
Chris Talbot's avatar
Chris Talbot committed
39
40
41
42
43
44
45
In order to compile VVM Player you need following software packages:
	- GCC compiler
	- GTK3 library
	- libhandy
	- GStreamer
	- GStreamer-pbutils

Chris Talbot's avatar
Chris Talbot committed
46
## Running VVM Player
47
48
49
50
51
52
53
54
55
56
57
VVM sound files are the generally of the Adaptive Multi-Rate (amr) audio codec.
gstreamer supports this in the "GStreamer Ugly Plug-ins":
https://gstreamer.freedesktop.org/modules/gst-plugins-ugly.html

This plugin is not needed to build VVM player, but if the Ugly plugins are not
installed, you will get a runtime error in attempting to playback your voicemail.

Depending on your distribution, you may have to additionally manually check that
support for amr is built into your distributions Ugly Plug-ins.


Chris Talbot's avatar
Chris Talbot committed
58
## Installing VVM Player
Chris Talbot's avatar
Chris Talbot committed
59
60
61
62
63
64
65
66
Build tools requirements

When building and testing directly from the repository it is important to
have at least meson version 0.56 or later installed. In addition, some
supported Meson backend is required (e.g. ninja).

To prepare/configure the project for compilation:

67
    # meson _build
Chris Talbot's avatar
Chris Talbot committed
68

69
70
71
72
73
74
However, if you want to install it, run

    # meson _build -Dprefix=/usr --sysconfdir=/etc

`--sysconfdir=/etc` will install the autostart file in the correct place, and
`-Dprefix=/usr` installs `vvmplayer` in `/usr/bin/` rather than `/usr/local/bin`
Chris Talbot's avatar
Chris Talbot committed
75

Chris Talbot's avatar
Chris Talbot committed
76
77
78
79
80
81
82
83
84
85
To build the project:

    # meson compile -C _build

Install:

    # meson install -C _build

    (Install may require sudo or root privileges).

Chris Talbot's avatar
Chris Talbot committed
86
87
88
89
90
Uninstall:

    # ninja uninstall -C _build/

    (Uninstall may require sudo or root privileges).
Chris Talbot's avatar
Chris Talbot committed
91

Chris Talbot's avatar
Chris Talbot committed
92
## Running from within the source code repository
Chris Talbot's avatar
Chris Talbot committed
93
94
95
96
97
Meson will build the binary in builddir (_build, using the examples above), and
can be invoked directly.

  Run with debugging
    # G_MESSAGES_DEBUG=all ./_build/src/vvmplayer