Changeset 39 in mp3-find for trunk/lib/MP3/Find/Filesystem.pm


Ignore:
Timestamp:
06/07/11 22:59:11 (13 years ago)
Author:
peter
Message:

Add the META.yml metadata file to version control

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/lib/MP3/Find/Filesystem.pm

    r36 r39  
    1212use MP3::Find::Util qw(get_mp3_metadata); 
    1313 
     14# XXX: this may or may not lead to faster searches 
    1415eval { 
    1516    require Sort::Key; 
     
    1819}; 
    1920my $USE_SORT_KEY = $@ ? 0 : 1; 
    20  
    21  
    22 eval { require MP3::Tag }; 
    23 my $CAN_USE_ID3V2 = $@ ? 0 : 1; 
    2421 
    2522use_winamp_genres(); 
     
    5249        } 
    5350    } 
    54      
    55     if ($$options{use_id3v2} and not $CAN_USE_ID3V2) { 
    56         # they want to use ID3v2, but don't have MP3::Tag 
    57         warn "MP3::Tag is required to search ID3v2 tags\n"; 
    58     } 
    59          
     51 
    6052    # run the actual find 
    6153    my @results; 
     
    10294    my $mp3 = get_mp3_metadata({ 
    10395        filename  => $filename, 
    104         use_id3v2 => $options->{use_id3v2}, 
    10596    }); 
    10697 
     
    139130L<File::Find>, L<MP3::Info>, L<Scalar::Util> 
    140131 
    141 L<MP3::Tag> is also needed if you want to search using ID3v2 tags. 
    142  
    143132=head1 DESCRIPTION 
    144133 
    145134This module implements the C<search> method from L<MP3::Find::Base> 
    146135using a L<File::Find> based search of the local filesystem. 
     136 
     137In addition to just the basic ID3v1 tags, you can search for files by their 
     138ID3v2 data, using the four-character frame names.  This isn't very useful if 
     139you are just search by artist or title, but if, for example, you have made use 
     140of the C<TOPE> ("Orignal Performer") frame, you could search for all the cover 
     141songs in your collection: 
     142 
     143    $finder->find_mp3s(query => { tope => '.' }); 
     144 
     145As with the basic query keys, ID3v2 query keys are converted to uppercase 
     146internally. 
    147147 
    148148=head2 Special Options 
     
    152152=item C<exclude_path> 
    153153 
    154 Scalar or arrayref; any file whose name matches any of these paths 
    155 will be skipped. 
    156  
    157 =item C<use_id3v2> 
    158  
    159 Boolean, defaults to false. If set to true, MP3::Find::Filesystem will 
    160 use L<MP3::Tag> to get the ID3v2 tag for each file. You can then search 
    161 for files by their ID3v2 data, using the four-character frame names.  
    162 This isn't very useful if you are just search by artist or title, but if, 
    163 for example, you have made use of the C<TOPE> ("Orignal Performer") frame, 
    164 you could search for all the cover songs in your collection: 
    165  
    166     $finder->find_mp3s(query => { tope => '.' }); 
    167  
    168 As with the basic query keys, ID3v2 query keys are converted to uppercase 
    169 internally. 
     154Scalar or arrayref; any file whose name matches any of these paths will be 
     155skipped. 
    170156 
    171157=back 
     
    181167=head1 COPYRIGHT AND LICENSE 
    182168 
    183 Copyright (c) 2006 by Peter Eichman. All rights reserved. 
     169Copyright (c) 2006-2008 by Peter Eichman. All rights reserved. 
    184170 
    185171This program is free software; you can redistribute it and/or 
Note: See TracChangeset for help on using the changeset viewer.