1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
#
# This file is part of Audio-MPD-Common
#
# This software is copyright (c) 2007 by Jerome Quelin.
#
# This is free software; you can redistribute it and/or modify it under
# the same terms as the Perl 5 programming language system itself.
#
use 5.008;
use strict;
use warnings;
package Audio::MPD::Common::Item::Song;
our $VERSION = '1.100430';
# ABSTRACT: a song object with some audio tags
use Moose;
use MooseX::Has::Sugar;
use MooseX::Types::Moose qw{ Int Str };
use Readonly;
use base qw{ Audio::MPD::Common::Item };
use overload '""' => \&as_string;
Readonly my $SEP => ' = ';
# -- public attributes
has album => ( rw, isa=>Str );
has artist => ( rw, isa=>Str );
has date => ( rw, isa=>Str );
has disc => ( rw, isa=>Str );
has file => ( rw, isa=>Str, required );
has genre => ( rw, isa=>Str );
has id => ( rw, isa=>Int );
has name => ( rw, isa=>Str );
has pos => ( rw, isa=>Int );
has title => ( rw, isa=>Str );
has track => ( rw, isa=>Str );
has time => ( rw, isa=>Int );
# -- public methods
sub as_string {
my ($self) = @_;
return $self->file unless defined $self->title;
my $str = $self->title;
return $str unless defined $self->artist;
$str = $self->artist . $SEP . $str;
return $str unless defined $self->album && defined $self->track;
return join $SEP,
$self->album,
$self->track,
$str;
}
1;
=pod
=head1 NAME
Audio::MPD::Common::Item::Song - a song object with some audio tags
=head1 VERSION
version 1.100430
=head1 DESCRIPTION
L<Audio::MPD::Common::Item::Song> is more a placeholder with some
attributes. Those attributes are taken from the song tags, so some of
them can be empty depending on the file.
The constructor should only be called by L<Audio::MPD::Common::Item>'s
constructor.
=head1 ATTRIBUTES
=head2 $song->album;
Album of the song.
=head2 $song->artist;
Artist of the song.
=head2 $song->date;
Last modification date of the song.
=head2 $song->disc;
Disc number of the album. This is a string to allow tags such as C<1/2>.
=head2 $song->file;
Path to the song. Only attribute which will always be defined.
=head2 $song->genre;
Genre of the song.
=head2 $song->id;
Id of the song in MPD's database.
=head2 $song->name;
Name of the song (for http streams).
=head2 $song->pos;
Position of the song in the playlist.
=head2 $song->title;
Title of the song.
=head2 $song->track;
Track number of the song.
=head2 $song->time;
Length of the song in seconds.
=head1 METHODS
=head2 my $str = $song->as_string;
Return a string representing $song. This string will be:
=over 4
=item either "album = track = artist = title"
=item or "artist = title"
=item or "title"
=item or "file"
=back
(in this order), depending on the existing tags of the song. The last
possibility always exist of course, since it's a path.
This method is also used to automatically stringify the C<$song>.
=head1 AUTHOR
Jerome Quelin
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2007 by Jerome Quelin.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
__END__
|
