Skip to content

Common naming nomenclature - first step #101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

cchampet
Copy link
Member

  • directories lowerCamelCase
  • directories no plural
  • files lowerCamelCase if the classes are different from the name of the file
  • prefix I for interfaces
  • directory Metadatas → MediaProperty
  • new directory swig
  • new directory option

Clement Champetier and others added 30 commits September 23, 2014 12:22
…ace"

* Need to do it for other interface.
* Need to rename InputStream / OutputStream files accordingly.
* AvOutputStream: no sense to create a default outputStream and can't
set its output file or stream index.
* IOutputStream: remove default constructor (automatically generated).
* AvInputStream: no sense to create a default inputStream and can't set
its input file or stream index.
* IInputStream: remove default constructor (automatically generated).
Add prefix "I" for "interface".
According to the name of the class contains in the file.
Contains specific files concern by the binding in general: avException
and avExport.
Contains files concern by the FFmpeg / libav options.
Give the same name as the included class.
LowerCamelCase for file with a list of classes or functions.

Conflicts:

	app/cpp/avMeta/avMeta.cpp
	app/cpp/avplay/AvReader.hpp
	src/AvTranscoder/mediaProperties/Print.hpp
	src/AvTranscoder/mediaProperties/printMediaProperties.hpp
	src/AvTranscoder/mediaProperty/Print.hpp
We do not want the user to redefine in a derived class the basic
functions to manipulate DataBuffer.
* Also remove default constructor (automatically generated).
…udio

* Also rename attributes and local variables about dummy:
     * Transcoder.
     * StreamTranscoder.
* Print a warning if avplay app can't be built.
* Allow the user to build avTranscoder library even if dependencies of
this app are not found.
* fix avTranscoder#94
Clement Champetier added 16 commits September 24, 2014 14:59
* Base class of all possible Progress.
* ProgressListener inherits this base class.
* Add documentation.
* Swig: add feature "director" to the base class.
the class implements the IProgress, to display a progress bar in
console.
* Manage cases when we need an IProgress but don't care of a progress
bar.
* Use it in avMeta app: we want the file infos, but don't care of the
progress bar.
* Create ProgressListener.cpp.
* Add include to iostream in Transcoder.
* Contains all files related to the progress.
* Also contains corresponding swig interface file.

Conflicts:

	src/AvTranscoder/file/InputFile.hpp
* 3 classes / files: IProgress, ConsoleProgress, NoDisplayProgress.
* Add a cpp file just for ConsoleProgress (the implementation is more
'complicated' than the others).

Conflicts:

	app/cpp/avMeta/avMeta.cpp
	app/cpp/avTranscoder/avTranscoder.cpp
	app/cpp/avplay/AvReader.hpp
	app/cpp/genericProcessor/genericProcessor.cpp
	src/AvTranscoder/file/InputFile.hpp
…e file

* This directive concerns all the project.
* So put it the the main swig interface file (avTranscoder.i).
…into dev_common_naming_nomenclature

Conflicts:
	app/avMeta/avMeta.cpp
	app/avTranscoder/avTranscoder.cpp
	app/avplay/AvReader.hpp
	app/genericProcessor/genericProcessor.cpp
	src/AvTranscoder/file/InputFile.hpp
	src/AvTranscoder/progress/progress.i
* New files are:
     * VideoStreamProperty
     * AudioStreamProperty
     * DataStreamProperty
     * SubtitleStreamProperty
     * AttachementStreamProperty
     * UnknownStreamProperty
MarcAntoine-Arnaud added a commit that referenced this pull request Sep 24, 2014
@MarcAntoine-Arnaud MarcAntoine-Arnaud merged commit 0ce93c3 into avTranscoder:master Sep 24, 2014
@cchampet cchampet deleted the dev_common_naming_nomenclature branch October 20, 2014 07:33
cchampet added a commit to cchampet/avTranscoder that referenced this pull request Mar 2, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants