GStreamerImportPlugin Class Reference

An ImportPlugin for GStreamer data. More...

Inheritance diagram for GStreamerImportPlugin:

Collaboration diagram for GStreamerImportPlugin:

Public Member Functions
	GStreamerImportPlugin ()
	! Constructor More...
virtual	~GStreamerImportPlugin ()
	! Destructor More...
TranslatableString	GetPluginFormatDescription () override
wxString	GetPluginStringID () override
FileExtensions	GetSupportedExtensions () override
std::unique_ptr< ImportFileHandle >	Open (const wxString &Filename, AudacityProject *) override
	! Probes the file and opens it if appropriate More...
Public Member Functions inherited from ImportPlugin
virtual wxString	GetPluginStringID ()=0
virtual TranslatableString	GetPluginFormatDescription ()=0
virtual FileExtensions	GetSupportedExtensions ()
virtual TranslatableString	FailureHint () const
	User visible message suggesting what to do when a file type isn't recognized; default empty string. More...
bool	SupportsExtension (const FileExtension &extension)
virtual std::unique_ptr< ImportFileHandle >	Open (const FilePath &Filename, AudacityProject *)=0
virtual	~ImportPlugin ()

Additional Inherited Members
Protected Member Functions inherited from ImportPlugin
	ImportPlugin (FileExtensions supportedExtensions)
Protected Attributes inherited from ImportPlugin
const FileExtensions	mExtensions

Detailed Description

An ImportPlugin for GStreamer data.

A representative of GStreamer loader in the Audacity import plugin list

Definition at line 234 of file ImportGStreamer.cpp.

Constructor & Destructor Documentation

GStreamerImportPlugin()

GStreamerImportPlugin::GStreamerImportPlugin

(

)

! Constructor

Definition at line 313 of file ImportGStreamer.cpp.

:  ImportPlugin( {} )
{
}

~GStreamerImportPlugin()

GStreamerImportPlugin::~GStreamerImportPlugin ( )

virtual

! Destructor

Definition at line 320 of file ImportGStreamer.cpp.

{
}

Member Function Documentation

GetPluginFormatDescription()

TranslatableString GStreamerImportPlugin::GetPluginFormatDescription ( )

overridevirtual

Implements ImportPlugin.

Definition at line 327 of file ImportGStreamer.cpp.

{
   return DESC;
}

References DESC.

GetPluginStringID()

wxString GStreamerImportPlugin::GetPluginStringID ( )

overridevirtual

Implements ImportPlugin.

Definition at line 335 of file ImportGStreamer.cpp.

{
   return wxT("gstreamer");
}

References wxT().

Here is the call graph for this function:

GetSupportedExtensions()

FileExtensions GStreamerImportPlugin::GetSupportedExtensions ( )

overridevirtual

Reimplemented from ImportPlugin.

Definition at line 343 of file ImportGStreamer.cpp.

{
   // We refresh the extensions each time this is called in case the
   // user had installed additional gstreamer plugins while Audacity
   // was active.
   mExtensions.clear();
 
   // Gather extensions from all factories that support audio
   {
      std::unique_ptr < GList, Deleter<GList, gst_plugin_feature_list_free> >
         factories{ gst_type_find_factory_get_list() };
 
      for (GList *list = factories.get(); list != NULL; list = g_list_next(list))
      {
         GstTypeFindFactory *factory = GST_TYPE_FIND_FACTORY(list->data);
 
         // We need the capabilities to determine if it handles audio
         GstCaps *caps = gst_type_find_factory_get_caps(factory);
         if (!caps)
         {
            continue;
         }
 
         // Check each structure in the caps for audio
         for (guint c = 0, clen = gst_caps_get_size(caps); c < clen; c++)
         {
            // Bypass if it isn't for audio
            GstStructure *str = gst_caps_get_structure(caps, c);
            if (!g_str_has_prefix(gst_structure_get_name(str), "audio"))
            {
               continue;
            }
 
            // This factory can handle audio, so get the extensions
            const gchar *const *extensions = gst_type_find_factory_get_extensions(factory);
            if (!extensions)
            {
               continue;
            }
 
            // Add each extension to the list
            for (guint i = 0; extensions[i] != NULL; i++)
            {
               wxString extension = wxString::FromUTF8(extensions[i]);
               if (mExtensions.Index(extension, false) == wxNOT_FOUND)
               {
                  mExtensions.push_back(extension);
               }
            }
         }
      }
   }
 
   // Get them in a decent order
   mExtensions.Sort();
 
   // Log it for debugging
   wxString extensions = wxT("Extensions:");
   for (size_t i = 0; i < mExtensions.size(); i++)
   {
      extensions = extensions + wxT(" ") + mExtensions[i];
   }
   wxLogMessage(wxT("%s"), extensions);
 
   return mExtensions;
}

References cloud::factory, ImportPlugin::mExtensions, str, and wxT().

Here is the call graph for this function:

Open()

std::unique_ptr< ImportFileHandle > GStreamerImportPlugin::Open ( const wxString &  Filename, AudacityProject *    )

overridevirtual

! Probes the file and opens it if appropriate

Implements ImportPlugin.

Definition at line 412 of file ImportGStreamer.cpp.

{
   auto handle = std::make_unique<GStreamerImportFileHandle>(filename);
 
   // Initialize the handle
   if (!handle->Init())
   {
      return nullptr;
   }
 
   // This std::move is needed to "upcast" the pointer type
   return std::move(handle);
}

---

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

• ImportGStreamer.cpp