doc/mainpage.txt

   1 /*!
   2
   3 @mainpage libsub
   4
   5 libsub is a library to read and write subtitles in a variety of formats.  It can be used to read subtitles for
   6 processing, to write them or to convert between formats.
   7
   8 The current version has reasonable support for the following subtitle formats:
   9 - Digital Cinema Package (DCP) XML
  10 - SubRip (.srt)
  11 - EBU-STL text and binary
  12
  13
  14 Reading subtitles
  15 --
  16
  17 The basic process is:
  18
  19     shared_ptr<sub::Reader> reader = reader_factory (filename);
  20     list<sub::Subtitle> subs = collect<list<sub::Subtitle> > (reader->subtitles ());
  21
  22 We first have:
  23
  24     shared_ptr<sub::Reader> reader = reader_factory (filename);
  25
  26 This looks at the extension of `filename' and, if necessary, its header, and guesses
  27 what format it is in.  Based on the format it creates an appropriate Reader object.
  28 This reader object can then return its subtitles using
  29
  30     reader->subtitles ();
  31
  32
  33
  34
  35
  36 */