git.sesse.net Git - vlc/blob - modules/demux/ogg.h

   1 /*****************************************************************************
   2  * ogg.h : ogg stream demux module for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2001-2010 VLC authors and VideoLAN
   5  *
   6  * Authors: Gildas Bazin <gbazin@netcourrier.com>
   7  *          Andre Pang <Andre.Pang@csiro.au> (Annodex support)
   8  *          Gabriel Finch <salsaman@gmail.com> (moved from ogg.c to ogg.h)
   9  *
  10  * This program is free software; you can redistribute it and/or modify it
  11  * under the terms of the GNU Lesser General Public License as published by
  12  * the Free Software Foundation; either version 2.1 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with this program; if not, write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28
  29
  30
  31
  32 /*****************************************************************************
  33  * Definitions of structures and functions used by this plugins
  34  *****************************************************************************/
  35
  36
  37 typedef struct oggseek_index_entry demux_index_entry_t;
  38
  39
  40 typedef struct logical_stream_s
  41 {
  42     ogg_stream_state os;                        /* logical stream of packets */
  43
  44     es_format_t      fmt;
  45     es_format_t      fmt_old;                  /* format of old ES is reused */
  46     es_out_id_t      *p_es;
  47     double           f_rate;
  48
  49     int              i_serial_no;
  50
  51     /* the header of some logical streams (eg vorbis) contain essential
  52      * data for the decoder. We back them up here in case we need to re-feed
  53      * them to the decoder. */
  54     int              b_force_backup;
  55     int              i_packets_backup;
  56     void             *p_headers;
  57     int              i_headers;
  58     ogg_int64_t      i_previous_granulepos;
  59
  60     /* program clock reference (in units of 90kHz) derived from the previous
  61      * granulepos */
  62     mtime_t          i_pcr;
  63     mtime_t          i_interpolated_pcr;
  64     mtime_t          i_previous_pcr;
  65
  66     /* Misc */
  67     bool b_reinit;
  68     int i_granule_shift;
  69     /* Opus has a starting offset in the headers. */
  70     int i_pre_skip;
  71     /* Vorbis and Opus can trim the end of a stream using granule positions. */
  72     int i_end_trim;
  73
  74     /* offset of first keyframe for theora; can be 0 or 1 depending on version number */
  75     int64_t i_keyframe_offset;
  76
  77     /* keyframe index for seeking, created as we discover keyframes */
  78     demux_index_entry_t *idx;
  79
  80     /* skip some frames after a seek */
  81     int i_skip_frames;
  82
  83     /* data start offset (absolute) in bytes */
  84     int64_t i_data_start;
  85
  86     /* kate streams have the number of headers in the ID header */
  87     int i_kate_num_headers;
  88
  89     /* for Annodex logical bitstreams */
  90     int i_secondary_header_packets;
  91
  92 } logical_stream_t;
  93
  94
  95
  96
  97
  98
  99 struct demux_sys_t
 100 {
 101     ogg_sync_state oy;        /* sync and verify incoming physical bitstream */
 102
 103     int i_streams;                           /* number of logical bitstreams */
 104     logical_stream_t **pp_stream;  /* pointer to an array of logical streams */
 105
 106     logical_stream_t *p_old_stream; /* pointer to a old logical stream to avoid recreating it */
 107
 108     /* program clock reference (in units of 90kHz) derived from the pcr of
 109      * the sub-streams */
 110     mtime_t i_pcr;
 111
 112     /* stream state */
 113     int     i_bos;
 114     int     i_eos;
 115
 116     /* bitrate */
 117     int     i_bitrate;
 118
 119     /* after reading all headers, the first data page is stuffed into the relevant stream, ready to use */
 120     bool    b_page_waiting;
 121
 122     /* count of total frames in video stream */
 123     int64_t i_total_frames;
 124
 125     /* length of file in bytes */
 126     int64_t i_total_length;
 127
 128     /* offset position in file (for reading) */
 129     int64_t i_input_position;
 130
 131     /* current page being parsed */
 132     ogg_page current_page;
 133
 134     mtime_t i_st_pts;
 135
 136
 137     /* */
 138     vlc_meta_t *p_meta;
 139
 140     /* */
 141     int                i_attachments;
 142     input_attachment_t **attachments;
 143
 144     /* Length, if available. */
 145     int64_t i_length;
 146 };