importer/importer.h

   1 /*****************************************************************************
   2  * importer.h
   3  *****************************************************************************
   4  * Copyright (C) 2010-2017 L-SMASH project
   5  *
   6  * Authors: Takashi Hirata <silverfilain@gmail.com>
   7  * Contributors: Yusuke Nakamura <muken.the.vfrmaniac@gmail.com>
   8  *
   9  * Permission to use, copy, modify, and/or distribute this software for any
  10  * purpose with or without fee is hereby granted, provided that the above
  11  * copyright notice and this permission notice appear in all copies.
  12  *
  13  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  14  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  15  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  16  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  17  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  18  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  19  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  20  *****************************************************************************/
  21
  22 /* This file is available under an ISC license. */
  23
  24 #ifndef LSMASH_IMPORTER_H
  25 #define LSMASH_IMPORTER_H
  26
  27 /***************************************************************************
  28     importer
  29 ***************************************************************************/
  30 typedef struct importer_tag importer_t;
  31
  32 #ifdef LSMASH_IMPORTER_INTERNAL
  33
  34 #include "core/box.h"
  35 #include "codecs/description.h"
  36
  37 typedef void     ( *importer_cleanup )           ( importer_t * );
  38 typedef int      ( *importer_get_accessunit )    ( importer_t *, uint32_t, lsmash_sample_t ** );
  39 typedef int      ( *importer_probe )             ( importer_t * );
  40 typedef uint32_t ( *importer_get_last_duration ) ( importer_t *, uint32_t );
  41 typedef int      ( *importer_construct_timeline )( importer_t *, uint32_t );
  42
  43 typedef enum
  44 {
  45     IMPORTER_ERROR  = -1,
  46     IMPORTER_OK     = 0,
  47     IMPORTER_CHANGE = 1,
  48     IMPORTER_EOF    = 2,
  49 } importer_status;
  50
  51 typedef struct
  52 {
  53     lsmash_class_t              class;
  54     int                         detectable;
  55     importer_probe              probe;
  56     importer_get_accessunit     get_accessunit;
  57     importer_get_last_duration  get_last_delta;
  58     importer_cleanup            cleanup;
  59     importer_construct_timeline construct_timeline;
  60 } importer_functions;
  61
  62 struct importer_tag
  63 {
  64     const lsmash_class_t   *class;
  65     lsmash_log_level        log_level;
  66     importer_status         status;
  67     lsmash_root_t          *root;
  68     lsmash_file_t          *file;
  69     lsmash_bs_t            *bs;
  70     lsmash_file_parameters_t file_param;
  71     int                     is_stdin;
  72     void                   *info;      /* importer internal status information. */
  73     importer_functions      funcs;
  74     lsmash_entry_list_t    *summaries;
  75 };
  76
  77 int lsmash_importer_make_fake_movie
  78 (
  79     importer_t *importer
  80 );
  81
  82 int lsmash_importer_make_fake_track
  83 (
  84     importer_t       *importer,
  85     lsmash_media_type media_type,
  86     uint32_t         *track_ID
  87 );
  88
  89 void lsmash_importer_break_fake_movie
  90 (
  91     importer_t *importer
  92 );
  93
  94 #else
  95
  96 int lsmash_importer_set_file
  97 (
  98     importer_t    *importer,
  99     lsmash_file_t *file
 100 );
 101
 102 /* importing functions */
 103 importer_t *lsmash_importer_alloc( void );
 104
 105 void lsmash_importer_destroy
 106 (
 107     importer_t *importer
 108 );
 109
 110 int lsmash_importer_find
 111 (
 112     importer_t *importer,
 113     const char *format,
 114     int         auto_detect
 115 );
 116
 117 importer_t *lsmash_importer_open
 118 (
 119     const char *identifier,
 120     const char *format
 121 );
 122
 123 void lsmash_importer_close
 124 (
 125     importer_t *importer
 126 );
 127
 128 int lsmash_importer_get_access_unit
 129 (
 130     importer_t       *importer,
 131     uint32_t          track_number,
 132     lsmash_sample_t **p_sample
 133 );
 134
 135 uint32_t lsmash_importer_get_last_delta
 136 (
 137     importer_t *importer,
 138     uint32_t    track_number
 139 );
 140
 141 int lsmash_importer_construct_timeline
 142 (
 143     importer_t *importer,
 144     uint32_t    track_number
 145 );
 146
 147 uint32_t lsmash_importer_get_track_count
 148 (
 149     importer_t *importer
 150 );
 151
 152 lsmash_summary_t *lsmash_duplicate_summary
 153 (
 154     importer_t *importer,
 155     uint32_t    track_number
 156 );
 157
 158 #endif /* #ifdef LSMASH_IMPORTER_INTERNAL */
 159
 160 #endif /* #ifndef LSMASH_IMPORTER_H */