cinelerra/asset.h

   1 /*
   2  * CINELERRA
   3  * Copyright (C) 2010 Adam Williams <broadcast at earthling dot net>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18  *
  19  */
  20
  21 #ifndef ASSET_H
  22 #define ASSET_H
  23
  24 #include <stdio.h>
  25 #include <stdint.h>
  26
  27 #include "arraylist.h"
  28 #include "bcwindowbase.inc"
  29 #include "bchash.inc"
  30 #include "edl.inc"
  31 #include "filexml.inc"
  32 #include "indexable.h"
  33 #include "indexfile.inc"
  34 #include "indexstate.inc"
  35 #include "linklist.h"
  36 #include "pluginserver.inc"
  37
  38
  39 // Time code formats
  40 #define TC_DROPFRAME 0
  41 #define TC_NONDROPFRAME 1
  42 #define TC_PAL 2
  43 #define TC_FILM 3
  44
  45 class Asset : public Indexable, public ListItem<Asset>
  46 {
  47 public:
  48         Asset();
  49         Asset(Asset &asset);
  50         Asset(const char *path);
  51         Asset(const int plugin_type, const char *plugin_path);
  52         ~Asset();
  53
  54         int init_values();
  55         int dump(FILE *fp=stdout);
  56         void boundaries();
  57
  58         void copy_from(Asset *asset, int do_index);
  59         void copy_location(Asset *asset);
  60         void copy_format(Asset *asset, int do_index = 1);
  61         void copy_index(Asset *asset);
  62         int64_t get_index_offset(int channel);
  63         int64_t get_index_size(int channel);
  64 // Get an english description of the compression.  Used by AssetEdit
  65         char* get_compression_text(int audio, int video);
  66
  67 // Load and save parameters for a render dialog
  68 // Used by render, record, menueffects, preferences
  69         void load_defaults(BC_Hash *defaults,
  70                 const char *prefix /* = 0 */,
  71                 int do_format /* = 0 */,
  72                 int do_compression,
  73                 int do_path,
  74                 int do_data_types,
  75                 int do_bits);
  76         void save_defaults(BC_Hash *defaults,
  77                 const char *prefix /* = 0 */,
  78                 int do_format,     /* Don't save format which is autodetected by file loader */
  79                 int do_compression,    /* Don't save compression which is fixed by driver */
  80                 int do_path,
  81                 int do_data_types,
  82                 int do_bits);
  83         char* construct_param(const char *param, const char *prefix, char *return_value);
  84
  85
  86
  87
  88 // Executed during index building only
  89         int equivalent(Asset &asset, int test_audio, int test_video, EDL *edl=0);
  90 // Return 1 if the paths match
  91         int test_path(const char *path);
  92         int read(FileXML *file,
  93                 int expand_relative = 1);
  94         int read_audio(FileXML *xml);
  95         int read_video(FileXML *xml);
  96         int read_index(FileXML *xml);
  97         void reset_audio();
  98         void reset_video();
  99
 100 // Output path is the path of the output file if name truncation is desired.
 101 // It is a "" if; complete names should be used.
 102         int write(FileXML *file, int include_index, const char *output_path);
 103
 104 // For Indexable
 105         int get_audio_channels();
 106         int get_sample_rate();
 107         int64_t get_audio_samples();
 108         int have_audio();
 109         int have_video();
 110         int get_w();
 111         int get_h();
 112         double get_frame_rate();
 113         int get_video_layers();
 114         int64_t get_video_frames();
 115         int get_program();
 116         void write_index(char *path, int data_bytes);
 117
 118 // Necessary for renderfarm to get encoding parameters
 119         int write_audio(FileXML *xml);
 120         int write_video(FileXML *xml);
 121         int write_index(FileXML *xml);
 122
 123         double total_length_framealigned(double fps);
 124
 125 // Format of file.  An enumeration from file.inc.
 126         int format;
 127
 128 // contains audio data
 129         int audio_data;
 130         int channels;
 131         int sample_rate;
 132         int bits;
 133         int byte_order;
 134         int signed_;
 135         int header;
 136         int dither;
 137 // String or FourCC describing compression
 138         char acodec[BCTEXTLEN];
 139
 140         int64_t audio_length;
 141
 142 // contains video data, single frame data set
 143         int video_data, single_frame;
 144         int layers, program;
 145         double frame_rate;
 146
 147         int actual_width, actual_height;
 148         int width, height;
 149 // String or FourCC describing compression
 150         char vcodec[BCTEXTLEN];
 151
 152 // Length in frames
 153 // -1 means a still photo
 154         int64_t video_length;
 155
 156
 157
 158 // mp3 compression
 159         int mp3_bitrate;
 160
 161 // mpeg audio information
 162         int ampeg_bitrate;
 163 // 2 - 3
 164         int ampeg_derivative;
 165
 166 // Vorbis compression
 167         int vorbis_min_bitrate;
 168         int vorbis_bitrate;
 169         int vorbis_max_bitrate;
 170         int vorbis_vbr;
 171
 172 // Theora compression
 173         int theora_fix_bitrate;
 174         int theora_bitrate;
 175         int theora_quality;
 176         int theora_sharpness;
 177         int theora_keyframe_frequency;
 178         int theora_keyframe_force_frequency;
 179
 180
 181 // Set by package render during file creation. -1 means square pixels.
 182         double aspect_ratio;
 183
 184 // for the interlace mode
 185         int interlace_autofixoption;
 186         int interlace_mode;
 187         int interlace_fixmethod;
 188 // for jpeg compression
 189         int jpeg_quality;
 190
 191 // for mpeg video compression
 192         int vmpeg_iframe_distance;
 193         int vmpeg_progressive;
 194         int vmpeg_denoise;
 195         int vmpeg_seq_codes;
 196         int vmpeg_bitrate;
 197 // 1 - 2
 198         int vmpeg_derivative;
 199         int vmpeg_quantization;
 200         int vmpeg_cmodel;
 201         int vmpeg_fix_bitrate;
 202
 203 // mjpegtools
 204         int vmpeg_preset;
 205 // top field first
 206         int vmpeg_field_order;
 207         int vmpeg_pframe_distance;
 208
 209 // ffmpeg muxer file extension
 210         char fformat[BCSTRLEN];
 211         char ff_video_options[BCTEXTLEN];
 212         char ff_pixel_format[BCSTRLEN];
 213         int ff_video_bitrate, ff_video_quality;
 214         char ff_audio_options[BCTEXTLEN];
 215         char ff_sample_format[BCSTRLEN];
 216         int ff_audio_bitrate, ff_audio_quality;
 217
 218 // PNG video compression
 219         int png_use_alpha;
 220
 221 // EXR video compression
 222         int exr_use_alpha;
 223         int exr_compression;
 224
 225 // TIFF video compression.  An enumeration from filetiff.h
 226         int tiff_cmodel;
 227         int tiff_compression;
 228
 229         int ac3_bitrate;
 230
 231 // Insert tag for spherical playback
 232         int mov_sphere, jpeg_sphere;
 233
 234 // Image file sequences.  Background rendering doesn't want to write a
 235 // sequence header but instead wants to start the sequence numbering at a certain
 236 // number.  This ensures deletion of all the frames which aren't being used.
 237 // We still want sequence headers sometimes because loading a directory full of images
 238 // for editing would create new assets for every image.
 239         int use_header;
 240 };
 241
 242
 243 #endif