1fc58c0b28b99260926f7a75ab2a7f6da444feff
[goodguy/history.git] / cinelerra-5.1 / cinelerra / filebase.h
1
2 /*
3  * CINELERRA
4  * Copyright (C) 2008 Adam Williams <broadcast at earthling dot net>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  */
21
22 #ifndef FILEBASE_H
23 #define FILEBASE_H
24
25 #include "asset.inc"
26 #include "assets.inc"
27 #include "bccmodels.h"
28 #include "edit.inc"
29 #include "ffmpeg.inc"
30 #include "guicast.h"
31 #include "file.inc"
32 #include "filelist.inc"
33 #include "indexfile.inc"
34 #include "mainprogress.inc"
35 #include "overlayframe.inc"
36 #include "strategies.inc"
37 #include "vframe.inc"
38
39 #include <sys/types.h>
40
41 // Number of samples saved before the current read position
42 #define HISTORY_MAX 0x10000
43
44 // inherited by every file interpreter
45 class FileBase
46 {
47 public:
48         FileBase(Asset *asset, File *file);
49         virtual ~FileBase();
50
51
52         friend class File;
53         friend class FFMPEG;
54         friend class FileList;
55         friend class FrameWriter;
56
57
58
59
60         void get_mode(char *mode, int rd, int wr);
61         void reset_parameters();
62
63
64
65         virtual void get_parameters(BC_WindowBase *parent_window,
66                         Asset *asset,
67                         BC_WindowBase **format_window,
68                         int audio_options,
69                         int video_options,
70                         int lock_compressor) {};
71
72
73
74         virtual int get_index(IndexFile *index_file, MainProgressBar *progress_bar) { return -1; }
75         virtual int check_header() { return 0; }  // Test file to see if it is of this type.
76         virtual int reset_parameters_derived() { return 0; }
77         virtual int read_header() { return 1; }   // WAV files for getting header
78         virtual int open_file(int rd, int wr) { return 1; }
79         virtual int close_file();
80         virtual int close_file_derived() { return 0; }
81         int set_dither();
82         virtual int seek_end() { return 0; }
83         virtual int seek_start() { return 0; }
84         virtual int64_t get_video_position() { return 0; }
85         virtual int64_t get_audio_position() { return 0; }
86         virtual int set_video_position(int64_t x) { return 0; }
87         virtual int set_audio_position(int64_t x) { return 0; }
88         virtual int set_subtitle(int value) { return -1; }
89         virtual int select_video_stream(Asset *asset, int vstream) { return -1; }
90         virtual int select_audio_stream(Asset *asset, int astream) { return -1; }
91         virtual int set_program(int no) { return -1; }
92         virtual int get_cell_time(int no, double &time) { time = -1.; return 1; }
93         virtual int get_system_time(int64_t &tm) { tm = -1; return 1; }
94         virtual int get_audio_for_video(int vstream, int astream, int64_t &channel_mask) {
95                  channel_mask = 0;  return -1;
96         }
97         virtual int get_video_pid(int track) { return -1; }
98         virtual int get_video_info(int track, int &pid, double &framerate,
99                 int &width, int &height, char *title=0) { return -1; }
100
101         virtual int get_thumbnail(int stream, int64_t &position,
102                 unsigned char *&thumbnail, int &ww, int &hh) { return -1; }
103         virtual int set_skimming(int track, int skim, skim_fn fn, void *vp) { return -1; }
104         virtual int skim_video(int track, void *vp, skim_fn fn) { return -1; }
105
106 // Subclass should call this to add the base class allocation.
107 // Only used in read mode.
108         virtual int64_t base_memory_usage();
109
110         virtual int write_samples(double **buffer,
111                 int64_t len) { return 0; }
112         virtual int write_frames(VFrame ***frames, int len) { return 0; }
113         virtual int read_compressed_frame(VFrame *buffer) { return 0; }
114         virtual int write_compressed_frame(VFrame *buffers) { return 0; }
115         virtual int64_t compressed_frame_size() { return 0; }
116 // Doubles are used to allow resampling
117         virtual int read_samples(double *buffer, int64_t len) { return 0; }
118         virtual int read_frame(VFrame *frame) { return 1; }
119 // get dvb record stream file descriptor
120         virtual int record_fd() { return -1; }
121
122         virtual int prefer_samples_float() { return 0; }
123         virtual int read_samples_float(float *buffer, int64_t len) { return 0; }
124
125 // Return either the argument or another colormodel which read_frame should
126 // use.
127         virtual int colormodel_supported(int colormodel) { return BC_RGB888; }
128 // This file can copy compressed frames directly from the asset
129         virtual int can_copy_from(Asset *asset, int64_t position) { return 0; }
130         virtual int can_scale_input() { return 0; }
131         virtual int get_render_strategy(ArrayList<int>* render_strategies) { return VRENDER_VPIXEL; }
132
133 // Manages an audio history buffer
134         void update_pcm_history(int64_t len);
135 // Returns history_start + history_size
136         int64_t get_history_sample();
137 // contiguous float
138         void append_history(float **new_data, int len);
139 // Interleaved short
140         void append_history(short *new_data, int len);
141         void read_history(double *dst,
142                 int64_t start_sample,
143                 int channel,
144                 int64_t len);
145         void allocate_history(int len);
146
147 // For static functions to access it
148         Asset *asset;
149         int rd, wr;
150
151 protected:
152 // Return 1 if the render_strategy is present on the list.
153         static int search_render_strategies(ArrayList<int>* render_strategies, int render_strategy);
154
155 // convert samples into file format
156         int64_t samples_to_raw(char *out_buffer,
157                                                         float **in_buffer, // was **buffer
158                                                         int64_t input_len,
159                                                         int bits,
160                                                         int channels,
161                                                         int byte_order,
162                                                         int signed_);
163
164 // overwrites the buffer from PCM data depending on feather.
165         int raw_to_samples(float *out_buffer, char *in_buffer,
166                 int64_t samples, int bits, int channels, int channel, int feather,
167                 float lfeather_len, float lfeather_gain, float lfeather_slope);
168
169 // Overwrite the buffer from float data using feather.
170         int overlay_float_buffer(float *out_buffer, float *in_buffer,
171                 int64_t samples,
172                 float lfeather_len, float lfeather_gain, float lfeather_slope);
173
174 // convert a frame to and from file format
175
176         int64_t frame_to_raw(unsigned char *out_buffer,
177                                         VFrame *in_frame,
178                                         int w,
179                                         int h,
180                                         int use_alpha,
181                                         int use_float,
182                                         int color_model);
183
184 // allocate a buffer for translating int to float
185         int get_audio_buffer(char **buffer, int64_t len, int64_t bits, int64_t channels); // audio
186
187 // Allocate a buffer for feathering floats
188         int get_float_buffer(float **buffer, int64_t len);
189
190 // allocate a buffer for translating video to VFrame
191         int get_video_buffer(unsigned char **buffer, int depth); // video
192         int get_row_pointers(unsigned char *buffer, unsigned char ***pointers, int depth);
193         static int match4(const char *in, const char *out);   // match 4 bytes for a fourcc type
194
195         float *float_buffer;          // for floating point feathering
196         unsigned char **row_pointers_in, **row_pointers_out;
197         int64_t prev_buffer_position;  // for audio determines if reading raw data is necessary
198         int64_t prev_frame_position;   // for video determines if reading raw video data is necessary
199         int64_t prev_bytes; // determines if new raw buffer is needed and used for getting memory usage
200         int64_t prev_len;
201         int prev_track;
202         int prev_layer;
203         int dither;
204         int internal_byte_order;
205         File *file;
206
207 // ================================= Audio compression
208         double **pcm_history;
209         int64_t history_allocated;
210         int64_t history_size;
211         int64_t history_start;
212         int history_channels;
213 // Range to decode to fill history buffer.  Maintained by FileBase.
214         int64_t decode_start;
215         int64_t decode_len;
216 // End of last decoded sample.  Maintained by user for seeking.
217         int64_t decode_end;
218
219 private:
220 // ULAW
221         float ulawtofloat(char ulaw);
222         char floattoulaw(float value);
223         int generate_ulaw_tables();
224         int delete_ulaw_tables();
225         float *ulawtofloat_table, *ulawtofloat_ptr;
226         unsigned char *floattoulaw_table, *floattoulaw_ptr;
227 };
228
229 #endif