.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Video::FourCC::Info 3pm" .TH Video::FourCC::Info 3pm "2016-10-21" "perl v5.24.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Video::FourCC::Info \- Perl module to retrieve information about FourCCs .SH "VERSION" .IX Header "VERSION" Version 1.005 ($Id: Info.pm 10585 2009\-12\-22 02:50:06Z FREQUENCY@cpan.org $) .SH "DESCRIPTION" .IX Header "DESCRIPTION" In order for video players to detect the algorithm required to decode a given video file, a four-byte sequence called a Four Character Code is written somewhere in the header of the file. This ensures that the detected codec format is independent of the file extension, which may be incorrect due to human error or for some other reason. .PP This is similar to the four-byte \*(L"magic number\*(R" used by the \s-1UNIX\s0 \fIfile\fR\|(1) command to roughly determine a file format. .PP Most applications seem to treat this as a case insensitive code. As a result, internally, your given FourCC's will be silently converted to uppercase. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Video::FourCC::Info; \& \& my $codec = Video::FourCC::Info\->new(\*(AqDIV3\*(Aq); \& \& printf "Codec description: %s\en", $codec\->description; .Ve .SH "COMPATIBILITY" .IX Header "COMPATIBILITY" This module was tested under Perl 5.10.0, using Debian Linux. However, because it's Pure Perl and doesn't do anything too obscure, it should be compatible with any version of Perl that supports its prerequisite modules. .PP If you encounter any problems on a different version or architecture, please contact the maintainer. .SH "METHODS" .IX Header "METHODS" .SS "new" .IX Subsection "new" .Vb 1 \& Video::FourCC::Info\->new( $fourcc ) .Ve .PP Creates a \f(CW\*(C`Video::FourCC::Info\*(C'\fR object, which provides information about the given Four Character Code. If the code does not exist in the database, it will return an error. .PP Example code: .PP .Vb 1 \& my $codec = Video::FourCC::Info\->new(\*(AqDIV3\*(Aq); .Ve .PP This method will return an appropriate \fBVideo::FourCC::Info\fR object or throw an exception on error. .SS "describe" .IX Subsection "describe" .Vb 1 \& Video::FourCC::Info\->describe( $fourcc ) .Ve .PP This is really just a shortcut to grab the short description of a codec given a Four Character Code as input. Note that this is a class method, not an object method. .PP Example code: .PP .Vb 1 \& my $codec_desc = Video::FourCC::Info\->describe(\*(AqDIV3\*(Aq); .Ve .PP Internally, this method creates a temporary object and returns the description, destroying the object due to falling out of scope. If you already have a \f(CW\*(C`Video::FourCC::Info\*(C'\fR object, then the \fBdescription\fR accessor will provide better performance. .PP Note, that just like \f(CW\*(C`new\*(C'\fR, this class method may throw an exception if the Four Character Code does not exist in the database. .PP Remember that this value could be \f(CW\*(C`undef\*(C'\fR if the information is unknown. .SS "description" .IX Subsection "description" .Vb 1 \& $codec\->description( ) .Ve .PP This returns the short description of the codec. It may be \f(CW\*(C`undef\*(C'\fR if there is no description in the database. .PP Example code: .PP .Vb 1 \& my $codec_desc = $codec\->description; .Ve .PP Remember that this value could be \f(CW\*(C`undef\*(C'\fR if the information is unknown. .SS "registered" .IX Subsection "registered" .Vb 1 \& $codec\->registered( ) .Ve .PP This returns the short description of the codec. It may be \f(CW\*(C`undef\*(C'\fR if there is no description in the database. .PP If \f(CW\*(C`DateTime\*(C'\fR is installed, then this will be a DateTime object. Otherwise, it will simply be a string in the format \f(CW\*(C`yyyy\-mm\-dd\*(C'\fR. .PP Example code: .PP .Vb 1 \& my $registered = $codec\->registered; .Ve .PP Remember that this value could be \f(CW\*(C`undef\*(C'\fR if the information is unknown. .SS "owner" .IX Subsection "owner" .Vb 1 \& $codec\->owner( ) .Ve .PP This returns the name of the corporation or other entity that owns the FourCC. Generally, this seems to be an ad-hoc standard, so it's a listing of the first entity known to use the given FourCC. .PP Example code: .PP .Vb 1 \& my $owner_name = $codec\->owner; .Ve .PP Remember that this value could be \f(CW\*(C`undef\*(C'\fR if the information is unknown. .SS "code" .IX Subsection "code" .Vb 1 \& $codec\->code( ) .Ve .PP This returns the Four Character Code corresponding to the current \&\f(CW\*(C`Video::FourCC::Info\*(C'\fR object. .PP Example code: .PP .Vb 1 \& my $fourcc = $codec\->fourcc; .Ve .SH "AUTHOR" .IX Header "AUTHOR" Jonathan Yu .SS "\s-1CONTRIBUTORS\s0" .IX Subsection "CONTRIBUTORS" Your name here ;\-) .SH "ACKNOWLEDGEMENTS" .IX Header "ACKNOWLEDGEMENTS" .IP "\(bu" 4 Thanks to Allen Day and Benjamin R. Ginter , developers of Video::Info, which inspired the creation of this module. .SH "SUPPORT" .IX Header "SUPPORT" You can find documentation for this module with the perldoc command. .PP .Vb 1 \& perldoc Video::FourCC::Info .Ve .PP You can also look for information at: .IP "\(bu" 4 AnnoCPAN: Annotated \s-1CPAN\s0 documentation .Sp .IP "\(bu" 4 \&\s-1CPAN\s0 Ratings .Sp .IP "\(bu" 4 Search \s-1CPAN\s0 .Sp .IP "\(bu" 4 \&\s-1CPAN\s0 Request Tracker .Sp .IP "\(bu" 4 \&\s-1CPAN\s0 Testing Service (Kwalitee Tests) .Sp .SH "FEEDBACK" .IX Header "FEEDBACK" Please send relevant comments, rotten tomatoes and suggestions directly to the maintainer noted above. .PP If you have a bug report or feature request, please file them on the \s-1CPAN\s0 Request Tracker at . If you are able to submit your bug report in the form of failing unit tests, you are \fBstrongly\fR encouraged to do so. .SH "SEE ALSO" .IX Header "SEE ALSO" Video::Info, a module for extracting information like the Four Character Code from arbitrary files. .SH "CAVEATS" .IX Header "CAVEATS" .SS "\s-1KNOWN BUGS\s0" .IX Subsection "KNOWN BUGS" There are no known bugs as of this release. .SS "\s-1LIMITATIONS\s0" .IX Subsection "LIMITATIONS" .IP "\(bu" 4 This module has not been tested very thoroughly with Unicode. .SH "DATA SOURCE" .IX Header "DATA SOURCE" The FourCC database of owner and descriptions come from data extracted from GSpot v2.70a, a freeware Codec Information utility. The registration dates come courtesy of Microsoft Corporation, accessed online at: .SH "LICENSE" .IX Header "LICENSE" In a perfect world, I could just say that this package and all of the code it contains is Public Domain. It's a bit more complicated than that; you'll have to read the included \fI\s-1LICENSE\s0\fR file to get the full details. .SH "DISCLAIMER OF WARRANTY" .IX Header "DISCLAIMER OF WARRANTY" The software is provided \*(L"\s-1AS IS\*(R",\s0 without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.