include/library/opus-ogg.hpp

   1 #ifndef _library__opus_ogg__hpp__included__
   2 #define _library__opus_ogg__hpp__included__
   3
   4 #include <functional>
   5 #include <cstdint>
   6 #include "ogg.hpp"
   7
   8 namespace opus
   9 {
  10 /**
  11  * OggOpus header structure.
  12  */
  13 struct ogg_header
  14 {
  15         uint8_t version;
  16         uint8_t channels;
  17         uint16_t preskip;
  18         uint32_t rate;
  19         int16_t gain;
  20         uint8_t map_family;
  21         uint8_t streams;
  22         uint8_t coupled;
  23         uint8_t chanmap[255];
  24 /**
  25  * Parse Ogg packet as OggOpus header.
  26  *
  27  * Parameter pacekt: The packet to parse.
  28  * Throws std::runtime_error: Not valid OggOpus header page.
  29  */
  30         void parse(struct ogg::packet& packet);
  31 /**
  32  * Serialize OggOpus header as an Ogg page.
  33  *
  34  * Returns: The serialized page.
  35  * Throws std::runtime_error: Not valid OggOpus header packet.
  36  */
  37         struct ogg::page serialize();
  38 };
  39
  40 /**
  41  * OggOpus tags structure
  42  */
  43 struct ogg_tags
  44 {
  45         std::string vendor;
  46         std::vector<std::string> comments;
  47 /**
  48  * Parse Ogg packet as OggOpus comment.
  49  *
  50  * Parameter packet: The packet to parse.
  51  * Throws std::runtime_error: Not valid OggOpus comment packet.
  52  */
  53         void parse(struct ogg::packet& packet);
  54 /**
  55  * Serialize OggOpus comments as Ogg pages.
  56  *
  57  * Parameter output: Callback to call on each serialized page on turn.
  58  * Parameter strmid: The stream id to use.
  59  * Returns: Next sequence number to use.
  60  * Throws std::runtime_error: Not valid OggOpus comments.
  61  */
  62         uint32_t serialize(std::function<void(const ogg::page& p)> output, uint32_t strmid);
  63 };
  64 }
  65 #endif