modules/demux/ogg.h

   1 /*****************************************************************************
   2  * ogg.h : ogg stream demux module for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2001-2010 the VideoLAN team
   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
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 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 General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, 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
  59     /* program clock reference (in units of 90kHz) derived from the previous
  60      * granulepos */
  61     mtime_t          i_pcr;
  62     mtime_t          i_interpolated_pcr;
  63     mtime_t          i_previous_pcr;
  64
  65     /* Misc */
  66     bool b_reinit;
  67     int i_granule_shift;
  68
  69     /* offset of first keyframe for theora; can be 0 or 1 depending on version number */
  70     int64_t i_keyframe_offset;
  71
  72     /* keyframe index for seeking, created as we discover keyframes */
  73     demux_index_entry_t *idx;
  74
  75     /* skip some frames after a seek */
  76     int i_skip_frames;
  77
  78     /* data start offset (absolute) in bytes */
  79     int64_t i_data_start;
  80
  81     /* kate streams have the number of headers in the ID header */
  82     int i_kate_num_headers;
  83
  84     /* for Annodex logical bitstreams */
  85     int i_secondary_header_packets;
  86
  87 } logical_stream_t;
  88
  89
  90
  91
  92
  93
  94 struct demux_sys_t
  95 {
  96     ogg_sync_state oy;        /* sync and verify incoming physical bitstream */
  97
  98     int i_streams;                           /* number of logical bitstreams */
  99     logical_stream_t **pp_stream;  /* pointer to an array of logical streams */
 100
 101     logical_stream_t *p_old_stream; /* pointer to a old logical stream to avoid recreating it */
 102
 103     /* program clock reference (in units of 90kHz) derived from the pcr of
 104      * the sub-streams */
 105     mtime_t i_pcr;
 106
 107     /* stream state */
 108     int     i_bos;
 109     int     i_eos;
 110
 111     /* bitrate */
 112     int     i_bitrate;
 113
 114     /* after reading all headers, the first data page is stuffed into the relevant stream, ready to use */
 115     bool    b_page_waiting;
 116
 117     /* count of total frames in video stream */
 118     int64_t i_total_frames;
 119
 120     /* length of file in bytes */
 121     int64_t i_total_length;
 122
 123     /* offset position in file (for reading) */
 124     int64_t i_input_position;
 125
 126     /* current page being parsed */
 127     ogg_page current_page;
 128
 129     mtime_t i_st_pts;
 130
 131
 132     /* */
 133     vlc_meta_t *p_meta;
 134 };