GStreamerImportFileHandle Class Reference

! Does actual import, returned by GStreamerImportPlugin::Open More...

Inheritance diagram for GStreamerImportFileHandle:

Collaboration diagram for GStreamerImportFileHandle:

Public Member Functions
	GStreamerImportFileHandle (const wxString &name)
virtual	~GStreamerImportFileHandle ()
bool	Init ()
TranslatableString	GetFileDescription () override
ByteCount	GetFileUncompressedBytes () override
wxInt32	GetStreamCount () override
const TranslatableStrings &	GetStreamInfo () override
void	SetStreamUsage (wxInt32 index, bool use) override
int	Import (TrackFactory *trackFactory, TrackHolders &outTracks, Tags *tags) override
void	OnPadAdded (GstPad *pad)
void	OnPadRemoved (GstPad *pad)
bool	ProcessBusMessage (bool &success)
void	OnTag (GstAppSink *appsink, GstTagList *tags)
void	OnNewSample (GStreamContext *c, GstSample *sample)
Public Member Functions inherited from ImportFileHandle
	ImportFileHandle (const FilePath &filename)
virtual	~ImportFileHandle ()
void	CreateProgress ()
virtual TranslatableString	GetFileDescription ()=0
virtual ByteCount	GetFileUncompressedBytes ()=0
virtual wxInt32	GetStreamCount ()=0
virtual const TranslatableStrings &	GetStreamInfo ()=0
virtual void	SetStreamUsage (wxInt32 StreamID, bool Use)=0
virtual ProgressResult	Import (WaveTrackFactory *trackFactory, TrackHolders &outTracks, Tags *tags)=0

Private Attributes
TranslatableStrings	mStreamInfo
	Array of stream descriptions. Length is the same as mStreams. More...
Tags	mTags
	Tags to be passed back to Audacity. More...
TrackFactory *	mTrackFactory
	Factory to create tracks when samples arrive. More...
GstString	mUri
	URI of file. More...
GstObjHandle< GstElement >	mPipeline
	GStreamer pipeline. More...
GstObjHandle< GstBus >	mBus
	Message bus. More...
GstElement *	mDec
	uridecodebin element More...
bool	mAsyncDone
	true = 1st async-done message received More...
GMutex	mStreamsLock
	Mutex protecting the mStreams array. More...
std::vector< std::unique_ptr< GStreamContext > >	mStreams
	Array of pointers to stream contexts. More...

Additional Inherited Members
Public Types inherited from ImportFileHandle
using	ProgressResult = BasicUI::ProgressResult
using	ByteCount = unsigned long long
Static Public Member Functions inherited from ImportFileHandle
static sampleFormat	ChooseFormat (sampleFormat effectiveFormat)
	Choose appropriate format, which will not be narrower than the specified one. More...
Protected Member Functions inherited from ImportFileHandle
std::shared_ptr< WaveTrack >	NewWaveTrack (WaveTrackFactory &trackFactory, sampleFormat effectiveFormat, double rate)
	Build a wave track with appropriate format, which will not be narrower than the specified one. More...
Protected Attributes inherited from ImportFileHandle
FilePath	mFilename
std::unique_ptr< ProgressDialog >	mProgress

Detailed Description

! Does actual import, returned by GStreamerImportPlugin::Open

An ImportFileHandle for GStreamer data.

Definition at line 158 of file ImportGStreamer.cpp.

Constructor & Destructor Documentation

GStreamerImportFileHandle()

GStreamerImportFileHandle::GStreamerImportFileHandle

(

const wxString &

name

)

Definition at line 839 of file ImportGStreamer.cpp.

:  ImportFileHandle(name)
{
   mDec = NULL;
   mTrackFactory = NULL;
   mAsyncDone = false;
 
   g_mutex_init(&mStreamsLock);
}

References mAsyncDone, mDec, mStreamsLock, and mTrackFactory.

~GStreamerImportFileHandle()

GStreamerImportFileHandle::~GStreamerImportFileHandle ( )

virtual

Definition at line 851 of file ImportGStreamer.cpp.

{
   // Make sure the pipeline isn't running
   if (mPipeline)
   {
      gst_element_set_state(mPipeline.get(), GST_STATE_NULL);
   }
 
   // Delete all of the contexts
   if (mStreams.size())
   {
      // PRL: is the FIFO destruction order important?
      // If not, then you could simply clear mStreams.
 
      {
         g_mutex_locker locker{ mStreamsLock };
         while (mStreams.size() > 0)
         {
            // remove context from the array
            mStreams.erase(mStreams.begin());
         }
      }
 
      // Done with the context array
   }
 
   // Release the decoder
   if (mDec != NULL)
   {
      gst_bin_remove(GST_BIN(mPipeline.get()), mDec);
   }
 
   g_mutex_clear(&mStreamsLock);
}

References mDec, mPipeline, mStreams, and mStreamsLock.

Member Function Documentation

GetFileDescription()

TranslatableString GStreamerImportFileHandle::GetFileDescription ( )

overridevirtual

Implements ImportFileHandle.

Definition at line 1001 of file ImportGStreamer.cpp.

{
   return DESC;
}

References DESC.

GetFileUncompressedBytes()

auto GStreamerImportFileHandle::GetFileUncompressedBytes ( )

overridevirtual

Implements ImportFileHandle.

Definition at line 1009 of file ImportGStreamer.cpp.

{
   return 0;
}

GetStreamCount()

wxInt32 GStreamerImportFileHandle::GetStreamCount ( )

overridevirtual

! Called by Import.cpp

Returns

number of readable audio streams in the file

Implements ImportFileHandle.

Definition at line 889 of file ImportGStreamer.cpp.

{
   return mStreamInfo.size();
}

References mStreamInfo.

GetStreamInfo()

const TranslatableStrings & GStreamerImportFileHandle::GetStreamInfo ( )

overridevirtual

! Called by Import.cpp

Returns

array of strings - descriptions of the streams

Implements ImportFileHandle.

Definition at line 897 of file ImportGStreamer.cpp.

{
   return mStreamInfo;
}

References mStreamInfo.

Import()

int GStreamerImportFileHandle::Import ( TrackFactory *  trackFactory, TrackHolders &  outTracks, Tags *  tags  )

override

! Imports audio

Returns

import status (see Import.cpp)

Definition at line 1017 of file ImportGStreamer.cpp.

{
   outTracks.clear();
 
   // Save track factory pointer
   mTrackFactory = trackFactory;
 
   // Create the progress dialog
   CreateProgress();
 
   // Block streams that are to be bypassed
   bool haveStreams = false;
   {
      g_mutex_locker locker{ mStreamsLock };
      for (guint i = 0; i < mStreams.size(); i++)
      {
         GStreamContext *c = mStreams[i].get();
 
         // Did the user choose to skip this stream?
         if (!c->mUse)
         {
            // Get the audioconvert sink pad and unlink
            {
               GstObjHandle<GstPad> convsink{ gst_element_get_static_pad(c->mConv, "sink") };
 
               {
                  GstObjHandle<GstPad> convpeer{ gst_pad_get_peer(convsink.get()) };
                  gst_pad_unlink(convpeer.get(), convsink.get());
               }
 
               // Set bitbucket callbacks so the prerolled sample won't get processed
               // when we change the state to PLAYING
               gst_app_sink_set_callbacks(GST_APP_SINK(c->mSink), &AppSinkBitBucket, this, NULL);
 
               // Set state to playing for conv and sink so EOS gets processed
               gst_element_set_state(c->mConv, GST_STATE_PLAYING);
               gst_element_set_state(c->mSink, GST_STATE_PLAYING);
 
               // Send an EOS event to the pad to force them to drain
               gst_pad_send_event(convsink.get(), gst_event_new_eos());
 
               // Resync state with pipeline
               gst_element_sync_state_with_parent(c->mConv);
               gst_element_sync_state_with_parent(c->mSink);
 
               // Done with the pad
            }
 
            // Unlink audioconvert and appsink
            gst_element_unlink(c->mConv, c->mSink);
 
            // Remove them from the bin
            gst_bin_remove_many(GST_BIN(mPipeline.get()), c->mConv, c->mSink, NULL);
 
            // All done with them
            c->mConv = NULL;
            c->mSink = NULL;
 
            continue;
         }
 
         // We have a stream to process
         haveStreams = true;
      }
   }
 
   // Can't do much if we don't have any streams to process
   if (!haveStreams)
   {
      AudacityMessageBox(
         XO("File doesn't contain any audio streams."),
         XO("GStreamer Importer"));
      return ProgressResult::Failed;
   }
 
   // Get the ball rolling...
   GstStateChangeReturn state = gst_element_set_state(mPipeline.get(), GST_STATE_PLAYING);
   if (state == GST_STATE_CHANGE_FAILURE)
   {
      AudacityMessageBox(
         XO("Unable to import file, state change failed."),
         XO("GStreamer Importer"));
      return ProgressResult::Failed;
   }
 
   // Get the duration of the stream
   gint64 duration;
   gst_element_query_duration(mPipeline.get(), GST_FORMAT_TIME, &duration);
 
   // Handle bus messages and update progress while files is importing
   bool success = true;
   int updateResult = ProgressResult::Success;
   while (ProcessBusMessage(success) && success && updateResult == ProgressResult::Success)
   {
      gint64 position;
 
      // Update progress indicator and give user chance to abort
      if (gst_element_query_position(mPipeline.get(), GST_FORMAT_TIME, &position))
      {
         updateResult = mProgress->Update((wxLongLong_t) position,
                                          (wxLongLong_t) duration);
      }
   }
 
   // Disable pipeline
   gst_element_set_state(mPipeline.get(), GST_STATE_NULL);
 
   // Something bad happened
   if (!success || updateResult == ProgressResult::Failed || updateResult == ProgressResult::Cancelled)
   {
      return updateResult;
   }
 
   // Grab the streams lock
   g_mutex_locker locker{ mStreamsLock };
 
   // Copy audio from mChannels to newly created tracks (destroying mChannels in process)
   int trackindex = 0;
   for (guint s = 0; s < mStreams.size(); s++)
   {
      GStreamContext *c = mStreams[s].get();
      if (c->mNumChannels)
      {
         for (int ch = 0; ch < c->mNumChannels; ch++)
            c->mChannels[ch]->Flush();
         outTracks.push_back(std::move(c->mChannels));
      }
   }
 
   // Set any tags found in the stream
   *tags = mTags;
 
   return updateResult;
}

References AppSinkBitBucket, AudacityMessageBox(), RefreshCode::Cancelled, ImportFileHandle::CreateProgress(), GStreamContext::mChannels, GStreamContext::mConv, GStreamContext::mNumChannels, mPipeline, ImportFileHandle::mProgress, GStreamContext::mSink, mStreams, mStreamsLock, mTags, mTrackFactory, GStreamContext::mUse, ProcessBusMessage(), BasicUI::Success, and XO().

Here is the call graph for this function:

Init()

bool GStreamerImportFileHandle::Init

(

)

! Format initialization

Returns

true if successful, false otherwise

Definition at line 918 of file ImportGStreamer.cpp.

{
   // Create a URI from the filename
   mUri.reset(g_strdup_printf("file:///%s", mFilename.ToUTF8().data()));
   if (!mUri)
   {
      wxLogMessage(wxT("GStreamerImport couldn't create URI"));
      return false;
   }
 
   // Create a pipeline
   mPipeline.reset(gst_pipeline_new("pipeline"));
 
   // Get its bus
   mBus.reset(gst_pipeline_get_bus(GST_PIPELINE(mPipeline.get())));
 
   // Create uridecodebin and set up signal handlers
   mDec = gst_element_factory_make("uridecodebin", "decoder");
   g_signal_connect(mDec, "autoplug-select", G_CALLBACK(GStreamerAutoplugSelectCallback), (gpointer) this);
   g_signal_connect(mDec, "pad-added", G_CALLBACK(GStreamerPadAddedCallback), (gpointer) this);
   g_signal_connect(mDec, "pad-removed", G_CALLBACK(GStreamerPadRemovedCallback), (gpointer) this);
 
   // Set the URI
   g_object_set(G_OBJECT(mDec), "uri", mUri, NULL);
 
   // Add the decoder to the pipeline
   if (!gst_bin_add(GST_BIN(mPipeline.get()), mDec))
   {
      AudacityMessageBox(
         XO("Unable to add decoder to pipeline"),
         XO("GStreamer Importer"));
 
      // Cleanup expected to occur in destructor
      return false;
   }
 
   // Run the pipeline
   GstStateChangeReturn state = gst_element_set_state(mPipeline.get(), GST_STATE_PAUSED);
   if (state == GST_STATE_CHANGE_FAILURE)
   {
      AudacityMessageBox(
         XO("Unable to set stream state to paused."),
         XO("GStreamer Importer"));
      return false;
   }
 
   // Collect info while the stream is prerolled
   //
   // Unfortunately, for some files this may cause a slight "pause" in the GUI
   // without a progress dialog appearing.  Not much can be done about it other
   // than throwing up an additional progress dialog and displaying two dialogs
   // may be confusing to the users.
 
   // Process messages until we get an error or the ASYNC_DONE message is received
   bool success;
   while (ProcessBusMessage(success) && success)
   {
      // Give wxWidgets a chance to do housekeeping
      wxSafeYield();
   }
 
   // Build the stream info array
   g_mutex_locker locker{ mStreamsLock };
   for (guint i = 0; i < mStreams.size(); i++)
   {
      GStreamContext *c = mStreams[i].get();
 
      // Create stream info string
      auto strinfo = XO("Index[%02d], Type[%s], Channels[%d], Rate[%d]")
         .Format(
            (unsigned int) i,
            wxString::FromUTF8(c->mType.get()),
            (int) c->mNumChannels,
            (int) c->mSampleRate );
      mStreamInfo.push_back(strinfo);
   }
 
   return success;
}

References AudacityMessageBox(), GStreamerAutoplugSelectCallback(), GStreamerPadAddedCallback(), GStreamerPadRemovedCallback(), mBus, mDec, ImportFileHandle::mFilename, GStreamContext::mNumChannels, mPipeline, GStreamContext::mSampleRate, mStreamInfo, mStreams, mStreamsLock, GStreamContext::mType, mUri, ProcessBusMessage(), wxT(), and XO().

Here is the call graph for this function:

OnNewSample()

void GStreamerImportFileHandle::OnNewSample	(	GStreamContext *	c,
		GstSample *	sample
	)

! Called when a NEW samples are queued

Parameters

c	- stream context
sample	- gstreamer sample

Definition at line 730 of file ImportGStreamer.cpp.

{
   // Allocate NEW tracks
   //
   // It is done here because, at least in the case of chained oggs,
   // not all streams are known ahead of time.
   if (c->mChannels.empty())
   {
      // Get the sample format...no need to release caps or structure
      GstCaps *caps = gst_sample_get_caps(sample);
      GstStructure *str = gst_caps_get_structure(caps, 0);
      const gchar *fmt = gst_structure_get_string(str, "format");
      if (!fmt)
      {
         WARN(mPipeline.get(), ("OnNewSample: missing audio format"));
         return;
      }
 
      // Determinate sample format based on negotiated format
      if (strcmp(fmt, GST_AUDIO_NE(S16)) == 0)
      {
         c->mFmt = int16Sample;
      }
      else if (strcmp(fmt, GST_AUDIO_NE(S24_32)) == 0)
      {
         c->mFmt = int24Sample;
      }
      else if (strcmp(fmt, GST_AUDIO_NE(F32)) == 0)
      {
         c->mFmt = floatSample;
      }
      else
      {
         // This shouldn't really happen since audioconvert will only give us
         // the formats we said we could handle.
         WARN(mPipeline.get(), ("OnNewSample: unrecognized sample format %s", fmt));
         return;
      }
 
      // Allocate the track array
      c->mChannels.resize(c->mNumChannels);
      if (c->mChannels.size() != c->mNumChannels)
      {
         WARN(mPipeline.get(), ("OnNewSample: unable to allocate track array"));
         return;
      }
 
      // Allocate all channels
      for (int ch = 0; ch < c->mNumChannels; ch++)
      {
         // Create a track
         c->mChannels[ch] = mTrackFactory->NewWaveTrack(c->mFmt, c->mSampleRate);
         if (!c->mChannels[ch])
         {
            WARN(mPipeline.get(), ("OnNewSample: unable to create track"));
            return;
         }
      }
   }
 
   // Get the buffer for the sample...no need to release
   GstBuffer *buffer = gst_sample_get_buffer(sample);
   if (!buffer)
   {
      // No buffer...not sure if this is an error or not,
      // but we can't do anything else, so just bail silently.
      return;
   }
 
   // Map the buffer
   GstMapInfo info;
   if (!gst_buffer_map(buffer, &info, GST_MAP_READ))
   {
      WARN(mPipeline.get(), ("OnNewSample: mapping buffer failed"));
      return;
   }
   auto cleanup = finally([&]{
      // Release buffer
      gst_buffer_unmap(buffer, &info);
   });
 
   // Cache a few items
   auto nChannels = c->mNumChannels;
   sampleFormat fmt = c->mFmt;
   samplePtr data = (samplePtr) info.data;
   size_t samples = info.size / nChannels / SAMPLE_SIZE(fmt);
 
   // Add sample data to tracks...depends on interleaved src data
   for (int chn = 0; chn < nChannels; chn++)
   {
      // Append one channel
      c->mChannels[chn]->Append(data,
                                fmt,
                                samples,
                                nChannels);
 
      // Bump src to next channel
      data += SAMPLE_SIZE(fmt);
   }
 
   return;
}

References floatSample, int16Sample, int24Sample, GStreamContext::mChannels, GStreamContext::mFmt, GStreamContext::mNumChannels, mPipeline, GStreamContext::mSampleRate, mTrackFactory, SAMPLE_SIZE, str, and WARN.

Referenced by GStreamerNewSample().

Here is the caller graph for this function:

OnPadAdded()

void GStreamerImportFileHandle::OnPadAdded

(

GstPad *

pad

)

! Called when a pad-added signal comes in from UriDecodeBin

Parameters

pad	- source pad of uridecodebin that will not be serving any data

Definition at line 535 of file ImportGStreamer.cpp.

{
   GStreamContext *c{};
 
   {
      // Retrieve the stream caps...skip stream if unavailable
      GstCaps *caps = gst_pad_get_current_caps(pad);
      GstCapsHandle handle{ caps };
 
      if (!caps)
      {
         WARN(mPipeline.get(), ("OnPadAdded: unable to retrieve stream caps"));
         return;
      }
 
      // Get the caps structure...no need to release
      GstStructure *str = gst_caps_get_structure(caps, 0);
      if (!str)
      {
         WARN(mPipeline.get(), ("OnPadAdded: unable to retrieve caps structure"));
         return;
      }
 
      // Only accept audio streams...no need to release
      const gchar *name = gst_structure_get_name(str);
      if (!g_strrstr(name, "audio"))
      {
         WARN(mPipeline.get(), ("OnPadAdded: bypassing '%s' stream", name));
         return;
      }
 
      {
         // Allocate a NEW stream context
         auto uc = std::make_unique<GStreamContext>();
         c = uc.get();
         if (!c)
         {
            WARN(mPipeline.get(), ("OnPadAdded: unable to allocate stream context"));
            return;
         }
 
         // Set initial state
         c->mUse = true;
 
         // Always add it to the context list to keep the number of contexts
         // in sync with the number of streams
         g_mutex_locker{ mStreamsLock };
         // Pass the buck from uc
         mStreams.push_back(std::move(uc));
      }
 
      c->mPipeline = mPipeline.get();
 
      // Need pointer to context during pad removal (pad-remove signal)
      SETCTX(pad, c);
 
      // Save the stream's start time and duration
      gst_pad_query_position(pad, GST_FORMAT_TIME, &c->mPosition);
      gst_pad_query_duration(pad, GST_FORMAT_TIME, &c->mDuration);
 
      // Retrieve the number of channels and validate
      gint channels = -1;
      gst_structure_get_int(str, "channels", &channels);
      if (channels <= 0)
      {
         WARN(mPipeline.get(), ("OnPadAdded: channel count is invalid %d", channels));
         return;
      }
      c->mNumChannels = channels;
 
      // Retrieve the sample rate and validate
      gint rate = -1;
      gst_structure_get_int(str, "rate", &rate);
      if (rate <= 0)
      {
         WARN(mPipeline.get(), ("OnPadAdded: sample rate is invalid %d", rate));
         return;
      }
      c->mSampleRate = (double)rate;
 
      c->mType.reset(g_strdup(name));
      if (!c->mType)
      {
         WARN(mPipeline.get(), ("OnPadAdded: unable to allocate audio type"));
         return;
      }
 
      // Done with capabilities
   }
 
   // Create audioconvert element
   c->mConv = gst_element_factory_make("audioconvert", NULL);
   if (!c->mConv)
   {
      WARN(mPipeline.get(), ("OnPadAdded: failed to create audioconvert element"));
      return;
   }
 
   // Create appsink element
   c->mSink = gst_element_factory_make("appsink", NULL);
   if (!c->mSink)
   {
      WARN(mPipeline.get(), ("OnPadAdded: failed to create appsink element"));
      return;
   }
   SETCTX(c->mSink, c);
 
   // Set the appsink callbacks and add the context pointer
   gst_app_sink_set_callbacks(GST_APP_SINK(c->mSink), &AppSinkCallbacks, this, NULL);
 
   {
      // Set the capabilities that we desire
      GstCaps *caps = gst_static_caps_get(&supportedCaps);
      GstCapsHandle handle{ caps };
      if (!caps)
      {
         WARN(mPipeline.get(), ("OnPadAdded: failed to create static caps"));
         return;
      }
      gst_app_sink_set_caps(GST_APP_SINK(c->mSink), caps);
   }
 
   // Do not sync to the clock...process as quickly as possible
   gst_base_sink_set_sync(GST_BASE_SINK(c->mSink), FALSE);
 
   // Don't drop buffers...allow queue to build unfettered
   gst_app_sink_set_drop(GST_APP_SINK(c->mSink), FALSE);
 
   // Add both elements to the pipeline
   gst_bin_add_many(GST_BIN(mPipeline.get()), c->mConv, c->mSink, NULL);
 
   // Link them together
   if (!gst_element_link(c->mConv, c->mSink))
   {
      WARN(mPipeline.get(), ("OnPadAdded: failed to link audioconvert and appsink"));
      return;
   }
 
   // Link the audiconvert sink pad to the src pad
   GstPadLinkReturn ret = GST_PAD_LINK_OK;
   {
      GstObjHandle<GstPad> convsink{ gst_element_get_static_pad(c->mConv, "sink") };
      if (convsink)
         ret = gst_pad_link(pad, convsink.get());
      if (!convsink || ret != GST_PAD_LINK_OK)
      {
         WARN(mPipeline.get(), ("OnPadAdded: failed to link uridecodebin to audioconvert - %d", ret));
         return;
      }
   }
 
   // Synchronize audioconvert state with parent
   if (!gst_element_sync_state_with_parent(c->mConv))
   {
      WARN(mPipeline.get(), ("OnPadAdded: unable to sync audioconvert state"));
      return;
   }
 
   // Synchronize appsink state with parent
   if (!gst_element_sync_state_with_parent(c->mSink))
   {
      WARN(mPipeline.get(), ("OnPadAdded: unable to sync appaink state"));
      return;
   }
 
   return;
}

References AppSinkCallbacks, mPipeline, mStreams, mStreamsLock, name, SETCTX, str, supportedCaps, and WARN.

OnPadRemoved()

void GStreamerImportFileHandle::OnPadRemoved

(

GstPad *

pad

)

! Called when a pad-removed signal comes in from UriDecodeBin

Parameters

pad	- source pad of uridecodebin that will not be serving any data

Definition at line 706 of file ImportGStreamer.cpp.

{
   GStreamContext *c = GETCTX(pad);
 
   // Set audioconvert and appsink states to NULL
   gst_element_set_state(c->mSink, GST_STATE_NULL);
   gst_element_set_state(c->mConv, GST_STATE_NULL);
 
   // Unlink audioconvert -> appsink
   gst_element_unlink(c->mConv, c->mSink);
 
   // Remove the pads from the pipeilne
   gst_bin_remove_many(GST_BIN(mPipeline.get()), c->mConv, c->mSink, NULL);
 
   // And reset context
   c->mConv = NULL;
   c->mSink = NULL;
 
   return;
}

References GETCTX, GStreamContext::mConv, mPipeline, and GStreamContext::mSink.

OnTag()

void GStreamerImportFileHandle::OnTag	(	GstAppSink *	appsink,
		GstTagList *	tags
	)

! Called when a tag message comes in from the appsink

Parameters

appsink	- Specific sink that received the message
tags	- List of tags

Definition at line 1314 of file ImportGStreamer.cpp.

{
   // Collect all of the associates tags
   for (guint i = 0, icnt = gst_tag_list_n_tags(tags); i < icnt; i++)
   {
      wxString string;
 
      // Get tag name...should always succeed...no need to release
      const gchar *name = gst_tag_list_nth_tag_name(tags, i);
      if (!name)
      {
         continue;
      }
 
      // For each tag, determine its type and retrieve if possible
      for (guint j = 0, jcnt = gst_tag_list_get_tag_size(tags, name); j < jcnt; j++)
      {
         const GValue *val;
 
         val = gst_tag_list_get_value_index(tags, name, j);
 
         if (G_VALUE_HOLDS_STRING(val))
         {
            string = wxString::FromUTF8(g_value_get_string(val));
         }
         else if (G_VALUE_HOLDS_UINT(val))
         {
            string.Printf(wxT("%u"), (unsigned int) g_value_get_uint(val));
         }
         else if (G_VALUE_HOLDS_DOUBLE(val))
         {
            string.Printf(wxT("%g"), g_value_get_double(val));
         }
         else if (G_VALUE_HOLDS_BOOLEAN(val))
         {
            string = g_value_get_boolean(val) ? wxT("true") : wxT("false");
         }
         else if (GST_VALUE_HOLDS_DATE_TIME(val))
         {
            GstDateTime *dt = (GstDateTime *) g_value_get_boxed(val);
            GstString str{ gst_date_time_to_iso8601_string(dt) };
            string = wxString::FromUTF8(str.get());
         }
         else if (G_VALUE_HOLDS(val, G_TYPE_DATE))
         {
            GstString str{ gst_value_serialize(val) };
            string = wxString::FromUTF8(str.get());
         }
         else
         {
            wxLogMessage(wxT("Tag %s has unhandled type: %s"),
                         wxString::FromUTF8(name),
                         wxString::FromUTF8(G_VALUE_TYPE_NAME(val)));
            continue;
         }
 
         // Translate known tag names
         wxString tag;
         if (strcmp(name, GST_TAG_TITLE) == 0)
         {
            tag = TAG_TITLE;
         }
         else if (strcmp(name, GST_TAG_ARTIST) == 0)
         {
            tag = TAG_ARTIST;
         }
         else if (strcmp(name, GST_TAG_ALBUM) == 0)
         {
            tag = TAG_ALBUM;
         }
         else if (strcmp(name, GST_TAG_TRACK_NUMBER) == 0)
         {
            tag = TAG_TRACK;
         }
         else if (strcmp(name, GST_TAG_DATE) == 0)
         {
            tag = TAG_YEAR;
         }
         else if (strcmp(name, GST_TAG_GENRE) == 0)
         {
            tag = TAG_GENRE;
         }
         else if (strcmp(name, GST_TAG_COMMENT) == 0)
         {
            tag = TAG_COMMENTS;
         }
         else
         {
            tag = wxString::FromUTF8(name);
         }
 
         if (jcnt > 1)
         {
            tag.Printf(wxT("%s:%d"), tag, j);
         }
 
         // Store the tag
         mTags.SetTag(tag, string);
      }
   }
}

References mTags, name, Tags::SetTag(), str, TAG_ALBUM, TAG_ARTIST, TAG_COMMENTS, TAG_GENRE, TAG_TITLE, TAG_TRACK, TAG_YEAR, and wxT().

Referenced by ProcessBusMessage().

Here is the call graph for this function:

Here is the caller graph for this function:

ProcessBusMessage()

bool GStreamerImportFileHandle::ProcessBusMessage

(

bool &

success

)

! Called when a message comes through GStreamer message bus

Parameters

success

- will be set to true if successful

Returns

true if the loop should be terminated

Definition at line 1163 of file ImportGStreamer.cpp.

{
   bool cont = true;
 
   // Default to no errors
   success = true;
 
   // Get the next message
   std::unique_ptr < GstMessage, Deleter < GstMessage, GstMessageUnref > >
      msg{ gst_bus_timed_pop(mBus.get(), 100 * GST_MSECOND) };
 
   if (!msg)
   {
      // Timed out...not an error
      return cont;
   }
 
#if defined(_DEBUG)
   {
      GstString objname;
      if (msg->src != NULL)
      {
         objname.reset(gst_object_get_name(msg->src));
      }
 
      wxLogMessage(wxT("GStreamer: Got %s%s%s"),
         wxString::FromUTF8(GST_MESSAGE_TYPE_NAME(msg.get())),
         objname ? wxT(" from ") : wxT(""),
         objname ? wxString::FromUTF8(objname.get()) : wxT(""));
   }
#endif
 
   // Handle based on message type
   switch (GST_MESSAGE_TYPE(msg.get()))
   {
      // Handle error message from gstreamer
      case GST_MESSAGE_ERROR:
      {
         GErrorHandle err;
         GstString debug;
 
         GstMessageParse(gst_message_parse_error, msg.get(), err, debug);
         if (err)
         {
            wxString m;
 
            m.Printf(wxT("%s%s%s"),
               wxString::FromUTF8(err.get()->message),
               debug ? wxT("\n") : wxT(""),
               debug ? wxString::FromUTF8(debug.get()) : wxT(""));
            auto msg = XO("GStreamer Error: %s").Format( m );
#if defined(_DEBUG)
            AudacityMessageBox( msg );
#else
            wxLogMessage( msg.Debug() );
#endif
         }
 
         success = false;
         cont = false;
      }
      break;
 
      // Handle warning message from gstreamer
      case GST_MESSAGE_WARNING:
      {
         GErrorHandle err;
         GstString debug;
         GstMessageParse(gst_message_parse_warning, msg.get(), err, debug);
 
         if (err)
         {
            wxLogMessage(wxT("GStreamer Warning: %s%s%s"),
                         wxString::FromUTF8(err.get()->message),
                         debug ? wxT("\n") : wxT(""),
                         debug ? wxString::FromUTF8(debug.get()) : wxT(""));
         }
      }
      break;
 
      // Handle warning message from gstreamer
      case GST_MESSAGE_INFO:
      {
         GErrorHandle err;
         GstString debug;
 
         GstMessageParse(gst_message_parse_info, msg.get(), err, debug);
         if (err)
         {
            wxLogMessage(wxT("GStreamer Info: %s%s%s"),
                         wxString::FromUTF8(err.get()->message),
                         debug ? wxT("\n") : wxT(""),
                         debug ? wxString::FromUTF8(debug.get()) : wxT(""));
         }
      }
      break;
 
      // Handle metadata tags
      case GST_MESSAGE_TAG:
      {
         GstTagList *tags = NULL;
         auto cleanup = finally([&]{
            // Done with list
            if(tags) gst_tag_list_unref(tags);
         });
 
         // Retrieve tag list from message...just ignore failure
         gst_message_parse_tag(msg.get(), &tags);
         if (tags)
         {
            // Go process the list
            OnTag(GST_APP_SINK(GST_MESSAGE_SRC(msg.get())), tags);
         }
      }
      break;
 
      // Pre-roll is done...will happen for each group
      // (like with chained OGG files)
      case GST_MESSAGE_ASYNC_DONE:
      {
         // If this is the first async-done message, then tell
         // caller to end loop, but leave it active so that
         // gstreamer threads can still queue up.
         //
         // We'll receive multiple async-done messages for chained
         // ogg files, so ignore the message the 2nd and subsequent
         // occurrences.
         if (!mAsyncDone)
         {
            cont = false;
            mAsyncDone = true;
         }
 
      }
      break;
 
      // End of the stream (and all sub-streams)
      case GST_MESSAGE_EOS:
      {
         // Terminate loop
         cont = false;
      }
      break;
   }
 
   return cont;
}

References AudacityMessageBox(), GstMessageParse(), mAsyncDone, mBus, OnTag(), wxT(), and XO().

Referenced by Import(), and Init().

Here is the call graph for this function:

Here is the caller graph for this function:

SetStreamUsage()

void GStreamerImportFileHandle::SetStreamUsage ( wxInt32  index, bool  use  )

overridevirtual

! Called by Import.cpp

Parameters

index	- index of the stream in mStreamInfo and mStreams arrays
use	- true if this stream should be imported, false otherwise

Implements ImportFileHandle.

Definition at line 905 of file ImportGStreamer.cpp.

{
   g_mutex_locker locker{ mStreamsLock };
   if ((guint) index < mStreams.size())
   {
      GStreamContext *c = mStreams[index].get();
      c->mUse = use;
   }
}

References mStreams, mStreamsLock, and GStreamContext::mUse.

Member Data Documentation

mAsyncDone

bool GStreamerImportFileHandle::mAsyncDone

private

true = 1st async-done message received

Definition at line 226 of file ImportGStreamer.cpp.

Referenced by GStreamerImportFileHandle(), and ProcessBusMessage().

mBus

GstObjHandle<GstBus> GStreamerImportFileHandle::mBus

private

Message bus.

Definition at line 224 of file ImportGStreamer.cpp.

Referenced by Init(), and ProcessBusMessage().

mDec

GstElement* GStreamerImportFileHandle::mDec

private

uridecodebin element

Definition at line 225 of file ImportGStreamer.cpp.

Referenced by GStreamerImportFileHandle(), Init(), and ~GStreamerImportFileHandle().

mPipeline

GstObjHandle<GstElement> GStreamerImportFileHandle::mPipeline

private

GStreamer pipeline.

Definition at line 223 of file ImportGStreamer.cpp.

Referenced by Import(), Init(), OnNewSample(), OnPadAdded(), OnPadRemoved(), and ~GStreamerImportFileHandle().

mStreamInfo

TranslatableStrings GStreamerImportFileHandle::mStreamInfo

private

Array of stream descriptions. Length is the same as mStreams.

Definition at line 218 of file ImportGStreamer.cpp.

Referenced by GetStreamCount(), GetStreamInfo(), and Init().

mStreams

std::vector<std::unique_ptr<GStreamContext> > GStreamerImportFileHandle::mStreams

private

Array of pointers to stream contexts.

Definition at line 229 of file ImportGStreamer.cpp.

Referenced by Import(), Init(), OnPadAdded(), SetStreamUsage(), and ~GStreamerImportFileHandle().

mStreamsLock

GMutex GStreamerImportFileHandle::mStreamsLock

private

Mutex protecting the mStreams array.

Definition at line 228 of file ImportGStreamer.cpp.

Referenced by GStreamerImportFileHandle(), Import(), Init(), OnPadAdded(), SetStreamUsage(), and ~GStreamerImportFileHandle().

mTags

Tags GStreamerImportFileHandle::mTags

private

Tags to be passed back to Audacity.

Definition at line 219 of file ImportGStreamer.cpp.

Referenced by Import(), and OnTag().

mTrackFactory

TrackFactory* GStreamerImportFileHandle::mTrackFactory

private

Factory to create tracks when samples arrive.

Definition at line 220 of file ImportGStreamer.cpp.

Referenced by GStreamerImportFileHandle(), Import(), and OnNewSample().

mUri

GstString GStreamerImportFileHandle::mUri

private

URI of file.

Definition at line 222 of file ImportGStreamer.cpp.

Referenced by Init().

---

The documentation for this class was generated from the following file:

• ImportGStreamer.cpp