OpenShot Library | libopenshot  0.4.0
FFmpegReader.cpp
Go to the documentation of this file.
1 
12 // Copyright (c) 2008-2024 OpenShot Studios, LLC, Fabrice Bellard
13 //
14 // SPDX-License-Identifier: LGPL-3.0-or-later
15 
16 #include <thread> // for std::this_thread::sleep_for
17 #include <chrono> // for std::chrono::milliseconds
18 #include <unistd.h>
19 
20 #include "FFmpegUtilities.h"
21 
22 #include "FFmpegReader.h"
23 #include "Exceptions.h"
24 #include "Timeline.h"
25 #include "ZmqLogger.h"
26 
27 #define ENABLE_VAAPI 0
28 
29 #if USE_HW_ACCEL
30 #define MAX_SUPPORTED_WIDTH 1950
31 #define MAX_SUPPORTED_HEIGHT 1100
32 
33 #if ENABLE_VAAPI
34 #include "libavutil/hwcontext_vaapi.h"
35 
36 typedef struct VAAPIDecodeContext {
37  VAProfile va_profile;
38  VAEntrypoint va_entrypoint;
39  VAConfigID va_config;
40  VAContextID va_context;
41 
42 #if FF_API_STRUCT_VAAPI_CONTEXT
43  // FF_DISABLE_DEPRECATION_WARNINGS
44  int have_old_context;
45  struct vaapi_context *old_context;
46  AVBufferRef *device_ref;
47  // FF_ENABLE_DEPRECATION_WARNINGS
48 #endif
49 
50  AVHWDeviceContext *device;
51  AVVAAPIDeviceContext *hwctx;
52 
53  AVHWFramesContext *frames;
54  AVVAAPIFramesContext *hwfc;
55 
56  enum AVPixelFormat surface_format;
57  int surface_count;
58  } VAAPIDecodeContext;
59 #endif // ENABLE_VAAPI
60 #endif // USE_HW_ACCEL
61 
62 
63 using namespace openshot;
64 
65 int hw_de_on = 0;
66 #if USE_HW_ACCEL
67  AVPixelFormat hw_de_av_pix_fmt_global = AV_PIX_FMT_NONE;
68  AVHWDeviceType hw_de_av_device_type_global = AV_HWDEVICE_TYPE_NONE;
69 #endif
70 
71 FFmpegReader::FFmpegReader(const std::string &path, bool inspect_reader)
72  : last_frame(0), is_seeking(0), seeking_pts(0), seeking_frame(0), seek_count(0), NO_PTS_OFFSET(-99999),
73  path(path), is_video_seek(true), check_interlace(false), check_fps(false), enable_seek(true), is_open(false),
74  seek_audio_frame_found(0), seek_video_frame_found(0),is_duration_known(false), largest_frame_processed(0),
75  current_video_frame(0), packet(NULL), max_concurrent_frames(OPEN_MP_NUM_PROCESSORS), audio_pts(0),
76  video_pts(0), pFormatCtx(NULL), videoStream(-1), audioStream(-1), pCodecCtx(NULL), aCodecCtx(NULL),
77  pStream(NULL), aStream(NULL), pFrame(NULL), previous_packet_location{-1,0},
78  hold_packet(false) {
79 
80  // Initialize FFMpeg, and register all formats and codecs
83 
84  // Init timestamp offsets
85  pts_offset_seconds = NO_PTS_OFFSET;
86  video_pts_seconds = NO_PTS_OFFSET;
87  audio_pts_seconds = NO_PTS_OFFSET;
88 
89  // Init cache
90  working_cache.SetMaxBytesFromInfo(max_concurrent_frames * info.fps.ToDouble() * 2, info.width, info.height, info.sample_rate, info.channels);
91  final_cache.SetMaxBytesFromInfo(max_concurrent_frames * 2, info.width, info.height, info.sample_rate, info.channels);
92 
93  // Open and Close the reader, to populate its attributes (such as height, width, etc...)
94  if (inspect_reader) {
95  Open();
96  Close();
97  }
98 }
99 
101  if (is_open)
102  // Auto close reader if not already done
103  Close();
104 }
105 
106 // This struct holds the associated video frame and starting sample # for an audio packet.
107 bool AudioLocation::is_near(AudioLocation location, int samples_per_frame, int64_t amount) {
108  // Is frame even close to this one?
109  if (abs(location.frame - frame) >= 2)
110  // This is too far away to be considered
111  return false;
112 
113  // Note that samples_per_frame can vary slightly frame to frame when the
114  // audio sampling rate is not an integer multiple of the video fps.
115  int64_t diff = samples_per_frame * (location.frame - frame) + location.sample_start - sample_start;
116  if (abs(diff) <= amount)
117  // close
118  return true;
119 
120  // not close
121  return false;
122 }
123 
124 #if USE_HW_ACCEL
125 
126 // Get hardware pix format
127 static enum AVPixelFormat get_hw_dec_format(AVCodecContext *ctx, const enum AVPixelFormat *pix_fmts)
128 {
129  const enum AVPixelFormat *p;
130 
131  for (p = pix_fmts; *p != AV_PIX_FMT_NONE; p++) {
132  switch (*p) {
133 #if defined(__linux__)
134  // Linux pix formats
135  case AV_PIX_FMT_VAAPI:
136  hw_de_av_pix_fmt_global = AV_PIX_FMT_VAAPI;
137  hw_de_av_device_type_global = AV_HWDEVICE_TYPE_VAAPI;
138  return *p;
139  break;
140  case AV_PIX_FMT_VDPAU:
141  hw_de_av_pix_fmt_global = AV_PIX_FMT_VDPAU;
142  hw_de_av_device_type_global = AV_HWDEVICE_TYPE_VDPAU;
143  return *p;
144  break;
145 #endif
146 #if defined(_WIN32)
147  // Windows pix formats
148  case AV_PIX_FMT_DXVA2_VLD:
149  hw_de_av_pix_fmt_global = AV_PIX_FMT_DXVA2_VLD;
150  hw_de_av_device_type_global = AV_HWDEVICE_TYPE_DXVA2;
151  return *p;
152  break;
153  case AV_PIX_FMT_D3D11:
154  hw_de_av_pix_fmt_global = AV_PIX_FMT_D3D11;
155  hw_de_av_device_type_global = AV_HWDEVICE_TYPE_D3D11VA;
156  return *p;
157  break;
158 #endif
159 #if defined(__APPLE__)
160  // Apple pix formats
161  case AV_PIX_FMT_VIDEOTOOLBOX:
162  hw_de_av_pix_fmt_global = AV_PIX_FMT_VIDEOTOOLBOX;
163  hw_de_av_device_type_global = AV_HWDEVICE_TYPE_VIDEOTOOLBOX;
164  return *p;
165  break;
166 #endif
167  // Cross-platform pix formats
168  case AV_PIX_FMT_CUDA:
169  hw_de_av_pix_fmt_global = AV_PIX_FMT_CUDA;
170  hw_de_av_device_type_global = AV_HWDEVICE_TYPE_CUDA;
171  return *p;
172  break;
173  case AV_PIX_FMT_QSV:
174  hw_de_av_pix_fmt_global = AV_PIX_FMT_QSV;
175  hw_de_av_device_type_global = AV_HWDEVICE_TYPE_QSV;
176  return *p;
177  break;
178  default:
179  // This is only here to silence unused-enum warnings
180  break;
181  }
182  }
183  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::get_hw_dec_format (Unable to decode this file using hardware decode)");
184  return AV_PIX_FMT_NONE;
185 }
186 
187 int FFmpegReader::IsHardwareDecodeSupported(int codecid)
188 {
189  int ret;
190  switch (codecid) {
191  case AV_CODEC_ID_H264:
192  case AV_CODEC_ID_MPEG2VIDEO:
193  case AV_CODEC_ID_VC1:
194  case AV_CODEC_ID_WMV1:
195  case AV_CODEC_ID_WMV2:
196  case AV_CODEC_ID_WMV3:
197  ret = 1;
198  break;
199  default :
200  ret = 0;
201  break;
202  }
203  return ret;
204 }
205 #endif // USE_HW_ACCEL
206 
208  // Open reader if not already open
209  if (!is_open) {
210  // Prevent async calls to the following code
211  const std::lock_guard<std::recursive_mutex> lock(getFrameMutex);
212 
213  // Initialize format context
214  pFormatCtx = NULL;
215  {
217  ZmqLogger::Instance()->AppendDebugMethod("Decode hardware acceleration settings", "hw_de_on", hw_de_on, "HARDWARE_DECODER", openshot::Settings::Instance()->HARDWARE_DECODER);
218  }
219 
220  // Open video file
221  if (avformat_open_input(&pFormatCtx, path.c_str(), NULL, NULL) != 0)
222  throw InvalidFile("File could not be opened.", path);
223 
224  // Retrieve stream information
225  if (avformat_find_stream_info(pFormatCtx, NULL) < 0)
226  throw NoStreamsFound("No streams found in file.", path);
227 
228  videoStream = -1;
229  audioStream = -1;
230 
231  // Init end-of-file detection variables
232  packet_status.reset(true);
233 
234  // Loop through each stream, and identify the video and audio stream index
235  for (unsigned int i = 0; i < pFormatCtx->nb_streams; i++) {
236  // Is this a video stream?
237  if (AV_GET_CODEC_TYPE(pFormatCtx->streams[i]) == AVMEDIA_TYPE_VIDEO && videoStream < 0) {
238  videoStream = i;
239  packet_status.video_eof = false;
240  packet_status.packets_eof = false;
241  packet_status.end_of_file = false;
242  }
243  // Is this an audio stream?
244  if (AV_GET_CODEC_TYPE(pFormatCtx->streams[i]) == AVMEDIA_TYPE_AUDIO && audioStream < 0) {
245  audioStream = i;
246  packet_status.audio_eof = false;
247  packet_status.packets_eof = false;
248  packet_status.end_of_file = false;
249  }
250  }
251  if (videoStream == -1 && audioStream == -1)
252  throw NoStreamsFound("No video or audio streams found in this file.", path);
253 
254  // Is there a video stream?
255  if (videoStream != -1) {
256  // Set the stream index
257  info.video_stream_index = videoStream;
258 
259  // Set the codec and codec context pointers
260  pStream = pFormatCtx->streams[videoStream];
261 
262  // Find the codec ID from stream
263  const AVCodecID codecId = AV_FIND_DECODER_CODEC_ID(pStream);
264 
265  // Get codec and codec context from stream
266  const AVCodec *pCodec = avcodec_find_decoder(codecId);
267  AVDictionary *opts = NULL;
268  int retry_decode_open = 2;
269  // If hw accel is selected but hardware cannot handle repeat with software decoding
270  do {
271  pCodecCtx = AV_GET_CODEC_CONTEXT(pStream, pCodec);
272 #if USE_HW_ACCEL
273  if (hw_de_on && (retry_decode_open==2)) {
274  // Up to here no decision is made if hardware or software decode
275  hw_de_supported = IsHardwareDecodeSupported(pCodecCtx->codec_id);
276  }
277 #endif
278  retry_decode_open = 0;
279 
280  // Set number of threads equal to number of processors (not to exceed 16)
281  pCodecCtx->thread_count = std::min(FF_NUM_PROCESSORS, 16);
282 
283  if (pCodec == NULL) {
284  throw InvalidCodec("A valid video codec could not be found for this file.", path);
285  }
286 
287  // Init options
288  av_dict_set(&opts, "strict", "experimental", 0);
289 #if USE_HW_ACCEL
290  if (hw_de_on && hw_de_supported) {
291  // Open Hardware Acceleration
292  int i_decoder_hw = 0;
293  char adapter[256];
294  char *adapter_ptr = NULL;
295  int adapter_num;
297  fprintf(stderr, "Hardware decoding device number: %d\n", adapter_num);
298 
299  // Set hardware pix format (callback)
300  pCodecCtx->get_format = get_hw_dec_format;
301 
302  if (adapter_num < 3 && adapter_num >=0) {
303 #if defined(__linux__)
304  snprintf(adapter,sizeof(adapter),"/dev/dri/renderD%d", adapter_num+128);
305  adapter_ptr = adapter;
307  switch (i_decoder_hw) {
308  case 1:
309  hw_de_av_device_type = AV_HWDEVICE_TYPE_VAAPI;
310  break;
311  case 2:
312  hw_de_av_device_type = AV_HWDEVICE_TYPE_CUDA;
313  break;
314  case 6:
315  hw_de_av_device_type = AV_HWDEVICE_TYPE_VDPAU;
316  break;
317  case 7:
318  hw_de_av_device_type = AV_HWDEVICE_TYPE_QSV;
319  break;
320  default:
321  hw_de_av_device_type = AV_HWDEVICE_TYPE_VAAPI;
322  break;
323  }
324 
325 #elif defined(_WIN32)
326  adapter_ptr = NULL;
328  switch (i_decoder_hw) {
329  case 2:
330  hw_de_av_device_type = AV_HWDEVICE_TYPE_CUDA;
331  break;
332  case 3:
333  hw_de_av_device_type = AV_HWDEVICE_TYPE_DXVA2;
334  break;
335  case 4:
336  hw_de_av_device_type = AV_HWDEVICE_TYPE_D3D11VA;
337  break;
338  case 7:
339  hw_de_av_device_type = AV_HWDEVICE_TYPE_QSV;
340  break;
341  default:
342  hw_de_av_device_type = AV_HWDEVICE_TYPE_DXVA2;
343  break;
344  }
345 #elif defined(__APPLE__)
346  adapter_ptr = NULL;
348  switch (i_decoder_hw) {
349  case 5:
350  hw_de_av_device_type = AV_HWDEVICE_TYPE_VIDEOTOOLBOX;
351  break;
352  case 7:
353  hw_de_av_device_type = AV_HWDEVICE_TYPE_QSV;
354  break;
355  default:
356  hw_de_av_device_type = AV_HWDEVICE_TYPE_VIDEOTOOLBOX;
357  break;
358  }
359 #endif
360 
361  } else {
362  adapter_ptr = NULL; // Just to be sure
363  }
364 
365  // Check if it is there and writable
366 #if defined(__linux__)
367  if( adapter_ptr != NULL && access( adapter_ptr, W_OK ) == 0 ) {
368 #elif defined(_WIN32)
369  if( adapter_ptr != NULL ) {
370 #elif defined(__APPLE__)
371  if( adapter_ptr != NULL ) {
372 #endif
373  ZmqLogger::Instance()->AppendDebugMethod("Decode Device present using device");
374  }
375  else {
376  adapter_ptr = NULL; // use default
377  ZmqLogger::Instance()->AppendDebugMethod("Decode Device not present using default");
378  }
379 
380  hw_device_ctx = NULL;
381  // Here the first hardware initialisations are made
382  if (av_hwdevice_ctx_create(&hw_device_ctx, hw_de_av_device_type, adapter_ptr, NULL, 0) >= 0) {
383  if (!(pCodecCtx->hw_device_ctx = av_buffer_ref(hw_device_ctx))) {
384  throw InvalidCodec("Hardware device reference create failed.", path);
385  }
386 
387  /*
388  av_buffer_unref(&ist->hw_frames_ctx);
389  ist->hw_frames_ctx = av_hwframe_ctx_alloc(hw_device_ctx);
390  if (!ist->hw_frames_ctx) {
391  av_log(avctx, AV_LOG_ERROR, "Error creating a CUDA frames context\n");
392  return AVERROR(ENOMEM);
393  }
394 
395  frames_ctx = (AVHWFramesContext*)ist->hw_frames_ctx->data;
396 
397  frames_ctx->format = AV_PIX_FMT_CUDA;
398  frames_ctx->sw_format = avctx->sw_pix_fmt;
399  frames_ctx->width = avctx->width;
400  frames_ctx->height = avctx->height;
401 
402  av_log(avctx, AV_LOG_DEBUG, "Initializing CUDA frames context: sw_format = %s, width = %d, height = %d\n",
403  av_get_pix_fmt_name(frames_ctx->sw_format), frames_ctx->width, frames_ctx->height);
404 
405 
406  ret = av_hwframe_ctx_init(pCodecCtx->hw_device_ctx);
407  ret = av_hwframe_ctx_init(ist->hw_frames_ctx);
408  if (ret < 0) {
409  av_log(avctx, AV_LOG_ERROR, "Error initializing a CUDA frame pool\n");
410  return ret;
411  }
412  */
413  }
414  else {
415  throw InvalidCodec("Hardware device create failed.", path);
416  }
417  }
418 #endif // USE_HW_ACCEL
419 
420  // Disable per-frame threading for album arts
421  // Using FF_THREAD_FRAME adds one frame decoding delay per thread,
422  // but there's only one frame in this case.
423  if (HasAlbumArt())
424  {
425  pCodecCtx->thread_type &= ~FF_THREAD_FRAME;
426  }
427 
428  // Open video codec
429  int avcodec_return = avcodec_open2(pCodecCtx, pCodec, &opts);
430  if (avcodec_return < 0) {
431  std::stringstream avcodec_error_msg;
432  avcodec_error_msg << "A video codec was found, but could not be opened. Error: " << av_err2string(avcodec_return);
433  throw InvalidCodec(avcodec_error_msg.str(), path);
434  }
435 
436 #if USE_HW_ACCEL
437  if (hw_de_on && hw_de_supported) {
438  AVHWFramesConstraints *constraints = NULL;
439  void *hwconfig = NULL;
440  hwconfig = av_hwdevice_hwconfig_alloc(hw_device_ctx);
441 
442 // TODO: needs va_config!
443 #if ENABLE_VAAPI
444  ((AVVAAPIHWConfig *)hwconfig)->config_id = ((VAAPIDecodeContext *)(pCodecCtx->priv_data))->va_config;
445  constraints = av_hwdevice_get_hwframe_constraints(hw_device_ctx,hwconfig);
446 #endif // ENABLE_VAAPI
447  if (constraints) {
448  if (pCodecCtx->coded_width < constraints->min_width ||
449  pCodecCtx->coded_height < constraints->min_height ||
450  pCodecCtx->coded_width > constraints->max_width ||
451  pCodecCtx->coded_height > constraints->max_height) {
452  ZmqLogger::Instance()->AppendDebugMethod("DIMENSIONS ARE TOO LARGE for hardware acceleration\n");
453  hw_de_supported = 0;
454  retry_decode_open = 1;
455  AV_FREE_CONTEXT(pCodecCtx);
456  if (hw_device_ctx) {
457  av_buffer_unref(&hw_device_ctx);
458  hw_device_ctx = NULL;
459  }
460  }
461  else {
462  // All is just peachy
463  ZmqLogger::Instance()->AppendDebugMethod("\nDecode hardware acceleration is used\n", "Min width :", constraints->min_width, "Min Height :", constraints->min_height, "MaxWidth :", constraints->max_width, "MaxHeight :", constraints->max_height, "Frame width :", pCodecCtx->coded_width, "Frame height :", pCodecCtx->coded_height);
464  retry_decode_open = 0;
465  }
466  av_hwframe_constraints_free(&constraints);
467  if (hwconfig) {
468  av_freep(&hwconfig);
469  }
470  }
471  else {
472  int max_h, max_w;
473  //max_h = ((getenv( "LIMIT_HEIGHT_MAX" )==NULL) ? MAX_SUPPORTED_HEIGHT : atoi(getenv( "LIMIT_HEIGHT_MAX" )));
475  //max_w = ((getenv( "LIMIT_WIDTH_MAX" )==NULL) ? MAX_SUPPORTED_WIDTH : atoi(getenv( "LIMIT_WIDTH_MAX" )));
477  ZmqLogger::Instance()->AppendDebugMethod("Constraints could not be found using default limit\n");
478  //cerr << "Constraints could not be found using default limit\n";
479  if (pCodecCtx->coded_width < 0 ||
480  pCodecCtx->coded_height < 0 ||
481  pCodecCtx->coded_width > max_w ||
482  pCodecCtx->coded_height > max_h ) {
483  ZmqLogger::Instance()->AppendDebugMethod("DIMENSIONS ARE TOO LARGE for hardware acceleration\n", "Max Width :", max_w, "Max Height :", max_h, "Frame width :", pCodecCtx->coded_width, "Frame height :", pCodecCtx->coded_height);
484  hw_de_supported = 0;
485  retry_decode_open = 1;
486  AV_FREE_CONTEXT(pCodecCtx);
487  if (hw_device_ctx) {
488  av_buffer_unref(&hw_device_ctx);
489  hw_device_ctx = NULL;
490  }
491  }
492  else {
493  ZmqLogger::Instance()->AppendDebugMethod("\nDecode hardware acceleration is used\n", "Max Width :", max_w, "Max Height :", max_h, "Frame width :", pCodecCtx->coded_width, "Frame height :", pCodecCtx->coded_height);
494  retry_decode_open = 0;
495  }
496  }
497  } // if hw_de_on && hw_de_supported
498  else {
499  ZmqLogger::Instance()->AppendDebugMethod("\nDecode in software is used\n");
500  }
501 #else
502  retry_decode_open = 0;
503 #endif // USE_HW_ACCEL
504  } while (retry_decode_open); // retry_decode_open
505  // Free options
506  av_dict_free(&opts);
507 
508  // Update the File Info struct with video details (if a video stream is found)
509  UpdateVideoInfo();
510  }
511 
512  // Is there an audio stream?
513  if (audioStream != -1) {
514  // Set the stream index
515  info.audio_stream_index = audioStream;
516 
517  // Get a pointer to the codec context for the audio stream
518  aStream = pFormatCtx->streams[audioStream];
519 
520  // Find the codec ID from stream
521  AVCodecID codecId = AV_FIND_DECODER_CODEC_ID(aStream);
522 
523  // Get codec and codec context from stream
524  const AVCodec *aCodec = avcodec_find_decoder(codecId);
525  aCodecCtx = AV_GET_CODEC_CONTEXT(aStream, aCodec);
526 
527  // Set number of threads equal to number of processors (not to exceed 16)
528  aCodecCtx->thread_count = std::min(FF_NUM_PROCESSORS, 16);
529 
530  if (aCodec == NULL) {
531  throw InvalidCodec("A valid audio codec could not be found for this file.", path);
532  }
533 
534  // Init options
535  AVDictionary *opts = NULL;
536  av_dict_set(&opts, "strict", "experimental", 0);
537 
538  // Open audio codec
539  if (avcodec_open2(aCodecCtx, aCodec, &opts) < 0)
540  throw InvalidCodec("An audio codec was found, but could not be opened.", path);
541 
542  // Free options
543  av_dict_free(&opts);
544 
545  // Update the File Info struct with audio details (if an audio stream is found)
546  UpdateAudioInfo();
547  }
548 
549  // Add format metadata (if any)
550  AVDictionaryEntry *tag = NULL;
551  while ((tag = av_dict_get(pFormatCtx->metadata, "", tag, AV_DICT_IGNORE_SUFFIX))) {
552  QString str_key = tag->key;
553  QString str_value = tag->value;
554  info.metadata[str_key.toStdString()] = str_value.trimmed().toStdString();
555  }
556 
557  // Init previous audio location to zero
558  previous_packet_location.frame = -1;
559  previous_packet_location.sample_start = 0;
560 
561  // Adjust cache size based on size of frame and audio
562  working_cache.SetMaxBytesFromInfo(max_concurrent_frames * info.fps.ToDouble() * 2, info.width, info.height, info.sample_rate, info.channels);
564 
565  // Scan PTS for any offsets (i.e. non-zero starting streams). At least 1 stream must start at zero timestamp.
566  // This method allows us to shift timestamps to ensure at least 1 stream is starting at zero.
567  UpdatePTSOffset();
568 
569  // Override an invalid framerate
570  if (info.fps.ToFloat() > 240.0f || (info.fps.num <= 0 || info.fps.den <= 0) || info.video_length <= 0) {
571  // Calculate FPS, duration, video bit rate, and video length manually
572  // by scanning through all the video stream packets
573  CheckFPS();
574  }
575 
576  // Mark as "open"
577  is_open = true;
578 
579  // Seek back to beginning of file (if not already seeking)
580  if (!is_seeking) {
581  Seek(1);
582  }
583  }
584 }
585 
587  // Close all objects, if reader is 'open'
588  if (is_open) {
589  // Prevent async calls to the following code
590  const std::lock_guard<std::recursive_mutex> lock(getFrameMutex);
591 
592  // Mark as "closed"
593  is_open = false;
594 
595  // Keep track of most recent packet
596  AVPacket *recent_packet = packet;
597 
598  // Drain any packets from the decoder
599  packet = NULL;
600  int attempts = 0;
601  int max_attempts = 128;
602  while (packet_status.packets_decoded() < packet_status.packets_read() && attempts < max_attempts) {
603  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::Close (Drain decoder loop)",
604  "packets_read", packet_status.packets_read(),
605  "packets_decoded", packet_status.packets_decoded(),
606  "attempts", attempts);
607  if (packet_status.video_decoded < packet_status.video_read) {
608  ProcessVideoPacket(info.video_length);
609  }
610  if (packet_status.audio_decoded < packet_status.audio_read) {
611  ProcessAudioPacket(info.video_length);
612  }
613  attempts++;
614  }
615 
616  // Remove packet
617  if (recent_packet) {
618  RemoveAVPacket(recent_packet);
619  }
620 
621  // Close the video codec
622  if (info.has_video) {
623  if(avcodec_is_open(pCodecCtx)) {
624  avcodec_flush_buffers(pCodecCtx);
625  }
626  AV_FREE_CONTEXT(pCodecCtx);
627 #if USE_HW_ACCEL
628  if (hw_de_on) {
629  if (hw_device_ctx) {
630  av_buffer_unref(&hw_device_ctx);
631  hw_device_ctx = NULL;
632  }
633  }
634 #endif // USE_HW_ACCEL
635  }
636 
637  // Close the audio codec
638  if (info.has_audio) {
639  if(avcodec_is_open(aCodecCtx)) {
640  avcodec_flush_buffers(aCodecCtx);
641  }
642  AV_FREE_CONTEXT(aCodecCtx);
643  }
644 
645  // Clear final cache
646  final_cache.Clear();
647  working_cache.Clear();
648 
649  // Close the video file
650  avformat_close_input(&pFormatCtx);
651  av_freep(&pFormatCtx);
652 
653  // Reset some variables
654  last_frame = 0;
655  hold_packet = false;
656  largest_frame_processed = 0;
657  seek_audio_frame_found = 0;
658  seek_video_frame_found = 0;
659  current_video_frame = 0;
660  last_video_frame.reset();
661  }
662 }
663 
664 bool FFmpegReader::HasAlbumArt() {
665  // Check if the video stream we use is an attached picture
666  // This won't return true if the file has a cover image as a secondary stream
667  // like an MKV file with an attached image file
668  return pFormatCtx && videoStream >= 0 && pFormatCtx->streams[videoStream]
669  && (pFormatCtx->streams[videoStream]->disposition & AV_DISPOSITION_ATTACHED_PIC);
670 }
671 
672 void FFmpegReader::UpdateAudioInfo() {
673  // Set default audio channel layout (if needed)
674 #if HAVE_CH_LAYOUT
675  if (!av_channel_layout_check(&(AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->ch_layout)))
676  AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->ch_layout = (AVChannelLayout) AV_CHANNEL_LAYOUT_STEREO;
677 #else
678  if (AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->channel_layout == 0)
679  AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->channel_layout = av_get_default_channel_layout(AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->channels);
680 #endif
681 
682  if (info.sample_rate > 0) {
683  // Skip init - if info struct already populated
684  return;
685  }
686 
687  // Set values of FileInfo struct
688  info.has_audio = true;
689  info.file_size = pFormatCtx->pb ? avio_size(pFormatCtx->pb) : -1;
690  info.acodec = aCodecCtx->codec->name;
691 #if HAVE_CH_LAYOUT
692  info.channels = AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->ch_layout.nb_channels;
693  info.channel_layout = (ChannelLayout) AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->ch_layout.u.mask;
694 #else
695  info.channels = AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->channels;
696  info.channel_layout = (ChannelLayout) AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->channel_layout;
697 #endif
698 
699  // If channel layout is not set, guess based on the number of channels
700  if (info.channel_layout == 0) {
701  if (info.channels == 1) {
703  } else if (info.channels == 2) {
705  }
706  }
707 
708  info.sample_rate = AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->sample_rate;
709  info.audio_bit_rate = AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->bit_rate;
710  if (info.audio_bit_rate <= 0) {
711  // Get bitrate from format
712  info.audio_bit_rate = pFormatCtx->bit_rate;
713  }
714 
715  // Set audio timebase
716  info.audio_timebase.num = aStream->time_base.num;
717  info.audio_timebase.den = aStream->time_base.den;
718 
719  // Get timebase of audio stream (if valid) and greater than the current duration
720  if (aStream->duration > 0 && aStream->duration > info.duration) {
721  // Get duration from audio stream
722  info.duration = aStream->duration * info.audio_timebase.ToDouble();
723  } else if (pFormatCtx->duration > 0 && info.duration <= 0.0f) {
724  // Use the format's duration
725  info.duration = float(pFormatCtx->duration) / AV_TIME_BASE;
726  }
727 
728  // Calculate duration from filesize and bitrate (if any)
729  if (info.duration <= 0.0f && info.video_bit_rate > 0 && info.file_size > 0) {
730  // Estimate from bitrate, total bytes, and framerate
732  }
733 
734  // Check for an invalid video length
735  if (info.has_video && info.video_length <= 0) {
736  // Calculate the video length from the audio duration
738  }
739 
740  // Set video timebase (if no video stream was found)
741  if (!info.has_video) {
742  // Set a few important default video settings (so audio can be divided into frames)
743  info.fps.num = 24;
744  info.fps.den = 1;
745  info.video_timebase.num = 1;
746  info.video_timebase.den = 24;
748  info.width = 720;
749  info.height = 480;
750 
751  // Use timeline to set correct width & height (if any)
752  Clip *parent = static_cast<Clip *>(ParentClip());
753  if (parent) {
754  if (parent->ParentTimeline()) {
755  // Set max width/height based on parent clip's timeline (if attached to a timeline)
756  info.width = parent->ParentTimeline()->preview_width;
757  info.height = parent->ParentTimeline()->preview_height;
758  }
759  }
760  }
761 
762  // Fix invalid video lengths for certain types of files (MP3 for example)
763  if (info.has_video && ((info.duration * info.fps.ToDouble()) - info.video_length > 60)) {
765  }
766 
767  // Add audio metadata (if any found)
768  AVDictionaryEntry *tag = NULL;
769  while ((tag = av_dict_get(aStream->metadata, "", tag, AV_DICT_IGNORE_SUFFIX))) {
770  QString str_key = tag->key;
771  QString str_value = tag->value;
772  info.metadata[str_key.toStdString()] = str_value.trimmed().toStdString();
773  }
774 }
775 
776 void FFmpegReader::UpdateVideoInfo() {
777  if (info.vcodec.length() > 0) {
778  // Skip init - if info struct already populated
779  return;
780  }
781 
782  // Set values of FileInfo struct
783  info.has_video = true;
784  info.file_size = pFormatCtx->pb ? avio_size(pFormatCtx->pb) : -1;
785  info.height = AV_GET_CODEC_ATTRIBUTES(pStream, pCodecCtx)->height;
786  info.width = AV_GET_CODEC_ATTRIBUTES(pStream, pCodecCtx)->width;
787  info.vcodec = pCodecCtx->codec->name;
788  info.video_bit_rate = (pFormatCtx->bit_rate / 8);
789 
790  // Frame rate from the container and codec
791  AVRational framerate = av_guess_frame_rate(pFormatCtx, pStream, NULL);
792  if (!check_fps) {
793  info.fps.num = framerate.num;
794  info.fps.den = framerate.den;
795  }
796 
797  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::UpdateVideoInfo", "info.fps.num", info.fps.num, "info.fps.den", info.fps.den);
798 
799  // TODO: remove excessive debug info in the next releases
800  // The debug info below is just for comparison and troubleshooting on users side during the transition period
801  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::UpdateVideoInfo (pStream->avg_frame_rate)", "num", pStream->avg_frame_rate.num, "den", pStream->avg_frame_rate.den);
802 
803  if (pStream->sample_aspect_ratio.num != 0) {
804  info.pixel_ratio.num = pStream->sample_aspect_ratio.num;
805  info.pixel_ratio.den = pStream->sample_aspect_ratio.den;
806  } else if (AV_GET_CODEC_ATTRIBUTES(pStream, pCodecCtx)->sample_aspect_ratio.num != 0) {
807  info.pixel_ratio.num = AV_GET_CODEC_ATTRIBUTES(pStream, pCodecCtx)->sample_aspect_ratio.num;
808  info.pixel_ratio.den = AV_GET_CODEC_ATTRIBUTES(pStream, pCodecCtx)->sample_aspect_ratio.den;
809  } else {
810  info.pixel_ratio.num = 1;
811  info.pixel_ratio.den = 1;
812  }
813  info.pixel_format = AV_GET_CODEC_PIXEL_FORMAT(pStream, pCodecCtx);
814 
815  // Calculate the DAR (display aspect ratio)
817 
818  // Reduce size fraction
819  size.Reduce();
820 
821  // Set the ratio based on the reduced fraction
822  info.display_ratio.num = size.num;
823  info.display_ratio.den = size.den;
824 
825  // Get scan type and order from codec context/params
826  if (!check_interlace) {
827  check_interlace = true;
828  AVFieldOrder field_order = AV_GET_CODEC_ATTRIBUTES(pStream, pCodecCtx)->field_order;
829  switch(field_order) {
830  case AV_FIELD_PROGRESSIVE:
831  info.interlaced_frame = false;
832  break;
833  case AV_FIELD_TT:
834  case AV_FIELD_TB:
835  info.interlaced_frame = true;
836  info.top_field_first = true;
837  break;
838  case AV_FIELD_BT:
839  case AV_FIELD_BB:
840  info.interlaced_frame = true;
841  info.top_field_first = false;
842  break;
843  case AV_FIELD_UNKNOWN:
844  // Check again later?
845  check_interlace = false;
846  break;
847  }
848  // check_interlace will prevent these checks being repeated,
849  // unless it was cleared because we got an AV_FIELD_UNKNOWN response.
850  }
851 
852  // Set the video timebase
853  info.video_timebase.num = pStream->time_base.num;
854  info.video_timebase.den = pStream->time_base.den;
855 
856  // Set the duration in seconds, and video length (# of frames)
857  info.duration = pStream->duration * info.video_timebase.ToDouble();
858 
859  // Check for valid duration (if found)
860  if (info.duration <= 0.0f && pFormatCtx->duration >= 0) {
861  // Use the format's duration
862  info.duration = float(pFormatCtx->duration) / AV_TIME_BASE;
863  }
864 
865  // Calculate duration from filesize and bitrate (if any)
866  if (info.duration <= 0.0f && info.video_bit_rate > 0 && info.file_size > 0) {
867  // Estimate from bitrate, total bytes, and framerate
869  }
870 
871  // Certain "image" formats do not have a valid duration
872  if (info.duration <= 0.0f && pStream->duration == AV_NOPTS_VALUE && pFormatCtx->duration == AV_NOPTS_VALUE) {
873  // Force an "image" duration
874  info.duration = 60 * 60 * 1; // 1 hour duration
875  info.video_length = 1;
876  info.has_single_image = true;
877  }
878 
879  // Get the # of video frames (if found in stream)
880  // Only set this 1 time (this method can be called multiple times)
881  if (pStream->nb_frames > 0 && info.video_length <= 0)
882  {
883  info.video_length = pStream->nb_frames;
884 
885  // If the file format is animated GIF, override the video_length to be (duration * fps) rounded.
886  if (pFormatCtx && pFormatCtx->iformat && strcmp(pFormatCtx->iformat->name, "gif") == 0)
887  {
888  if (pStream->nb_frames > 1) {
889  // Animated gif (nb_frames does not take into delays and gaps)
891  } else {
892  // Static non-animated gif (set a default duration)
893  info.duration = 10.0;
894  }
895  }
896  }
897 
898  // No duration found in stream of file
899  if (info.duration <= 0.0f) {
900  // No duration is found in the video stream
901  info.duration = -1;
902  info.video_length = -1;
903  is_duration_known = false;
904  } else {
905  // Yes, a duration was found
906  is_duration_known = true;
907 
908  // Calculate number of frames (if not already found in metadata)
909  // Only set this 1 time (this method can be called multiple times)
910  if (info.video_length <= 0) {
912  }
913  }
914 
915  // Add video metadata (if any)
916  AVDictionaryEntry *tag = NULL;
917  while ((tag = av_dict_get(pStream->metadata, "", tag, AV_DICT_IGNORE_SUFFIX))) {
918  QString str_key = tag->key;
919  QString str_value = tag->value;
920  info.metadata[str_key.toStdString()] = str_value.trimmed().toStdString();
921  }
922 }
923 
925  return this->is_duration_known;
926 }
927 
928 std::shared_ptr<Frame> FFmpegReader::GetFrame(int64_t requested_frame) {
929  // Check for open reader (or throw exception)
930  if (!is_open)
931  throw ReaderClosed("The FFmpegReader is closed. Call Open() before calling this method.", path);
932 
933  // Adjust for a requested frame that is too small or too large
934  if (requested_frame < 1)
935  requested_frame = 1;
936  if (requested_frame > info.video_length && is_duration_known)
937  requested_frame = info.video_length;
938  if (info.has_video && info.video_length == 0)
939  // Invalid duration of video file
940  throw InvalidFile("Could not detect the duration of the video or audio stream.", path);
941 
942  // Debug output
943  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::GetFrame", "requested_frame", requested_frame, "last_frame", last_frame);
944 
945  // Check the cache for this frame
946  std::shared_ptr<Frame> frame = final_cache.GetFrame(requested_frame);
947  if (frame) {
948  // Debug output
949  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::GetFrame", "returned cached frame", requested_frame);
950 
951  // Return the cached frame
952  return frame;
953  } else {
954 
955  // Prevent async calls to the remainder of this code
956  const std::lock_guard<std::recursive_mutex> lock(getFrameMutex);
957 
958  // Check the cache a 2nd time (due to the potential previous lock)
959  frame = final_cache.GetFrame(requested_frame);
960  if (frame) {
961  // Debug output
962  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::GetFrame", "returned cached frame on 2nd look", requested_frame);
963 
964  } else {
965  // Frame is not in cache
966  // Reset seek count
967  seek_count = 0;
968 
969  // Are we within X frames of the requested frame?
970  int64_t diff = requested_frame - last_frame;
971  if (diff >= 1 && diff <= 20) {
972  // Continue walking the stream
973  frame = ReadStream(requested_frame);
974  } else {
975  // Greater than 30 frames away, or backwards, we need to seek to the nearest key frame
976  if (enable_seek) {
977  // Only seek if enabled
978  Seek(requested_frame);
979 
980  } else if (!enable_seek && diff < 0) {
981  // Start over, since we can't seek, and the requested frame is smaller than our position
982  // Since we are seeking to frame 1, this actually just closes/re-opens the reader
983  Seek(1);
984  }
985 
986  // Then continue walking the stream
987  frame = ReadStream(requested_frame);
988  }
989  }
990  return frame;
991  }
992 }
993 
994 // Read the stream until we find the requested Frame
995 std::shared_ptr<Frame> FFmpegReader::ReadStream(int64_t requested_frame) {
996  // Allocate video frame
997  bool check_seek = false;
998  int packet_error = -1;
999 
1000  // Debug output
1001  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ReadStream", "requested_frame", requested_frame, "max_concurrent_frames", max_concurrent_frames);
1002 
1003  // Loop through the stream until the correct frame is found
1004  while (true) {
1005  // Check if working frames are 'finished'
1006  if (!is_seeking) {
1007  // Check for final frames
1008  CheckWorkingFrames(requested_frame);
1009  }
1010 
1011  // Check if requested 'final' frame is available (and break out of loop if found)
1012  bool is_cache_found = (final_cache.GetFrame(requested_frame) != NULL);
1013  if (is_cache_found) {
1014  break;
1015  }
1016 
1017  if (!hold_packet || !packet) {
1018  // Get the next packet
1019  packet_error = GetNextPacket();
1020  if (packet_error < 0 && !packet) {
1021  // No more packets to be found
1022  packet_status.packets_eof = true;
1023  }
1024  }
1025 
1026  // Debug output
1027  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ReadStream (GetNextPacket)", "requested_frame", requested_frame,"packets_read", packet_status.packets_read(), "packets_decoded", packet_status.packets_decoded(), "is_seeking", is_seeking);
1028 
1029  // Check the status of a seek (if any)
1030  if (is_seeking) {
1031  check_seek = CheckSeek(false);
1032  } else {
1033  check_seek = false;
1034  }
1035 
1036  if (check_seek) {
1037  // Packet may become NULL on Close inside Seek if CheckSeek returns false
1038  // Jump to the next iteration of this loop
1039  continue;
1040  }
1041 
1042  // Video packet
1043  if ((info.has_video && packet && packet->stream_index == videoStream) ||
1044  (info.has_video && packet_status.video_decoded < packet_status.video_read) ||
1045  (info.has_video && !packet && !packet_status.video_eof)) {
1046  // Process Video Packet
1047  ProcessVideoPacket(requested_frame);
1048  }
1049  // Audio packet
1050  if ((info.has_audio && packet && packet->stream_index == audioStream) ||
1051  (info.has_audio && !packet && packet_status.audio_decoded < packet_status.audio_read) ||
1052  (info.has_audio && !packet && !packet_status.audio_eof)) {
1053  // Process Audio Packet
1054  ProcessAudioPacket(requested_frame);
1055  }
1056 
1057  // Remove unused packets (sometimes we purposely ignore video or audio packets,
1058  // if the has_video or has_audio properties are manually overridden)
1059  if ((!info.has_video && packet && packet->stream_index == videoStream) ||
1060  (!info.has_audio && packet && packet->stream_index == audioStream)) {
1061  // Keep track of deleted packet counts
1062  if (packet->stream_index == videoStream) {
1063  packet_status.video_decoded++;
1064  } else if (packet->stream_index == audioStream) {
1065  packet_status.audio_decoded++;
1066  }
1067 
1068  // Remove unused packets (sometimes we purposely ignore video or audio packets,
1069  // if the has_video or has_audio properties are manually overridden)
1070  RemoveAVPacket(packet);
1071  packet = NULL;
1072  }
1073 
1074  // Determine end-of-stream (waiting until final decoder threads finish)
1075  // Force end-of-stream in some situations
1076  packet_status.end_of_file = packet_status.packets_eof && packet_status.video_eof && packet_status.audio_eof;
1077  if ((packet_status.packets_eof && packet_status.packets_read() == packet_status.packets_decoded()) || packet_status.end_of_file) {
1078  // Force EOF (end of file) variables to true, if decoder does not support EOF detection.
1079  // If we have no more packets, and all known packets have been decoded
1080  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ReadStream (force EOF)", "packets_read", packet_status.packets_read(), "packets_decoded", packet_status.packets_decoded(), "packets_eof", packet_status.packets_eof, "video_eof", packet_status.video_eof, "audio_eof", packet_status.audio_eof, "end_of_file", packet_status.end_of_file);
1081  if (!packet_status.video_eof) {
1082  packet_status.video_eof = true;
1083  }
1084  if (!packet_status.audio_eof) {
1085  packet_status.audio_eof = true;
1086  }
1087  packet_status.end_of_file = true;
1088  break;
1089  }
1090  } // end while
1091 
1092  // Debug output
1093  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ReadStream (Completed)",
1094  "packets_read", packet_status.packets_read(),
1095  "packets_decoded", packet_status.packets_decoded(),
1096  "end_of_file", packet_status.end_of_file,
1097  "largest_frame_processed", largest_frame_processed,
1098  "Working Cache Count", working_cache.Count());
1099 
1100  // Have we reached end-of-stream (or the final frame)?
1101  if (!packet_status.end_of_file && requested_frame >= info.video_length) {
1102  // Force end-of-stream
1103  packet_status.end_of_file = true;
1104  }
1105  if (packet_status.end_of_file) {
1106  // Mark any other working frames as 'finished'
1107  CheckWorkingFrames(requested_frame);
1108  }
1109 
1110  // Return requested frame (if found)
1111  std::shared_ptr<Frame> frame = final_cache.GetFrame(requested_frame);
1112  if (frame)
1113  // Return prepared frame
1114  return frame;
1115  else {
1116 
1117  // Check if largest frame is still cached
1118  frame = final_cache.GetFrame(largest_frame_processed);
1119  int samples_in_frame = Frame::GetSamplesPerFrame(requested_frame, info.fps,
1121  if (frame) {
1122  // Copy and return the largest processed frame (assuming it was the last in the video file)
1123  std::shared_ptr<Frame> f = CreateFrame(largest_frame_processed);
1124 
1125  // Use solid color (if no image data found)
1126  if (!frame->has_image_data) {
1127  // Use solid black frame if no image data available
1128  f->AddColor(info.width, info.height, "#000");
1129  }
1130  // Silence audio data (if any), since we are repeating the last frame
1131  frame->AddAudioSilence(samples_in_frame);
1132 
1133  return frame;
1134  } else {
1135  // The largest processed frame is no longer in cache, return a blank frame
1136  std::shared_ptr<Frame> f = CreateFrame(largest_frame_processed);
1137  f->AddColor(info.width, info.height, "#000");
1138  f->AddAudioSilence(samples_in_frame);
1139  return f;
1140  }
1141  }
1142 
1143 }
1144 
1145 // Get the next packet (if any)
1146 int FFmpegReader::GetNextPacket() {
1147  int found_packet = 0;
1148  AVPacket *next_packet;
1149  next_packet = new AVPacket();
1150  found_packet = av_read_frame(pFormatCtx, next_packet);
1151 
1152  if (packet) {
1153  // Remove previous packet before getting next one
1154  RemoveAVPacket(packet);
1155  packet = NULL;
1156  }
1157  if (found_packet >= 0) {
1158  // Update current packet pointer
1159  packet = next_packet;
1160 
1161  // Keep track of packet stats
1162  if (packet->stream_index == videoStream) {
1163  packet_status.video_read++;
1164  } else if (packet->stream_index == audioStream) {
1165  packet_status.audio_read++;
1166  }
1167  } else {
1168  // No more packets found
1169  delete next_packet;
1170  packet = NULL;
1171  }
1172  // Return if packet was found (or error number)
1173  return found_packet;
1174 }
1175 
1176 // Get an AVFrame (if any)
1177 bool FFmpegReader::GetAVFrame() {
1178  int frameFinished = 0;
1179 
1180  // Decode video frame
1181  AVFrame *next_frame = AV_ALLOCATE_FRAME();
1182 
1183 #if IS_FFMPEG_3_2
1184  int send_packet_err = 0;
1185  int64_t send_packet_pts = 0;
1186  if ((packet && packet->stream_index == videoStream) || !packet) {
1187  send_packet_err = avcodec_send_packet(pCodecCtx, packet);
1188 
1189  if (packet && send_packet_err >= 0) {
1190  send_packet_pts = GetPacketPTS();
1191  hold_packet = false;
1192  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::GetAVFrame (send packet succeeded)", "send_packet_err", send_packet_err, "send_packet_pts", send_packet_pts);
1193  }
1194  }
1195 
1196  #if USE_HW_ACCEL
1197  // Get the format from the variables set in get_hw_dec_format
1198  hw_de_av_pix_fmt = hw_de_av_pix_fmt_global;
1199  hw_de_av_device_type = hw_de_av_device_type_global;
1200  #endif // USE_HW_ACCEL
1201  if (send_packet_err < 0 && send_packet_err != AVERROR_EOF) {
1202  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::GetAVFrame (send packet: Not sent [" + av_err2string(send_packet_err) + "])", "send_packet_err", send_packet_err, "send_packet_pts", send_packet_pts);
1203  if (send_packet_err == AVERROR(EAGAIN)) {
1204  hold_packet = true;
1205  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::GetAVFrame (send packet: AVERROR(EAGAIN): user must read output with avcodec_receive_frame()", "send_packet_pts", send_packet_pts);
1206  }
1207  if (send_packet_err == AVERROR(EINVAL)) {
1208  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::GetAVFrame (send packet: AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush", "send_packet_pts", send_packet_pts);
1209  }
1210  if (send_packet_err == AVERROR(ENOMEM)) {
1211  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::GetAVFrame (send packet: AVERROR(ENOMEM): failed to add packet to internal queue, or legitimate decoding errors", "send_packet_pts", send_packet_pts);
1212  }
1213  }
1214 
1215  // Always try and receive a packet, if not EOF.
1216  // Even if the above avcodec_send_packet failed to send,
1217  // we might still need to receive a packet.
1218  int receive_frame_err = 0;
1219  AVFrame *next_frame2;
1220 #if USE_HW_ACCEL
1221  if (hw_de_on && hw_de_supported) {
1222  next_frame2 = AV_ALLOCATE_FRAME();
1223  }
1224  else
1225 #endif // USE_HW_ACCEL
1226  {
1227  next_frame2 = next_frame;
1228  }
1229  pFrame = AV_ALLOCATE_FRAME();
1230  while (receive_frame_err >= 0) {
1231  receive_frame_err = avcodec_receive_frame(pCodecCtx, next_frame2);
1232 
1233  if (receive_frame_err != 0) {
1234  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::GetAVFrame (receive frame: frame not ready yet from decoder [\" + av_err2string(receive_frame_err) + \"])", "receive_frame_err", receive_frame_err, "send_packet_pts", send_packet_pts);
1235 
1236  if (receive_frame_err == AVERROR_EOF) {
1238  "FFmpegReader::GetAVFrame (receive frame: AVERROR_EOF: EOF detected from decoder, flushing buffers)", "send_packet_pts", send_packet_pts);
1239  avcodec_flush_buffers(pCodecCtx);
1240  packet_status.video_eof = true;
1241  }
1242  if (receive_frame_err == AVERROR(EINVAL)) {
1244  "FFmpegReader::GetAVFrame (receive frame: AVERROR(EINVAL): invalid frame received, flushing buffers)", "send_packet_pts", send_packet_pts);
1245  avcodec_flush_buffers(pCodecCtx);
1246  }
1247  if (receive_frame_err == AVERROR(EAGAIN)) {
1249  "FFmpegReader::GetAVFrame (receive frame: AVERROR(EAGAIN): output is not available in this state - user must try to send new input)", "send_packet_pts", send_packet_pts);
1250  }
1251  if (receive_frame_err == AVERROR_INPUT_CHANGED) {
1253  "FFmpegReader::GetAVFrame (receive frame: AVERROR_INPUT_CHANGED: current decoded frame has changed parameters with respect to first decoded frame)", "send_packet_pts", send_packet_pts);
1254  }
1255 
1256  // Break out of decoding loop
1257  // Nothing ready for decoding yet
1258  break;
1259  }
1260 
1261 #if USE_HW_ACCEL
1262  if (hw_de_on && hw_de_supported) {
1263  int err;
1264  if (next_frame2->format == hw_de_av_pix_fmt) {
1265  next_frame->format = AV_PIX_FMT_YUV420P;
1266  if ((err = av_hwframe_transfer_data(next_frame,next_frame2,0)) < 0) {
1267  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::GetAVFrame (Failed to transfer data to output frame)", "hw_de_on", hw_de_on);
1268  }
1269  if ((err = av_frame_copy_props(next_frame,next_frame2)) < 0) {
1270  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::GetAVFrame (Failed to copy props to output frame)", "hw_de_on", hw_de_on);
1271  }
1272  }
1273  }
1274  else
1275 #endif // USE_HW_ACCEL
1276  { // No hardware acceleration used -> no copy from GPU memory needed
1277  next_frame = next_frame2;
1278  }
1279 
1280  // TODO also handle possible further frames
1281  // Use only the first frame like avcodec_decode_video2
1282  frameFinished = 1;
1283  packet_status.video_decoded++;
1284 
1285  av_image_alloc(pFrame->data, pFrame->linesize, info.width, info.height, (AVPixelFormat)(pStream->codecpar->format), 1);
1286  av_image_copy(pFrame->data, pFrame->linesize, (const uint8_t**)next_frame->data, next_frame->linesize,
1287  (AVPixelFormat)(pStream->codecpar->format), info.width, info.height);
1288 
1289  // Get display PTS from video frame, often different than packet->pts.
1290  // Sending packets to the decoder (i.e. packet->pts) is async,
1291  // and retrieving packets from the decoder (frame->pts) is async. In most decoders
1292  // sending and retrieving are separated by multiple calls to this method.
1293  if (next_frame->pts != AV_NOPTS_VALUE) {
1294  // This is the current decoded frame (and should be the pts used) for
1295  // processing this data
1296  video_pts = next_frame->pts;
1297  } else if (next_frame->pkt_dts != AV_NOPTS_VALUE) {
1298  // Some videos only set this timestamp (fallback)
1299  video_pts = next_frame->pkt_dts;
1300  }
1301 
1303  "FFmpegReader::GetAVFrame (Successful frame received)", "video_pts", video_pts, "send_packet_pts", send_packet_pts);
1304 
1305  // break out of loop after each successful image returned
1306  break;
1307  }
1308 #if USE_HW_ACCEL
1309  if (hw_de_on && hw_de_supported) {
1310  AV_FREE_FRAME(&next_frame2);
1311  }
1312  #endif // USE_HW_ACCEL
1313 #else
1314  avcodec_decode_video2(pCodecCtx, next_frame, &frameFinished, packet);
1315 
1316  // always allocate pFrame (because we do that in the ffmpeg >= 3.2 as well); it will always be freed later
1317  pFrame = AV_ALLOCATE_FRAME();
1318 
1319  // is frame finished
1320  if (frameFinished) {
1321  // AVFrames are clobbered on the each call to avcodec_decode_video, so we
1322  // must make a copy of the image data before this method is called again.
1323  avpicture_alloc((AVPicture *) pFrame, pCodecCtx->pix_fmt, info.width, info.height);
1324  av_picture_copy((AVPicture *) pFrame, (AVPicture *) next_frame, pCodecCtx->pix_fmt, info.width,
1325  info.height);
1326  }
1327 #endif // IS_FFMPEG_3_2
1328 
1329  // deallocate the frame
1330  AV_FREE_FRAME(&next_frame);
1331 
1332  // Did we get a video frame?
1333  return frameFinished;
1334 }
1335 
1336 // Check the current seek position and determine if we need to seek again
1337 bool FFmpegReader::CheckSeek(bool is_video) {
1338  // Are we seeking for a specific frame?
1339  if (is_seeking) {
1340  // Determine if both an audio and video packet have been decoded since the seek happened.
1341  // If not, allow the ReadStream method to keep looping
1342  if ((is_video_seek && !seek_video_frame_found) || (!is_video_seek && !seek_audio_frame_found))
1343  return false;
1344 
1345  // Check for both streams
1346  if ((info.has_video && !seek_video_frame_found) || (info.has_audio && !seek_audio_frame_found))
1347  return false;
1348 
1349  // Determine max seeked frame
1350  int64_t max_seeked_frame = std::max(seek_audio_frame_found, seek_video_frame_found);
1351 
1352  // determine if we are "before" the requested frame
1353  if (max_seeked_frame >= seeking_frame) {
1354  // SEEKED TOO FAR
1355  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::CheckSeek (Too far, seek again)",
1356  "is_video_seek", is_video_seek,
1357  "max_seeked_frame", max_seeked_frame,
1358  "seeking_frame", seeking_frame,
1359  "seeking_pts", seeking_pts,
1360  "seek_video_frame_found", seek_video_frame_found,
1361  "seek_audio_frame_found", seek_audio_frame_found);
1362 
1363  // Seek again... to the nearest Keyframe
1364  Seek(seeking_frame - (10 * seek_count * seek_count));
1365  } else {
1366  // SEEK WORKED
1367  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::CheckSeek (Successful)",
1368  "is_video_seek", is_video_seek,
1369  "packet->pts", GetPacketPTS(),
1370  "seeking_pts", seeking_pts,
1371  "seeking_frame", seeking_frame,
1372  "seek_video_frame_found", seek_video_frame_found,
1373  "seek_audio_frame_found", seek_audio_frame_found);
1374 
1375  // Seek worked, and we are "before" the requested frame
1376  is_seeking = false;
1377  seeking_frame = 0;
1378  seeking_pts = -1;
1379  }
1380  }
1381 
1382  // return the pts to seek to (if any)
1383  return is_seeking;
1384 }
1385 
1386 // Process a video packet
1387 void FFmpegReader::ProcessVideoPacket(int64_t requested_frame) {
1388  // Get the AVFrame from the current packet
1389  // This sets the video_pts to the correct timestamp
1390  int frame_finished = GetAVFrame();
1391 
1392  // Check if the AVFrame is finished and set it
1393  if (!frame_finished) {
1394  // No AVFrame decoded yet, bail out
1395  if (pFrame) {
1396  RemoveAVFrame(pFrame);
1397  }
1398  return;
1399  }
1400 
1401  // Calculate current frame #
1402  int64_t current_frame = ConvertVideoPTStoFrame(video_pts);
1403 
1404  // Track 1st video packet after a successful seek
1405  if (!seek_video_frame_found && is_seeking)
1406  seek_video_frame_found = current_frame;
1407 
1408  // Create or get the existing frame object. Requested frame needs to be created
1409  // in working_cache at least once. Seek can clear the working_cache, so we must
1410  // add the requested frame back to the working_cache here. If it already exists,
1411  // it will be moved to the top of the working_cache.
1412  working_cache.Add(CreateFrame(requested_frame));
1413 
1414  // Debug output
1415  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ProcessVideoPacket (Before)", "requested_frame", requested_frame, "current_frame", current_frame);
1416 
1417  // Init some things local (for OpenMP)
1418  PixelFormat pix_fmt = AV_GET_CODEC_PIXEL_FORMAT(pStream, pCodecCtx);
1419  int height = info.height;
1420  int width = info.width;
1421  int64_t video_length = info.video_length;
1422 
1423  // Create variables for a RGB Frame (since most videos are not in RGB, we must convert it)
1424  AVFrame *pFrameRGB = nullptr;
1425  uint8_t *buffer = nullptr;
1426 
1427  // Allocate an AVFrame structure
1428  pFrameRGB = AV_ALLOCATE_FRAME();
1429  if (pFrameRGB == nullptr)
1430  throw OutOfMemory("Failed to allocate frame buffer", path);
1431 
1432  // Determine the max size of this source image (based on the timeline's size, the scaling mode,
1433  // and the scaling keyframes). This is a performance improvement, to keep the images as small as possible,
1434  // without losing quality. NOTE: We cannot go smaller than the timeline itself, or the add_layer timeline
1435  // method will scale it back to timeline size before scaling it smaller again. This needs to be fixed in
1436  // the future.
1437  int max_width = info.width;
1438  int max_height = info.height;
1439 
1440  Clip *parent = static_cast<Clip *>(ParentClip());
1441  if (parent) {
1442  if (parent->ParentTimeline()) {
1443  // Set max width/height based on parent clip's timeline (if attached to a timeline)
1444  max_width = parent->ParentTimeline()->preview_width;
1445  max_height = parent->ParentTimeline()->preview_height;
1446  }
1447  if (parent->scale == SCALE_FIT || parent->scale == SCALE_STRETCH) {
1448  // Best fit or Stretch scaling (based on max timeline size * scaling keyframes)
1449  float max_scale_x = parent->scale_x.GetMaxPoint().co.Y;
1450  float max_scale_y = parent->scale_y.GetMaxPoint().co.Y;
1451  max_width = std::max(float(max_width), max_width * max_scale_x);
1452  max_height = std::max(float(max_height), max_height * max_scale_y);
1453 
1454  } else if (parent->scale == SCALE_CROP) {
1455  // Cropping scale mode (based on max timeline size * cropped size * scaling keyframes)
1456  float max_scale_x = parent->scale_x.GetMaxPoint().co.Y;
1457  float max_scale_y = parent->scale_y.GetMaxPoint().co.Y;
1458  QSize width_size(max_width * max_scale_x,
1459  round(max_width / (float(info.width) / float(info.height))));
1460  QSize height_size(round(max_height / (float(info.height) / float(info.width))),
1461  max_height * max_scale_y);
1462  // respect aspect ratio
1463  if (width_size.width() >= max_width && width_size.height() >= max_height) {
1464  max_width = std::max(max_width, width_size.width());
1465  max_height = std::max(max_height, width_size.height());
1466  } else {
1467  max_width = std::max(max_width, height_size.width());
1468  max_height = std::max(max_height, height_size.height());
1469  }
1470 
1471  } else {
1472  // Scale video to equivalent unscaled size
1473  // Since the preview window can change sizes, we want to always
1474  // scale against the ratio of original video size to timeline size
1475  float preview_ratio = 1.0;
1476  if (parent->ParentTimeline()) {
1477  Timeline *t = (Timeline *) parent->ParentTimeline();
1478  preview_ratio = t->preview_width / float(t->info.width);
1479  }
1480  float max_scale_x = parent->scale_x.GetMaxPoint().co.Y;
1481  float max_scale_y = parent->scale_y.GetMaxPoint().co.Y;
1482  max_width = info.width * max_scale_x * preview_ratio;
1483  max_height = info.height * max_scale_y * preview_ratio;
1484  }
1485  }
1486 
1487  // Determine if image needs to be scaled (for performance reasons)
1488  int original_height = height;
1489  if (max_width != 0 && max_height != 0 && max_width < width && max_height < height) {
1490  // Override width and height (but maintain aspect ratio)
1491  float ratio = float(width) / float(height);
1492  int possible_width = round(max_height * ratio);
1493  int possible_height = round(max_width / ratio);
1494 
1495  if (possible_width <= max_width) {
1496  // use calculated width, and max_height
1497  width = possible_width;
1498  height = max_height;
1499  } else {
1500  // use max_width, and calculated height
1501  width = max_width;
1502  height = possible_height;
1503  }
1504  }
1505 
1506  // Determine required buffer size and allocate buffer
1507  const int bytes_per_pixel = 4;
1508  int buffer_size = (width * height * bytes_per_pixel) + 128;
1509  buffer = new unsigned char[buffer_size]();
1510 
1511  // Copy picture data from one AVFrame (or AVPicture) to another one.
1512  AV_COPY_PICTURE_DATA(pFrameRGB, buffer, PIX_FMT_RGBA, width, height);
1513 
1514  int scale_mode = SWS_FAST_BILINEAR;
1515  if (openshot::Settings::Instance()->HIGH_QUALITY_SCALING) {
1516  scale_mode = SWS_BICUBIC;
1517  }
1518  SwsContext *img_convert_ctx = sws_getContext(info.width, info.height, AV_GET_CODEC_PIXEL_FORMAT(pStream, pCodecCtx), width,
1519  height, PIX_FMT_RGBA, scale_mode, NULL, NULL, NULL);
1520 
1521  // Resize / Convert to RGB
1522  sws_scale(img_convert_ctx, pFrame->data, pFrame->linesize, 0,
1523  original_height, pFrameRGB->data, pFrameRGB->linesize);
1524 
1525  // Create or get the existing frame object
1526  std::shared_ptr<Frame> f = CreateFrame(current_frame);
1527 
1528  // Add Image data to frame
1529  if (!ffmpeg_has_alpha(AV_GET_CODEC_PIXEL_FORMAT(pStream, pCodecCtx))) {
1530  // Add image with no alpha channel, Speed optimization
1531  f->AddImage(width, height, bytes_per_pixel, QImage::Format_RGBA8888_Premultiplied, buffer);
1532  } else {
1533  // Add image with alpha channel (this will be converted to premultipled when needed, but is slower)
1534  f->AddImage(width, height, bytes_per_pixel, QImage::Format_RGBA8888, buffer);
1535  }
1536 
1537  // Update working cache
1538  working_cache.Add(f);
1539 
1540  // Keep track of last last_video_frame
1541  last_video_frame = f;
1542 
1543  // Free the RGB image
1544  AV_FREE_FRAME(&pFrameRGB);
1545 
1546  // Remove frame and packet
1547  RemoveAVFrame(pFrame);
1548  sws_freeContext(img_convert_ctx);
1549 
1550  // Get video PTS in seconds
1551  video_pts_seconds = (double(video_pts) * info.video_timebase.ToDouble()) + pts_offset_seconds;
1552 
1553  // Debug output
1554  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ProcessVideoPacket (After)", "requested_frame", requested_frame, "current_frame", current_frame, "f->number", f->number, "video_pts_seconds", video_pts_seconds);
1555 }
1556 
1557 // Process an audio packet
1558 void FFmpegReader::ProcessAudioPacket(int64_t requested_frame) {
1559  AudioLocation location;
1560  // Calculate location of current audio packet
1561  if (packet && packet->pts != AV_NOPTS_VALUE) {
1562  // Determine related video frame and starting sample # from audio PTS
1563  location = GetAudioPTSLocation(packet->pts);
1564 
1565  // Track 1st audio packet after a successful seek
1566  if (!seek_audio_frame_found && is_seeking)
1567  seek_audio_frame_found = location.frame;
1568  }
1569 
1570  // Create or get the existing frame object. Requested frame needs to be created
1571  // in working_cache at least once. Seek can clear the working_cache, so we must
1572  // add the requested frame back to the working_cache here. If it already exists,
1573  // it will be moved to the top of the working_cache.
1574  working_cache.Add(CreateFrame(requested_frame));
1575 
1576  // Debug output
1577  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ProcessAudioPacket (Before)",
1578  "requested_frame", requested_frame,
1579  "target_frame", location.frame,
1580  "starting_sample", location.sample_start);
1581 
1582  // Init an AVFrame to hold the decoded audio samples
1583  int frame_finished = 0;
1584  AVFrame *audio_frame = AV_ALLOCATE_FRAME();
1585  AV_RESET_FRAME(audio_frame);
1586 
1587  int packet_samples = 0;
1588  int data_size = 0;
1589 
1590 #if IS_FFMPEG_3_2
1591  int send_packet_err = avcodec_send_packet(aCodecCtx, packet);
1592  if (send_packet_err < 0 && send_packet_err != AVERROR_EOF) {
1593  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ProcessAudioPacket (Packet not sent)");
1594  }
1595  else {
1596  int receive_frame_err = avcodec_receive_frame(aCodecCtx, audio_frame);
1597  if (receive_frame_err >= 0) {
1598  frame_finished = 1;
1599  }
1600  if (receive_frame_err == AVERROR_EOF) {
1601  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ProcessAudioPacket (EOF detected from decoder)");
1602  packet_status.audio_eof = true;
1603  }
1604  if (receive_frame_err == AVERROR(EINVAL) || receive_frame_err == AVERROR_EOF) {
1605  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ProcessAudioPacket (invalid frame received or EOF from decoder)");
1606  avcodec_flush_buffers(aCodecCtx);
1607  }
1608  if (receive_frame_err != 0) {
1609  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ProcessAudioPacket (frame not ready yet from decoder)");
1610  }
1611  }
1612 #else
1613  int used = avcodec_decode_audio4(aCodecCtx, audio_frame, &frame_finished, packet);
1614 #endif
1615 
1616  if (frame_finished) {
1617  packet_status.audio_decoded++;
1618 
1619  // This can be different than the current packet, so we need to look
1620  // at the current AVFrame from the audio decoder. This timestamp should
1621  // be used for the remainder of this function
1622  audio_pts = audio_frame->pts;
1623 
1624  // Determine related video frame and starting sample # from audio PTS
1625  location = GetAudioPTSLocation(audio_pts);
1626 
1627  // determine how many samples were decoded
1628  int plane_size = -1;
1629 #if HAVE_CH_LAYOUT
1630  int nb_channels = AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->ch_layout.nb_channels;
1631 #else
1632  int nb_channels = AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->channels;
1633 #endif
1634  data_size = av_samples_get_buffer_size(&plane_size, nb_channels,
1635  audio_frame->nb_samples, (AVSampleFormat) (AV_GET_SAMPLE_FORMAT(aStream, aCodecCtx)), 1);
1636 
1637  // Calculate total number of samples
1638  packet_samples = audio_frame->nb_samples * nb_channels;
1639  } else {
1640  if (audio_frame) {
1641  // Free audio frame
1642  AV_FREE_FRAME(&audio_frame);
1643  }
1644  }
1645 
1646  // Estimate the # of samples and the end of this packet's location (to prevent GAPS for the next timestamp)
1647  int pts_remaining_samples = packet_samples / info.channels; // Adjust for zero based array
1648 
1649  // Bail if no samples found
1650  if (pts_remaining_samples == 0) {
1651  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ProcessAudioPacket (No samples, bailing)",
1652  "packet_samples", packet_samples,
1653  "info.channels", info.channels,
1654  "pts_remaining_samples", pts_remaining_samples);
1655  return;
1656  }
1657 
1658  while (pts_remaining_samples) {
1659  // Get Samples per frame (for this frame number)
1660  int samples_per_frame = Frame::GetSamplesPerFrame(previous_packet_location.frame, info.fps, info.sample_rate, info.channels);
1661 
1662  // Calculate # of samples to add to this frame
1663  int samples = samples_per_frame - previous_packet_location.sample_start;
1664  if (samples > pts_remaining_samples)
1665  samples = pts_remaining_samples;
1666 
1667  // Decrement remaining samples
1668  pts_remaining_samples -= samples;
1669 
1670  if (pts_remaining_samples > 0) {
1671  // next frame
1672  previous_packet_location.frame++;
1673  previous_packet_location.sample_start = 0;
1674  } else {
1675  // Increment sample start
1676  previous_packet_location.sample_start += samples;
1677  }
1678  }
1679 
1680  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ProcessAudioPacket (ReSample)",
1681  "packet_samples", packet_samples,
1682  "info.channels", info.channels,
1683  "info.sample_rate", info.sample_rate,
1684  "aCodecCtx->sample_fmt", AV_GET_SAMPLE_FORMAT(aStream, aCodecCtx));
1685 
1686  // Create output frame
1687  AVFrame *audio_converted = AV_ALLOCATE_FRAME();
1688  AV_RESET_FRAME(audio_converted);
1689  audio_converted->nb_samples = audio_frame->nb_samples;
1690  av_samples_alloc(audio_converted->data, audio_converted->linesize, info.channels, audio_frame->nb_samples, AV_SAMPLE_FMT_FLTP, 0);
1691 
1692  SWRCONTEXT *avr = NULL;
1693 
1694  // setup resample context
1695  avr = SWR_ALLOC();
1696 #if HAVE_CH_LAYOUT
1697  av_opt_set_chlayout(avr, "in_chlayout", &AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->ch_layout, 0);
1698  av_opt_set_chlayout(avr, "out_chlayout", &AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->ch_layout, 0);
1699 #else
1700  av_opt_set_int(avr, "in_channel_layout", AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->channel_layout, 0);
1701  av_opt_set_int(avr, "out_channel_layout", AV_GET_CODEC_ATTRIBUTES(aStream, aCodecCtx)->channel_layout, 0);
1702  av_opt_set_int(avr, "in_channels", info.channels, 0);
1703  av_opt_set_int(avr, "out_channels", info.channels, 0);
1704 #endif
1705  av_opt_set_int(avr, "in_sample_fmt", AV_GET_SAMPLE_FORMAT(aStream, aCodecCtx), 0);
1706  av_opt_set_int(avr, "out_sample_fmt", AV_SAMPLE_FMT_FLTP, 0);
1707  av_opt_set_int(avr, "in_sample_rate", info.sample_rate, 0);
1708  av_opt_set_int(avr, "out_sample_rate", info.sample_rate, 0);
1709  SWR_INIT(avr);
1710 
1711  // Convert audio samples
1712  int nb_samples = SWR_CONVERT(avr, // audio resample context
1713  audio_converted->data, // output data pointers
1714  audio_converted->linesize[0], // output plane size, in bytes. (0 if unknown)
1715  audio_converted->nb_samples, // maximum number of samples that the output buffer can hold
1716  audio_frame->data, // input data pointers
1717  audio_frame->linesize[0], // input plane size, in bytes (0 if unknown)
1718  audio_frame->nb_samples); // number of input samples to convert
1719 
1720  // Deallocate resample buffer
1721  SWR_CLOSE(avr);
1722  SWR_FREE(&avr);
1723  avr = NULL;
1724 
1725  int64_t starting_frame_number = -1;
1726  for (int channel_filter = 0; channel_filter < info.channels; channel_filter++) {
1727  // Array of floats (to hold samples for each channel)
1728  starting_frame_number = location.frame;
1729  int channel_buffer_size = nb_samples;
1730  auto *channel_buffer = (float *) (audio_converted->data[channel_filter]);
1731 
1732  // Loop through samples, and add them to the correct frames
1733  int start = location.sample_start;
1734  int remaining_samples = channel_buffer_size;
1735  while (remaining_samples > 0) {
1736  // Get Samples per frame (for this frame number)
1737  int samples_per_frame = Frame::GetSamplesPerFrame(starting_frame_number, info.fps, info.sample_rate, info.channels);
1738 
1739  // Calculate # of samples to add to this frame
1740  int samples = std::fmin(samples_per_frame - start, remaining_samples);
1741 
1742  // Create or get the existing frame object
1743  std::shared_ptr<Frame> f = CreateFrame(starting_frame_number);
1744 
1745  // Add samples for current channel to the frame.
1746  f->AddAudio(true, channel_filter, start, channel_buffer, samples, 1.0f);
1747 
1748  // Debug output
1749  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ProcessAudioPacket (f->AddAudio)",
1750  "frame", starting_frame_number,
1751  "start", start,
1752  "samples", samples,
1753  "channel", channel_filter,
1754  "samples_per_frame", samples_per_frame);
1755 
1756  // Add or update cache
1757  working_cache.Add(f);
1758 
1759  // Decrement remaining samples
1760  remaining_samples -= samples;
1761 
1762  // Increment buffer (to next set of samples)
1763  if (remaining_samples > 0)
1764  channel_buffer += samples;
1765 
1766  // Increment frame number
1767  starting_frame_number++;
1768 
1769  // Reset starting sample #
1770  start = 0;
1771  }
1772  }
1773 
1774  // Free AVFrames
1775  av_free(audio_converted->data[0]);
1776  AV_FREE_FRAME(&audio_converted);
1777  AV_FREE_FRAME(&audio_frame);
1778 
1779  // Get audio PTS in seconds
1780  audio_pts_seconds = (double(audio_pts) * info.audio_timebase.ToDouble()) + pts_offset_seconds;
1781 
1782  // Debug output
1783  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::ProcessAudioPacket (After)",
1784  "requested_frame", requested_frame,
1785  "starting_frame", location.frame,
1786  "end_frame", starting_frame_number - 1,
1787  "audio_pts_seconds", audio_pts_seconds);
1788 
1789 }
1790 
1791 
1792 // Seek to a specific frame. This is not always frame accurate, it's more of an estimation on many codecs.
1793 void FFmpegReader::Seek(int64_t requested_frame) {
1794  // Adjust for a requested frame that is too small or too large
1795  if (requested_frame < 1)
1796  requested_frame = 1;
1797  if (requested_frame > info.video_length)
1798  requested_frame = info.video_length;
1799  if (requested_frame > largest_frame_processed && packet_status.end_of_file) {
1800  // Not possible to search past largest_frame once EOF is reached (no more packets)
1801  return;
1802  }
1803 
1804  // Debug output
1805  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::Seek",
1806  "requested_frame", requested_frame,
1807  "seek_count", seek_count,
1808  "last_frame", last_frame);
1809 
1810  // Clear working cache (since we are seeking to another location in the file)
1811  working_cache.Clear();
1812 
1813  // Reset the last frame variable
1814  video_pts = 0.0;
1815  video_pts_seconds = NO_PTS_OFFSET;
1816  audio_pts = 0.0;
1817  audio_pts_seconds = NO_PTS_OFFSET;
1818  hold_packet = false;
1819  last_frame = 0;
1820  current_video_frame = 0;
1821  largest_frame_processed = 0;
1822  bool has_audio_override = info.has_audio;
1823  bool has_video_override = info.has_video;
1824 
1825  // Init end-of-file detection variables
1826  packet_status.reset(false);
1827 
1828  // Increment seek count
1829  seek_count++;
1830 
1831  // If seeking near frame 1, we need to close and re-open the file (this is more reliable than seeking)
1832  int buffer_amount = std::max(max_concurrent_frames, 8);
1833  if (requested_frame - buffer_amount < 20) {
1834  // prevent Open() from seeking again
1835  is_seeking = true;
1836 
1837  // Close and re-open file (basically seeking to frame 1)
1838  Close();
1839  Open();
1840 
1841  // Update overrides (since closing and re-opening might update these)
1842  info.has_audio = has_audio_override;
1843  info.has_video = has_video_override;
1844 
1845  // Not actually seeking, so clear these flags
1846  is_seeking = false;
1847  if (seek_count == 1) {
1848  // Don't redefine this on multiple seek attempts for a specific frame
1849  seeking_frame = 1;
1850  seeking_pts = ConvertFrameToVideoPTS(1);
1851  }
1852  seek_audio_frame_found = 0; // used to detect which frames to throw away after a seek
1853  seek_video_frame_found = 0; // used to detect which frames to throw away after a seek
1854 
1855  } else {
1856  // Seek to nearest key-frame (aka, i-frame)
1857  bool seek_worked = false;
1858  int64_t seek_target = 0;
1859 
1860  // Seek video stream (if any), except album arts
1861  if (!seek_worked && info.has_video && !HasAlbumArt()) {
1862  seek_target = ConvertFrameToVideoPTS(requested_frame - buffer_amount);
1863  if (av_seek_frame(pFormatCtx, info.video_stream_index, seek_target, AVSEEK_FLAG_BACKWARD) < 0) {
1864  fprintf(stderr, "%s: error while seeking video stream\n", pFormatCtx->AV_FILENAME);
1865  } else {
1866  // VIDEO SEEK
1867  is_video_seek = true;
1868  seek_worked = true;
1869  }
1870  }
1871 
1872  // Seek audio stream (if not already seeked... and if an audio stream is found)
1873  if (!seek_worked && info.has_audio) {
1874  seek_target = ConvertFrameToAudioPTS(requested_frame - buffer_amount);
1875  if (av_seek_frame(pFormatCtx, info.audio_stream_index, seek_target, AVSEEK_FLAG_BACKWARD) < 0) {
1876  fprintf(stderr, "%s: error while seeking audio stream\n", pFormatCtx->AV_FILENAME);
1877  } else {
1878  // AUDIO SEEK
1879  is_video_seek = false;
1880  seek_worked = true;
1881  }
1882  }
1883 
1884  // Was the seek successful?
1885  if (seek_worked) {
1886  // Flush audio buffer
1887  if (info.has_audio)
1888  avcodec_flush_buffers(aCodecCtx);
1889 
1890  // Flush video buffer
1891  if (info.has_video)
1892  avcodec_flush_buffers(pCodecCtx);
1893 
1894  // Reset previous audio location to zero
1895  previous_packet_location.frame = -1;
1896  previous_packet_location.sample_start = 0;
1897 
1898  // init seek flags
1899  is_seeking = true;
1900  if (seek_count == 1) {
1901  // Don't redefine this on multiple seek attempts for a specific frame
1902  seeking_pts = seek_target;
1903  seeking_frame = requested_frame;
1904  }
1905  seek_audio_frame_found = 0; // used to detect which frames to throw away after a seek
1906  seek_video_frame_found = 0; // used to detect which frames to throw away after a seek
1907 
1908  } else {
1909  // seek failed
1910  seeking_pts = 0;
1911  seeking_frame = 0;
1912 
1913  // prevent Open() from seeking again
1914  is_seeking = true;
1915 
1916  // Close and re-open file (basically seeking to frame 1)
1917  Close();
1918  Open();
1919 
1920  // Not actually seeking, so clear these flags
1921  is_seeking = false;
1922 
1923  // disable seeking for this reader (since it failed)
1924  enable_seek = false;
1925 
1926  // Update overrides (since closing and re-opening might update these)
1927  info.has_audio = has_audio_override;
1928  info.has_video = has_video_override;
1929  }
1930  }
1931 }
1932 
1933 // Get the PTS for the current video packet
1934 int64_t FFmpegReader::GetPacketPTS() {
1935  if (packet) {
1936  int64_t current_pts = packet->pts;
1937  if (current_pts == AV_NOPTS_VALUE && packet->dts != AV_NOPTS_VALUE)
1938  current_pts = packet->dts;
1939 
1940  // Return adjusted PTS
1941  return current_pts;
1942  } else {
1943  // No packet, return NO PTS
1944  return AV_NOPTS_VALUE;
1945  }
1946 }
1947 
1948 // Update PTS Offset (if any)
1949 void FFmpegReader::UpdatePTSOffset() {
1950  if (pts_offset_seconds != NO_PTS_OFFSET) {
1951  // Skip this method if we have already set PTS offset
1952  return;
1953  }
1954  pts_offset_seconds = 0.0;
1955  double video_pts_offset_seconds = 0.0;
1956  double audio_pts_offset_seconds = 0.0;
1957 
1958  bool has_video_pts = false;
1959  if (!info.has_video) {
1960  // Mark as checked
1961  has_video_pts = true;
1962  }
1963  bool has_audio_pts = false;
1964  if (!info.has_audio) {
1965  // Mark as checked
1966  has_audio_pts = true;
1967  }
1968 
1969  // Loop through the stream (until a packet from all streams is found)
1970  while (!has_video_pts || !has_audio_pts) {
1971  // Get the next packet (if any)
1972  if (GetNextPacket() < 0)
1973  // Break loop when no more packets found
1974  break;
1975 
1976  // Get PTS of this packet
1977  int64_t pts = GetPacketPTS();
1978 
1979  // Video packet
1980  if (!has_video_pts && packet->stream_index == videoStream) {
1981  // Get the video packet start time (in seconds)
1982  video_pts_offset_seconds = 0.0 - (video_pts * info.video_timebase.ToDouble());
1983 
1984  // Is timestamp close to zero (within X seconds)
1985  // Ignore wildly invalid timestamps (i.e. -234923423423)
1986  if (std::abs(video_pts_offset_seconds) <= 10.0) {
1987  has_video_pts = true;
1988  }
1989  }
1990  else if (!has_audio_pts && packet->stream_index == audioStream) {
1991  // Get the audio packet start time (in seconds)
1992  audio_pts_offset_seconds = 0.0 - (pts * info.audio_timebase.ToDouble());
1993 
1994  // Is timestamp close to zero (within X seconds)
1995  // Ignore wildly invalid timestamps (i.e. -234923423423)
1996  if (std::abs(audio_pts_offset_seconds) <= 10.0) {
1997  has_audio_pts = true;
1998  }
1999  }
2000  }
2001 
2002  // Do we have all valid timestamps to determine PTS offset?
2003  if (has_video_pts && has_audio_pts) {
2004  // Set PTS Offset to the smallest offset
2005  // [ video timestamp ]
2006  // [ audio timestamp ]
2007  //
2008  // ** SHIFT TIMESTAMPS TO ZERO **
2009  //
2010  //[ video timestamp ]
2011  // [ audio timestamp ]
2012  //
2013  // Since all offsets are negative at this point, we want the max value, which
2014  // represents the closest to zero
2015  pts_offset_seconds = std::max(video_pts_offset_seconds, audio_pts_offset_seconds);
2016  }
2017 }
2018 
2019 // Convert PTS into Frame Number
2020 int64_t FFmpegReader::ConvertVideoPTStoFrame(int64_t pts) {
2021  // Apply PTS offset
2022  int64_t previous_video_frame = current_video_frame;
2023 
2024  // Get the video packet start time (in seconds)
2025  double video_seconds = (double(pts) * info.video_timebase.ToDouble()) + pts_offset_seconds;
2026 
2027  // Divide by the video timebase, to get the video frame number (frame # is decimal at this point)
2028  int64_t frame = round(video_seconds * info.fps.ToDouble()) + 1;
2029 
2030  // Keep track of the expected video frame #
2031  if (current_video_frame == 0)
2032  current_video_frame = frame;
2033  else {
2034 
2035  // Sometimes frames are duplicated due to identical (or similar) timestamps
2036  if (frame == previous_video_frame) {
2037  // return -1 frame number
2038  frame = -1;
2039  } else {
2040  // Increment expected frame
2041  current_video_frame++;
2042  }
2043  }
2044 
2045  // Return frame #
2046  return frame;
2047 }
2048 
2049 // Convert Frame Number into Video PTS
2050 int64_t FFmpegReader::ConvertFrameToVideoPTS(int64_t frame_number) {
2051  // Get timestamp of this frame (in seconds)
2052  double seconds = (double(frame_number - 1) / info.fps.ToDouble()) + pts_offset_seconds;
2053 
2054  // Calculate the # of video packets in this timestamp
2055  int64_t video_pts = round(seconds / info.video_timebase.ToDouble());
2056 
2057  // Apply PTS offset (opposite)
2058  return video_pts;
2059 }
2060 
2061 // Convert Frame Number into Video PTS
2062 int64_t FFmpegReader::ConvertFrameToAudioPTS(int64_t frame_number) {
2063  // Get timestamp of this frame (in seconds)
2064  double seconds = (double(frame_number - 1) / info.fps.ToDouble()) + pts_offset_seconds;
2065 
2066  // Calculate the # of audio packets in this timestamp
2067  int64_t audio_pts = round(seconds / info.audio_timebase.ToDouble());
2068 
2069  // Apply PTS offset (opposite)
2070  return audio_pts;
2071 }
2072 
2073 // Calculate Starting video frame and sample # for an audio PTS
2074 AudioLocation FFmpegReader::GetAudioPTSLocation(int64_t pts) {
2075  // Get the audio packet start time (in seconds)
2076  double audio_seconds = (double(pts) * info.audio_timebase.ToDouble()) + pts_offset_seconds;
2077 
2078  // Divide by the video timebase, to get the video frame number (frame # is decimal at this point)
2079  double frame = (audio_seconds * info.fps.ToDouble()) + 1;
2080 
2081  // Frame # as a whole number (no more decimals)
2082  int64_t whole_frame = int64_t(frame);
2083 
2084  // Remove the whole number, and only get the decimal of the frame
2085  double sample_start_percentage = frame - double(whole_frame);
2086 
2087  // Get Samples per frame
2088  int samples_per_frame = Frame::GetSamplesPerFrame(whole_frame, info.fps, info.sample_rate, info.channels);
2089 
2090  // Calculate the sample # to start on
2091  int sample_start = round(double(samples_per_frame) * sample_start_percentage);
2092 
2093  // Protect against broken (i.e. negative) timestamps
2094  if (whole_frame < 1)
2095  whole_frame = 1;
2096  if (sample_start < 0)
2097  sample_start = 0;
2098 
2099  // Prepare final audio packet location
2100  AudioLocation location = {whole_frame, sample_start};
2101 
2102  // Compare to previous audio packet (and fix small gaps due to varying PTS timestamps)
2103  if (previous_packet_location.frame != -1) {
2104  if (location.is_near(previous_packet_location, samples_per_frame, samples_per_frame)) {
2105  int64_t orig_frame = location.frame;
2106  int orig_start = location.sample_start;
2107 
2108  // Update sample start, to prevent gaps in audio
2109  location.sample_start = previous_packet_location.sample_start;
2110  location.frame = previous_packet_location.frame;
2111 
2112  // Debug output
2113  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::GetAudioPTSLocation (Audio Gap Detected)", "Source Frame", orig_frame, "Source Audio Sample", orig_start, "Target Frame", location.frame, "Target Audio Sample", location.sample_start, "pts", pts);
2114 
2115  } else {
2116  // Debug output
2117  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::GetAudioPTSLocation (Audio Gap Ignored - too big)", "Previous location frame", previous_packet_location.frame, "Target Frame", location.frame, "Target Audio Sample", location.sample_start, "pts", pts);
2118  }
2119  }
2120 
2121  // Set previous location
2122  previous_packet_location = location;
2123 
2124  // Return the associated video frame and starting sample #
2125  return location;
2126 }
2127 
2128 // Create a new Frame (or return an existing one) and add it to the working queue.
2129 std::shared_ptr<Frame> FFmpegReader::CreateFrame(int64_t requested_frame) {
2130  // Check working cache
2131  std::shared_ptr<Frame> output = working_cache.GetFrame(requested_frame);
2132 
2133  if (!output) {
2134  // (re-)Check working cache
2135  output = working_cache.GetFrame(requested_frame);
2136  if(output) return output;
2137 
2138  // Create a new frame on the working cache
2139  output = std::make_shared<Frame>(requested_frame, info.width, info.height, "#000000", Frame::GetSamplesPerFrame(requested_frame, info.fps, info.sample_rate, info.channels), info.channels);
2140  output->SetPixelRatio(info.pixel_ratio.num, info.pixel_ratio.den); // update pixel ratio
2141  output->ChannelsLayout(info.channel_layout); // update audio channel layout from the parent reader
2142  output->SampleRate(info.sample_rate); // update the frame's sample rate of the parent reader
2143 
2144  working_cache.Add(output);
2145 
2146  // Set the largest processed frame (if this is larger)
2147  if (requested_frame > largest_frame_processed)
2148  largest_frame_processed = requested_frame;
2149  }
2150  // Return frame
2151  return output;
2152 }
2153 
2154 // Determine if frame is partial due to seek
2155 bool FFmpegReader::IsPartialFrame(int64_t requested_frame) {
2156 
2157  // Sometimes a seek gets partial frames, and we need to remove them
2158  bool seek_trash = false;
2159  int64_t max_seeked_frame = seek_audio_frame_found; // determine max seeked frame
2160  if (seek_video_frame_found > max_seeked_frame) {
2161  max_seeked_frame = seek_video_frame_found;
2162  }
2163  if ((info.has_audio && seek_audio_frame_found && max_seeked_frame >= requested_frame) ||
2164  (info.has_video && seek_video_frame_found && max_seeked_frame >= requested_frame)) {
2165  seek_trash = true;
2166  }
2167 
2168  return seek_trash;
2169 }
2170 
2171 // Check the working queue, and move finished frames to the finished queue
2172 void FFmpegReader::CheckWorkingFrames(int64_t requested_frame) {
2173 
2174  // Prevent async calls to the following code
2175  const std::lock_guard<std::recursive_mutex> lock(getFrameMutex);
2176 
2177  // Get a list of current working queue frames in the cache (in-progress frames)
2178  std::vector<std::shared_ptr<openshot::Frame>> working_frames = working_cache.GetFrames();
2179  std::vector<std::shared_ptr<openshot::Frame>>::iterator working_itr;
2180 
2181  // Loop through all working queue frames (sorted by frame #)
2182  for(working_itr = working_frames.begin(); working_itr != working_frames.end(); ++working_itr)
2183  {
2184  // Get working frame
2185  std::shared_ptr<Frame> f = *working_itr;
2186 
2187  // Was a frame found? Is frame requested yet?
2188  if (!f || f->number > requested_frame) {
2189  // If not, skip to next one
2190  continue;
2191  }
2192 
2193  // Calculate PTS in seconds (of working frame), and the most recent processed pts value
2194  double frame_pts_seconds = (double(f->number - 1) / info.fps.ToDouble()) + pts_offset_seconds;
2195  double recent_pts_seconds = std::max(video_pts_seconds, audio_pts_seconds);
2196 
2197  // Determine if video and audio are ready (based on timestamps)
2198  bool is_video_ready = false;
2199  bool is_audio_ready = false;
2200  double recent_pts_diff = recent_pts_seconds - frame_pts_seconds;
2201  if ((frame_pts_seconds <= video_pts_seconds)
2202  || (recent_pts_diff > 1.5)
2203  || packet_status.video_eof || packet_status.end_of_file) {
2204  // Video stream is past this frame (so it must be done)
2205  // OR video stream is too far behind, missing, or end-of-file
2206  is_video_ready = true;
2207  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::CheckWorkingFrames (video ready)",
2208  "frame_number", f->number,
2209  "frame_pts_seconds", frame_pts_seconds,
2210  "video_pts_seconds", video_pts_seconds,
2211  "recent_pts_diff", recent_pts_diff);
2212  if (info.has_video && !f->has_image_data) {
2213  // Frame has no image data (copy from previous frame)
2214  // Loop backwards through final frames (looking for the nearest, previous frame image)
2215  for (int64_t previous_frame = requested_frame - 1; previous_frame > 0; previous_frame--) {
2216  std::shared_ptr<Frame> previous_frame_instance = final_cache.GetFrame(previous_frame);
2217  if (previous_frame_instance && previous_frame_instance->has_image_data) {
2218  // Copy image from last decoded frame
2219  f->AddImage(std::make_shared<QImage>(previous_frame_instance->GetImage()->copy()));
2220  break;
2221  }
2222  }
2223 
2224  if (last_video_frame && !f->has_image_data) {
2225  // Copy image from last decoded frame
2226  f->AddImage(std::make_shared<QImage>(last_video_frame->GetImage()->copy()));
2227  } else if (!f->has_image_data) {
2228  f->AddColor("#000000");
2229  }
2230  }
2231  }
2232 
2233  double audio_pts_diff = audio_pts_seconds - frame_pts_seconds;
2234  if ((frame_pts_seconds < audio_pts_seconds && audio_pts_diff > 1.0)
2235  || (recent_pts_diff > 1.5)
2236  || packet_status.audio_eof || packet_status.end_of_file) {
2237  // Audio stream is past this frame (so it must be done)
2238  // OR audio stream is too far behind, missing, or end-of-file
2239  // Adding a bit of margin here, to allow for partial audio packets
2240  is_audio_ready = true;
2241  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::CheckWorkingFrames (audio ready)",
2242  "frame_number", f->number,
2243  "frame_pts_seconds", frame_pts_seconds,
2244  "audio_pts_seconds", audio_pts_seconds,
2245  "audio_pts_diff", audio_pts_diff,
2246  "recent_pts_diff", recent_pts_diff);
2247  }
2248  bool is_seek_trash = IsPartialFrame(f->number);
2249 
2250  // Adjust for available streams
2251  if (!info.has_video) is_video_ready = true;
2252  if (!info.has_audio) is_audio_ready = true;
2253 
2254  // Debug output
2255  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::CheckWorkingFrames",
2256  "frame_number", f->number,
2257  "is_video_ready", is_video_ready,
2258  "is_audio_ready", is_audio_ready,
2259  "video_eof", packet_status.video_eof,
2260  "audio_eof", packet_status.audio_eof,
2261  "end_of_file", packet_status.end_of_file);
2262 
2263  // Check if working frame is final
2264  if ((!packet_status.end_of_file && is_video_ready && is_audio_ready) || packet_status.end_of_file || is_seek_trash) {
2265  // Debug output
2266  ZmqLogger::Instance()->AppendDebugMethod("FFmpegReader::CheckWorkingFrames (mark frame as final)",
2267  "requested_frame", requested_frame,
2268  "f->number", f->number,
2269  "is_seek_trash", is_seek_trash,
2270  "Working Cache Count", working_cache.Count(),
2271  "Final Cache Count", final_cache.Count(),
2272  "end_of_file", packet_status.end_of_file);
2273 
2274  if (!is_seek_trash) {
2275  // Move frame to final cache
2276  final_cache.Add(f);
2277 
2278  // Remove frame from working cache
2279  working_cache.Remove(f->number);
2280 
2281  // Update last frame processed
2282  last_frame = f->number;
2283  } else {
2284  // Seek trash, so delete the frame from the working cache, and never add it to the final cache.
2285  working_cache.Remove(f->number);
2286  }
2287 
2288  }
2289  }
2290 
2291  // Clear vector of frames
2292  working_frames.clear();
2293  working_frames.shrink_to_fit();
2294 }
2295 
2296 // Check for the correct frames per second (FPS) value by scanning the 1st few seconds of video packets.
2297 void FFmpegReader::CheckFPS() {
2298  if (check_fps) {
2299  // Do not check FPS more than 1 time
2300  return;
2301  } else {
2302  check_fps = true;
2303  }
2304 
2305  int frames_per_second[3] = {0,0,0};
2306  int max_fps_index = sizeof(frames_per_second) / sizeof(frames_per_second[0]);
2307  int fps_index = 0;
2308 
2309  int all_frames_detected = 0;
2310  int starting_frames_detected = 0;
2311 
2312  // Loop through the stream
2313  while (true) {
2314  // Get the next packet (if any)
2315  if (GetNextPacket() < 0)
2316  // Break loop when no more packets found
2317  break;
2318 
2319  // Video packet
2320  if (packet->stream_index == videoStream) {
2321  // Get the video packet start time (in seconds)
2322  double video_seconds = (double(GetPacketPTS()) * info.video_timebase.ToDouble()) + pts_offset_seconds;
2323  fps_index = int(video_seconds); // truncate float timestamp to int (second 1, second 2, second 3)
2324 
2325  // Is this video packet from the first few seconds?
2326  if (fps_index >= 0 && fps_index < max_fps_index) {
2327  // Yes, keep track of how many frames per second (over the first few seconds)
2328  starting_frames_detected++;
2329  frames_per_second[fps_index]++;
2330  }
2331 
2332  // Track all video packets detected
2333  all_frames_detected++;
2334  }
2335  }
2336 
2337  // Calculate FPS (based on the first few seconds of video packets)
2338  float avg_fps = 30.0;
2339  if (starting_frames_detected > 0 && fps_index > 0) {
2340  avg_fps = float(starting_frames_detected) / std::min(fps_index, max_fps_index);
2341  }
2342 
2343  // Verify average FPS is a reasonable value
2344  if (avg_fps < 8.0) {
2345  // Invalid FPS assumed, so switching to a sane default FPS instead
2346  avg_fps = 30.0;
2347  }
2348 
2349  // Update FPS (truncate average FPS to Integer)
2350  info.fps = Fraction(int(avg_fps), 1);
2351 
2352  // Update Duration and Length
2353  if (all_frames_detected > 0) {
2354  // Use all video frames detected to calculate # of frames
2355  info.video_length = all_frames_detected;
2356  info.duration = all_frames_detected / avg_fps;
2357  } else {
2358  // Use previous duration to calculate # of frames
2359  info.video_length = info.duration * avg_fps;
2360  }
2361 
2362  // Update video bit rate
2364 }
2365 
2366 // Remove AVFrame from cache (and deallocate its memory)
2367 void FFmpegReader::RemoveAVFrame(AVFrame *remove_frame) {
2368  // Remove pFrame (if exists)
2369  if (remove_frame) {
2370  // Free memory
2371  av_freep(&remove_frame->data[0]);
2372 #ifndef WIN32
2373  AV_FREE_FRAME(&remove_frame);
2374 #endif
2375  }
2376 }
2377 
2378 // Remove AVPacket from cache (and deallocate its memory)
2379 void FFmpegReader::RemoveAVPacket(AVPacket *remove_packet) {
2380  // deallocate memory for packet
2381  AV_FREE_PACKET(remove_packet);
2382 
2383  // Delete the object
2384  delete remove_packet;
2385 }
2386 
2387 // Generate JSON string of this object
2388 std::string FFmpegReader::Json() const {
2389 
2390  // Return formatted string
2391  return JsonValue().toStyledString();
2392 }
2393 
2394 // Generate Json::Value for this object
2395 Json::Value FFmpegReader::JsonValue() const {
2396 
2397  // Create root json object
2398  Json::Value root = ReaderBase::JsonValue(); // get parent properties
2399  root["type"] = "FFmpegReader";
2400  root["path"] = path;
2401 
2402  // return JsonValue
2403  return root;
2404 }
2405 
2406 // Load JSON string into this object
2407 void FFmpegReader::SetJson(const std::string value) {
2408 
2409  // Parse JSON string into JSON objects
2410  try {
2411  const Json::Value root = openshot::stringToJson(value);
2412  // Set all values that match
2413  SetJsonValue(root);
2414  }
2415  catch (const std::exception& e) {
2416  // Error parsing JSON (or missing keys)
2417  throw InvalidJSON("JSON is invalid (missing keys or invalid data types)");
2418  }
2419 }
2420 
2421 // Load Json::Value into this object
2422 void FFmpegReader::SetJsonValue(const Json::Value root) {
2423 
2424  // Set parent data
2426 
2427  // Set data from Json (if key is found)
2428  if (!root["path"].isNull())
2429  path = root["path"].asString();
2430 
2431  // Re-Open path, and re-init everything (if needed)
2432  if (is_open) {
2433  Close();
2434  Open();
2435  }
2436 }
openshot::stringToJson
const Json::Value stringToJson(const std::string value)
Definition: Json.cpp:16
openshot::CacheMemory::Clear
void Clear()
Clear the cache of all frames.
Definition: CacheMemory.cpp:221
AV_FIND_DECODER_CODEC_ID
#define AV_FIND_DECODER_CODEC_ID(av_stream)
Definition: FFmpegUtilities.h:206
openshot::ReaderInfo::sample_rate
int sample_rate
The number of audio samples per second (44100 is a common sample rate)
Definition: ReaderBase.h:60
openshot::FFmpegReader::FFmpegReader
FFmpegReader(const std::string &path, bool inspect_reader=true)
Constructor for FFmpegReader.
Definition: FFmpegReader.cpp:71
openshot::Fraction::ToFloat
float ToFloat()
Return this fraction as a float (i.e. 1/2 = 0.5)
Definition: Fraction.cpp:35
openshot::Settings::HARDWARE_DECODER
int HARDWARE_DECODER
Use video codec for faster video decoding (if supported)
Definition: Settings.h:62
openshot::Coordinate::Y
double Y
The Y value of the coordinate (usually representing the value of the property being animated)
Definition: Coordinate.h:41
openshot::CacheMemory::Count
int64_t Count()
Count the frames in the queue.
Definition: CacheMemory.cpp:235
FFmpegUtilities.h
Header file for FFmpegUtilities.
openshot::ReaderBase::JsonValue
virtual Json::Value JsonValue() const =0
Generate Json::Value for this object.
Definition: ReaderBase.cpp:107
openshot::InvalidCodec
Exception when no valid codec is found for a file.
Definition: Exceptions.h:172
openshot::TimelineBase::preview_width
int preview_width
Optional preview width of timeline image. If your preview window is smaller than the timeline,...
Definition: TimelineBase.h:44
openshot::PacketStatus::reset
void reset(bool eof)
Definition: FFmpegReader.h:68
openshot::CacheMemory::GetFrame
std::shared_ptr< openshot::Frame > GetFrame(int64_t frame_number)
Get a frame from the cache.
Definition: CacheMemory.cpp:80
openshot::FFmpegReader::GetFrame
std::shared_ptr< openshot::Frame > GetFrame(int64_t requested_frame) override
Definition: FFmpegReader.cpp:928
AV_COPY_PICTURE_DATA
#define AV_COPY_PICTURE_DATA(av_frame, buffer, pix_fmt, width, height)
Definition: FFmpegUtilities.h:218
openshot::CacheMemory::Add
void Add(std::shared_ptr< openshot::Frame > frame)
Add a Frame to the cache.
Definition: CacheMemory.cpp:46
PixelFormat
#define PixelFormat
Definition: FFmpegUtilities.h:102
AV_ALLOCATE_FRAME
#define AV_ALLOCATE_FRAME()
Definition: FFmpegUtilities.h:198
openshot::ReaderBase::SetJsonValue
virtual void SetJsonValue(const Json::Value root)=0
Load Json::Value into this object.
Definition: ReaderBase.cpp:162
SWR_CONVERT
#define SWR_CONVERT(ctx, out, linesize, out_count, in, linesize2, in_count)
Definition: FFmpegUtilities.h:144
openshot
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:28
openshot::Point::co
Coordinate co
This is the primary coordinate.
Definition: Point.h:66
FF_NUM_PROCESSORS
#define FF_NUM_PROCESSORS
Definition: OpenMPUtilities.h:24
openshot::Clip::scale_y
openshot::Keyframe scale_y
Curve representing the vertical scaling in percent (0 to 1)
Definition: Clip.h:307
openshot::AudioLocation
This struct holds the associated video frame and starting sample # for an audio packet.
Definition: AudioLocation.h:25
openshot::AudioLocation::frame
int64_t frame
Definition: AudioLocation.h:26
openshot::Clip
This class represents a clip (used to arrange readers on the timeline)
Definition: Clip.h:89
openshot::Fraction
This class represents a fraction.
Definition: Fraction.h:30
openshot::AudioLocation::sample_start
int sample_start
Definition: AudioLocation.h:27
AV_FREE_FRAME
#define AV_FREE_FRAME(av_frame)
Definition: FFmpegUtilities.h:202
openshot::Keyframe::GetMaxPoint
Point GetMaxPoint() const
Get max point (by Y coordinate)
Definition: KeyFrame.cpp:245
openshot::ReaderBase::info
openshot::ReaderInfo info
Information about the current media file.
Definition: ReaderBase.h:88
openshot::ReaderInfo::interlaced_frame
bool interlaced_frame
Definition: ReaderBase.h:56
Timeline.h
Header file for Timeline class.
openshot::Clip::ParentTimeline
void ParentTimeline(openshot::TimelineBase *new_timeline) override
Set associated Timeline pointer.
Definition: Clip.cpp:383
openshot::FFmpegReader::~FFmpegReader
virtual ~FFmpegReader()
Destructor.
Definition: FFmpegReader.cpp:100
openshot::ReaderInfo::audio_bit_rate
int audio_bit_rate
The bit rate of the audio stream (in bytes)
Definition: ReaderBase.h:59
openshot::CacheMemory::Remove
void Remove(int64_t frame_number)
Remove a specific frame.
Definition: CacheMemory.cpp:154
AV_FREE_PACKET
#define AV_FREE_PACKET(av_packet)
Definition: FFmpegUtilities.h:203
openshot::ReaderInfo::duration
float duration
Length of time (in seconds)
Definition: ReaderBase.h:43
openshot::ReaderInfo::has_video
bool has_video
Determines if this file has a video stream.
Definition: ReaderBase.h:40
openshot::FFmpegReader::JsonValue
Json::Value JsonValue() const override
Generate Json::Value for this object.
Definition: FFmpegReader.cpp:2395
openshot::PacketStatus::audio_read
int64_t audio_read
Definition: FFmpegReader.h:49
openshot::ReaderInfo::width
int width
The width of the video (in pixesl)
Definition: ReaderBase.h:46
openshot::LAYOUT_STEREO
@ LAYOUT_STEREO
Definition: ChannelLayouts.h:31
openshot::FFmpegReader::SetJson
void SetJson(const std::string value) override
Load JSON string into this object.
Definition: FFmpegReader.cpp:2407
openshot::PacketStatus::packets_eof
bool packets_eof
Definition: FFmpegReader.h:55
hw_de_av_pix_fmt_global
AVPixelFormat hw_de_av_pix_fmt_global
Definition: FFmpegReader.cpp:67
openshot::PacketStatus::audio_decoded
int64_t audio_decoded
Definition: FFmpegReader.h:50
openshot::Fraction::ToDouble
double ToDouble() const
Return this fraction as a double (i.e. 1/2 = 0.5)
Definition: Fraction.cpp:40
openshot::PacketStatus::video_read
int64_t video_read
Definition: FFmpegReader.h:47
hw_de_on
int hw_de_on
Definition: FFmpegReader.cpp:65
openshot::CacheBase::SetMaxBytesFromInfo
void SetMaxBytesFromInfo(int64_t number_of_frames, int width, int height, int sample_rate, int channels)
Set maximum bytes to a different amount based on a ReaderInfo struct.
Definition: CacheBase.cpp:30
openshot::LAYOUT_MONO
@ LAYOUT_MONO
Definition: ChannelLayouts.h:30
openshot::Clip::scale_x
openshot::Keyframe scale_x
Curve representing the horizontal scaling in percent (0 to 1)
Definition: Clip.h:306
AV_GET_CODEC_ATTRIBUTES
#define AV_GET_CODEC_ATTRIBUTES(av_stream, av_context)
Definition: FFmpegUtilities.h:213
openshot::ReaderInfo::video_length
int64_t video_length
The number of frames in the video stream.
Definition: ReaderBase.h:53
hw_de_av_device_type_global
AVHWDeviceType hw_de_av_device_type_global
Definition: FFmpegReader.cpp:68
openshot::ReaderInfo::height
int height
The height of the video (in pixels)
Definition: ReaderBase.h:45
openshot::PacketStatus::video_eof
bool video_eof
Definition: FFmpegReader.h:53
openshot::Fraction::num
int num
Numerator for the fraction.
Definition: Fraction.h:32
if
if(!codec) codec
ZmqLogger.h
Header file for ZeroMQ-based Logger class.
openshot::Fraction::den
int den
Denominator for the fraction.
Definition: Fraction.h:33
OPEN_MP_NUM_PROCESSORS
#define OPEN_MP_NUM_PROCESSORS
Definition: OpenMPUtilities.h:23
AV_RESET_FRAME
#define AV_RESET_FRAME(av_frame)
Definition: FFmpegUtilities.h:201
openshot::AudioLocation::is_near
bool is_near(AudioLocation location, int samples_per_frame, int64_t amount)
Definition: FFmpegReader.cpp:107
SWR_CLOSE
#define SWR_CLOSE(ctx)
Definition: FFmpegUtilities.h:147
openshot::ReaderInfo::has_audio
bool has_audio
Determines if this file has an audio stream.
Definition: ReaderBase.h:41
openshot::Settings::DE_LIMIT_HEIGHT_MAX
int DE_LIMIT_HEIGHT_MAX
Maximum rows that hardware decode can handle.
Definition: Settings.h:74
openshot::InvalidJSON
Exception for invalid JSON.
Definition: Exceptions.h:217
openshot::FFmpegReader::enable_seek
bool enable_seek
Definition: FFmpegReader.h:232
openshot::ReaderInfo::file_size
int64_t file_size
Size of file (in bytes)
Definition: ReaderBase.h:44
openshot::Timeline
This class represents a timeline.
Definition: Timeline.h:148
openshot::FFmpegReader::Open
void Open() override
Open File - which is called by the constructor automatically.
Definition: FFmpegReader.cpp:207
openshot::OutOfMemory
Exception when memory could not be allocated.
Definition: Exceptions.h:348
openshot::SCALE_CROP
@ SCALE_CROP
Scale the clip until both height and width fill the canvas (cropping the overlap)
Definition: Enums.h:37
SWR_INIT
#define SWR_INIT(ctx)
Definition: FFmpegUtilities.h:149
SWRCONTEXT
#define SWRCONTEXT
Definition: FFmpegUtilities.h:150
openshot::PacketStatus::audio_eof
bool audio_eof
Definition: FFmpegReader.h:54
openshot::ReaderInfo::has_single_image
bool has_single_image
Determines if this file only contains a single image.
Definition: ReaderBase.h:42
openshot::FFmpegReader::final_cache
CacheMemory final_cache
Final cache object used to hold final frames.
Definition: FFmpegReader.h:228
openshot::ReaderInfo::video_timebase
openshot::Fraction video_timebase
The video timebase determines how long each frame stays on the screen.
Definition: ReaderBase.h:55
openshot::Settings::Instance
static Settings * Instance()
Create or get an instance of this logger singleton (invoke the class with this method)
Definition: Settings.cpp:23
openshot::ReaderInfo::metadata
std::map< std::string, std::string > metadata
An optional map/dictionary of metadata for this reader.
Definition: ReaderBase.h:65
path
path
Definition: FFmpegWriter.cpp:1476
openshot::Frame::GetSamplesPerFrame
int GetSamplesPerFrame(openshot::Fraction fps, int sample_rate, int channels)
Calculate the # of samples per video frame (for the current frame number)
Definition: Frame.cpp:484
openshot::InvalidFile
Exception for files that can not be found or opened.
Definition: Exceptions.h:187
openshot::ReaderInfo::audio_stream_index
int audio_stream_index
The index of the audio stream.
Definition: ReaderBase.h:63
openshot::ZmqLogger::Instance
static ZmqLogger * Instance()
Create or get an instance of this logger singleton (invoke the class with this method)
Definition: ZmqLogger.cpp:35
openshot::ReaderInfo::audio_timebase
openshot::Fraction audio_timebase
The audio timebase determines how long each audio packet should be played.
Definition: ReaderBase.h:64
openshot::FFmpegReader::Close
void Close() override
Close File.
Definition: FFmpegReader.cpp:586
openshot::SCALE_FIT
@ SCALE_FIT
Scale the clip until either height or width fills the canvas (with no cropping)
Definition: Enums.h:38
openshot::PacketStatus::packets_read
int64_t packets_read()
Definition: FFmpegReader.h:58
openshot::ReaderInfo::pixel_format
int pixel_format
The pixel format (i.e. YUV420P, RGB24, etc...)
Definition: ReaderBase.h:47
openshot::ZmqLogger::AppendDebugMethod
void AppendDebugMethod(std::string method_name, std::string arg1_name="", float arg1_value=-1.0, std::string arg2_name="", float arg2_value=-1.0, std::string arg3_name="", float arg3_value=-1.0, std::string arg4_name="", float arg4_value=-1.0, std::string arg5_name="", float arg5_value=-1.0, std::string arg6_name="", float arg6_value=-1.0)
Append debug information.
Definition: ZmqLogger.cpp:178
openshot::ReaderInfo::vcodec
std::string vcodec
The name of the video codec used to encode / decode the video stream.
Definition: ReaderBase.h:52
openshot::PacketStatus::packets_decoded
int64_t packets_decoded()
Definition: FFmpegReader.h:63
AV_GET_CODEC_TYPE
#define AV_GET_CODEC_TYPE(av_stream)
Definition: FFmpegUtilities.h:205
openshot::ReaderClosed
Exception when a reader is closed, and a frame is requested.
Definition: Exceptions.h:363
openshot::ReaderInfo::channel_layout
openshot::ChannelLayout channel_layout
The channel layout (mono, stereo, 5 point surround, etc...)
Definition: ReaderBase.h:62
AV_FREE_CONTEXT
#define AV_FREE_CONTEXT(av_context)
Definition: FFmpegUtilities.h:204
PIX_FMT_RGBA
#define PIX_FMT_RGBA
Definition: FFmpegUtilities.h:105
AV_GET_CODEC_PIXEL_FORMAT
#define AV_GET_CODEC_PIXEL_FORMAT(av_stream, av_context)
Definition: FFmpegUtilities.h:214
AVCODEC_REGISTER_ALL
#define AVCODEC_REGISTER_ALL
Definition: FFmpegUtilities.h:194
SWR_FREE
#define SWR_FREE(ctx)
Definition: FFmpegUtilities.h:148
openshot::Settings::DE_LIMIT_WIDTH_MAX
int DE_LIMIT_WIDTH_MAX
Maximum columns that hardware decode can handle.
Definition: Settings.h:77
openshot::ReaderInfo::fps
openshot::Fraction fps
Frames per second, as a fraction (i.e. 24/1 = 24 fps)
Definition: ReaderBase.h:48
AV_GET_SAMPLE_FORMAT
#define AV_GET_SAMPLE_FORMAT(av_stream, av_context)
Definition: FFmpegUtilities.h:216
openshot::ReaderInfo::video_bit_rate
int video_bit_rate
The bit rate of the video stream (in bytes)
Definition: ReaderBase.h:49
openshot::PacketStatus::end_of_file
bool end_of_file
Definition: FFmpegReader.h:56
openshot::Clip::scale
openshot::ScaleType scale
The scale determines how a clip should be resized to fit its parent.
Definition: Clip.h:168
openshot::ReaderInfo::top_field_first
bool top_field_first
Definition: ReaderBase.h:57
openshot::ChannelLayout
ChannelLayout
This enumeration determines the audio channel layout (such as stereo, mono, 5 point surround,...
Definition: ChannelLayouts.h:28
SWR_ALLOC
#define SWR_ALLOC()
Definition: FFmpegUtilities.h:146
openshot::ReaderInfo::pixel_ratio
openshot::Fraction pixel_ratio
The pixel ratio of the video stream as a fraction (i.e. some pixels are not square)
Definition: ReaderBase.h:50
AV_REGISTER_ALL
#define AV_REGISTER_ALL
Definition: FFmpegUtilities.h:193
openshot::CacheMemory::GetFrames
std::vector< std::shared_ptr< openshot::Frame > > GetFrames()
Get an array of all Frames.
Definition: CacheMemory.cpp:96
AV_GET_CODEC_CONTEXT
#define AV_GET_CODEC_CONTEXT(av_stream, av_codec)
Definition: FFmpegUtilities.h:207
openshot::ReaderInfo::video_stream_index
int video_stream_index
The index of the video stream.
Definition: ReaderBase.h:54
openshot::FFmpegReader::SetJsonValue
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.
Definition: FFmpegReader.cpp:2422
openshot::SCALE_STRETCH
@ SCALE_STRETCH
Scale the clip until both height and width fill the canvas (distort to fit)
Definition: Enums.h:39
openshot::ReaderInfo::acodec
std::string acodec
The name of the audio codec used to encode / decode the video stream.
Definition: ReaderBase.h:58
openshot::NoStreamsFound
Exception when no streams are found in the file.
Definition: Exceptions.h:285
openshot::ReaderInfo::display_ratio
openshot::Fraction display_ratio
The ratio of width to height of the video stream (i.e. 640x480 has a ratio of 4/3)
Definition: ReaderBase.h:51
openshot::ReaderInfo::channels
int channels
The number of audio channels used in the audio stream.
Definition: ReaderBase.h:61
openshot::FFmpegReader::Json
std::string Json() const override
Generate JSON string of this object.
Definition: FFmpegReader.cpp:2388
openshot::FFmpegReader::GetIsDurationKnown
bool GetIsDurationKnown()
Return true if frame can be read with GetFrame()
Definition: FFmpegReader.cpp:924
openshot::PacketStatus::video_decoded
int64_t video_decoded
Definition: FFmpegReader.h:48
opts
AVDictionary * opts
Definition: FFmpegWriter.cpp:1483
Exceptions.h
Header file for all Exception classes.
openshot::Settings::HW_DE_DEVICE_SET
int HW_DE_DEVICE_SET
Which GPU to use to decode (0 is the first)
Definition: Settings.h:80
FFmpegReader.h
Header file for FFmpegReader class.
openshot::ReaderBase::getFrameMutex
std::recursive_mutex getFrameMutex
Mutex for multiple threads.
Definition: ReaderBase.h:79
openshot::ReaderBase::ParentClip
openshot::ClipBase * ParentClip()
Parent clip object of this reader (which can be unparented and NULL)
Definition: ReaderBase.cpp:245