opusinfo.1 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. .\" Process this file with
  2. .\" groff -man -Tascii opusinfo.1
  3. .\"
  4. .TH opusinfo 1 2019-09-07 "Xiph.Org Foundation" "opus-tools"
  5. .SH NAME
  6. opusinfo \(en display information and perform validity checks on Opus files
  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 file.opus
  19. .B ...
  20. .SH DESCRIPTION
  21. .B opusinfo
  22. reads one or more Opus files and prints information about stream contents
  23. (including chained and/or multiplexed streams) to standard output. It will
  24. detect (but not correct) a wide range of common defects, with many
  25. additional checks specifically for Opus streams.
  26. .PP
  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. .PP
  32. For
  33. .B Opus
  34. streams, information including the version used for encoding, number of
  35. channels and other header information, the bitrate and playback length,
  36. the contents of the comment header, and general statistics about the
  37. stream are printed.
  38. .PP
  39. Opusinfo is a fork of \fBogginfo\fR(1) with the non-Opus parts largely removed.
  40. .SH OPTIONS
  41. .TP
  42. .B -h
  43. Show command help.
  44. .TP
  45. .B -q
  46. Quiet mode. This may be specified multiple times. Doing so once will remove
  47. the detailed informative messages; twice will remove warnings as well.
  48. .TP
  49. .B -v
  50. Verbose mode. At the current time, this does not do anything.
  51. .TP
  52. .B -V
  53. Show version information.
  54. .SH NOTES
  55. There are many kinds of errored, invalid, non-normative, or otherwise
  56. unwise stream constructions for which opusinfo will not produce warnings.
  57. Passing opusinfo with flying colors is not certification of the
  58. correctness of a stream. Future versions may detect more error
  59. conditions.
  60. .SH AUTHORS
  61. Michael Smith <msmith@xiph.org>
  62. .PP
  63. Gregory Maxwell <greg@xiph.org>
  64. .SH SEE ALSO
  65. .BR opusdec (1),
  66. .BR opusenc (1)