opusinfo.1 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. .\" Process this file with
  2. .\" groff -man -Tascii opusinfo.1
  3. .\"
  4. .TH opusinfo 1 2012-08-31 "Xiph.Org Foundation" "opus-tools"
  5. .SH NAME
  6. opusinfo \- gives information about Opus files and does extensive validity checking
  7. .SH SYNOPSIS
  8. .B opusinfo
  9. [
  10. .B -q
  11. |
  12. .B -v
  13. ] [
  14. .B -h
  15. ] [
  16. .B -V
  17. ]
  18. .I file1.opus
  19. .B ...
  20. .I fileN.opus
  21. .SH DESCRIPTION
  22. .B opusinfo
  23. reads one or more Opus files and prints information about stream contents
  24. (including chained and/or multiplexed streams) to standard output. It will
  25. detect (but not correct) a wide range of common defects, with many
  26. additional checks specifically for Opus streams.
  27. For all stream types
  28. .B opusinfo
  29. will print the filename being processed, the stream serial numbers, and various
  30. common error conditions.
  31. For
  32. .B Opus
  33. streams, information including the version used for encoding, number of channels
  34. and other header information, the bitrate and playback length, the contents of the
  35. comment header, and general statistics about the stream are printed.
  36. Opusinfo is a fork of \fBogginfo\fR(1) with the non-opus parts largely removed.
  37. .SH OPTIONS
  38. .IP -h
  39. Show a help and usage message.
  40. .IP -q
  41. Quiet mode. This may be specified multiple times. Doing so once will remove
  42. the detailed informative messages; twice will remove warnings as well.
  43. .IP -v
  44. Verbose mode. At the current time, this does not do anything.
  45. .IP -V
  46. Show program version info and exit.
  47. .SH NOTES
  48. There are many kinds of errored, invalid, non-normative, or otherwise
  49. unwise stream constructions which opusinfo will not produce warnings
  50. on. Passing opusinfo with flying colors is not certification of the
  51. correctness of a stream. Future versions may detect more error
  52. conditions.
  53. .SH AUTHORS
  54. .br
  55. Michael Smith <msmith@xiph.org>
  56. .br
  57. Gregory Maxwell <greg@xiph.org>
  58. .SH SEE ALSO
  59. .BR opusdec (1),
  60. .BR opusenc (1)