File Coverage

blib/lib/Data/iRealPro.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1             #! perl
2              
3             package Data::iRealPro;
4              
5 23     23   599461 use warnings;
  23         124  
  23         732  
6 23     23   179 use strict;
  23         45  
  23         1235  
7              
8             =head1 NAME
9              
10             Data::iRealPro - Convert iRealBook/iRealPro data
11              
12             =cut
13              
14             our $VERSION = "1.15";
15              
16             =head1 SYNOPSIS
17              
18             irealcvt iRealPro_exported.html --output formatted.pdf
19             irealcvt iRealPro_exported.html --output formatted.png
20             irealcvt iRealPro_exported.html --output song.mma
21             irealcvt iRealPro_exported.html --output raw.json
22             irealcvt iRealPro_exported.html --output editable.txt
23             irealcvt iRealPro_exported.html --output importable.html
24             irealcvt iRealPro_exported.html --generate Forum --output forumpost.txt
25             irealcvt iRealPro_exported.html --list
26              
27             =head1 DESCRIPTION
28              
29             iRealPro (previously named iReal-B) is a songwriting tool / electronic
30             backup band for iPhone/iPad, Mac OSX and Android that lets you
31             experiment with advanced chord progressions and arrangements quickly
32             and easily. You can use iRealPro for songwriting experiments, as
33             accompaniment when learning new songs or for making backing tracks for
34             your guitar / saxophone / theremin solos.
35              
36             B can import songs in one of two textual format formats.
37             The 'irealbook' format is easily readable and straightforward. The
38             official 'irealb' format is proprietary and uses some form of
39             scrambling to hide the contents. iRealPro can export songs in the form
40             of a HTML document that contains the data in big URLs, and some
41             printable formats.
42              
43             MusicXML input is possible if the module L is available.
44              
45             Data::iRealPro provides a set of modules that can be used to read and
46             analyse iRealPro songs in URL format and convert them into something
47             else, like PDF or PNG. A ready-to-use program irealcvt is provided to
48             perform conversions on the command line.
49              
50             iRealPro web site: L.
51              
52             =head1 A NOTE ABOUT WRITTEN KEY AND PLAYING KEY
53              
54             In iRealPro you can write a song in a specific key, and play it in a
55             different key. The formatter backends PDF and PNG will show the song
56             in the key it was played, just like iRealPro when it is playing your song.
57              
58             The JSON and Text reflect the raw data of the song and will show the
59             song in the key it was written, just like iRealPro when you are
60             editing the song.
61              
62             =head1 REQUIREMENTS
63              
64             PDF document generation requires L. This is considered core
65             functionality.
66              
67             Image generation requires L. This is optional.
68              
69             The web backend C requires L.
70              
71             =head1 AUTHOR
72              
73             Johan Vromans, C<< >>
74              
75             =head1 SUPPORT
76              
77             The development of this module is hosted on GitHub, repository
78             L.
79              
80             Please report any bugs or feature requests to the GitHub issue tracker,
81             L.
82              
83             You can find documentation for this module with the perldoc command.
84              
85             perldoc Data::iRealPro
86              
87             =head1 ACKNOWLEDGEMENTS
88              
89             Massimo Biolcati of Technimo LLC, for writing iRealPro.
90              
91             The iRealPro community, for contributing many, many songs.
92              
93             =head1 COPYRIGHT & LICENSE
94              
95             Copyright 2013,2019 Johan Vromans, all rights reserved.
96              
97             Clone me at L
98              
99             =cut
100              
101             1;