Credit Andrew - fix vorbis audio which was scratchy and ensure aging plugin does...
[goodguy/cinelerra.git] / cinelerra-5.1 / cinelerra / file.C
index 1fec188eacb98570229d46acda6e27cc19322cfd..90ad489f76a3307314789cab03035426f4d6e374 100644 (file)
@@ -1,6 +1,7 @@
 /*
  * CINELERRA
  * Copyright (C) 2010 Adam Williams <broadcast at earthling dot net>
+ * Copyright (C) 2003-2016 Cinelerra CV contributors
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -26,6 +27,7 @@
 #include <stdarg.h>
 #include <ctype.h>
 #include <limits.h>
+#include <time.h>
 // work arounds (centos)
 #include <lzma.h>
 #ifndef INT64_MAX
@@ -44,6 +46,7 @@
 #include "filecr2.h"
 #include "filedb.h"
 #include "filedv.h"
+#include "filedpx.h"
 #include "fileexr.h"
 #include "fileffmpeg.h"
 #include "fileflac.h"
@@ -52,6 +55,7 @@
 #include "filejpeg.h"
 #include "filempeg.h"
 #undef HAVE_STDLIB_H // automake conflict
+#include "fileogg.h"
 #include "filepng.h"
 #include "fileppm.h"
 #include "fileref.h"
@@ -60,6 +64,7 @@
 #include "filetga.h"
 #include "filethread.h"
 #include "filetiff.h"
+#include "filevorbis.h"
 #include "filexml.h"
 #include "formatwindow.h"
 #include "formattools.h"
 #include "samples.h"
 #include "vframe.h"
 
+#ifdef HAVE_OGG
+//suppress noref warning
+void *vorbis0_ov_callbacks[] = {
+ &OV_CALLBACKS_DEFAULT, &OV_CALLBACKS_NOCLOSE,
+ &OV_CALLBACKS_STREAMONLY, &OV_CALLBACKS_STREAMONLY_NOCLOSE,
+};
+#endif
+
 File::File()
 {
        cpus = 1;
@@ -94,7 +107,6 @@ File::~File()
        }
 
        if( temp_frame ) {
-//printf("File::~File %d temp_debug=%d\n", __LINE__, --temp_debug);
                delete temp_frame;
        }
 
@@ -164,10 +176,12 @@ int File::get_options(FormatTools *format,
        format_completion->lock("File::get_options");
        switch( asset->format ) {
 #ifdef HAVE_CIN_3RDPARTY
+#ifdef HAVE_LIBZMPEG
        case FILE_AC3: FileAC3::get_parameters(parent_window, asset, format_window,
                        audio_options, video_options, edl);
                break;
 #endif
+#endif
 #ifdef HAVE_DV
        case FILE_RAWDV:
                FileDV::get_parameters(parent_window, asset, format_window,
@@ -198,6 +212,13 @@ int File::get_options(FormatTools *format,
                FileJPEG::get_parameters(parent_window, asset, format_window,
                        audio_options, video_options, edl);
                break;
+#ifdef HAVE_LIBDPX
+       case FILE_DPX:
+       case FILE_DPX_LIST:
+               FileDPX::get_parameters(parent_window, asset, format_window,
+                       audio_options, video_options, edl);
+               break;
+#endif
 #ifdef HAVE_OPENEXR
        case FILE_EXR:
        case FILE_EXR_LIST:
@@ -229,6 +250,16 @@ int File::get_options(FormatTools *format,
                FileTIFF::get_parameters(parent_window, asset, format_window,
                        audio_options, video_options, edl);
                break;
+#ifdef HAVE_OGG
+       case FILE_OGG:
+               FileOGG::get_parameters(parent_window, asset, format_window,
+                       audio_options, video_options, edl);
+               break;
+       case FILE_VORBIS:
+               FileVorbis::get_parameters(parent_window, asset, format_window,
+                       audio_options, video_options, edl);
+               break;
+#endif
        default:
                break;
        }
@@ -260,6 +291,7 @@ int File::can_scale_input(Asset *asset)
        case FILE_MPEG:
        case FILE_FFMPEG:
                return 1;
+       case FILE_DPX:
        case FILE_EXR:
        case FILE_JPEG:
        case FILE_PNG:
@@ -329,6 +361,24 @@ int File::delete_oldest()
        return frame_cache->delete_oldest();
 }
 
+int File::get_cache_frame(VFrame *frame, int64_t position)
+{
+       return frame_cache->get_cache_frame(frame, position,
+               current_layer, asset->frame_rate);
+}
+
+void File::put_cache_frame(VFrame *frame, int64_t position, int use_copy)
+{
+       frame_cache->put_cache_frame(frame,
+               position, current_layer, asset->frame_rate, use_copy);
+}
+
+int File::get_use_cache()
+{
+       return use_cache;
+}
+
+
 // file driver in order of probe precidence
 //  can be reordered in preferences->interface
 const char *File::default_probes[] = { 
@@ -342,7 +392,12 @@ const char *File::default_probes[] = {
        "PNG",
        "PPM",
        "JPEG",
+#ifdef HAVE_GIFLIB
        "GIF",
+#endif
+#ifdef HAVE_LIBDPX
+       "DPX",
+#endif
 #ifdef HAVE_OPENEXR
        "EXR",
 #endif
@@ -350,9 +405,15 @@ const char *File::default_probes[] = {
        "CR2",
        "TGA",
        "TIFF",
+#ifdef HAVE_OGG
+       "OGG",
+       "Vorbis",
+#endif
+#ifdef HAVE_LIBZMPEG
        "MPEG",
+#endif
        "EDL",
-               "FFMPEG_Late", 
+       "FFMPEG_Late",
 }; 
 const int File::nb_probes =
        sizeof(File::default_probes)/sizeof(File::default_probes[0]); 
@@ -415,6 +476,7 @@ int File::probe()
                        file = new FileJPEG(this->asset, this);
                        return FILE_OK;
                }
+#ifdef HAVE_GIFLIB
                if( !strcmp(pref->name,"GIF") ) { // GIF file
                        if( FileGIFList::check_sig(this->asset) )
                                file = new FileGIFList(this->asset, this);
@@ -423,6 +485,14 @@ int File::probe()
                        else continue;
                        return FILE_OK;
                }
+#endif
+#ifdef HAVE_LIBDPX
+               if( !strcmp(pref->name,"DPX") ) { // DPX file
+                       if( !FileDPX::check_sig(this->asset, data) ) continue;
+                       file = new FileDPX(this->asset, this);
+                       return FILE_OK;
+               }
+#endif
 #ifdef HAVE_OPENEXR
                if( !strcmp(pref->name,"EXR") ) { // EXR file
                        if( !FileEXR::check_sig(this->asset, data)) continue;
@@ -450,6 +520,18 @@ int File::probe()
                        file = new FileTIFF(this->asset, this);
                        return FILE_OK;
                }
+#ifdef HAVE_OGG
+               if( !strcmp(pref->name,"OGG") ) { // OGG file
+                       if( !FileOGG::check_sig(this->asset) ) continue;
+                       file = new FileOGG(this->asset, this);
+                       return FILE_OK;
+               }
+               if( !strcmp(pref->name,"Vorbis") ) { // VorbisFile file
+                       if( !FileVorbis::check_sig(this->asset) ) continue;
+                       file = new FileVorbis(this->asset, this);
+                       return FILE_OK;
+               }
+#endif
 #ifdef HAVE_LIBZMPEG
                if( !strcmp(pref->name,"MPEG") ) { // MPEG file
                        if( !FileMPEG::check_sig(this->asset) ) continue;
@@ -493,9 +575,11 @@ int File::open_file(Preferences *preferences,
                break; }
 // format already determined
 #ifdef HAVE_CIN_3RDPARTY
+#ifdef HAVE_LIBZMPEG
        case FILE_AC3:
                file = new FileAC3(this->asset, this);
                break;
+#endif
 #endif
        case FILE_SCENE:
                file = new FileScene(this->asset, this);
@@ -528,20 +612,27 @@ int File::open_file(Preferences *preferences,
        case FILE_JPEG_LIST:
                file = new FileJPEG(this->asset, this);
                break;
-
+#ifdef HAVE_GIFLIB
        case FILE_GIF:
                file = new FileGIF(this->asset, this);
                break;
        case FILE_GIF_LIST:
                file = new FileGIFList(this->asset, this);
                break;
-
+#endif
+#ifdef HAVE_LIBDPX
+       case FILE_DPX:
+       case FILE_DPX_LIST:
+               file = new FileDPX(this->asset, this);
+               break;
+#endif
 #ifdef HAVE_OPENEXR
        case FILE_EXR:
        case FILE_EXR_LIST:
                file = new FileEXR(this->asset, this);
                break;
 #endif
+
        case FILE_FLAC:
                file = new FileFLAC(this->asset, this);
                break;
@@ -573,6 +664,15 @@ int File::open_file(Preferences *preferences,
                file = new FileMPEG(this->asset, this);
                break;
 #endif
+#ifdef HAVE_OGG
+       case FILE_OGG:
+               file = new FileOGG(this->asset, this);
+               break;
+
+       case FILE_VORBIS:
+               file = new FileVorbis(this->asset, this);
+               break;
+#endif
 #ifdef HAVE_DV
        case FILE_RAWDV:
                file = new FileDV(this->asset, this);
@@ -595,6 +695,17 @@ int File::open_file(Preferences *preferences,
        }
 
 
+// If file type is a list verify that all files match in dimensions.
+// Should be done only after the file open function has been performed
+// Reason: although this function checks if file exists or not but
+// it has no way of relaying this information back and if this function
+// is called before open_file the program may accidently interpret file
+// not found as file size don't match
+ if( !file->verify_file_list() ) {
+  delete file;  file = 0;
+  return FILE_SIZE_DONT_MATCH;
+ }
+
 
 // Set extra writing parameters to mandatory settings.
        if( wr ) {
@@ -1109,52 +1220,52 @@ int File::read_frame(VFrame *frame, int is_thread)
        if( debug ) PRINT_TRACE
        int result = 0;
        int supported_colormodel = colormodel_supported(frame->get_color_model());
-       int advance_position = 1;
-       int cache_active = use_cache || asset->single_frame ? 1 : 0;
+       int do_read = 1;
+// if reverse playback reading, use_cache is -1
+       int cache_active = asset->single_frame ? 1 : use_cache;
        int64_t cache_position = !asset->single_frame ? current_frame : -1;
 
 // Test cache
-       if( cache_active && frame_cache->get_frame(frame, cache_position,
-                       current_layer, asset->frame_rate) ) {
-// Can't advance position if cache used.
-//printf("File::read_frame %d\n", __LINE__);
-               advance_position = 0;
+       if( cache_active ) {
+               if( get_cache_frame(frame, cache_position) ) {
+                       do_read = 0;
+               }
+               else if( cache_active < 0 && frame_cache->cache_items() > 0 ) {
+// reverse reading and cache miss, clear cache for new readahead
+                       purge_cache();
+               }
        }
-// Need temp
-       else if( frame->get_color_model() != BC_COMPRESSED &&
-               (supported_colormodel != frame->get_color_model() ||
-               (!file->can_scale_input() &&
-                       (frame->get_w() != asset->width ||
-                        frame->get_h() != asset->height))) ) {
-
-//                     printf("File::read_frame %d\n", __LINE__);
-// Can't advance position here because it needs to be added to cache
-               if( temp_frame ) {
-                       if( !temp_frame->params_match(asset->width, asset->height, supported_colormodel) ) {
-                               delete temp_frame;
-                               temp_frame = 0;
+// Need to read
+       if( do_read ) {
+               VFrame *vframe = frame;
+               if( frame->get_color_model() != BC_COMPRESSED &&
+                   (supported_colormodel != frame->get_color_model() ||
+                       (!file->can_scale_input() &&
+                               (frame->get_w() != asset->width ||
+                                frame->get_h() != asset->height))) ) {
+                       if( temp_frame ) {
+                               if( !temp_frame->params_match(asset->width, asset->height,
+                                               supported_colormodel) ) {
+                                       delete temp_frame;  temp_frame = 0;
+                               }
+                       }
+                       if( !temp_frame ) {
+                               temp_frame = new VFrame(asset->width, asset->height,
+                                               supported_colormodel, 0);
+                               temp_frame->clear_frame();
                        }
-               }
 
-               if( !temp_frame ) {
-                       temp_frame = new VFrame(asset->width, asset->height, supported_colormodel, 0);
-                       temp_frame->clear_frame();
+                       temp_frame->copy_stacks(frame);
+                       vframe = temp_frame;
                }
-
-//                     printf("File::read_frame %d\n", __LINE__);
-               temp_frame->copy_stacks(frame);
-               result = file->read_frame(temp_frame);
-               if( !result )
-                       frame->transfer_from(temp_frame);
-               else if( result && frame->get_status() > 0 )
-                       frame->set_status(-1);
-//printf("File::read_frame %d\n", __LINE__);
-       }
-       else {
-// Can't advance position here because it needs to be added to cache
-//printf("File::read_frame %d\n", __LINE__);
-               result = file->read_frame(frame);
-               if( result && frame->get_status() > 0 )
+               result = file->read_frame(vframe);
+               if( !result ) {
+                       if( frame != vframe )
+                               frame->transfer_from(vframe);
+                       if( cache_active > 0 )
+                               put_cache_frame(frame, cache_position, 1);
+               }
+               else if( frame->get_status() > 0 )
                        frame->set_status(-1);
 //for( int i = 0; i < 100 * 1000; i++ ) ((float*)frame->get_rows()[0])[i] = 1.0;
        }
@@ -1162,12 +1273,9 @@ int File::read_frame(VFrame *frame, int is_thread)
        if( result && !current_frame )
                frame->clear_frame();
 
-       if( cache_active && advance_position && frame->get_status() > 0 )
-               frame_cache->put_frame(frame, cache_position,
-                       current_layer, asset->frame_rate, 1, 0);
 //printf("File::read_frame %d\n", __LINE__);
 
-       if( advance_position ) current_frame++;
+       if( do_read ) current_frame++;
        if( debug ) PRINT_TRACE
        return 0;
 }
@@ -1202,6 +1310,8 @@ int File::strtoformat(const char *format)
        if( !strcasecmp(format, _(TIFF_LIST_NAME)) ) return FILE_TIFF_LIST;
        if( !strcasecmp(format, _(JPEG_NAME)) ) return FILE_JPEG;
        if( !strcasecmp(format, _(JPEG_LIST_NAME)) ) return FILE_JPEG_LIST;
+       if( !strcasecmp(format, _(DPX_NAME)) ) return FILE_DPX;
+       if( !strcasecmp(format, _(DPX_LIST_NAME)) ) return FILE_DPX_LIST;
        if( !strcasecmp(format, _(EXR_NAME)) ) return FILE_EXR;
        if( !strcasecmp(format, _(EXR_LIST_NAME)) ) return FILE_EXR_LIST;
        if( !strcasecmp(format, _(FLAC_NAME)) ) return FILE_FLAC;
@@ -1214,6 +1324,8 @@ int File::strtoformat(const char *format)
        if( !strcasecmp(format, _(VMPEG_NAME)) ) return FILE_VMPEG;
        if( !strcasecmp(format, _(TGA_NAME)) ) return FILE_TGA;
        if( !strcasecmp(format, _(TGA_LIST_NAME)) ) return FILE_TGA_LIST;
+       if( !strcasecmp(format, _(OGG_NAME)) ) return FILE_OGG;
+       if( !strcasecmp(format, _(VORBIS_NAME)) ) return FILE_VORBIS;
        if( !strcasecmp(format, _(RAWDV_NAME)) ) return FILE_RAWDV;
        if( !strcasecmp(format, _(FFMPEG_NAME)) ) return FILE_FFMPEG;
        if( !strcasecmp(format, _(DBASE_NAME)) ) return FILE_DB;
@@ -1244,6 +1356,8 @@ const char* File::formattostr(int format)
        case FILE_FLAC:         return _(FLAC_NAME);
        case FILE_GIF:          return _(GIF_NAME);
        case FILE_GIF_LIST:     return _(GIF_LIST_NAME);
+       case FILE_DPX:          return _(DPX_NAME);
+       case FILE_DPX_LIST:     return _(DPX_LIST_NAME);
        case FILE_EXR:          return _(EXR_NAME);
        case FILE_EXR_LIST:     return _(EXR_LIST_NAME);
 #ifdef HAVE_LIBZMPEG
@@ -1255,6 +1369,10 @@ const char* File::formattostr(int format)
        case FILE_TGA_LIST:     return _(TGA_LIST_NAME);
        case FILE_TIFF:         return _(TIFF_NAME);
        case FILE_TIFF_LIST:    return _(TIFF_LIST_NAME);
+#ifdef HAVE_OGG
+       case FILE_OGG:          return _(OGG_NAME);
+       case FILE_VORBIS:       return _(VORBIS_NAME);
+#endif
        case FILE_RAWDV:        return _(RAWDV_NAME);
        case FILE_FFMPEG:       return _(FFMPEG_NAME);
        case FILE_DB:           return _(DBASE_NAME);
@@ -1334,6 +1452,10 @@ int File::get_best_colormodel(Asset *asset, int driver)
 #endif
        case FILE_JPEG:
        case FILE_JPEG_LIST:    return FileJPEG::get_best_colormodel(asset, driver);
+#ifdef HAVE_LIBDPX
+       case FILE_DPX:
+       case FILE_DPX_LIST:     return FileDPX::get_best_colormodel(asset, driver);     
+#endif
 #ifdef HAVE_OPENEXR
        case FILE_EXR:
        case FILE_EXR_LIST:     return FileEXR::get_best_colormodel(asset, driver);
@@ -1388,6 +1510,7 @@ int64_t File::get_memory_usage()
 int File::renders_video(int format)
 {
        switch( format ) {
+       case FILE_OGG:
        case FILE_JPEG:
        case FILE_JPEG_LIST:
        case FILE_CR2:
@@ -1425,6 +1548,8 @@ int File::renders_audio(int format)
        case FILE_FLAC:
        case FILE_PCM:
        case FILE_WAV:
+       case FILE_OGG:
+       case FILE_VORBIS:
        case FILE_AMPEG:
        case FILE_AU:
        case FILE_AIFF:
@@ -1466,11 +1591,14 @@ const char* File::get_tag(int format)
        case FILE_AU:           return "au";
        case FILE_RAWDV:        return "dv";
        case FILE_DB:           return "db";
+       case FILE_DPX:          return "dpx";
        case FILE_EXR:          return "exr";
+       case FILE_DPX_LIST:     return "dpxs";
        case FILE_EXR_LIST:     return "exrs";
        case FILE_FLAC:         return "flac";
        case FILE_JPEG:         return "jpg";
        case FILE_JPEG_LIST:    return "jpgs";
+       case FILE_OGG:          return "ogg";
        case FILE_GIF:          return "gif";
        case FILE_GIF_LIST:     return "gifs";
        case FILE_PCM:          return "pcm";
@@ -1483,6 +1611,7 @@ const char* File::get_tag(int format)
        case FILE_TIFF:         return "tif";
        case FILE_TIFF_LIST:    return "tifs";
        case FILE_VMPEG:        return "m2v";
+       case FILE_VORBIS:       return "ogg";
        case FILE_WAV:          return "wav";
        case FILE_FFMPEG:       return "ffmpg";
        case FILE_REF:          return "ref";
@@ -1514,9 +1643,13 @@ const char* File::get_prefix(int format)
        case FILE_PNG_LIST:     return "PNG_LIST";
        case FILE_PPM_LIST:     return "PPM_LIST";
        case FILE_AC3:          return "AC3";
+       case FILE_DPX:          return "DPX";
+       case FILE_DPX_LIST:     return "DPX_LIST";
        case FILE_EXR:          return "EXR";
        case FILE_EXR_LIST:     return "EXR_LIST";
        case FILE_CR2:          return "CR2";
+       case FILE_OGG:          return "OGG";
+       case FILE_VORBIS:       return "VORBIS";
        case FILE_FLAC:         return "FLAC";
        case FILE_FFMPEG:       return "FFMPEG";
        case FILE_SCENE:        return "SCENE";
@@ -1529,13 +1662,6 @@ const char* File::get_prefix(int format)
 }
 
 
-PackagingEngine *File::new_packaging_engine(Asset *asset)
-{
-       PackagingEngine *result = (PackagingEngine*) new PackagingEngineDefault();
-       return result;
-}
-
-
 int File::record_fd()
 {
        return file ? file->record_fd() : -1;
@@ -1545,7 +1671,14 @@ int File::record_fd()
 void File::get_exe_path(char *result, char *bnp)
 {
 // Get executable path, basename
+#if !defined(__FreeBSD__)
        int len = readlink("/proc/self/exe", result, BCTEXTLEN-1);
+#else
+       char exe_path[BCTEXTLEN];
+       sprintf(exe_path,"/proc/%d/file",getpid());
+       int len = readlink(exe_path, result, BCTEXTLEN-1);
+#endif
+
        if( len >= 0 ) {
                result[len] = 0;
                char *ptr = strrchr(result, '/');
@@ -1588,11 +1721,15 @@ void File::setenv_path(const char *var, const char *path, int overwrite)
        getenv_path(env_path, path);
        setenv(var, env_path, overwrite);
 }
-
-void File::init_cin_path()
+/**
+* @brief Set various environment variables to pass constant values to
+*        forks, shell scripts, and other parts of CinGG.
+*/
+void File::init_cin_env_vars()
 {
-       char env_path[BCTEXTLEN], env_pkg[BCTEXTLEN];
-// these values are advertised for forks/shell scripts
+       char env_path[BCTEXTLEN], env_pkg[BCTEXTLEN], build_name[32], dateTimeText[32];
+       struct stat st;
+       struct tm *dateTime;
        get_exe_path(env_path, env_pkg);
        setenv_path("CIN_PATH", env_path, 1);
        setenv_path("CIN_PKG", env_pkg, 1);
@@ -1603,5 +1740,12 @@ void File::init_cin_path()
        setenv_path("CIN_LADSPA", LADSPA_DIR, 0);
        setenv_path("CIN_LOCALE", LOCALE_DIR, 0);
        setenv_path("CIN_BROWSER", CIN_BROWSER, 0);
+// Create env_var CINGG_BUILD for use when running as AppImage
+       stat(env_path, &st);
+       dateTime = gmtime(&st.st_mtime);
+       strftime(dateTimeText, sizeof(dateTimeText), "%Y%m%d_%H%M%S", dateTime);
+    snprintf(build_name, sizeof(build_name), "CINGG_%s", dateTimeText);
+       build_name[sizeof(build_name) - 1] = 0;
+       setenv_path("CINGG_BUILD", build_name, 1);
 }