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