man mpg123 Command

Man page for apt-get mpg123 Command

Man Page for mpg123 in Linux

This tutorial shows the man page for man mpg123 in linux.

Open terminal with 'su' access and type the command as shown below:
man mpg123

Result of the Command Execution shown below:

mpg123(1)                                                                                                                                                  mpg123(1)



NAME
       mpg123   play audio MPEG 1.0/2.0/2.5 stream (layers 1, 2 and 3)

SYNOPSIS
       mpg123 [ options ] file ... | URL ... |  

DESCRIPTION
       mpg123  reads  one  or  more  files (or standard input if `` '' is specified) or URLs and plays them on the audio device (default) or outputs them to stdout.
       file/URL is assumed to be an MPEG audio bit stream.

OPERANDS
       The following operands are supported:

       file(s) The path name(s) of one or more input files.  They must be valid MPEG 1.0/2.0/2.5 audio layer 1, 2 or 3 bit streams.  If a dash `` ''  is  specified,
               MPEG data will be read from the standard input.  Furthermore, any name starting with ``http://'' is recognized as URL (see next section).

OPTIONS
       mpg123  options  may be either the traditional POSIX one letter options, or the GNU style long options.  POSIX style options start with a single `` '', while
       GNU long options start with ``  ''.  Option arguments (if needed) follow separated by whitespace (not ``='').  Note that some options can be absent from your
       installation when disabled in the build process.

INPUT OPTIONS
        k num,   skip num
              Skip first num frames.  By default the decoding starts at the first frame.

        n num,   frames num
              Decode only num frames.  By default the complete stream is decoded.

         fuzzy
              Enable  fuzzy  seeks  (guessing  byte offsets or using approximate seek points from Xing TOC).  Without that, seeks need a first scan through the file
              before they can jump at positions.  You can decide here: sample accurate operation with gapless features or faster (fuzzy) seeking.

        y,   no resync
              Do NOT try to resync and continue decoding if an error occurs in the input file. Normally, mpg123 tries to keep  the  playback  alive  at  all  costs,
              including skipping invalid material and searching new header when something goes wrong.  With this switch you can make it bail out on data errors (and
              perhaps spare your ears a bad time). Note that this switch has been renamed from   resync.  The old  name  still  works,  but  is  not  advertised  or
              recommened to use (subject to removal in future).

         resync limit bytes
              Set  number  of bytes to search for valid MPEG data; <0 means search whole stream.  If you know there are huge chunks of invalid data in your files...
              here is your hammer.

        p URL | none,   proxy URL | none
              The specified proxy will be used for HTTP requests.  It should be specified as full URL (``http://host.domain:port/''), but  the  ``http://''  prefix,
              the  port  number  and  the  trailing  slash are optional (the default port is 80).  Specifying none means not to use any proxy, and to retrieve files
              directly from the respective servers.  See also the ``HTTP SUPPORT'' section.

        u auth,   auth auth
              HTTP authentication to use when recieving files via HTTP.  The format used is user:password.

        @ file,   list file
              Read filenames and/or URLs of MPEG audio streams from the specified file in addition to the ones specified on the command line (if  any).   Note  that
              file  can be either an ordinary file, a dash `` '' to indicate that a list of filenames/URLs is to be read from the standard input, or an URL pointing
              to a an appropriate list file.  Note: only one  @ option can be used (if more than one is specified, only the last one will be recognized).

        l n,   listentry n
              Of the playlist, play specified entry only.  n is the number of entry starting at 1. A value of 0 is the default and means playling the whole list,  a
              negative value means showing of the list of titles with their numbers...

         loop times
              for looping track(s) a certain number of times, < 0 means infinite loop (not with   random!).

         keep open
              For remote control mode: Keep loaded file open after reaching end.

         timeout seconds
              Timeout in (integer) seconds before declaring a stream dead (if <= 0, wait forever).

        z,   shuffle
              Shuffle play.  Randomly shuffles the order of files specified on the command line, or in the list file.

        Z,   random
              Continuous  random  play.  Keeps picking a random file from the command line or the play list.  Unlike shuffle play above, random play never ends, and
              plays individual songs more than once.

         no icy meta
              Do not accept ICY meta data.

        i,   index
              Index / scan through the track before playback.  This fills the index table for seeking (if enabled in libmpg123) and may make  the  operating  system
              cache the file contents for smoother operating on playback.

         index size size
              Set the number of entries in the seek frame index table.

         preframes num
              Set  the number of frames to be read as lead in before a seeked to position.  This serves to fill the layer 3 bit reservoir, which is needed to faith Äê
              fully reproduce a certain sample at a certain position.  Note that for layer 3, a minimum of 1 is enforced (because of frame overlap), and for layer 1
              and 2, this is limited to 2 (no bit reservoir in that case, but engine spin up anyway).


OUTPUT and PROCESSING OPTIONS
        o module,   output module
              Select audio output module. You can provide a comma separated list to use the first one that works.

         list modules
              List the available modules.

        a dev,   audiodevice dev
              Specify  the  audio  device  to  use.   The  default is system dependent (usually /dev/audio or /dev/dsp).  Use this option if you have multiple audio
              devices and the default is not what you want.

        s,   stdout
              The decoded audio samples are written to standard output, instead of playing them through the audio device.  This option must be used  if  your  audio
              hardware  is  not  supported by mpg123.  The output format per default is raw (headerless) linear PCM audio data, 16 bit, stereo, host byte order (you
              can force mono or 8bit).

        O file,   outfile
              Write raw output into a file (instead of simply redirecting standard output to a file with the shell).

        w file,   wav
              Write output as WAV file. This will cause the MPEG stream to be decoded and saved as file file , or standard output if   is used as file name. You can
              also use   au and   cdr for AU and CDR format, respectively.

         au file
              Does not play the MPEG file but writes it to file in SUN audio format.  If   is used as the filename, the AU file is written to stdout.

         cdr file
              Does not play the MPEG file but writes it to file as a CDR file.  If   is used as the filename, the CDR file is written to stdout.

         reopen
              Forces reopen of the audiodevice after ever song

         cpu decoder type
              Selects  a certain decoder (optimized for specific CPU), for example i586 or MMX.  The list of available decoders can vary; depending on the build and
              what your CPU supports.  This options is only availabe when the build actually includes several optimized decoders.

         test cpu
              Tests your CPU and prints a list of possible choices for   cpu.

         list cpu
              Lists all available decoder choices, regardless of support by your CPU.

        g gain,   gain gain
              [DEPRECATED] Set audio hardware output gain (default: don't change). The unit of the gain value is hardware and output module dependent.  (This param Äê
              eter  is only provided for backwards compatibility and may be removed in the future without prior notice. Use the audio player for playing and a mixer
              app for mixing, UNIX style!)

        f factor,   scale factor
              Change scale factor (default: 32768).

         rva mix,   rva radio
              Enable RVA (relative volume adjustment) using the values stored for ReplayGain radio mode / mix mode with all  tracks  roughly  equal  loudness.   The
              first valid information found in ID3V2 Tags (Comment named RVA or the RVA2 frame) or ReplayGain header in Lame/Info Tag is used.

         rva album,   rva audiophile
              Enable RVA (relative volume adjustment) using the values stored for ReplayGain audiophile mode / album mode with usually the effect of adjusting album
              loudness but keeping relative loudness inside album.  The first valid information found in ID3V2 Tags (Comment named RVA_ALBUM or the RVA2  frame)  or
              ReplayGain header in Lame/Info Tag is used.

        0,   single0;  1,   single1
              Decode only channel 0 (left) or channel 1 (right), respectively.  These options are available for stereo MPEG streams only.

        m,   mono,   mix,   singlemix
              Mix both channels / decode mono. It takes less CPU time than full stereo decoding.

         stereo
              Force stereo output

        r rate,   rate rate
              Set sample rate (default: automatic).  You may want to change this if you need a constant bitrate independed of the mpeg stream rate. mpg123 automagi Äê
              cally converts the rate. You should then combine this with   stereo or   mono.

        2,   2to1;  4,   4to1
              Performs a downsampling of ratio 2:1 (22 kHz) or 4:1 (11 kHz) on the output stream, respectively. Saves some CPU cycles, but at least  the  4:1  ratio
              sounds ugly.

         pitch value
              Set  hardware  pitch  (speedup/down,  0  is neutral; 0.05 is 5%). This changes the output sampling rate, so it only works in the range your audio sys Äê
              tem/hardware supports.

         8bit Forces 8bit output

        d n,   doublespeed n
              Only play every n'th frame.  This will cause the MPEG stream to be played n times faster, which can be used for special effects.  Can also be combined
              with the   halfspeed option to play 3 out of 4 frames etc.  Don't expect great sound quality when using this option.

        h n,   halfspeed n
              Play  each  frame  n times.  This will cause the MPEG stream to be played at 1/n'th speed (n times slower), which can be used for special effects. Can
              also be combined with the   doublespeed option to double every third frame or things like that.  Don't expect great  sound  quality  when  using  this
              option.

        E file,   equalizer
              Enables  equalization,  taken from file.  The file needs to contain 32 lines of data, additional comment lines may be prefixed with 

Related Topics