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;          /* pointer to a referenced ROOT */
  68     lsmash_file_t           *file;          /* pointer to a file which this importer handles */
  69     lsmash_bs_t             *bs;
  70     lsmash_file_parameters_t file_param;
  71     void                    *info;          /* importer internal status information. */
  72     importer_functions       funcs;
  73     lsmash_entry_list_t     *summaries;
  74     int                      is_adhoc_open; /* If set to 1, it means this importer is not allocated by lsmash_read_file().
  75                                              * This is a poor design due to historical implementation between the importer
  76                                              * framework and ISOBMFF demuxer framework. The importer shall be hidden inside
  77                                              * the file handling abstraction layer. That'll achieve integration of the muxer
  78                                              * and the remuxer CLIs. */
  79 };
  80
  81 int lsmash_importer_make_fake_movie
  82 (
  83     importer_t *importer
  84 );
  85
  86 int lsmash_importer_make_fake_track
  87 (
  88     importer_t       *importer,
  89     lsmash_media_type media_type,
  90     uint32_t         *track_ID
  91 );
  92
  93 void lsmash_importer_break_fake_movie
  94 (
  95     importer_t *importer
  96 );
  97
  98 #else
  99
 100 int lsmash_importer_set_file
 101 (
 102     importer_t    *importer,
 103     lsmash_file_t *file
 104 );
 105
 106 /* importing functions */
 107 importer_t *lsmash_importer_alloc
 108 (
 109     lsmash_root_t *root
 110 );
 111
 112 void lsmash_importer_destroy
 113 (
 114     importer_t *importer
 115 );
 116
 117 int lsmash_importer_find
 118 (
 119     importer_t *importer,
 120     const char *format,
 121     int         auto_detect
 122 );
 123
 124 importer_t *lsmash_importer_open
 125 (
 126     lsmash_root_t *root,
 127     const char    *identifier,
 128     const char    *format
 129 );
 130
 131 void lsmash_importer_close
 132 (
 133     importer_t *importer
 134 );
 135
 136 int lsmash_importer_get_access_unit
 137 (
 138     importer_t       *importer,
 139     uint32_t          track_number,
 140     lsmash_sample_t **p_sample
 141 );
 142
 143 uint32_t lsmash_importer_get_last_delta
 144 (
 145     importer_t *importer,
 146     uint32_t    track_number
 147 );
 148
 149 int lsmash_importer_construct_timeline
 150 (
 151     importer_t *importer,
 152     uint32_t    track_number
 153 );
 154
 155 uint32_t lsmash_importer_get_track_count
 156 (
 157     importer_t *importer
 158 );
 159
 160 lsmash_summary_t *lsmash_duplicate_summary
 161 (
 162     importer_t *importer,
 163     uint32_t    track_number
 164 );
 165
 166 #endif /* #ifdef LSMASH_IMPORTER_INTERNAL */
 167
 168 #endif /* #ifndef LSMASH_IMPORTER_H */