cinelerra/asset.h

   1 #ifndef ASSET_H
   2 #define ASSET_H
   3
   4
   5 #include "arraylist.h"
   6 #include "bcwindowbase.inc"
   7 #include "bchash.inc"
   8 #include "filexml.inc"
   9 #include "garbage.h"
  10 #include "linklist.h"
  11 #include "pluginserver.inc"
  12
  13
  14 #include <stdint.h>
  15
  16 // Time code formats
  17 #define TC_DROPFRAME 0
  18 #define TC_NONDROPFRAME 1
  19 #define TC_PAL 2
  20 #define TC_FILM 3
  21
  22 // Asset can be one of the following:
  23 // 1) a pure media file
  24 // 2) an EDL
  25 // 3) a log
  26 // The EDL can reference itself if it contains a media file
  27 class Asset : public ListItem<Asset>, public GarbageObject
  28 {
  29 public:
  30         Asset();
  31         Asset(Asset &asset);
  32         Asset(const char *path);
  33         Asset(const int plugin_type, const char *plugin_path);
  34         ~Asset();
  35
  36         int init_values();
  37         int dump();
  38
  39         void copy_from(Asset *asset, int do_index);
  40         void copy_location(Asset *asset);
  41         void copy_format(Asset *asset, int do_index = 1);
  42         void copy_index(Asset *asset);
  43         int64_t get_index_offset(int channel);
  44         int64_t get_index_size(int channel);
  45 // Get an english description of the compression.  Used by AssetEdit
  46         char* get_compression_text(int audio, int video);
  47
  48 // Load and save parameters for a render dialog
  49 // Used by render, record, menueffects, preferences
  50         void load_defaults(BC_Hash *defaults,
  51                 char *prefix /* = 0 */,
  52                 int do_format /* = 0 */,
  53                 int do_compression,
  54                 int do_path,
  55                 int do_data_types,
  56                 int do_bits);
  57         void save_defaults(BC_Hash *defaults,
  58                 char *prefix /* = 0 */,
  59                 int do_format,     /* Don't save format which is autodetected by file loader */
  60                 int do_compression,    /* Don't save compression which is fixed by driver */
  61                 int do_path,
  62                 int do_data_types,
  63                 int do_bits);
  64         char* construct_param(char *param, char *prefix, char *return_value);
  65
  66 // defaults which are specific to format used
  67         void load_format_defaults(BC_Hash *defaults);
  68         void save_format_defaults(BC_Hash *defaults);
  69
  70 // Executed during index building only
  71         void update_index(Asset *asset);
  72         int equivalent(Asset &asset,
  73                 int test_audio,
  74                 int test_video);
  75         Asset& operator=(Asset &asset);
  76         int operator==(Asset &asset);
  77         int operator!=(Asset &asset);
  78         int test_path(const char *path);
  79         int test_plugin_title(const char *path);
  80         int read(FileXML *file, int expand_relative = 1);
  81         int read_audio(FileXML *xml);
  82         int read_video(FileXML *xml);
  83         int read_index(FileXML *xml);
  84         int reset_index();  // When the index file is wrong, reset the asset values
  85
  86         int set_timecode(char *tc, int format, int end);
  87         int reset_timecode();
  88
  89 // Output path is the path of the output file if name truncation is desired.
  90 // It is a "" if; complete names should be used.
  91         int write(FileXML *file,
  92                 int include_index,
  93                 char *output_path);
  94 // Write the index data and asset info.  Used by IndexThread.
  95         int write_index(char *path, int data_bytes);
  96
  97
  98 // Necessary for renderfarm to get encoding parameters
  99         int write_audio(FileXML *xml);
 100         int write_video(FileXML *xml);
 101         int write_index(FileXML *xml);
 102         int update_path(char *new_path);
 103
 104 // Path to file
 105         char path[BCTEXTLEN];
 106
 107 // Pipe command
 108         char pipe[BCTEXTLEN];
 109         int use_pipe;
 110
 111 // Prefix used to generate this asset
 112         char prefix[BCTEXTLEN];
 113
 114 // Folder in resource manager
 115         char folder[BCTEXTLEN];
 116
 117 // Format of file.  An enumeration from file.inc.
 118         int format;
 119
 120 // contains audio data
 121         int audio_data;
 122         int channels;
 123         int sample_rate;
 124         int bits;
 125         int byte_order;
 126         int signed_;
 127         int header;
 128         int dither;
 129 // String or FourCC describing compression
 130         char acodec[BCTEXTLEN];
 131
 132
 133         int64_t audio_length;
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146 // contains video data
 147         int video_data;
 148         int layers;
 149         double frame_rate;
 150
 151 // Timecode information. User setable, in case of errors in source
 152         char reel_name[BCTEXTLEN];
 153         int reel_number;
 154         int64_t tcstart;
 155         int64_t tcend;
 156         int tcformat;
 157
 158         int width, height;
 159 // String or FourCC describing compression
 160         char vcodec[BCTEXTLEN];
 161
 162 // Length in units of asset
 163         int64_t video_length;
 164
 165
 166
 167
 168
 169 // mpeg audio information
 170         int ampeg_bitrate;
 171 // 2 - 3
 172         int ampeg_derivative;
 173
 174 // Vorbis compression
 175         int vorbis_min_bitrate;
 176         int vorbis_bitrate;
 177         int vorbis_max_bitrate;
 178         int vorbis_vbr;
 179
 180 // Theora compression
 181         int theora_fix_bitrate;
 182         int theora_bitrate;
 183         int theora_quality;
 184         int theora_sharpness;
 185         int theora_keyframe_frequency;
 186         int theora_keyframe_force_frequency;
 187
 188
 189 // mp3 compression
 190         int mp3_bitrate;
 191
 192 // mp4a compression
 193         int mp4a_bitrate;
 194         int mp4a_quantqual;
 195
 196
 197 // Set by package render during file creation. -1 means square pixels.
 198         double aspect_ratio;
 199
 200 // for the interlace mode
 201         int interlace_autofixoption;
 202         int interlace_mode;
 203         int interlace_fixmethod;
 204
 205 // for jpeg compression
 206         int jpeg_quality;
 207
 208 // for mpeg video compression
 209         int vmpeg_iframe_distance;
 210         int vmpeg_progressive;
 211         int vmpeg_denoise;
 212         int vmpeg_seq_codes;
 213         int vmpeg_bitrate;
 214 // 1 - 2
 215         int vmpeg_derivative;
 216         int vmpeg_quantization;
 217         int vmpeg_cmodel;
 218         int vmpeg_fix_bitrate;
 219
 220 // mjpegtools
 221         int vmpeg_preset;
 222 // top field first
 223         int vmpeg_field_order;
 224         int vmpeg_pframe_distance;
 225
 226
 227
 228
 229
 230
 231
 232
 233 // Divx video compression
 234         int divx_bitrate;
 235         int divx_rc_period;
 236         int divx_rc_reaction_ratio;
 237         int divx_rc_reaction_period;
 238         int divx_max_key_interval;
 239         int divx_max_quantizer;
 240         int divx_min_quantizer;
 241         int divx_quantizer;
 242         int divx_quality;
 243         int divx_fix_bitrate;
 244
 245 // h264 video compression
 246         int h264_bitrate;
 247         int h264_quantizer;
 248         int h264_fix_bitrate;
 249
 250 // Divx video decompression
 251         int divx_use_deblocking;
 252
 253 // PNG video compression
 254         int png_use_alpha;
 255
 256 // EXR video compression
 257         int exr_use_alpha;
 258         int exr_compression;
 259
 260 // TIFF video compression.  An enumeration from filetiff.h
 261         int tiff_cmodel;
 262         int tiff_compression;
 263
 264 // Microsoft MPEG-4
 265         int ms_bitrate;
 266         int ms_bitrate_tolerance;
 267         int ms_interlaced;
 268         int ms_quantization;
 269         int ms_gop_size;
 270         int ms_fix_bitrate;
 271
 272
 273         int ac3_bitrate;
 274
 275
 276
 277 // Image file sequences.  Background rendering doesn't want to write a
 278 // sequence header but instead wants to start the sequence numbering at a certain
 279 // number.  This ensures deletion of all the frames which aren't being used.
 280 // We still want sequence headers sometimes because loading a directory full of images
 281 // for editing would create new assets for every image.
 282         int use_header;
 283
 284
 285
 286 // Edits store data for the transition
 287
 288 // index info
 289         int index_status;     // Macro from assets.inc
 290         int64_t index_zoom;      // zoom factor of index data
 291         int64_t index_start;     // byte start of index data in the index file
 292 // Total bytes in source file when the index was buillt
 293         int64_t index_bytes;
 294         int64_t index_end, old_index_end;    // values for index build
 295 // offsets of channels in index buffer in floats
 296         int64_t *index_offsets;
 297 // Sizes of channels in index buffer in floats.  This allows
 298 // variable channel size.
 299         int64_t *index_sizes;
 300 // [ index channel      ][ index channel      ]
 301 // [high][low][high][low][high][low][high][low]
 302         float *index_buffer;
 303         int id;
 304 };
 305
 306
 307 #endif