/*****************************************************************************

 * matroska_segment.hpp : matroska demuxer

 *****************************************************************************

 * Copyright (C) 2003-2004 VLC authors and VideoLAN

 *

 * Authors: Laurent Aimar <fenrir@via.ecp.fr>

 *          Steve Lhomme <steve.lhomme@free.fr>

 *

 * This program is free software; you can redistribute it and/or modify it

 * under the terms of the GNU Lesser General Public License as published by

 * the Free Software Foundation; either version 2.1 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

 * GNU Lesser General Public License for more details.

 *

 * You should have received a copy of the GNU Lesser General Public License

 * along with this program; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.

 *****************************************************************************/

#ifndef VLC_MKV_MATROSKA_SEGMENT_HPP_

#define VLC_MKV_MATROSKA_SEGMENT_HPP_

#include "demux.hpp"

#include "mkv.hpp"

#include "matroska_segment_seeker.hpp"

#include <vector>

#include <string>

#include <map>

#include <set>

#include <memory>

#include "Ebml_parser.hpp"

namespace mkv {

class EbmlParser;

class chapter_edition_c;

class chapter_translation_c;

class chapter_item_c;

class mkv_track_t;

typedef enum

{

    WHOLE_SEGMENT,

    TRACK_UID,

    EDITION_UID,

    CHAPTER_UID,

    ATTACHMENT_UID

} tag_target_type;

class SimpleTag

{

public:

    typedef std::vector<SimpleTag> sub_tags_t;

    std::string tag_name;

    std::string lang;

    std::string value;

    sub_tags_t sub_tags;

};

class Tag

{

public:

    typedef std::vector<SimpleTag> simple_tags_t;

    Tag():i_tag_type(WHOLE_SEGMENT),i_target_type(50),i_uid(0){}

    tag_target_type i_tag_type;

    uint64_t        i_target_type;

    uint64_t        i_uid;

    simple_tags_t   simple_tags;

};

struct demux_sys_t;

class matroska_segment_c

{

public:

    typedef std::map<mkv_track_t::track_id_t, std::unique_ptr<mkv_track_t>> tracks_map_t;

    typedef std::vector<Tag>            tags_t;

    matroska_segment_c( demux_sys_t &, matroska_iostream_c &, KaxSegment * );

    virtual ~matroska_segment_c();

    KaxSegment              *segment;

    matroska_iostream_c     & es;

    /* time scale */

    uint64_t                i_timescale;

    /* duration of the segment */

    vlc_tick_t              i_duration;

    vlc_tick_t              i_mk_start_time;

    /* all tracks */

    tracks_map_t tracks;

    SegmentSeeker::track_ids_t priority_tracks;

    vlc_tick_t                 pcr_shift = 0;

    /* from seekhead */

    int                     i_seekhead_count;

    int64_t                 i_seekhead_position;

    int64_t                 i_cues_position;

    int64_t                 i_tracks_position;

    int64_t                 i_info_position;

    int64_t                 i_chapters_position;

    int64_t                 i_attachments_position;

    KaxCluster              *cluster;

    uint64_t                i_block_pos;

    KaxSegmentUID           *p_segment_uid;

    KaxPrevUID              *p_prev_segment_uid;

    KaxNextUID              *p_next_segment_uid;

    bool                    b_cues;

    /* info */

    char                    *psz_muxing_application;

    char                    *psz_writing_application;

    char                    *psz_segment_filename;

    char                    *psz_title;

    char                    *psz_date_utc;

    /* !!!!! GCC 3.3 bug on Darwin !!!!! */

    /* when you remove this variable the compiler issues an atomicity error */

    /* this variable only works when using std::vector<chapter_edition_c> */

    std::vector<chapter_edition_c*> stored_editions;

    std::vector<chapter_edition_c*>::size_type i_default_edition;

    std::vector<chapter_translation_c*> translations;

    std::vector<KaxSegmentFamily*>  families;

    tags_t                          tags;

    demux_sys_t                    & sys;

    EbmlParser                     ep;

    bool                           b_preloaded;

    bool                           b_ref_external_segments;

    bool Preload();

    bool PreloadFamily( const matroska_segment_c & segment );

    bool PreloadClusters( uint64_t i_cluster_position );

    void InformationCreate();

    bool Seek( demux_t &, vlc_tick_t i_mk_date, vlc_tick_t i_mk_time_offset, bool b_accurate );

    int BlockGet( KaxBlock * &, KaxSimpleBlock * &, KaxBlockAdditions * &,

                  bool *, bool *, int64_t *);

    mkv_track_t * FindTrackByBlock(const KaxBlock *, const KaxSimpleBlock * );

    bool ESCreate( );

    void ESDestroy( );

    static bool CompareSegmentUIDs( const matroska_segment_c * item_a, const matroska_segment_c * item_b );

    bool SameFamily( const matroska_segment_c & of_segment ) const;

    // read a whole EBML master element at once

    bool ReadMaster(EbmlMaster & m, ScopeMode scope = SCOPE_ALL_DATA)

    {

        if( unlikely( m.IsFiniteSize() && m.GetSize() >= SIZE_MAX ) )

        {

            msg_Err( VLC_OBJECT(&sys.demuxer), "%s too big, aborting", EBML_NAME(&m) );

            return false;

        }

        try

        {

            EbmlElement *el;

            int i_upper_level = 0;

            m.Read( es, EBML_CONTEXT(&m), i_upper_level, el, true, scope );

            if (i_upper_level != 0)

            {

                assert(el != nullptr);

                delete el;

            }

        }

        catch(...)

        {

            msg_Err( VLC_OBJECT(&sys.demuxer), "Couldn't read %s", EBML_NAME(&m) );

            return false;

        }

        return true;

    }

private:

    void LoadCues( KaxCues *cues );

    void LoadTags( KaxTags *tags );

    bool LoadSeekHeadItem( const EbmlCallbacks & ClassInfos, int64_t i_element_position );

    void ParseInfo( KaxInfo *info );

    void ParseAttachments( KaxAttachments *attachments );

    void ParseChapters( KaxChapters *chapters );

    void ParseSeekHead( KaxSeekHead *seekhead );

    void ParseTracks( KaxTracks *tracks );

    void ParseChapterAtom( int i_level, KaxChapterAtom *ca, chapter_item_c & chapters );

    void ParseTrackEntry( const KaxTrackEntry* m );

    bool ParseCluster( KaxCluster *cluster, bool b_update_start_time = true, ScopeMode read_fully = SCOPE_ALL_DATA );

    bool ParseSimpleTags( SimpleTag* out, KaxTagSimple *tag, int level = 50 );

    bool TrackInit( mkv_track_t * p_tk );

    void ComputeTrackPriority();

    void EnsureDuration();

    SegmentSeeker _seeker;

    friend SegmentSeeker;

};

} // namespace

#endif