The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

File::ELAN - Parsing and manipulating ELAN files

VERSION

Version 0.01

SYNOPSIS

ELAN (http://tla.mpi.nl/tools/tla-tools/elan/) is a tool for creating annotations on video and audio resources. This module allows you to read and manipulate the annotation files.

    use File::ELAN;

    my $elan = File::ELAN->read("test.eaf");
    for my $annot ($elan->{annotations}{tier1}) { 
      ...
    }

    $elan->{annotations}{newtier} = [ ... ];

    $elan->write("test2.eaf");

SUBROUTINES/METHODS

read($filename)

Reads the annotations from the ELAN file into a data structure, to be found in the {annotations} hashref. annotations contains a hash of tiers, and each tier contains an array of annotations.

  my @annotations_in_this_tier = @{$elan->{annotations}{tier_i_am_interested_in}};

Each element of @annotations_in_this_tier is a hashref which looks like this:

  {
    id    => "a123", # Annotation ID
    start => 12.34,   # Time value in seconds
    end   => 23.45,
    value => "Hello" # Content of annotation 
  }

write($filename)

After fiddling with the annotations hash, you can call write to write the information back to another ELAN file. You can create new tiers, and new annotations. You don't have to mess about with timeslots; we work all that out for you. You also don't need to give each annotation an id; one will be automatically assigned.

AUTHOR

Simon Cozens, <simon at simon-cozens.org>

BUGS

Please report any bugs or feature requests to bug-file-elan at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=File-ELAN. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc File::ELAN

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2014 Simon Cozens.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.